smartystreets_ruby_sdk 5.12.1 → 5.14.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9b875a25fbdd31a426fa6fdfb61dfc62d2fce2c8a1e5b9baebf6933076bf77b
-  data.tar.gz: 9aab93b22abe5671ed4a63e0482f44a995e1871e3ad02459d10e53f40eb2107c
+  metadata.gz: 9d02af89c4f23a2ee8609900f75bd708036b0a5bccaa34e51d0d3100cc2df8b5
+  data.tar.gz: 9fb18a334690fe5fc8420c1a1dcc30374a7162603469201a8c7abae01259b220
 SHA512:
-  metadata.gz: 9ad7fd90449fcea0eb99a810366f4f428295b0e14e54e30af98cd3935206bd9dfdad4e8e31667f434a7ccefb4422a5299133189822ee4c8bee264d5a1a147e4f
-  data.tar.gz: 2ccab08012c1ce1c88100353e908d5c83c3a6d4831fc9705e6b5ce035553ec05652cc6fc3973166897dc221b7c5ad3fb411d689d529eff11caa37e38876959fa
+  metadata.gz: a424c5a78886aaab175634774bd8abfc33ddd673d909eade4f1159a75ceebaaa3b3001a8dd46ec8fa388736a02891fa4e5e396a3faa1d69e7f8de7941e075bca
+  data.tar.gz: 5396e88defd12c5899346cee54de6f663f40575460e51765e0fbda1a05f8a9c6ed8cd5f68c9040b074576bb3b5f550fe2154b8bb3f95c0ff39ba9c51c37357b4

data/examples/international_autocomplete_example.rb

@@ -0,0 +1,47 @@
+require 'smartystreets_ruby_sdk/shared_credentials'
+require '../lib/smartystreets_ruby_sdk/client_builder'
+require '../lib/smartystreets_ruby_sdk/international_autocomplete/lookup'
+require '../lib/smartystreets_ruby_sdk/international_autocomplete/client'
+
+class USAutocompleteProExample
+  Lookup = SmartyStreets::InternationalAutocomplete::Lookup
+
+  def run
+    # key = 'Your SmartyStreets Auth ID here'
+    # hostname = 'Your SmartyStreets Auth Token here'
+
+    # 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)
+
+    # The appropriate license values to be used for your subscriptions
+    # can be found on the Subscriptions page of the account dashboard.
+    # https://www.smartystreets.com/docs/cloud/licensing
+    client = SmartyStreets::ClientBuilder.new(credentials).with_licenses(['international-autocomplete-cloud'])
+                 .build_international_autocomplete_api_client
+
+    # Documentation for input fields can be found at:
+    # https://smartystreets.com/docs/cloud/us-autocomplete-api
+
+    lookup = Lookup.new('Louis')
+    lookup.country = "FRA"
+    lookup.locality = "Paris"
+
+    suggestions = client.send(lookup) # The client will also return the suggestions directly
+
+    puts
+    puts '*** Result with some filters ***'
+    puts
+
+    suggestions.each do |suggestion|
+      puts "#{suggestion.street} #{suggestion.locality}, #{suggestion.country_iso3}"
+    end
+
+  end
+end
+
+USAutocompleteProExample.new.run
+
+

data/examples/us_autocomplete_pro_example.rb

@@ -24,12 +24,14 @@ class USAutocompleteProExample
     # Documentation for input fields can be found at:
     # https://smartystreets.com/docs/cloud/us-autocomplete-api
 
-    lookup = Lookup.new('4770 Lincoln Ave O')
-    lookup.max_results = 10
-    lookup.add_city_filter('Ogden')
-    lookup.add_state_filter('IL')
+    lookup = Lookup.new('1042 W Center')
+    lookup.add_state_filter('CO')
+    lookup.add_state_filter('UT')
+    lookup.add_city_filter('Denver')
+    lookup.add_city_filter('Orem')
     lookup.max_results = 5
     lookup.prefer_ratio = 3
+    lookup.source = "all"
 
     suggestions = client.send(lookup) # The client will also return the suggestions directly
 

data/lib/smartystreets_ruby_sdk/client_builder.rb

@@ -23,6 +23,7 @@ module SmartyStreets
   # 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
@@ -125,6 +126,11 @@ module SmartyStreets
       InternationalStreet::Client.new(build_sender, @serializer)
     end
 
+    def build_international_autocomplete_api_client
+      ensure_url_prefix_not_null(INTERNATIONAL_AUTOCOMPLETE_API_URL)
+      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)

data/lib/smartystreets_ruby_sdk/international_autocomplete/client.rb

@@ -0,0 +1,61 @@
+require_relative '../request'
+require_relative '../exceptions'
+require_relative 'suggestion'
+
+module SmartyStreets
+  module InternationalAutocomplete
+    # It is recommended to instantiate this class using ClientBuilder.build_international_autocomplete_api_client
+    class Client
+      def initialize(sender, serializer)
+        @sender = sender
+        @serializer = serializer
+      end
+
+      # Sends a Lookup object to the International Autocomplete API and stores the result in the Lookup's result field.
+      def send(lookup)
+        if not lookup or not lookup.search
+          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)
+        lookup.result = suggestions
+      end
+
+
+      def build_request(lookup)
+        request = Request.new
+
+        add_parameter(request, 'search', lookup.search)
+        add_parameter(request, 'country', lookup.country)
+        add_parameter(request, 'include_only_administrative_area', lookup.administrative_area)
+        add_parameter(request, 'include_only_locality', lookup.locality)
+        add_parameter(request, 'include_only_postal_code', lookup.postal_code)
+
+        request
+      end
+
+      def convert_suggestions(suggestion_hashes)
+        converted_suggestions = []
+        return converted_suggestions if suggestion_hashes.nil?
+
+        suggestion_hashes.each do |suggestion|
+          converted_suggestions.push(InternationalAutocomplete::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/international_autocomplete/lookup.rb

@@ -0,0 +1,21 @@
+require_relative '../json_able'
+
+module SmartyStreets
+  module InternationalAutocomplete
+    # 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.
+    class Lookup < JSONAble
+
+      attr_accessor :result, :search, :country, :administrative_area, :locality, :postal_code
+
+      def initialize(search=nil, country=nil, administrative_area=nil, locality=nil, postal_code=nil)
+        @result = []
+        @search = search
+        @country = country
+        @administrative_area = administrative_area
+        @locality = locality
+        @postal_code = postal_code
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/international_autocomplete/suggestion.rb

@@ -0,0 +1,16 @@
+module SmartyStreets
+  module InternationalAutocomplete
+    class Suggestion
+
+      attr_reader :street, :locality, :administrative_area, :postal_code, :country_iso3
+
+      def initialize(obj)
+        @street = obj.fetch('street', nil)
+        @locality = obj.fetch('locality', nil)
+        @administrative_area = obj.fetch('administrative_area', nil)
+        @postal_code = obj.fetch('postal_code', nil)
+        @country_iso3 = obj.fetch('country_iso3', nil)
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/native_sender.rb

@@ -17,6 +17,7 @@ module SmartyStreets
         http = build_http(request)
         http.use_ssl = true
         http.ssl_version = :TLSv1_2
+        http.open_timeout = @max_timeout
         http.read_timeout = @max_timeout
 
         response = http.request(request)

data/lib/smartystreets_ruby_sdk/us_autocomplete_pro/client.rb

@@ -43,6 +43,7 @@ module SmartyStreets
         add_parameter(request, 'prefer_states', build_filter_string(lookup.prefer_states))
         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
           request.parameters['prefer_geolocation'] = GeolocationType::NONE
         else
@@ -54,7 +55,7 @@ module SmartyStreets
       end
 
       def build_filter_string(filter_list)
-        filter_list ? filter_list.join(',') : nil
+        filter_list ? filter_list.join(';') : nil
       end
 
       def convert_suggestions(suggestion_hashes)

data/lib/smartystreets_ruby_sdk/us_autocomplete_pro/lookup.rb

@@ -9,11 +9,12 @@ module SmartyStreets
     class Lookup < JSONAble
 
       attr_accessor :result, :search, :max_results, :city_filter, :state_filter, :zip_filter,
-                    :exclude_states, :prefer_cities, :prefer_states, :prefer_zip_codes, :prefer_ratio, :prefer_geolocation, :selected
+                    :exclude_states, :prefer_cities, :prefer_states, :prefer_zip_codes, :prefer_ratio,
+                    :prefer_geolocation, :selected, :source
 
       def initialize(search=nil, max_results=nil, city_filter=nil, state_filter=nil, zip_filter=nil,
                      exclude_states=nil, prefer_cities=nil, prefer_states=nil, prefer_zips=nil, prefer_ratio=nil,
-                     prefer_geolocation=nil, selected=nil)
+                     prefer_geolocation=nil, selected=nil, source=nil)
         @result = []
         @search = search
         @max_results = max_results
@@ -27,6 +28,7 @@ module SmartyStreets
         @prefer_ratio = prefer_ratio
         @prefer_geolocation = prefer_geolocation
         @selected = selected
+        @source = source
       end
 
       def add_city_filter(city)

data/lib/smartystreets_ruby_sdk/version.rb

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

data/smartystreets_ruby_sdk.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 2.2.27'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'minitest', '~> 5.8', '>= 5.8.3'
   spec.add_development_dependency 'simplecov', '~> 0.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartystreets_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 5.12.1
+  version: 5.14.3
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-20 00:00:00.000000000 Z
+date: 2021-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.2.27
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.2.27
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -90,6 +90,7 @@ files:
 - bin/console
 - bin/setup
 - docker-compose.yml
+- examples/international_autocomplete_example.rb
 - examples/international_example.rb
 - examples/us_autocomplete_pro_example.rb
 - examples/us_extract_example.rb
@@ -104,6 +105,9 @@ files:
 - lib/smartystreets_ruby_sdk/custom_header_sender.rb
 - lib/smartystreets_ruby_sdk/errors.rb
 - lib/smartystreets_ruby_sdk/exceptions.rb
+- 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_street.rb
 - lib/smartystreets_ruby_sdk/international_street/analysis.rb
 - lib/smartystreets_ruby_sdk/international_street/candidate.rb