loqate 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 655d046a38008004a6326183b2a283c7fe4d274d30c8ef483b31db174fc444c4
-  data.tar.gz: 3b1903221bc7c8dec2e66d4576e58a07e8951a58e78d263b466ac7eed06845f8
+  metadata.gz: 5fb61fc51df7e0d68f444bbdc456f8dc3908f4615a34ba36aa0a16265518ea86
+  data.tar.gz: 53aa2a20fde0da8a1cc284f56b18dde9edbd8def3c0f3265757ec5c30f388d23
 SHA512:
-  metadata.gz: 6cb4834aab155f2d07512c40eabae69da60147027dfba6a3c14a66066a4ab8f9436dbdb2e8acb35e581826276d40768cada4274f1244457be9b869a9fa31d1e8
-  data.tar.gz: 51fe28520b336371baee222145ecaab28cd108495f196d23771ba3ecf476b3770c184d21d57d79b3da3697bb2872d9f539131094453a0c5c7befe20c6b927145
+  metadata.gz: be0b4b5a521533eb1f023c60c1cbd5b203fb586333dfc3a3b52bda07fe8b35a57b9d42d94a0eaf4f1a531e3f3ac2ef56917e75b1ca514dbf078c06192dc8c106
+  data.tar.gz: 27f8a174a784a974f755d303ff2df0f8ec370e23781b25b7dc6ad86d2bd096bd959634e4c82506971d8e14b924ad4d8fd5acb5c8c69b7ed8b6b466c94a36d295

data/.yardstick.yml

@@ -15,15 +15,15 @@ rules:
   ExampleTag:
     enabled: true
     exclude:
-      - Loqate::Address#==
-      - Loqate::Address#attributes
-      - Loqate::Address#description
-      - Loqate::Address#highlight
-      - Loqate::Address#id
-      - Loqate::Address#initialize
-      - Loqate::Address#text
-      - Loqate::Address#type
-      - Loqate::AddressGateway#initialize
+      - Loqate::Address::Address#==
+      - Loqate::Address::Address#attributes
+      - Loqate::Address::Address#description
+      - Loqate::Address::Address#highlight
+      - Loqate::Address::Address#id
+      - Loqate::Address::Address#initialize
+      - Loqate::Address::Address#text
+      - Loqate::Address::Address#type
+      - Loqate::Address::Gateway#initialize
       - Loqate::APIResult#errors?
       - Loqate::APIResult#initialize
       - Loqate::APIResult#items
@@ -83,35 +83,35 @@ rules:
       - Loqate::Bank::Gateway#initialize
       - Loqate::Bank::InternationalAccountValidation#correct?
       - Loqate::Bank::InternationalAccountValidation#is_correct
-      - Loqate::BatchEmailValidation#account
-      - Loqate::BatchEmailValidation#domain
-      - Loqate::BatchEmailValidation#email_address
-      - Loqate::BatchEmailValidation#invalid?
-      - Loqate::BatchEmailValidation#is_disposible
-      - Loqate::BatchEmailValidation#is_system_mailbox
-      - Loqate::BatchEmailValidation#status
-      - Loqate::BatchEmailValidation#unknown?
-      - Loqate::BatchEmailValidation#unverified?
-      - Loqate::BatchEmailValidation#valid?
+      - Loqate::Email::BatchEmailValidation#account
+      - Loqate::Email::BatchEmailValidation#domain
+      - Loqate::Email::BatchEmailValidation#email_address
+      - Loqate::Email::BatchEmailValidation#invalid?
+      - Loqate::Email::BatchEmailValidation#is_disposible
+      - Loqate::Email::BatchEmailValidation#is_system_mailbox
+      - Loqate::Email::BatchEmailValidation#status
+      - Loqate::Email::BatchEmailValidation#unknown?
+      - Loqate::Email::BatchEmailValidation#unverified?
+      - Loqate::Email::BatchEmailValidation#valid?
       - Loqate::Configuration#api_key
       - Loqate::Configuration#host
       - Loqate::Configuration#initialize
       - Loqate::Configuration#language
