smartystreets_ruby_sdk 6.4.1 → 10.0.0

data/examples/us_zipcode_single_lookup_example.rb

@@ -1,5 +1,6 @@
 require '../lib/smartystreets_ruby_sdk/static_credentials'
 require '../lib/smartystreets_ruby_sdk/shared_credentials'
+require '../lib/smartystreets_ruby_sdk/basic_auth_credentials'
 require '../lib/smartystreets_ruby_sdk/client_builder'
 require '../lib/smartystreets_ruby_sdk/us_zipcode/lookup'
 
@@ -8,13 +9,13 @@ class UsZipcodeSingleLookupExample
     # key = 'Your SmartyStreets Auth Key here'
     # referer = 'Your host name here'
     # We recommend storing your secret keys in environment variables instead---it's safer!
-    key = ENV['SMARTY_AUTH_WEB']
-    referer = ENV['SMARTY_AUTH_REFERER']
-    credentials = SmartyStreets::SharedCredentials.new(key, referer)
+    # key = ENV['SMARTY_AUTH_WEB']
+    # referer = ENV['SMARTY_AUTH_REFERER']
+    # credentials = SmartyStreets::SharedCredentials.new(key, referer)
 
-    # id = ENV['SMARTY_AUTH_ID']
-    # token = ENV['SMARTY_AUTH_TOKEN']
-    # credentials = SmartyStreets::StaticCredentials.new(id, token)
+    id = ENV['SMARTY_AUTH_ID']
+    token = ENV['SMARTY_AUTH_TOKEN']
+    credentials = SmartyStreets::BasicAuthCredentials.new(id, token)
 
     client = SmartyStreets::ClientBuilder.new(credentials).build_us_zipcode_api_client
 

data/lib/smartystreets_ruby_sdk/basic_auth_credentials.rb

@@ -0,0 +1,14 @@
+module SmartyStreets
+  class BasicAuthCredentials
+    def initialize(auth_id, auth_token)
+      raise ArgumentError, 'credentials (auth id, auth token) required' if auth_id.nil? || auth_id.empty? || auth_token.nil? || auth_token.empty?
+
+      @auth_id = auth_id
+      @auth_token = auth_token
+    end
+
+    def sign(request)
+      request.basic_auth = [@auth_id, @auth_token]
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/client_builder.rb

@@ -17,6 +17,7 @@ require_relative 'international_street/client'
 require_relative 'international_autocomplete/client'
 require_relative 'us_reverse_geo/client'
 require_relative 'us_autocomplete_pro/client'
+require_relative 'us_autocomplete/client'
 require_relative 'us_enrichment/client'
 require_relative 'international_postal_code/client'
 
@@ -28,6 +29,7 @@ module SmartyStreets
     INTERNATIONAL_STREET_API_URL = 'https://international-street.api.smarty.com/verify'.freeze
     INTERNATIONAL_AUTOCOMPLETE_API_URL = "https://international-autocomplete.api.smarty.com/v2/lookup".freeze
     US_AUTOCOMPLETE_PRO_API_URL = 'https://us-autocomplete-pro.api.smarty.com/lookup'.freeze
+    US_AUTOCOMPLETE_API_URL = 'https://us-autocomplete.api.smarty.com/v2/lookup'.freeze
     US_EXTRACT_API_URL = 'https://us-extract.api.smarty.com/'.freeze
     US_STREET_API_URL = 'https://us-street.api.smarty.com/street-address'.freeze
     US_ZIP_CODE_API_URL = 'https://us-zipcode.api.smarty.com/lookup'.freeze
@@ -44,6 +46,7 @@ module SmartyStreets
       @url_prefix = nil
       @proxy = nil
       @header = nil
+      @append_headers = {}
       @licenses = %w()
       @debug = nil
       @queries = {}
@@ -65,7 +68,7 @@ module SmartyStreets
       self
     end
 
-    # Default is a series of nested senders. (See build_sender()
+    # Sets the innermost HTTP transport sender while keeping the full middleware chain intact.
     #
     # Returns self to accommodate method chaining.
     def with_sender(sender)
@@ -105,6 +108,18 @@ module SmartyStreets
     # Returns self to accommodate method chaining.
     def with_custom_headers(header)
       @header = header
+      @append_headers = {}
+      self
+    end
+
+    # Appends the provided value to the existing header value using the specified separator,
+    # rather than adding a separate header value. This is useful for single-value headers like User-Agent.
+    #
+    # Returns self to accommodate method chaining.
+    def with_appended_header(key, value, separator)
+      @header = {} if @header.nil?
+      @append_headers[key] = separator
+      @header[key] = (@header[key] || []).concat([value])
       self
     end
 
@@ -141,6 +156,12 @@ module SmartyStreets
       self
     end
 
+    # with_feature_iana_time_zone turns on the IANA timezone feature for the request.
+    def with_feature_iana_time_zone()
+      self.with_custom_comma_separated_query("features", "iana-timezone")
+      self
+    end
+
     # Enables debug mode, which will print information about the HTTP request and response to $stdout.
     #
     # Returns self to accommodate method chaining.
@@ -166,6 +187,11 @@ module SmartyStreets
       USAutocompletePro::Client.new(build_sender, @serializer)
     end
 
+    def build_us_autocomplete_api_client
+      ensure_url_prefix_not_null(US_AUTOCOMPLETE_API_URL)
+      USAutocomplete::Client.new(build_sender, @serializer)
+    end
+
     def build_us_extract_api_client
       ensure_url_prefix_not_null(US_EXTRACT_API_URL)
       USExtract::Client.new(build_sender, @serializer)
@@ -199,13 +225,18 @@ module SmartyStreets
     # </editor-fold>
 
     def build_sender
-      return @http_sender unless @http_sender.nil?
-
-      sender = NativeSender.new(@max_timeout, @proxy, @debug)
+      if @http_sender
+        conflicts = []
+        conflicts << 'with_max_timeout' if @max_timeout != 10
+        conflicts << 'with_proxy' if @proxy
+        conflicts << 'with_debug' if @debug
+        raise ArgumentError, "with_sender cannot be combined with: #{conflicts.join(', ')}. These options only apply to the built-in HTTP transport." unless conflicts.empty?
+      end
+      sender = @http_sender || NativeSender.new(@max_timeout, @proxy, @debug)
 
       sender = StatusCodeSender.new(sender)
 
-      sender = CustomHeaderSender.new(sender, @header) unless @header.nil?
+      sender = CustomHeaderSender.new(sender, @header, @append_headers) unless @header.nil?
 
       sender = SigningSender.new(@signer, sender) unless @signer.nil?
 

data/lib/smartystreets_ruby_sdk/custom_header_sender.rb

@@ -1,13 +1,27 @@
 module SmartyStreets
   class CustomHeaderSender
-    def initialize(inner, header)
+    def initialize(inner, header, append_headers = {})
       @inner = inner
       @header = header
+      @append_headers = append_headers || {}
     end
 
     def send(request)
-      request.header = @header
+      apply_headers.each { |key, value| request.header[key] = value }
       @inner.send(request)
     end
+
+    def apply_headers
+      result = {}
+      @header.each do |key, values|
+        if @append_headers.key?(key)
+          separator = @append_headers[key]
+          result[key] = values.respond_to?(:join) ? values.join(separator) : values.to_s
+        else
+          result[key] = values.dup
+        end
+      end
+      result
+    end
   end
 end

data/lib/smartystreets_ruby_sdk/errors.rb

@@ -1,28 +1,33 @@
 module SmartyStreets
-  NOT_MODIFIED = 'Not Modified: This data has not been modified since the last request. Please remove the etag header to fetch this data'.freeze
+  NOT_MODIFIED = 'Not Modified: The requested record has not been modified since the previous request' \
+                 ' with the Etag value.'.freeze
 
