snail 1.2.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66d476f925ee1a96953e978455d3156a569d81e0
-  data.tar.gz: e8b7178abc333e38faaddc9d01e082115485ea75
+  metadata.gz: 262c3219f21ad619b858424c360885d11d3f1522
+  data.tar.gz: c6f39b55987d70ac3715c808e6c1b2aa45e8a747
 SHA512:
-  metadata.gz: 538632807048301e388d015de06e804cf0cc8d8f55e46f203dc866040f812cd3e6585714f8c784a87a702875aa47e17c1a23fd915120cb04f06899acf2f21f80
-  data.tar.gz: 8ad23a9974f1d142d50aa1566ec42c208faa4f0c95ac8dc283fa4732080eec96f49cf84fc7afad5bec55e5b6ef174a75bb60a9e74bb3b762ae0662748650f19e
+  metadata.gz: d6269557deae28f0d52d330824fdc99123e447e95937185412761a61782518ab6f195491e19f86017649b3421420b5ba66fe2f931e6975ff2aa34e60f5bb66c7
+  data.tar.gz: d1a6b9356bf78d26f5480cf65be7a8bdb26dbd57c5e1c7f3c33354ef5ca2556e2a784bfdac932c4cd2c0c61755f162e0ff1272ac82e0ff4d562f0b0b11d88910

data/README.md