-      - Loqate::DetailedAddress#==
-      - Loqate::DetailedAddress#initialize
-      - Loqate::EmailGateway#initialize
-      - Loqate::EmailValidation#domain
-      - Loqate::EmailValidation#duration
-      - Loqate::EmailValidation#email_address
-      - Loqate::EmailValidation#invalid?
-      - Loqate::EmailValidation#is_complainer_or_fraud_risk
-      - Loqate::EmailValidation#is_disposable_or_temporary
-      - Loqate::EmailValidation#response_code
-      - Loqate::EmailValidation#response_message
-      - Loqate::EmailValidation#timeout?
-      - Loqate::EmailValidation#user_account
-      - Loqate::EmailValidation#valid?
-      - Loqate::EmailValidation#valid_domain?
+      - Loqate::Address::DetailedAddress#==
+      - Loqate::Address::DetailedAddress#initialize
+      - Loqate::Email::Gateway#initialize
+      - Loqate::Email::EmailValidation#domain
+      - Loqate::Email::EmailValidation#duration
+      - Loqate::Email::EmailValidation#email_address
+      - Loqate::Email::EmailValidation#invalid?
+      - Loqate::Email::EmailValidation#is_complainer_or_fraud_risk
+      - Loqate::Email::EmailValidation#is_disposable_or_temporary
+      - Loqate::Email::EmailValidation#response_code
+      - Loqate::Email::EmailValidation#response_message
+      - Loqate::Email::EmailValidation#timeout?
+      - Loqate::Email::EmailValidation#user_account
+      - Loqate::Email::EmailValidation#valid?
+      - Loqate::Email::EmailValidation#valid_domain?
       - Loqate::Error#cause
       - Loqate::Error#description
       - Loqate::Error#id
@@ -123,17 +123,17 @@ rules:
       - Loqate::Gateway#email
       - Loqate::Gateway#initialize
       - Loqate::Gateway#phone
-      - Loqate::PhoneGateway#initialize
-      - Loqate::PhoneNumberValidation#country_prefix
-      - Loqate::PhoneNumberValidation#is_valid
-      - Loqate::PhoneNumberValidation#national_format
-      - Loqate::PhoneNumberValidation#network_code
-      - Loqate::PhoneNumberValidation#network_country
-      - Loqate::PhoneNumberValidation#network_name
-      - Loqate::PhoneNumberValidation#number_type
-      - Loqate::PhoneNumberValidation#phone_number
-      - Loqate::PhoneNumberValidation#request_processed
-      - Loqate::PhoneNumberValidation#valid?
+      - Loqate::Phone::Gateway#initialize
+      - Loqate::Phone::PhoneNumberValidation#country_prefix
+      - Loqate::Phone::PhoneNumberValidation#is_valid
+      - Loqate::Phone::PhoneNumberValidation#national_format
+      - Loqate::Phone::PhoneNumberValidation#network_code
+      - Loqate::Phone::PhoneNumberValidation#network_country
+      - Loqate::Phone::PhoneNumberValidation#network_name
+      - Loqate::Phone::PhoneNumberValidation#number_type
+      - Loqate::Phone::PhoneNumberValidation#phone_number
+      - Loqate::Phone::PhoneNumberValidation#request_processed
+      - Loqate::Phone::PhoneNumberValidation#valid?
       - Loqate::Result#code
       - Loqate::Result#value
       - Loqate::Result::Failure#error
@@ -144,19 +144,19 @@ rules:
   ReturnTag:
     enabled: true
     exclude:
-      - Loqate::Address#==
-      - Loqate::Address#attributes
-      - Loqate::Address#description
-      - Loqate::Address#highlight
-      - Loqate::Address#id
-      - Loqate::Address#text
-      - Loqate::Address#type
-      - Loqate::AddressGateway#build_addresses_from
-      - Loqate::AddressGateway#build_detailed_address_from
-      - Loqate::AddressGateway#build_error_from
-      - Loqate::AddressGateway#client
-      - Loqate::AddressGateway#error_mapper
-      - Loqate::AddressGateway#mapper
+      - Loqate::Address::Address#==
+      - Loqate::Address::Address#attributes
+      - Loqate::Address::Address#description
+      - Loqate::Address::Address#highlight
+      - Loqate::Address::Address#id
+      - Loqate::Address::Address#text
+      - Loqate::Address::Address#type
+      - Loqate::Address::Gateway#build_addresses_from
+      - Loqate::Address::Gateway#build_detailed_address_from
+      - Loqate::Address::Gateway#build_error_from
+      - Loqate::Address::Gateway#client
+      - Loqate::Address::Gateway#error_mapper
+      - Loqate::Address::Gateway#mapper
       - Loqate::Bank::Gateway#build_account_validation_from
       - Loqate::Bank::Gateway#build_account_validations_from
       - Loqate::Bank::Gateway#build_branch_from
@@ -170,20 +170,20 @@ rules:
       - Loqate::Client#configuration
       - Loqate::Client#format_params
       - Loqate::Client#headers
-      - Loqate::DetailedAddress#==
-      - Loqate::EmailGateway#build_email_validation_from
-      - Loqate::EmailGateway#build_email_validations_from
-      - Loqate::EmailGateway#build_error_from
-      - Loqate::EmailGateway#client
-      - Loqate::EmailGateway#error_mapper
-      - Loqate::EmailGateway#mapper
+      - Loqate::Address::DetailedAddress#==
+      - Loqate::Email::Gateway#build_email_validation_from
+      - Loqate::Email::Gateway#build_email_validations_from
+      - Loqate::Email::Gateway#build_error_from
+      - Loqate::Email::Gateway#client
+      - Loqate::Email::Gateway#error_mapper
+      - Loqate::Email::Gateway#mapper
       - Loqate::Error#attributes
       - Loqate::Gateway#client
-      - Loqate::PhoneGateway#build_error_from
-      - Loqate::PhoneGateway#build_phone_validation_from
-      - Loqate::PhoneGateway#client
-      - Loqate::PhoneGateway#error_mapper
-      - Loqate::PhoneGateway#mapper
+      - Loqate::Phone::Gateway#build_error_from
+      - Loqate::Phone::Gateway#build_phone_validation_from
+      - Loqate::Phone::Gateway#client
+      - Loqate::Phone::Gateway#error_mapper
+      - Loqate::Phone::Gateway#mapper
       - Loqate::Result::Failure#error
       - Loqate::Util#camelize
       - Loqate::Util#underscore
@@ -192,19 +192,19 @@ rules:
   Summary::Presence:
     enabled: true
     exclude:
-      - Loqate::Address#==
-      - Loqate::Address#attributes
-      - Loqate::Address#description
-      - Loqate::Address#highlight
-      - Loqate::Address#id
-      - Loqate::Address#text
-      - Loqate::Address#type
-      - Loqate::AddressGateway#build_addresses_from
-      - Loqate::AddressGateway#build_detailed_address_from
-      - Loqate::AddressGateway#build_error_from
-      - Loqate::AddressGateway#client
-      - Loqate::AddressGateway#error_mapper
-      - Loqate::AddressGateway#mapper
+      - Loqate::Address::Address#==
+      - Loqate::Address::Address#attributes
+      - Loqate::Address::Address#description
+      - Loqate::Address::Address#highlight
+      - Loqate::Address::Address#id
+      - Loqate::Address::Address#text
+      - Loqate::Address::Address#type
+      - Loqate::Address::Gateway#build_addresses_from
+      - Loqate::Address::Gateway#build_detailed_address_from
+      - Loqate::Address::Gateway#build_error_from
+      - Loqate::Address::Gateway#client
+      - Loqate::Address::Gateway#error_mapper
+      - Loqate::Address::Gateway#mapper
       - Loqate::Bank::Gateway#build_account_validation_from
       - Loqate::Bank::Gateway#build_account_validations_from
       - Loqate::Bank::Gateway#build_branch_from
@@ -218,21 +218,21 @@ rules:
       - Loqate::Client#configuration
       - Loqate::Client#format_params
       - Loqate::Client#headers
-      - Loqate::DetailedAddress#==
-      - Loqate::DetailedAddress#initialize
-      - Loqate::EmailGateway#build_email_validation_from
-      - Loqate::EmailGateway#build_email_validations_from
-      - Loqate::EmailGateway#build_error_from
-      - Loqate::EmailGateway#client
-      - Loqate::EmailGateway#error_mapper
-      - Loqate::EmailGateway#mapper
+      - Loqate::Address::DetailedAddress#==
+      - Loqate::Address::DetailedAddress#initialize
+      - Loqate::Email::Gateway#build_email_validation_from
+      - Loqate::Email::Gateway#build_email_validations_from
+      - Loqate::Email::Gateway#build_error_from
+      - Loqate::Email::Gateway#client
+      - Loqate::Email::Gateway#error_mapper
+      - Loqate::Email::Gateway#mapper
       - Loqate::Error#attributes
       - Loqate::Gateway#client
-      - Loqate::PhoneGateway#build_error_from
-      - Loqate::PhoneGateway#build_phone_validation_from
-      - Loqate::PhoneGateway#client
-      - Loqate::PhoneGateway#error_mapper
-      - Loqate::PhoneGateway#mapper
+      - Loqate::Phone::Gateway#build_error_from
+      - Loqate::Phone::Gateway#build_phone_validation_from
+      - Loqate::Phone::Gateway#client
+      - Loqate::Phone::Gateway#error_mapper
+      - Loqate::Phone::Gateway#mapper
       - Loqate::Result::Failure#error
   Summary::Length:
     enabled: false

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.7.0] - 2018-12-03
+### Changed
+- Moved the `Address`, `Email` and `Phone` APIs into their own namespaces
+
 ## [0.6.0] - 2018-12-03
 ### Added
 - Bank API
@@ -53,6 +57,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Initial core functionality
 - Codebase maintenance tools
 
+[0.7.0]: https://github.com/wilsonsilva/loqate/compare/v0.6.0...v0.7.0
 [0.6.0]: https://github.com/wilsonsilva/loqate/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/wilsonsilva/loqate/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/wilsonsilva/loqate/compare/v0.3.0...v0.4.0

data/README.md

@@ -114,7 +114,6 @@ selection.
 
 ```ruby
 addresses = gateway.address.find!(text: 'EC1Y 8AF', country: 'GB', limit: 5)
-
 addresses.first.id # => 'GB|RM|B|8144611'
 ```
 
@@ -138,17 +137,8 @@ a new phone number validation request.
 
 ```ruby
 phone_validation = gateway.phone.validate!(phone: '+447440029210', country: 'GB')
-
-phone_validation.phone_number      # => '+447440029210'
-phone_validation.request_processed # => true
-phone_validation.is_valid          # => 'Yes' -> This is how Loqate defines validity
-phone_validation.valid?            # => true
-phone_validation.network_code      # => '26'
-phone_validation.network_name      # => 'Telefonica UK'
-phone_validation.network_country   # => 'GB'
-phone_validation.national_format   # => '07440 029210'
-phone_validation.country_prefix    # => 44
-phone_validation.number_type       # => 'Mobile'
+phone_validation.phone_number # => '+447440029210'
+phone_validation.valid?       # => true
 ```
 
 ### Email API
@@ -162,37 +152,15 @@ validate multiple emails at once.
 #### Validating an email address
 ```ruby
 email_validation = gateway.email.validate!(email: 'person@gmail.com')
-
-email_validation.response_code               # => 'Valid'
-email_validation.response_message            # => 'Email address was fully validated'
-email_validation.email_address               # => 'person@gmail.com'
-email_validation.user_account                # => 'person'
-email_validation.domain                      # => 'gmail.com'
-email_validation.is_disposable_or_temporary  # => false
-email_validation.is_complainer_or_fraud_risk # => false
-email_validation.duration                    # => 0.007366261
-email_validation.valid?                      # => true
-email_validation.valid_domain?               # => true
-email_validation.invalid?                    # => false
-email_validation.timeout?                    # => false
+email_validation.valid? # => true
 ```
 
 #### Validating multiple email addresses
 
 ```ruby                                                                    
 email_validations = gateway.email.batch_validate!(emails: %w[person@gmail.com])
-email_validation = email_validations.first
-
-email_validation.status            # => 'Valid'
-email_validation.email_address     # => 'person@gmail.com'
-email_validation.account           # => 'person'
-email_validation.domain            # => 'gmail.com'
-email_validation.is_disposible     # => false
-email_validation.is_system_mailbox # => false
-email_validation.valid?            # => true
-email_validation.invalid?          # => false
-email_validation.unknown?          # => false
-email_validation.unverified?       # => false
+email_validation  = email_validations.first
+email_validation.valid? # => true
 ```
 
 ### Bank API
