Class: FactPulse::GenerateCertificateRequest

Inherits:
ApiModelBase show all
Defined in:
lib/factpulse/models/generate_certificate_request.rb

Overview

Requête pour générer un certificat X.509 auto-signé de test. ⚠️ ATTENTION : Ce certificat est destiné uniquement aux TESTS. NE PAS utiliser en production ! Niveau eIDAS : SES (Simple Electronic Signature)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ GenerateCertificateRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 104

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::GenerateCertificateRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `FactPulse::GenerateCertificateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'cn')
    self.cn = attributes[:'cn']
  else
    self.cn = 'Test Signature FactPulse'
  end

  if attributes.key?(:'organisation')
    self.organisation = attributes[:'organisation']
  else
    self.organisation = 'FactPulse Test'
  end

  if attributes.key?(:'pays')
    self.pays = attributes[:'pays']
  else
    self.pays = 'FR'
  end

  if attributes.key?(:'ville')
    self.ville = attributes[:'ville']
  else
    self.ville = 'Paris'
  end

  if attributes.key?(:'province')
    self.province = attributes[:'province']
  else
    self.province = 'Ile-de-France'
  end

  if attributes.key?(:'email')
    self.email = attributes[:'email']
  end

  if attributes.key?(:'duree_jours')
    self.duree_jours = attributes[:'duree_jours']
  else
    self.duree_jours = 365
  end

  if attributes.key?(:'taille_cle')
    self.taille_cle = attributes[:'taille_cle']
  else
    self.taille_cle = 2048
  end

  if attributes.key?(:'passphrase_cle')
    self.passphrase_cle = attributes[:'passphrase_cle']
  end

  if attributes.key?(:'generer_p12')
    self.generer_p12 = attributes[:'generer_p12']
  else
    self.generer_p12 = false
  end

  if attributes.key?(:'passphrase_p12')
    self.passphrase_p12 = attributes[:'passphrase_p12']
  else
    self.passphrase_p12 = 'changeme'
  end
end

Instance Attribute Details

#cn ⇒ Object

Common Name (CN) - Nom du certificat



20
21
22
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 20

def cn
  @cn
end

#duree_jours ⇒ Object

Durée de validité en jours



37
38
39
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 37

def duree_jours
  @duree_jours
end

#email ⇒ Object

Returns the value of attribute email.



34
35
36
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 34

def email
  @email
end

#generer_p12 ⇒ Object

Générer aussi un fichier PKCS#12 (.p12)



45
46
47
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 45

def generer_p12
  @generer_p12
end

#organisation ⇒ Object

Organisation (O)



23
24
25
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 23

def organisation
  @organisation
end

#passphrase_cle ⇒ Object

Returns the value of attribute passphrase_cle.



42
43
44
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 42

def passphrase_cle
  @passphrase_cle
end

#passphrase_p12 ⇒ Object

Passphrase pour le fichier PKCS#12



48
49
50
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 48

def passphrase_p12
  @passphrase_p12
end

#pays ⇒ Object

Code pays ISO 2 lettres ©



26
27
28
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 26

def pays
  @pays
end

#province ⇒ Object

Province/État (ST)



32
33
34
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 32

def province
  @province
end

#taille_cle ⇒ Object

Taille de la clé RSA en bits



40
41
42
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 40

def taille_cle
  @taille_cle
end

#ville ⇒ Object

Ville (L)



29
30
31
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 29

def ville
  @ville
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



68
69
70
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 68

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 73

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 51

def self.attribute_map
  {
    :'cn' => :'cn',
    :'organisation' => :'organisation',
    :'pays' => :'pays',
    :'ville' => :'ville',
    :'province' => :'province',
    :'email' => :'email',
    :'duree_jours' => :'duree_jours',
    :'taille_cle' => :'taille_cle',
    :'passphrase_cle' => :'passphrase_cle',
    :'generer_p12' => :'generer_p12',
    :'passphrase_p12' => :'passphrase_p12'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 285

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



95
96
97
98
99
100
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 95

def self.openapi_nullable
  Set.new([
    :'email',
    :'passphrase_cle',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 78

def self.openapi_types
  {
    :'cn' => :'String',
    :'organisation' => :'String',
    :'pays' => :'String',
    :'ville' => :'String',
    :'province' => :'String',
    :'email' => :'String',
    :'duree_jours' => :'Integer',
    :'taille_cle' => :'Integer',
    :'passphrase_cle' => :'String',
    :'generer_p12' => :'Boolean',
    :'passphrase_p12' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 254

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cn == o.cn &&
      organisation == o.organisation &&
      pays == o.pays &&
      ville == o.ville &&
      province == o.province &&
      email == o.email &&
      duree_jours == o.duree_jours &&
      taille_cle == o.taille_cle &&
      passphrase_cle == o.passphrase_cle &&
      generer_p12 == o.generer_p12 &&
      passphrase_p12 == o.passphrase_p12
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


272
273
274
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



278
279
280
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 278

def hash
  [cn, organisation, pays, ville, province, email, duree_jours, taille_cle, passphrase_cle, generer_p12, passphrase_p12].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 183

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@pays.nil? && @pays.to_s.length > 2
    invalid_properties.push('invalid value for "pays", the character length must be smaller than or equal to 2.')
  end

  if !@pays.nil? && @pays.to_s.length < 2
    invalid_properties.push('invalid value for "pays", the character length must be greater than or equal to 2.')
  end

  if !@duree_jours.nil? && @duree_jours > 3650
    invalid_properties.push('invalid value for "duree_jours", must be smaller than or equal to 3650.')
  end

  if !@duree_jours.nil? && @duree_jours < 1
    invalid_properties.push('invalid value for "duree_jours", must be greater than or equal to 1.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 307

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



207
208
209
210
211
212
213
214
 
# File 'lib/factpulse/models/generate_certificate_request.rb', line 207

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@pays.nil? && @pays.to_s.length > 2
  return false if !@pays.nil? && @pays.to_s.length < 2
  return false if !@duree_jours.nil? && @duree_jours > 3650
  return false if !@duree_jours.nil? && @duree_jours < 1
  true
end