Class: Comet::MacOSCodeSignProperties

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/mac_oscode_sign_properties.rb

Overview

MacOSCodeSignProperties is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ MacOSCodeSignProperties

Returns a new instance of MacOSCodeSignProperties.



70
71
72
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 70

def initialize
  clear
end

Instance Attribute Details

#app_certificate_file ⇒ Object

Returns the value of attribute app_certificate_file.



49
50
51
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 49

def app_certificate_file
  @app_certificate_file
end

#app_certificate_name ⇒ Object

“Developer ID Application” certificate, either a local filepath or a resource:// URI. Used for signing internal binaries if Notary is enabled



33
34
35
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 33

def app_certificate_name
  @app_certificate_name
end

#apple_id ⇒ Object

Returns the value of attribute apple_id.



36
37
38
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 36

def apple_id
  @apple_id
end

#apple_idpass ⇒ Object

Returns the value of attribute apple_idpass.



39
40
41
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 39

def apple_idpass
  @apple_idpass
end

#apple_idpass_format ⇒ Object

One of the ENCRYPTIONMETHOD_ constants



43
44
45
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 43

def apple_idpass_format
  @apple_idpass_format
end

#certificate_file ⇒ Object

Returns the value of attribute certificate_file.



46
47
48
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 46

def certificate_file
  @certificate_file
end

#certificate_name ⇒ Object

“Developer ID Installer” certificate, either a local filepath or a resource:// URI. Used for signing the final flat *.pkg.



28
29
30
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 28

def certificate_name
  @certificate_name
end

#level ⇒ Object

One of the MACOSCODESIGN_LEVEL_ constants



17
18
19
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 17

def level
  @level
end

#notary_apiissuer_id ⇒ Object

Returns the value of attribute notary_apiissuer_id.



59
60
61
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 59

def notary_apiissuer_id
  @notary_apiissuer_id
end

#notary_apikey_file ⇒ Object

Returns the value of attribute notary_apikey_file.



65
66
67
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 65

def notary_apikey_file
  @notary_apikey_file
end

#notary_apikey_id ⇒ Object

Returns the value of attribute notary_apikey_id.



62
63
64
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 62

def notary_apikey_id
  @notary_apikey_id
end

#pfx_file_password ⇒ Object

Returns the value of attribute pfx_file_password.



52
53
54
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 52

def pfx_file_password
  @pfx_file_password
end

#pfx_file_password_format ⇒ Object

One of the ENCRYPTIONMETHOD_ constants



56
57
58
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 56

def pfx_file_password_format
  @pfx_file_password_format
end

#sign_locally ⇒ Object

Returns the value of attribute sign_locally.



20
21
22
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 20

def sign_locally
  @sign_locally
end

#sshserver ⇒ Object

Returns the value of attribute sshserver.



23
24
25
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 23

def sshserver
  @sshserver
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



68
69
70
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 68

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 74

def clear
  @level = 0
  @sshserver = Comet::SSHConnection.new
  @certificate_name = ''
  @app_certificate_name = ''
  @apple_id = ''
  @apple_idpass = ''
  @apple_idpass_format = 0
  @certificate_file = ''
  @app_certificate_file = ''
  @pfx_file_password = ''
  @pfx_file_password_format = 0
  @notary_apiissuer_id = ''
  @notary_apikey_id = ''
  @notary_apikey_file = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 100

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'Level'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @level = v
    when 'SignLocally'
      @sign_locally = v
    when 'SSHServer'
      @sshserver = Comet::SSHConnection.new
      @sshserver.from_hash(v)
    when 'CertificateName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @certificate_name = v
    when 'AppCertificateName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @app_certificate_name = v
    when 'AppleID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @apple_id = v
    when 'AppleIDPass'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @apple_idpass = v
    when 'AppleIDPassFormat'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @apple_idpass_format = v
    when 'CertificateFile'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @certificate_file = v
    when 'AppCertificateFile'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @app_certificate_file = v
    when 'PfxFilePassword'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @pfx_file_password = v
    when 'PfxFilePasswordFormat'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @pfx_file_password_format = v
    when 'NotaryAPIIssuerID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @notary_apiissuer_id = v
    when 'NotaryAPIKeyID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @notary_apikey_id = v
    when 'NotaryAPIKeyFile'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @notary_apikey_file = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


93
94
95
96
97
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 93

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



193
194
195
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 193

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 169

def to_hash
  ret = {}
  ret['Level'] = @level
  ret['SignLocally'] = @sign_locally
  ret['SSHServer'] = @sshserver
  ret['CertificateName'] = @certificate_name
  ret['AppCertificateName'] = @app_certificate_name
  ret['AppleID'] = @apple_id
  ret['AppleIDPass'] = @apple_idpass
  ret['AppleIDPassFormat'] = @apple_idpass_format
  ret['CertificateFile'] = @certificate_file
  ret['AppCertificateFile'] = @app_certificate_file
  ret['PfxFilePassword'] = @pfx_file_password
  ret['PfxFilePasswordFormat'] = @pfx_file_password_format
  ret['NotaryAPIIssuerID'] = @notary_apiissuer_id
  ret['NotaryAPIKeyID'] = @notary_apikey_id
  ret['NotaryAPIKeyFile'] = @notary_apikey_file
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



198
199
200
 
# File 'lib/comet/models/mac_oscode_sign_properties.rb', line 198

def to_json(options = {})
  to_hash.to_json(options)
end