smartystreets_ruby_sdk 5.20.2 → 5.20.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: feea3fd221e9e87912c8d35bd636b8c295ae0415ef20cc45880b330d1199ce3f
-  data.tar.gz: e0d8168d70e4edf32906f49ec0cb39b1f7890804a7067e80cf7538e1db1ba24c
+  metadata.gz: c554ac1a2e41bfab06caaf370cc2c3650cf8978d4a9124b9d264d2fb0e816a52
+  data.tar.gz: 3665b21cad59e010cc754c4f92a6c353857537e1634a4b119d5b56f7bb405e93
 SHA512:
-  metadata.gz: 17120bcc323bd9dd58ce32520fdfe8993afaf352dd595bbc2316a33cddd5e8ab44b4c2728b807488ab601be72e68a4627b5ea3a5b4a5825bb9843e0ffeb2e0eb
-  data.tar.gz: a9535cac7038a34e74101d551781368d883c9aafd12ef9b5dbe52d37c158cf8d3253cb179a1ce2a872cb928660a40c599e92a163ee3e7f1d4a0fbfcc165d64d7
+  metadata.gz: 1e9118f8e575962fc0e0381687baf92ed8fcb1bb004699dd90a38737a8064108577b63a29d57d2a93abae1df260e7af70599e0415fc9719f9bde185b8ec5f519
+  data.tar.gz: d7753e3c65e0a7a4c5c734c60caf3f03c725f952ecc411ab459e55cbbf90edc41cd10e649b3f31cfba80fa706c4f90a3977b81d0279127aafec2cfd055ead680

data/examples/us_enrichment_example.rb

@@ -33,6 +33,7 @@ class USEnrichmentAddressExample
     lookup.city = "Somerville"
     lookup.state = "NJ"
     lookup.zipcode = "08876"
+    #lookup.etag = "AUBAGDQDAIGQYCYC"
 
     # Or, create a freeform lookup to search using a single line address
     freeform_lookup = SmartyStreets::USEnrichment::Lookup.new

data/lib/smartystreets_ruby_sdk/errors.rb

@@ -1,4 +1,6 @@
 module SmartyStreets
+  NOT_MODIFIED = 'Not Modified: This data has not been modified since the last request. Please remove the etag header to fetch this data'.freeze
+
   BAD_CREDENTIALS = 'Unauthorized: The credentials were provided incorrectly or did not match any existing,
  active credentials.'.freeze
 

data/lib/smartystreets_ruby_sdk/exceptions.rb

@@ -3,6 +3,9 @@ module SmartyStreets
   class SmartyError < StandardError
   end
 
+  class NotModifiedInfo < SmartyError
+  end
+
   class BadCredentialsError < SmartyError
   end
 

data/lib/smartystreets_ruby_sdk/international_street/components.rb

@@ -12,7 +12,8 @@ module SmartyStreets
                   :sub_building_name, :postal_code, :dependent_locality, :premise_type, :sub_building_number,
                   :super_administrative_area, :premise_extra, :dependent_thoroughfare_predirection,
                   :building_trailing_type, :thoroughfare_predirection, :building_name, :level_type, :level_number,
-                  :country_iso_3, :sub_building_type
+                  :country_iso_3, :sub_building_type, :additional_content, :delivery_installation, :delivery_installation_type,
+                  :delivery_installation_qualifier_name, :route, :route_number, :route_type
 
       def initialize(obj)
         @country_iso_3 = obj.fetch('country_iso_3', nil)
@@ -58,6 +59,13 @@ module SmartyStreets
         @post_box = obj.fetch('post_box', nil)
         @post_box_type = obj.fetch('post_box_type', nil)
         @post_box_number = obj.fetch('post_box_number', nil)
+        @additional_content = obj.fetch('additional_content', nil)
+        @delivery_installation = obj.fetch('delivery_installation', nil)
+        @delivery_installation_type = obj.fetch('delivery_installation_type', nil)
+        @delivery_installation_qualifier_name = obj.fetch('delivery_installation_qualifier_name', nil)
+        @route = obj.fetch('route', nil)
+        @route_number = obj.fetch('route_number', nil)
+        @route_type = obj.fetch('route_type', nil)
       end
     end
   end

data/lib/smartystreets_ruby_sdk/status_code_sender.rb

@@ -35,6 +35,8 @@ module SmartyStreets
 
     def assign_exception(response)
       response.error = case response.status_code
+                         when '304'          
+                           NotModifiedInfo.new(NOT_MODIFIED)
                          when '401'
                            BadCredentialsError.new(BAD_CREDENTIALS)
                          when '402'

