local_postal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed2600f0a7379186d3ba0141a63a5b21cd8f13d8
+  data.tar.gz: 95ef6f15bec1d8447d59eb7a3fa0c1bc14b3f468
+SHA512:
+  metadata.gz: b34fde1812178871e094be8e554f5cc809e6bd7524957d6853cc32c17b418382ca8927a84719a7399a8261db922305d81e52395e2d53f6618f4d7ae80df794e2
+  data.tar.gz: cb8a5e216beea4d21be8eb0e0751f467c51993d2d19acc2dc41714fd1a724c8b701fce7a13b5c36c06e1b23e25cd7a88b06a41f6c22bcb5b767593d145f5f817

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,26 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people
+who contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual
+language or imagery, derogatory comments or personal attacks, trolling, public
+or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct. Project maintainers who do not follow the
+Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the
+[Contributor Covenant](http://contributor-covenant.org),
+[version 1.0.0](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Travis Haynes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,124 @@
+# LocalPostal
+
+Formats addresses using the postal rules of the country it belongs to.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'local_postal'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install local_postal
+
+## Usage
+
+The best way to describe how to use this gem is by giving a couple of examples.
+
+```ruby
+address = LocalPostal::Address.new(
+  name: 'Sherlock Holmes',
+  company: '',
+  street_address: '221B Baker Street',
+  secondary_address: '',
+  city: 'London',
+  region: 'England',
+  postal_code: 'NW1 6XE',
+  country: 'United Kingdom'
+)
+
+puts address.lines
+```
+
+The above will output the following:
+
+    Sherlock Holmes
+    221B Baker Street
+    LONDON
+    England
+    NW1 6XE
+    UNITED KINGDOM
+
+
+Here's another example for the US.
+
+```ruby
+address = LocalPostal::Address.new(
+  name: 'Elwood Blues',
+  company: 'The Blues Brothers',
+  street_address: '1060 West Addison Street',
+  secondary_address: '',
+  city: 'Chicago',
+  region: 'IL',
+  postal_code: '60620',
+  country: 'United States'
+)
+
+puts address.lines
+```
+
+Which will output:
+
+    Elwood Blues
+    The Blues Brothers
+    1060 West Addison Street
+    CHICAGO, IL 60620
+    UNITED STATES
+
+`LocalPostal::Address` is an `ActiveModel::Model` and has some field
+validations based on the shipping rules for its country.
+
+```ruby
+address = LocalPostal::Address.new(
+  name: nil,
+  street_address: nil,
+  city: 'Los Angeles',
+  region: 'CA',
+  postal_code: 'xxx',
+  country: 'United States'
+)
+
+address.valid? # => false
+puts address.errors.full_messages
+```
+
+Gives you the following errors:
+
+    Name is required
+    Street address is required
+    Postal code is invalid
+
+**NOTICE:** This does not check that the address is actually deliverable. It
+only checks that all the required fields are present, and that the postal code
+matches a pattern. For example, if the city was `Bevery Hills`, and the postal
+code was `12345` then `address.valid?` would still return `true`, even though
+the address is physically invalid.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/travishaynes/local_postal.
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the
+[Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test
+
+# load Rake tasks
+Dir[File.expand_path('../lib/tasks/**/*.rake', __FILE__)].each {|f| load f }

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'local_postal'
+require 'irb'
+
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -euo pipefail
+
+IFS=$'\n\t'
+
+bundle install

data/config/formats/AC.json

@@ -0,0 +1,13 @@
+{
+	"locale": "und",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%locality",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city"
+}

data/config/formats/AD.json

@@ -0,0 +1,15 @@
+{
+	"locale": "ca",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%postalCode %locality",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city",
+	"postal_code_type": "postal",
+	"postal_code_pattern": "AD[1-7]0\\d"
+}

data/config/formats/AE.json

@@ -0,0 +1,13 @@
+{
+	"locale": "ar-Latn",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%administrativeArea",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"administrativeArea"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"administrative_area_type": "emirate"
+}

data/config/formats/AF.json

@@ -0,0 +1,13 @@
+{
+	"locale": "und",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%locality",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city"
+}

data/config/formats/AG.json

@@ -0,0 +1,12 @@
+{
+	"locale": "und",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%locality",
+	"required_fields": [
+		"recipient",
+		"addressLine1"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city"
+}

data/config/formats/AI.json

@@ -0,0 +1,13 @@
+{
+	"locale": "und",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%locality",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city"
+}

data/config/formats/AL.json

@@ -0,0 +1,15 @@
+{
+	"locale": "und",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%postalCode\n%locality",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city",
+	"postal_code_type": "postal",
+	"postal_code_pattern": "\\d{4}"
+}

data/config/formats/AM.json

@@ -0,0 +1,16 @@
+{
+	"locale": "hy-Latn",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%postalCode\n%locality\n%administrativeArea",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"administrative_area_type": "province",
+	"locality_type": "city",
+	"postal_code_type": "postal",
+	"postal_code_pattern": "(37)?\\d{4}"
+}

data/config/formats/AR.json

@@ -0,0 +1,19 @@
+{
+	"locale": "es",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%postalCode %locality\n%administrativeArea",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality"
+	],
+	"uppercase_fields": [
+		"addressLine1",
+		"addressLine2",
+		"locality",
+		"postalCode"
+	],
+	"administrative_area_type": "province",
+	"locality_type": "city",
+	"postal_code_type": "postal",
+	"postal_code_pattern": "((?:[A-HJ-NP-Z])?\\d{4})([A-Z]{3})?"
+}

data/config/formats/AS.json

@@ -0,0 +1,23 @@
+{
+	"locale": "und",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%locality %administrativeArea %postalCode",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality",
+		"administrativeArea",
+		"postalCode"
+	],
+	"uppercase_fields": [
+		"addressLine1",
+		"addressLine2",
+		"locality",
+		"recipient",
+		"organization",
+		"administrativeArea"
+	],
+	"administrative_area_type": "state",
+	"locality_type": "city",
+	"postal_code_type": "zip",
+	"postal_code_pattern": "(96799)(?:[ \\-](\\d{4}))?"
+}

data/config/formats/AT.json

@@ -0,0 +1,16 @@
+{
+	"locale": "und",
+	"format": "%organization\n%recipient\n%addressLine1\n%addressLine2\n%postalCode %locality",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality",
+		"postalCode"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city",
+	"postal_code_type": "postal",
+	"postal_code_pattern": "\\d{4}"
+}

data/config/formats/AU.json

@@ -0,0 +1,19 @@
+{
+	"locale": "en",
+	"format": "%organization\n%recipient\n%addressLine1\n%addressLine2\n%locality %administrativeArea %postalCode",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality",
+		"administrativeArea",
+		"postalCode"
+	],
+	"uppercase_fields": [
+		"locality",
+		"administrativeArea"
+	],
+	"administrative_area_type": "state",
+	"locality_type": "city",
+	"postal_code_type": "postal",
+	"postal_code_pattern": "\\d{4}"
+}

data/config/formats/AX.json

@@ -0,0 +1,17 @@
+{
+	"locale": "und",
+	"format": "%organization\n%recipient\n%addressLine1\n%addressLine2\n%postalCode %locality\nÅLAND",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality",
+		"postalCode"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city",
+	"postal_code_type": "postal",
+	"postal_code_pattern": "22\\d{3}",
+	"postal_code_prefix": "AX-"
+}

data/config/formats/AZ.json

@@ -0,0 +1,16 @@
+{
+	"locale": "und",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%postalCode %locality",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city",
+	"postal_code_type": "postal",
+	"postal_code_pattern": "\\d{4}",
+	"postal_code_prefix": "AZ "
+}

data/config/formats/BA.json

@@ -0,0 +1,15 @@
+{
+	"locale": "und",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%postalCode %locality",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city",
+	"postal_code_type": "postal",
+	"postal_code_pattern": "\\d{5}"
+}

data/config/formats/BB.json

@@ -0,0 +1,15 @@
+{
+	"locale": "und",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%locality %postalCode",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city",
+	"postal_code_type": "postal",
+	"postal_code_pattern": "BB\\d{5}"
+}

data/config/formats/BD.json

@@ -0,0 +1,15 @@
+{
+	"locale": "und",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%locality - %postalCode",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city",
+	"postal_code_type": "postal",
+	"postal_code_pattern": "\\d{4}"
+}

data/config/formats/BE.json

@@ -0,0 +1,16 @@
+{
+	"locale": "und",
+	"format": "%organization\n%recipient\n%addressLine1\n%addressLine2\n%postalCode %locality",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality",
+		"postalCode"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city",
+	"postal_code_type": "postal",
+	"postal_code_pattern": "\\d{4}"
+}

data/config/formats/BF.json

@@ -0,0 +1,13 @@
+{
+	"locale": "und",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%locality %sortingCode",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city"
+}

data/config/formats/BG.json

@@ -0,0 +1,15 @@
+{
+	"locale": "und",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%postalCode %locality",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city",
+	"postal_code_type": "postal",
+	"postal_code_pattern": "\\d{4}"
+}

data/config/formats/BH.json

@@ -0,0 +1,15 @@
+{
+	"locale": "und",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%locality %postalCode",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city",
+	"postal_code_type": "postal",
+	"postal_code_pattern": "(?:(?:\\d|1[0-2])\\d{2})?"
+}

data/config/formats/BJ.json

@@ -0,0 +1,15 @@
+{
+	"locale": "und",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%locality",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality"
+	],
+	"uppercase_fields": [
+		"addressLine1",
+		"addressLine2",
+		"locality"
+	],
+	"locality_type": "city"
+}

