Class: FCP::Address

Inherits:
Object
  • Object
show all
Defined in:
lib/first-class-postcodes/models/address.rb

Overview

Represents an address, including all the numbers associated with it.

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



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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/first-class-postcodes/models/address.rb', line 59

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

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

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

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

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

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

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

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

Instance Attribute Details

#city ⇒ Object

City or national locality component, if applicable.



13
14
15
 
# File 'lib/first-class-postcodes/models/address.rb', line 13

def city
  @city
end

#country ⇒ Object

The name of the country, ie. "United Kingdom"



25
26
27
 
# File 'lib/first-class-postcodes/models/address.rb', line 25

def country
  @country
end

#county ⇒ Object

The national state, province, prefecture, or region component, if applicable.



19
20
21
 
# File 'lib/first-class-postcodes/models/address.rb', line 19

def county
  @county
end

#district ⇒ Object

The postal district corresponding to the postcode.



16
17
18
 
# File 'lib/first-class-postcodes/models/address.rb', line 16

def district
  @district
end

#numbers ⇒ Object

All the house, flat and building numbers that belong to the postcode.



10
11
12
 
# File 'lib/first-class-postcodes/models/address.rb', line 10

def numbers
  @numbers
end

#position ⇒ Object

Returns the value of attribute position.



27
28
29
 
# File 'lib/first-class-postcodes/models/address.rb', line 27

def position
  @position
end

#postcode ⇒ Object

Zip or postal code for the location, if applicable.



22
23
24
 
# File 'lib/first-class-postcodes/models/address.rb', line 22

def postcode
  @postcode
end

#street ⇒ Object

The full name of the street.



7
8
9
 
# File 'lib/first-class-postcodes/models/address.rb', line 7

def street
  @street
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
38
39
40
41
 
# File 'lib/first-class-postcodes/models/address.rb', line 30

def self.attribute_map
  {
    :'street' => :'street',
    :'numbers' => :'numbers',
    :'city' => :'city',
    :'district' => :'district',
    :'county' => :'county',
    :'postcode' => :'postcode',
    :'country' => :'country',
    :'position' => :'position'
  }
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



185
186
187
 
# File 'lib/first-class-postcodes/models/address.rb', line 185

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

.openapi_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/first-class-postcodes/models/address.rb', line 44

def self.openapi_types
  {
    :'street' => :'String',
    :'numbers' => :'Array<String>',
    :'city' => :'String',
    :'district' => :'String',
    :'county' => :'String',
    :'postcode' => :'String',
    :'country' => :'String',
    :'position' => :'Position'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/first-class-postcodes/models/address.rb', line 157

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      street == o.street &&
      numbers == o.numbers &&
      city == o.city &&
      district == o.district &&
      county == o.county &&
      postcode == o.postcode &&
      country == o.country &&
      position == o.position
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



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
 
# File 'lib/first-class-postcodes/models/address.rb', line 213

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/first-class-postcodes/models/address.rb', line 278

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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/first-class-postcodes/models/address.rb', line 192

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


172
173
174
 
# File 'lib/first-class-postcodes/models/address.rb', line 172

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



178
179
180
 
# File 'lib/first-class-postcodes/models/address.rb', line 178

def hash
  [street, numbers, city, district, county, postcode, country, position].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



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
 
# File 'lib/first-class-postcodes/models/address.rb', line 109

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

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

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

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

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

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

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



258
259
260
 
# File 'lib/first-class-postcodes/models/address.rb', line 258

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



264
265
266
267
268
269
270
271
272
 
# File 'lib/first-class-postcodes/models/address.rb', line 264

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



252
253
254
 
# File 'lib/first-class-postcodes/models/address.rb', line 252

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



144
145
146
147
148
149
150
151
152
153
 
# File 'lib/first-class-postcodes/models/address.rb', line 144

def valid?
  return false if @street.nil?
  return false if @city.nil?
  return false if @district.nil?
  return false if @county.nil?
  return false if @postcode.nil?
  return false if @country.nil?
  return false if @position.nil?
  true
end