postcode_validation 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1b7365d65c023287b34e28abfc3cfe8b1db68f1
-  data.tar.gz: 9d6173ff64a453177a2785b00268ef0e05174377
+  metadata.gz: 6dad524f16f594e36cfc565454b9bbdcbd33bace
+  data.tar.gz: f6fc74fa28e9dcf9839376cbaf2428523cc148ee
 SHA512:
-  metadata.gz: d9a0615d997a863c470ed6a9730d90f677be4dc45a10bd9c6b46e1c9532f962976007477ea23a1fdf2ce2878c7ce9f20964c3ae5e1aa53fc2cb0ec76a9640bb7
-  data.tar.gz: c3746ff38a800745b7a355155598132bf6bac61e8c46f6c2114ffa9acedeeae8bea91e9f3af45357745323a3ba1740652f91d8ac0c7449e5ac22c2aa1e5a8fc6
+  metadata.gz: f8a5aa14677804b36ee54081fc4afdcf2b9191aa9960977fe7234d647138170f8c2f8881df0736b9cbe00a26064a3d6b016b49014c1f9d13b53c7e6addc1a1eb
+  data.tar.gz: 45ec31c2c5bc4ae57e83df50f5544874fd8a4c2bddfdd1b1969db3d5171c4748436624d13410690cf3c9770f486b72c5e6ea712d57037f5c6429e0e451ef258b

data/lib/postcode_validation/domain/address.rb

@@ -0,0 +1,12 @@
+module PostcodeValidation
+  module Domain
+    class Address
+      def initialize(street_address:, place:)
+        @street_address = street_address
+        @place = place
+      end
+
+      attr_reader :street_address, :place
+    end
+  end
+end

data/lib/postcode_validation/gateway/pca_address_list.rb

@@ -0,0 +1,44 @@
+module PostcodeValidation
+  module Gateway
+    class PCAAddressList
+      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 = address_list_for_postcode(country, search_term)
+
+        response.map do |row|
+          raise PCARequestError, error_message(row) if row.key?('Error')
+
+          PostcodeValidation::Domain::Address.new(street_address: row['StreetAddress'],
+                                                  place: row['Place'])
+        end
+      end
+
+      private
+
+      def error_message(row)
+        "#{row['Error']} #{row['Cause']} #{row['Resolution']}"
+      end
+
+      def address_list_for_postcode(country, search_term)
+        JSON.parse(self.class.get('/PostcodeAnywhere/Interactive/Find/1.1/json.ws', lookup_parameters(country, search_term)).body)
+      end
+
+      def lookup_parameters(country, search_term)
+        {
+          query: {
+            Country: country,
+            Key: KEY,
+            SearchTerm: search_term,
+            Filter: 'None'
+          }
+        }
+      end
+    end
+  end
+end

data/lib/postcode_validation/gateway/pca_potential_address_match.rb

@@ -34,8 +34,7 @@ module PostcodeValidation
           query: {
             Key: KEY,
             Countries: country,
-            Text: search_term,
-            Filter: 'PostCode'
+            Text: search_term
           }
         }
       end

data/lib/postcode_validation/use_case/address_list.rb

@@ -0,0 +1,39 @@
+require_relative 'validate_address/format_validator'
+
+module PostcodeValidation
+  module UseCase
+    class AddressList
+      def initialize(address_list_gateway:, logger: nil)
+        @address_list_gateway = address_list_gateway
+        @logger = logger
+      end
+
+      def execute(postcode:, country:)
+        addresses = matched_addresses(postcode, country)
+
+        formatted(addresses)
+      rescue PostcodeValidation::Error::RequestError => e
+        log_error(e)
+      end
+
+      private
+
+      attr_reader :address_match_gateway, :logger
+
+      def formatted(addresses)
+        addresses.map do |address|
+          { street_address: address.street_address, place: address.place }
+        end
+      end
+
+      def log_error(e)
+        logger.error(e) unless logger.nil?
+      end
+
+      def matched_addresses(postcode, country)
+        @address_list_gateway.query(search_term: postcode,
+                                    country: country)
+      end
+    end
+  end
+end

data/lib/postcode_validation/use_case/validate_address/format_validator.rb

@@ -0,0 +1,25 @@
+require_relative 'format_validators/nl_postcode_validator'
+require_relative 'format_validators/be_postcode_validator'
+require_relative 'format_validators/gb_postcode_validator'
+require_relative 'format_validators/fr_postcode_validator'
+
+module PostcodeValidation
+  module UseCase
+    class ValidateAddress
+      class FormatValidator
+        def for country
+          case country
+            when 'NL'
+              FormatValidators::NLPostcodeValidator.new
+            when 'GB'
+              FormatValidators::GBPostcodeValidator.new
+            when 'BE'
+              FormatValidators::BEPostcodeValidator.new
+            when 'FR'
+              FormatValidators::FRPostcodeValidator.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/postcode_validation/use_case/validate_address/format_validators/be_postcode_validator.rb

@@ -0,0 +1,13 @@
+require_relative 'regex_validator'
+
+module PostcodeValidation
+  module UseCase
+    class ValidateAddress
+      module FormatValidators
+        class BEPostcodeValidator < RegexValidator
+          REGEX = /^[1-9]{1}[0-9]{3}$/
+        end
+      end
+    end
+  end
+end

data/lib/postcode_validation/use_case/validate_address/format_validators/fr_postcode_validator.rb

@@ -0,0 +1,13 @@
+require_relative 'regex_validator'
+
+module PostcodeValidation
+  module UseCase
+    class ValidateAddress
+      module FormatValidators
+        class FRPostcodeValidator < RegexValidator
+          REGEX = /^(F-)?((2[A|B])|[0-9]{2})[0-9]{3}$/
+        end
+      end
+    end
+  end
+end

