postcode_validation 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 969757f1b9dadfcc8c8558149da021ca01ac30f1
-  data.tar.gz: 74e813efac7b28877b0b1ba5c63e4d78709eb77e
+  metadata.gz: 45f5e5e066397a1d1c55a10ea92a47263f9768f7
+  data.tar.gz: 509c5abfd707f03c895afe3bd2266f38e03014e0
 SHA512:
-  metadata.gz: 4bb9d8016d76ae1fe87201a5e7bd702aadf2b71feee1f88ea36c740e8b4043ac53d7e653961883c0eaf493848cf1f6a8369b1ef26e2ee0f0c2462bd71a3bb24f
-  data.tar.gz: 1e1cf7282b35ce418aa6c1b496c0471b5518ae164a6d6bc64ab59ab83dac41b3e3bb7390471a579402760541987b85fe775016c9b6f0a1b6c768b364ce536d0c
+  metadata.gz: 83f494bed9f25db5205d39dd4ca3f4c7e65e77cf2d608e0e1f5a1a003d752b467ae9ae02358c56d6462177d6ce702d778d6e4239d112550a37e5ee1e9a4fac4d
+  data.tar.gz: 5c9ee9e8012e11f1a7d808039472624b2d56ce9e5430a906d931abce73d7869147c01483dcd474c6fe1f878950831b63f8cf538d2c8ed4b97b799ef70f460d9b

data/.travis.yml

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

data/README.md

@@ -1,8 +1,14 @@
-# PostcodeValidation
+# PostcodeValidation [![Build Status](https://travis-ci.org/madetech/postcode_validation.svg?branch=master)](https://travis-ci.org/madetech/postcode_validation)
 
 This gem provides basic postcode validation functionality which can be used in any application
  
+The specific validation that we perform goes beyond simple regex matching, to determine if the postcode actually exists.
+ 
+To do this it uses PCAPredict.com's Capture+ API. 
+By leveraging this service we are able to provide validation against country's postcode that they support.
+ 
 It also comes with out of the box plugins for:
+
 - Solidus
 
 ## Installation
@@ -23,13 +29,24 @@ Or install it yourself as:
 
 ## Usage
 
+This gem relies on ```ENV['POSTCODE_ANYWHERE_KEY']``` being set to a valid PCAPredict service key for Capture+. 
+
+One of the easiest ways to do this is to use the ```dotenv``` gem for this in your host application.
+
 ### Using with Solidus
 
-TODO
+```ruby
+require 'postcode_validation'
+require 'postcode_validation/plugins/solidus'
+Spree::Order.include(PostcodeValidation::SpreeOrderPostcodeValid)
+````
+
+NB: Error reporting currently only works with a Tagged Logger
 
 ### Bespoke application usage
 
 ```ruby
+require 'postcode_validation'
 use_case = PostcodeValidation::UseCase::ValidateAddress.new(
   address_match_gateway: PostcodeValidation::Gateway::PCAPotentialAddressMatch.new
 )
@@ -37,6 +54,11 @@ use_case = PostcodeValidation::UseCase::ValidateAddress.new(
 valid = use_case.execute(postcode: 'SE10SW', country: 'GB')[:valid?]
 ```
 
+```
+> valid
+true
+```
+
 Country must be a valid 2-letter ISO country code.
 Postcode is the postcode under test.
 

data/lib/postcode_validation/use_case/validate_address.rb

@@ -24,16 +24,16 @@ module PostcodeValidation
       end
 
       def valid_postcode?
-        address = first_potential_address
-        return false if address.nil?
+        matches = potential_address_matches
+        return false if matches.first.nil?
 
-        address.postcode_matches? postcode
+        matches.map { |address| return true if address.postcode_matches? postcode }
+        false
       end
 
-      def first_potential_address
-        potential_address_matches = @address_match_gateway.query(search_term: postcode,
-                                                                 country: country)
-        potential_address_matches.first
+      def potential_address_matches
+        @address_match_gateway.query(search_term: postcode,
+                                     country: country)
       end
     end
   end

data/lib/postcode_validation/version.rb

@@ -1,3 +1,3 @@
 module PostcodeValidation
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postcode_validation
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Craig J. Bass
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-06 00:00:00.000000000 Z
+date: 2016-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty