loqate 0.6.0 → 0.7.0

data/lib/loqate/detailed_address.rb

@@ -1,83 +0,0 @@
-module Loqate
-  # 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

data/lib/loqate/email_gateway.rb

@@ -1,122 +0,0 @@
-require 'loqate/client'
-require 'loqate/result'
-require 'loqate/email_validation'
-require 'loqate/batch_email_validation'
-require 'loqate/mappers/error_mapper'
-require 'loqate/mappers/generic_mapper'
-
-module Loqate
-  # Validates the existence of email addresses.
-  #
-  class EmailGateway
-    BATCH_VALIDATE_ENDPOINT = '/EmailValidation/Batch/Validate/v1.20/json3.ws'.freeze
-    VALIDATE_ENDPOINT = '/EmailValidation/Interactive/Validate/v2.00/json3.ws'.freeze
-
-    include Result::Mixin
-
-    # Creates an email gateway.
-    #
-    # @param [Client] client The client responsible for the HTTP interactions
-    #
-    def initialize(client)
-      @client       = client
-      @mapper       = Mappers::GenericMapper.new
-      @error_mapper = Mappers::ErrorMapper.new
-    end
-
-    # Verifies the existence of an email address.
-    #
-    # @param [Hash] options The options to validate an email address.
-    # @option options [String] :email The email address to verify.
-    # @option options [Integer] :timeout The time (in milliseconds) you want to give for the validation attempt to be
-    #   executed within. Value must be between 1 and 15000 (values outside of these ranges will fallback to the
-    #   default of 15000).
-    #
-    # @example
-    #   email_validation = email_gateway.validate(email: 'spam@example.com')
-    #
-    # @return [Result] A result wrapping an email address validation
-    #
-    def validate(options)
-      response = client.get(VALIDATE_ENDPOINT, options)
-
-      response.errors? && build_error_from(response.items.first) || build_email_validation_from(response.items.first)
-    end
-
-    # Verifies the existence of an email address.
-    #
-    # @param [Hash] options The options to validate an email address.
-    # @option options [String] :email The email address to verify.
-    # @option options [Integer] :timeout The time (in milliseconds) you want to give for the validation attempt to be
-    #   executed within. Value must be between 1 and 15000 (values outside of these ranges will fallback to the
-    #   default of 15000).
-    #
-    # @example
-    #   email_validation = email_gateway.validate!(email: 'spam@example.com')
-    #
-    # @raise [Error] If the result is not a success
-    #
-    # @return [EmailValidation> An email address validation
-    #
-    def validate!(options)
-      unwrap_result_or_raise { validate(options) }
-    end
-
-    # Verifies up to 100 emails per batch.
-    #
-    # @param [Hash] options The options to validate an email address.
-    # @option options [Array<String>] :emails The email addresses to verify. Maximum 100 records.
-    #
-    # @example
-    #   result = email_gateway.batch_validate(emails: %w[spam@example.com example@example.com])
-    #   result.value # => [#<Loqate::BatchEmailValidation status="Invalid" ...]
-    #
-    # @return [Result] A result wrapping a list of email address validations
-    #
-    def batch_validate(options)
-      options[:emails] = options[:emails].join(',') if options[:emails]
-      response = client.get(BATCH_VALIDATE_ENDPOINT, options)
-
-      response.errors? && build_error_from(response.items.first) || build_email_validations_from(response.items)
-    end
-
-    # Verifies up to 100 emails per batch.
-    #
-    # @param [Hash] options The options to validate an email address.
-    # @option options [Array<String>] :emails The email addresses to verify. Maximum 100 records.
-    #
-    # @example
-    #   email_validations = email_gateway.batch_validate!(emails: %w[spam@example.com example@example.com])
-    #
-    # @raise [Error] If the result is not a success
-    #
-    # @return [Array<BatchEmailValidation>] A list of email address validations
-    #
-    def batch_validate!(options)
-      unwrap_result_or_raise { batch_validate(options) }
-    end
-
-    private
-
-    # @api private
-    attr_reader :client, :mapper, :error_mapper
-
-    # @api private
-    def build_error_from(item)
-      error = error_mapper.map_one(item)
-      Failure(error)
-    end
-
-    # @api private
-    def build_email_validation_from(item)
-      email_validation = mapper.map_one(item, EmailValidation)
-      Success(email_validation)
-    end
-
-    # @api private
-    def build_email_validations_from(item)
-      email_validation = mapper.map(item, BatchEmailValidation)
-      Success(email_validation)
-    end
-  end
-end

