smartystreets_ruby_sdk 6.1.2 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 954bacc17a899a815959f93e7c44494e7514305cfb64cf96df12816c8397ab12
-  data.tar.gz: 05e7e0e7544e5eddbc31de48e7d1f94a1187dbd9399aa2e957d20b6da93276cb
+  metadata.gz: 2a717adaa26421afae4a9537b752f1d0fa6765481a733bdfe49fbfe4019066d1
+  data.tar.gz: a0fdc35eb728b744b311f02ee3267cb74e1278dc03f5c453672324027cd4b589
 SHA512:
-  metadata.gz: 61e551343736810efdb5d1d0f35811523551280bda4b633a0b6607f3c66b43485e35b1d4b5b652d8d28a7603eb4e78df8cc622c9587ea673b87b4be92945e6af
-  data.tar.gz: 9e30ec67d9f24d9d2f5c667ef493e0433d1838a3a73131cf1223a3347fb9a141d88eb075a7e55514b6ca34498acdca2bad12ec18ab09991ce6d639d52a9cabd7
+  metadata.gz: 4ae46059f92d3de97bc82adefee2a45aad62e34d17fba1b4d5d6b138aa85943275becdcb15832feafc1b7706649c81190ad1ffa2c3d5f9fb6aee45d3a44b8fc5
+  data.tar.gz: 13dd12de3c3ac0defae3a13e13fe8cf817b3c48bbdb489e22bdd33ca29ffffceffd3546a566e923c1009b0067e8abda532a5c66d75dd59c120654b94bebccaa7

data/Makefile

@@ -27,6 +27,9 @@ publish: package
 international_autocomplete_api:
 	cd examples && ruby international_autocomplete_example.rb
 
+international_postal_code_api:
+	cd examples && ruby international_postal_code_example.rb
+
 international_street_api:
 	cd examples && ruby international_example.rb
 
@@ -43,11 +46,11 @@ 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
 
-examples: international_autocomplete_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_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_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_enrichment_api us_extract_api us_reverse_geo_api us_street_api us_zipcode_api examples

data/examples/international_postal_code_example.rb

@@ -0,0 +1,59 @@
+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/international_postal_code/lookup'
+
+class InternationalPostalCodeExample
+  Lookup = SmartyStreets::InternationalPostalCode::Lookup
+
+  def run
+    # 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_DEV']
+    token = ENV['SMARTY_AUTH_TOKEN_DEV']
+    credentials = SmartyStreets::StaticCredentials.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
+
+    # Documentation for input fields can be found at:
+    # https://smartystreets.com/docs/cloud/international-postal-code-api
+
+    lookup = Lookup.new
+    lookup.input_id = 'ID-8675309'
+    lookup.locality = 'Sao Paulo'
+    lookup.administrative_area = 'SP'
+    lookup.country = 'Brazil'
+    lookup.postal_code = '02516'
+
+    results = client.send_lookup(lookup)
+
+    puts 'Results:'
+    puts
+    results.each_with_index do |candidate, c|
+      puts "Candidate: #{c}"
+      display(candidate.input_id)
+      display(candidate.country_iso_3)
+      display(candidate.locality)
+      display(candidate.dependent_locality)
+      display(candidate.double_dependent_locality)
+      display(candidate.sub_administrative_area)
+      display(candidate.administrative_area)
+      display(candidate.super_administrative_area)
+      display(candidate.postal_code)
+      puts
+    end
+  end
+
+  def display(value)
+    if value && value.length > 0
+      puts "  #{value}"
+    end
+  end
+end
+
+InternationalPostalCodeExample.new.run
+
+

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

@@ -18,6 +18,7 @@ require_relative 'international_autocomplete/client'
 require_relative 'us_reverse_geo/client'
 require_relative 'us_autocomplete_pro/client'
 require_relative 'us_enrichment/client'
+require_relative 'international_postal_code/client'
 
 module SmartyStreets
   # The ClientBuilder class helps you build a client object for one of the supported SmartyStreets APIs.
@@ -32,6 +33,7 @@ module SmartyStreets
     US_ZIP_CODE_API_URL = 'https://us-zipcode.api.smarty.com/lookup'.freeze
     US_REVERSE_GEO_API_URL = 'https://us-reverse-geo.api.smarty.com/lookup'.freeze
     US_ENRICHMENT_API_URL = 'https://us-enrichment.api.smarty.com/lookup'.freeze
+    INTERNATIONAL_POSTAL_CODE_API_URL = 'https://international-postal-code.api.smarty.com/lookup'.freeze
 
     def initialize(signer)
       @signer = signer
@@ -189,6 +191,11 @@ module SmartyStreets
       USEnrichment::Client.new(build_sender, @serializer)
     end
 
+    def build_international_postal_code_api_client
+      ensure_url_prefix_not_null(INTERNATIONAL_POSTAL_CODE_API_URL)
+      InternationalPostalCode::Client.new(build_sender, @serializer)
+    end
+
     # </editor-fold>
 
     def build_sender

data/lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb

@@ -0,0 +1,35 @@
+module SmartyStreets
+  module InternationalPostalCode
+    # Represents a single candidate returned by the International Postal Code API.
+    # See https://smartystreets.com/docs/cloud/international-postal-code-api
+    class Candidate
+      attr_reader :input_id,
+                  :administrative_area,
+                  :sub_administrative_area,
+                  :super_administrative_area,
+                  :country_iso_3,
+                  :locality,
+                  :dependent_locality,
+                  :dependent_locality_name,
+                  :double_dependent_locality,
+                  :postal_code,
+                  :postal_code_extra
+
+      def initialize(obj)
+        @input_id = obj['input_id']
+        @administrative_area = obj['administrative_area']
+        @sub_administrative_area = obj['sub_administrative_area']
+        @super_administrative_area = obj['super_administrative_area']
+        @country_iso_3 = obj['country_iso_3']
+        @locality = obj['locality']
+        @dependent_locality = obj['dependent_locality']
+        @dependent_locality_name = obj['dependent_locality_name']
+        @double_dependent_locality = obj['double_dependent_locality']
+        @postal_code = obj['postal_code']
+        @postal_code_extra = obj['postal_code_extra']
+      end
+    end
+  end
+end
+
+

data/lib/smartystreets_ruby_sdk/international_postal_code/client.rb

@@ -0,0 +1,60 @@
+require_relative '../request'
+require_relative '../exceptions'
+require_relative 'candidate'
+
+module SmartyStreets
+  module InternationalPostalCode
+    # It is recommended to instantiate this class using ClientBuilder.build_international_postal_code_api_client
+    class Client
+      def initialize(sender, serializer)
+        @sender = sender
+        @serializer = serializer
+      end
+
+      # Sends a Lookup object to the International Postal Code API and stores the result in the Lookup's results field.
+      def send_lookup(lookup)
+        raise SmartyStreets::SmartyError, 'Send() must be passed a Lookup.' if lookup.nil?
+
+        request = build_request(lookup)
+
+        response = @sender.send(request)
+
+        raise response.error if response.error
+
+        candidate_hashes = @serializer.deserialize(response.payload) || []
+        candidates = convert_candidates(candidate_hashes)
+        lookup.results = candidates
+        candidates
+      end
+
+      def build_request(lookup)
+        request = SmartyStreets::Request.new
+
+        add_parameter(request, 'input_id', lookup.input_id)
+        add_parameter(request, 'country', lookup.country)
+        add_parameter(request, 'locality', lookup.locality)
+        add_parameter(request, 'administrative_area', lookup.administrative_area)
+        add_parameter(request, 'postal_code', lookup.postal_code)
+
+        request
+      end
+
+      def convert_candidates(candidate_hashes)
+        converted = []
+        return converted if candidate_hashes.nil?
+
+        candidate_hashes.each do |obj|
+          converted.push(InternationalPostalCode::Candidate.new(obj))
+        end
+
+        converted
+      end
+
+      def add_parameter(request, key, value)
+        request.parameters[key] = value unless value.nil? or value.empty?
+      end
+    end
+  end
+end
+
+

data/lib/smartystreets_ruby_sdk/international_postal_code/lookup.rb

@@ -0,0 +1,21 @@
+module SmartyStreets
+  module InternationalPostalCode
+    # Holds the input data for a postal code lookup and the results returned by the API.
+    # See https://smartystreets.com/docs/cloud/international-postal-code-api
+    class Lookup
+
+      attr_accessor :input_id, :country, :locality, :administrative_area, :postal_code, :results
+
+      def initialize
+        @input_id = nil
+        @country = nil
+        @locality = nil
+        @administrative_area = nil
+        @postal_code = nil
+        @results = []
+      end
+    end
+  end
+end
+
+

data/lib/smartystreets_ruby_sdk/international_postal_code.rb

@@ -0,0 +1,5 @@
+require 'smartystreets_ruby_sdk/international_postal_code/lookup'
+require 'smartystreets_ruby_sdk/international_postal_code/candidate'
+require 'smartystreets_ruby_sdk/international_postal_code/client'
+
+

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.2' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '6.3.0' # DO NOT EDIT (this is updated by a build job when a new release is published)
 end

data/lib/smartystreets_ruby_sdk.rb

@@ -25,6 +25,7 @@ require 'smartystreets_ruby_sdk/us_zipcode'
 require 'smartystreets_ruby_sdk/us_autocomplete_pro'
 require 'smartystreets_ruby_sdk/international_street'
 require 'smartystreets_ruby_sdk/international_autocomplete'
+require 'smartystreets_ruby_sdk/international_postal_code'
 require 'smartystreets_ruby_sdk/us_reverse_geo'
 
 module SmartyStreets

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartystreets_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 6.1.2
+  version: 6.3.0
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-21 00:00:00.000000000 Z
+date: 2025-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,10 +93,12 @@ files:
 - docker-compose.yml
 - examples/international_autocomplete_example.rb
 - examples/international_example.rb
+- examples/international_postal_code_example.rb
 - examples/us_autocomplete_pro_example.rb
 - 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
@@ -112,6 +114,10 @@ files:
 - lib/smartystreets_ruby_sdk/international_autocomplete/client.rb
 - lib/smartystreets_ruby_sdk/international_autocomplete/lookup.rb
 - lib/smartystreets_ruby_sdk/international_autocomplete/suggestion.rb
+- lib/smartystreets_ruby_sdk/international_postal_code.rb
+- lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb
+- lib/smartystreets_ruby_sdk/international_postal_code/client.rb
+- lib/smartystreets_ruby_sdk/international_postal_code/lookup.rb
 - lib/smartystreets_ruby_sdk/international_street.rb
 - lib/smartystreets_ruby_sdk/international_street/analysis.rb
 - lib/smartystreets_ruby_sdk/international_street/candidate.rb
@@ -182,6 +188,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