-  BAD_CREDENTIALS = 'Unauthorized: The credentials were provided incorrectly or did not match any existing,
- active credentials.'.freeze
+  BAD_CREDENTIALS = 'Unauthorized: The credentials were provided incorrectly or did not match any existing,' \
+                    ' active credentials.'.freeze
 
-  PAYMENT_REQUIRED = 'Payment Required: There is no active subscription
- for the account associated with the credentials submitted with the request.'.freeze
+  PAYMENT_REQUIRED = 'Payment Required: There is no active subscription for the account associated with the' \
+                     ' credentials submitted with the request.'.freeze
 
-  FORBIDDEN = 'Because the international service is currently in a limited release phase, only approved accounts' \
-            ' may access the service.'.freeze
+  FORBIDDEN = 'Forbidden: The request contained valid data and was understood by the server, but the server' \
+              ' is refusing action.'.freeze
+
+  REQUEST_TIMEOUT = 'Request timeout error.'.freeze
 
   REQUEST_ENTITY_TOO_LARGE = 'Request Entity Too Large: The request body has exceeded the maximum size.'.freeze
 
-  BAD_REQUEST = 'Bad Request (Malformed Payload): A GET request lacked a street field or the request body of a
- POST request contained malformed JSON, possibly because a value was submitted as a number rather than as a string.'.freeze
+  BAD_REQUEST = 'Bad Request (Malformed Payload): A GET request lacked a required field or the request body' \
+                ' of a POST request contained malformed JSON.'.freeze
 
   UNPROCESSABLE_ENTITY = 'GET request lacked required fields.'.freeze
 
-  TOO_MANY_REQUESTS = 'The rate limit has been exceeded.'.freeze
+  TOO_MANY_REQUESTS = 'Too Many Requests: The rate limit for your account has been exceeded.'.freeze
 
   INTERNAL_SERVER_ERROR = 'Internal Server Error.'.freeze
 
+  BAD_GATEWAY = 'Bad Gateway error.'.freeze
+
   SERVICE_UNAVAILABLE = 'Service Unavailable. Try again later.'.freeze
 
   GATEWAY_TIMEOUT = 'The upstream data provider did not respond in a timely fashion and the request failed. ' \
-                  'A serious, yet rare occurrence indeed.'.freeze
+                    'A serious, yet rare occurrence indeed.'.freeze
 end

data/lib/smartystreets_ruby_sdk/exceptions.rb

@@ -4,6 +4,12 @@ module SmartyStreets
   end
 
   class NotModifiedInfo < SmartyError
+    attr_reader :response_etag
+
+    def initialize(message = nil, response_etag = nil)
+      super(message)
+      @response_etag = response_etag
+    end
   end
 
   class BadCredentialsError < SmartyError
@@ -12,6 +18,12 @@ module SmartyStreets
   class ForbiddenError < SmartyError
   end
 
+  class RequestTimeoutError < SmartyError
+  end
+
+  class BadGatewayError < SmartyError
+  end
+
   class PaymentRequiredError < SmartyError
   end
 

data/lib/smartystreets_ruby_sdk/international_autocomplete/client.rb

@@ -39,6 +39,8 @@ module SmartyStreets
         add_parameter(request, 'search', lookup.search)
         add_parameter(request, 'country', lookup.country)
         add_parameter(request, 'max_results', lookup.max_results.to_s)
+        add_parameter(request, 'max_group_results', lookup.max_group_results.to_s)
+        add_parameter(request, 'geolocation', 'on') if lookup.geolocation
         add_parameter(request, 'include_only_locality', lookup.locality)
         add_parameter(request, 'include_only_postal_code', lookup.postal_code)
 

data/lib/smartystreets_ruby_sdk/international_autocomplete/lookup.rb

@@ -6,14 +6,16 @@ module SmartyStreets
     # of the lookup after it comes back from the API.
     class Lookup < JSONAble
 
