Class: Athenian::FilterCommitsRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/athenian/models/filter_commits_request.rb

Overview

Filter for listing commits.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FilterCommitsRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/athenian/models/filter_commits_request.rb', line 108

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_in ⇒ Object

Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored.



29
30
31
 
# File 'lib/athenian/models/filter_commits_request.rb', line 29

def _in
  @_in
end

#account ⇒ Object

Session account ID.



17
18
19
 
# File 'lib/athenian/models/filter_commits_request.rb', line 17

def 
  @account
end

#date_from ⇒ Object

Commits must be made later than or equal to this date.



20
21
22
 
# File 'lib/athenian/models/filter_commits_request.rb', line 20

def date_from
  @date_from
end

#date_to ⇒ Object

Commits must be made earlier than or equal to this date.



23
24
25
 
# File 'lib/athenian/models/filter_commits_request.rb', line 23

def date_to
  @date_to
end

#only_default_branch ⇒ Object

Consider only commits that are accessible from the head of the default branch. For example, if your workflow includes PR-ing feature branches, you rebase and merge them and don’t delete afterward, ‘bypassing_prs` will report the commits in those feature branches unless you set `only_default_branch` to `true`.



41
42
43
 
# File 'lib/athenian/models/filter_commits_request.rb', line 41

def only_default_branch
  @only_default_branch
end

#property ⇒ Object

Main trait of the commits - the core of the filter. * bypassing_prs: select commits that were pushed without creating a PR * everything: select all the commits matched by the filters * no_pr_merges: select all the commits but PR merges by [email protected]



38
39
40
 
# File 'lib/athenian/models/filter_commits_request.rb', line 38

def property
  @property
end

#timezone ⇒ Object

Local time zone offset in minutes, used to adjust ‘date_from` and `date_to`.



26
27
28
 
# File 'lib/athenian/models/filter_commits_request.rb', line 26

def timezone
  @timezone
end

#with_author ⇒ Object

A set of developers. An empty list disables the filter and includes everybody. Duplicates are automatically ignored.



32
33
34
 
# File 'lib/athenian/models/filter_commits_request.rb', line 32

def with_author
  @with_author
end

#with_committer ⇒ Object

A set of developers. An empty list disables the filter and includes everybody. Duplicates are automatically ignored.



35
36
37
 
# File 'lib/athenian/models/filter_commits_request.rb', line 35

def with_committer
  @with_committer
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/athenian/models/filter_commits_request.rb', line 81

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/athenian/models/filter_commits_request.rb', line 66

def self.attribute_map
  {
    :'account' => :'account',
    :'date_from' => :'date_from',
    :'date_to' => :'date_to',
    :'timezone' => :'timezone',
    :'_in' => :'in',
    :'with_author' => :'with_author',
    :'with_committer' => :'with_committer',
    :'property' => :'property',
    :'only_default_branch' => :'only_default_branch'
  }
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



269
270
271
 
# File 'lib/athenian/models/filter_commits_request.rb', line 269

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



101
102
103
104
 
# File 'lib/athenian/models/filter_commits_request.rb', line 101

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/athenian/models/filter_commits_request.rb', line 86

def self.openapi_types
  {
    :'account' => :'Integer',
    :'date_from' => :'Date',
    :'date_to' => :'Date',
    :'timezone' => :'Integer',
    :'_in' => :'Array<String>',
    :'with_author' => :'Array<String>',
    :'with_committer' => :'Array<String>',
    :'property' => :'String',
    :'only_default_branch' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/athenian/models/filter_commits_request.rb', line 240

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      date_from == o.date_from &&
      date_to == o.date_to &&
      timezone == o.timezone &&
      _in == o._in &&
      with_author == o.with_author &&
      with_committer == o.with_committer &&
      property == o.property &&
      only_default_branch == o.only_default_branch
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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/athenian/models/filter_commits_request.rb', line 300

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



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/athenian/models/filter_commits_request.rb', line 371

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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/athenian/models/filter_commits_request.rb', line 276

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


256
257
258
 
# File 'lib/athenian/models/filter_commits_request.rb', line 256

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



262
263
264
 
# File 'lib/athenian/models/filter_commits_request.rb', line 262

def hash
  [, date_from, date_to, timezone, _in, with_author, with_committer, property, only_default_branch].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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/athenian/models/filter_commits_request.rb', line 166

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

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

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

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

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

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

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



347
348
349
 
# File 'lib/athenian/models/filter_commits_request.rb', line 347

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/athenian/models/filter_commits_request.rb', line 353

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



341
342
343
 
# File 'lib/athenian/models/filter_commits_request.rb', line 341

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



201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/athenian/models/filter_commits_request.rb', line 201

def valid?
  return false if @account.nil?
  return false if @date_from.nil?
  return false if @date_to.nil?
  return false if !@timezone.nil? && @timezone > 780
  return false if !@timezone.nil? && @timezone < -720
  return false if @_in.nil?
  return false if @property.nil?
  property_validator = EnumAttributeValidator.new('String', ['bypassing_prs', 'everything', 'no_pr_merges'])
  return false unless property_validator.valid?(@property)
  true
end