smartystreets_ruby_sdk 6.4.0 → 6.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d375dcd5f5bbf6d34f142ca1607d8501f603e62f8124a66c79af6dbe7d9d84c
-  data.tar.gz: 12d4f82423aa49823dcbb64fd6776be7b481c98430287617efcb5d6401569321
+  metadata.gz: 4580e181f2c397b9abcf2c155562d3032f9bf3982b3e09cfba587d86013f9e16
+  data.tar.gz: 1640dbc717b3098f3f9e4f5883b3aa9879ef657cb1aeee4aac4747fce3b913db
 SHA512:
-  metadata.gz: 101162f5fc509e6ba0be4f6f256d4d5fe0144eee79d486d21f9ba21d6299941c13b857df558bd3dc413b3e1fe93bba07464ee37d2dfd345c5ec4c6baddc7c4a6
-  data.tar.gz: fadbf14f9db3e6c4a9f602dc0402d9fb5fe3b57c54082d54670d26d43c10c0d4356ef6485479a9c03325cb43e0b8700e2866ae3ecf6f9ad6a1742f1324824ee3
+  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.
@@ -52,9 +53,8 @@ class USEnrichmentAddressExample
       # Uncomment the following lines to perform other types of lookups:
       result = client.send_property_principal_lookup(lookup) # Using address components
       # result = client.send_property_principal_lookup(freeform_lookup) # Using freeform address
-       
+
       # Access the other Enrichment datasets using the below functions. All of these functions can take a lookup or a smartykey
-      # result = client.send_property_financial_lookup("325023201")
       # result = client.send_geo_reference_lookup("325023201")
       # result = client.send_risk_lookup("325023201")
       # result = client.send_secondary_lookup("325023201")

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

@@ -1,4 +1,3 @@
-require_relative "property/financial/response"
 require_relative "property/principal/response"
 require_relative "geo_reference/response"
 require_relative "risk/response"
@@ -15,16 +14,6 @@ module SmartyStreets
                 @serializer = serializer
             end
 
-            def send_property_financial_lookup(lookup)
-                if (lookup.instance_of? String)
-                    __send(USEnrichment::Lookup.new(lookup,'property','financial'))
-                elsif (lookup.instance_of? USEnrichment::Lookup)
-                    lookup.data_set = 'property'
-                    lookup.data_sub_set = 'financial'
-                    __send(lookup)
-                end
-            end
-
             def send_property_principal_lookup(lookup)
                 if (lookup.instance_of? String)
                     __send(USEnrichment::Lookup.new(lookup,'property','principal'))
@@ -129,9 +118,6 @@ module SmartyStreets
                 output = []
                 results.each do |raw_result|
                     result = nil
-                    if lookup.data_sub_set == "financial"
-                        result = USEnrichment::Property::Financial::Response.new(raw_result, response.header['etag'])
-                    end
                     if lookup.data_sub_set == "principal"
                         result = USEnrichment::Property::Principal::Response.new(raw_result, response.header['etag'])
                     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.0' # 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.0
+  version: 6.5.0
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-17 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
@@ -158,9 +161,6 @@ files:
 - lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/place_entry.rb
 - lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/response.rb
 - lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb
-- lib/smartystreets_ruby_sdk/us_enrichment/property/financial/attributes.rb
-- lib/smartystreets_ruby_sdk/us_enrichment/property/financial/history_entry.rb
-- lib/smartystreets_ruby_sdk/us_enrichment/property/financial/response.rb
 - lib/smartystreets_ruby_sdk/us_enrichment/property/principal/attributes.rb
 - lib/smartystreets_ruby_sdk/us_enrichment/property/principal/history_entry.rb
 - lib/smartystreets_ruby_sdk/us_enrichment/property/principal/response.rb

data/lib/smartystreets_ruby_sdk/us_enrichment/property/financial/attributes.rb

@@ -1,137 +0,0 @@
-require_relative 'history_entry'
-
-module SmartyStreets
-    module USEnrichment
-        module Property
-            module Financial
-                class Attributes
-                    attr_reader :assessed_improvement_percent, :assessed_improvement_value, :assessed_land_value, :assessed_value, 
-                    :assessor_last_update, :assessor_taxroll_update, :contact_city, :contact_crrt, :contact_full_address, :contact_house_number, 
-                    :contact_mail_info_format, :contact_mail_info_privacy, :contact_mailing_county, :contact_mailing_fips, :contact_post_direction, 
-                    :contact_pre_direction, :contact_state, :contact_street_name, :contact_suffix, :contact_unit_designator, :contact_value, 
-                    :contact_zip, :contact_zip4, :deed_document_page, :deed_document_book, :deed_document_number, :deed_owner_first_name, 
-                    :deed_owner_first_name2, :deed_owner_first_name3, :deed_owner_first_name4, :deed_owner_full_name, :deed_owner_full_name2, 
-                    :deed_owner_full_name3, :deed_owner_full_name4, :deed_owner_last_name, :deed_owner_last_name2, :deed_owner_last_name3, 
-                    :deed_owner_last_name4, :deed_owner_middle_name, :deed_owner_middle_name2, :deed_owner_middle_name3, :deed_owner_middle_name4, 
-                    :deed_owner_suffix, :deed_owner_suffix2, :deed_owner_suffix3, :deed_owner_suffix4, :deed_sale_date, :deed_sale_price, 
-                    :deed_transaction_id, :disabled_tax_exemption, :financial_history, :first_name, :first_name_2, :first_name_3, :first_name_4, 
-                    :homeowner_tax_exemption, :last_name, :last_name_2, :last_name_3, :last_name_4, :market_improvement_percent, :market_improvement_value, 
-                    :market_land_value, :market_value_year, :match_type, :middle_name, :middle_name_2, :middle_name_3, :middle_name_4, :other_tax_exemption, 
-                    :owner_full_name, :owner_full_name_2, :owner_full_name_3, :owner_full_name_4, :ownership_transfer_date, :ownership_transfer_doc_number, 
-                    :ownership_transfer_transaction_id, :ownership_type, :ownership_type_2, :previous_assessed_value, :prior_sale_amount, :prior_sale_date, 
-                    :sale_amount, :sale_date, :senior_tax_exemption, :suffix, :suffix_2, :suffix_3, :suffix_4, :tax_assess_year, :tax_billed_amount, 
-                    :tax_delinquent_year, :tax_fiscal_year, :tax_rate_area, :total_market_value, :trust_description, :veteran_tax_exemption, :widow_tax_exemption
-            
-                    def initialize(obj)
-                        @assessed_improvement_percent = obj['assessed_improvement_percent']
-                        @assessed_improvement_value = obj['assessed_improvement_value']
-                        @assessed_land_value = obj['assessed_land_value']
-                        @assessed_value = obj['assessed_value']
-                        @assessor_last_update = obj['assessor_last_update']
-                        @assessor_taxroll_update = obj['assessor_taxroll_update']
-                        @contact_city = obj['contact_city']
-                        @contact_crrt = obj['contact_crrt']
-                        @contact_full_address = obj['contact_full_address']
-                        @contact_house_number = obj['contact_house_number']
-                        @contact_mail_info_format = obj['contact_mail_info_format']
-                        @contact_mail_info_privacy = obj['contact_mail_info_privacy']
-                        @contact_mailing_county = obj['contact_mailing_county']
-                        @contact_mailing_fips = obj['contact_mailing_fips']
-                        @contact_post_direction = obj['contact_post_direction']
-                        @contact_pre_direction = obj['contact_pre_direction']
-                        @contact_state = obj['contact_state']
-                        @contact_street_name = obj['contact_street_name']
-                        @contact_suffix = obj['contact_suffix']
-                        @contact_unit_designator = obj['contact_unit_designator']
-                        @contact_value = obj['contact_value']
-                        @contact_zip = obj['contact_zip']
-                        @contact_zip4 = obj['contact_zip4']
-                        @deed_document_page = obj['deed_document_page']
-                        @deed_document_book = obj['deed_document_book']
-                        @deed_document_number = obj['deed_document_number']
-                        @deed_owner_first_name = obj['deed_owner_first_name']
-                        @deed_owner_first_name2 = obj['deed_owner_first_name2']
-                        @deed_owner_first_name3 = obj['deed_owner_first_name3']
-                        @deed_owner_first_name4 = obj['deed_owner_first_name4']
-                        @deed_owner_full_name = obj['deed_owner_full_name']
-                        @deed_owner_full_name2 = obj['deed_owner_full_name2']
-                        @deed_owner_full_name3 = obj['deed_owner_full_name3']
-                        @deed_owner_full_name4 = obj['deed_owner_full_name4']
-                        @deed_owner_last_name = obj['deed_owner_last_name']
-                        @deed_owner_last_name2 = obj['deed_owner_last_name2']
-                        @deed_owner_last_name3 = obj['deed_owner_last_name3']
-                        @deed_owner_last_name4 = obj['deed_owner_last_name4']
-                        @deed_owner_middle_name = obj['deed_owner_middle_name']
-                        @deed_owner_middle_name2 = obj['deed_owner_middle_name2']
-                        @deed_owner_middle_name3 = obj['deed_owner_middle_name3']
-                        @deed_owner_middle_name4 = obj['deed_owner_middle_name4']
-                        @deed_owner_suffix = obj['deed_owner_suffix']
-                        @deed_owner_suffix2 = obj['deed_owner_suffix2']
-                        @deed_owner_suffix3 = obj['deed_owner_suffix3']
-                        @deed_owner_suffix4 = obj['deed_owner_suffix4']
-                        @deed_sale_date = obj['deed_sale_date']
-                        @deed_sale_price = obj['deed_sale_price']
-                        @deed_transaction_id = obj['deed_transaction_id']
-                        @disabled_tax_exemption = obj['disabled_tax_exemption']
-                        @financial_history = createFinancialHistory(obj['financial_history'])
-                        @first_name = obj['first_name']
-                        @first_name_2 = obj['first_name_2']
-                        @first_name_3 = obj['first_name_3']
-                        @first_name_4 = obj['first_name_4']
-                        @homeowner_tax_exemption = obj['homeowner_tax_exemption']
-                        @last_name = obj['last_name']
-                        @last_name_2 = obj['last_name_2']
-                        @last_name_3 = obj['last_name_3']
-                        @last_name_4 = obj['last_name_4']
-                        @market_improvement_percent = obj['market_improvement_percent']
-                        @market_improvement_value = obj['market_improvement_value']
-                        @market_land_value = obj['market_land_value']
-                        @market_value_year = obj['market_value_year']
-                        @match_type = obj['match_type']
-                        @middle_name = obj['middle_name']
-                        @middle_name_2 = obj['middle_name_2']
-                        @middle_name_3 = obj['middle_name_3']
-                        @middle_name_4 = obj['middle_name_4']
-                        @other_tax_exemption = obj['other_tax_exemption']
-                        @owner_full_name = obj['owner_full_name']
-                        @owner_full_name_2 = obj['owner_full_name_2']
-                        @owner_full_name_3 = obj['owner_full_name_3']
-                        @owner_full_name_4 = obj['owner_full_name_4']
-                        @ownership_transfer_date = obj['ownership_transfer_date']
-                        @ownership_transfer_doc_number = obj['ownership_transfer_doc_number']
-                        @ownership_transfer_transaction_id = obj['ownership_transfer_transaction_id']
-                        @ownership_type = obj['ownership_type']
-                        @ownership_type_2 = obj['ownership_type_2']
-                        @previous_assessed_value = obj['previous_assessed_value']
-                        @prior_sale_amount = obj['prior_sale_amount']
-                        @prior_sale_date = obj['prior_sale_date']
-                        @sale_amount = obj['sale_amount']
-                        @sale_date = obj['sale_date']
-                        @senior_tax_exemption = obj['senior_tax_exemption']
-                        @suffix = obj['suffix']
-                        @suffix_2 = obj['suffix_2']
-                        @suffix_3 = obj['suffix_3']
-                        @suffix_4 = obj['suffix_4']
-                        @tax_assess_year = obj['tax_assess_year']
-                        @tax_billed_amount = obj['tax_billed_amount']
-                        @tax_delinquent_year = obj['tax_delinquent_year']
-                        @tax_fiscal_year = obj['tax_fiscal_year']
-                        @tax_rate_area = obj['tax_rate_area']
-                        @total_market_value = obj['total_market_value']
-                        @trust_description = obj['trust_description']
-                        @veteran_tax_exemption = obj['veteran_tax_exemption']
-                        @widow_tax_exemption = obj['widow_tax_exemption']
-                    end
-                    
-                    def createFinancialHistory(historyArray)
-                        entryArray = []
-                        for entry in historyArray do
-                            entryArray << Financial::HistoryEntry.new(entry)
-                        end
-                        return entryArray
-                    end
-                end
-            end
-        end
-    end
-end

data/lib/smartystreets_ruby_sdk/us_enrichment/property/financial/history_entry.rb

@@ -1,64 +0,0 @@
-module SmartyStreets
-    module USEnrichment
-        module Property
-            module Financial
-                class HistoryEntry
-                    attr_reader :code_title_company, :document_type_description, :instrument_date, :interest_rate_type_2, :lender_address, :lender_address_2, 
-                    :lender_city, :lender_city_2, :lender_code_2, :lender_first_name, :lender_first_name_2, :lender_last_name, 
-                    :lender_last_name_2, :lender_name, :lender_name_2, :lender_seller_carry_back, :lender_seller_carry_back_2, 
-                    :lender_state, :lender_state_2, :lender_zip, :lender_zip_2, :lender_zip_extended, :lender_zip_extended_2, 
-                    :mortgage_amount, :mortgage_amount_2, :mortgage_due_date, :mortgage_due_date_2, :mortgage_interest_rate, 
-                    :mortgage_interest_rate_type, :mortgage_lender_code, :mortgage_rate_2, :mortgage_recording_date, 
-                    :mortgage_recording_date_2, :mortgage_term, :mortgage_term_2, :mortgage_term_type, :mortgage_term_type_2, 
-                    :mortgage_type, :mortgage_type_2, :multi_parcel_flag, :name_title_company, :recording_date, :transfer_amount
-            
-                    def initialize(obj)
-                        @code_title_company = obj['code_title_company']
-                        @document_type_description = obj['document_type_description']
-                        @instrument_date = obj['instrument_date']
-                        @interest_rate_type_2 = obj['interest_rate_type_2']
-                        @lender_address = obj['lender_address']
-                        @lender_address_2 = obj['lender_address_2']
-                        @lender_city = obj['lender_city']
-                        @lender_city_2 = obj['lender_city_2']
-                        @lender_code_2 = obj['lender_code_2']
-                        @lender_first_name = obj['lender_first_name']
-                        @lender_first_name_2 = obj['lender_first_name_2']
-                        @lender_last_name = obj['lender_last_name']
-                        @lender_last_name_2 = obj['lender_last_name_2']
-                        @lender_name = obj['lender_name']
-                        @lender_name_2 = obj['lender_name_2']
-                        @lender_seller_carry_back = obj['lender_seller_carry_back']
-                        @lender_seller_carry_back_2 = obj['lender_seller_carry_back_2']
-                        @lender_state = obj['lender_state']
-                        @lender_state_2 = obj['lender_state_2']
-                        @lender_zip = obj['lender_zip']
-                        @lender_zip_2 = obj['lender_zip_2']
-                        @lender_zip_extended = obj['lender_zip_extended']
-                        @lender_zip_extended_2 = obj['lender_zip_extended_2']
-                        @mortgage_amount = obj['mortgage_amount']
-                        @mortgage_amount_2 = obj['mortgage_amount_2']
-                        @mortgage_due_date = obj['mortgage_due_date']
-                        @mortgage_due_date_2 = obj['mortgage_due_date_2']
-                        @mortgage_interest_rate = obj['mortgage_interest_rate']
-                        @mortgage_interest_rate_type = obj['mortgage_interest_rate_type']
-                        @mortgage_lender_code = obj['mortgage_lender_code']
-                        @mortgage_rate_2 = obj['mortgage_rate_2']
-                        @mortgage_recording_date = obj['mortgage_recording_date']
-                        @mortgage_recording_date_2 = obj['mortgage_recording_date_2']
-                        @mortgage_term = obj['mortgage_term']
-                        @mortgage_term_2 = obj['mortgage_term_2']
-                        @mortgage_term_type = obj['mortgage_term_type']
-                        @mortgage_term_type_2 = obj['mortgage_term_type_2']
-                        @mortgage_type = obj['mortgage_type']
-                        @mortgage_type_2 = obj['mortgage_type_2']
-                        @multi_parcel_flag = obj['multi_parcel_flag']
-                        @name_title_company = obj['name_title_company']
-                        @recording_date = obj['recording_date']
-                        @transfer_amount = obj['transfer_amount']
-                    end
-                end
-            end
-        end
-    end
-end

data/lib/smartystreets_ruby_sdk/us_enrichment/property/financial/response.rb

@@ -1,22 +0,0 @@
-require_relative "attributes"
-
-module SmartyStreets
-    module USEnrichment
-        module Property
-            module Financial
-                class Response
-                    attr_reader :smarty_key, :data_set_name, :data_subset_name, :matched_address, :attributes, :etag
-            
-                    def initialize(obj, etag=nil)
-                        @smarty_key = obj['smarty_key']
-                        @data_set_name = obj['data_set_name']
-                        @data_subset_name = obj['data_subset_name']
-                        @matched_address = obj['matched_address']
-                        @attributes = Attributes.new(obj['attributes'])
-                        @etag = etag
-                    end
-                end
-            end
-        end
-    end
-end