-      attr_accessor :result, :search, :address_id, :country, :max_results, :locality, :postal_code, :custom_param_hash
+      attr_accessor :result, :search, :address_id, :country, :max_results, :max_group_results, :geolocation, :locality, :postal_code, :custom_param_hash
 
-      def initialize(search = nil, address_id = nil, country = nil, max_results = nil, locality = nil, postal_code = nil, custom_param_hash = nil)
+      def initialize(search = nil, address_id = nil, country = nil, max_results = nil, max_group_results = 100, geolocation = false, locality = nil, postal_code = nil, custom_param_hash = nil)
         @result = []
         @search = search
         @address_id = address_id
         @country = country
         @max_results = max_results
+        @max_group_results = max_group_results
+        @geolocation = geolocation
         @locality = locality
         @postal_code = postal_code
         @custom_param_hash = {}

data/lib/smartystreets_ruby_sdk/international_street/client.rb

@@ -1,5 +1,6 @@
 require_relative '../request'
 require_relative 'candidate'
+require_relative 'language_mode'
 
 module SmartyStreets
   module InternationalStreet
@@ -13,6 +14,7 @@ module SmartyStreets
       # Sends a Lookup object to the International Street API and stores the result in the Lookup's result field.
       # Deprecated, please use send_lookup instead.
       def send(lookup)
+        raise ArgumentError, 'lookup cannot be nil' if lookup.nil?
         lookup.ensure_enough_info
         request = build_request(lookup)
 
@@ -26,6 +28,7 @@ module SmartyStreets
 
       # Sends a Lookup object to the International Street API and stores the result in the Lookup's result field.
       def send_lookup(lookup)
+        raise ArgumentError, 'lookup cannot be nil' if lookup.nil?
         lookup.ensure_enough_info
         request = build_request(lookup)
 
@@ -43,7 +46,7 @@ module SmartyStreets
         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, 'language', normalized_language(lookup.language))
         add_parameter(request, 'freeform', lookup.freeform)
         add_parameter(request, 'address1', lookup.address1)
         add_parameter(request, 'address2', lookup.address2)
@@ -66,6 +69,12 @@ module SmartyStreets
         request.parameters[key] = value unless value.nil? or value.empty?
       end
 
+      def normalized_language(language)
+        return nil if language.nil?
+
+        LanguageMode.from_value(language).value
+      end
+
       def convert_candidates(raw_candidates)
         candidates = []
 

data/lib/smartystreets_ruby_sdk/international_street/components.rb

@@ -5,11 +5,12 @@ module SmartyStreets
       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, :administrative_area_iso2,:administrative_area_short, :administrative_area_long, :post_box,
+                  :administrative_area, :administrative_area_iso2, :attention, :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,
+                  :short_address_code, :sub_building_leading_type, :sub_building_block, :sub_building_door, :sub_building_staircase,
                   :super_administrative_area, :premise_extra, :dependent_thoroughfare_predirection,
                   :building_trailing_type, :thoroughfare_predirection, :building_name, :level_type, :level_number,
                   :country_iso_3, :sub_building_type, :additional_content, :delivery_installation, :delivery_installation_type,
@@ -20,8 +21,7 @@ module SmartyStreets
         @super_administrative_area = obj.fetch('super_administrative_area', nil)
         @administrative_area = obj.fetch('administrative_area', nil)
         @administrative_area_iso2 = obj.fetch('administrative_area_iso2', nil)
-        @administrative_area_short = obj.fetch('administrative_area_short', nil)
-        @administrative_area_long = obj.fetch('administrative_area_long', nil)
+        @attention = obj.fetch('attention', 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)
@@ -35,6 +35,11 @@ module SmartyStreets
         @premise_number = obj.fetch('premise_number', nil)
         @premise_prefix_number = obj.fetch('premise_prefix_number', nil)
         @premise_type = obj.fetch('premise_type', nil)
+        @short_address_code = obj.fetch('short_address_code', nil)
+        @sub_building_leading_type = obj.fetch('sub_building_leading_type', nil)
+        @sub_building_block = obj.fetch('sub_building_block', nil)
+        @sub_building_door = obj.fetch('sub_building_door', nil)
+        @sub_building_staircase = obj.fetch('sub_building_staircase', nil)
         @thoroughfare = obj.fetch('thoroughfare', nil)
         @thoroughfare_predirection = obj.fetch('thoroughfare_predirection', nil)
         @thoroughfare_postdirection = obj.fetch('thoroughfare_postdirection', nil)

data/lib/smartystreets_ruby_sdk/international_street/language_mode.rb

@@ -1,9 +1,26 @@
+require_relative '../exceptions'
+
 module SmartyStreets
   module InternationalStreet
-    module LanguageMode
-      NATIVE = 'native'.freeze
+    # A closed set of valid Language values, the closest Ruby equivalent to an enum: a fixed set of frozen
+    # instances rather than an arbitrary string.
+    class LanguageMode < Data.define(:value)
+      NATIVE = new('native')
+      LATIN = new('latin')
+
+      ALL = [NATIVE, LATIN].freeze
+
+      # Resolves a LanguageMode instance or a raw value (eg. from user input or config) into a LanguageMode,
+      # matching 'native'/'latin' regardless of case.
+      def self.from_value(value)
+        return value if value.is_a?(LanguageMode)
+
+        match = ALL.find { |mode| mode.value.casecmp?(value.to_s) }
+        raise SmartyStreets::UnprocessableEntityError,
+              "invalid Language value; must be unset, 'native', or 'latin' (case-insensitive)" if match.nil?
 
-      LATIN = 'latin'.freeze
+        match
+      end
     end
   end
 end

data/lib/smartystreets_ruby_sdk/international_street/lookup.rb

@@ -1,3 +1,5 @@
+require_relative 'language_mode'
+
 module SmartyStreets
   module InternationalStreet
     # In addition to holding all of the input data for this lookup, this class also will contain the
@@ -71,18 +73,9 @@ module SmartyStreets
       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
+        raise UnprocessableEntityError, 'Country field is required.' if field_is_missing(@country)
+        raise UnprocessableEntityError, 'Either freeform or address1 is required.' if field_is_missing(@freeform) && field_is_missing(@address1)
+        LanguageMode.from_value(@language) unless @language.nil?
       end
     end
   end

data/lib/smartystreets_ruby_sdk/international_street/rootlevel.rb

@@ -2,7 +2,7 @@ module SmartyStreets
   module InternationalStreet
     class RootLevel
       attr_reader :input_id, :organization, :address1, :address2, :address3, :address4, :address5, :address6, :address7,
-                  :address8, :address9, :address10, :address11, :address12
+                  :address8
 
       def initialize(obj)
         @input_id = obj.fetch('input_id', nil)
@@ -15,10 +15,6 @@ module SmartyStreets
         @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

data/lib/smartystreets_ruby_sdk/native_sender.rb

@@ -47,6 +47,7 @@ module SmartyStreets
       request.body = smarty_request.payload
       request['User-Agent'] = "smartystreets (sdk:ruby@#{SmartyStreets::VERSION})"
       request['Referer'] = smarty_request.referer unless smarty_request.referer.nil?
+      request.basic_auth(smarty_request.basic_auth[0], smarty_request.basic_auth[1]) unless smarty_request.basic_auth.nil?
       set_custom_headers(smarty_request.header, request)
       request
     end
@@ -80,10 +81,8 @@ module SmartyStreets
 
     def self.set_custom_headers(smarty_header, request)
       smarty_header.each do |key, values|
-        if values.respond_to? :each
-          values.each do |value|
-            request.add_field(key, value)
-          end
+        if values.respond_to?(:each)
+          values.each { |value| request.add_field(key, value) }
         else
           request.add_field(key, values)
         end

