smartystreets_ruby_sdk 0.0.0

data/lib/smartystreets_ruby_sdk/international_autocomplete/client.rb

@@ -0,0 +1,61 @@
+require_relative '../request'
+require_relative '../exceptions'
+require_relative 'suggestion'
+
+module SmartyStreets
+  module InternationalAutocomplete
+    # It is recommended to instantiate this class using ClientBuilder.build_international_autocomplete_api_client
+    class Client
+      def initialize(sender, serializer)
+        @sender = sender
+        @serializer = serializer
+      end
+
+      # Sends a Lookup object to the International Autocomplete API and stores the result in the Lookup's result field.
+      def send(lookup)
+        if not lookup or not lookup.search
+          raise SmartyStreets::SmartyError, 'Send() must be passed a Lookup with the prefix field set.'
+        end
+
+        request = build_request(lookup)
+
+        response = @sender.send(request)
+
+        raise response.error if response.error
+
+        result = @serializer.deserialize(response.payload)
+        suggestions = convert_suggestions(result.fetch('candidates', []))
+        lookup.result = suggestions
+      end
+
+
+      def build_request(lookup)
+        request = Request.new
+
+        add_parameter(request, 'search', lookup.search)
+        add_parameter(request, 'country', lookup.country)
+        add_parameter(request, 'include_only_administrative_area', lookup.administrative_area)
+        add_parameter(request, 'include_only_locality', lookup.locality)
+        add_parameter(request, 'include_only_postal_code', lookup.postal_code)
+
+        request
+      end
+
+      def convert_suggestions(suggestion_hashes)
+        converted_suggestions = []
+        return converted_suggestions if suggestion_hashes.nil?
+
+        suggestion_hashes.each do |suggestion|
+          converted_suggestions.push(InternationalAutocomplete::Suggestion.new(suggestion))
+        end
+
+        converted_suggestions
+      end
+
+      def add_parameter(request, key, value)
+        request.parameters[key] = value unless value.nil? or value.empty?
+      end
+    end
+  end
+end
+

data/lib/smartystreets_ruby_sdk/international_autocomplete/lookup.rb

@@ -0,0 +1,21 @@
+require_relative '../json_able'
+
+module SmartyStreets
+  module InternationalAutocomplete
+    # In addition to holding all of the input data for this lookup, this class also will contain the result
+    # of the lookup after it comes back from the API.
+    class Lookup < JSONAble
+
+      attr_accessor :result, :search, :country, :administrative_area, :locality, :postal_code
+
+      def initialize(search=nil, country=nil, administrative_area=nil, locality=nil, postal_code=nil)
+        @result = []
+        @search = search
+        @country = country
+        @administrative_area = administrative_area
+        @locality = locality
+        @postal_code = postal_code
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/international_autocomplete/suggestion.rb

@@ -0,0 +1,16 @@
+module SmartyStreets
+  module InternationalAutocomplete
+    class Suggestion
+
+      attr_reader :street, :locality, :administrative_area, :postal_code, :country_iso3
+
+      def initialize(obj)
+        @street = obj.fetch('street', nil)
+        @locality = obj.fetch('locality', nil)
+        @administrative_area = obj.fetch('administrative_area', nil)
+        @postal_code = obj.fetch('postal_code', nil)
+        @country_iso3 = obj.fetch('country_iso3', nil)
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/international_street/analysis.rb

@@ -0,0 +1,17 @@
+require_relative 'changes'
+module SmartyStreets
+  module InternationalStreet
+    # See "https://smartystreets.com/docs/cloud/international-street-api#analysis"
+    class Analysis
+
+      attr_reader :max_address_precision, :verification_status, :address_precision, :changes
+
+      def initialize(obj)
+        @verification_status = obj.fetch('verification_status', nil)
+        @address_precision = obj.fetch('address_precision', nil)
+        @max_address_precision = obj.fetch('max_address_precision', nil)
+        @changes = Changes.new(obj.fetch('changes', {}))
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/international_street/candidate.rb

@@ -0,0 +1,23 @@
+require_relative 'components'
+require_relative 'metadata'
+require_relative 'analysis'
+require_relative 'rootlevel'
+
+module SmartyStreets
+  module InternationalStreet
+    # A candidate is a possible match for an address that was submitted. A lookup can have multiple
+    # candidates if the address was ambiguous.
+    #
+    # See "https://smartystreets.com/docs/cloud/international-street-api#root"
+    class Candidate < RootLevel
+      attr_reader :metadata, :components, :analysis
+
+      def initialize(obj)
+        @components = Components.new(obj.fetch('components', {}))
+        @metadata = Metadata.new(obj.fetch('metadata', {}))
+        @analysis = Analysis.new(obj.fetch('analysis', {}))
+        super(obj)
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/international_street/changes.rb

@@ -0,0 +1,15 @@
+require_relative 'rootlevel'
+require_relative 'components'
+
+module SmartyStreets
+  module InternationalStreet
+    class Changes < RootLevel
+      attr_reader :components
+
+      def initialize(obj)
+        @components = Components.new(obj.fetch('components', {}))
+        super(obj)
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/international_street/client.rb

@@ -0,0 +1,63 @@
+require_relative '../request'
+require_relative 'candidate'
+
+module SmartyStreets
+  module InternationalStreet
+    # It is recommended to instantiate this class using ClientBuilder.build_international_street_api_client()
+    class Client
+      def initialize(sender, serializer)
+        @sender = sender
+        @serializer = serializer
+      end
+
+      # Sends a Lookup object to the International Street API and stores the result in the Lookup's result field.
+      def send(lookup)
+        lookup.ensure_enough_info
+        request = build_request(lookup)
+
+        response = @sender.send(request)
+
+        raise response.error if response.error
+
+        candidates = convert_candidates(@serializer.deserialize(response.payload))
+        lookup.result = candidates
+      end
+
+      def build_request(lookup)
+        request = SmartyStreets::Request.new
+
+        add_parameter(request, 'input_id', lookup.input_id)
+        add_parameter(request, 'country', lookup.country)
+        add_parameter(request, 'geocode', lookup.geocode.to_s)
+        add_parameter(request, 'language', lookup.language)
+        add_parameter(request, 'freeform', lookup.freeform)
+        add_parameter(request, 'address1', lookup.address1)
+        add_parameter(request, 'address2', lookup.address2)
+        add_parameter(request, 'address3', lookup.address3)
+        add_parameter(request, 'address4', lookup.address4)
+        add_parameter(request, 'organization', lookup.organization)
+        add_parameter(request, 'locality', lookup.locality)
+        add_parameter(request, 'administrative_area', lookup.administrative_area)
+        add_parameter(request, 'postal_code', lookup.postal_code)
+
+        request
+      end
+
+      def add_parameter(request, key, value)
+        request.parameters[key] = value unless value.nil? or value.empty?
+      end
+
+      def convert_candidates(raw_candidates)
+        candidates = []
+
+        unless raw_candidates.nil?
+          raw_candidates.each do |candidate|
+            candidates.push(Candidate.new(candidate))
+          end
+        end
+
+        candidates
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/international_street/components.rb

@@ -0,0 +1,58 @@
+module SmartyStreets
+  module InternationalStreet
+    # See "https://smartystreets.com/docs/cloud/international-street-api#components"
+    class Components
+      attr_reader :premise, :thoroughfare_trailing_type, :sub_building, :locality, :post_box_number,
+                  :thoroughfare_name, :thoroughfare_postdirection, :dependent_thoroughfare, :premise_prefix_number,
+                  :thoroughfare, :dependent_thoroughfare_name, :postal_code_short, :dependent_thoroughfare_trailing_type,
+                  :administrative_area, :post_box, :building_leading_type, :dependent_locality_name, :thoroughfare_type,
+                  :dependent_thoroughfare_postdirection, :double_dependent_locality, :premise_number,
+                  :dependent_thoroughfare_type, :post_box_type, :building, :sub_administrative_area, :postal_code_extra,
+                  :sub_building_name, :postal_code, :dependent_locality, :premise_type, :sub_building_number,
+                  :super_administrative_area, :premise_extra, :dependent_thoroughfare_predirection,
+                  :building_trailing_type, :thoroughfare_predirection, :building_name, :country_iso_3, :sub_building_type
+
+      def initialize(obj)
+        @country_iso_3 = obj.fetch('country_iso_3', nil)
+        @super_administrative_area = obj.fetch('super_administrative_area', nil)
+        @administrative_area = obj.fetch('administrative_area', nil)
+        @sub_administrative_area = obj.fetch('sub_administrative_area', nil)
+        @dependent_locality= obj.fetch('dependent_locality', nil)
+        @dependent_locality_name = obj.fetch('dependent_locality_name', nil)
+        @double_dependent_locality = obj.fetch('double_dependent_locality', nil)
+        @locality = obj.fetch('locality', nil)
+        @postal_code = obj.fetch('postal_code', nil)
+        @postal_code_short = obj.fetch('postal_code_short', nil)
+        @postal_code_extra = obj.fetch('postal_code_extra', nil)
+        @premise = obj.fetch('premise', nil)
+        @premise_extra = obj.fetch('premise_extra', nil)
+        @premise_number = obj.fetch('premise_number', nil)
+        @premise_prefix_number = obj.fetch('premise_prefix_number', nil)
+        @premise_type = obj.fetch('premise_type', nil)
+        @thoroughfare = obj.fetch('thoroughfare', nil)
+        @thoroughfare_predirection = obj.fetch('thoroughfare_predirection', nil)
+        @thoroughfare_postdirection = obj.fetch('thoroughfare_postdirection', nil)
+        @thoroughfare_name = obj.fetch('thoroughfare_name', nil)
+        @thoroughfare_trailing_type = obj.fetch('thoroughfare_trailing_type', nil)
+        @thoroughfare_type = obj.fetch('thoroughfare_type', nil)
+        @dependent_thoroughfare = obj.fetch('dependent_thoroughfare', nil)
+        @dependent_thoroughfare_predirection = obj.fetch('dependent_thoroughfare_predirection', nil)
+        @dependent_thoroughfare_postdirection = obj.fetch('dependent_thoroughfare_postdirection', nil)
+        @dependent_thoroughfare_name = obj.fetch('dependent_thoroughfare_name', nil)
+        @dependent_thoroughfare_trailing_type = obj.fetch('dependent_thoroughfare_trailing_type', nil)
+        @dependent_thoroughfare_type = obj.fetch('dependent_thoroughfare_type', nil)
+        @building = obj.fetch('building', nil)
+        @building_leading_type = obj.fetch('building_leading_type', nil)
+        @building_name = obj.fetch('building_name', nil)
+        @building_trailing_type = obj.fetch('building_trailing_type', nil)
+        @sub_building_type = obj.fetch('sub_building_type', nil)
+        @sub_building_number = obj.fetch('sub_building_number', nil)
+        @sub_building_name = obj.fetch('sub_building_name', nil)
+        @sub_building = obj.fetch('sub_building', nil)
+        @post_box = obj.fetch('post_box', nil)
+        @post_box_type = obj.fetch('post_box_type', nil)
+        @post_box_number = obj.fetch('post_box_number', nil)
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/international_street/language_mode.rb

@@ -0,0 +1,9 @@
+module SmartyStreets
+  module InternationalStreet
+    module LanguageMode
+      NATIVE = 'native'.freeze
+
+      LATIN = 'latin'.freeze
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/international_street/lookup.rb

@@ -0,0 +1,82 @@
+module SmartyStreets
+  module InternationalStreet
+    # In addition to holding all of the input data for this lookup, this class also will contain the
+    # result of the lookup after it comes back from the API.
+    #
+    # Note: Lookups must have certain required fields set with non-blank values.
+    # These can be found at the URL below.
+    #
+    # See "https://smartystreets.com/docs/cloud/international-street-api#http-input-fields"
+    #
+    # @geocode:: Disabled by default. Set to true to enable.
+    # @language:: When not set, the output language will match the language of the input values.
+    #     When set to language_mode.NATIVE, the results will always be in the language of the output country.
+    #     When set to language_mode.LATIN, the results will always be provided using a Latin character set.
+    class Lookup
+
+      attr_accessor :input_id, :freeform, :locality, :postal_code, :address3, :address2, :inputId, :address1,
+                    :geocode, :administrative_area, :country, :organization, :language, :address4, :result
+
+      def initialize(freeform=nil, country=nil)
+        @result = []
+
+        @input_id = nil
+        @country = country
+        @geocode = nil
+        @language = nil
+        @freeform = freeform
+        @address1 = nil
+        @address2 = nil
+        @address3 = nil
+        @address4 = nil
+        @organization = nil
+        @locality = nil
+        @administrative_area = nil
+        @postal_code = nil
+      end
+
+      def missing_country
+        field_is_missing(@country)
+      end
+
+      def has_freeform
+        field_is_set(@freeform)
+      end
+
+      def missing_address1
+        field_is_missing(@address1)
+      end
+
+      def has_postal_code
+        field_is_set(@postal_code)
+      end
+
+      def missing_locality_or_administrative_area
+        field_is_missing(@locality) or field_is_missing(@administrative_area)
+      end
+
+      def field_is_missing(field)
+        field.nil? or field.empty?
+      end
+
+      def field_is_set(field)
+        not field_is_missing(field)
+      end
+
+      def ensure_enough_info
+        raise UnprocessableEntityError, 'Country field is required.' if missing_country
+
+        return true if has_freeform
+
+        raise UnprocessableEntityError, 'Either freeform or address1 is required.' if missing_address1
+
+        return true if has_postal_code
+
+        if missing_locality_or_administrative_area
+          raise UnprocessableEntityError, 'Insufficient information:'\
+              'One or more required fields were not set on the lookup.'
+        end
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/international_street/metadata.rb

@@ -0,0 +1,17 @@
+module SmartyStreets
+  module InternationalStreet
+    # See "https://smartystreets.com/docs/cloud/international-street-api#metadata"
+    class Metadata
+
+      attr_reader :longitude, :geocode_precision, :max_geocode_precision, :latitude, :address_format
+
+      def initialize(obj)
+        @latitude = obj.fetch('latitude', nil)
+        @longitude = obj.fetch('longitude', nil)
+        @geocode_precision = obj.fetch('geocode_precision', nil)
+        @max_geocode_precision = obj.fetch('max_geocode_precision', nil)
+        @address_format = obj.fetch('address_format', nil)
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/international_street/rootlevel.rb

@@ -0,0 +1,25 @@
+module SmartyStreets
+  module InternationalStreet
+    class RootLevel
+      attr_reader :input_id, :organization, :address1, :address2, :address3, :address4, :address5, :address6, :address7,
+                  :address8, :address9, :address10, :address11, :address12
+
+      def initialize(obj)
+        @input_id = obj.fetch('input_id', nil)
+        @organization = obj.fetch('organization', nil)
+        @address1 = obj.fetch('address1', nil)
+        @address2 = obj.fetch('address2', nil)
+        @address3 = obj.fetch('address3', nil)
+        @address4 = obj.fetch('address4', nil)
+        @address5 = obj.fetch('address5', nil)
+        @address6 = obj.fetch('address6', nil)
+        @address7 = obj.fetch('address7', nil)
+        @address8 = obj.fetch('address8', nil)
+        @address9 = obj.fetch('address9', nil)
+        @address10 = obj.fetch('address10', nil)
+        @address11 = obj.fetch('address11', nil)
+        @address12 = obj.fetch('address12', nil)
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/international_street.rb

@@ -0,0 +1,12 @@
+require_relative './international_street/lookup'
+require_relative './international_street/metadata'
+require_relative './international_street/analysis'
+require_relative './international_street/components'
+require_relative './international_street/candidate'
+require_relative './international_street/client'
+require_relative './international_street/language_mode'
+
+module SmartyStreets
+  module InternationalStreet
+  end
+end

data/lib/smartystreets_ruby_sdk/json_able.rb

@@ -0,0 +1,19 @@
+require 'json'
+
+module SmartyStreets
+  class JSONAble
+    def to_json(options={})
+      hash = {}
+      instance_variables.each do |var|
+        hash[var.to_s.delete('@')] = instance_variable_get var
+      end
+      hash.to_json
+    end
+
+    def from_json!(string)
+      JSON.load(string).each do |var, val|
+        instance_variable_set var, val
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/license_sender.rb

@@ -0,0 +1,15 @@
+module SmartyStreets
+  class LicenseSender
+    def initialize(inner, licenses)
+      @inner = inner
+      @licenses = licenses
+    end
+
+    def send(request)
+      if @licenses.length > 0
+        request.parameters['license'] = @licenses.join(',')
+      end
+      @inner.send(request)
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/logger.rb

@@ -0,0 +1,7 @@
+module SmartyStreets
+  class Logger
+    def log(message)
+      puts message
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/native_sender.rb

@@ -0,0 +1,85 @@
+require 'net/http'
+require_relative 'version'
+require_relative 'response'
+
+module SmartyStreets
+  class NativeSender
+    def initialize(max_timeout = 10, proxy = nil, debug = false)
+      @max_timeout = max_timeout
+      @proxy = proxy
+      @debug = debug
+    end
+
+    def send(smarty_request)
+      request = self.class.build_request(smarty_request)
+
+      begin
+        http = build_http(request)
+        http.use_ssl = true
+        http.ssl_version = :TLSv1_2
+        http.open_timeout = @max_timeout
+        http.read_timeout = @max_timeout
+
+        response = http.request(request)
+
+        http.finish if http.started?
+      rescue StandardError => err
+        return Response.new(nil, nil, err)
+      end
+
+      build_smarty_response(response)
+    end
+
+    def self.build_request(smarty_request)
+      query = create_query(smarty_request)
+
+      if smarty_request.payload.nil?
+        request = Net::HTTP::Get.new(URI.parse("#{smarty_request.url_prefix}?#{query}"))
+      else
+        request = Net::HTTP::Post.new(URI.parse("#{smarty_request.url_prefix}?#{query}"))
+      end
+
+      request.content_type = 'application/json'
+      request.body = smarty_request.payload
+      request['User-Agent'] = "smartystreets (sdk:ruby@#{SmartyStreets::VERSION})"
+      request['Referer'] = smarty_request.referer unless smarty_request.referer.nil?
+      set_custom_headers(smarty_request.headers, request)
+      request
+    end
+
+    def build_smarty_response(native_response)
+      Response.new(native_response.body, native_response.code)
+    end
+
+    def build_http(request)
+      uri = request.uri
+
+      if @proxy.nil?
+        http = Net::HTTP.new(uri.hostname, uri.port)
+      else
+        http = Net::HTTP.new(uri.hostname, uri.port, @proxy.host,
+                             @proxy.port, @proxy.username, @proxy.password)
+      end
+
+      http.set_debug_output($stdout) if @debug
+
+      http
+    end
+
+    def self.create_query(smarty_request)
+      URI.encode_www_form(smarty_request.parameters)
+    end
+
+    def self.set_custom_headers(smarty_headers, request)
+      smarty_headers.each do |key, values|
+        if values.respond_to? :each
+          values.each do |value|
+            request.add_field(key, value)
+          end
+        else
+          request.add_field(key, values)
+        end
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/native_serializer.rb

@@ -0,0 +1,13 @@
+require 'json'
+
+module SmartyStreets
+  class NativeSerializer
+    def serialize(obj)
+      obj.to_json
+    end
+
+    def deserialize(payload)
+      JSON.load(payload)
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/proxy.rb

@@ -0,0 +1,16 @@
+module SmartyStreets
+  # Contains information about the proxy through which all requests will be sent.
+  #
+  # host should not include a scheme
+  class Proxy
+
+    attr_accessor :port, :host, :username, :password
+
+    def initialize(host, port, username = nil, password = nil)
+      @host = host
+      @port = port
+      @username = username
+      @password = password
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/request.rb

@@ -0,0 +1,14 @@
+module SmartyStreets
+  class Request
+    attr_accessor :parameters, :payload, :url_prefix, :referer, :headers, :content_type
+
+    def initialize
+      @parameters = {}
+      @payload = nil
+      @url_prefix = nil
+      @referer = nil
+      @headers = {}
+      @content_type = 'application/json'
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/response.rb

@@ -0,0 +1,11 @@
+module SmartyStreets
+  class Response
+    attr_accessor :payload, :status_code, :error
+
+    def initialize(payload, status_code, error = nil)
+      @payload = payload
+      @status_code = status_code
+      @error = error
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/retry_sender.rb

@@ -0,0 +1,39 @@
+module SmartyStreets
+  class RetrySender
+    MAX_BACKOFF_DURATION = 10
+    STATUS_INTERNAL_SERVER_ERROR = 500
+    STATUS_TOO_MANY_REQUESTS = 429
+
+    def initialize(max_retries, inner, sleeper, logger)
+      @max_retries = max_retries
+      @inner = inner
+      @sleeper = sleeper
+      @logger = logger
+    end
+
+    def send(request)
+      response = @inner.send(request)
+
+      (0..@max_retries-1).each do |i|
+        if response.status_code.to_i == STATUS_TOO_MANY_REQUESTS
+          backoff(5)
+        end
+        
+        break if response.status_code.to_i < STATUS_INTERNAL_SERVER_ERROR
+
+        backoff(i)
+
+        response = @inner.send(request)
+      end
+
+      response
+    end
+
+    def backoff(attempt)
+      backoff_duration = [attempt, MAX_BACKOFF_DURATION].min
+
+      @logger.log("There was an error processing the request. Retrying in #{backoff_duration} seconds...")
+      @sleeper.sleep(backoff_duration)
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/shared_credentials.rb

@@ -0,0 +1,13 @@
+module SmartyStreets
+  class SharedCredentials
+    def initialize(id, host_name)
+      @id = id
+      @host_name = host_name
+    end
+
+    def sign(request)
+      request.parameters['key'] = @id
+      request.referer = @host_name
+    end
+  end
+end