Class: Shortcut::Commit

Inherits:
Object
  • Object
show all
Defined in:
lib/shortcut_client_ruby/models/commit.rb

Overview

Commit refers to a VCS commit and all associated details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Commit

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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 105

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#author_email ⇒ Object

The email address of the VCS user that authored the Commit.



39
40
41
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 39

def author_email
  @author_email
end

#author_id ⇒ Object

The ID of the Member that authored the Commit, if known.



21
22
23
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 21

def author_id
  @author_id
end

#author_identity ⇒ Object

Returns the value of attribute author_identity.



44
45
46
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 44

def author_identity
  @author_identity
end

#created_at ⇒ Object

The time/date the Commit was created.



50
51
52
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 50

def created_at
  @created_at
end

#entity_type ⇒ Object

A string description of this resource.



18
19
20
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 18

def entity_type
  @entity_type
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



24
25
26
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 24

def hash
  @hash
end

#id ⇒ Object

The unique ID of the Commit.



33
34
35
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 33

def id
  @id
end

#merged_branch_ids ⇒ Object

The IDs of the Branches the Commit has been merged into.



30
31
32
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 30

def merged_branch_ids
  @merged_branch_ids
end

#message ⇒ Object

The Commit message.



53
54
55
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 53

def message
  @message
end

#repository_id ⇒ Object

The ID of the Repository that contains the Commit.



47
48
49
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 47

def repository_id
  @repository_id
end

#timestamp ⇒ Object

The time/date the Commit was pushed.



42
43
44
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 42

def timestamp
  @timestamp
end

#updated_at ⇒ Object

The time/date the Commit was updated.



27
28
29
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 27

def updated_at
  @updated_at
end

#url ⇒ Object

The URL of the Commit.



36
37
38
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 36

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 56

def self.attribute_map
  {
    :'entity_type' => :'entity_type',
    :'author_id' => :'author_id',
    :'hash' => :'hash',
    :'updated_at' => :'updated_at',
    :'merged_branch_ids' => :'merged_branch_ids',
    :'id' => :'id',
    :'url' => :'url',
    :'author_email' => :'author_email',
    :'timestamp' => :'timestamp',
    :'author_identity' => :'author_identity',
    :'repository_id' => :'repository_id',
    :'created_at' => :'created_at',
    :'message' => :'message'
  }
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



286
287
288
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 286

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
98
99
100
101
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 94

def self.openapi_nullable
  Set.new([
    :'author_id',
    :'updated_at',
    :'id',
    :'repository_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'entity_type' => :'Object',
    :'author_id' => :'Object',
    :'hash' => :'Object',
    :'updated_at' => :'Object',
    :'merged_branch_ids' => :'Object',
    :'id' => :'Object',
    :'url' => :'Object',
    :'author_email' => :'Object',
    :'timestamp' => :'Object',
    :'author_identity' => :'Object',
    :'repository_id' => :'Object',
    :'created_at' => :'Object',
    :'message' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      entity_type == o.entity_type &&
      author_id == o.author_id &&
      hash == o.hash &&
      updated_at == o.updated_at &&
      merged_branch_ids == o.merged_branch_ids &&
      id == o.id &&
      url == o.url &&
      author_email == o.author_email &&
      timestamp == o.timestamp &&
      author_identity == o.author_identity &&
      repository_id == o.repository_id &&
      created_at == o.created_at &&
      message == o.message
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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 316

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    Shortcut.const_get(type).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



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 385

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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 293

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


273
274
275
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 273

def eql?(o)
  self == o
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 175

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

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

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

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

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

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

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

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

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

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

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

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

  if @message.nil?
    invalid_properties.push('invalid value for "message", message 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



361
362
363
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 361

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 367

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



355
356
357
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 355

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/shortcut_client_ruby/models/commit.rb', line 234

def valid?
  return false if @entity_type.nil?
  return false if @author_id.nil?
  return false if @hash.nil?
  return false if @updated_at.nil?
  return false if @merged_branch_ids.nil?
  return false if @id.nil?
  return false if @url.nil?
  return false if @author_email.nil?
  return false if @timestamp.nil?
  return false if @author_identity.nil?
  return false if @repository_id.nil?
  return false if @created_at.nil?
  return false if @message.nil?
  true
end