snail 0.5.7 → 0.6.0

data/lib/snail.rb

@@ -11,10 +11,10 @@ end
 
 class Snail
   include Configurable
-  
+
   # this will be raised whenever formatting or validation is run on an unsupported or unknown country
   class UnknownCountryError < ArgumentError; end
-  
+
   # My made-up standard fields.
   attr_accessor :name
   attr_accessor :line_1
@@ -23,7 +23,7 @@ class Snail
   attr_accessor :region
   attr_accessor :postal_code
   attr_accessor :country
-  
+
   # Aliases for easier assignment compatibility
   {
     :full_name  => :name,
@@ -39,64 +39,86 @@ class Snail
   end
 
   def self.home_country
-    @home_country ||= "USA"
+    @home_country ||= "US"
   end
 
   def self.home_country=(val)
-    @home_country = val
+    @home_country = lookup_country_iso(val)
+  end
+
+  def self.lookup_country_iso(val)
+    return nil if val.blank?
+    val = val.upcase
+    if ::Snail::Iso3166::ALPHA2[val]
+      val
+    elsif iso = ::Snail::Iso3166::ALPHA2_EXCEPTIONS[val]
+      iso
+    elsif iso = ::Snail::Iso3166::ALPHA3_TO_ALPHA2[val]
+      iso
+    elsif iso_pair = ::Snail::Iso3166::ALPHA2.find { |a2, names| names.include?(val) }
+      ActiveSupport::Deprecation.warn("Country name lookup will be deprecated in the near future. Please pass ISO3166 country codes to Snail instead.", caller)
+      iso_pair.first
+    else
+      nil
+    end
   end
-  
+
+  # Store country as ISO-3166 Alpha 2
+  def country=(val)
+    @country = Snail.lookup_country_iso(val)
+  end
+
   def to_s
     [name, line_1, line_2, city_line, country_line].select{|line| !(line.nil? or line.empty?)}.join("\n")
   end
-  
-  def to_html 
+
+  def to_html
     "<address>#{CGI.escapeHTML(to_s).gsub("\n", '<br />')}</address>".html_safe
   end
-  
+
   # this method will get much larger. completeness is out of my scope at this time.
   # currently it's based on the sampling of city line formats from frank's compulsive guide.
   def city_line
     case country
-    when 'China', 'India'
+    when 'CN', 'IN'
       "#{city}, #{region}  #{postal_code}"
-    when 'Brazil'
+    when 'BR'
       "#{postal_code} #{city}-#{region}"
-    when 'Mexico', 'Slovakia'
+    when 'MX', 'SK'
       "#{postal_code} #{city}, #{region}"
-    when 'Italy'
+    when 'IT'
       "#{postal_code} #{city} (#{region})"
-    when 'Belarus'
+    when 'BY'
       "#{postal_code} #{city}-(#{region})"
-    when 'USA', 'Canada', 'Australia', nil, ""
+    when 'US', 'CA', 'AU', nil, ""
       "#{city} #{region}  #{postal_code}"
-    when 'Israel', 'Denmark', 'Finland', 'France', 'Germany', 'Greece', 'Italy', 'Norway', 'Spain', 'Sweden', 'Turkey', 'Cyprus', 'Portugal', 'Macedonia', 'Bosnia and Herzegovina'
+    when 'IL', 'DK', 'FI', 'FR', 'DE', 'GR', 'IT', 'NO', 'ES', 'SE', 'TR', 'CY', 'PT', 'MK', 'BA'
       "#{postal_code} #{city}"
-    when 'Kuwait', 'Syria', 'Oman', 'Estonia','Luxembourg', 'Belgium', 'Iceland', 'Switzerland', 'Austria', 'Moldova', 'Montenegro', 'Serbia', 'Bulgaria', 'Georgia', 'Poland', 'Armenia', 'Croatia', 'Romania', 'Azerbaijan'
+    when 'KW', 'SY', 'OM', 'EE', 'LU', 'BE', 'IS', 'CH', 'AT', 'MD', 'ME', 'RS', 'BG', 'GE', 'PL', 'AM', 'HR', 'RO', 'AZ'
       "#{postal_code} #{city}"
-    when 'Netherlands'
-      "#{postal_code} #{region} #{city}"
-    when 'Ireland'
+    when 'NL'
+      "#{postal_code}  #{city}"
+    when 'IE'
       "#{city}, #{region}"
-    when 'England', 'Scotland', 'Wales', 'United Kingdom', 'Russia', 'Russian Federation', 'Ukraine', 'Jordan', 'Lebanon','Iran, Islamic Republic of', 'Iran', 'Saudi Arabia', 'New Zealand'
+    when 'GB', 'RU', 'UA', 'JO', 'LB', 'IR', 'SA', 'NZ'
       "#{city}  #{postal_code}" # Locally these may be on separate lines. The USPS prefers the city line above the country line, though.
-    when 'Ecuador'
+    when 'EC'
       "#{postal_code} #{city}"
-    when 'Hong Kong', 'Syria', 'Iraq', 'Yemen', 'Qatar', 'Albania'
+    when 'HK', 'IQ', 'YE', 'QA', 'AL'
       "#{city}"
-    when 'United Arab Emirates'
+    when 'AE'
       "#{postal_code}\n#{city}"
-    when 'Japan'
+    when 'JP'
       "#{city}, #{region}\n#{postal_code}"
-    when 'Egypt', 'South Africa','Isle of Man', 'Kazakhstan', 'Hungary'
+    when 'EG', 'ZA', 'IM', 'KZ', 'HU'
       "#{city}\n#{postal_code}"
-    when 'Latvia'
+    when 'LV'
       "#{city}, LV-#{postal_code}"
-    when 'Lithuania'
+    when 'LT'
       "LT-#{postal_code} #{city}"
-    when 'Slovenia'
+    when 'SI'
       "SI-#{postal_code} #{city}"
-    when 'Czech Republic'
+    when 'CZ'
       "#{postal_code} #{region}\n#{city}"
     else
       if Kernel.const_defined?("Rails")
@@ -105,8 +127,9 @@ class Snail
       "#{city} #{region}  #{postal_code}"
     end
   end
-  
+
+  # TODO after country name lookup deprecation, add localized country names to this
   def country_line
-    self.class.home_country.to_s.upcase == country.to_s.upcase ? nil : country.to_s.upcase
+    ::Snail::Iso3166::ALPHA2[country].first if country and self.class.home_country != country
   end
 end

data/lib/snail/constants.rb

@@ -112,6 +112,7 @@ class Snail
     'Kenya',
     'Kiribati',
     'Korea',
+    'Kosovo',
     'Kuwait',
     'Kyrgyzstan',
     'Laos',
@@ -172,7 +173,7 @@ class Snail
     'Republic of the Congo',
     'Reunion',
     'Romania',
-    'Russia',
+    'Russian Federation',
     'Rwanda',
     'Saint Helena',
     'Saint Kitts and Nevis',
@@ -194,6 +195,7 @@ class Snail
     'Somalia',
     'South Africa',
     'South Georgia',
+    'South Sudan',
     'Spain',
     'Sri Lanka',
     'Sudan',
@@ -333,6 +335,7 @@ class Snail
       "Armed Forces Europe" => "AE",
       "Armed Forces Middle East" => "AE",
       "Armed Forces Pacific" => "AP",
+      "Australia" => "AQ"
     }
   }
 
@@ -342,5 +345,514 @@ class Snail
   CA_PROVINCES = REGIONS[:ca]
   AU_REGIONS   = REGIONS[:au]
 
+  module Iso3166
+    # as of June 3rd, 2010
+    # pulled http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+    ALPHA2 = {
+      'AD' => ["ANDORRA"],
+      'AE' => ["UNITED ARAB EMIRATES"],
+      'AF' => ["AFGHANISTAN"],
+      'AG' => ["ANTIGUA AND BARBUDA"],
+      'AI' => ["ANGUILLA"],
+      'AL' => ["ALBANIA"],
+      'AM' => ["ARMENIA"],
+      'AN' => ["NETHERLANDS ANTILLES"],
+      'AO' => ["ANGOLA"],
+      'AQ' => ["ANTARCTICA"],
+      'AR' => ["ARGENTINA"],
+      'AS' => ["AMERICAN SAMOA"],
+      'AT' => ["AUSTRIA"],
+      'AU' => ["AUSTRALIA"],
+      'AW' => ["ARUBA"],
+      'AX' => ["ALAND ISLANDS"],
+      'AZ' => ["AZERBAIJAN"],
+      'BA' => ["BOSNIA AND HERZEGOVINA"],
+      'BB' => ["BARBADOS"],
+      'BD' => ["BANGLADESH"],
+      'BE' => ["BELGIUM"],
+      'BF' => ["BURKINA FASO"],
+      'BG' => ["BULGARIA"],
+      'BH' => ["BAHRAIN"],
+      'BI' => ["BURUNDI"],
+      'BJ' => ["BENIN"],
+      'BL' => ["SAINT BARTHELEMY"],
+      'BM' => ["BERMUDA"],
+      'BN' => ["BRUNEI DARUSSALAM"],
+      'BO' => ["BOLIVIA"],
+      'BR' => ["BRAZIL"],
+      'BS' => ["BAHAMAS"],
+      'BT' => ["BHUTAN"],
+      'BV' => ["BOUVET ISLAND"],
+      'BW' => ["BOTSWANA"],
+      'BY' => ["BELARUS"],
+      'BZ' => ["BELIZE"],
+      'CA' => ["CANADA"],
+      'CC' => ["COCOS (KEELING) ISLANDS"],
+      'CD' => ["DEMOCRATIC REPUBLIC OF THE CONGO"],
+      'CF' => ["CENTRAL AFRICAN REPUBLIC"],
+      'CG' => ["CONGO", "REPUBLIC OF THE CONGO"],
+      'CH' => ["SWITZERLAND"],
+      'CI' => ["COTE D'IVOIRE"],
+      'CK' => ["COOK ISLANDS"],
+      'CL' => ["CHILE"],
+      'CM' => ["CAMEROON"],
+      'CN' => ["CHINA", "PEOPLE'S REPUBLIC OF CHINA"],
+      'CO' => ["COLOMBIA"],
+      'CR' => ["COSTA RICA"],
+      'CU' => ["CUBA"],
+      'CV' => ["CAPE VERDE"],
+      'CX' => ["CHRISTMAS ISLAND"],
+      'CY' => ["CYPRUS"],
+      'CZ' => ["CZECH REPUBLIC"],
+      'DE' => ["GERMANY"],
+      'DJ' => ["DJIBOUTI"],
+      'DK' => ["DENMARK"],
+      'DM' => ["DOMINICA"],
+      'DO' => ["DOMINICAN REPUBLIC"],
+      'DZ' => ["ALGERIA"],
+      'EC' => ["ECUADOR"],
+      'EE' => ["ESTONIA"],
+      'EG' => ["EGYPT"],
+      'EH' => ["WESTERN SAHARA"],
+      'ER' => ["ERITREA"],
+      'ES' => ["SPAIN"],
+      'ET' => ["ETHIOPIA"],
+      'FI' => ["FINLAND"],
+      'FJ' => ["FIJI"],
+      'FK' => ["FALKLAND ISLANDS"],
+      'FM' => ["MICRONESIA"],
+      'FO' => ["FAROE ISLANDS"],
+      'FR' => ["FRANCE"],
+      'GA' => ["GABON"],
+      'GB' => ["UNITED KINGDOM", "ENGLAND", "NORTHERN IRELAND", "SCOTLAND", "WALES"],
+      'GD' => ["GRENADA"],
+      'GE' => ["GEORGIA"],
+      'GF' => ["FRENCH GUIANA"],
+      'GG' => ["GUERNSEY"],
+      'GH' => ["GHANA"],
+      'GI' => ["GIBRALTAR"],
+      'GL' => ["GREENLAND"],
+      'GM' => ["GAMBIA"],
+      'GN' => ["GUINEA"],
+      'GP' => ["GUADELOUPE"],
+      'GQ' => ["EQUATORIAL GUINEA"],
+      'GR' => ["GREECE"],
+      'GS' => ["SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS"],
+      'GT' => ["GUATEMALA"],
+      'GU' => ["GUAM"],
+      'GW' => ["GUINEA-BISSAU"],
+      'GY' => ["GUYANA"],
+      'HK' => ["HONG KONG"],
+      'HM' => ["HEARD ISLAND AND MCDONALD ISLANDS"],
+      'HN' => ["HONDURAS"],
+      'HR' => ["CROATIA"],
+      'HT' => ["HAITI"],
+      'HU' => ["HUNGARY"],
+      'ID' => ["INDONESIA"],
+      'IE' => ["IRELAND"],
+      'IL' => ["ISRAEL"],
+      'IM' => ["ISLE OF MAN"],
+      'IN' => ["INDIA"],
+      'IO' => ["BRITISH INDIAN OCEAN TERRITORY"],
+      'IQ' => ["IRAQ"],
+      'IR' => ["IRAN", "ISLAMIC REPUBLIC OF IRAN"],
+      'IS' => ["ICELAND"],
+      'IT' => ["ITALY"],
+      'JE' => ["JERSEY"],
+      'JM' => ["JAMAICA"],
+      'JO' => ["JORDAN"],
+      'JP' => ["JAPAN"],
+      'KE' => ["KENYA"],
+      'KG' => ["KYRGYZSTAN"],
+      'KH' => ["CAMBODIA"],
+      'KI' => ["KIRIBATI"],
+      'KM' => ["COMOROS"],
+      'KN' => ["SAINT KITTS AND NEVIS"],
+      'KP' => ["NORTH KOREA", "DEMOCRATIC PEOPLE'S REPUBLIC OF KOREA"],
+      'KR' => ["SOUTH KOREA", "KOREA", "REPUBLIC OF KOREA"],
+      'KW' => ["KUWAIT"],
+      'KY' => ["CAYMAN ISLANDS"],
+      'KZ' => ["KAZAKHSTAN"],
+      'LA' => ["LAOS"],
+      'LB' => ["LEBANON"],
+      'LC' => ["SAINT LUCIA"],
+      'LI' => ["LIECHTENSTEIN"],
+      'LK' => ["SRI LANKA"],
+      'LR' => ["LIBERIA"],
+      'LS' => ["LESOTHO"],
+      'LT' => ["LITHUANIA"],
+      'LU' => ["LUXEMBOURG"],
+      'LV' => ["LATVIA"],
+      'LY' => ["LIBYAN ARAB JAMAHIRIYA"],
+      'MA' => ["MOROCCO"],
+      'MC' => ["MONACO"],
+      'MD' => ["MOLDOVA"],
+      'ME' => ["MONTENEGRO"],
+      'MF' => ["SAINT MARTIN"],
+      'MG' => ["MADAGASCAR"],
+      'MH' => ["MARSHALL ISLANDS"],
+      'MK' => ["MACEDONIA"],
+      'ML' => ["MALI"],
+      'MM' => ["MYANMAR"],
+      'MN' => ["MONGOLIA"],
+      'MO' => ["MACAO"],
+      'MP' => ["NORTHERN MARIANA ISLANDS"],
+      'MQ' => ["MARTINIQUE"],
+      'MR' => ["MAURITANIA"],
+      'MS' => ["MONTSERRAT"],
+      'MT' => ["MALTA"],
+      'MU' => ["MAURITIUS"],
+      'MV' => ["MALDIVES"],
+      'MW' => ["MALAWI"],
+      'MX' => ["MEXICO"],
+      'MY' => ["MALAYSIA"],
+      'MZ' => ["MOZAMBIQUE"],
+      'NA' => ["NAMIBIA"],
+      'NC' => ["NEW CALEDONIA"],
+      'NE' => ["NIGER"],
+      'NF' => ["NORFOLK ISLAND"],
+      'NG' => ["NIGERIA"],
+      'NI' => ["NICARAGUA"],
+      'NL' => ["NETHERLANDS"],
+      'NO' => ["NORWAY"],
+      'NP' => ["NEPAL"],
+      'NR' => ["NAURU"],
+      'NU' => ["NIUE"],
+      'NZ' => ["NEW ZEALAND"],
+      'OM' => ["OMAN"],
+      'PA' => ["PANAMA"],
+      'PE' => ["PERU"],
+      'PF' => ["FRENCH POLYNESIA"],
+      'PG' => ["PAPUA NEW GUINEA"],
+      'PH' => ["PHILIPPINES"],
+      'PK' => ["PAKISTAN"],
+      'PL' => ["POLAND"],
+      'PM' => ["SAINT PIERRE AND MIQUELON"],
+      'PN' => ["PITCAIRN"],
+      'PR' => ["PUERTO RICO"],
+      'PS' => ["PALESTINIAN TERRITORIES"],
+      'PT' => ["PORTUGAL"],
+      'PW' => ["PALAU"],
+      'PY' => ["PARAGUAY"],
+      'QA' => ["QATAR"],
+      'RE' => ["REUNION"],
+      'RO' => ["ROMANIA"],
+      'RS' => ["SERBIA"],
+      'RU' => ["RUSSIAN FEDERATION", "RUSSIA"],
+      'RW' => ["RWANDA"],
+      'SA' => ["SAUDI ARABIA"],
+      'SB' => ["SOLOMON ISLANDS"],
+      'SC' => ["SEYCHELLES"],
+      'SD' => ["SUDAN"],
+      'SE' => ["SWEDEN"],
+      'SG' => ["SINGAPORE"],
+      'SH' => ["SAINT HELENA"],
+      'SI' => ["SLOVENIA"],
+      'SJ' => ["SVALBARD AND JAN MAYEN"],
+      'SK' => ["SLOVAKIA"],
+      'SL' => ["SIERRA LEONE"],
+      'SM' => ["SAN MARINO"],
+      'SN' => ["SENEGAL"],
+      'SO' => ["SOMALIA"],
+      'SR' => ["SURINAME"],
+      'SS' => ["SOUTH SUDAN"],
+      'ST' => ["SAO TOME AND PRINCIPE"],
+      'SV' => ["EL SALVADOR"],
+      'SY' => ["SYRIAN ARAB REPUBLIC", "SYRIA"],
+      'SZ' => ["SWAZILAND"],
+      'TC' => ["TURKS AND CAICOS ISLANDS"],
+      'TD' => ["CHAD"],
+      'TF' => ["FRENCH SOUTHERN TERRITORIES"],
+      'TG' => ["TOGO"],
+      'TH' => ["THAILAND"],
+      'TJ' => ["TAJIKISTAN"],
+      'TK' => ["TOKELAU"],
+      'TL' => ["TIMOR-LESTE"],
+      'TM' => ["TURKMENISTAN"],
+      'TN' => ["TUNISIA"],
+      'TO' => ["TONGA"],
+      'TR' => ["TURKEY"],
+      'TT' => ["TRINIDAD AND TOBAGO"],
+      'TV' => ["TUVALU"],
+      'TW' => ["TAIWAN"],
+      'TZ' => ["TANZANIA"],
+      'UA' => ["UKRAINE"],
+      'UG' => ["UGANDA"],
+      'UM' => ["UNITED STATES MINOR OUTLYING ISLANDS"],
+      'US' => ["UNITED STATES", "UNITED STATES OF AMERICA"],
+      'UY' => ["URUGUAY"],
+      'UZ' => ["UZBEKISTAN"],
+      'VA' => ["VATICAN CITY"],
+      'VC' => ["SAINT VINCENT AND THE GRENADINES"],
+      'VE' => ["VENEZUELA"],
+      'VG' => ["VIRGIN ISLANDS, BRITISH"],
+      'VI' => ["VIRGIN ISLANDS, U.S."],
+      'VN' => ["VIET NAM"],
+      'VU' => ["VANUATU"],
+      'WF' => ["WALLIS AND FUTUNA"],
+      'WS' => ["SAMOA"],
+      'YE' => ["YEMEN"],
+      'YT' => ["MAYOTTE"],
+      'ZA' => ["SOUTH AFRICA"],
+      'ZM' => ["ZAMBIA"],
+      'ZW' => ["ZIMBABWE"]
+    }
+    
+    ALPHA2_EXCEPTIONS = {
+      'UK' => 'GB', # great britain aka united kingdom
+      'FX' => 'FR', # france
+      'SU' => 'RU'  # russia
+    }
+    
+    ALPHA3_TO_ALPHA2 = {
+      "ABW" => "AW",
+      "AFG" => "AF",
+      "AGO" => "AO",
+      "AIA" => "AI",
+      "ALA" => "AX",
+      "ALB" => "AL",
+      "AND" => "AD",
+      "ANT" => "AN",
+      "ARE" => "AE",
+      "ARG" => "AR",
+      "ARM" => "AM",
+      "ASM" => "AS",
+      "ATA" => "AQ",
+      "ATF" => "TF",
+      "ATG" => "AG",
+      "AUS" => "AU",
+      "AUT" => "AT",
+      "AZE" => "AZ",
+      "BDI" => "BI",
+      "BEL" => "BE",
+      "BEN" => "BJ",
+      "BFA" => "BF",
+      "BGD" => "BD",
+      "BGR" => "BG",
+      "BHR" => "BH",
+      "BHS" => "BS",
+      "BIH" => "BA",
+      "BLM" => "BL",
+      "BLR" => "BY",
+      "BLZ" => "BZ",
+      "BMU" => "BM",
+      "BOL" => "BO",
+      "BRA" => "BR",
+      "BRB" => "BB",
+      "BRN" => "BN",
+      "BTN" => "BT",
+      "BVT" => "BV",
+      "BWA" => "BW",
+      "CAF" => "CF",
+      "CAN" => "CA",
+      "CCK" => "CC",
+      "CHE" => "CH",
+      "CHL" => "CL",
+      "CHN" => "CN",
+      "CIV" => "CI",
+      "CMR" => "CM",
+      "COD" => "CD",
+      "COG" => "CG",
+      "COK" => "CK",
+      "COL" => "CO",
+      "COM" => "KM",
+      "CPV" => "CV",
+      "CRI" => "CR",
+      "CUB" => "CU",
+      "CXR" => "CX",
+      "CYM" => "KY",
+      "CYP" => "CY",
+      "CZE" => "CZ",
+      "DEU" => "DE",
+      "DJI" => "DJ",
+      "DMA" => "DM",
+      "DNK" => "DK",
+      "DOM" => "DO",
+      "DZA" => "DZ",
+      "ECU" => "EC",
+      "EGY" => "EG",
+      "ERI" => "ER",
+      "ESH" => "EH",
+      "ESP" => "ES",
+      "EST" => "EE",
+      "ETH" => "ET",
+      "FIN" => "FI",
+      "FJI" => "FJ",
+      "FLK" => "FK",
+      "FRA" => "FR",
+      "FRO" => "FO",
+      "FSM" => "FM",
+      "GAB" => "GA",
+      "GBR" => "GB",
+      "GEO" => "GE",
+      "GGY" => "GG",
+      "GHA" => "GH",
+      "GIB" => "GI",
+      "GIN" => "GN",
+      "GLP" => "GP",
+      "GMB" => "GM",
+      "GNB" => "GW",
+      "GNQ" => "GQ",
+      "GRC" => "GR",
+      "GRD" => "GD",
+      "GRL" => "GL",
+      "GTM" => "GT",
+      "GUF" => "GF",
+      "GUM" => "GU",
+      "GUY" => "GY",
+      "HKG" => "HK",
+      "HMD" => "HM",
+      "HND" => "HN",
+      "HRV" => "HR",
+      "HTI" => "HT",
+      "HUN" => "HU",
+      "IDN" => "ID",
+      "IMN" => "IM",
+      "IND" => "IN",
+      "IOT" => "IO",
+      "IRL" => "IE",
+      "IRN" => "IR",
+      "IRQ" => "IQ",
+      "ISL" => "IS",
+      "ISR" => "IL",
+      "ITA" => "IT",
+      "JAM" => "JM",
+      "JEY" => "JE",
+      "JOR" => "JO",
+      "JPN" => "JP",
+      "KAZ" => "KZ",
+      "KEN" => "KE",
+      "KGZ" => "KG",
+      "KHM" => "KH",
+      "KIR" => "KI",
+      "KNA" => "KN",
+      "KOR" => "KR",
+      "KWT" => "KW",
+      "LAO" => "LA",
+      "LBN" => "LB",
+      "LBR" => "LR",
+      "LBY" => "LY",
+      "LCA" => "LC",
+      "LIE" => "LI",
+      "LKA" => "LK",
+      "LSO" => "LS",
+      "LTU" => "LT",
+      "LUX" => "LU",
+      "LVA" => "LV",
+      "MAC" => "MO",
+      "MAF" => "MF",
+      "MAR" => "MA",
+      "MCO" => "MC",
+      "MDA" => "MD",
+      "MDG" => "MG",
+      "MDV" => "MV",
+      "MEX" => "MX",
+      "MHL" => "MH",
+      "MKD" => "MK",
+      "MLI" => "ML",
+      "MLT" => "MT",
+      "MMR" => "MM",
+      "MNE" => "ME",
+      "MNG" => "MN",
+      "MNP" => "MP",
+      "MOZ" => "MZ",
+      "MRT" => "MR",
+      "MSR" => "MS",
+      "MTQ" => "MQ",
+      "MUS" => "MU",
+      "MWI" => "MW",
+      "MYS" => "MY",
+      "MYT" => "YT",
+      "NAM" => "NA",
+      "NCL" => "NC",
+      "NER" => "NE",
+      "NFK" => "NF",
+      "NGA" => "NG",
+      "NIC" => "NI",
+      "NIU" => "NU",
+      "NLD" => "NL",
+      "NOR" => "NO",
+      "NPL" => "NP",
+      "NRU" => "NR",
+      "NZL" => "NZ",
+      "OMN" => "OM",
+      "PAK" => "PK",
+      "PAN" => "PA",
+      "PCN" => "PN",
+      "PER" => "PE",
+      "PHL" => "PH",
+      "PLW" => "PW",
+      "PNG" => "PG",
+      "POL" => "PL",
+      "PRI" => "PR",
+      "PRK" => "KP",
+      "PRT" => "PT",
+      "PRY" => "PY",
+      "PSE" => "PS",
+      "PYF" => "PF",
+      "QAT" => "QA",
+      "REU" => "RE",
+      "ROU" => "RO",
+      "RUS" => "RU",
+      "RWA" => "RW",
+      "SAU" => "SA",
+      "SDN" => "SD",
+      "SEN" => "SN",
+      "SGP" => "SG",
+      "SGS" => "GS",
+      "SHN" => "SH",
+      "SJM" => "SJ",
+      "SLB" => "SB",
+      "SLE" => "SL",
+      "SLV" => "SV",
+      "SMR" => "SM",
+      "SOM" => "SO",
+      "SPM" => "PM",
+      "SRB" => "RS",
+      "SSD" => "SS",
+      "STP" => "ST",
+      "SUR" => "SR",
+      "SVK" => "SK",
+      "SVN" => "SI",
+      "SWE" => "SE",
+      "SWZ" => "SZ",
+      "SYC" => "SC",
+      "SYR" => "SY",
+      "TCA" => "TC",
+      "TCD" => "TD",
+      "TGO" => "TG",
+      "THA" => "TH",
+      "TJK" => "TJ",
+      "TKL" => "TK",
+      "TKM" => "TM",
+      "TLS" => "TL",
+      "TON" => "TO",
+      "TTO" => "TT",
+      "TUN" => "TN",
+      "TUR" => "TR",
+      "TUV" => "TV",
+      "TWN" => "TW",
+      "TZA" => "TZ",
+      "UGA" => "UG",
+      "UKR" => "UA",
+      "UMI" => "UM",
+      "URY" => "UY",
+      "USA" => "US",
+      "UZB" => "UZ",
+      "VAT" => "VA",
+      "VCT" => "VC",
+      "VEN" => "VE",
+      "VGB" => "VG",
+      "VIR" => "VI",
+      "VNM" => "VN",
+      "VUT" => "VU",
+      "WLF" => "WF",
+      "WSM" => "WS",
+      "YEM" => "YE",
+      "ZAF" => "ZA",
+      "ZMB" => "ZM",
+      "ZWE" => "ZW"
+    }
+  end
 
 end

data/test/snail_test.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/test_helper'
 class SnailTest < ActiveSupport::TestCase
   def setup
     @us = {:name => "John Doe", :line_1 => "12345 5th St", :city => "Somewheres", :state => "NY", :zip => "12345", :country => 'USA'}
-    @ca = {:name => "John Doe", :line_1 => "12345 5th St", :city => "Somewheres", :state => "NY", :zip => "12345", :country => 'Canada'}
+    @ca = {:name => "John Doe", :line_1 => "12345 5th St", :city => "Somewheres", :state => "NY", :zip => "12345", :country => 'CAN'}
   end
 
   test "provides USPS country names" do
@@ -50,6 +50,35 @@ class SnailTest < ActiveSupport::TestCase
     assert_equal Snail.new(:postcode => "12345").postal_code, Snail.new(:postal_code => "12345").postal_code
   end
 
+  ##
+  ## Country Normalization
+  ##
+
+  test "normalize country name to alpha2" do
+    s = Snail.new(@ca.merge(:country => 'Slovenia'))
+    assert_equal "SI", s.country
+  end
+
+  test "normalize uppercase country name to alpha2" do
+    s = Snail.new(@ca.merge(:country => 'JAPAN'))
+    assert_equal "JP", s.country
+  end
+
+  test "normalize alpha3 to alpha2" do
+    s = Snail.new(@ca.merge(:country => 'SVN'))
+    assert_equal "SI", s.country
+  end
+
+  test "normalize alpha2 exceptions to alpha2" do
+    s = Snail.new(@ca.merge(:country => 'UK'))
+    assert_equal "GB", s.country
+  end
+
+  test "leave alpha2 as alpha2" do
+    s = Snail.new(@ca.merge(:country => 'GB'))
+    assert_equal "GB", s.country
+  end
+
   ##
   ## Formatting
   ##
@@ -73,7 +102,12 @@ class SnailTest < ActiveSupport::TestCase
 
   test "includes country name for international addresses" do
     s = Snail.new(@ca)
-    assert s.to_s.match(/Canada/i)
+    assert s.to_s.match(/Canada\Z/i), s.to_s
+  end
+
+  test "includes first country name for countries with many commonly used names" do
+    s = Snail.new(@ca.merge(:country => 'UK'))
+    assert s.to_s.match(/United Kingdom\Z/i), s.to_s
   end
 
   test "output ok if country is nil" do
@@ -83,7 +117,7 @@ class SnailTest < ActiveSupport::TestCase
 
   test "country names are uppercased" do
     s = Snail.new(@ca)
-    assert s.to_s.match(/CANADA/)
+    assert s.to_s.match(/CANADA/), s.to_s
   end
 
   test "empty lines are removed" do

metadata

@@ -1,76 +1,57 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: snail
-version: !ruby/object:Gem::Version 
-  hash: 5
-  prerelease: false
-  segments: 
-  - 0
-  - 5
-  - 7
-  version: 0.5.7
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Lance Ivy
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-23 00:00:00 -07:00
-default_executable: 
+date: 2012-07-09 00:00:00.000000000 Z
 dependencies: []
-
-description: International snail mail addressing is a pain. This begins to make it easier.
+description: International snail mail addressing is a pain. This begins to make it
+  easier.
 email: lance@cainlevy.net
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/snail/constants.rb
+files:
 - lib/snail/configurable.rb
+- lib/snail/constants.rb
 - lib/snail.rb
 - lib/snail_helpers.rb
-- test/test_helper.rb
 - test/snail_test.rb
+- test/test_helper.rb
 - README.rdoc
 - MIT-LICENSE
-has_rdoc: true
 homepage: http://github.com/cainlevy/snail
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --title
 - Snail
 - --line-numbers
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Easily format snail mail addresses for international delivery
 test_files: []
-
+has_rdoc: true