smartystreets_ruby_sdk 6.1.1 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c07fa454096d003b8ba5542b000d6b860060d29dded06e9eef1733da2877517
-  data.tar.gz: 11cc1c65b25eda1bc04f8538560dd8e5017ddd596e394f4ea2efbfcd96ae7657
+  metadata.gz: 004ff7e3e907b690ae90319ec80fc5ae0a39e0110811271d0b5af96078d97a13
+  data.tar.gz: 7f4ff64365804d28130f2714583e211f9c7051849a435c35e7ad36e22c3f822a
 SHA512:
-  metadata.gz: 3f7463332cc45516bcb54abe9423c1c6bcddcb23e2279cf4df687b16cbba81300279f1d7c744cd4757cc2606e4ab0af4aa224494376d83da30152a47dc8b7fe0
-  data.tar.gz: 235aaadb030654a801593b22f8af8c3f53f17ca69e74c5c4a24b481286a805b28963bd177f409888c6038cc6c71868b91cdc55c78377ec93eb3940fbf7793672
+  metadata.gz: b18e712ed2d5a5bfd113fe220295a732185ddaac9ce37ef25d1e088b3b9f7d3bc9b55d9a72b9baa185548c3206c62d9a5da8b2ef77213d225c945dab406f2559
+  data.tar.gz: f78011e0d4fe74231f60534f79a967b88beb85cdeb279f59ad028cf5430fc5b264b6662d165d6dfc82fad4ccd85613c565ecd8886befd1e9ba58f82b6d3a43bc

data/Makefile

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

data/examples/us_street_component_analysis_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/client_builder'
+require '../lib/smartystreets_ruby_sdk/us_street/lookup'
+require '../lib/smartystreets_ruby_sdk/us_street/match_type'
+
+class USStreetComponentAnalysisExample
+  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::StaticCredentials.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.
+      .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 # Enhanced matching is required to return component analysis results.
+
+    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]
+
+    # Here is an example of how to access the result of component analysis.
+    puts "Primary Number: "
+    puts "\tStatus: #{first_candidate.analysis.components.secondary_number.status}"
+    puts "\tChange: #{first_candidate.analysis.components.secondary_number.change}"
+  end
+end
+
+example = USStreetComponentAnalysisExample.new
+example.run

data/lib/smartystreets_ruby_sdk/client_builder.rb

@@ -9,6 +9,7 @@ require_relative 'sleeper'
 require_relative 'logger'
 require_relative 'proxy'
 require_relative 'custom_header_sender'
+require_relative 'custom_query_sender'
 require_relative 'us_street/client'
 require_relative 'us_zipcode/client'
 require_relative 'us_extract/client'
@@ -43,6 +44,7 @@ module SmartyStreets
       @header = nil
       @licenses = %w()
       @debug = nil
+      @queries = {}
     end
 
     # Sets the maximum number of times to retry sending the request to the API. (Default is 5)
@@ -112,6 +114,31 @@ module SmartyStreets
       self
     end
 
+    # Allows the caller to specify key and value pair that is added to the request query.
+    #
+    # Returns self to accommodate method chaining.
+    def with_custom_query(key, value)
+      @queries[key] = value
+      self
+    end
+
+    # Allows the caller to specify key and value pair and appends the value to the current
+    # value associated with the key, separated by a comma.
+    #
+    # Returns self to accommodate method chaining.
+    def with_custom_comma_separated_query(key, value)
+      @queries[key] = [@queries[key], value].compact.join(',')
+      self
+    end
+    
+    # Adds to the request query to use the component analysis feature.
+    #
+    # Returns self to accommodate method chaining.
+    def with_feature_component_analysis()
+      self.with_custom_comma_separated_query("features", "component-analysis")
+      self
+    end
+
     # Enables debug mode, which will print information about the HTTP request and response to $stdout.
     #
     # Returns self to accommodate method chaining.
@@ -179,6 +206,8 @@ module SmartyStreets
 
       sender = LicenseSender.new(sender, @licenses)
 
+      sender = CustomQuerySender.new(sender, @queries)
+
       URLPrefixSender.new(@url_prefix, sender)
     end
 

data/lib/smartystreets_ruby_sdk/custom_query_sender.rb

@@ -0,0 +1,13 @@
+module SmartyStreets
+  class CustomQuerySender
+    def initialize(inner, queries)
+      @inner = inner
+      @queries = queries
+    end
+
+    def send(request)
+      request.parameters.merge!(@queries)
+      @inner.send(request)
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_street/analysis.rb

