smartystreets_ruby_sdk 6.4.1 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e9036bc90b5244c404d1969ebeaf73fbf2579be9a2a0346faecd9a65e1fd138
-  data.tar.gz: eb1968e810a46432866e5309c75dc5e3438c4441c1cf13ca3190b813aba96d58
+  metadata.gz: 6dfe1e04d687c3c2b33c116f12115c921092875761773196e70b05686642147d
+  data.tar.gz: c48c629d5c11195f679fe264b0fe4557e0fc78355e8f51b3ff62ebc463f27da8
 SHA512:
-  metadata.gz: c20f5407fde9a7b7b01125e8cc1868c21957df86594baf04e4924d32ae7d37ab28de8b78590859eda5b249ea3ecb0245d62d612f92990fb2783559d33d3e708f
-  data.tar.gz: 797f184b4fa722e8f9bea76a448558723a6da6bcab86d64fc00f563cd80c29b5969396b11eb51c9b89a01f801f660713439298429a5f2948b2188e10b111b87b
+  metadata.gz: 1fdef4159968f9cdfd3a6e67afefc68ffdddbf527bc4331f424410274b27812c1cfce78c18ca81e8a3ccc817d4b0db267513a116c55e182d43e71e8ffee694c8
+  data.tar.gz: 5fc398cc1452df089d87f0f13869b6ead3ebe387a9698d47881a064b498b8a10b992381e5ec26d95626e0dfdceb56ec47833f15e91601a60f6bbb9de513c4a6c

data/.claude/settings.json

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

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

@@ -0,0 +1,73 @@
+# 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). Compatible with Ruby 3.3 and later.
+
+### 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 (outermost to innermost):
+```
+URLPrefixSender → CustomQuerySender → LicenseSender → RetrySender → SigningSender → CustomHeaderSender → StatusCodeSender → NativeSender
+```
+`CustomHeaderSender` is only included when custom headers are configured; `RetrySender` only when max_retries > 0.
+
+**Authentication**: Three credential types — `StaticCredentials` (auth-id/auth-token), `SharedCredentials` (website key/hostname), and `BasicAuthCredentials` (basic auth header). Credentials are passed to `ClientBuilder` and injected into the sender chain via `SigningSender`.
+
+### 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, 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

@@ -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)"
@@ -33,11 +33,14 @@ international_postal_code_api:
 international_street_api:
 	cd examples && ruby international_example.rb
 
+us_autocomplete_api:
+	cd examples && ruby us_autocomplete_example.rb
+
 us_autocomplete_pro_api:
 	cd examples && ruby us_autocomplete_pro_example.rb
 
 us_enrichment_api:
-	cd examples && ruby us_enrichment_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 +49,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.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_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
+examples: international_autocomplete_api international_postal_code_api international_street_api us_autocomplete_pro_api us_autocomplete_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_autocomplete_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/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
 
@@ -27,13 +28,15 @@ class InternationalAutocompleteExample
     lookup = Lookup.new('Louis')
     lookup.country = "FRA"
     lookup.locality = "Paris"
+    lookup.max_group_results = 5
+    lookup.geolocation = true
 
     # lookup.add_custom_parameter('parameter', 'value')
 
     suggestions = client.send(lookup) # The client will also return the suggestions directly
 
     puts
-    puts '*** Result with some filters ***'
+    puts '*** Result with some filters (max_group_results=5, geolocation=on) ***'
     puts
 
     suggestions.each do |suggestion|

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_example.rb

@@ -0,0 +1,69 @@
+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/lookup'
+require '../lib/smartystreets_ruby_sdk/us_autocomplete/source_type'
+
+# This example is for US Autocomplete (V2). It has the same name as a previous product
+# which has been deprecated since 2022, which we refer to as US Autocomplete Basic.
+# If you are still using US Autocomplete Basic, this SDK will not work.
+class USAutocompleteExample
+  Lookup = SmartyStreets::USAutocomplete::Lookup
+  SourceType = SmartyStreets::USAutocomplete::SourceType
+
+  def run
+    # 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::BasicAuthCredentials.new(id, token)
+
+    client = SmartyStreets::ClientBuilder.new(credentials).build_us_autocomplete_api_client
+
+    # Documentation for input fields can be found at:
+    # https://www.smarty.com/docs/apis/us-autocomplete-v2/reference#http-request-input-fields
+
+    lookup = Lookup.new('1042 W Center')
+    lookup.add_city_filter('Denver,Aurora,CO')
+    lookup.add_city_filter('Orem,UT')
+    lookup.max_results = 5
+    lookup.prefer_ratio = 3
+    lookup.source = SourceType::ALL
+
+    # lookup.add_custom_parameter('parameter', 'value')
+
+    suggestions = client.send(lookup) # The client will also return the suggestions directly
+
+    puts
+    puts '*** Result with some filters ***'
+    puts
+
+    entry_id = nil
+    suggestions.each do |suggestion|
+      puts "#{suggestion.street_line} #{suggestion.city}, #{suggestion.state}"
+      entry_id = suggestion.entry_id if suggestion.entry_id && !suggestion.entry_id.empty?
+    end
+
+    # Expand the secondaries of a result that has an entry_id by passing it back as the selected address.
+    if entry_id && !entry_id.empty?
+      lookup.selected = entry_id
+      suggestions = client.send(lookup)
+
+      puts
+      puts '*** Secondaries ***'
+      puts
+
+      suggestions.each do |suggestion|
+        puts "#{suggestion.street_line} #{suggestion.city}, #{suggestion.state}"
+      end
+    end
+  end
+end
+
+USAutocompleteExample.new.run

data/examples/us_autocomplete_pro_example.rb

@@ -1,27 +1,25 @@
 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'
+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'
     # 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)
-
-    # auth_id = ENV['SMARTY_AUTH_ID']
-    # auth_token = ENV['SMARTY_AUTH_TOKEN']
-    #
-    # credentials = SmartyStreets::StaticCredentials.new(auth_id, auth_token)
+    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
 
@@ -33,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_example.rb

@@ -0,0 +1,72 @@
+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 USEnrichmentBusinessExample
+  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
+
+    smarty_key = "1962995076"
+
+    begin
+      summary_results = client.send_business_lookup(smarty_key)
+    rescue SmartyStreets::SmartyError => err
+      puts err
+      return
+    end
+
+    if summary_results.nil? || summary_results.empty?
+      puts "No response returned for SmartyKey #{smarty_key}"
+      return
+    end
+
+    summary = summary_results[0]
+    if summary.businesses.nil? || summary.businesses.empty?
+      puts "SmartyKey #{smarty_key} has no business tenants"
+      return
+    end
+
+    puts "Summary results for SmartyKey: #{smarty_key}"
+    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 = USEnrichmentBusinessExample.new
+example.run

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