smartystreets_ruby_sdk 6.4.1 → 10.0.0

data/examples/us_enrichment_etag_example.rb

@@ -0,0 +1,130 @@
+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 USEnrichmentEtagExample
+  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"
+
+    business_id = exercise_summary_etag(smarty_key)
+    return if business_id.nil?
+
+    exercise_detail_etag(business_id)
+  end
+
+  def exercise_summary_etag(smarty_key)
+    puts "=== Business.Summary ETag round trip ==="
+
+    first = SmartyStreets::USEnrichment::Lookup.new(smarty_key, 'business')
+    begin
+      initial_results = @client.send_business_lookup(first)
+    rescue SmartyStreets::SmartyError => err
+      puts "  Initial Summary call failed: #{err.message}"
+      return nil
+    end
+    captured_etag = first.response_etag
+    puts "  Call 1 (no Etag): captured Etag=#{display(captured_etag)}, results=#{initial_results.nil? ? 0 : initial_results.length}"
+
+    if captured_etag.nil? || captured_etag.empty?
+      puts "  Server did not return an Etag header; skipping conditional calls."
+      return first_business_id(initial_results)
+    end
+
+    second = SmartyStreets::USEnrichment::Lookup.new(smarty_key, 'business')
+    second.request_etag = captured_etag
+    begin
+      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
+    end
+
+    third = SmartyStreets::USEnrichment::Lookup.new(smarty_key, 'business')
+    third.request_etag = captured_etag + "X"
+    begin
+      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
+
+    first_business_id(initial_results)
+  end
+
+  def exercise_detail_etag(business_id)
+    puts
+    puts "=== Business.Detail ETag round trip (businessId: #{business_id}) ==="
+
+    first = SmartyStreets::USEnrichment::BusinessDetailLookup.new(business_id)
+    begin
+      initial_result = @client.send_business_detail_lookup(first)
+    rescue SmartyStreets::SmartyError => err
+      puts "  Initial Detail call failed: #{err.message}"
+      return
+    end
+    captured_etag = first.response_etag
+    puts "  Call 1 (no Etag): captured Etag=#{display(captured_etag)}, businessId=#{initial_result ? initial_result.business_id : '<nil>'}"
+
+    if captured_etag.nil? || captured_etag.empty?
+      puts "  Server did not return an Etag header; skipping conditional calls."
+      return
+    end
+
+    second = SmartyStreets::USEnrichment::BusinessDetailLookup.new(business_id)
+    second.request_etag = captured_etag
+    begin
+      @client.send_business_detail_lookup(second)
+      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
+    end
+
+    third = SmartyStreets::USEnrichment::BusinessDetailLookup.new(business_id)
+    third.request_etag = captured_etag + "X"
+    begin
+      @client.send_business_detail_lookup(third)
+      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
+  end
+
+  def first_business_id(summary_results)
+    return nil if summary_results.nil? || summary_results.empty?
+    first = summary_results[0]
+    return nil if first.businesses.nil? || first.businesses.empty?
+    first.businesses[0].business_id
+  end
+
+  def display(value)
+    value.nil? || value.empty? ? "<none>" : value
+  end
+end
+
+example = USEnrichmentEtagExample.new
+example.run

data/examples/us_enrichment_example.rb

@@ -1,20 +1,18 @@
 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 USEnrichmentAddressExample
-  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)
+  # SmartyKey used for the non-property datasets. The property example uses a
+  # separate key because its address happens to have rich financial history.
+  SHARED_SMARTY_KEY = '325023201'
 
+  def run
     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.
@@ -22,57 +20,145 @@ class USEnrichmentAddressExample
     #
     # To try with a proxy, add this method call at the end of the chain
     #   with_proxy('localhost', 8080, 'proxyUser', 'proxyPassword')
-    client = SmartyStreets::ClientBuilder.new(credentials).
-             build_us_enrichment_api_client
-    result = nil
+    @client = SmartyStreets::ClientBuilder.new(credentials).
+      build_us_enrichment_api_client
 
-    # Create a new lookup instance to search with address components
-    lookup = SmartyStreets::USEnrichment::Lookup.new
+    property_principal_example
+    geo_reference_example
+    secondary_example
+    secondary_count_example
+  end
 
