Class: Shortcut::IterationStats

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

Overview

A group of calculated values for this Iteration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IterationStats

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
143
144
145
146
147
148
 
# File 'lib/shortcut_client_ruby/models/iteration_stats.rb', line 92

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#average_cycle_time ⇒ Object

The average cycle time (in seconds) of completed stories in this Iteration.



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

def average_cycle_time
  @average_cycle_time
end

#average_lead_time ⇒ Object

The average lead time (in seconds) of completed stories in this Iteration.



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

def average_lead_time
  @average_lead_time
end

#num_points ⇒ Object

The total number of points in this Iteration.



45
46
47
 
# File 'lib/shortcut_client_ruby/models/iteration_stats.rb', line 45

def num_points
  @num_points
end

#num_points_done ⇒ Object

The total number of completed points in this Iteration.



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

def num_points_done
  @num_points_done
end

#num_points_started ⇒ Object

The total number of started points in this Iteration.



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

def num_points_started
  @num_points_started
end

#num_points_unstarted ⇒ Object

The total number of unstarted points in this Iteration.



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

def num_points_unstarted
  @num_points_unstarted
end

#num_related_documents ⇒ Object

The total number of documents related to an Iteration



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

def num_related_documents
  @num_related_documents
end

#num_stories_done ⇒ Object

The total number of done Stories in this Iteration.



48
49
50
 
# File 'lib/shortcut_client_ruby/models/iteration_stats.rb', line 48

def num_stories_done
  @num_stories_done
end

#num_stories_started ⇒ Object

The total number of started Stories in this Iteration.



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

def num_stories_started
  @num_stories_started
end

#num_stories_unestimated ⇒ Object

The total number of Stories with no point estimate.



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

def num_stories_unestimated
  @num_stories_unestimated
end

#num_stories_unstarted ⇒ Object

The total number of unstarted Stories in this Iteration.



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

def num_stories_unstarted
  @num_stories_unstarted
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/shortcut_client_ruby/models/iteration_stats.rb', line 51

def self.attribute_map
  {
    :'num_points_done' => :'num_points_done',
    :'num_related_documents' => :'num_related_documents',
    :'average_cycle_time' => :'average_cycle_time',
    :'num_stories_unstarted' => :'num_stories_unstarted',
    :'num_points_started' => :'num_points_started',
    :'num_points_unstarted' => :'num_points_unstarted',
    :'num_stories_started' => :'num_stories_started',
    :'num_stories_unestimated' => :'num_stories_unestimated',
    :'average_lead_time' => :'average_lead_time',
    :'num_points' => :'num_points',
    :'num_stories_done' => :'num_stories_done'
  }
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



241
242
243
 
# File 'lib/shortcut_client_ruby/models/iteration_stats.rb', line 241

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



85
86
87
88
 
# File 'lib/shortcut_client_ruby/models/iteration_stats.rb', line 85

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

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/shortcut_client_ruby/models/iteration_stats.rb', line 68

def self.openapi_types
  {
    :'num_points_done' => :'Object',
    :'num_related_documents' => :'Object',
    :'average_cycle_time' => :'Object',
    :'num_stories_unstarted' => :'Object',
    :'num_points_started' => :'Object',
    :'num_points_unstarted' => :'Object',
    :'num_stories_started' => :'Object',
    :'num_stories_unestimated' => :'Object',
    :'average_lead_time' => :'Object',
    :'num_points' => :'Object',
    :'num_stories_done' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/shortcut_client_ruby/models/iteration_stats.rb', line 210

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      num_points_done == o.num_points_done &&
      num_related_documents == o.num_related_documents &&
      average_cycle_time == o.average_cycle_time &&
      num_stories_unstarted == o.num_stories_unstarted &&
      num_points_started == o.num_points_started &&
      num_points_unstarted == o.num_points_unstarted &&
      num_stories_started == o.num_stories_started &&
      num_stories_unestimated == o.num_stories_unestimated &&
      average_lead_time == o.average_lead_time &&
      num_points == o.num_points &&
      num_stories_done == o.num_stories_done
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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/shortcut_client_ruby/models/iteration_stats.rb', line 271

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



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/shortcut_client_ruby/models/iteration_stats.rb', line 340

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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/shortcut_client_ruby/models/iteration_stats.rb', line 248

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


228
229
230
 
# File 'lib/shortcut_client_ruby/models/iteration_stats.rb', line 228

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



234
235
236
 
# File 'lib/shortcut_client_ruby/models/iteration_stats.rb', line 234

def hash
  [num_points_done, num_related_documents, average_cycle_time, num_stories_unstarted, num_points_started, num_points_unstarted, num_stories_started, num_stories_unestimated, average_lead_time, num_points, num_stories_done].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



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
 
# File 'lib/shortcut_client_ruby/models/iteration_stats.rb', line 152

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

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

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

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

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

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

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

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

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



316
317
318
 
# File 'lib/shortcut_client_ruby/models/iteration_stats.rb', line 316

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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/shortcut_client_ruby/models/iteration_stats.rb', line 322

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



310
311
312
 
# File 'lib/shortcut_client_ruby/models/iteration_stats.rb', line 310

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



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

def valid?
  return false if @num_points_done.nil?
  return false if @num_related_documents.nil?
  return false if @num_stories_unstarted.nil?
  return false if @num_points_started.nil?
  return false if @num_points_unstarted.nil?
  return false if @num_stories_started.nil?
  return false if @num_stories_unestimated.nil?
  return false if @num_points.nil?
  return false if @num_stories_done.nil?
  true
end