smartystreets_ruby_sdk 5.14.22 → 5.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e72e7fe2acaced930d16971827d0d03f873841fa21d696a7199f6f675bf9bcb4
-  data.tar.gz: a406b8824048bd60f46ab3d8b90c616c9a3d90a8e56a48fe7fe0d5107b1227c7
+  metadata.gz: 05d6a0df50a6639ed4941e02cdae2164fdcf14eba8ff16fef88cf9433b36d686
+  data.tar.gz: 10ab92e972f454ff59ff4d0ebebefc6e761132749adbeb75a40ef4feda3283cf
 SHA512:
-  metadata.gz: db8b4fba0496780c09d76da886cfaf9f11f9f0ce17617052b462934ce5d534f30dca758bd03f5705b0936bae2995a3655c1afcbc795c0aebbae87abb9f863c45
-  data.tar.gz: 339aae0de4aae8973bbb7dfd0c075b501ab2d001d9d84f439cdc2f32f7196c06288b57ecd6fa3bea5ce69db177f5996219588818448c7a2d82e45f3fbc973f71
+  metadata.gz: b5d7b633a7c6a2ecc552df8449527610725795e50adcd196520d574b2ed523ccc708d7277e7a590609b313cbdc8b8c5c4aec16724ae9eb5650716a594801b990
+  data.tar.gz: c70b4d70013046254d0dbd93dd8b098318fbb11ca3c0f6fa6af3f2ac5ba7ca1f30a1493dd9b242f0174a148eb10f633e6eb6289cc646263f974ae8f092aac2d5

data/examples/international_example.rb

@@ -38,7 +38,7 @@ class InternationalExample
     lookup.country = 'Brazil'
     lookup.postal_code = '02516-050'
 
-    candidates = client.send(lookup) # The candidates are also stored in the lookup's 'result' field.
+    candidates = client.send_lookup(lookup) # The candidates are also stored in the lookup's 'result' field.
 
     first_candidate = candidates[0]
     puts "Input ID: #{first_candidate.input_id}"

data/lib/smartystreets_ruby_sdk/client_builder.rb

@@ -22,14 +22,14 @@ module SmartyStreets
   # You can use ClientBuilder's methods to customize settings like maximum retries or timeout duration.
   # These methods are chainable, so you can usually get set up with one line of code.
   class ClientBuilder
-    INTERNATIONAL_STREET_API_URL = 'https://international-street.api.smartystreets.com/verify'.freeze
-    INTERNATIONAL_AUTOCOMPLETE_API_URL = "https://international-autocomplete.api.smartystreets.com/lookup".freeze
-    US_AUTOCOMPLETE_API_URL = 'https://us-autocomplete.api.smartystreets.com/suggest'.freeze
-    US_AUTOCOMPLETE_PRO_API_URL = 'https://us-autocomplete-pro.api.smartystreets.com/lookup'.freeze
-    US_EXTRACT_API_URL = 'https://us-extract.api.smartystreets.com/'.freeze
-    US_STREET_API_URL = 'https://us-street.api.smartystreets.com/street-address'.freeze
-    US_ZIP_CODE_API_URL = 'https://us-zipcode.api.smartystreets.com/lookup'.freeze
-    US_REVERSE_GEO_API_URL = 'https://us-reverse-geo.api.smartystreets.com/lookup'.freeze
+    INTERNATIONAL_STREET_API_URL = 'https://international-street.api.smarty.com/verify'.freeze
+    INTERNATIONAL_AUTOCOMPLETE_API_URL = "https://international-autocomplete.api.smarty.com/lookup".freeze
+    US_AUTOCOMPLETE_API_URL = 'https://us-autocomplete.api.smarty.com/suggest'.freeze
+    US_AUTOCOMPLETE_PRO_API_URL = 'https://us-autocomplete-pro.api.smarty.com/lookup'.freeze
+    US_EXTRACT_API_URL = 'https://us-extract.api.smarty.com/'.freeze
+    US_STREET_API_URL = 'https://us-street.api.smarty.com/street-address'.freeze
+    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
 
     def initialize(signer)
       @signer = signer

data/lib/smartystreets_ruby_sdk/international_street/client.rb

@@ -11,6 +11,7 @@ module SmartyStreets
       end
 
       # Sends a Lookup object to the International Street API and stores the result in the Lookup's result field.