data/lib/smartystreets_ruby_sdk/us_enrichment/client.rb

@@ -83,6 +83,10 @@ module SmartyStreets
                 smarty_request = Request.new
 
                 return if lookup.nil?
+
+                if (!lookup.etag.nil?)
+                    smarty_request.header["ETAG"] = lookup.etag
+                end
                 if (lookup.smarty_key.nil?)
                     if (lookup.data_sub_set.nil?)
                         smarty_request.url_components = '/search/' + lookup.data_set
@@ -113,19 +117,19 @@ module SmartyStreets
                 results.each do |raw_result|
                     result = nil
                     if lookup.data_sub_set == "financial"
-                        result = USEnrichment::Property::Financial::Response.new(raw_result)
+                        result = USEnrichment::Property::Financial::Response.new(raw_result, response.header['etag'])
                     end
                     if lookup.data_sub_set == "principal"
-                        result = USEnrichment::Property::Principal::Response.new(raw_result)
+                        result = USEnrichment::Property::Principal::Response.new(raw_result, response.header['etag'])
                     end
                     if lookup.data_set == "geo-reference"
-                      result = USEnrichment::GeoReference::Response.new(raw_result)
+                      result = USEnrichment::GeoReference::Response.new(raw_result, response.header['etag'])
                     end
                     if lookup.data_set == "secondary"
                       if lookup.data_sub_set == "count"
-                        result = USEnrichment::Secondary::Count::Response.new(raw_result)
+                        result = USEnrichment::Secondary::Count::Response.new(raw_result, response.header['etag'])
                       elsif lookup.data_sub_set.nil?
-                        result = USEnrichment::Secondary::Response.new(raw_result)
+                        result = USEnrichment::Secondary::Response.new(raw_result, response.header['etag'])
                       end
                     end
                     output << result

data/lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/lookup.rb

@@ -2,12 +2,13 @@ module SmartyStreets
   module USEnrichment
     module GeoReference
       class Lookup
-        attr_reader :smarty_key, :data_set, :data_sub_set
+        attr_reader :smarty_key, :data_set, :data_sub_set, :etag
 
-        def initialize(smarty_key)
+        def initialize(smarty_key, etag=nil)
           @smarty_key = smarty_key
           @data_set = 'geo-reference'
           @data_sub_set = nil
+          @etag = etag
         end
       end
     end

data/lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/response.rb

@@ -4,12 +4,13 @@ module SmartyStreets
   module USEnrichment
     module GeoReference
       class Response
-        attr_reader :smarty_key, :data_set, :attributes
+        attr_reader :smarty_key, :data_set, :attributes, :etag
 
-        def initialize(obj)
+        def initialize(obj, etag=nil)
           @smarty_key = obj['smarty_key']
           @data_set = 'geo-reference'
           @attributes = Attributes.new(obj['attributes'])
+          @etag = etag
         end
       end
     end

data/lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb

@@ -2,9 +2,9 @@ require_relative '../json_able'
 module SmartyStreets
   module USEnrichment
     class Lookup < JSONAble
-      attr_accessor :smarty_key, :data_set, :data_sub_set, :freeform, :street, :city, :state, :zipcode
+      attr_accessor :smarty_key, :data_set, :data_sub_set, :freeform, :street, :city, :state, :zipcode, :etag
               
-      def initialize(smarty_key=nil, data_set=nil, data_sub_set=nil, freeform=nil, street=nil, city=nil, state=nil, zipcode=nil)
+      def initialize(smarty_key=nil, data_set=nil, data_sub_set=nil, freeform=nil, street=nil, city=nil, state=nil, zipcode=nil, etag=nil)
         @smarty_key = smarty_key
         @data_set = data_set
         @data_sub_set = data_sub_set
@@ -13,6 +13,7 @@ module SmartyStreets
         @city = city
         @state = state
         @zipcode = zipcode
+        @etag = etag
       end
     end
   end

data/lib/smartystreets_ruby_sdk/us_enrichment/property/financial/lookup.rb

@@ -3,12 +3,13 @@ module SmartyStreets
         module Property
             module Financial
                 class Lookup
-                    attr_reader :smarty_key, :data_set, :data_sub_set
+                    attr_reader :smarty_key, :data_set, :data_sub_set, :etag
                     
-                    def initialize(smarty_key)
+                    def initialize(smarty_key, etag=nil)
                         @smarty_key = smarty_key
                         @data_set = "property"
                         @data_sub_set = "financial"
+                        @etag = etag
                     end
                 end
             end

data/lib/smartystreets_ruby_sdk/us_enrichment/property/financial/response.rb

