postcode_validation 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea004687bfaa8fea973fd7b953dcd19b26dd224c
+  data.tar.gz: 454c66d84f41f92518b984dcbc058bce3e1e5b06
+SHA512:
+  metadata.gz: fbab8666322cf4a8bfdea31004fda11f676f514cbe83de005a6119e52a569e53271ea9a30196fd7e33a99baf47c8668f9a70f153ad8bc521de74573e9f8e8f43
+  data.tar.gz: d4a4627d2e1880fd0546d46ea31f0b2fca2075ec5acdaec14a26753a87171f540e1da043eaeeb8a6d6ee6cb302de8e8886ed37857884b7c934ad30d3e956e7e4

data/.env

@@ -0,0 +1 @@
+POSTCODE_ANYWHERE_KEY=FAKEKEY

data/.gitignore

@@ -0,0 +1,62 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/bin
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6 --binstubs
+script:
+  - bundle exec rake spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Craig J. Bass
+
+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,66 @@
+# PostcodeValidation
+
+This gem provides basic postcode validation functionality which can be used in any application
+ 
+It also comes with out of the box plugins for:
+- Solidus
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'postcode_validation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install postcode_validation
+
+## Usage
+
+### Using with Solidus
+
+TODO
+
+### Bespoke application usage
+
+```ruby
+use_case = PostcodeValidation::UseCase::ValidateAddress.new(
+  address_match_gateway: PostcodeValidation::Gateway::PCAPotentialAddressMatch.new
+)
+
+valid = use_case.execute(postcode: 'SE10SW', country: 'GB')[:valid?]
+```
+
+Country must be a valid 2-letter ISO country code.
+Postcode is the postcode under test.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/madetech/postcode_validation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+##Credits
+
+Developed and maintained by [Made](http://www.madetech.co.uk?ref=github&repo=postcode_validation).
+
+[![made](https://s3-eu-west-1.amazonaws.com/made-assets/googleapps/google-apps.png)](http://www.madetech.co.uk?ref=github&repo=postcode_validation)
+
+Key contributions:
+
+* [Craig J. Bass](https://github.com/craigjbass)
+* [Seb Ashton](https://github.com/sebashton)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/postcode_validation/domain/potential_address_match.rb

@@ -0,0 +1,21 @@
+module PostcodeValidation
+  module Domain
+    class PotentialAddressMatch
+      def initialize(text:)
+        @text = text
+      end
+
+      def postcode_matches?(postcode)
+        letters_and_numbers_only(text).include?(letters_and_numbers_only(postcode))
+      end
+
+      attr_reader :text
+
+      private
+
+      def letters_and_numbers_only(postcode)
+        postcode.gsub(/[^0-9a-zA-Z]/, '')
+      end
+    end
+  end
+end

data/lib/postcode_validation/error/request_error.rb

@@ -0,0 +1,6 @@
+module PostcodeValidation
+  module Error
+    class RequestError < Exception
+    end
+  end
+end

data/lib/postcode_validation/gateway/pca_potential_address_match.rb

@@ -0,0 +1,43 @@
+module PostcodeValidation
+  module Gateway
+    class PCAPotentialAddressMatch
+      include HTTParty
+
+      class PCARequestError < PostcodeValidation::Error::RequestError; end
+
+      KEY = ENV['POSTCODE_ANYWHERE_KEY']
+      base_uri 'https://services.postcodeanywhere.co.uk'
+
+      def query(search_term:, country:)
+        response = find_postcode(country, search_term)
+
+        response.map do |row|
+          raise PCARequestError, error_message(row) if row.key?('Error')
+
+          PostcodeValidation::Domain::PotentialAddressMatch.new(text: row['Text'])
+        end
+      end
+
+      private
+
+      def error_message(row)
+        "#{row['Error']} #{row['Cause']} #{row['Resolution']}"
+      end
+
+      def find_postcode(country, search_term)
+        JSON.parse(self.class.get('/Capture/Interactive/Find/v1.00/json.ws', lookup_parameters(country, search_term)).body)
+      end
+
+      def lookup_parameters(country, search_term)
+        {
+          query: {
+            Key: KEY,
+            Countries: country,
+            Text: search_term,
+            Filter: 'PostCode'
+          }
+        }
+      end
+    end
+  end
+end

data/lib/postcode_validation/plugins/solidus/models/concerns/spree_order_postcode_valid.rb

@@ -0,0 +1,33 @@
+module PostcodeValidation
+  module SpreeOrderPostcodeValid
+    extend ActiveSupport::Concern
+
+    included do
+      state_machine.before_transition to: :delivery,
+                                      do: :validate_delivery_postcode
+    end
+
+    private
+
+    def validate_delivery_postcode
+      return if valid_postcode?
+
+      errors.add(:ship_address_zipcode, Spree.t(:couldnt_find_postcode))
+      false
+    end
+
+    def valid_postcode?
+      use_case.execute(postcode: ship_address.zipcode, country: shipping_country_iso)[:valid?]
+    end
+
+    def shipping_country_iso
+      ship_address.country.iso
+    end
+
+    def use_case
+      PostcodeValidation::UseCase::ValidateAddress.new(
+        address_match_gateway: PostcodeValidation::Gateway::PCAPotentialAddressMatch.new
+      )
+    end
+  end
+end

data/lib/postcode_validation/plugins/solidus.rb

@@ -0,0 +1,7 @@
+module PostcodeValidation
+  module Plugins
+    module Solidus
+      require 'postcode_validation/plugins/solidus/models/concerns/spree_order_postcode_valid'
+    end
+  end
+end

data/lib/postcode_validation/use_case/validate_address.rb

@@ -0,0 +1,37 @@
+module PostcodeValidation
+  module UseCase
+    class ValidateAddress
+      def initialize(address_match_gateway:)
+        @address_match_gateway = address_match_gateway
+      end
+
+      def execute(postcode:, country:)
+        @postcode = postcode
+        @country = country
+        { valid?: valid_postcode? }
+      rescue PostcodeValidation::Error::RequestError => e
+        on_error(e)
+        { valid?: true }
+      end
+
+      private
+
+      attr_reader :address_match_gateway, :postcode, :country
+
+      def on_error(e) ; end
+
+      def valid_postcode?
+        address = first_potential_address
+        return false if address.nil?
+
+        address.postcode_matches? postcode
+      end
+
+      def first_potential_address
+        potential_address_matches = @address_match_gateway.query(search_term: postcode,
+                                                                 country: country)
+        potential_address_matches.first
+      end
+    end
+  end
+end

data/lib/postcode_validation/version.rb

@@ -0,0 +1,3 @@
+module PostcodeValidation
+  VERSION = "0.0.1"
+end

data/lib/postcode_validation.rb

@@ -0,0 +1,9 @@
+require 'postcode_validation/version'
+
+module PostcodeValidation
+  require 'httparty'
+  require 'postcode_validation/domain/potential_address_match'
+  require 'postcode_validation/error/request_error'
+  require 'postcode_validation/gateway/pca_potential_address_match'
+  require 'postcode_validation/use_case/validate_address'
+end

data/postcode_validation.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'postcode_validation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "postcode_validation"
+  spec.version       = PostcodeValidation::VERSION
+  spec.authors       = ["Craig J. Bass"]
+  spec.email         = ["craig@madetech.co.uk"]
+
+  spec.summary       = %q{Provides really basic postcode validation (intended for eCommerce platforms).}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'httparty'
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'dotenv'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: postcode_validation
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Craig J. Bass
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- craig@madetech.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/postcode_validation.rb
+- lib/postcode_validation/domain/potential_address_match.rb
+- lib/postcode_validation/error/request_error.rb
+- lib/postcode_validation/gateway/pca_potential_address_match.rb
+- lib/postcode_validation/plugins/solidus.rb
+- lib/postcode_validation/plugins/solidus/models/concerns/spree_order_postcode_valid.rb
+- lib/postcode_validation/use_case/validate_address.rb
+- lib/postcode_validation/version.rb
+- postcode_validation.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Provides really basic postcode validation (intended for eCommerce platforms).
+test_files: []