Class: Kleister::Mod

Inherits:
Object
  • Object
show all
Defined in:
lib/kleister/models/mod.rb

Overview

Model to represent mod

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Mod

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/kleister/models/mod.rb', line 104

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError, 'The input argument (attributes) must be a hash in `Kleister::Mod` initialize method'
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    unless self.class.attribute_map.key?(k.to_sym)
      raise ArgumentError, "`#{k}` is not a valid attribute in `Kleister::Mod`. 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
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#author ⇒ Object

Returns the value of attribute author.



17
18
19
 
# File 'lib/kleister/models/mod.rb', line 17

def author
  @author
end

#created_at ⇒ Object

Returns the value of attribute created_at.



17
18
19
 
# File 'lib/kleister/models/mod.rb', line 17

def created_at
  @created_at
end

#description ⇒ Object

Returns the value of attribute description.



17
18
19
 
# File 'lib/kleister/models/mod.rb', line 17

def description
  @description
end

Returns the value of attribute donate.



17
18
19
 
# File 'lib/kleister/models/mod.rb', line 17

def donate
  @donate
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/kleister/models/mod.rb', line 17

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



17
18
19
 
# File 'lib/kleister/models/mod.rb', line 17

def name
  @name
end

#public ⇒ Object

Returns the value of attribute public.



17
18
19
 
# File 'lib/kleister/models/mod.rb', line 17

def public
  @public
end

#side ⇒ Object

Returns the value of attribute side.



17
18
19
 
# File 'lib/kleister/models/mod.rb', line 17

def side
  @side
end

#slug ⇒ Object

Returns the value of attribute slug.



17
18
19
 
# File 'lib/kleister/models/mod.rb', line 17

def slug
  @slug
end

#teams ⇒ Object

Returns the value of attribute teams.



17
18
19
 
# File 'lib/kleister/models/mod.rb', line 17

def teams
  @teams
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



17
18
19
 
# File 'lib/kleister/models/mod.rb', line 17

def updated_at
  @updated_at
end

#users ⇒ Object

Returns the value of attribute users.



17
18
19
 
# File 'lib/kleister/models/mod.rb', line 17

def users
  @users
end

#versions ⇒ Object

Returns the value of attribute versions.



17
18
19
 
# File 'lib/kleister/models/mod.rb', line 17

def versions
  @versions
end

#website ⇒ Object

Returns the value of attribute website.



17
18
19
 
# File 'lib/kleister/models/mod.rb', line 17

def website
  @website
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



265
266
267
268
269
270
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
 
# File 'lib/kleister/models/mod.rb', line 265

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



61
62
63
 
# File 'lib/kleister/models/mod.rb', line 61

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/kleister/models/mod.rb', line 41

def self.attribute_map
  {
    id: :id,
    slug: :slug,
    name: :name,
    side: :side,
    description: :description,
    author: :author,
    website: :website,
    donate: :donate,
    public: :public,
    created_at: :created_at,
    updated_at: :updated_at,
    versions: :versions,
    users: :users,
    teams: :teams
  }
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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/kleister/models/mod.rb', line 240

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.to_s] = 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.to_s] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash[key.to_s] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/kleister/models/mod.rb', line 86

def self.openapi_nullable
  Set.new(%i[
            slug
            name
            side
            description
            author
            website
            donate
            public
            versions
            users
            teams
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    id: :String,
    slug: :String,
    name: :String,
    side: :String,
    description: :String,
    author: :String,
    website: :String,
    donate: :String,
    public: :Boolean,
    created_at: :Time,
    updated_at: :Time,
    versions: :'Array<Version>',
    users: :'Array<UserMod>',
    teams: :'Array<TeamMod>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/kleister/models/mod.rb', line 205

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    slug == other.slug &&
    name == other.name &&
    side == other.side &&
    description == other.description &&
    author == other.author &&
    website == other.website &&
    donate == other.donate &&
    public == other.public &&
    created_at == other.created_at &&
    updated_at == other.updated_at &&
    versions == other.versions &&
    users == other.users &&
    teams == other.teams
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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/kleister/models/mod.rb', line 336

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?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


227
228
229
 
# File 'lib/kleister/models/mod.rb', line 227

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



233
234
235
 
# File 'lib/kleister/models/mod.rb', line 233

def hash
  [id, slug, name, side, description, author, website, donate, public, created_at, updated_at, versions, users, teams].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



177
178
179
180
 
# File 'lib/kleister/models/mod.rb', line 177

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  []
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



312
313
314
 
# File 'lib/kleister/models/mod.rb', line 312

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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/kleister/models/mod.rb', line 318

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



306
307
308
 
# File 'lib/kleister/models/mod.rb', line 306

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



184
185
186
187
188
189
190
 
# File 'lib/kleister/models/mod.rb', line 184

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  side_validator = EnumAttributeValidator.new('String', %w[both server client])
  return false unless side_validator.valid?(@side)

  true
end