@@ -5,13 +5,14 @@ module SmartyStreets
         module Property
             module Financial
                 class Response
-                    attr_reader :smarty_key, :data_set, :data_sub_set, :attributes
+                    attr_reader :smarty_key, :data_set, :data_sub_set, :attributes, :etag
             
-                    def initialize(obj)
+                    def initialize(obj, etag=nil)
                         @smarty_key = obj['smarty_key']
                         @data_set = obj['data_set']
                         @data_sub_set = obj['data_sub_set']
                         @attributes = Attributes.new(obj['attributes'])
+                        @etag = etag
                     end
                 end
             end

data/lib/smartystreets_ruby_sdk/us_enrichment/property/principal/lookup.rb

@@ -3,12 +3,13 @@ module SmartyStreets
         module Property
             module Principal
                 class Lookup
-                    attr_reader :smarty_key, :data_set, :data_sub_set
+                    attr_reader :smarty_key, :data_set, :data_sub_set, :etag
                     
-                    def initialize(smarty_key)
+                    def initialize(smarty_key, etag=nil)
                         @smarty_key = smarty_key
                         @data_set = "property"
                         @data_sub_set = "principal"
+                        @etag = etag
                     end
                 end
             end

data/lib/smartystreets_ruby_sdk/us_enrichment/property/principal/response.rb

@@ -5,13 +5,14 @@ module SmartyStreets
         module Property
             module Principal
                 class Response
-                    attr_reader :smarty_key, :data_set, :data_sub_set, :attributes
+                    attr_reader :smarty_key, :data_set, :data_sub_set, :attributes, :etag
             
-                    def initialize(obj)
+                    def initialize(obj, etag=nil)
                         @smarty_key = obj['smarty_key']
                         @data_set = obj['data_set']
                         @data_sub_set = obj['data_sub_set']
                         @attributes = Attributes.new(obj['attributes'])
+                        @etag = etag
                     end
                 end
             end

data/lib/smartystreets_ruby_sdk/us_enrichment/secondary/count/lookup.rb

@@ -3,12 +3,13 @@ module SmartyStreets
     module Secondary
       module Count
         class Lookup
-          attr_reader :smarty_key, :data_set, :data_sub_set
+          attr_reader :smarty_key, :data_set, :data_sub_set, :etag
               
-          def initialize(smarty_key)
+          def initialize(smarty_key, etag=nil)
             @smarty_key = smarty_key
             @data_set = "secondary"
             @data_sub_set = "count"
+            @etag = etag
           end
         end
       end

data/lib/smartystreets_ruby_sdk/us_enrichment/secondary/count/response.rb

@@ -3,11 +3,12 @@ module SmartyStreets
     module Secondary
       module Count
         class Response
-          attr_reader :smarty_key, :count
+          attr_reader :smarty_key, :count, :etag
 
-          def initialize(obj)
+          def initialize(obj, etag=nil)
             @smarty_key = obj['smarty_key']
             @count = obj['count']
+            @etag = etag
           end
         end
       end

data/lib/smartystreets_ruby_sdk/us_enrichment/secondary/lookup.rb

@@ -2,12 +2,13 @@ module SmartyStreets
   module USEnrichment
     module Secondary
       class Lookup
-        attr_reader :smarty_key, :data_set, :data_sub_set
+        attr_reader :smarty_key, :data_set, :data_sub_set, :etag
               
-        def initialize(smarty_key)
+        def initialize(smarty_key, etag=nil)
           @smarty_key = smarty_key
           @data_set = "secondary"
           @data_sub_set = nil
+          @etag = etag
         end
       end
     end

data/lib/smartystreets_ruby_sdk/us_enrichment/secondary/response.rb

@@ -6,15 +6,16 @@ module SmartyStreets
   module USEnrichment
     module Secondary
       class Response
-        attr_reader :smarty_key, :root_address, :aliases, :secondaries
+        attr_reader :smarty_key, :root_address, :aliases, :secondaries, :etag
 
-        def initialize(obj)
+        def initialize(obj, etag=nil)
           @smarty_key = obj['smarty_key']
           @root_address = Secondary::RootAddressEntry.new(obj['root_address'])
           if !obj['aliases'].nil?
             @aliases = createAliasesArray(obj['aliases'])
           end
           @secondaries = createSecondariesArray(obj['secondaries'])
+          @etag=etag
         end
 
         def createAliasesArray(obj)

data/lib/smartystreets_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreets
-  VERSION = '5.20.2' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '5.20.4' # 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.20.2
+  version: 5.20.4
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-23 00:00:00.000000000 Z
+date: 2024-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler