smartystreets_ruby_sdk 5.17.2 → 5.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bb4d7f95acdc304c855640ce81cb93563af039289bbae4c09bf36789878004f
-  data.tar.gz: 482c9eb3f4b9b70eb2490dea7d7bbaa627e4a744bea5e852737c80bf4e7f3d39
+  metadata.gz: a2e3dc88790963736ff42822f302051343efd6d2609fec588c3349f1469d88bd
+  data.tar.gz: 8cb33654006b0be0a7b7563490758c4098ee2aec334a34c735ce973170d499b6
 SHA512:
-  metadata.gz: 18a812e046d3353bfb8b29f7964fe239ca8a469d327d66d46ca44f7f53cd908df8e080d9a191e49f4ce06799c025745c060ae36603db356186f25aba732e9cd9
-  data.tar.gz: f103c20ec45c229dbe503c529f633beb7d44f66b7c32502fa4eccf0e370ed78f83430d9295d62dda97ac4d591a47c80937134bfb6cab9d9a7036c02ecf946822
+  metadata.gz: 3339ead2a561e4273f7fc64b47f4964848185eee5e29f1e89cdac838f0807456ecc687278120e81703beb50a15d9966c281aaa3ddd3b79593bb283c3fb1c507d
+  data.tar.gz: 9a1adbea48489171695f2b5bf6022b07a6c618c46f70a2a9b5d1a8583d5c4f98ad58a38860c7632fa15ef8de286178615a9193a56ed63da32de4faf82b77e72c

data/.gitignore

@@ -2,3 +2,4 @@
 .idea
 coverage
 *.gem
+/smartystreets-ruby-sdk.iml

data/lib/smartystreets_ruby_sdk/client_builder.rb

@@ -12,7 +12,6 @@ require_relative 'custom_header_sender'
 require_relative 'us_street/client'
 require_relative 'us_zipcode/client'
 require_relative 'us_extract/client'
-require_relative 'us_autocomplete/client'
 require_relative 'international_street/client'
 require_relative 'international_autocomplete/client'
 require_relative 'us_reverse_geo/client'
@@ -26,7 +25,6 @@ module SmartyStreets
   class ClientBuilder
     INTERNATIONAL_STREET_API_URL = 'https://international-street.api.smarty.com/verify'.freeze
     INTERNATIONAL_AUTOCOMPLETE_API_URL = "https://international-autocomplete.api.smarty.com/v2/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
@@ -134,11 +132,6 @@ module SmartyStreets
       InternationalAutocomplete::Client.new(build_sender, @serializer)
     end
 
-    def build_us_autocomplete_api_client # Deprecated
-      ensure_url_prefix_not_null(US_AUTOCOMPLETE_API_URL)
-      USAutocomplete::Client.new(build_sender, @serializer)
-    end
-
     def build_us_autocomplete_pro_api_client
       ensure_url_prefix_not_null(US_AUTOCOMPLETE_PRO_API_URL)
       USAutocompletePro::Client.new(build_sender, @serializer)

data/lib/smartystreets_ruby_sdk/us_autocomplete_pro/client.rb

@@ -44,7 +44,7 @@ module SmartyStreets
         add_parameter(request, 'prefer_zip_codes', build_filter_string(lookup.prefer_zip_codes))
         add_parameter(request, 'prefer_ratio', lookup.prefer_ratio.to_s)
         add_parameter(request, 'source', lookup.source)
-        if lookup.prefer_zip_codes or lookup.zip_filter
+        if lookup.prefer_zip_codes.any? || lookup.zip_filter.any?
           request.parameters['prefer_geolocation'] = GeolocationType::NONE
         else
           add_parameter(request, 'prefer_geolocation', lookup.prefer_geolocation)

data/lib/smartystreets_ruby_sdk/us_street/lookup.rb

@@ -6,7 +6,7 @@ module SmartyStreets
     #
     # See "https://smartystreets.com/docs/cloud/us-street-api#input-fields"
     #
-    # @match:: Must be set to 'strict', 'range', or 'invalid'. Constants for these are in match_type.rb
+    # @match:: Must be set to 'strict', 'enhanced', 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, :format, :result

data/lib/smartystreets_ruby_sdk/us_street/match_type.rb

@@ -2,7 +2,6 @@ module SmartyStreets
   module USStreet
     module MatchType
       STRICT = 'strict'.freeze
-      RANGE = 'range'.freeze # Deprecated
       INVALID = 'invalid'.freeze
       ENHANCED = 'enhanced'.freeze
     end

data/lib/smartystreets_ruby_sdk/version.rb

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

data/lib/smartystreets_ruby_sdk.rb

@@ -1,7 +1,6 @@
 require 'smartystreets_ruby_sdk/version'
 require 'smartystreets_ruby_sdk/logger'
 require 'smartystreets_ruby_sdk/sleeper'
-
 require 'smartystreets_ruby_sdk/batch'
 require 'smartystreets_ruby_sdk/client_builder'
 require 'smartystreets_ruby_sdk/custom_header_sender'
@@ -20,11 +19,9 @@ require 'smartystreets_ruby_sdk/signing_sender'
 require 'smartystreets_ruby_sdk/static_credentials'
 require 'smartystreets_ruby_sdk/status_code_sender'
 require 'smartystreets_ruby_sdk/url_prefix_sender'
-
 require 'smartystreets_ruby_sdk/us_extract'
 require 'smartystreets_ruby_sdk/us_street'
 require 'smartystreets_ruby_sdk/us_zipcode'
-require 'smartystreets_ruby_sdk/us_autocomplete'
 require 'smartystreets_ruby_sdk/us_autocomplete_pro'
 require 'smartystreets_ruby_sdk/international_street'
 require 'smartystreets_ruby_sdk/international_autocomplete'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartystreets_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 5.17.2
+  version: 5.18.0
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2024-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,11 +136,6 @@ files:
 - lib/smartystreets_ruby_sdk/static_credentials.rb
 - lib/smartystreets_ruby_sdk/status_code_sender.rb
 - lib/smartystreets_ruby_sdk/url_prefix_sender.rb
-- lib/smartystreets_ruby_sdk/us_autocomplete.rb
-- lib/smartystreets_ruby_sdk/us_autocomplete/client.rb
-- lib/smartystreets_ruby_sdk/us_autocomplete/geolocation_type.rb
-- lib/smartystreets_ruby_sdk/us_autocomplete/lookup.rb
-- lib/smartystreets_ruby_sdk/us_autocomplete/suggestion.rb
 - lib/smartystreets_ruby_sdk/us_autocomplete_pro.rb
 - lib/smartystreets_ruby_sdk/us_autocomplete_pro/client.rb
 - lib/smartystreets_ruby_sdk/us_autocomplete_pro/geolocation_type.rb

data/lib/smartystreets_ruby_sdk/us_autocomplete/client.rb

@@ -1,72 +0,0 @@
-require_relative '../request'
-require_relative '../exceptions'
-require_relative 'geolocation_type'
-require_relative 'suggestion'
-
-module SmartyStreets
-  module USAutocomplete
-    # It is recommended to instantiate this class using ClientBuilder.build_us_autocomplete_api_client
-    class Client
-      def initialize(sender, serializer)
-        @sender = sender
-        @serializer = serializer
-      end
-
-      # Sends a Lookup object to the US Autocomplete API and stores the result in the Lookup's result field.
-      def send(lookup)
-        if not lookup or not lookup.prefix
-          raise SmartyStreets::SmartyError, 'Send() must be passed a Lookup with the prefix field set.'
-        end
-
-        request = build_request(lookup)
-
-        response = @sender.send(request)
-
-        raise response.error if response.error
-
-        result = @serializer.deserialize(response.payload)
-        suggestions = convert_suggestions(result.fetch('suggestions', []))
-        lookup.result = suggestions
-      end
-
-
-      def build_request(lookup)
-        request = Request.new
-
-        add_parameter(request, 'prefix', lookup.prefix)
-        add_parameter(request, 'suggestions', lookup.max_suggestions.to_s)
-        add_parameter(request, 'city_filter', build_filter_string(lookup.city_filter))
-        add_parameter(request, 'state_filter', build_filter_string(lookup.state_filter))
-        add_parameter(request, 'prefer', build_filter_string(lookup.prefer))
-        add_parameter(request, 'prefer_ratio', lookup.prefer_ratio.to_s)
-        if lookup.geolocate_type != GeolocationType::NONE
-          request.parameters['geolocate'] = 'true'
-          request.parameters['geolocate_precision'] = lookup.geolocate_type
-        else
-          request.parameters['geolocate'] = 'false'
-        end
-
-        request
-      end
-
-      def build_filter_string(filter_list)
-        filter_list ? filter_list.join(',') : nil
-      end
-
-      def convert_suggestions(suggestion_hashes)
-        converted_suggestions = []
-        return converted_suggestions if suggestion_hashes.nil?
-
-        suggestion_hashes.each do |suggestion|
-          converted_suggestions.push(USAutocomplete::Suggestion.new(suggestion))
-        end
-
-        converted_suggestions
-      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/us_autocomplete/geolocation_type.rb

@@ -1,9 +0,0 @@
-module SmartyStreets
-  module USAutocomplete
-    module GeolocationType
-      CITY = 'city'
-      STATE = 'state'
-      NONE = 'null'
-    end
-  end
-end

data/lib/smartystreets_ruby_sdk/us_autocomplete/lookup.rb

@@ -1,38 +0,0 @@
-require_relative '../json_able'
-
-module SmartyStreets
-  module USAutocomplete
-    # In addition to holding all of the input data for this lookup, this class also will contain the result
-    # of the lookup after it comes back from the API.
-    #
-    # See "https://smartystreets.com/docs/cloud/us-autocomplete-api#http-request-input-fields"
-    class Lookup < JSONAble
-
-      attr_accessor :result, :prefix, :state_filter, :prefer, :prefer_ratio, :max_suggestions, :geolocate_type, :city_filter
-
-      def initialize(prefix=nil, suggestions=nil, city_filter=nil, state_filter=nil,
-                     prefer=nil, prefer_ratio=nil, geolocate_type=nil)
-        @result = []
-        @prefix = prefix
-        @max_suggestions = suggestions
-        @city_filter = city_filter ? city_filter : []
-        @state_filter = state_filter ? state_filter : []
-        @prefer = prefer ? prefer : []
-        @prefer_ratio = prefer_ratio
-        @geolocate_type = geolocate_type
-      end
-
-      def add_city_filter(city)
-        @city_filter.push(city)
-      end
-
-      def add_state_filter(state)
-        @state_filter.push(state)
-      end
-
-      def add_prefer(prefer)
-        @prefer.push(prefer)
-      end
-    end
-  end
-end

data/lib/smartystreets_ruby_sdk/us_autocomplete/suggestion.rb

@@ -1,16 +0,0 @@
-module SmartyStreets
-  module USAutocomplete
-    # See "https://smartystreets.com/docs/cloud/us-autocomplete-api#http-response"
-    class Suggestion
-
-      attr_reader :text, :street_line, :state, :city
-
-      def initialize(obj)
-        @text = obj.fetch('text', nil)
-        @street_line = obj.fetch('street_line', nil)
-        @city = obj.fetch('city', nil)
-        @state = obj.fetch('state', nil)
-      end
-    end
-  end
-end

data/lib/smartystreets_ruby_sdk/us_autocomplete.rb

@@ -1,9 +0,0 @@
-require_relative './us_autocomplete/lookup'
-require_relative './us_autocomplete/geolocation_type'
-require_relative './us_autocomplete/suggestion'
-require_relative './us_autocomplete/client'
-
-module SmartyStreets
-  module USAutocomplete
-  end
-end