data/lib/smartystreets_ruby_sdk/native_serializer.rb

@@ -7,6 +7,7 @@ module SmartyStreets
     end
 
     def deserialize(payload)
+      return {} if payload.nil? || payload.empty?
       JSON.load(payload)
     end
   end

data/lib/smartystreets_ruby_sdk/request.rb

@@ -1,6 +1,6 @@
 module SmartyStreets
   class Request
-    attr_accessor :parameters, :payload, :url_components, :url_prefix, :referer, :header, :content_type
+    attr_accessor :parameters, :payload, :url_components, :url_prefix, :referer, :header, :content_type, :basic_auth
 
     def initialize
       @parameters = {}
@@ -10,6 +10,7 @@ module SmartyStreets
       @referer = nil
       @header = {}
       @content_type = 'application/json'
+      @basic_auth = nil
     end
   end
 end

data/lib/smartystreets_ruby_sdk/response.rb

@@ -8,5 +8,18 @@ module SmartyStreets
       @header = header
       @error = error
     end
+
+    # Case-insensitive lookup that works on both plain Hash (used by mocks)
+    # and Net::HTTPResponse (returned by the live HTTP transport, which
+    # exposes each_header but not each_pair).
+    def find_header(name)
+      return nil if @header.nil?
+      target = name.to_s.downcase
+      iterator = @header.respond_to?(:each_header) ? :each_header : :each_pair
+      @header.send(iterator) do |k, v|
+        return v if k.to_s.downcase == target
+      end
+      nil
+    end
   end
 end

data/lib/smartystreets_ruby_sdk/retry_sender.rb

@@ -1,8 +1,12 @@
+require 'net/http'
+require 'timeout'
+
 module SmartyStreets
   class RetrySender
     MAX_BACKOFF_DURATION = 10
     STATUS_TOO_MANY_REQUESTS = 429
     STATUS_TO_RETRY = [408, 429, 500, 502, 503, 504]
+    TIMEOUT_ERRORS = [Net::OpenTimeout, Net::ReadTimeout, Timeout::Error, Errno::ETIMEDOUT]
 
     def initialize(max_retries, inner, sleeper, logger)
       @max_retries = max_retries
@@ -16,29 +20,44 @@ module SmartyStreets
 
       (1..@max_retries).each do |i|
 
-        break if STATUS_TO_RETRY.include?(response.status_code.to_i) == false
-
-        if response.status_code.to_i == STATUS_TOO_MANY_REQUESTS
-          seconds_to_backoff = 10
-          if response.header.nil? == false
-            if Integer(response.header["Retry-After"], exception: false)
-              seconds_to_backoff = response.header["Retry-After"].to_i
+        if timeout_error?(response.error)
+          timeout_backoff(i, response.error)
+          response = @inner.send(request)
+        elsif !STATUS_TO_RETRY.include?(response.status_code.to_i)
+          break
+        else
+          if response.status_code.to_i == STATUS_TOO_MANY_REQUESTS
+            seconds_to_backoff = 10
+            unless response.header.nil?
+              if Integer(response.header["Retry-After"], exception: false)
+                seconds_to_backoff = response.header["Retry-After"].to_i
+              end
             end
+            rate_limit_backoff(seconds_to_backoff)
+          else
+            backoff(i)
           end
-          rate_limit_backoff(seconds_to_backoff)
-        else
-          backoff(i)
+          response = @inner.send(request)
         end
-        response = @inner.send(request)
       end
 
       response
     end
 
-    def backoff(attempt)
+    def timeout_error?(error)
+      return false if error.nil?
+
+      TIMEOUT_ERRORS.any? { |klass| error.is_a?(klass) }
+    end
+
+    def timeout_backoff(attempt, error)
+      backoff(attempt, "Timeout error (#{error.class}).")
+    end
+
+    def backoff(attempt, message = 'There was an error processing the request.')
       backoff_duration = [attempt, MAX_BACKOFF_DURATION].min
 
-      @logger.log("There was an error processing the request. Retrying in #{backoff_duration} seconds...")
+      @logger.log("#{message} Retrying in #{backoff_duration} seconds...")
       @sleeper.sleep(backoff_duration)
     end
 

data/lib/smartystreets_ruby_sdk/status_code_sender.rb

@@ -1,3 +1,4 @@
+require 'json'
 require_relative 'exceptions'
 require_relative 'errors'
 
@@ -18,43 +19,59 @@ module SmartyStreets
       response
     end
 
+    private
+
     def parse_rate_limit_response(response)
-      error_message = ""
-      if !response.payload.nil?
-        response_json = JSON.parse(response.payload)
-        response_json["errors"].each do |error|
-          error_message += (" " + error["message"])
+      TooManyRequestsError.new(from_message(response, TOO_MANY_REQUESTS))
+    end
+
+    def from_message(response, fallback)
+      body = response.payload.nil? ? '' : response.payload.to_s.strip
+      unless body.empty?
+        begin
+          errors = JSON.parse(response.payload)["errors"]
+        rescue JSON::ParserError, TypeError
+          errors = nil
+        end
+        unless errors.nil? || errors.empty?
+          message = errors.map { |error| error["message"] }.join(" ")
+          return message unless message.empty?
         end
-        error_message.strip!
-      end
-      if error_message == ""
-        error_message = TOO_MANY_REQUESTS
       end
-      TooManyRequestsError.new(error_message)
+
+      "#{fallback} Body: #{body}".strip
     end
 
     def assign_exception(response)
-      response.error = case response.status_code
-                         when '304'          
-                           NotModifiedInfo.new(NOT_MODIFIED)
+      response.error = case response.status_code.to_s
+                         when '200', '304'
+                           nil
                          when '401'
-                           BadCredentialsError.new(BAD_CREDENTIALS)
+                           BadCredentialsError.new(from_message(response, BAD_CREDENTIALS))
                          when '402'
-                           PaymentRequiredError.new(PAYMENT_REQUIRED)
+                           PaymentRequiredError.new(from_message(response, PAYMENT_REQUIRED))
+                         when '403'
+                           ForbiddenError.new(from_message(response, FORBIDDEN))
+                         when '408'
+                           RequestTimeoutError.new(from_message(response, REQUEST_TIMEOUT))
                          when '413'
-                           RequestEntityTooLargeError.new(REQUEST_ENTITY_TOO_LARGE)
+                           RequestEntityTooLargeError.new(from_message(response, REQUEST_ENTITY_TOO_LARGE))
                          when '400'
-                           BadRequestError.new(BAD_REQUEST)
+                           BadRequestError.new(from_message(response, BAD_REQUEST))
                          when '422'
-                           UnprocessableEntityError.new(UNPROCESSABLE_ENTITY)
+                           UnprocessableEntityError.new(from_message(response, UNPROCESSABLE_ENTITY))
                          when '429'
-                           TooManyRequestsError.new(TOO_MANY_REQUESTS)
+                           TooManyRequestsError.new(from_message(response, TOO_MANY_REQUESTS))
                          when '500'
-                           InternalServerError.new(INTERNAL_SERVER_ERROR)
+                           InternalServerError.new(from_message(response, INTERNAL_SERVER_ERROR))
+                         when '502'
+                           BadGatewayError.new(from_message(response, BAD_GATEWAY))
                          when '503'
-                           ServiceUnavailableError.new(SERVICE_UNAVAILABLE)
+                           ServiceUnavailableError.new(from_message(response, SERVICE_UNAVAILABLE))
+                         when '504'
+                           GatewayTimeoutError.new(from_message(response, GATEWAY_TIMEOUT))
                          else
-                           nil
+                           SmartyError.new(from_message(response, "The server returned an unexpected HTTP status code: #{response.status_code}"))
                        end
     end
   end