Class: ZipMoney::Address

Inherits:
Object
  • Object
show all
Defined in:
lib/zip_money/models/address.rb

Overview

The address object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Address

Initializes the object

Parameters:

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

    Model attributes in the form of hash



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/zip_money/models/address.rb', line 66

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'line1')
    self.line1 = attributes[:'line1']
  end

  if attributes.has_key?(:'line2')
    self.line2 = attributes[:'line2']
  end

  if attributes.has_key?(:'city')
    self.city = attributes[:'city']
  end

  if attributes.has_key?(:'state')
    self.state = attributes[:'state']
  end

  if attributes.has_key?(:'postal_code')
    self.postal_code = attributes[:'postal_code']
  end

  if attributes.has_key?(:'country')
    self.country = attributes[:'country']
  end

  if attributes.has_key?(:'first_name')
    self.first_name = attributes[:'first_name']
  end

  if attributes.has_key?(:'last_name')
    self.last_name = attributes[:'last_name']
  end

end

Instance Attribute Details

#city ⇒ Object

The address city



18
19
20
 
# File 'lib/zip_money/models/address.rb', line 18

def city
  @city
end

#country ⇒ Object

The ISO-3166 country code. See en.wikipedia.org/wiki/ISO_3166-1_alpha-2.



27
28
29
 
# File 'lib/zip_money/models/address.rb', line 27

def country
  @country
end

#first_name ⇒ Object

The recipient’s first name



30
31
32
 
# File 'lib/zip_money/models/address.rb', line 30

def first_name
  @first_name
end

#last_name ⇒ Object

The recipient’s last name



33
34
35
 
# File 'lib/zip_money/models/address.rb', line 33

def last_name
  @last_name
end

#line1 ⇒ Object

The first line in the address



12
13
14
 
# File 'lib/zip_money/models/address.rb', line 12

def line1
  @line1
end

#line2 ⇒ Object

The (optional) second address line



15
16
17
 
# File 'lib/zip_money/models/address.rb', line 15

def line2
  @line2
end

#postal_code ⇒ Object

The post or zip code



24
25
26
 
# File 'lib/zip_money/models/address.rb', line 24

def postal_code
  @postal_code
end

#state ⇒ Object

The state or province



21
22
23
 
# File 'lib/zip_money/models/address.rb', line 21

def state
  @state
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/zip_money/models/address.rb', line 37

def self.attribute_map
  {
    :'line1' => :'line1',
    :'line2' => :'line2',
    :'city' => :'city',
    :'state' => :'state',
    :'postal_code' => :'postal_code',
    :'country' => :'country',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name'
  }
end

.zip_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/zip_money/models/address.rb', line 51

def self.zip_types
  {
    :'line1' => :'String',
    :'line2' => :'String',
    :'city' => :'String',
    :'state' => :'String',
    :'postal_code' => :'String',
    :'country' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/zip_money/models/address.rb', line 282

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      line1 == o.line1 &&
      line2 == o.line2 &&
      city == o.city &&
      state == o.state &&
      postal_code == o.postal_code &&
      country == o.country &&
      first_name == o.first_name &&
      last_name == o.last_name
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



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/zip_money/models/address.rb', line 331

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
    temp_model = ZipMoney.const_get(type).new
    temp_model.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



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/zip_money/models/address.rb', line 397

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



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

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.zip_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


297
298
299
 
# File 'lib/zip_money/models/address.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



303
304
305
 
# File 'lib/zip_money/models/address.rb', line 303

def hash
  [line1, line2, city, state, postal_code, country, first_name, last_name].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



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
 
# File 'lib/zip_money/models/address.rb', line 108

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

  if @line1.to_s.length > 200
    invalid_properties.push("invalid value for 'line1', the character length must be smaller than or equal to 200.")
  end

  if !@line2.nil? && @line2.to_s.length > 200
    invalid_properties.push("invalid value for 'line2', the character length must be smaller than or equal to 200.")
  end

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

  if @city.to_s.length > 50
    invalid_properties.push("invalid value for 'city', the character length must be smaller than or equal to 50.")
  end

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

  if @state.to_s.length > 50
    invalid_properties.push("invalid value for 'state', the character length must be smaller than or equal to 50.")
  end

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

  if @postal_code.to_s.length > 15
    invalid_properties.push("invalid value for 'postal_code', the character length must be smaller than or equal to 15.")
  end

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

  if @country.to_s.length > 2
    invalid_properties.push("invalid value for 'country', the character length must be smaller than or equal to 2.")
  end

  if @country.to_s.length < 2
    invalid_properties.push("invalid value for 'country', the character length must be great than or equal to 2.")
  end

  if !@first_name.nil? && @first_name.to_s.length > 200
    invalid_properties.push("invalid value for 'first_name', the character length must be smaller than or equal to 200.")
  end

  return 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



377
378
379
 
# File 'lib/zip_money/models/address.rb', line 377

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



383
384
385
386
387
388
389
390
391
 
# File 'lib/zip_money/models/address.rb', line 383

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



371
372
373
 
# File 'lib/zip_money/models/address.rb', line 371

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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/zip_money/models/address.rb', line 167

def valid?
  return false if @line1.nil?
  return false if @line1.to_s.length > 200
  return false if !@line2.nil? && @line2.to_s.length > 200
  return false if @city.nil?
  return false if @city.to_s.length > 50
  return false if @state.nil?
  return false if @state.to_s.length > 50
  return false if @postal_code.nil?
  return false if @postal_code.to_s.length > 15
  return false if @country.nil?
  return false if @country.to_s.length > 2
  return false if @country.to_s.length < 2
  return false if !@first_name.nil? && @first_name.to_s.length > 200
  return true
end