Contents

require 'loqate/address_gateway'
require 'loqate/email_gateway'
require 'loqate/phone_gateway'

module Loqate
  # Acts as a single point of entry for a defined group of API's.
  class Gateway
    # The gem configuration.
    #
    # @return [Configuration]
    #
    attr_reader :config

    # Creates a new gateway.
    #
    # @param [Hash] options Options to configure the gem.
    # @option options [String] :api_key API key that will give you access to all services
    # @option options [String] :host Base URL for Loqate's services
    # @option options [String] :language Preferred language for results
    #
    # @see Configuration
    #
    def initialize(options)
      @config = Configuration.new(options)
      @client = Client.new(config)
    end

    # Gateway to the Address APIs.
    #
    # @return [AddressGateway] An instance of an address gateway.
    #
    def address
      @address ||= AddressGateway.new(client)
    end

    # Gateway to the Phone number API.
    #
    # @return [PhoneGateway] An instance of a phone gateway.
    #
    def phone
      @phone ||= PhoneGateway.new(client)
    end

    # Gateway to the Email verification APIs.
    #
    # @return [EmailGateway] An instance of an email gateway.
    #
    def email
      @email ||= EmailGateway.new(client)
    end

    private

    # @api private
    attr_reader :client
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
loqate-0.5.0	lib/loqate/gateway.rb