postcode-anywhere 1.0.1

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/config/pre_commit.yml

@@ -0,0 +1,7 @@
+---
+:checks_remove: []
+:checks_add:
+- :rubocop
+- :white_space
+- :merge_conflict
+- :yaml

data/lib/postcode_anywhere.rb

@@ -0,0 +1,10 @@
+require 'postcode_anywhere/configuration'
+require 'postcode_anywhere/version'
+require 'postcode_anywhere/capture_plus/client'
+require 'postcode_anywhere/cleanse_plus/client'
+require 'postcode_anywhere/bank_account_validation/client'
+require 'postcode_anywhere/email_validation/client'
+
+module PostcodeAnywhere
+  extend Configuration
+end

data/lib/postcode_anywhere/bank_account_validation/bank_branch.rb

@@ -0,0 +1,45 @@
+require 'postcode_anywhere/model_base'
+
+module PostcodeAnywhere
+  module BankAccountValidation
+    class BankBranch < PostcodeAnywhere::ModelBase
+      # The name of the banking institution.
+      attr_reader :bank
+
+      # The banking institution's BIC, also know as the SWIFT BIC.
+      attr_reader :bank_bic
+
+      # The name of the account holding branch.
+      attr_reader :branch
+
+      # The branch's BIC.
+      attr_reader :branch_bic
+
+      # Line 1 of the branch's contact address.
+      # NB: This is the address to be used for BACs enquiries and may be a
+      # contact centre rather than the branch's address.
+      attr_reader :contact_address_line1
+
+      # Line 2 of the branch's contact address.
+      attr_reader :contact_address_line2
+
+      # The branch's contact post town.
+      attr_reader :contact_post_town
+
+      # The branch's contact postcode.
+      attr_reader :contact_postcode
+
+      # The branch's contact phone number.
+      attr_reader :contact_phone
+
+      # The branch's contact fax number.
+      attr_reader :contact_fax
+
+      # Indicates that the account supports the faster payments service.
+      attr_reader :faster_payments_supported
+
+      # Indicates that the account supports the CHAPS service.
+      attr_reader :chaps_supported
+    end
+  end
+end

data/lib/postcode_anywhere/bank_account_validation/client.rb

@@ -0,0 +1,13 @@
+require 'postcode_anywhere/client'
+require 'postcode_anywhere/bank_account_validation/interactive'
+
+module PostcodeAnywhere
+  module BankAccountValidation
+    class Client < ::PostcodeAnywhere::Client
+      include PostcodeAnywhere::BankAccountValidation::Interactive
+      def initialize(options = {})
+        super(options)
+      end
+    end
+  end
+end

data/lib/postcode_anywhere/bank_account_validation/interactive.rb

@@ -0,0 +1,39 @@
+require 'postcode_anywhere/utils'
+require 'postcode_anywhere/bank_account_validation/bank_branch'
+require 'postcode_anywhere/bank_account_validation/validation_result'
+
+module PostcodeAnywhere
+  module BankAccountValidation
+    module Interactive
+      include ::PostcodeAnywhere::Utils
+
+      API_VERSION = '1.00'
+
+      RETRIEVE_BY_SORTCODE_ENDPOINT =
+        "BankAccountValidation/Interactive/RetrieveBySortcode/v#{API_VERSION}/json.ws"
+
+      VALIDATE_ACCOUNT_ENDPOINT =
+        "BankAccountValidation/Interactive/Validate/v#{API_VERSION}/json.ws"
+
+      def retrieve_by_sortcode(sort_code, options = {})
+        options.merge!('SortCode' => sort_code)
+        perform_with_object(
+          :get,
+          RETRIEVE_BY_SORTCODE_ENDPOINT,
+          options,
+          PostcodeAnywhere::BankAccountValidation::BankBranch
+        )
+      end
+
+      def validate_account(account_number, sort_code, options = {})
+        options.merge!('SortCode' => sort_code, 'AccountNumber' => account_number)
+        perform_with_object(
+          :get,
+          VALIDATE_ACCOUNT_ENDPOINT,
+          options,
+          PostcodeAnywhere::BankAccountValidation::ValidationResult
+        )
+      end
+    end
+  end
+end

