Class: Omniship::Address

Inherits:
Object show all
Defined in:
lib/omniship/address.rb

Constant Summary collapse

ADDRESS_TYPES = 
%w{residential commercial po_box}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Address

Returns a new instance of Address.



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/omniship/address.rb', line 27

def initialize(options = {})
  @country = (options[:country].nil? or options[:country].is_a?(ActiveUtils::Country)) ?
      options[:country] :
      ActiveUtils::Country.find(options[:country])
  @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]
  @attention_name = options[:attention_name]

  self.address_type = options[:address_type]
end

Instance Attribute Details

#address1 ⇒ Object (readonly)

Returns the value of attribute address1.



5
6
7
 
# File 'lib/omniship/address.rb', line 5

def address1
  @address1
end

#address2 ⇒ Object (readonly)

Returns the value of attribute address2.



5
6
7
 
# File 'lib/omniship/address.rb', line 5

def address2
  @address2
end

#address3 ⇒ Object (readonly)

Returns the value of attribute address3.



5
6
7
 
# File 'lib/omniship/address.rb', line 5

def address3
  @address3
end

#address_type ⇒ Object

Returns the value of attribute address_type.



5
6
7
 
# File 'lib/omniship/address.rb', line 5

def address_type
  @address_type
end

#attention_name ⇒ Object (readonly)

Returns the value of attribute attention_name.



5
6
7
 
# File 'lib/omniship/address.rb', line 5

def attention_name
  @attention_name
end

#city ⇒ Object (readonly)

Returns the value of attribute city.



5
6
7
 
# File 'lib/omniship/address.rb', line 5

def city
  @city
end

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

Returns the value of attribute company_name.



5
6
7
 
# File 'lib/omniship/address.rb', line 5

def company_name
  @company_name
end

#country ⇒ Object (readonly)

Returns the value of attribute country.



5
6
7
 
# File 'lib/omniship/address.rb', line 5

def country
  @country
end

#fax ⇒ Object (readonly)

Returns the value of attribute fax.



5
6
7
 
# File 'lib/omniship/address.rb', line 5

def fax
  @fax
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



5
6
7
 
# File 'lib/omniship/address.rb', line 5

def name
  @name
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/omniship/address.rb', line 5

def options
  @options
end

#phone ⇒ Object (readonly)

Returns the value of attribute phone.



5
6
7
 
# File 'lib/omniship/address.rb', line 5

def phone
  @phone
end

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

Returns the value of attribute postal_code.



5
6
7
 
# File 'lib/omniship/address.rb', line 5

def postal_code
  @postal_code
end

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

Returns the value of attribute province.



5
6
7
 
# File 'lib/omniship/address.rb', line 5

def province
  @province
end

Class Method Details

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/omniship/address.rb', line 46

def self.from(object, options={})
  return object if object.is_a? Omniship::Address
  attr_mappings = {
    :name           => [:name],
    :attention_name => [:attention_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]
  }
  attributes = {}
  hash_access = begin
    object[:some_symbol]
    true
  rescue
    false
  end
  attr_mappings.each do |pair|
    pair[1].each do |sym|
      if value = (object[sym] if hash_access) || (object.send(sym) if object.respond_to?(sym) && (!hash_access || !Hash.public_instance_methods.include?(sym.to_s)))
        attributes[pair[0]] = value
        break
      end
    end
  end
  attributes.delete(:address_type) unless ADDRESS_TYPES.include?(attributes[:address_type].to_s)
  self.new(attributes.update(options))
end

Instance Method Details

#commercial? ⇒ Boolean

Returns:

  • (Boolean) 


87
 
# File 'lib/omniship/address.rb', line 87

def commercial?; @address_type == 'commercial' end

#country_code(format = :alpha2) ⇒ Object 



82
83
84
 
# File 'lib/omniship/address.rb', line 82

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

#inspect ⇒ Object 



131
132
133
134
135
136
 
# File 'lib/omniship/address.rb', line 131

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

#po_box? ⇒ Boolean

Returns:

  • (Boolean) 


88
 
# File 'lib/omniship/address.rb', line 88

def po_box?; @address_type == 'po_box' end

#prettyprint ⇒ Object 



123
124
125
126
127
128
129
 
# File 'lib/omniship/address.rb', line 123

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

#residential? ⇒ Boolean

Returns:

  • (Boolean) 


86
 
# File 'lib/omniship/address.rb', line 86

def residential?; @address_type == 'residential' end

#to_hash ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/omniship/address.rb', line 96

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,
    :attention_name => attention_name
  }
end

#to_s ⇒ Object 



119
120
121
 
# File 'lib/omniship/address.rb', line 119

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

#to_xml(options = {}) ⇒ Object 



114
115
116
117
 
# File 'lib/omniship/address.rb', line 114

def to_xml(options={})
  options[:root] ||= "address"
  to_hash.to_xml(options)
end