smartystreets_ruby_sdk 5.14.13 → 5.14.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42a215aa8d810dbd85f5739ae7a73dbd0ead4a253627d8bfeb36d017e36ca716
-  data.tar.gz: 3be273085fc4466f96c0376e9d101d5dc2464210aa3a092c00e0f4ddade0fb12
+  metadata.gz: 1edcb3f9748038e66ecee27cea05ddabaf8ba620a31d1868d8ea4d646f490011
+  data.tar.gz: a8581fb18d074bd4015b54d97f4a85739e76551eb0ea1b2a639b57bf3fad4095
 SHA512:
-  metadata.gz: 318e5a6802ffa480c4a83887637a0e64c41e3481d5cfd28799de3d455f68369f2733c9fad6afa9b1e95974524da273daf688d54f124062d8ea9e634b80ad0bda
-  data.tar.gz: f719f070faf89dfe73c4e248f19cdb71c769ecdd88e2e5bd2ddf0ec9cfcd4f35f66630fe763b05e6903b7a76af5932302ed41ff29dcbceac46d43dc0f513d00a
+  metadata.gz: 3c3e96df14a5ed1c0834fe4e664637bac9edced38b9e65c01d920e0653469b968092dab7648a6fc4d3d745980239cea37047193d95da80f1efa898e9eff76057
+  data.tar.gz: 74b31b8f16737035405eef5c3d8ca114b6d27c90ff255550cac8ecc73b87e2247e727f1f03a591a1c08f1cce74f7a3ba96def607c2e17f2ba3c3b425e1949b9f

data/.github/workflows/gem-publish.yml

@@ -13,7 +13,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         with:
-          fetch-depth: 0 # need all the commits
+          fetch-depth: 0
       
       - uses: ruby/setup-ruby@v1
         with:
@@ -40,10 +40,8 @@ jobs:
 
       - name: Grab Version
         run: |
-          echo "Module SmartyStreets
-          VERSION = '${{ env.RELEASE_VERSION }}' 
-          end" >> version.rb \
-          && cat version.rb \
+          sed -i "s/0\.0\.0/${{ env.RELEASE_VERSION }}/g" lib/smartystreets_ruby_sdk/version.rb \
+          && cat lib/smartystreets_ruby_sdk/version.rb \
           && gem build *.gemspec \
           && git checkout lib/smartystreets_ruby_sdk/version.rb
 
@@ -54,6 +52,5 @@ jobs:
           chmod 0600 $HOME/.gem/credentials
           printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
           gem push *.gem
-#          chmod 0600 /root/.gem/credentials
         env:
           GEM_HOST_API_KEY: "${{secrets.GEM_HOST_API_KEY}}"

data/examples/us_street_single_address_example.rb

@@ -1,6 +1,7 @@
 require 'smartystreets_ruby_sdk/static_credentials'
 require 'smartystreets_ruby_sdk/client_builder'
 require 'smartystreets_ruby_sdk/us_street/lookup'
+require 'smartystreets_ruby_sdk/us_street/match_type'
 
 class USStreetSingleAddressExample
   def run
@@ -16,9 +17,11 @@ class USStreetSingleAddressExample
     # The appropriate license values to be used for your subscriptions
     # can be found on the Subscriptions page of the account dashboard.
     # https://www.smartystreets.com/docs/cloud/licensing
-    client = SmartyStreets::ClientBuilder.new(credentials).with_licenses(['us-core-cloud'])
-        # with_proxy('localhost', 8080, 'proxyUser', 'proxyPassword'). # Uncomment this line to try it with a proxy
-        build_us_street_api_client
+    #
+    # To try with a proxy, add this method call after with_licences
+    #   with_proxy('localhost', 8080, 'proxyUser', 'proxyPassword')
+    client = SmartyStreets::ClientBuilder.new(credentials).with_licenses(['us-core-cloud']).
+             build_us_street_api_client
 
     # Documentation for input fields can be found at:
     # https://smartystreets.com/docs/cloud/us-street-api
@@ -34,7 +37,8 @@ class USStreetSingleAddressExample
     lookup.state = 'CA'
     lookup.zipcode = '21229'
     lookup.candidates = 3
-    lookup.match = Lookup.INVALID # "invalid" is the most permissive match,
+    lookup.match = SmartyStreets::USStreet::MatchType::INVALID
+                                    # "invalid" is the most permissive match,
                                     # this will always return at least one result even if the address is invalid.
                                     # Refer to the documentation for additional Match Strategy options.
 
@@ -64,4 +68,4 @@ class USStreetSingleAddressExample
 end
 
 example = USStreetSingleAddressExample.new
-example.run
+example.run

data/lib/smartystreets_ruby_sdk/client_builder.rb

@@ -39,7 +39,7 @@ module SmartyStreets
       @max_timeout = 10
       @url_prefix = nil
       @proxy = nil
-      @headers = nil
+      @header = nil
       @licenses = %w()
       @debug = nil
     end