data/lib/postcode_anywhere/bank_account_validation/validation_result.rb

@@ -0,0 +1,80 @@
+require 'postcode_anywhere/model_base'
+
+module PostcodeAnywhere
+  module BankAccountValidation
+    class ValidationResult < PostcodeAnywhere::ModelBase
+      # Indicates whether the account number a sortcode are valid.
+      # Example: false
+      attr_reader :is_correct
+
+      # Indicates whether the account can accept direct debits.
+      # Certain accounts (e.g. savings) will not accept direct debits.
+      # Example: false
+      attr_reader :is_direct_debit_capable
+
+      # More detail about the outcome of the validation process.
+      # Describes reasons validation failed or changes made to pass validation.
+      # DetailsChanged indicates that the account and sortcode should be changed for
+      # BACs submission (check CorrectedAccountNumber and CorrectedSortCode).
+      # CautiousOK is set where the sortcode exists but no validation rules are
+      # set for the bank (very rare).
+      #
+      # Values:
+      #   - None
+      #   - UnknownSortCode
+      #   - InvalidAccountNumber
+      #   - OK
+      #   - CautiousOK
+      #   - DetailsChanged
+      attr_reader :status_information
+
+      # The correct version of the SortCode. This will be 6 digits long with no hyphens.
+      # It may differ from the original sortcode.
+      attr_reader :corrected_sort_code
+
+      # The correct version of the AccountNumber.
+      # This will be 8 digits long and in the form expected for BACs submission.
+      attr_reader :corrected_account_number
+
+      # The correctly formatted IBAN for the account.
+      attr_reader :iban
+
+      # The name of the banking institution.
+      attr_reader :bank
+
+      # The banking institution's BIC, also know as the SWIFT BIC.
+      attr_reader :bank_bic
+
+      # The name of the account holding branch.
+      attr_reader :branch
+
+      # The branch's BIC.
+      attr_reader :branch_bic
+
+      # Line 1 of the branch's contact address. NB: This is the address to be used for BACs
+      # enquiries and may be a contact centre rather than the branch's address.
+      attr_reader :contact_address_line1
+
+      # Line 2 of the branch's contact address.
+      attr_reader :contact_address_line2
+
+      # The branch's contact post town.
+      attr_reader :contact_post_town
+
+      # The branch's contact postcode.
+      attr_reader :contact_postcode
+
+      # The branch's contact phone number.
+      attr_reader :contact_phone
+
+      # The branch's contact fax number.
+      attr_reader :contact_fax
+
+      # Indicates that the account supports the faster payments service.
+      attr_reader :faster_payments_supported
+
+      # Indicates that the account supports the CHAPS service.
+      attr_reader :chaps_supported
+    end
+  end
+end

data/lib/postcode_anywhere/capture_plus/client.rb

@@ -0,0 +1,13 @@
+require 'postcode_anywhere/client'
+require 'postcode_anywhere/capture_plus/interactive'
+
+module PostcodeAnywhere
+  module CapturePlus
+    class Client < ::PostcodeAnywhere::Client
+      include PostcodeAnywhere::CapturePlus::Interactive
+      def initialize(options = {})
+        super(options)
+      end
+    end
+  end
+end

data/lib/postcode_anywhere/capture_plus/interactive.rb

@@ -0,0 +1,84 @@
+require 'postcode_anywhere/utils'
+require 'postcode_anywhere/capture_plus/search_result'
+require 'postcode_anywhere/capture_plus/retrieve_result'
+require 'postcode_anywhere/capture_plus/query_type'
+
+module PostcodeAnywhere
+  module CapturePlus
+    module Interactive
+      include ::PostcodeAnywhere::Utils
+
+      API_VERSION = '2.00'
+
+      FIND_ADDRESSES_ENDPOINT = "CapturePlus/Interactive/Find/v#{API_VERSION}/json.ws"
+
+      RETRIEVE_ADDRESS_ENDPOINT = "CapturePlus/Interactive/Retrieve/v#{API_VERSION}/json.ws"
+
+      def query(search_term, options = {})
+        options.merge!(
+          'SearchTerm' => search_term
+        )
+        options['LastId'] = ParentIdExtractor.new(options.delete(:parent_query)).extract
+        options['SearchFor'] = options.delete(:search_for) || EVERYTHING
+        options['Country']   = options.delete(:country) || 'GBR'
+        options['LanguagePreference'] = options.delete(:language) || 'EN'
+        perform_with_objects(
+          :get,
+          FIND_ADDRESSES_ENDPOINT,
+          options,
+          PostcodeAnywhere::CapturePlus::SearchResult
+        )
+      end
+
+      def sub_query(search_term, parent_query, options = {})
+        options.merge!(parent_query: parent_query)
+        query(search_term, options)
+      end
+
+      def query_places(search_term, options = {})
+        options.merge!(search_for: PLACE)
+        query search_term, options
+      end
+
+      def query_companies(search_term, options = {})
+        options.merge!(search_for: COMPANY)
+        query search_term, options
+      end
+
+      def query_postcodes(search_term, options = {})
+        options.merge!(search_for: POSTCODE)
+        query search_term, options
+      end
+
+      def retrieve(search_result)
+        options = {}
+        options.merge!(
+          'Id' => ParentIdExtractor.new(search_result).extract
+        )
+        perform_with_object(
+          :get,
+          RETRIEVE_ADDRESS_ENDPOINT,
+          options,
+          PostcodeAnywhere::CapturePlus::RetrieveResult
+        )
+      end
+
+      class ParentIdExtractor
+        attr_accessor :parent_query
+
+        def initialize(parent)
+          @parent_query = parent
+        end
+
+        def extract
+          if @parent_query &&
+             @parent_query.class == PostcodeAnywhere::CapturePlus::SearchResult
+            return @parent_query.id
+          else
+            return @parent_query
+          end
+        end
+      end
+    end
+  end
+end

data/lib/postcode_anywhere/capture_plus/query_type.rb

@@ -0,0 +1,8 @@
+module PostcodeAnywhere
+  module CapturePlus
+    EVERYTHING = 'Everything'
+    POSTCODE = 'PostalCodes'
+    COMPANY = 'Companies'
+    PLACE = 'Places'
+  end
+end

data/lib/postcode_anywhere/capture_plus/retrieve_result.rb

@@ -0,0 +1,45 @@
+require 'postcode_anywhere/model_base'
+
+module PostcodeAnywhere
+  module CapturePlus
+    class RetrieveResult < PostcodeAnywhere::ModelBase
+      attr_reader :id
+      attr_reader :domestic_id
+      attr_reader :language
+      attr_reader :language_alternatives
+      attr_reader :department
+      attr_reader :company
+      attr_reader :sub_building
+      attr_reader :building_number
+      attr_reader :building_name
+      attr_reader :secondary_street
+      attr_reader :street
+      attr_reader :block
+      attr_reader :neighbourhood
+      attr_reader :district
+      attr_reader :city
+      attr_reader :line1
+      attr_reader :line2
+      attr_reader :line3
+      attr_reader :line4
+      attr_reader :line5
+      attr_reader :admin_area_name
+      attr_reader :admin_area_code
+      attr_reader :province
+      attr_reader :province_name
+      attr_reader :province_code
+      attr_reader :postal_code
+      attr_reader :country_name
+      attr_reader :country_iso2
+      attr_reader :country_iso3
+      attr_reader :country_iso_number
+      attr_reader :sorting_number1
+      attr_reader :sorting_number2
+      attr_reader :barcode
+      attr_reader :po_box_number
+      attr_reader :label
+      attr_reader :type
+      attr_reader :data_level
+    end
+  end
+end

data/lib/postcode_anywhere/capture_plus/search_result.rb