data/lib/loqate/email_validation.rb

@@ -1,81 +0,0 @@
-module Loqate
-  # Result of a email address validation.
-  class EmailValidation < Dry::Struct::Value
-    ResponseCode = Types::Strict::String.enum('Valid', 'Valid_CatchAll', 'Invalid', 'Timeout')
-
-    # Valid - The email address has been fully validated (including the account portion)
-    # Valid_CatchAll - The domain has been validated but the account could not be validated
-    # Invalid - The email address is invalid and shouldn't be accepted
-    # Timeout - The validation could not be completed within the timeout specified (try increasing the timeout value)
-    #
-    # @return ['Valid', 'Valid_CatchAll', 'Invalid', 'Timeout']
-    #
-    attribute :response_code, ResponseCode
-
-    # A textual description of the ResponseCode returned
-    #
-    # @return [String]
-    #
-    attribute :response_message, Types::Strict::String
-
-    # The email address that verification was attempted on.
-    #
-    # @return [String]
-    #
-    attribute :email_address, Types::Strict::String
-
-    # The account portion of the email address provided.
-    #
-    # @return [String
-    #
-    attribute :user_account, Types::Strict::String
-
-    # The domain portion of the email address provided.
-    #
-    # @return [String]
-    #
-    attribute :domain, Types::Strict::String
-
-    # Whether the email address provided is a disposable mailbox (some companies create temporary mailboxes
-    # which shouldn't be used for marketing communications).
-    #
-    # @return [Boolean]
-    #
-    attribute :is_disposable_or_temporary, Types::Strict::Bool
-
-    # True if we recognise the email address against known lists of complainers and/or the email address has been
-    # used to defraud.
-    #
-    # @return [Boolean]
-    #
-    attribute :is_complainer_or_fraud_risk, Types::Strict::Bool
-
-    # The duration (in seconds) that the email validation took (maximum timeout enforced at 15 seconds).
-    # We recommend a high timeout (at least 5 seconds) value as it will minimise the number of "Timeout"
-    # responses returned.
-    #
-    # @return [Float]
-    #
-    attribute :duration, Types::Strict::Float
-
-    # Whether the email was fully validated (including the account portion).
-    def valid?
-      response_code == 'Valid'
-    end
-
-    # Whether the domain has been validated but the account hasn't.
-    def valid_domain?
-      response_code == 'Valid' || response_code == 'Valid_CatchAll'
-    end
-
-    # Whether the email is invalid and shouldn't be accepted.
-    def invalid?
-      response_code == 'Invalid'
-    end
-
-    # Whether the validation could not be completed within the timeout specified.
-    def timeout?
-      response_code == 'Timeout'
-    end
-  end
-end

data/lib/loqate/phone_gateway.rb

@@ -1,82 +0,0 @@
-require 'loqate/client'
-require 'loqate/result'
-require 'loqate/mappers/error_mapper'
-require 'loqate/mappers/generic_mapper'
-require 'loqate/phone_number_validation'
-
-module Loqate
-  # Starts a new phone number validation request.
-  #
-  class PhoneGateway
-    VALIDATE_ENDPOINT = '/PhoneNumberValidation/Interactive/Validate/v2.20/json3.ws'.freeze
-
-    include Result::Mixin
-
-    # Creates a phone gateway
-    #
-    # @param [Client] client The client responsible for the HTTP interactions
-    #
-    def initialize(client)
-      @client       = client
-      @mapper       = Mappers::GenericMapper.new
-      @error_mapper = Mappers::ErrorMapper.new
-    end
-
-    # Validates phone numbers.
-    #
-    # @param [Hash] options The options to validate a phone number.
-    # @option options [String] :phone The mobile/cell phone number to verify. This must be in international format
-    #   (+447528471411 or 447528471411) if no country code is provided or national format with a Country parameter
-    #   provided (07528471411 and GB as the Country parameter).
-    # @option options [String] :country The ISO2 country code of the number you are trying to validate
-    #   (if provided in national format).
-    #
-    # @example
-    #   phone_validation = phone_gateway.validate(phone: '447440019210', country: 'GB')
-    #
-    # @return [Result] A result wrapping a phone number validation
-    #
-    def validate(options)
-      response = client.get(VALIDATE_ENDPOINT, options)
-
-      response.errors? && build_error_from(response.items.first) || build_phone_validation_from(response.items.first)
-    end
-
-    # Validates phone numbers.
-    #
-    # @param [Hash] options The options to validate a phone number.
-    # @option options [String] :phone The mobile/cell phone number to verify. This must be in international format
-    #   (+447528471411 or 447528471411) if no country code is provided or national format with a Country parameter
-    #   provided (07528471411 and GB as the Country parameter).
-    # @option options [String] :country The ISO2 country code of the number you are trying to validate
-    #   (if provided in national format).
-    #
-    # @example
-    #   phone_validation = phone_gateway.validate(phone: '447440019210', country: 'GB')
-    #
-    # @raise [Error] If the result is not a success
-    #
-    # @return [PhoneNumberValidation> A phone number validation
-    #
-    def validate!(options)
-      unwrap_result_or_raise { validate(options) }
-    end
-
-    private
-
-    # @api private
-    attr_reader :client, :mapper, :error_mapper
-
-    # @api private
-    def build_error_from(item)
-      error = error_mapper.map_one(item)
-      Failure(error)
-    end
-
-    # @api private
-    def build_phone_validation_from(item)
-      phone_number_validation = mapper.map_one(item, PhoneNumberValidation)
-      Success(phone_number_validation)
-    end
-  end
-end

data/lib/loqate/phone_number_validation.rb

@@ -1,67 +0,0 @@
-module Loqate
-  # Result of a phone number validation.
-  class PhoneNumberValidation < Dry::Struct::Value
-    IsValid = Types::Strict::String.enum('Yes', 'No', 'Unknown')
-    NumberType = Types::Strict::String.enum('Mobile', 'Landline', 'Voip', 'Unknown')
-
-    # The recipient phone number in international format.
-    #
-    # @return [String]
-    #
-    attribute :phone_number, Types::Strict::String
-
-    # Returns true if we managed to process the request on the network or false if the validation
-    # attempt was unsuccessful.
-    #
-    # @return [Boolean]
-    #
-    attribute :request_processed, Types::Strict::Bool
-
-    # Whether the number is valid or not (Unknown returned if validation wasn't possible).
-    #
-    # @return [String]
-    #
-    attribute :is_valid, IsValid
-
-    # The current operator serving the supplied number.
-    #
-    # @return [String]
-    #
-    attribute :network_code, Types::Strict::String
-
-    # The name of the current operator serving the supplied number.
-    #
-    # @return [String]
-    #
-    attribute :network_name, Types::Strict::String
-
-    # The country code of the operator.
-    #
-    # @return [String]
-    #
-    attribute :network_country, Types::Strict::String
-
-    # The domestic network format (useful for dialling from within the same country).
-    #
-    # @return [String]
-    #
-    attribute :national_format, Types::Strict::String
-
-    # The country prefix that must be prepended to the number when dialling internationally.
-    #
-    # @return [Integer]
-    #
-    attribute :country_prefix, Types::Coercible::Integer
-
-    # The type of number that was detected in the request (Mobile, Landline, VOIP or Unknown).
-    #
-    # @return [String]
-    #
-    attribute :number_type, NumberType
-
-    # Whether the validation was successful or not.
-    def valid?
-      is_valid == 'Yes'
-    end
-  end
-end