smartystreets_ruby_sdk 6.4.1 → 6.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e9036bc90b5244c404d1969ebeaf73fbf2579be9a2a0346faecd9a65e1fd138
-  data.tar.gz: eb1968e810a46432866e5309c75dc5e3438c4441c1cf13ca3190b813aba96d58
+  metadata.gz: 4580e181f2c397b9abcf2c155562d3032f9bf3982b3e09cfba587d86013f9e16
+  data.tar.gz: 1640dbc717b3098f3f9e4f5883b3aa9879ef657cb1aeee4aac4747fce3b913db
 SHA512:
-  metadata.gz: c20f5407fde9a7b7b01125e8cc1868c21957df86594baf04e4924d32ae7d37ab28de8b78590859eda5b249ea3ecb0245d62d612f92990fb2783559d33d3e708f
-  data.tar.gz: 797f184b4fa722e8f9bea76a448558723a6da6bcab86d64fc00f563cd80c29b5969396b11eb51c9b89a01f801f660713439298429a5f2948b2188e10b111b87b
+  metadata.gz: 44c218c01469fa611468c4aa448094954c7e3a6ebca1e0e662763d7c214406247cbd257e672b4d507008bd307fada6030b0f39eae0485ec9e5427ee60b8ad665
+  data.tar.gz: 569f4edfb672b87d3d4b165f74af82bcee8b45b43a41fcca24000a43da1509f07f0748479bd793695aac33827fd812a40b08cc61f254db1e2ae5fc70b6c9fffd

data/.claude/settings.json

@@ -0,0 +1,14 @@
+{
+  "permissions": {
+    "allow": [
+      "Edit",
+      "Write",
+      "Bash(rm:./*)",
+      "Bash(git *)",
+      "Bash(make *)",
+      "Bash(gem *)",
+      "Bash(rake *)",
+      "Bash(ruby *)"
+    ]
+  }
+}

data/CLAUDE.md

@@ -0,0 +1,70 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Build and Test Commands
+
+```bash
+# Run all tests
+rake test
+# or
+make test
+
+# Run a single test file
+ruby -Ilib:test test/smartystreets_ruby_sdk/test_batch.rb
+
+# Install dependencies
+gem install minitest
+
+# Build the gem (used by CI, requires VERSION env var)
+make package
+
+# Run all example scripts (requires SMARTY_AUTH_ID and SMARTY_AUTH_TOKEN env vars)
+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).
+
+### Core Design Patterns
+
+**Builder Pattern**: `ClientBuilder` provides a fluent interface for configuring API clients:
+```ruby
+credentials = SmartyStreets::StaticCredentials.new(auth_id, auth_token)
+client = SmartyStreets::ClientBuilder.new(credentials)
+    .retry_at_most(5)
+    .with_licenses(['us-rooftop-geocoding-cloud'])
+    .build_us_street_api_client
+```
+
+**Chain of Responsibility**: HTTP requests flow through a middleware chain of "Sender" objects. Each sender wraps an inner sender:
+```
+URLPrefixSender → LicenseSender → RetrySender → SigningSender → StatusCodeSender → NativeSender
+```
+
+### Key Components
+
+- **lib/smartystreets_ruby_sdk.rb**: Main entry point, requires all modules
+- **client_builder.rb**: Constructs sender chains and API clients
+- **Sender classes**: Middleware for URL prefixing, retries, authentication, status code handling
+- **API modules** (us_street/, us_zipcode/, international_street/, etc.): Each contains:
+  - `client.rb`: API client with `send_lookup()` and `send_batch()` methods
+  - `lookup.rb`: Input model (JSONAble mixin for serialization)
+  - Response classes (candidate.rb, result.rb, etc.)
+
+### Supported APIs
+
+- US Street, US ZipCode, US Autocomplete Pro, US Extract, US Reverse Geo, US Enrichment
+- International Street, International Autocomplete, International Postal Code
+
+### Test Structure
+
+Tests use Minitest with mock objects in `test/mocks/`. Test files mirror the lib structure under `test/smartystreets_ruby_sdk/`.
+
+### Adding New API Support
+
+1. Create new directory under `lib/smartystreets_ruby_sdk/` with client, lookup, and response classes
+2. Add `build_[api]_client` method to `client_builder.rb`
+3. Add requires to main `smartystreets_ruby_sdk.rb`
+4. Create corresponding test files and example script

data/Makefile

@@ -46,7 +46,7 @@ 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.rb && ruby us_street_component_analysis_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_component_analysis_example.rb
 
 us_zipcode_api:
 	cd examples && ruby us_zipcode_single_lookup_example.rb && ruby us_zipcode_multiple_lookup_example.rb

data/examples/international_autocomplete_example.rb

@@ -1,5 +1,6 @@
 require '../lib/smartystreets_ruby_sdk/shared_credentials'
 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/international_autocomplete/lookup'
 require '../lib/smartystreets_ruby_sdk/international_autocomplete/client'
@@ -11,13 +12,13 @@ class InternationalAutocompleteExample
     # 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_international_autocomplete_api_client
 

data/examples/international_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/international_street/lookup'
 
@@ -10,13 +11,13 @@ class InternationalExample
     # 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_international_street_api_client
 

data/examples/international_postal_code_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/international_postal_code/lookup'
 
@@ -12,11 +13,11 @@ class InternationalPostalCodeExample
     # referer = ENV['SMARTY_AUTH_REFERER']
     # credentials = SmartyStreets::SharedCredentials.new(key, referer)
 
-    id = ENV['SMARTY_AUTH_ID_DEV']
-    token = ENV['SMARTY_AUTH_TOKEN_DEV']
-    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).with_base_url("https://international-postal-code.api.rivendell.smartyops.net/lookup").build_international_postal_code_api_client
+    client = SmartyStreets::ClientBuilder.new(credentials).build_international_postal_code_api_client
 
     # Documentation for input fields can be found at:
     # https://smartystreets.com/docs/cloud/international-postal-code-api

data/examples/us_autocomplete_pro_example.rb

@@ -1,5 +1,6 @@
 require '../lib/smartystreets_ruby_sdk/shared_credentials'
 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'
 
@@ -10,18 +11,13 @@ class USAutocompleteProExample
     # 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)
-
-    # id = ENV['SMARTY_AUTH_ID']
-    # token = ENV['SMARTY_AUTH_TOKEN']
-    # credentials = SmartyStreets::StaticCredentials.new(id, token)
-
-    # auth_id = ENV['SMARTY_AUTH_ID']
-    # auth_token = ENV['SMARTY_AUTH_TOKEN']
-    #
-    # credentials = SmartyStreets::StaticCredentials.new(auth_id, auth_token)
+    # 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::BasicAuthCredentials.new(id, token)
 
     client = SmartyStreets::ClientBuilder.new(credentials).build_us_autocomplete_pro_api_client
 

data/examples/us_enrichment_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_enrichment/lookup'
 
@@ -14,7 +15,7 @@ class USEnrichmentAddressExample
 
     id = ENV['SMARTY_AUTH_ID']
     token = ENV['SMARTY_AUTH_TOKEN']
-    credentials = SmartyStreets::StaticCredentials.new(id, token)
+    credentials = SmartyStreets::BasicAuthCredentials.new(id, token)
 
     # The appropriate license values to be used for your subscriptions
     # can be found on the Subscriptions page of the account dashboard.

data/examples/us_extract_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_extract/lookup'
 require '../lib/smartystreets_ruby_sdk/us_street/match_type'
@@ -12,13 +13,13 @@ class USExtractExample
     # 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_extract_api_client
 

data/examples/us_reverse_geo_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_reverse_geo/lookup'
 
@@ -10,13 +11,13 @@ class USReverseGeoExample
     # 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_reverse_geo_api_client
 

data/examples/us_street_component_analysis_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_street/lookup'
 require '../lib/smartystreets_ruby_sdk/us_street/match_type'
@@ -14,7 +15,7 @@ class USStreetComponentAnalysisExample
     # For server-to-server requests, use this code:
     id = ENV['SMARTY_AUTH_ID']
     token = ENV['SMARTY_AUTH_TOKEN']
-    credentials = SmartyStreets::StaticCredentials.new(id, token)
+    credentials = SmartyStreets::BasicAuthCredentials.new(id, token)
 
     client = SmartyStreets::ClientBuilder.new(credentials)
       .with_feature_component_analysis() #  To add component analysis feature you need to specify when you create the client.

data/examples/us_street_multiple_address_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/batch'
 require '../lib/smartystreets_ruby_sdk/us_street/lookup'
@@ -12,13 +13,13 @@ class USStreetMultipleAddressExample
     # 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_street_api_client
     batch = SmartyStreets::Batch.new

data/examples/us_street_single_address_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_street/lookup'
 require '../lib/smartystreets_ruby_sdk/us_street/match_type'
@@ -9,13 +10,13 @@ class USStreetSingleAddressExample
     # 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)
 
     # To try with a proxy, add this method before build_us_street_api_client
     #   with_proxy('localhost', 8080, 'proxyUser', 'proxyPassword')

data/examples/us_zipcode_multiple_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/batch'
 require '../lib/smartystreets_ruby_sdk/us_zipcode/lookup'
@@ -11,13 +12,13 @@ class USZipcodeMultipleLookupExample
     # 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
     batch = SmartyStreets::Batch.new

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/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

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/us_street/client.rb

@@ -47,7 +47,16 @@ module SmartyStreets
         converted_obj = []
         obj.each do |lookup|
           converted_lookup = {}
-          lookup.candidates = 5 if lookup.match == "enhanced" && lookup.candidates == 0
+          match_strategy = lookup.match
+          match_strategy = MatchType::ENHANCED if match_strategy.nil? || match_strategy.empty?
+
+          if lookup.candidates > 0
+            converted_lookup['candidates'] = lookup.candidates
+          elsif match_strategy == MatchType::ENHANCED
+            converted_lookup['candidates'] = 5
+          end
+
+          converted_lookup['match'] = match_strategy if match_strategy != MatchType::STRICT
 
           converted_lookup['input_id'] = lookup.input_id
           converted_lookup['street'] = lookup.street
@@ -59,8 +68,6 @@ module SmartyStreets
           converted_lookup['lastline'] = lookup.lastline
           converted_lookup['addressee'] = lookup.addressee
           converted_lookup['urbanization'] = lookup.urbanization
-          converted_lookup['match'] = lookup.match
-          converted_lookup['candidates'] = lookup.candidates
           converted_lookup['format'] = lookup.format
           converted_lookup['county_source'] = lookup.county_source
 

data/lib/smartystreets_ruby_sdk/version.rb

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

data/lib/smartystreets_ruby_sdk.rb

@@ -17,6 +17,7 @@ require 'smartystreets_ruby_sdk/license_sender'
 require 'smartystreets_ruby_sdk/shared_credentials'
 require 'smartystreets_ruby_sdk/signing_sender'
 require 'smartystreets_ruby_sdk/static_credentials'
+require 'smartystreets_ruby_sdk/basic_auth_credentials'
 require 'smartystreets_ruby_sdk/status_code_sender'
 require 'smartystreets_ruby_sdk/url_prefix_sender'
 require 'smartystreets_ruby_sdk/us_extract'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartystreets_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 6.4.1
+  version: 6.5.0
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-22 00:00:00.000000000 Z
+date: 2026-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,9 +79,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".claude/settings.json"
 - ".github/workflows/gem-publish.yml"
 - ".gitignore"
 - CHANGELOG.md
+- CLAUDE.md
 - Dockerfile
 - Gemfile
 - LICENSE.md
@@ -104,6 +106,7 @@ files:
 - examples/us_zipcode_multiple_lookup_example.rb
 - examples/us_zipcode_single_lookup_example.rb
 - lib/smartystreets_ruby_sdk.rb
+- lib/smartystreets_ruby_sdk/basic_auth_credentials.rb
 - lib/smartystreets_ruby_sdk/batch.rb
 - lib/smartystreets_ruby_sdk/client_builder.rb
 - lib/smartystreets_ruby_sdk/custom_header_sender.rb