smartystreets_ruby_sdk 8.1.1 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efc93c57b151ba68bae6b932c750aa6dd99c152d8461777be6de4e99bc3c92ab
-  data.tar.gz: 2109c0a80c243df5141d2569c4d48f19f854cca030a8a5be771fd2128b9aeff4
+  metadata.gz: 1f80a7994c3b9e2b9c0936875503a6fe6751db574e64861014ead029f5e1079e
+  data.tar.gz: d488f5c6698c089bc147d562793d67e5478b70c23da9d76e8607fe03111b0a93
 SHA512:
-  metadata.gz: 23260f7cf247a188e01fb3dca36a0644c8019fb2a72968d2545825cd27044c4785e98722f259415bdf9ef720b0d2a7a9099482a185585bb2c4bd0c92cf789e62
-  data.tar.gz: 794bc979c32379a448b2330451438c92239e63706cb3a15ddaab0f2738c85736611ca6cd85f583545922c4268aeb22371e8fa7a6944cb161f98db5c425335dfd
+  metadata.gz: 739c0edcc1fc7e0a6d4cff83ec12adb0f2f146518e211fe981988d2d4dc18921c16866e911de63612df5e3638a72835bdf6f74a69a8b218c459211941a257c3b
+  data.tar.gz: 1f8de619ff3655c99a97d7acb5a3c95d892451c7aab832dd8e0cc88c32ecb12a8b1d6e8237cb3f9032ca7fee8573c43cbdcf805313f10b3c67de8fab42317484

data/.github/workflows/ci.yml

@@ -0,0 +1,10 @@
+name: Ruby Tests
+
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  test:
+    uses: ./.github/workflows/test.yml

