smartystreets_ruby_sdk 5.13.0 → 5.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 423a76efb5b1f719deb33c17e0a7799e9ed6a6e7b6b570a2ffb19d1fb5aa89d1
-  data.tar.gz: 6b307ac880704d629a735f3d32f0535e7cee3678ebef7db6611f01299c786b72
+  metadata.gz: eb354ac31fa7cc2bd045b1bb7877e8a0daf5b491d3863d23ea27ace3f38ed637
+  data.tar.gz: 86ad9f8c1371467d314f59e0f7f7588e5c66d10fcf4d6ba039cdf7afedfa6295
 SHA512:
-  metadata.gz: 509b66bf2ea805128a40c0603be38d283407015c9e179e2c635bad3b947efd228a287fd52959b24b80a7682c4ccadbd8e6b7f7750f04766d9b4a5cac42f8377d
-  data.tar.gz: 343069ee8fd58bea6f4c90bdf90baa5cd050456c0521d93f2fa43064ea04d1d524c3e027ec83dd14844dae66f04f62d74a85fd7c8cc806b4bbd5375fb7700c26
+  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/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/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreets
-  VERSION = '5.13.0' # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartystreets_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 5.13.0
+  version: 5.14.0
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2021-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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