Class: Falcon::WebhooktriggerHMACConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/models/webhooktrigger_hmac_config.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebhooktriggerHMACConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 105

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Falcon::WebhooktriggerHMACConfig` 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 `Falcon::WebhooktriggerHMACConfig`. 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?(:'field_delimiter')
    self.field_delimiter = attributes[:'field_delimiter']
  end

  if attributes.key?(:'fields')
    if (value = attributes[:'fields']).is_a?(Array)
      self.fields = value
    end
  end

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

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

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

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

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

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

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

Instance Attribute Details

#field_delimiter ⇒ Object

Delimiter for fields in HMAC calculation (dot|comma)



36
37
38
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 36

def field_delimiter
  @field_delimiter
end

#fields ⇒ Object

Request components to include in HMAC calculation (body|timestamp|message_id)



39
40
41
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 39

def fields
  @fields
end

#hash_function ⇒ Object

Hash function to use for HMAC (e.g., sha256)



42
43
44
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 42

def hash_function
  @hash_function
end

#message_id_header_name ⇒ Object

Name of the header containing the webhook message ID



45
46
47
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 45

def message_id_header_name
  @message_id_header_name
end

#secret ⇒ Object

Secret key for HMAC signing



48
49
50
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 48

def secret
  @secret
end

#signature_encoding ⇒ Object

Encoding format for the signature



51
52
53
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 51

def signature_encoding
  @signature_encoding
end

#signature_header_name ⇒ Object

Name of the header containing the HMAC signature



54
55
56
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 54

def signature_header_name
  @signature_header_name
end

#signature_prefix ⇒ Object

Prefix of the HMAC signature which defines the signature format



57
58
59
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 57

def signature_prefix
  @signature_prefix
end

#timestamp_header_name ⇒ Object

Name of the header containing the timestamp



60
61
62
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 60

def timestamp_header_name
  @timestamp_header_name
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 63

def self.attribute_map
  {
    :'field_delimiter' => :'field_delimiter',
    :'fields' => :'fields',
    :'hash_function' => :'hash_function',
    :'message_id_header_name' => :'message_id_header_name',
    :'secret' => :'secret',
    :'signature_encoding' => :'signature_encoding',
    :'signature_header_name' => :'signature_header_name',
    :'signature_prefix' => :'signature_prefix',
    :'timestamp_header_name' => :'timestamp_header_name'
  }
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



201
202
203
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 201

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 98

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 83

def self.openapi_types
  {
    :'field_delimiter' => :'String',
    :'fields' => :'Array<String>',
    :'hash_function' => :'String',
    :'message_id_header_name' => :'String',
    :'secret' => :'String',
    :'signature_encoding' => :'String',
    :'signature_header_name' => :'String',
    :'signature_prefix' => :'String',
    :'timestamp_header_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 172

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      field_delimiter == o.field_delimiter &&
      fields == o.fields &&
      hash_function == o.hash_function &&
      message_id_header_name == o.message_id_header_name &&
      secret == o.secret &&
      signature_encoding == o.signature_encoding &&
      signature_header_name == o.signature_header_name &&
      signature_prefix == o.signature_prefix &&
      timestamp_header_name == o.timestamp_header_name
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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 232

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 = Falcon.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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 303

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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 208

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


188
189
190
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 188

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



194
195
196
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 194

def hash
  [field_delimiter, fields, hash_function, message_id_header_name, secret, signature_encoding, signature_header_name, signature_prefix, timestamp_header_name].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



159
160
161
162
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 159

def list_invalid_properties
  invalid_properties = Array.new
  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



279
280
281
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 279

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 285

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



273
274
275
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 273

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



166
167
168
 
# File 'lib/crimson-falcon/models/webhooktrigger_hmac_config.rb', line 166

def valid?
  true
end