Class: ShipEngine::Dimensions

Inherits:
Object
  • Object
show all
Defined in:
lib/ship_engine/models/dimensions.rb

Overview

The dimensions of a package

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Dimensions

Initializes the object



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/ship_engine/models/dimensions.rb', line 57

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::Dimensions` 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|

    h[k.to_sym] = v
  }

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

  if attributes.key?(:'length')
    self.length = attributes[:'length']
  else
    self.length = 0
  end

  if attributes.key?(:'width')
    self.width = attributes[:'width']
  else
    self.width = 0
  end

  if attributes.key?(:'height')
    self.height = attributes[:'height']
  else
    self.height = 0
  end
end

Instance Attribute Details

#height ⇒ Object

The length of the package, in the specified unit



27
28
29
 
# File 'lib/ship_engine/models/dimensions.rb', line 27

def height
  @height
end

#length ⇒ Object

The length of the package, in the specified unit



21
22
23
 
# File 'lib/ship_engine/models/dimensions.rb', line 21

def length
  @length
end

#unit ⇒ Object

Returns the value of attribute unit.



18
19
20
 
# File 'lib/ship_engine/models/dimensions.rb', line 18

def unit
  @unit
end

#width ⇒ Object

The width of the package, in the specified unit



24
25
26
 
# File 'lib/ship_engine/models/dimensions.rb', line 24

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
 
# File 'lib/ship_engine/models/dimensions.rb', line 30

def self.attribute_map
  {
    :'unit' => :'unit',
    :'length' => :'length',
    :'width' => :'width',
    :'height' => :'height'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



207
208
209
 
# File 'lib/ship_engine/models/dimensions.rb', line 207

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



50
51
52
53
 
# File 'lib/ship_engine/models/dimensions.rb', line 50

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

.openapi_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
 
# File 'lib/ship_engine/models/dimensions.rb', line 40

def self.openapi_types
  {
    :'unit' => :'DimensionUnit',
    :'length' => :'Float',
    :'width' => :'Float',
    :'height' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



183
184
185
186
187
188
189
190
 
# File 'lib/ship_engine/models/dimensions.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      unit == o.unit &&
      length == o.length &&
      width == o.width &&
      height == o.height
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/ship_engine/models/dimensions.rb', line 235

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



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/ship_engine/models/dimensions.rb', line 304

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/ship_engine/models/dimensions.rb', line 214

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]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


194
195
196
 
# File 'lib/ship_engine/models/dimensions.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



200
201
202
 
# File 'lib/ship_engine/models/dimensions.rb', line 200

def hash
  [unit, length, width, height].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



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
 
# File 'lib/ship_engine/models/dimensions.rb', line 93

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

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

  if @length < 0
    invalid_properties.push('invalid value for "length", must be greater than or equal to 0.')
  end

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

  if @width < 0
    invalid_properties.push('invalid value for "width", must be greater than or equal to 0.')
  end

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

  if @height < 0
    invalid_properties.push('invalid value for "height", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



280
281
282
 
# File 'lib/ship_engine/models/dimensions.rb', line 280

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/ship_engine/models/dimensions.rb', line 286

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



274
275
276
 
# File 'lib/ship_engine/models/dimensions.rb', line 274

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



128
129
130
131
132
133
134
135
136
137
 
# File 'lib/ship_engine/models/dimensions.rb', line 128

def valid?
  return false if @unit.nil?
  return false if @length.nil?
  return false if @length < 0
  return false if @width.nil?
  return false if @width < 0
  return false if @height.nil?
  return false if @height < 0
  true
end