-    lookup.smarty_key = "87844267"
-    lookup.street = "56 Union Ave"
-    lookup.city = "Somerville"
-    lookup.state = "NJ"
-    lookup.zipcode = "08876"
-    lookup.features = "financial"
-    # lookup.etag = "AUBAGDQDAIGQYCYC"
+  # ---------- property / principal ----------
+  def property_principal_example
+    banner 'property / principal'
 
+    lookup = SmartyStreets::USEnrichment::Lookup.new
+    lookup.smarty_key = '87844267'
+    lookup.street = '56 Union Ave'
+    lookup.city = 'Somerville'
+    lookup.state = 'NJ'
+    lookup.zipcode = '08876'
+    lookup.features = 'financial'
+    # lookup.request_etag = 'AUBAGDQDAIGQYCYC'
     # lookup.add_custom_parameter('parameter', 'value')
 
-    # Or, create a freeform lookup to search using a single line address
-    freeform_lookup = SmartyStreets::USEnrichment::Lookup.new
-    freeform_lookup.freeform = "56 Union Ave Somerville NJ 08876"
+    results = invoke { @client.send_property_principal_lookup(lookup) }
+    return if results.nil? || results.empty?
 
-    
+    response = results[0]
+    attrs = response.attributes
+    puts "Smarty Key: #{response.smarty_key}"
+    puts "Data Set: #{response.data_set_name}/#{response.data_subset_name}"
+    puts "ETag: #{lookup.response_etag}"
+    puts
+    puts 'Property Address:'
+    puts "  Full Address: #{attrs.property_address_full}"
+    puts "  City: #{attrs.property_address_city}, #{attrs.property_address_state} #{attrs.property_address_zipcode}"
+    puts "Owner: #{attrs.owner_full_name}"
+    puts "Year Built: #{attrs.year_built}  Building Sqft: #{attrs.building_sqft}"
+    puts "Assessed Value: #{attrs.assessed_value}  Total Market Value: #{attrs.total_market_value}"
+    unless attrs.financial_history.nil? || attrs.financial_history.empty?
+      puts "Financial History entries: #{attrs.financial_history.length}"
+    end
+  end
 
-    begin
-      # Send a lookup with a smarty key using the line below
-      # result = client.send_property_principal_lookup("325023201")
+  # ---------- geo-reference ----------
+  def geo_reference_example
+    banner 'geo-reference'
 
-      # 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
+    lookup = SmartyStreets::USEnrichment::Lookup.new(SHARED_SMARTY_KEY)
+    results = invoke { @client.send_geo_reference_lookup(lookup) }
+    return if results.nil? || results.empty?
 
-      # Access the other Enrichment datasets using the below functions. All of these functions can take a lookup or a smartykey
-      # result = client.send_geo_reference_lookup("325023201")
-      # result = client.send_risk_lookup("325023201")
-      # result = client.send_secondary_lookup("325023201")
-      # result = client.send_secondary_count_lookup("325023201")
+    response = results[0]
+    attrs = response.attributes
+    puts "Smarty Key: #{response.smarty_key}"
+    puts "Data Set: #{response.data_set_name} (version: #{response.data_set_version})"
+    puts "Matched Address: #{response.matched_address}"
+    puts "ETag: #{lookup.response_etag}"
+    puts
+    print_object('Census Block', attrs.census_block)
+    print_object('Census County Division', attrs.census_county_division)
+    print_object('Census Tract', attrs.census_tract)
+    print_object('Core Based Stat Area', attrs.core_based_stat_area)
+    print_object('Place', attrs.place)
+  end
 
-    rescue SmartyStreets::SmartyError => err
-      puts err
-      return
+  # ---------- secondary ----------
+  def secondary_example
+    banner 'secondary'
+
+    lookup = SmartyStreets::USEnrichment::Lookup.new(SHARED_SMARTY_KEY)
+    results = invoke { @client.send_secondary_lookup(lookup) }
+    return if results.nil? || results.empty?
+
+    response = results[0]
+    puts "Smarty Key: #{response.smarty_key}"
+    puts "Matched Address: #{response.matched_address}"
+    puts "ETag: #{lookup.response_etag}"
+    puts
+    print_object('Root Address', response.root_address)
+
+    unless response.aliases.nil? || response.aliases.empty?
+      puts "\nAliases (#{response.aliases.length}):"
+      response.aliases.each_with_index { |a, i| puts "  [#{i}] #{one_liner(a)}" }
     end
 