@@ -1,9 +1,11 @@
+require_relative 'component_analysis'
+
 module SmartyStreets
   module USStreet
     # See "https://smartystreets.com/docs/cloud/us-street-api#analysis"
     class Analysis
       attr_reader :lacs_link_code, :active, :footnotes, :lacs_link_indicator, :dpv_match_code, :is_suite_link_match,
-                  :is_ews_match, :dpv_footnotes, :cmra, :vacant, :no_stat, :enhanced_match
+                  :is_ews_match, :dpv_footnotes, :cmra, :vacant, :no_stat, :enhanced_match, :components
 
       def initialize(obj)
         @dpv_match_code = obj['dpv_match_code']
@@ -18,6 +20,7 @@ module SmartyStreets
         @lacs_link_indicator = obj['lacslink_indicator']
         @is_suite_link_match = obj['suitelink_match']
         @enhanced_match = obj['enhanced_match']
+        @components = ComponentAnalysis.new(obj.fetch('components', {}))
       end
     end
   end

data/lib/smartystreets_ruby_sdk/us_street/component_analysis.rb

@@ -0,0 +1,36 @@
+module SmartyStreets
+  module USStreet
+    class MatchInfo
+      attr_reader :status, :change
+
+      def initialize(obj = {})
+        @status = obj['status']
+        @change = obj['change'] || []
+      end
+    end
+
+    class ComponentAnalysis
+      attr_reader :primary_number, :street_predirection, :street_name, :street_postdirection,
+                  :street_suffix, :secondary_number, :secondary_designator, :extra_secondary_number,
+                  :extra_secondary_designator, :city_name, :state_abbreviation, :zipcode,
+                  :plus4_code, :urbanization
+
+      def initialize(obj = {})
+        @primary_number = MatchInfo.new(obj.fetch('primary_number', {}))
+        @street_predirection = MatchInfo.new(obj.fetch('street_predirection', {}))
+        @street_name = MatchInfo.new(obj.fetch('street_name', {}))
+        @street_postdirection = MatchInfo.new(obj.fetch('street_postdirection', {}))
+        @street_suffix = MatchInfo.new(obj.fetch('street_suffix', {}))
+        @secondary_number = MatchInfo.new(obj.fetch('secondary_number', {}))
+        @secondary_designator = MatchInfo.new(obj.fetch('secondary_designator', {}))
+        @extra_secondary_number = MatchInfo.new(obj.fetch('extra_secondary_number', {}))
+        @extra_secondary_designator = MatchInfo.new(obj.fetch('extra_secondary_designator', {}))
+        @city_name = MatchInfo.new(obj.fetch('city_name', {}))
+        @state_abbreviation = MatchInfo.new(obj.fetch('state_abbreviation', {}))
+        @zipcode = MatchInfo.new(obj.fetch('zipcode', {}))
+        @plus4_code = MatchInfo.new(obj.fetch('plus4_code', {}))
+        @urbanization = MatchInfo.new(obj.fetch('urbanization', {}))
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreets
-  VERSION = '6.1.1' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '6.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: 6.1.1
+  version: 6.2.0
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-20 00:00:00.000000000 Z
+date: 2025-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,6 +97,7 @@ files:
 - examples/us_enrichment_example.rb
 - examples/us_extract_example.rb
 - examples/us_reverse_geo_example.rb
+- examples/us_street_component_analysis_example.rb
 - examples/us_street_multiple_address_example.rb
 - examples/us_street_single_address_example.rb
 - examples/us_zipcode_multiple_lookup_example.rb
@@ -105,6 +106,7 @@ files:
 - lib/smartystreets_ruby_sdk/batch.rb
 - lib/smartystreets_ruby_sdk/client_builder.rb
 - lib/smartystreets_ruby_sdk/custom_header_sender.rb
+- lib/smartystreets_ruby_sdk/custom_query_sender.rb
 - lib/smartystreets_ruby_sdk/errors.rb
 - lib/smartystreets_ruby_sdk/exceptions.rb
 - lib/smartystreets_ruby_sdk/international_autocomplete.rb
@@ -181,6 +183,7 @@ files:
 - lib/smartystreets_ruby_sdk/us_street/analysis.rb
 - lib/smartystreets_ruby_sdk/us_street/candidate.rb
 - lib/smartystreets_ruby_sdk/us_street/client.rb
+- lib/smartystreets_ruby_sdk/us_street/component_analysis.rb
 - lib/smartystreets_ruby_sdk/us_street/components.rb
 - lib/smartystreets_ruby_sdk/us_street/lookup.rb
 - lib/smartystreets_ruby_sdk/us_street/match_type.rb