data/config/formats/BL.json

@@ -0,0 +1,19 @@
+{
+	"locale": "und",
+	"format": "%organization\n%recipient\n%addressLine1\n%addressLine2\n%postalCode %locality %sortingCode",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality",
+		"postalCode"
+	],
+	"uppercase_fields": [
+		"addressLine1",
+		"addressLine2",
+		"locality",
+		"sortingCode"
+	],
+	"locality_type": "city",
+	"postal_code_type": "postal",
+	"postal_code_pattern": "9[78][01]\\d{2}"
+}

data/config/formats/BM.json

@@ -0,0 +1,15 @@
+{
+	"locale": "und",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%locality %postalCode",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city",
+	"postal_code_type": "postal",
+	"postal_code_pattern": "[A-Z]{2}[ ]?[A-Z0-9]{2}"
+}

data/config/formats/BN.json

@@ -0,0 +1,15 @@
+{
+	"locale": "und",
+	"format": "%recipient\n%organization\n%addressLine1\n%addressLine2\n%locality %postalCode",
+	"required_fields": [
+		"recipient",
+		"addressLine1",
+		"locality"
+	],
+	"uppercase_fields": [
+		"locality"
+	],
+	"locality_type": "city",
+	"postal_code_type": "postal",
+	"postal_code_pattern": "[A-Z]{2}[ ]?\\d{4}"
+}