+      # Deprecated, please use send_lookup instead.
       def send(lookup)
         lookup.ensure_enough_info
         request = build_request(lookup)
@@ -23,6 +24,19 @@ module SmartyStreets
         lookup.result = candidates
       end
 
+      # Sends a Lookup object to the International Street API and stores the result in the Lookup's result field.
+      def send_lookup(lookup)
+        lookup.ensure_enough_info
+        request = build_request(lookup)
+
+        response = @sender.send(request)
+
+        raise response.error if response.error
+
+        candidates = convert_candidates(@serializer.deserialize(response.payload))
+        lookup.result = candidates
+      end
+
       def build_request(lookup)
         request = SmartyStreets::Request.new
 

data/lib/smartystreets_ruby_sdk/retry_sender.rb

@@ -14,7 +14,7 @@ module SmartyStreets
     def send(request)
       response = @inner.send(request)
 
-      (0..@max_retries-1).each do |i|
+      (1..@max_retries).each do |i|
 
         break if STATUS_TO_RETRY.include?(response.status_code.to_i) == false
 

data/lib/smartystreets_ruby_sdk/us_street/candidate.rb

@@ -6,8 +6,8 @@ module SmartyStreets
   module USStreet
     # See "https://smartystreets.com/docs/cloud/us-street-api#metadata"
     class Candidate
-      attr_reader :input_id, :input_index, :candidate_index, :addressee, :delivery_line_1, :delivery_line_2, :delivery_point_barcode,
-                  :last_line, :metadata, :components, :analysis
+      attr_reader :input_id, :input_index, :candidate_index, :addressee, :delivery_line_1, :delivery_line_2,
+                  :last_line,:delivery_point_barcode, :smarty_key, :metadata, :components, :analysis
 
       def initialize(obj)
         @input_id = obj['input_id']
@@ -18,6 +18,7 @@ module SmartyStreets
         @delivery_line_2 = obj['delivery_line_2']
         @last_line = obj['last_line']
         @delivery_point_barcode = obj['delivery_point_barcode']
+        @smarty_key = obj['smarty_key']
         @components = Components.new(obj.fetch('components', {}))
         @metadata = Metadata.new(obj.fetch('metadata', {}))
         @analysis = Analysis.new(obj.fetch('analysis', {}))

data/lib/smartystreets_ruby_sdk/us_street/client.rb

@@ -61,7 +61,7 @@ module SmartyStreets
           converted_lookup['urbanization'] = lookup.urbanization
           converted_lookup['match'] = lookup.match
           converted_lookup['candidates'] = lookup.candidates
-
+          converted_lookup['format'] = lookup.format
           converted_obj.push(converted_lookup)
         end
         converted_obj

data/lib/smartystreets_ruby_sdk/us_street/lookup.rb

@@ -9,10 +9,10 @@ module SmartyStreets
     # @match:: Must be set to 'strict', 'range', or 'invalid'. Constants for these are in match_type.rb
     class Lookup < JSONAble
       attr_accessor :input_id, :street, :street2, :secondary, :city, :state, :zipcode, :lastline, :addressee, :urbanization,
-                    :match, :candidates, :result
+                    :match, :candidates, :format, :result
 
       def initialize(street=nil, street2=nil, secondary=nil, city=nil, state=nil, zipcode=nil, lastline=nil,
-                     addressee=nil, urbanization=nil, match=nil, candidates=0, input_id=nil)
+                     addressee=nil, urbanization=nil, match=nil, candidates=0, input_id=nil, format=nil)
         @input_id = input_id
         @street = street
         @street2 = street2
@@ -25,6 +25,7 @@ module SmartyStreets
         @urbanization = urbanization
         @match = match
         @candidates = candidates
+        @format = format
         @result = []
       end
     end

data/lib/smartystreets_ruby_sdk/us_street/match_type.rb

@@ -6,5 +6,11 @@ module SmartyStreets
       INVALID = 'invalid'.freeze
       ENHANCED = 'enhanced'.freeze
     end
+
+    module OutputFormat
+      DEFAULT = 'default'.freeze
+      PROJECT_USA = 'project-usa'.freeze
+      CASS = 'cass'.freeze
+    end
   end
 end

data/lib/smartystreets_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreets
-  VERSION = '5.14.22' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '5.15.1' # 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: 5.14.22
+  version: 5.15.1
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-27 00:00:00.000000000 Z
+date: 2023-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler