Class: Athenian::CodeCheckMetricsRequest

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

Overview

Request for calculating metrics on top of code check runs (CI) data.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CodeCheckMetricsRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



86
87
88
89
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
139
140
141
142
 
# File 'lib/athenian/models/code_check_metrics_request.rb', line 86

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

  if attributes.key?(:'metrics')
    if (value = attributes[:'metrics']).is_a?(Array)
      self.metrics = value
    end
  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?(:'granularities')
    if (value = attributes[:'granularities']).is_a?(Array)
      self.granularities = value
    end
  end

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

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

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

Instance Attribute Details

#_for ⇒ Object

Sets of developers and repositories for which to calculate the metrics. The aggregation is ‘AND` between repositories and developers. The aggregation is `OR` inside both repositories and developers.



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

def _for
  @_for
end

#account ⇒ Object

Session account ID.



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

def 
  @account
end

#date_from ⇒ Object

Date from when to start measuring the metrics.



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

def date_from
  @date_from
end

#date_to ⇒ Object

Date until which to measure the metrics.



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

def date_to
  @date_to
end

#granularities ⇒ Object

The splits of the specified time range.



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

def granularities
  @granularities
end

#metrics ⇒ Object

Requested metric identifiers.



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

def metrics
  @metrics
end

#quantiles ⇒ Object

Cut the distributions at certain quantiles. The default values are [0, 1] which means no cutting.



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

def quantiles
  @quantiles
end

#split_by_check_runs ⇒ Object

Calculate metrics separately for each number of check runs in suite.



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

def split_by_check_runs
  @split_by_check_runs
end

#timezone ⇒ Object

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



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

def timezone
  @timezone
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



59
60
61
 
# File 'lib/athenian/models/code_check_metrics_request.rb', line 59

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/athenian/models/code_check_metrics_request.rb', line 44

def self.attribute_map
  {
    :'_for' => :'for',
    :'metrics' => :'metrics',
    :'date_from' => :'date_from',
    :'date_to' => :'date_to',
    :'timezone' => :'timezone',
    :'granularities' => :'granularities',
    :'quantiles' => :'quantiles',
    :'account' => :'account',
    :'split_by_check_runs' => :'split_by_check_runs'
  }
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
 
# File 'lib/athenian/models/code_check_metrics_request.rb', line 285

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



79
80
81
82
 
# File 'lib/athenian/models/code_check_metrics_request.rb', line 79

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

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/athenian/models/code_check_metrics_request.rb', line 64

def self.openapi_types
  {
    :'_for' => :'Array<ForSetCodeChecks>',
    :'metrics' => :'Array<CodeCheckMetricID>',
    :'date_from' => :'Date',
    :'date_to' => :'Date',
    :'timezone' => :'Integer',
    :'granularities' => :'Array<String>',
    :'quantiles' => :'Array<Float>',
    :'account' => :'Integer',
    :'split_by_check_runs' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/athenian/models/code_check_metrics_request.rb', line 256

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _for == o._for &&
      metrics == o.metrics &&
      date_from == o.date_from &&
      date_to == o.date_to &&
      timezone == o.timezone &&
      granularities == o.granularities &&
      quantiles == o.quantiles &&
       == o. &&
      split_by_check_runs == o.split_by_check_runs
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
352
353
 
# File 'lib/athenian/models/code_check_metrics_request.rb', line 316

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



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/athenian/models/code_check_metrics_request.rb', line 387

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



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

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


272
273
274
 
# File 'lib/athenian/models/code_check_metrics_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/athenian/models/code_check_metrics_request.rb', line 278

def hash
  [_for, metrics, date_from, date_to, timezone, granularities, quantiles, , split_by_check_runs].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



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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/athenian/models/code_check_metrics_request.rb', line 146

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

  if @metrics.nil?
    invalid_properties.push('invalid value for "metrics", metrics 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 @granularities.nil?
    invalid_properties.push('invalid value for "granularities", granularities cannot be nil.')
  end

  if @granularities.length < 1
    invalid_properties.push('invalid value for "granularities", number of items must be greater than or equal to 1.')
  end

  if !@quantiles.nil? && @quantiles.length > 2
    invalid_properties.push('invalid value for "quantiles", number of items must be less than or equal to 2.')
  end

  if !@quantiles.nil? && @quantiles.length < 2
    invalid_properties.push('invalid value for "quantiles", number of items must be greater than or equal to 2.')
  end

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



363
364
365
 
# File 'lib/athenian/models/code_check_metrics_request.rb', line 363

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



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/athenian/models/code_check_metrics_request.rb', line 369

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



357
358
359
 
# File 'lib/athenian/models/code_check_metrics_request.rb', line 357

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/athenian/models/code_check_metrics_request.rb', line 197

def valid?
  return false if @_for.nil?
  return false if @metrics.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 @granularities.nil?
  return false if @granularities.length < 1
  return false if !@quantiles.nil? && @quantiles.length > 2
  return false if !@quantiles.nil? && @quantiles.length < 2
  return false if @account.nil?
  true
end