data/lib/postcode_validation/use_case/validate_address/format_validators/gb_postcode_validator.rb

@@ -0,0 +1,13 @@
+require_relative 'regex_validator'
+
+module PostcodeValidation
+  module UseCase
+    class ValidateAddress
+      module FormatValidators
+        class GBPostcodeValidator < RegexValidator
+          REGEX = /(?i)([A-Z]{1,2}[0-9]{1,2}[A-Z]?)\s*([0-9][A-Z]{2})/
+        end
+      end
+    end
+  end
+end

data/lib/postcode_validation/use_case/validate_address/format_validators/nl_postcode_validator.rb

@@ -0,0 +1,13 @@
+require_relative 'regex_validator'
+
+module PostcodeValidation
+  module UseCase
+    class ValidateAddress
+      module FormatValidators
+        class NLPostcodeValidator < RegexValidator
+          REGEX = /(NL-)?(\d{4})\s*([A-Z]{2})/
+        end
+      end
+    end
+  end
+end

data/lib/postcode_validation/use_case/validate_address/format_validators/regex_validator.rb

@@ -0,0 +1,14 @@
+module PostcodeValidation
+  module UseCase
+    class ValidateAddress
+      module FormatValidators
+        class RegexValidator
+          def valid? postcode
+            validation = self.class::REGEX =~ postcode
+            !validation.nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/postcode_validation/use_case/validate_address.rb

@@ -1,39 +1,67 @@
+require_relative 'validate_address/format_validator'
+
 module PostcodeValidation
   module UseCase
     class ValidateAddress
       def initialize(address_match_gateway:, logger: nil)
+        @format_validator = FormatValidator.new
         @address_match_gateway = address_match_gateway
         @logger = logger
+        @errors = []
       end
 
       def execute(postcode:, country:)
-        @postcode = postcode
-        @country = country
-        { valid?: valid_postcode? }
+        check_country(country)
+        check_postcode_format(postcode, country)
+        result = matched_addresses(postcode, country)
+
+        check_matched_addresses(result)
+
+        result_payload(result, postcode)
       rescue PostcodeValidation::Error::RequestError => e
-        on_error(e)
-        { valid?: true }
+        gracefully_handle_error(e)
       end
 
       private
 
       attr_reader :address_match_gateway, :logger, :postcode, :country
 
+      def result_payload(result, postcode)
+        return { valid?: false, reason: @errors } unless @errors.empty?
+
+        result.each do |address|
+          return { valid?: true, reason: ['valid_postcode'] } if address.postcode_matches? postcode
+        end
+
+        { valid?: false, reason: ['no_postcode_matches_found'] }
+      end
+
       def on_error(e)
         logger.error(e) unless logger.nil?
       end
 
-      def valid_postcode?
-        matches = potential_address_matches
-        return false if matches.first.nil?
+      def matched_addresses(postcode, country)
+        @address_match_gateway.query(search_term: postcode,
+                                     country: country)
+      end
+
+      def check_matched_addresses(result)
+        @errors << 'no_matches' if result.first.nil?
+      end
+
+      def check_country(country)
+        @errors << 'no_country_provided' if country.nil?
+      end
 
-        matches.each { |address| return true if address.postcode_matches? postcode }
-        false
+      def check_postcode_format(postcode, country)
+        return if country.nil?
+        validator = @format_validator.for(country)
+        @errors << 'invalid_format' if !validator.valid?(postcode)
       end
 
-      def potential_address_matches
-        @address_match_gateway.query(search_term: postcode,
-                                     country: country)
+      def gracefully_handle_error(error)
+        on_error(error)
+        { valid?: true, reason: ['unable_to_reach_service'] }
       end
     end
   end

data/lib/postcode_validation/version.rb

@@ -1,3 +1,3 @@
 module PostcodeValidation
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/lib/postcode_validation.rb

@@ -3,7 +3,10 @@ require 'postcode_validation/version'
 module PostcodeValidation
   require 'httparty'
   require 'postcode_validation/domain/potential_address_match'
+  require 'postcode_validation/domain/address'
   require 'postcode_validation/error/request_error'
   require 'postcode_validation/gateway/pca_potential_address_match'
+  require 'postcode_validation/gateway/pca_address_list'
   require 'postcode_validation/use_case/validate_address'
+  require 'postcode_validation/use_case/address_list'
 end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: postcode_validation
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Craig J. Bass
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-06 00:00:00.000000000 Z
+date: 2017-05-03 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: 
@@ -115,21 +115,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .env
-- .gitignore
-- .rspec
-- .travis.yml
+- ".env"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/postcode_validation.rb
+- lib/postcode_validation/domain/address.rb
 - lib/postcode_validation/domain/potential_address_match.rb
 - lib/postcode_validation/error/request_error.rb
+- lib/postcode_validation/gateway/pca_address_list.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/address_list.rb
 - lib/postcode_validation/use_case/validate_address.rb
+- lib/postcode_validation/use_case/validate_address/format_validator.rb
+- lib/postcode_validation/use_case/validate_address/format_validators/be_postcode_validator.rb
+- lib/postcode_validation/use_case/validate_address/format_validators/fr_postcode_validator.rb
+- lib/postcode_validation/use_case/validate_address/format_validators/gb_postcode_validator.rb
+- lib/postcode_validation/use_case/validate_address/format_validators/nl_postcode_validator.rb
+- lib/postcode_validation/use_case/validate_address/format_validators/regex_validator.rb
 - lib/postcode_validation/version.rb
 - postcode_validation.gemspec
 homepage: 
@@ -142,17 +151,17 @@ 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.0.14.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Provides really basic postcode validation (intended for eCommerce platforms).