@@ -0,0 +1,39 @@
+require 'postcode_anywhere/model_base'
+
+module PostcodeAnywhere
+  module CapturePlus
+    class SearchResult < PostcodeAnywhere::ModelBase
+      # The Id to be used as the LastId with the Find method.
+      # Example: GBR|ST|27299|3739|6|0|0|
+      attr_reader :id
+
+      # The found item.
+      # Example: High Street, London
+      attr_reader :text
+
+      # A list of number ranges identifying the characters to highlight
+      # in the Text response (zero-based start position and end).
+      # Example: 0-2,6-4
+      attr_reader :highlight
+
+      # A zero-based position in the Text response indicating the suggested
+      # position of the cursor if this item is selected.
+      # A -1 response indicates no suggestion is available.
+      # 0
+      # Example: true
+      attr_reader :cursor
+
+      # Descriptive information about the found item, typically if it's a container.
+      # Example: 102 Streets
+      attr_reader :description
+
+      # The next step of the search process.
+      # Values:
+      #   - Find
+      #   - Retrieve
+      #   - None
+      # Example: Retrieve
+      attr_reader :next
+    end
+  end
+end

data/lib/postcode_anywhere/cleanse_plus/cleansed_address.rb

@@ -0,0 +1,98 @@
+require 'postcode_anywhere/model_base'
+
+module PostcodeAnywhere
+  module CleansePlus
+    class CleansedAddress < PostcodeAnywhere::ModelBase
+      # The Royal Mail UDPRN (Unique Delivery Point Reference Number) for the address.
+      # Example: 26742632
+      attr_reader :udprn
+
+      # The name of the company.
+      # Example: Postcode Anywhere (Europe) Ltd
+      attr_reader :company
+
+      # Department name (rarely used).
+      attr_reader :department
+
+      # Line 1 of the address.
+      # Example: Enigma House
+      attr_reader :line1
+
+      # Line 2 of the address.
+      # Example: Elgar Business Centre
+      attr_reader :line2
+
+      # Line 3 of the address (rarely used).
+      # Example: Moseley Road
+      attr_reader :line3
+
+      # Line 4 of the address (rarely used).
+      # Example: Hallow
+      attr_reader :line4
+
+      # Line 5 of the address (rarely used).
+      attr_reader :line5
+
+      # The post town for the address.
+      # Example: Worcester
+      attr_reader :post_town
+
+      # The postal county for the address.
+      # Example: Worcestershire
+      attr_reader :county
+
+      # The postcode for the address.
+      # Example: WR2 6NJ
+      attr_reader :postcode
+
+      # The mailsort code for the address.
+      # Example: 70122
+      attr_reader :mailsort
+
+      # The barcode for the address.
+      # Example: (WR26NJ3UT)
+      attr_reader :barcode
+
+      # The type of address.
+      # Example: SmallBusiness
+      # Values:
+      #   - Residential
+      #   - SmallBusiness
+      #   - LargeBusiness
+      #   - Unknown
+      attr_reader :type
+
+      # The 2 character delivery point suffix.
+      # Example: 3U
+      attr_reader :delivery_point_suffix
+
+      # The name of the sub building (flat / unit etc).
+      # Example: Enigma House
+      attr_reader :sub_building
+
+      # The building name if present.
+      # Elgar Business Centre
+      attr_reader :building_name
+
+      # The number (or number range) of the building.
+      attr_reader :building_number
+
+      # The primary thoroughfare name.
+      # Example: Moseley Road
+      attr_reader :primary_street
+
+      # The secondary thoroughfare name. Usually a small street off the primary.
+      attr_reader :secondary_street
+
+      # The least significant locality (rarely used), possibly a hamlet.
+      attr_reader :double_dependent_locality
+
+      # Less significant locality name, possibly a village.
+      # Example: Hallow
+      attr_reader :dependent_locality
+
+      # The number of the PO Box if present (may contain non numeric items).
+      attr_reader :po_box
+    end
+  end
+end