@@ -98,8 +98,8 @@ module SmartyStreets
     # headers is a Hash object.
     #
     # Returns self to accommodate method chaining.
-    def with_custom_headers(headers)
-      @headers = headers
+    def with_custom_headers(header)
+      @header = header
       self
     end
 
@@ -170,7 +170,7 @@ module SmartyStreets
 
       sender = StatusCodeSender.new(sender)
 
-      sender = CustomHeaderSender.new(sender, @headers) unless @headers.nil?
+      sender = CustomHeaderSender.new(sender, @header) unless @header.nil?
 
       sender = SigningSender.new(@signer, sender) unless @signer.nil?
 

data/lib/smartystreets_ruby_sdk/custom_header_sender.rb

@@ -1,12 +1,12 @@
 module SmartyStreets
   class CustomHeaderSender
-    def initialize(inner, headers)
+    def initialize(inner, header)
       @inner = inner
-      @headers = headers
+      @header = header
     end
 
     def send(request)
-      request.headers = @headers
+      request.header = @header
       @inner.send(request)
     end
   end

data/lib/smartystreets_ruby_sdk/errors.rb

@@ -15,8 +15,7 @@ module SmartyStreets
 
   UNPROCESSABLE_ENTITY = 'GET request lacked required fields.'.freeze
 
-  TOO_MANY_REQUESTS = 'When using public "website key" authentication,
-we restrict the number of requests coming from a given source over too short of a time.'.freeze
+  TOO_MANY_REQUESTS = 'The rate limit has been exceeded.'.freeze
 
   INTERNAL_SERVER_ERROR = 'Internal Server Error.'.freeze
 

data/lib/smartystreets_ruby_sdk/native_sender.rb

@@ -24,7 +24,11 @@ module SmartyStreets
 
         http.finish if http.started?
       rescue StandardError => err
-        return Response.new(nil, nil, err)
+        if response.nil?
+          return Response.new(nil, nil, nil, err)
+        else
+          return Response.new(nil, nil, response.header, err)
+        end
       end
 
       build_smarty_response(response)
@@ -43,12 +47,16 @@ 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?
-      set_custom_headers(smarty_request.headers, request)
+      set_custom_headers(smarty_request.header, request)
       request
     end
 
     def build_smarty_response(native_response)
-      Response.new(native_response.body, native_response.code)
+      if native_response.header.nil?
+        Response.new(native_response.body, native_response.code)
+      else
+        Response.new(native_response.body, native_response.code, native_response.header)
+      end
     end
 
     def build_http(request)
@@ -70,8 +78,8 @@ module SmartyStreets
       URI.encode_www_form(smarty_request.parameters)
     end
 
-    def self.set_custom_headers(smarty_headers, request)
-      smarty_headers.each do |key, values|
+    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)

data/lib/smartystreets_ruby_sdk/request.rb

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

data/lib/smartystreets_ruby_sdk/response.rb

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

data/lib/smartystreets_ruby_sdk/retry_sender.rb

@@ -1,8 +1,8 @@
 module SmartyStreets
   class RetrySender
     MAX_BACKOFF_DURATION = 10
-    STATUS_INTERNAL_SERVER_ERROR = 500
     STATUS_TOO_MANY_REQUESTS = 429
+    STATUS_TO_RETRY = [408, 429, 500, 502, 503, 504]
 
     def initialize(max_retries, inner, sleeper, logger)
       @max_retries = max_retries
@@ -15,14 +15,20 @@ module SmartyStreets
       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)
+        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
+            end
+          end
+          rate_limit_backoff(seconds_to_backoff)
+        else
+          backoff(i)
+        end
         response = @inner.send(request)
       end
 
@@ -35,5 +41,10 @@ module SmartyStreets
       @logger.log("There was an error processing the request. Retrying in #{backoff_duration} seconds...")
       @sleeper.sleep(backoff_duration)
     end
+
+    def rate_limit_backoff(backoff_duration)
+      @logger.log("Rate limit reached. Retrying in #{backoff_duration} seconds...")
+      @sleeper.sleep(backoff_duration)
+    end
   end
 end

data/lib/smartystreets_ruby_sdk/status_code_sender.rb

@@ -10,11 +10,29 @@ module SmartyStreets
     def send(request)
       response = @inner.send(request)
 
+      if response.status_code == '429'
+        response.error = parse_rate_limit_response(response)
+      end
       assign_exception(response) if response.error == nil
 
       response
     end
 
+    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"])
+        end
+        error_message.strip!
+      end
+      if error_message == ""
+        error_message = TOO_MANY_REQUESTS
+      end
+      TooManyRequestsError.new(error_message)
+    end
+
     def assign_exception(response)
       response.error = case response.status_code
                          when '401'

data/lib/smartystreets_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreets
-  VERSION = '5.14.13' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '5.14.14' # DO NOT EDIT (this is updated by a build job when a new release is published)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartystreets_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 5.14.13
+  version: 5.14.14
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-09 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler