Class: Plaid::JWKPublicKey

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/jwk_public_key.rb

Overview

A JSON Web Key (JWK) that can be used in conjunction with [JWT libraries](jwt.io/#libraries-io) to verify Plaid webhooks

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JWKPublicKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
92
93
94
95
96
97
98
99
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
 
# File 'lib/plaid/models/jwk_public_key.rb', line 90

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#alg ⇒ Object

The alg member identifies the cryptographic algorithm family used with the key.



20
21
22
 
# File 'lib/plaid/models/jwk_public_key.rb', line 20

def alg
  @alg
end

#created_at ⇒ Object

The timestamp when the key was created, in Unix time.



41
42
43
 
# File 'lib/plaid/models/jwk_public_key.rb', line 41

def created_at
  @created_at
end

#crv ⇒ Object

The crv member identifies the cryptographic curve used with the key.



23
24
25
 
# File 'lib/plaid/models/jwk_public_key.rb', line 23

def crv
  @crv
end

#expired_at ⇒ Object

The timestamp when the key expired, in Unix time.



44
45
46
 
# File 'lib/plaid/models/jwk_public_key.rb', line 44

def expired_at
  @expired_at
end

#kid ⇒ Object

The kid (Key ID) member can be used to match a specific key. This can be used, for instance, to choose among a set of keys within the JWK during key rollover.



26
27
28
 
# File 'lib/plaid/models/jwk_public_key.rb', line 26

def kid
  @kid
end

#kty ⇒ Object

The kty (key type) parameter identifies the cryptographic algorithm family used with the key, such as RSA or EC.



29
30
31
 
# File 'lib/plaid/models/jwk_public_key.rb', line 29

def kty
  @kty
end

#use ⇒ Object

The use (public key use) parameter identifies the intended use of the public key.



32
33
34
 
# File 'lib/plaid/models/jwk_public_key.rb', line 32

def use
  @use
end

#x ⇒ Object

The x member contains the x coordinate for the elliptic curve point, provided as a base64url-encoded string of the coordinate’s big endian representation.



35
36
37
 
# File 'lib/plaid/models/jwk_public_key.rb', line 35

def x
  @x
end

#y ⇒ Object

The y member contains the y coordinate for the elliptic curve point, provided as a base64url-encoded string of the coordinate’s big endian representation.



38
39
40
 
# File 'lib/plaid/models/jwk_public_key.rb', line 38

def y
  @y
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



62
63
64
 
# File 'lib/plaid/models/jwk_public_key.rb', line 62

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/plaid/models/jwk_public_key.rb', line 47

def self.attribute_map
  {
    :'alg' => :'alg',
    :'crv' => :'crv',
    :'kid' => :'kid',
    :'kty' => :'kty',
    :'use' => :'use',
    :'x' => :'x',
    :'y' => :'y',
    :'created_at' => :'created_at',
    :'expired_at' => :'expired_at'
  }
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



224
225
226
 
# File 'lib/plaid/models/jwk_public_key.rb', line 224

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
86
 
# File 'lib/plaid/models/jwk_public_key.rb', line 82

def self.openapi_nullable
  Set.new([
    :'expired_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/plaid/models/jwk_public_key.rb', line 67

def self.openapi_types
  {
    :'alg' => :'String',
    :'crv' => :'String',
    :'kid' => :'String',
    :'kty' => :'String',
    :'use' => :'String',
    :'x' => :'String',
    :'y' => :'String',
    :'created_at' => :'Integer',
    :'expired_at' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/plaid/models/jwk_public_key.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      alg == o.alg &&
      crv == o.crv &&
      kid == o.kid &&
      kty == o.kty &&
      use == o.use &&
      x == o.x &&
      y == o.y &&
      created_at == o.created_at &&
      expired_at == o.expired_at
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/plaid/models/jwk_public_key.rb', line 255

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/plaid/models/jwk_public_key.rb', line 326

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/plaid/models/jwk_public_key.rb', line 231

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


211
212
213
 
# File 'lib/plaid/models/jwk_public_key.rb', line 211

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



217
218
219
 
# File 'lib/plaid/models/jwk_public_key.rb', line 217

def hash
  [alg, crv, kid, kty, use, x, y, created_at, expired_at].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



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
 
# File 'lib/plaid/models/jwk_public_key.rb', line 142

def list_invalid_properties
  invalid_properties = Array.new
  if @alg.nil?
    invalid_properties.push('invalid value for "alg", alg cannot be nil.')
  end

  if @crv.nil?
    invalid_properties.push('invalid value for "crv", crv cannot be nil.')
  end

  if @kid.nil?
    invalid_properties.push('invalid value for "kid", kid cannot be nil.')
  end

  if @kty.nil?
    invalid_properties.push('invalid value for "kty", kty cannot be nil.')
  end

  if @use.nil?
    invalid_properties.push('invalid value for "use", use cannot be nil.')
  end

  if @x.nil?
    invalid_properties.push('invalid value for "x", x cannot be nil.')
  end

  if @y.nil?
    invalid_properties.push('invalid value for "y", y cannot be nil.')
  end

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



302
303
304
 
# File 'lib/plaid/models/jwk_public_key.rb', line 302

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/plaid/models/jwk_public_key.rb', line 308

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



296
297
298
 
# File 'lib/plaid/models/jwk_public_key.rb', line 296

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/plaid/models/jwk_public_key.rb', line 181

def valid?
  return false if @alg.nil?
  return false if @crv.nil?
  return false if @kid.nil?
  return false if @kty.nil?
  return false if @use.nil?
  return false if @x.nil?
  return false if @y.nil?
  return false if @created_at.nil?
  true
end