data/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Ruby Gem Publish
+
+on:
+  push:
+    tags:
+      - '**'
+
+jobs:
+  test:
+    uses: ./.github/workflows/test.yml
+
+  publish:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: false
+
+      - name: Publish
+        run: |
+          VERSION=${GITHUB_REF#refs/*/} make publish
+        env:
+          API_KEY: "${{ secrets.GEM_HOST_API_KEY }}"

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Ruby Tests (reusable)
+
+on:
+  workflow_call:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.3', '3.4', '4.0']
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: false
+      - name: Install dependencies
+        run: make dependencies
+      - name: Test
+        run: make test

data/CLAUDE.md

@@ -25,7 +25,7 @@ make examples
 
 ## Architecture
 
-This is the official SmartyStreets Ruby SDK for address verification APIs. It uses pure Ruby with Net::HTTP (no external runtime dependencies).
+This is the official SmartyStreets Ruby SDK for address verification APIs. It uses pure Ruby with Net::HTTP (no external runtime dependencies). Compatible with Ruby 3.3 and later.
 
 ### Core Design Patterns
 

data/Makefile

@@ -12,7 +12,7 @@ test:
 dependencies:
 	gem install minitest
 
-package: clean dependencies test
+package: clean dependencies
 	sed -i "s/0\.0\.0/${VERSION}/g" "$(VERSION_FILE)" \
 	&& gem build *.gemspec \
 	&& git checkout "$(VERSION_FILE)"
@@ -37,7 +37,7 @@ us_autocomplete_pro_api:
 	cd examples && ruby us_autocomplete_pro_example.rb
 
 us_enrichment_api:
-	cd examples && ruby us_enrichment_example.rb && ruby us_enrichment_business_example.rb && ruby us_enrichment_etag_example.rb
+	cd examples && ruby us_enrichment_example.rb && ruby us_enrichment_business_example.rb && ruby us_enrichment_etag_example.rb && ruby us_enrichment_business_name_search_example.rb
 
 us_extract_api:
 	cd examples && ruby us_extract_example.rb
@@ -46,11 +46,14 @@ us_reverse_geo_api:
 	cd examples && ruby us_reverse_geo_example.rb
 
 us_street_api:
-	cd examples && ruby us_street_single_address_example.rb && ruby us_street_multiple_address_example.rb && ruby us_street_component_analysis_example.rb && ruby us_street_iana_timezone_example.rb
+	cd examples && ruby us_street_single_address_example.rb && ruby us_street_multiple_address_example.rb && ruby us_street_component_analysis_example.rb && ruby us_street_iana_timezone_example.rb && ruby us_street_match_strategy_example.rb
+
+us_street_match_strategy_api:
+	cd examples && ruby us_street_match_strategy_example.rb
 
 us_zipcode_api:
 	cd examples && ruby us_zipcode_single_lookup_example.rb && ruby us_zipcode_multiple_lookup_example.rb
 
 examples: international_autocomplete_api international_postal_code_api international_street_api us_autocomplete_pro_api us_enrichment_api us_extract_api us_reverse_geo_api us_street_api us_zipcode_api
 
-.PHONY: clean test dependencies package publish international_autocomplete_api international_postal_code_api international_street_api us_autocomplete_pro_api us_enrichment_api us_extract_api us_reverse_geo_api us_street_api us_zipcode_api examples
+.PHONY: clean test dependencies package publish international_autocomplete_api international_postal_code_api international_street_api us_autocomplete_pro_api us_enrichment_api us_extract_api us_reverse_geo_api us_street_api us_street_match_strategy_api us_zipcode_api examples

data/README.md

@@ -4,6 +4,8 @@
 
 The official client libraries for accessing SmartyStreets APIs from Ruby
 
+Compatible with Ruby 3.3 and later.
+
 You may have noticed this page is curiously sparse. Don't panic, there's [documentation](https://smartystreets.com/docs/sdk/ruby) and [examples](examples).
 
 [Apache 2.0 License](LICENSE.txt)

data/examples/us_autocomplete_pro_example.rb

@@ -3,9 +3,11 @@ require '../lib/smartystreets_ruby_sdk/static_credentials'
 require '../lib/smartystreets_ruby_sdk/basic_auth_credentials'
 require '../lib/smartystreets_ruby_sdk/client_builder'
 require '../lib/smartystreets_ruby_sdk/us_autocomplete_pro/lookup'
+require '../lib/smartystreets_ruby_sdk/us_autocomplete_pro/source_type'
 
 class USAutocompleteProExample
   Lookup = SmartyStreets::USAutocompletePro::Lookup
+  SourceType = SmartyStreets::USAutocompletePro::SourceType
 
   def run
     # key = 'Your SmartyStreets Auth Key here'
@@ -29,7 +31,7 @@ class USAutocompleteProExample
     lookup.add_city_filter('Orem,UT')
     lookup.max_results = 5
     lookup.prefer_ratio = 3
-    lookup.source = "all"
+    lookup.source = SourceType::ALL
 
     # lookup.add_custom_parameter('parameter', 'value')
 

data/examples/us_enrichment_business_name_search_example.rb

@@ -0,0 +1,76 @@
+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_enrichment/lookup'
+
+class USEnrichmentBusinessNameSearchExample
+  def run
+    id = ENV['SMARTY_AUTH_ID']
+    token = ENV['SMARTY_AUTH_TOKEN']
+    credentials = SmartyStreets::BasicAuthCredentials.new(id, token)
+
+    client = SmartyStreets::ClientBuilder.new(credentials).build_us_enrichment_api_client
+
+    business_name = "delta air"
+
+    lookup = SmartyStreets::USEnrichment::Lookup.new
+    lookup.business_name = business_name
+    lookup.city = "atlanta"
+
+    begin
+      summary_results = client.send_business_lookup(lookup)
+    rescue SmartyStreets::SmartyError => err
+      puts err
+      return
+    end
+
+    if summary_results.nil? || summary_results.empty?
+      puts "No response returned for business-name search"
+      return
+    end
+
+    summary = summary_results[0]
+    if summary.businesses.nil? || summary.businesses.empty?
+      puts "No businesses found for this business name search"
+      return
+    end
+
+    puts "Summary results for BusinessName: #{business_name}"
+    summary.businesses.each do |biz|
+      puts "  - #{biz.company_name} (ID: #{biz.business_id})"
+    end
+
+    first = summary.businesses[0]
+    puts
+    puts "Fetching details for business: #{first.company_name} (ID: #{first.business_id})"
+
+    begin
+      detail_result = client.send_business_detail_lookup(first.business_id)
+    rescue SmartyStreets::SmartyError => err
+      puts err
+      return
+    end
+
+    if detail_result.nil?
+      puts "No detail result returned"
+      return
+    end
+
+    puts
+    puts "Detail result:"
+    puts "  smarty_key: #{detail_result.smarty_key}"
+    puts "  data_set_name: #{detail_result.data_set_name}"
+    puts "  business_id: #{detail_result.business_id}"
+    attrs = detail_result.attributes
+    return if attrs.nil?
+    attrs.instance_variables.each do |var|
+      value = attrs.instance_variable_get(var)
+      next if value.nil?
+      puts "  #{var.to_s.delete('@')}: #{value}"
+    end
+  end
+end
+
+example = USEnrichmentBusinessNameSearchExample.new
+example.run

data/examples/us_enrichment_etag_example.rb

@@ -40,10 +40,12 @@ class USEnrichmentEtagExample
     second = SmartyStreets::USEnrichment::Lookup.new(smarty_key, 'business')
     second.request_etag = captured_etag
     begin
-      @client.send_business_lookup(second)
-      puts "  Call 2 (matching Etag): 200 - server did NOT honor the conditional. Etag=#{display(second.response_etag)}"
-    rescue SmartyStreets::NotModifiedInfo => ex
-      puts "  Call 2 (matching Etag): 304 NotModifiedInfo - caller treats this as cache-valid. Refreshed Etag=#{display(ex.response_etag)}"
+      results = @client.send_business_lookup(second)
+      if results.empty?
+        puts "  Call 2 (matching Etag): 304 not modified - cache is still valid. Refreshed Etag=#{display(second.response_etag)}"
+      else
+        puts "  Call 2 (matching Etag): 200 - server did NOT honor the conditional. Etag=#{display(second.response_etag)}"
+      end
     rescue SmartyStreets::SmartyError => err
       puts "  Call 2 unexpected failure: #{err.class}: #{err.message}"
       return nil
@@ -52,10 +54,12 @@ class USEnrichmentEtagExample
     third = SmartyStreets::USEnrichment::Lookup.new(smarty_key, 'business')
     third.request_etag = captured_etag + "X"
     begin
-      @client.send_business_lookup(third)
-      puts "  Call 3 (mutated Etag): 200 as expected. Etag=#{display(third.response_etag)}"
-    rescue SmartyStreets::NotModifiedInfo
-      puts "  Call 3 (mutated Etag): 304 - UNEXPECTED. Server treated a different Etag as matching."
+      results = @client.send_business_lookup(third)
+      if results.empty?
+        puts "  Call 3 (mutated Etag): 304 - UNEXPECTED. Server treated a different Etag as matching."
+      else
+        puts "  Call 3 (mutated Etag): 200 as expected. Etag=#{display(third.response_etag)}"
+      end
     rescue SmartyStreets::SmartyError => err
       puts "  Call 3 unexpected failure: #{err.class}: #{err.message}"
     end
@@ -86,9 +90,11 @@ class USEnrichmentEtagExample
     second.request_etag = captured_etag
     begin
       @client.send_business_detail_lookup(second)
-      puts "  Call 2 (matching Etag): 200 - server did NOT honor the conditional. Etag=#{display(second.response_etag)}"
-    rescue SmartyStreets::NotModifiedInfo => ex
-      puts "  Call 2 (matching Etag): 304 NotModifiedInfo - caller treats this as cache-valid. Refreshed Etag=#{display(ex.response_etag)}"
+      if second.result.nil?
+        puts "  Call 2 (matching Etag): 304 not modified - cache is still valid. Refreshed Etag=#{display(second.response_etag)}"
+      else
+        puts "  Call 2 (matching Etag): 200 - server did NOT honor the conditional. Etag=#{display(second.response_etag)}"
+      end
     rescue SmartyStreets::SmartyError => err
       puts "  Call 2 unexpected failure: #{err.class}: #{err.message}"
       return
@@ -98,9 +104,11 @@ class USEnrichmentEtagExample
     third.request_etag = captured_etag + "X"
     begin
       @client.send_business_detail_lookup(third)
-      puts "  Call 3 (mutated Etag): 200 as expected. Etag=#{display(third.response_etag)}"
-    rescue SmartyStreets::NotModifiedInfo
-      puts "  Call 3 (mutated Etag): 304 - UNEXPECTED. Server treated a different Etag as matching."
+      if third.result.nil?
+        puts "  Call 3 (mutated Etag): 304 - UNEXPECTED. Server treated a different Etag as matching."
+      else
+        puts "  Call 3 (mutated Etag): 200 as expected. Etag=#{display(third.response_etag)}"
+      end
     rescue SmartyStreets::SmartyError => err
       puts "  Call 3 unexpected failure: #{err.class}: #{err.message}"
     end

data/examples/us_enrichment_example.rb

@@ -154,7 +154,7 @@ class USEnrichmentAddressExample
   end
 
   def one_liner(obj)
-    obj.instance_variables.filter_map do |var|
+    obj.instance_variables.filter do |var|
       value = obj.instance_variable_get(var)
       "#{var.to_s.delete('@')}=#{value}" unless value.nil?
     end.join(' ')

data/examples/us_reverse_geo_example.rb

@@ -3,9 +3,11 @@ 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_reverse_geo/lookup'
+require '../lib/smartystreets_ruby_sdk/us_reverse_geo/source_type'
 
 class USReverseGeoExample
   Lookup = SmartyStreets::USReverseGeo::Lookup
+  SourceType = SmartyStreets::USReverseGeo::SourceType
 
   def run
     # key = 'Your SmartyStreets Auth Key here'
@@ -25,6 +27,7 @@ class USReverseGeoExample
     # https://smartystreets.com/docs/cloud/us-reverse-geo-api#http-request-input-fields
 
     lookup = Lookup.new(40.111111, -111.111111)
+    lookup.source = SourceType::ALL
 
     # lookup.add_custom_parameter('parameter', 'value')
 

data/examples/us_street_match_strategy_example.rb

@@ -0,0 +1,85 @@
+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/batch'
+require '../lib/smartystreets_ruby_sdk/us_street/lookup'
+require '../lib/smartystreets_ruby_sdk/us_street/match_type'
+
+class USStreetLookupsWithMatchStrategyExample
+  Lookup = SmartyStreets::USStreet::Lookup
+  MatchType = SmartyStreets::USStreet::MatchType
+
+  def run
+    # We recommend storing your secret keys in environment variables instead---it's safer!
+    id = ENV['SMARTY_AUTH_ID']
+    token = ENV['SMARTY_AUTH_TOKEN']
+    credentials = SmartyStreets::BasicAuthCredentials.new(id, token)
+    client = SmartyStreets::ClientBuilder.new(credentials).build_us_street_api_client
+
+    # Each address is run through all three match strategies so you can compare how
+    # 'strict', 'enhanced', and 'invalid' each handle a valid, an invalid, and an
+    # ambiguous address.
+    #   - strict:   only returns candidates that are valid, mailable addresses.
+    #   - enhanced: returns a more comprehensive dataset (requires a US Core or Rooftop license).
+    #   - invalid:  most permissive; always returns at least one candidate (a best-guess standardization).
+    # Documentation for input fields: https://smartystreets.com/docs/cloud/us-street-api
+    addresses = [
+      ['valid (real, deliverable)',    '1600 Amphitheatre Pkwy', 'Mountain View', 'CA', '94043'],
+      ['invalid (no such address)',    '9999 W 1150 S',          'Provo',         'UT', '84601'],
+      ['ambiguous (missing ZIP/unit)', '1 Rosedale St',          'Baltimore',     'MD', '']
+    ]
+    strategies = [MatchType::STRICT, MatchType::ENHANCED, MatchType::INVALID]
+
+    batch = SmartyStreets::Batch.new
+    cases = [] # parallel metadata for each lookup, in the order they are added to the batch
+
+    addresses.each do |label, street, city, state, zipcode|
+      strategies.each do |strategy|
+        lookup = Lookup.new
+        lookup.street = street
+        lookup.city = city
+        lookup.state = state
+        lookup.zipcode = zipcode
+        lookup.match = strategy
+        lookup.candidates = 10 # allow ambiguous addresses to return more than one match
+        batch.add(lookup)
+        cases << [label, "#{street}, #{city}, #{state}", strategy]
+      end
+    end
+
+    begin
+      client.send_batch(batch)
+    rescue SmartyStreets::SmartyError => err
+      puts err
+      return
+    end
+
+    last_address = nil
+    batch.each_with_index do |lookup, i|
+      label, address_display, strategy = cases[i]
+
+      unless address_display == last_address
+        puts "\n" + ('=' * 70)
+        puts " Address: #{address_display}  [#{label}]"
+        puts('=' * 70)
+        last_address = address_display
+      end
+
+      candidates = lookup.result
+      puts "\n--- '#{strategy}' strategy ---"
+
+      if candidates.empty?
+        puts '  0 candidates - no match returned under this strategy.'
+        next
+      end
+
+      puts "  #{candidates.length} candidate(s):"
+      candidates.each do |candidate|
+        puts "    [#{candidate.candidate_index}] #{candidate.delivery_line_1}  #{candidate.last_line}"
+      end
+    end
+  end
+end
+
+USStreetLookupsWithMatchStrategyExample.new.run

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

@@ -18,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_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/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_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/status_code_sender.rb

@@ -22,38 +22,38 @@ module SmartyStreets
     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"])
-        end
-        error_message.strip!
-      end
-      if error_message == ""
-        error_message = TOO_MANY_REQUESTS
-      end
-      TooManyRequestsError.new(error_message)
+      TooManyRequestsError.new(from_message(response, TOO_MANY_REQUESTS))
     end
 
     def from_message(response, fallback)
-      return fallback if response.payload.nil?
-
-      errors = JSON.parse(response.payload)["errors"]
-      return fallback if errors.nil? || errors.empty?
+      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
+      end
 
-      message = errors.map { |error| error["message"] }.join(" ")
-      message.empty? ? fallback : message
+      "#{fallback} Body: #{body}".strip
     end
 
     def assign_exception(response)
-      response.error = case response.status_code
-                         when '304'
-                           NotModifiedInfo.new(NOT_MODIFIED, response.find_header('etag'))
+      response.error = case response.status_code.to_s
+                         when '200', '304'
+                           nil
                          when '401'
                            BadCredentialsError.new(from_message(response, BAD_CREDENTIALS))
                          when '402'
                            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(from_message(response, REQUEST_ENTITY_TOO_LARGE))
                          when '400'
@@ -61,13 +61,17 @@ module SmartyStreets
                          when '422'
                            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

data/lib/smartystreets_ruby_sdk/us_autocomplete_pro/source_type.rb

@@ -0,0 +1,8 @@
+module SmartyStreets
+  module USAutocompletePro
+    module SourceType
+      ALL = 'all'.freeze
+      POSTAL = 'postal'.freeze
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_autocomplete_pro.rb

@@ -1,5 +1,6 @@
 require_relative './us_autocomplete_pro/lookup'
 require_relative './us_autocomplete_pro/geolocation_type'
+require_relative './us_autocomplete_pro/source_type'
 require_relative './us_autocomplete_pro/suggestion'
 require_relative './us_autocomplete_pro/client'
 

data/lib/smartystreets_ruby_sdk/us_enrichment/client.rb

@@ -84,6 +84,7 @@ module SmartyStreets
 
                 response = @sender.send(smarty_request)
                 capture_response_etag(response, lookup)
+                return lookup.result if response.status_code.to_s == '304'
                 results = @serializer.deserialize(response.payload)
 
                 results = [] if results.nil?
@@ -114,8 +115,8 @@ module SmartyStreets
             private
 
             def __send(lookup)
-                if lookup.nil? || (blank?(lookup.smarty_key) && blank?(lookup.street) && blank?(lookup.freeform))
-                    raise SmartyError.new("Lookup requires one of 'smartykey', 'street', or 'freeform' to be set")
+                if lookup.nil? || (blank?(lookup.smarty_key) && blank?(lookup.street) && blank?(lookup.freeform) && blank?(lookup.business_name))
+                    raise SmartyError.new("Lookup requires one of 'smarty_key', 'street', 'freeform', or 'business_name' to be set")
                 end
 
                 smarty_request = Request.new
@@ -135,6 +136,7 @@ module SmartyStreets
                     add_parameter(smarty_request, 'city', lookup.city)
                     add_parameter(smarty_request, 'state', lookup.state)
                     add_parameter(smarty_request, 'zipcode', lookup.zipcode)
+                    add_parameter(smarty_request, 'business_name', lookup.business_name)
                 else
                     if (lookup.data_sub_set.nil?)
                         smarty_request.url_components = '/' + lookup.smarty_key + '/' + lookup.data_set
@@ -147,6 +149,7 @@ module SmartyStreets
 
                 response = @sender.send(smarty_request)
                 capture_response_etag(response, lookup)
+                return [] if response.status_code.to_s == '304'
                 results = @serializer.deserialize(response.payload)
 
                 results = [] if results.nil?

data/lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb

@@ -28,9 +28,9 @@ module SmartyStreets
     end
 
     class Lookup < LookupBase
-      attr_accessor :smarty_key, :data_set, :data_sub_set, :freeform, :street, :city, :state, :zipcode
+      attr_accessor :smarty_key, :data_set, :data_sub_set, :freeform, :street, :city, :state, :zipcode, :business_name
 
-      def initialize(smarty_key=nil, data_set=nil, data_sub_set=nil, freeform=nil, street=nil, city=nil, state=nil, zipcode=nil, request_etag=nil, features=nil)
+      def initialize(smarty_key=nil, data_set=nil, data_sub_set=nil, freeform=nil, street=nil, city=nil, state=nil, zipcode=nil, request_etag=nil, features=nil, business_name=nil)
         super()
         @smarty_key = smarty_key
         @data_set = data_set
@@ -42,6 +42,7 @@ module SmartyStreets
         @zipcode = zipcode
         @request_etag = request_etag
         @features = features
+        @business_name = business_name
       end
     end
 

data/lib/smartystreets_ruby_sdk/us_reverse_geo/source_type.rb

@@ -0,0 +1,8 @@
+module SmartyStreets
+  module USReverseGeo
+    module SourceType
+      ALL = 'all'.freeze
+      POSTAL = 'postal'.freeze
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_reverse_geo/us_reverse_geo_response.rb

@@ -8,7 +8,7 @@ module SmartyStreets
       def initialize(obj)
         @results = []
 
-        obj['results'].each do |result|
+        obj.fetch('results', []).each do |result|
           @results.push(Result.new(result))
         end
       end

data/lib/smartystreets_ruby_sdk/us_reverse_geo.rb

@@ -1,4 +1,5 @@
 require_relative './us_reverse_geo/address'
+require_relative './us_reverse_geo/source_type'
 require_relative './us_reverse_geo/client'
 require_relative './us_reverse_geo/coordinate'
 require_relative './us_reverse_geo/lookup'

data/lib/smartystreets_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreets
-  VERSION = '8.1.1' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '9.0.0' # 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: 8.1.1
+  version: 9.0.0
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-06-08 00:00:00.000000000 Z
+date: 2026-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,7 +80,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".claude/settings.json"
-- ".github/workflows/gem-publish.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/publish.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - CHANGELOG.md
 - CLAUDE.md
@@ -98,12 +100,14 @@ files:
 - examples/international_postal_code_example.rb
 - examples/us_autocomplete_pro_example.rb
 - examples/us_enrichment_business_example.rb
+- examples/us_enrichment_business_name_search_example.rb
 - examples/us_enrichment_etag_example.rb
 - examples/us_enrichment_example.rb
 - examples/us_extract_example.rb
 - examples/us_reverse_geo_example.rb
 - examples/us_street_component_analysis_example.rb
 - examples/us_street_iana_timezone_example.rb
+- examples/us_street_match_strategy_example.rb
 - examples/us_street_multiple_address_example.rb
 - examples/us_street_single_address_example.rb
 - examples/us_zipcode_multiple_lookup_example.rb
@@ -153,6 +157,7 @@ files:
 - lib/smartystreets_ruby_sdk/us_autocomplete_pro/client.rb
 - lib/smartystreets_ruby_sdk/us_autocomplete_pro/geolocation_type.rb
 - lib/smartystreets_ruby_sdk/us_autocomplete_pro/lookup.rb
+- lib/smartystreets_ruby_sdk/us_autocomplete_pro/source_type.rb
 - lib/smartystreets_ruby_sdk/us_autocomplete_pro/suggestion.rb
 - lib/smartystreets_ruby_sdk/us_enrichment.rb
 - lib/smartystreets_ruby_sdk/us_enrichment/business/detail/attributes.rb
@@ -188,6 +193,7 @@ files:
 - lib/smartystreets_ruby_sdk/us_reverse_geo/coordinate.rb
 - lib/smartystreets_ruby_sdk/us_reverse_geo/lookup.rb
 - lib/smartystreets_ruby_sdk/us_reverse_geo/result.rb
+- lib/smartystreets_ruby_sdk/us_reverse_geo/source_type.rb
 - lib/smartystreets_ruby_sdk/us_reverse_geo/us_reverse_geo_response.rb
 - lib/smartystreets_ruby_sdk/us_street.rb
 - lib/smartystreets_ruby_sdk/us_street/analysis.rb
@@ -227,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: An official library for the SmartyStreets APIs

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

@@ -1,27 +0,0 @@
-name: Ruby Gem Publish
-
-on:
-  push:
-    tags: 
-      - '*'
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    env:
-      GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
-    
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.2'
-          bundler-cache: false
-
-      - name: Publish
-        run: |
-          VERSION=${GITHUB_REF#refs/*/} API_KEY=${{ secrets.GEM_HOST_API_KEY }} make publish
-        env:
-          API_KEY: "${{ secrets.GEM_HOST_API_KEY }}"