-    if result.empty?
-      puts 'No results. This means the smartykey is not valid.'
+    unless response.secondaries.nil? || response.secondaries.empty?
+      puts "\nSecondaries (#{response.secondaries.length}):"
+      response.secondaries.first(5).each_with_index { |s, i| puts "  [#{i}] #{one_liner(s)}" }
+      puts "  ...#{response.secondaries.length - 5} more" if response.secondaries.length > 5
+    end
+  end
+
+  # ---------- secondary / count ----------
+  def secondary_count_example
+    banner 'secondary / count'
+
+    lookup = SmartyStreets::USEnrichment::Lookup.new(SHARED_SMARTY_KEY)
+    results = invoke { @client.send_secondary_count_lookup(lookup) }
+    return if results.nil? || results.empty?
+
+    response = results[0]
+    puts "Smarty Key: #{response.smarty_key}"
+    puts "Matched Address: #{response.matched_address}"
+    puts "Count: #{response.count}"
+    puts "ETag: #{lookup.response_etag}"
+  end
+
+  # ---------- helpers ----------
+  def banner(title)
+    puts
+    puts "=== #{title} ==="
+  end
+
+  def invoke
+    yield
+  rescue SmartyStreets::SmartyError => err
+    puts "  Lookup failed: #{err.class}: #{err.message}"
+    nil
+  end
+
+  def print_object(label, obj)
+    puts "#{label}:"
+    if obj.nil?
+      puts '  (none)'
       return
     end
+    obj.instance_variables.each do |var|
+      value = obj.instance_variable_get(var)
+      next if value.nil?
+      puts "  #{var.to_s.delete('@')}: #{value}"
+    end
+  end
 
-    puts "Lookup Successful! Here is the result: "
-    puts result[0].inspect
+  def one_liner(obj)
+    obj.instance_variables.filter do |var|
+      value = obj.instance_variable_get(var)
+      "#{var.to_s.delete('@')}=#{value}" unless value.nil?
+    end.join(' ')
   end
 end
 
-example = USEnrichmentAddressExample.new
-example.run
+USEnrichmentAddressExample.new.run

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,22 +1,25 @@
 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'
+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'
     # 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
 
@@ -24,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_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_iana_timezone_example.rb

@@ -0,0 +1,54 @@
+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'
+
+class USStreetIANATimezoneExample
+  def run
+    # For client-side requests (browser/mobile), use this code:
+    # key = ENV['SMARTY_AUTH_WEB']
+    # referer = ENV['SMARTY_AUTH_REFERER']
+    # credentials = SmartyStreets::SharedCredentials.new(key, referer)
+
+    # For server-to-server requests, use this code:
+    id = ENV['SMARTY_AUTH_ID']
+    token = ENV['SMARTY_AUTH_TOKEN']
+    credentials = SmartyStreets::BasicAuthCredentials.new(id, token)
+
+    client = SmartyStreets::ClientBuilder.new(credentials)
+      .with_feature_iana_time_zone()
+      .build_us_street_api_client
+
+    lookup = SmartyStreets::USStreet::Lookup.new
+    lookup.street = "1 Rosedale"
+    lookup.secondary = "APT 2"
+    lookup.city = "Baltimore"
+    lookup.state = "MD"
+    lookup.zipcode = "21229"
+    lookup.match = SmartyStreets::USStreet::MatchType::ENHANCED
+
+    begin
+      client.send_lookup(lookup)
+    rescue SmartyStreets::SmartyError => err
+      puts err
+      return
+    end
+
+    result = lookup.result
+
+    if result.empty?
+      return
+    end
+
+    first_candidate = result[0]
+
+    puts "IANA Time Zone: #{first_candidate.metadata.iana_time_zone}"
+    puts "IANA UTC Offset: #{first_candidate.metadata.iana_utc_offset}"
+    puts "IANA Obeys DST: #{first_candidate.metadata.iana_obeys_dst}"
+  end
+end
+
+example = USStreetIANATimezoneExample.new
+example.run

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