smartystreets_ruby_sdk 5.11.2 → 5.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cab0fb9db3564b7caedea4931eafe8e57a5ada51972384880bc1a4a039a7ab7
-  data.tar.gz: 41de034cf22edcc134ff1b03bbef740235d78703e873e3c195cdcb4df890b5af
+  metadata.gz: eb354ac31fa7cc2bd045b1bb7877e8a0daf5b491d3863d23ea27ace3f38ed637
+  data.tar.gz: 86ad9f8c1371467d314f59e0f7f7588e5c66d10fcf4d6ba039cdf7afedfa6295
 SHA512:
-  metadata.gz: 68c005e8b8998c1fb75360740c749a5b55062aeb6ba7d32820e4da91794b0d2dece81c04f6021e2a9f4802b0f2ed9c9dfdf4111157ed973971352b656da1a261
-  data.tar.gz: 9d38f269c9203f7d5845ee1c04454ed5cf89ef846b4a07a189fcd74a229b9eb4e7b5df25355dfb4783ee0d09d1701b27ba7b31d864c45a6e5230af7063a12505
+  metadata.gz: 85550fb289d9a64084aaa321f7d71a13f95c6d2bd116e6ac81728c3ad12030182778899a00659124957975875c11b5c5d49b24ffa62feb09b1c712f114f82651
+  data.tar.gz: e3af8c142b7dbadae883ccb9b3af2e62cf37c242c3fe6dd214df13bfe1f1cbe0d1b993d695bbbb678fdf1a5ce8d529e58c9c8dba8bf15ca35296d8d8927c188a

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

@@ -30,6 +30,7 @@ class USAutocompleteProExample
     lookup.add_state_filter('IL')
     lookup.max_results = 5
     lookup.prefer_ratio = 3
+    lookup.source = "all"
 
     suggestions = client.send(lookup) # The client will also return the suggestions directly
 

data/examples/us_street_multiple_address_example.rb

@@ -36,7 +36,7 @@ class USStreetMultipleAddressExample
     batch[0].lastline = 'Mountain view, California'
     batch[0].zipcode = '21229'
     batch[0].candidates = 3
-    batch[0].match = 'invalid'.freeze # "invalid" is the most permissive match,
+    batch[0].match = Lookup.INVALID # "invalid" is the most permissive match,
                                       # this will always return at least one result even if the address is invalid.
                                       # Refer to the documentation for additional Match Strategy options.
 

data/examples/us_street_single_address_example.rb

@@ -34,7 +34,7 @@ class USStreetSingleAddressExample
     lookup.state = 'CA'
     lookup.zipcode = '21229'
     lookup.candidates = 3
-    lookup.match = 'invalid'.freeze # "invalid" is the most permissive match,
+    lookup.match = Lookup.INVALID # "invalid" is the most permissive match,
                                     # this will always return at least one result even if the address is invalid.
                                     # Refer to the documentation for additional Match Strategy options.
 

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,7 +126,12 @@ module SmartyStreets
       InternationalStreet::Client.new(build_sender, @serializer)
     end
 
-    def build_us_autocomplete_api_client
+    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)
     end

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/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

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/us_street/match_type.rb

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

data/lib/smartystreets_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreets
-  VERSION = '5.11.2' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '5.14.0' # 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.11.2
+  version: 5.14.0
 platform: ruby
 authors:
 - SmartyStreets SDK Team
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-06 00:00:00.000000000 Z
+date: 2021-10-05 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
@@ -72,7 +72,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.0
-description: 
+description:
 email:
 - support@smartystreets.com
 executables: []
@@ -90,8 +90,8 @@ files:
 - bin/console
 - bin/setup
 - docker-compose.yml
+- examples/international_autocomplete_example.rb
 - examples/international_example.rb
-- examples/us_autocomplete_example.rb
 - examples/us_autocomplete_pro_example.rb
 - examples/us_extract_example.rb
 - examples/us_reverse_geo_example.rb
@@ -105,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
@@ -175,7 +178,7 @@ homepage: https://github.com/smartystreets/smartystreets-ruby-sdk
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -190,8 +193,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: An official library for the SmartyStreets APIs
 test_files: []

data/examples/us_autocomplete_example.rb

@@ -1,52 +0,0 @@
-require 'smartystreets_ruby_sdk/static_credentials'
-require 'smartystreets_ruby_sdk/client_builder'
-require 'smartystreets_ruby_sdk/us_autocomplete/lookup'
-
-class USAutocompleteExample
-  Lookup = SmartyStreets::USAutocomplete::Lookup
-
-  def run
-    auth_id = 'Your SmartyStreets Auth ID here'
-    auth_token = 'Your SmartyStreets Auth Token here'
-
-    # We recommend storing your secret keys in environment variables instead---it's safer!
-    # auth_id = ENV['SMARTY_AUTH_ID']
-    # auth_token = ENV['SMARTY_AUTH_TOKEN']
-
-    credentials = SmartyStreets::StaticCredentials.new(auth_id, auth_token)
-    client = SmartyStreets::ClientBuilder.new(credentials).build_us_autocomplete_api_client
-
-    # 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_suggestions = 10
-
-    client.send(lookup)
-
-    puts '*** Result with no filter ***'
-    puts
-    lookup.result.each do |suggestion|
-      puts suggestion.text
-    end
-
-    lookup.add_city_filter('Ogden')
-    lookup.add_state_filter('IL')
-    lookup.add_prefer('Ogden, IL')
-    lookup.max_suggestions = 5
-    lookup.prefer_ratio = 0.333333
-
-    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.text
-    end
-
-  end
-end
-
-USAutocompleteExample.new.run