Class: Lishogi::ChallengeJson

Inherits:
Object
  • Object
show all
Defined in:
lib/lishogi/models/challenge_json.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChallengeJson

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/lishogi/models/challenge_json.rb', line 118

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

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

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = nil
  end

  if attributes.key?(:'challenger')
    self.challenger = attributes[:'challenger']
  else
    self.challenger = nil
  end

  if attributes.key?(:'dest_user')
    self.dest_user = attributes[:'dest_user']
  else
    self.dest_user = nil
  end

  if attributes.key?(:'variant')
    self.variant = attributes[:'variant']
  else
    self.variant = nil
  end

  if attributes.key?(:'rated')
    self.rated = attributes[:'rated']
  else
    self.rated = nil
  end

  if attributes.key?(:'speed')
    self.speed = attributes[:'speed']
  else
    self.speed = nil
  end

  if attributes.key?(:'time_control')
    self.time_control = attributes[:'time_control']
  else
    self.time_control = nil
  end

  if attributes.key?(:'color')
    self.color = attributes[:'color']
  else
    self.color = nil
  end

  if attributes.key?(:'perf')
    self.perf = attributes[:'perf']
  else
    self.perf = nil
  end

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

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

Instance Attribute Details

#challenger ⇒ Object

Returns the value of attribute challenger.



24
25
26
 
# File 'lib/lishogi/models/challenge_json.rb', line 24

def challenger
  @challenger
end

#color ⇒ Object

Returns the value of attribute color.



36
37
38
 
# File 'lib/lishogi/models/challenge_json.rb', line 36

def color
  @color
end

#dest_user ⇒ Object

Returns the value of attribute dest_user.



26
27
28
 
# File 'lib/lishogi/models/challenge_json.rb', line 26

def dest_user
  @dest_user
end

#direction ⇒ Object

Returns the value of attribute direction.



40
41
42
 
# File 'lib/lishogi/models/challenge_json.rb', line 40

def direction
  @direction
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/lishogi/models/challenge_json.rb', line 18

def id
  @id
end

#initial_sfen ⇒ Object

Returns the value of attribute initial_sfen.



42
43
44
 
# File 'lib/lishogi/models/challenge_json.rb', line 42

def initial_sfen
  @initial_sfen
end

#perf ⇒ Object

Returns the value of attribute perf.



38
39
40
 
# File 'lib/lishogi/models/challenge_json.rb', line 38

def perf
  @perf
end

#rated ⇒ Object

Returns the value of attribute rated.



30
31
32
 
# File 'lib/lishogi/models/challenge_json.rb', line 30

def rated
  @rated
end

#speed ⇒ Object

Returns the value of attribute speed.



32
33
34
 
# File 'lib/lishogi/models/challenge_json.rb', line 32

def speed
  @speed
end

#status ⇒ Object

Returns the value of attribute status.



22
23
24
 
# File 'lib/lishogi/models/challenge_json.rb', line 22

def status
  @status
end

#time_control ⇒ Object

Returns the value of attribute time_control.



34
35
36
 
# File 'lib/lishogi/models/challenge_json.rb', line 34

def time_control
  @time_control
end

#url ⇒ Object

Returns the value of attribute url.



20
21
22
 
# File 'lib/lishogi/models/challenge_json.rb', line 20

def url
  @url
end

#variant ⇒ Object

Returns the value of attribute variant.



28
29
30
 
# File 'lib/lishogi/models/challenge_json.rb', line 28

def variant
  @variant
end

Class Method Details

._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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/lishogi/models/challenge_json.rb', line 366

def self._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 = Lishogi.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/lishogi/models/challenge_json.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'url' => :'url',
    :'status' => :'status',
    :'challenger' => :'challenger',
    :'dest_user' => :'destUser',
    :'variant' => :'variant',
    :'rated' => :'rated',
    :'speed' => :'speed',
    :'time_control' => :'timeControl',
    :'color' => :'color',
    :'perf' => :'perf',
    :'direction' => :'direction',
    :'initial_sfen' => :'initialSfen'
  }
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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/lishogi/models/challenge_json.rb', line 342

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



110
111
112
113
114
 
# File 'lib/lishogi/models/challenge_json.rb', line 110

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/lishogi/models/challenge_json.rb', line 91

def self.openapi_types
  {
    :'id' => :'String',
    :'url' => :'String',
    :'status' => :'String',
    :'challenger' => :'ChallengeUser',
    :'dest_user' => :'ChallengeUser',
    :'variant' => :'Variant',
    :'rated' => :'Boolean',
    :'speed' => :'Speed',
    :'time_control' => :'ChallengeJsonTimeControl',
    :'color' => :'String',
    :'perf' => :'ChallengeJsonPerf',
    :'direction' => :'String',
    :'initial_sfen' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/lishogi/models/challenge_json.rb', line 309

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      url == o.url &&
      status == o.status &&
      challenger == o.challenger &&
      dest_user == o.dest_user &&
      variant == o.variant &&
      rated == o.rated &&
      speed == o.speed &&
      time_control == o.time_control &&
      color == o.color &&
      perf == o.perf &&
      direction == o.direction &&
      initial_sfen == o.initial_sfen
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



437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/lishogi/models/challenge_json.rb', line 437

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


329
330
331
 
# File 'lib/lishogi/models/challenge_json.rb', line 329

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



335
336
337
 
# File 'lib/lishogi/models/challenge_json.rb', line 335

def hash
  [id, url, status, challenger, dest_user, variant, rated, speed, time_control, color, perf, direction, initial_sfen].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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/lishogi/models/challenge_json.rb', line 208

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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 @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

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

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

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

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

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

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

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



413
414
415
 
# File 'lib/lishogi/models/challenge_json.rb', line 413

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



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/lishogi/models/challenge_json.rb', line 419

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



407
408
409
 
# File 'lib/lishogi/models/challenge_json.rb', line 407

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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/lishogi/models/challenge_json.rb', line 256

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @url.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["created", "offline", "declined", "accepted"])
  return false unless status_validator.valid?(@status)
  return false if @challenger.nil?
  return false if @variant.nil?
  return false if @rated.nil?
  return false if @speed.nil?
  return false if @time_control.nil?
  return false if @color.nil?
  color_validator = EnumAttributeValidator.new('String', ["sente", "gote", "random"])
  return false unless color_validator.valid?(@color)
  return false if @perf.nil?
  direction_validator = EnumAttributeValidator.new('String', ["in", "out"])
  return false unless direction_validator.valid?(@direction)
  true
end