@@ -0,0 +1,65 @@
+# Snail
+
+International snail mail addressing is a pain. This gem begins to make it easier.
+
+## Problems
+
+The first problem when sending mail is getting it OUT of the originating country. This means writing the destination country in a manner that the originating country understands.
+
+The second problem is getting it TO the correct address. This means writing the address lines in a manner that the destination country understands.
+
+## Solutions
+
+Snail relies on practical formatting guidelines gathered by [Frank's Compulsive Guide to Postal Addresses](http://www.columbia.edu/kermit/postal.html), plus internationalized country names from [The Unicode CLDR Project](http://cldr.unicode.org/index).
+
+## Getting Started
+
+Taking regular data and formatting it into an internationally mailable address:
+
+```ruby
+Snail.new(
+  :name => "Jon Doe",
+  :line_1 => "12345 Somewhere Ln",
+  :line_2 => nil,
+  :city => "Bentley",
+  :region => "WA",
+  :postal_code => "6102",
+  :country => "AU"
+).to_s
+
+=> "Jon Doe\n12345 Somewhere Ln\nBENTLEY WA  6102\nAUSTRALIA"
+```
+
+By default addresses with a country of USA are considered domestic and the country will
+be left off any output. To change the home country:
+
+```ruby
+Snail.home_country = "Australia"
+Snail.new(
+  :name => "Jon Doe",
+  :line_1 => "12345 Somewhere Ln",
+  :line_2 => nil,
+  :city => "Bentley",
+  :region => "WA",
+  :postal_code => "6102",
+  :country => "AU"
+).to_s
+
+=> "Jon Doe\n12345 Somewhere Ln\nBENTLEY WA  6102"
+```
+
+See the test cases for more.
+
+## Fun Times
+
+The United States Postal Service (USPS) requires (strongly prefers?) a few things:
+
+* That the address be 5 lines long or less.
+* That the last address line be a country name recognized by the USPS, in all uppercase.
+* That the city line (comprising the city, state, and postal code as appropriate) immediately precede the country line.
+
+Nearly all of the variation in formatting rules applies to the city line. Depending on the receiving country, the three component pieces (e.g. city, state, postal code) have different names, are pieced together in different order with different punctuation, and may or may not be required.
+
+And then there's Great Britain, which Frank's Compulsive Guide describes as "where to find the most confusing addresses on earth" (a description confirmed and further confused by a source from within Royal Mail).
+
+Copyright (c) 2009-2016 Lance Ivy, released under the MIT license

data/assets/AD.yml

@@ -0,0 +1,249 @@
+AD: ANDORRA
+AE: EMIRATS ÀRABS UNITS
+AF: AFGANISTAN
+AG: ANTIGUA I BARBUDA
+AI: ANGUILLA
+AL: ALBÀNIA
+AM: ARMÈNIA
+AO: ANGOLA
+AQ: ANTÀRTIDA
+AR: ARGENTINA
+AS: SAMOA NORD-AMERICANA
+AT: ÀUSTRIA
+AU: AUSTRÀLIA
+AW: ARUBA
+AX: ILLES ÅLAND
+AZ: AZERBAIDJAN
+BA: BÒSNIA I HERCEGOVINA
+BB: BARBADOS
+BD: BANGLA DESH
+BE: BÈLGICA
+BF: BURKINA FASO
+BG: BULGÀRIA
+BH: BAHRAIN
+BI: BURUNDI
+BJ: BENÍN
+BL: SAINT BARTHÉLEMY
+BM: BERMUDES
+BN: BRUNEI
+BO: BOLÍVIA
+BQ: CARIB NEERLANDÈS
+BR: BRASIL
+BS: BAHAMES
+BT: BHUTAN
+BV: BOUVET
+BW: BOTSWANA
+BY: BELARÚS
+BZ: BELIZE
+CA: CANADÀ
+CC: ILLES COCOS
+CD: CONGO - KINSHASA
+CF: REPÚBLICA CENTREAFRICANA
+CG: CONGO - BRAZZAVILLE
+CH: SUÏSSA
+CI: COSTA D’IVORI
+CK: ILLES COOK
+CL: XILE
+CM: CAMERUN
+CN: XINA
+CO: COLÒMBIA
+CR: COSTA RICA
+CU: CUBA
+CV: CAP VERD
+CW: CURAÇAO
+CX: ILLA CHRISTMAS
+CY: XIPRE
+CZ: REPÚBLICA TXECA
+DE: ALEMANYA
+DJ: DJIBOUTI
+DK: DINAMARCA
+DM: DOMINICA
+DO: REPÚBLICA DOMINICANA
+DZ: ALGÈRIA
+EC: EQUADOR
+EE: ESTÒNIA
+EG: EGIPTE
+EH: SÀHARA OCCIDENTAL
+ER: ERITREA
+ES: ESPANYA
+ET: ETIÒPIA
+FI: FINLÀNDIA
+FJ: FIJI
+FK: ILLES MALVINES
+FM: MICRONÈSIA
+FO: ILLES FÈROE
+FR: FRANÇA
+GA: GABON
+GB: REGNE UNIT
+GD: GRENADA
+GE: GEÒRGIA
+GF: GUAIANA FRANCESA
+GG: GUERNSEY
+GH: GHANA
+GI: GIBRALTAR
+GL: GRENLÀNDIA
+GM: GÀMBIA
+GN: GUINEA
+GP: GUADELOUPE
+GQ: GUINEA EQUATORIAL
+GR: GRÈCIA
+GS: ILLES GEÒRGIA DEL SUD I SANDWICH DEL SUD
+GT: GUATEMALA
+GU: GUAM
+GW: GUINEA BISSAU
+GY: GUYANA
+HK: HONG KONG (RAE XINA)
+HM: ILLA HEARD I ILLES MCDONALD
+HN: HONDURES
+HR: CROÀCIA
+HT: HAITÍ
+HU: HONGRIA
+ID: INDONÈSIA
+IE: IRLANDA
+IL: ISRAEL
+IM: ILLA DE MAN
+IN: ÍNDIA
+IO: TERRITORI BRITÀNIC DE L’OCEÀ ÍNDIC
+IQ: IRAQ
+IR: IRAN
+IS: ISLÀNDIA
+IT: ITÀLIA
+JE: JERSEY
+JM: JAMAICA
+JO: JORDÀNIA
+JP: JAPÓ
+KE: KENYA
+KG: KIRGUIZISTAN
+KH: CAMBODJA
+KI: KIRIBATI
+KM: COMORES
+KN: SAINT CHRISTOPHER I NEVIS
+KP: COREA DEL NORD
+KR: COREA DEL SUD
+KW: KUWAIT
+KY: ILLES CAIMAN
+KZ: KAZAKHSTAN
+LA: LAOS
+LB: LÍBAN
+LC: SAINT LUCIA
+LI: LIECHTENSTEIN
+LK: SRI LANKA
+LR: LIBÈRIA
+LS: LESOTHO
+LT: LITUÀNIA
+LU: LUXEMBURG
+LV: LETÒNIA
+LY: LÍBIA
+MA: MARROC
+MC: MÒNACO
+MD: MOLDÀVIA
+ME: MONTENEGRO
+MF: SAINT MARTIN
+MG: MADAGASCAR
+MH: ILLES MARSHALL
+MK: MACEDÒNIA
+ML: MALI
+MM: MYANMAR (BIRMÀNIA)
+MN: MONGÒLIA
+MO: MACAU (RAE XINA)
+MP: ILLES MARIANNES DEL NORD
+MQ: MARTINICA
+MR: MAURITÀNIA
+MS: MONTSERRAT
+MT: MALTA
+MU: MAURICI
+MV: MALDIVES
+MW: MALAWI
+MX: MÈXIC
+MY: MALÀISIA
+MZ: MOÇAMBIC
+NA: NAMÍBIA
+NC: NOVA CALEDÒNIA
+NE: NÍGER
+NF: NORFOLK
+NG: NIGÈRIA
+NI: NICARAGUA
+NL: PAÏSOS BAIXOS
+NO: NORUEGA
+NP: NEPAL
+NR: NAURU
+NU: NIUE
+NZ: NOVA ZELANDA
+OM: OMAN
+PA: PANAMÀ
+PE: PERÚ
+PF: POLINÈSIA FRANCESA
+PG: PAPUA NOVA GUINEA
+PH: FILIPINES
+PK: PAKISTAN
+PL: POLÒNIA
+PM: SAINT-PIERRE-ET-MIQUELON
+PN: ILLES PITCAIRN
+PR: PUERTO RICO
+PS: PALESTINA
+PT: PORTUGAL
+PW: PALAU
+PY: PARAGUAI
+QA: QATAR
+RE: ILLA DE LA REUNIÓ
+RO: ROMANIA
+RS: SÈRBIA
+RU: RÚSSIA
+RW: RUANDA
+SA: ARÀBIA SAUDITA
+SB: ILLES SALOMÓ
+SC: SEYCHELLES
+SD: SUDAN
+SE: SUÈCIA
+SG: SINGAPUR
+SH: SAINT HELENA
+SI: ESLOVÈNIA
+SJ: SVALBARD I JAN MAYEN
+SK: ESLOVÀQUIA
+SL: SIERRA LEONE
+SM: SAN MARINO
+SN: SENEGAL
+SO: SOMÀLIA
+SR: SURINAM
+SS: SUDAN DEL SUD
+ST: SÃO TOMÉ I PRÍNCIPE
+SV: EL SALVADOR
+SX: SINT MAARTEN
+SY: SÍRIA
+SZ: SWAZILÀNDIA
+TC: ILLES TURKS I CAICOS
+TD: TXAD
+TF: TERRITORIS FRANCESOS DEL SUD
+TG: TOGO
+TH: TAILÀNDIA
+TJ: TADJIKISTAN
+TK: TOKELAU
+TL: TIMOR ORIENTAL
+TM: TURKMENISTAN
+TN: TUNÍSIA
+TO: TONGA
+TR: TURQUIA
+TT: TRINITAT I TOBAGO
+TV: TUVALU
+TW: TAIWAN
+TZ: TANZÀNIA
+UA: UCRAÏNA
+UG: UGANDA
+UM: ILLES PERIFÈRIQUES MENORS DELS EUA
+US: ESTATS UNITS
+UY: URUGUAI
+UZ: UZBEKISTAN
+VA: CIUTAT DEL VATICÀ
+VC: SAINT VINCENT I LES GRENADINES
+VE: VENEÇUELA
+VG: ILLES VERGES BRITÀNIQUES
+VI: ILLES VERGES NORD-AMERICANES
+VN: VIETNAM
+VU: VANUATU
+WF: WALLIS I FUTUNA
+WS: SAMOA
+YE: IEMEN
+YT: MAYOTTE
+ZA: REPÚBLICA DE SUD-ÀFRICA
+ZM: ZÀMBIA
+ZW: ZIMBÀBUE

data/assets/AE.yml

@@ -0,0 +1,249 @@
+AD: أندورا
+AE: الإمارات العربية المتحدة
+AF: أفغانستان
+AG: أنتيغوا وبربودا
+AI: أنغويلا
+AL: ألبانيا
+AM: أرمينيا
+AO: أنغولا
+AQ: أنتاركتيكا
+AR: الأرجنتين
+AS: ساموا الأمريكية
+AT: النمسا
+AU: أستراليا
+AW: أروبا
+AX: جزر آلاند
+AZ: أذربيجان
+BA: البوسنة والهرسك
+BB: بربادوس
+BD: بنجلاديش
+BE: بلجيكا
+BF: بوركينا فاسو
+BG: بلغاريا
+BH: البحرين
+BI: بوروندي
+BJ: بنين
+BL: سان بارتليمي
+BM: برمودا
+BN: بروناي
+BO: بوليفيا
+BQ: هولندا الكاريبية
+BR: البرازيل
+BS: البهاما
+BT: بوتان
+BV: جزيرة بوفيه
+BW: بتسوانا
+BY: بيلاروس
+BZ: بليز
+CA: كندا
+CC: جزر كوكوس (كيلينغ)
+CD: الكونغو - كينشاسا
+CF: جمهورية أفريقيا الوسطى
+CG: الكونغو - برازافيل
+CH: سويسرا
+CI: ساحل العاج
+CK: جزر كوك
+CL: تشيلي
+CM: الكاميرون
+CN: الصين
+CO: كولومبيا
+CR: كوستاريكا
+CU: كوبا
+CV: الرأس الأخضر
+CW: كوراساو
+CX: جزيرة الكريسماس
+CY: قبرص
+CZ: جمهورية التشيك
+DE: ألمانيا
+DJ: جيبوتي
+DK: الدانمرك
+DM: دومينيكا
+DO: جمهورية الدومينيك
+DZ: الجزائر
+EC: الإكوادور
+EE: إستونيا
+EG: مصر
+EH: الصحراء الغربية
+ER: إريتريا
+ES: إسبانيا
+ET: إثيوبيا
+FI: فنلندا
+FJ: فيجي
+FK: جزر فوكلاند
+FM: ميكرونيزيا
+FO: جزر فارو
+FR: فرنسا
+GA: الجابون
+GB: المملكة المتحدة
+GD: غرينادا
+GE: جورجيا
+GF: غويانا الفرنسية
+GG: غيرنزي
+GH: غانا
+GI: جبل طارق
+GL: غرينلاند
+GM: غامبيا
+GN: غينيا
+GP: غوادلوب
+GQ: غينيا الإستوائية
+GR: اليونان
+GS: جورجيا الجنوبية وجزر ساندويتش الجنوبية
+GT: غواتيمالا
+GU: غوام
+GW: غينيا بيساو
+GY: غيانا
+HK: هونغ كونغ الصينية
+HM: جزيرة هيرد وجزر ماكدونالد
+HN: هندوراس
+HR: كرواتيا
+HT: هايتي
+HU: هنغاريا
+ID: إندونيسيا
+IE: أيرلندا
+IL: إسرائيل
+IM: جزيرة مان
+IN: الهند
+IO: الإقليم البريطاني في المحيط الهندي
+IQ: العراق
+IR: إيران
+IS: أيسلندا
+IT: إيطاليا
+JE: جيرسي
+JM: جامايكا
+JO: الأردن
+JP: اليابان
+KE: كينيا
+KG: قرغيزستان
+KH: كمبوديا
+KI: كيريباتي
+KM: جزر القمر
+KN: سانت كيتس ونيفيس
+KP: كوريا الشمالية
+KR: كوريا الجنوبية
+KW: الكويت
+KY: جزر الكايمن
+KZ: كازاخستان
+LA: لاوس
+LB: لبنان
+LC: سانت لوسيا
+LI: ليختنشتاين
+LK: سريلانكا
+LR: ليبيريا
+LS: ليسوتو
+LT: ليتوانيا
+LU: لوكسمبورغ
+LV: لاتفيا
+LY: ليبيا
+MA: المغرب
+MC: موناكو
+MD: مولدافيا
+ME: الجبل الأسود
+MF: سانت مارتن
+MG: مدغشقر
+MH: جزر المارشال
+MK: مقدونيا
+ML: مالي
+MM: ميانمار -بورما
+MN: منغوليا
+MO: مكاو الصينية (منطقة إدارية خاصة)
+MP: جزر ماريانا الشمالية
+MQ: مارتينيك
+MR: موريتانيا
+MS: مونتسرات
+MT: مالطا
+MU: موريشيوس
+MV: جزر المالديف
+MW: ملاوي
+MX: المكسيك
+MY: ماليزيا
+MZ: موزمبيق
+NA: ناميبيا
+NC: كاليدونيا الجديدة
+NE: النيجر
+NF: جزيرة نورفوك
+NG: نيجيريا
+NI: نيكاراغوا
+NL: هولندا
+NO: النرويج
+NP: نيبال
+NR: ناورو
+NU: نيوي
+NZ: نيوزيلندا
+OM: عُمان
+PA: بنما
+PE: بيرو
+PF: بولينيزيا الفرنسية
+PG: بابوا غينيا الجديدة
+PH: الفلبين
+PK: باكستان
+PL: بولندا
+PM: سانت بيير وميكولون
+PN: جزر بيتكيرن
+PR: بورتوريكو
+PS: الأراضي الفلسطينية
+PT: البرتغال
+PW: بالاو
+PY: باراغواي
+QA: قطر
+RE: روينيون
+RO: رومانيا
+RS: صربيا
+RU: روسيا
+RW: رواندا
+SA: المملكة العربية السعودية
+SB: جزر سليمان
+SC: سيشل
+SD: السودان
+SE: السويد
+SG: سنغافورة
+SH: سانت هيلنا
+SI: سلوفينيا
+SJ: سفالبارد وجان مايان
+SK: سلوفاكيا
+SL: سيراليون
+SM: سان مارينو
+SN: السنغال
+SO: الصومال
+SR: سورينام
+SS: جنوب السودان
+ST: ساو تومي وبرينسيبي
+SV: السلفادور
+SX: سينت مارتن
+SY: سوريا
+SZ: سوازيلاند
+TC: جزر توركس وكايكوس
+TD: تشاد
+TF: الأقاليم الجنوبية الفرنسية
+TG: توغو
+TH: تايلاند
+TJ: طاجيكستان
+TK: توكيلو
+TL: تيمور الشرقية
+TM: تركمانستان
+TN: تونس
+TO: تونغا
+TR: تركيا
+TT: ترينيداد وتوباغو
+TV: توفالو
+TW: تايوان
+TZ: تنزانيا
+UA: أوكرانيا
+UG: أوغندا
+UM: جزر الولايات المتحدة النائية
+US: الولايات المتحدة
+UY: أورغواي
+UZ: أوزبكستان
+VA: الفاتيكان
+VC: سانت فنسنت وغرنادين
+VE: فنزويلا
+VG: جزر فرجين البريطانية
+VI: جزر فرجين الأمريكية
+VN: فيتنام
+VU: فانواتو
+WF: جزر والس وفوتونا
+WS: ساموا
+YE: اليمن
+YT: مايوت
+ZA: جنوب أفريقيا
+ZM: زامبيا
+ZW: زيمبابوي