Class: ActiveShipping::Location

Inherits:
Object
  • Object
show all
Defined in:
lib/active_shipping/location.rb

Constant Summary collapse

ADDRESS_TYPES = 
%w(residential commercial po_box)
ATTRIBUTE_ALIASES = 
{
  name: [:name],
  country: [:country_code, :country],
  postal_code: [:postal_code, :zip, :postal],
  province: [:province_code, :state_code, :territory_code, :region_code, :province, :state, :territory, :region],
  city: [:city, :town],
  address1: [:address1, :address, :street],
  address2: [:address2],
  address3: [:address3],
  phone: [:phone, :phone_number],
  fax: [:fax, :fax_number],
  address_type: [:address_type],
  company_name: [:company, :company_name],
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Location

Returns a new instance of Location.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/active_shipping/location.rb', line 41

def initialize(options = {})
  @country = if options[:country].nil? || options[:country].is_a?(ActiveUtils::Country)
    options[:country]
  else
    ActiveUtils::Country.find(options[:country])
  end

  @postal_code = options[:postal_code] || options[:postal] || options[:zip]
  @province = options[:province] || options[:state] || options[:territory] || options[:region]
  @city = options[:city]
  @name = options[:name]
  @address1 = options[:address1]
  @address2 = options[:address2]
  @address3 = options[:address3]
  @phone = options[:phone]
  @fax = options[:fax]
  @company_name = options[:company_name] || options[:company]

  self.address_type = options[:address_type]
end

Instance Attribute Details

#address1 ⇒ Object (readonly)

Returns the value of attribute address1.



20
21
22
 
# File 'lib/active_shipping/location.rb', line 20

def address1
  @address1
end

#address2 ⇒ Object (readonly)

Returns the value of attribute address2.



20
21
22
 
# File 'lib/active_shipping/location.rb', line 20

def address2
  @address2
end

#address3 ⇒ Object (readonly)

Returns the value of attribute address3.



20
21
22
 
# File 'lib/active_shipping/location.rb', line 20

def address3
  @address3
end

#address_type ⇒ Object

Returns the value of attribute address_type.



20
21
22
 
# File 'lib/active_shipping/location.rb', line 20

def address_type
  @address_type
end

#city ⇒ Object (readonly)

Returns the value of attribute city.



20
21
22
 
# File 'lib/active_shipping/location.rb', line 20

def city
  @city
end

#company_name ⇒ Object (readonly) Also known as: company

Returns the value of attribute company_name.



20
21
22
 
# File 'lib/active_shipping/location.rb', line 20

def company_name
  @company_name
end

#country ⇒ Object (readonly)

Returns the value of attribute country.



20
21
22
 
# File 'lib/active_shipping/location.rb', line 20

def country
  @country
end

#fax ⇒ Object (readonly)

Returns the value of attribute fax.



20
21
22
 
# File 'lib/active_shipping/location.rb', line 20

def fax
  @fax
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



20
21
22
 
# File 'lib/active_shipping/location.rb', line 20

def name
  @name
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



20
21
22
 
# File 'lib/active_shipping/location.rb', line 20

def options
  @options
end

#phone ⇒ Object (readonly)

Returns the value of attribute phone.



20
21
22
 
# File 'lib/active_shipping/location.rb', line 20

def phone
  @phone
end

#postal_code ⇒ Object (readonly) Also known as: zip, postal

Returns the value of attribute postal_code.



20
21
22
 
# File 'lib/active_shipping/location.rb', line 20

def postal_code
  @postal_code
end

#province ⇒ Object (readonly) Also known as: state, territory, region

Returns the value of attribute province.



20
21
22
 
# File 'lib/active_shipping/location.rb', line 20

def province
  @province
end

Class Method Details

.from(object, options = {}) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/active_shipping/location.rb', line 62

def self.from(object, options = {})
  return object if object.is_a?(ActiveShipping::Location)

  attributes = {}

  hash_access = object.respond_to?(:[])

  ATTRIBUTE_ALIASES.each do |attribute, aliases|
    aliases.detect do |sym|
      value = object[sym] if hash_access
      if !value &&
        object.respond_to?(sym) &&
        (!hash_access || !Hash.public_instance_methods.include?(sym))
        value = object.send(sym)
      end

      attributes[attribute] = value if value
    end
  end

  attributes.delete(:address_type) unless ADDRESS_TYPES.include?(attributes[:address_type].to_s)

  new(attributes.update(options))
end

Instance Method Details

#==(other) ⇒ Object 



157
158
159
 
# File 'lib/active_shipping/location.rb', line 157

def ==(other)
  to_hash == other.to_hash
end

#address2_and_3 ⇒ Object 



153
154
155
 
# File 'lib/active_shipping/location.rb', line 153

def address2_and_3
  [address2, address3].reject(&:blank?).join(", ")
end

#commercial? ⇒ Boolean

Returns:

  • (Boolean) 


95
96
97
 
# File 'lib/active_shipping/location.rb', line 95

def commercial?
  @address_type == 'commercial'
end

#country_code(format = :alpha2) ⇒ Object 



87
88
89
 
# File 'lib/active_shipping/location.rb', line 87

def country_code(format = :alpha2)
  @country.nil? ? nil : @country.code(format).value
end

#inspect ⇒ Object 



141
142
143
144
145
146
 
# File 'lib/active_shipping/location.rb', line 141

def inspect
  string = prettyprint
  string << "\nPhone: #{@phone}" unless @phone.blank?
  string << "\nFax: #{@fax}" unless @fax.blank?
  string
end

#po_box? ⇒ Boolean

Returns:

  • (Boolean) 


99
100
101
 
# File 'lib/active_shipping/location.rb', line 99

def po_box?
  @address_type == 'po_box'
end

#prettyprint ⇒ Object 



134
135
136
137
138
139
 
# File 'lib/active_shipping/location.rb', line 134

def prettyprint
  chunks = [@name, @address1, @address2, @address3]
  chunks << [@city, @province, @postal_code].reject(&:blank?).join(', ')
  chunks << @country
  chunks.reject(&:blank?).join("\n")
end

#residential? ⇒ Boolean

Returns:

  • (Boolean) 


91
92
93
 
# File 'lib/active_shipping/location.rb', line 91

def residential?
  @address_type == 'residential'
end

#to_hash ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/active_shipping/location.rb', line 113

def to_hash
  {
    country: country_code,
    postal_code: postal_code,
    province: province,
    city: city,
    name: name,
    address1: address1,
    address2: address2,
    address3: address3,
    phone: phone,
    fax: fax,
    address_type: address_type,
    company_name: company_name
  }
end

#to_s ⇒ Object 



130
131
132
 
# File 'lib/active_shipping/location.rb', line 130

def to_s
  prettyprint.gsub(/\n/, ' ')
end

#unknown? ⇒ Boolean

Returns:

  • (Boolean) 


103
104
105
 
# File 'lib/active_shipping/location.rb', line 103

def unknown?
  country_code == 'ZZ'
end

#zip_plus_4 ⇒ Object

Returns the postal code as a properly formatted Zip+4 code, e.g. "77095-2233"



149
150
151
 
# File 'lib/active_shipping/location.rb', line 149

def zip_plus_4
  "#{$1}-#{$2}" if /(\d{5})-?(\d{4})/ =~ @postal_code
end