@@ -221,10 +189,10 @@ account_validation.correct? # => true
 #### Validating multiple bank accounts
 ```ruby
 accounts_validations = gateway.bank.batch_validate_accounts!(
-  account_numbers: %w[51065718 00000000],
-  sort_codes: %w[40-41-31 000000]
+  account_numbers: %w[51065718 12001020],
+  sort_codes: %w[40-41-31 083210]
 )
-accounts_validations.first.correct? # => true
+accounts_validations.first.correct?  # => true
 accounts_validations.second.correct? # => false
 ```
 

data/ROADMAP.md

@@ -19,7 +19,7 @@
 - [ ] Data Cleanse
 - [x] Email Verification
 - [x] Phone Verification
-- [ ] Bank Verification
+- [x] Bank Verification
 
 ## Formats
 

data/lib/loqate/address/address.rb

@@ -0,0 +1,37 @@
+module Loqate
+  module Address
+    # A result from the address find service.
+    class Address < Dry::Struct::Value
+      # An address ID or a container ID for further results
+      #
+      # @return [String]
+      #
+      attribute :id, Types::Strict::String
+
+      # If the Type is 'Address' then the ID can be passed to the Retrieve service.
+      # Any other ID should be passed as the Container to a further Find request to get more results.
+      #
+      # @return [String]
+      #
+      attribute :type, Types::Strict::String
+
+      # The name of the result
+      #
+      # @return [String]
+      #
+      attribute :text, Types::Strict::String
+
+      # A list of number ranges identifying the matched characters in the Text and Description
+      #
+      # @return [String]
+      #
+      attribute :highlight, Types::Strict::String
+
+      # Descriptive information about the result
+      #
+      # @return [String]
+      #
+      attribute :description, Types::Strict::String
+    end
+  end
+end

data/lib/loqate/address/detailed_address.rb

@@ -0,0 +1,85 @@
+module Loqate
+  module Address
+    # A result from the address retrieve service.
+    class DetailedAddress
+      # For the first version, this will be a flat structure, exactly as it is defined in Loqate's API.
+      # But this many attributes is too much for a single object to hold.
+      #
+      # @api private
+      #
+      ATTRIBUTES = %i[
+        admin_area_code
+        admin_area_name
+        barcode
+        block
+        building_name
+        building_number
+        city
+        company
+        country_iso2
+        country_iso3
+        country_iso_number
+        country_name
+        data_level
+        department
+        district
+        domestic_id
+        field1
+        field2
+        field3
+        field4
+        field5
+        field6
+        field7
+        field8
+        field9
+        field10
+        field11
+        field12
+        field13
+        field14
+        field15
+        field16
+        field17
+        field18
+        field19
+        field20
+        id
+        label
+        language
+        language_alternatives
+        line1
+        line2
+        line3
+        line4
+        line5
+        neighbourhood
+        po_box_number
+        postal_code
+        province
+        province_code
+        province_name
+        secondary_street
+        sorting_number1
+        sorting_number2
+        street
+        sub_building
+        type
+      ].freeze
+
+      ATTRIBUTES.each do |attribute|
+        attr_reader attribute
+      end
+
+      def initialize(options = {})
+        options.each_pair do |key, value|
+          instance_variable_set("@#{key}", value) if ATTRIBUTES.include?(key)
+        end
+      end
+
+      def ==(other)
+        other.is_a?(DetailedAddress) && id == other.id
+      end
+    end
+  end
+end