smartystreets_ruby_sdk 7.0.0 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94a47cbd186460b37be8ffcfc4fcdfdd3f4f2353a8f8c9c05e4bc5fe5a39dcda
-  data.tar.gz: 10137cd33f8abfa0c7eca6fbc73a601bfde1dfb5149d4dc4d618afe7a7f3fb72
+  metadata.gz: a2fe64aee0f04fb24de988f8d76f5f922befc65b50b9ce4aff450add95e1ae9c
+  data.tar.gz: ce1bb5f95af3e1b4493525f5d6039a59f1110e134587a1a5e494b55961395300
 SHA512:
-  metadata.gz: cd156836f531094ce0a844f30e227e2d71e9383a8ac3e32ce2b06683251f23bcd5c99294761872e824e01ff0de8525f34b3e278bfee410fbe529e5e9022c237f
-  data.tar.gz: 229d0fdf49332e20a79e6d05fec85acf53696c500b891ae9e08721f1861a6ad0a58a06a4aa4a2bfa510dc9cf9a2a353fea91d03a6ad4781a53365690358764bc
+  metadata.gz: 186de2a1abbc0f62efc80be190f195df5341df523f88e92a7ad37edb95b28fdfae93395e16302ca79376b9dd534ab7928475f981c963923ca60edf277509b17c
+  data.tar.gz: f5a5c41a29c2b77f5c8e5b0405d70b872e74447a0ebe9e39e49b0f44dfb89d3525a449ca6953792d22de7bd7ff0b4d19c89e5ec3fb3f6ba97369511e2d6515d1

data/.claude/settings.json

@@ -10,5 +10,9 @@
       "Bash(rake *)",
       "Bash(ruby *)"
     ]
+  },
+  "attribution": {
+    "commit": "",
+    "pr": ""
   }
 }

data/CLAUDE.md

@@ -38,10 +38,13 @@ client = SmartyStreets::ClientBuilder.new(credentials)
     .build_us_street_api_client
 ```
 
-**Chain of Responsibility**: HTTP requests flow through a middleware chain of "Sender" objects. Each sender wraps an inner sender:
+**Chain of Responsibility**: HTTP requests flow through a middleware chain of "Sender" objects. Each sender wraps an inner sender (outermost to innermost):
 ```
-URLPrefixSender → LicenseSender → RetrySender → SigningSender → StatusCodeSender → NativeSender
+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
 

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_example.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
 
 us_zipcode_api:
 	cd examples && ruby us_zipcode_single_lookup_example.rb && ruby us_zipcode_multiple_lookup_example.rb

data/examples/us_enrichment_example.rb

@@ -44,8 +44,6 @@ class USEnrichmentAddressExample
     freeform_lookup = SmartyStreets::USEnrichment::Lookup.new
     freeform_lookup.freeform = "56 Union Ave Somerville NJ 08876"
 
-    
-
     begin
       # Send a lookup with a smarty key using the line below
       # result = client.send_property_principal_lookup("325023201")
@@ -70,8 +68,67 @@ class USEnrichmentAddressExample
       return
     end
 
-    puts "Lookup Successful! Here is the result: "
-    puts result[0].inspect
+    puts "Lookup Successful! Here is the result:"
+    puts
+
+    response = result[0]
+    attrs = response.attributes
+
+    puts "Smarty Key: #{response.smarty_key}"
+    puts "Data Set: #{response.data_set_name}/#{response.data_subset_name}"
+    puts "ETag: #{response.etag}"
+    puts
+
+    puts "Property Address:"
+    puts "\tFull Address: #{attrs.property_address_full}"
+    puts "\tCity: #{attrs.property_address_city}"
+    puts "\tState: #{attrs.property_address_state}"
+    puts "\tZIP: #{attrs.property_address_zipcode}"
+    puts
+
+    puts "Owner:"
+    puts "\tName: #{attrs.owner_full_name}"
+    puts "\tOccupancy: #{attrs.owner_occupancy_status}"
+    puts
+
+    puts "Property Details:"
+    puts "\tLand Use: #{attrs.land_use_standard}"
+    puts "\tYear Built: #{attrs.year_built}"
+    puts "\tBuilding Sqft: #{attrs.building_sqft}"
+    puts "\tLot Sqft: #{attrs.lot_sqft}"
+    puts "\tAcres: #{attrs.acres}"
+    puts "\tBathrooms: #{attrs.bathrooms_total}"
+    puts "\tBedrooms: #{attrs.bedrooms}"
+    puts "\tStories: #{attrs.stories_number}"
+    puts "\tFireplace: #{attrs.fireplace}"
+    puts "\tGarage: #{attrs.garage}"
+    puts
+
+    puts "Assessment:"
+    puts "\tAssessed Value: #{attrs.assessed_value}"
+    puts "\tTotal Market Value: #{attrs.total_market_value}"
+    puts "\tTax Year: #{attrs.tax_assess_year}"
+    puts "\tTax Billed: #{attrs.tax_billed_amount}"
+    puts
+
+    puts "Location:"
+    puts "\tCounty: #{attrs.situs_county}"
+    puts "\tLatitude: #{attrs.latitude}"
+    puts "\tLongitude: #{attrs.longitude}"
+    puts "\tElevation (ft): #{attrs.elevation_feet}"
+    puts
+
+    unless attrs.financial_history.nil? || attrs.financial_history.empty?
+      puts "Financial History (#{attrs.financial_history.length} entries):"
+      attrs.financial_history.each_with_index do |entry, i|
+        puts "\tEntry #{i + 1}:"
+        puts "\t\tDocument Type: #{entry.document_type_description}"
+        puts "\t\tLender: #{entry.lender_name}"
+        puts "\t\tMortgage Amount: #{entry.mortgage_amount}"
+        puts "\t\tMortgage Type: #{entry.mortgage_type}"
+        puts "\t\tRecording Date: #{entry.mortgage_recording_date}"
+      end
+    end
   end
 end
 

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/lib/smartystreets_ruby_sdk/client_builder.rb

@@ -44,6 +44,7 @@ module SmartyStreets
       @url_prefix = nil
       @proxy = nil
       @header = nil
+      @append_headers = {}
       @licenses = %w()
       @debug = nil
       @queries = {}
@@ -105,6 +106,18 @@ module SmartyStreets
     # Returns self to accommodate method chaining.
     def with_custom_headers(header)
       @header = header
+      @append_headers = {}
+      self
+    end
+
+    # Appends the provided value to the existing header value using the specified separator,
+    # rather than adding a separate header value. This is useful for single-value headers like User-Agent.
+    #
+    # Returns self to accommodate method chaining.
+    def with_appended_header(key, value, separator)
+      @header = {} if @header.nil?
+      @append_headers[key] = separator
+      @header[key] = (@header[key] || []).concat([value])
       self
     end
 
@@ -141,6 +154,12 @@ module SmartyStreets
       self
     end
 
+    # with_feature_iana_time_zone turns on the IANA timezone feature for the request.
+    def with_feature_iana_time_zone()
+      self.with_custom_comma_separated_query("features", "iana-timezone")
+      self
+    end
+
     # Enables debug mode, which will print information about the HTTP request and response to $stdout.
     #
     # Returns self to accommodate method chaining.
@@ -205,7 +224,7 @@ module SmartyStreets
 
       sender = StatusCodeSender.new(sender)
 
-      sender = CustomHeaderSender.new(sender, @header) unless @header.nil?
+      sender = CustomHeaderSender.new(sender, @header, @append_headers) unless @header.nil?
 
       sender = SigningSender.new(@signer, sender) unless @signer.nil?
 

data/lib/smartystreets_ruby_sdk/custom_header_sender.rb

@@ -1,12 +1,14 @@
 module SmartyStreets
   class CustomHeaderSender
-    def initialize(inner, header)
+    def initialize(inner, header, append_headers = {})
       @inner = inner
       @header = header
+      @append_headers = append_headers || {}
     end
 
     def send(request)
-      request.header = @header
+      request.header = @header.transform_values(&:dup)
+      request.append_headers = @append_headers.dup
       @inner.send(request)
     end
   end

data/lib/smartystreets_ruby_sdk/native_sender.rb

@@ -48,7 +48,7 @@ module SmartyStreets
       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)
+      set_custom_headers(smarty_request.header, request, smarty_request.append_headers)
       request
     end
 
@@ -79,9 +79,13 @@ module SmartyStreets
       URI.encode_www_form(smarty_request.parameters)
     end
 
-    def self.set_custom_headers(smarty_header, request)
+    def self.set_custom_headers(smarty_header, request, append_headers = {})
       smarty_header.each do |key, values|
-        if values.respond_to? :each
+        if append_headers.key?(key)
+          separator = append_headers[key]
+          joined = values.respond_to?(:join) ? values.join(separator) : values.to_s
+          request[key] = [request[key], joined].compact.join(separator)
+        elsif values.respond_to?(:each)
           values.each do |value|
             request.add_field(key, value)
           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, :basic_auth
+    attr_accessor :parameters, :payload, :url_components, :url_prefix, :referer, :header, :append_headers, :content_type, :basic_auth
 
     def initialize
       @parameters = {}
@@ -9,6 +9,7 @@ module SmartyStreets
       @url_components = nil
       @referer = nil
       @header = {}
+      @append_headers = {}
       @content_type = 'application/json'
       @basic_auth = nil
     end

data/lib/smartystreets_ruby_sdk/us_street/metadata.rb

@@ -4,7 +4,8 @@ module SmartyStreets
     class Metadata
       attr_reader :elot_sort, :longitude, :elot_sequence, :county_fips, :building_default_indicator, :rdi,
                   :congressional_district, :latitude, :precision, :time_zone, :zip_type, :county_name, :utc_offset,
-                  :record_type, :carrier_route, :obeys_dst, :is_an_ews_match
+                  :record_type, :carrier_route, :obeys_dst, :iana_time_zone, :iana_utc_offset, :iana_obeys_dst,
+                  :is_an_ews_match
 
       def initialize(obj)
         @record_type = obj['record_type']
@@ -23,6 +24,9 @@ module SmartyStreets
         @time_zone = obj['time_zone']
         @utc_offset = obj['utc_offset']
         @obeys_dst = obj['dst']
+        @iana_time_zone = obj['iana_time_zone']
+        @iana_utc_offset = obj['iana_utc_offset']
+        @iana_obeys_dst = obj['iana_dst']
         @is_an_ews_match = obj['ews_match']
       end
     end

data/lib/smartystreets_ruby_sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartystreets_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.2.0
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-26 00:00:00.000000000 Z
+date: 2026-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,6 +101,7 @@ files:
 - examples/us_extract_example.rb
 - examples/us_reverse_geo_example.rb
 - examples/us_street_component_analysis_example.rb
+- examples/us_street_iana_timezone_example.rb
 - examples/us_street_multiple_address_example.rb
 - examples/us_street_single_address_example.rb
 - examples/us_zipcode_multiple_lookup_example.rb