Class: Athenian::FilterJIRAStuff

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

Overview

Request of ‘/filter/jira` to retrieve epics, labels, types, priorities, users, etc.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FilterJIRAStuff

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_return ⇒ Object

Specifies which items are required, an empty or missing array means everything.



49
50
51
 
# File 'lib/athenian/models/filter_jira_stuff.rb', line 49

def _return
  @_return
end

#account ⇒ Object

Session account ID.



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

def 
  @account
end

#date_from ⇒ Object

‘null` disables the time filter boundary, thus everything is returned. `date_from` and `date_to` must be both either `null` or not `null`.



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

def date_from
  @date_from
end

#date_to ⇒ Object

‘null` disables the time filter boundary, thus everything is returned. `date_from` and `date_to` must be both either `null` or not `null`.



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

def date_to
  @date_to
end

#exclude_inactive ⇒ Object

Value indicating whether issues with the last update older than ‘date_from` should be ignored. If `date_from` and `date_to` are `null`, does nothing.



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

def exclude_inactive
  @exclude_inactive
end

#labels_exclude ⇒ Object

JIRA issues may not contain labels from this list.



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

def labels_exclude
  @labels_exclude
end

#labels_include ⇒ Object

JIRA issues must contain at least one label from the list. Several labels may be concatenated by a comma ‘,` so that all of them are required.



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

def labels_include
  @labels_include
end

#priorities ⇒ Object

Selected issue priorities.



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

def priorities
  @priorities
end

#projects ⇒ Object

Issues must belong to these JIRA projects.



46
47
48
 
# File 'lib/athenian/models/filter_jira_stuff.rb', line 46

def projects
  @projects
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_jira_stuff.rb', line 26

def timezone
  @timezone
end

#types ⇒ Object

Selected issue types. Ignored for epics.



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

def types
  @types
end

#with ⇒ Object

Returns the value of attribute with.



43
44
45
 
# File 'lib/athenian/models/filter_jira_stuff.rb', line 43

def with
  @with
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



70
71
72
 
# File 'lib/athenian/models/filter_jira_stuff.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/athenian/models/filter_jira_stuff.rb', line 52

def self.attribute_map
  {
    :'account' => :'account',
    :'date_from' => :'date_from',
    :'date_to' => :'date_to',
    :'timezone' => :'timezone',
    :'priorities' => :'priorities',
    :'types' => :'types',
    :'labels_include' => :'labels_include',
    :'labels_exclude' => :'labels_exclude',
    :'exclude_inactive' => :'exclude_inactive',
    :'with' => :'with',
    :'projects' => :'projects',
    :'_return' => :'return'
  }
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



257
258
259
 
# File 'lib/athenian/models/filter_jira_stuff.rb', line 257

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



93
94
95
96
97
98
 
# File 'lib/athenian/models/filter_jira_stuff.rb', line 93

def self.openapi_nullable
  Set.new([
    :'date_from',
    :'date_to',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'account' => :'Integer',
    :'date_from' => :'Date',
    :'date_to' => :'Date',
    :'timezone' => :'Integer',
    :'priorities' => :'Array<String>',
    :'types' => :'Array<String>',
    :'labels_include' => :'Array<String>',
    :'labels_exclude' => :'Array<String>',
    :'exclude_inactive' => :'Boolean',
    :'with' => :'FilterJIRAStuffWith',
    :'projects' => :'Array<String>',
    :'_return' => :'Array<JIRAFilterReturn>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/athenian/models/filter_jira_stuff.rb', line 225

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 &&
      priorities == o.priorities &&
      types == o.types &&
      labels_include == o.labels_include &&
      labels_exclude == o.labels_exclude &&
      exclude_inactive == o.exclude_inactive &&
      with == o.with &&
      projects == o.projects &&
      _return == o._return
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



288
289
290
291
292
293
294
295
296
297
298
299
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
 
# File 'lib/athenian/models/filter_jira_stuff.rb', line 288

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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/athenian/models/filter_jira_stuff.rb', line 359

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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/athenian/models/filter_jira_stuff.rb', line 264

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


244
245
246
 
# File 'lib/athenian/models/filter_jira_stuff.rb', line 244

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



250
251
252
 
# File 'lib/athenian/models/filter_jira_stuff.rb', line 250

def hash
  [, date_from, date_to, timezone, priorities, types, labels_include, labels_exclude, exclude_inactive, with, projects, _return].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



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_jira_stuff.rb', line 178

def list_invalid_properties
  invalid_properties = Array.new
  if @account.nil?
    invalid_properties.push('invalid value for "account", account 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 @exclude_inactive.nil?
    invalid_properties.push('invalid value for "exclude_inactive", exclude_inactive 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



335
336
337
 
# File 'lib/athenian/models/filter_jira_stuff.rb', line 335

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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/athenian/models/filter_jira_stuff.rb', line 341

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



329
330
331
 
# File 'lib/athenian/models/filter_jira_stuff.rb', line 329

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

def valid?
  return false if @account.nil?
  return false if !@timezone.nil? && @timezone > 780
  return false if !@timezone.nil? && @timezone < -720
  return false if @exclude_inactive.nil?
  true
end