smartystreets_ruby_sdk 5.9.2 → 5.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3bf47c1d7fc05162f580218523c230a1831b5d3a7db41114632ffff8edcd715
-  data.tar.gz: c88966f71a4516c4e89077411eb171ccd8074b7f5d9897c551eb1faf977f2415
+  metadata.gz: f89f84d4011a28b76ab8d465d6739df79e5a1627913aba1727a86db053e3af30
+  data.tar.gz: 4a14fd611da96954d6741aa14298f86e6348deeae245306d10eb52630f23a670
 SHA512:
-  metadata.gz: 2d6c3fb74acd909a9c8c3faa5ccff9ab59fc8edc7a515b3ba265318f75eebeeb42cc24e63714050bdc61ee1dd49ab62a7e85c0f0034e248e143460e9d8fb8c34
-  data.tar.gz: 938c7cfcdc00f22924c66668d25446425a27edc43839193c959b41452f68ea250de64c99790f4c764699e0a180b9c19c35586dd8c57c8b906ddbe2378f20a817
+  metadata.gz: 2e2d508cb7906c19db797a60feb00adbd5e132e4aadd2b656b7e362253a74308a1e792bef5e8216b2e1bb741ccd5228a86e329ea16835151d1cf094b5097dbe7
+  data.tar.gz: 7bf6945deeb19c48e22bd3f5aa78b42e5aa4a678a977c6a9aeef00fa4457423e7748e69e8a4f4f9798683c618e2a24c2b55f632f86c50d2541b03717f8f382bf

data/examples/us_autocomplete_pro_example.rb

@@ -0,0 +1,43 @@
+require 'smartystreets_ruby_sdk/shared_credentials'
+require '../lib/smartystreets_ruby_sdk/client_builder'
+require '../lib/smartystreets_ruby_sdk/us_autocomplete_pro/lookup'
+
+class USAutocompleteProExample
+  Lookup = SmartyStreets::USAutocompletePro::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)
+    client = SmartyStreets::ClientBuilder.new(credentials).build_us_autocomplete_pro_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_results = 10
+    lookup.add_city_filter('Ogden')
+    lookup.add_state_filter('IL')
+    lookup.max_results = 5
+    lookup.prefer_ratio = 3
+
+    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_line} #{suggestion.city}, #{suggestion.state}"
+    end
+
+  end
+end
+
+USAutocompleteProExample.new.run
+

data/lib/smartystreets_ruby_sdk.rb

@@ -25,6 +25,7 @@ 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/us_reverse_geo'
 

data/lib/smartystreets_ruby_sdk/client_builder.rb

@@ -15,6 +15,7 @@ require_relative 'us_extract/client'
 require_relative 'us_autocomplete/client'
 require_relative 'international_street/client'
 require_relative 'us_reverse_geo/client'
+require_relative 'us_autocomplete_pro/client'
 
 module SmartyStreets
   # The ClientBuilder class helps you build a client object for one of the supported SmartyStreets APIs.
@@ -23,6 +24,7 @@ module SmartyStreets
   class ClientBuilder
     INTERNATIONAL_STREET_API_URL = 'https://international-street.api.smartystreets.com/verify'.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
     US_STREET_API_URL = 'https://us-street.api.smartystreets.com/street-address'.freeze
     US_ZIP_CODE_API_URL = 'https://us-zipcode.api.smartystreets.com/lookup'.freeze
@@ -128,6 +130,11 @@ module SmartyStreets
       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)
+    end
+
     def build_us_extract_api_client
       ensure_url_prefix_not_null(US_EXTRACT_API_URL)
       USExtract::Client.new(build_sender, @serializer)

data/lib/smartystreets_ruby_sdk/shared_credentials.rb

@@ -6,7 +6,7 @@ module SmartyStreets
     end
 
     def sign(request)
-      request.parameters['auth-id'] = @id
+      request.parameters['key'] = @id
       request.referer = @host_name
     end
   end

data/lib/smartystreets_ruby_sdk/us_autocomplete_pro.rb

@@ -0,0 +1,10 @@
+require_relative './us_autocomplete_pro/lookup'
+require_relative './us_autocomplete_pro/geolocation_type'
+require_relative './us_autocomplete_pro/suggestion'
+require_relative './us_autocomplete_pro/client'
+
+module SmartyStreets
+  module USAutocompletePro
+  end
+end
+

data/lib/smartystreets_ruby_sdk/us_autocomplete_pro/client.rb

@@ -0,0 +1,77 @@
+require_relative '../request'
+require_relative '../exceptions'
+require_relative 'geolocation_type'
+require_relative 'suggestion'
+
+module SmartyStreets
+  module USAutocompletePro
+    # It is recommended to instantiate this class using ClientBuilder.build_us_autocomplete_pro_api_client
+    class Client
+      def initialize(sender, serializer)
+        @sender = sender
+        @serializer = serializer
+      end
+
+      # Sends a Lookup object to the US Autocomplete Pro 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.fetch('suggestions', []))
+        lookup.result = suggestions
+      end
+
+
+      def build_request(lookup)
+        request = Request.new
+
+        add_parameter(request, 'search', lookup.search)
+        add_parameter(request, 'max_results', lookup.max_results.to_s)
+        add_parameter(request, 'include_only_cities', build_filter_string(lookup.city_filter))
+        add_parameter(request, 'include_only_states', build_filter_string(lookup.state_filter))
+        add_parameter(request, 'include_only_zip_codes', build_filter_string(lookup.zip_filter))
+        add_parameter(request, 'exclude_states', build_filter_string(lookup.exclude_states))
+        add_parameter(request, 'prefer_cities', build_filter_string(lookup.prefer_cities))
+        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)
+        if lookup.prefer_zip_codes or lookup.zip_filter
+          request.parameters['prefer_geolocation'] = GeolocationType::NONE
+        else
+          add_parameter(request, 'prefer_geolocation', lookup.prefer_geolocation)
+        end
+        add_parameter(request, 'selected', lookup.selected)
+
+        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(USAutocompletePro::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_pro/geolocation_type.rb

@@ -0,0 +1,8 @@
+module SmartyStreets
+  module USAutocompletePro
+    module GeolocationType
+      CITY = 'city'
+      NONE = 'none'
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_autocomplete_pro/lookup.rb

@@ -0,0 +1,61 @@
+require_relative '../json_able'
+
+module SmartyStreets
+  module USAutocompletePro
+    # 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, :search, :max_results, :city_filter, :state_filter, :zip_filter,
+                    :exclude_states, :prefer_cities, :prefer_states, :prefer_zip_codes, :prefer_ratio, :prefer_geolocation, :selected
+
+      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)
+        @result = []
+        @search = search
+        @max_results = max_results
+        @city_filter = city_filter ? city_filter : []
+        @state_filter = state_filter ? state_filter : []
+        @zip_filter = zip_filter ? zip_filter : []
+        @exclude_states = exclude_states ? exclude_states : []
+        @prefer_cities = prefer_cities ? prefer_cities : []
+        @prefer_states = prefer_states ? prefer_states : []
+        @prefer_zip_codes = prefer_zips ? prefer_zips : []
+        @prefer_ratio = prefer_ratio
+        @prefer_geolocation = prefer_geolocation
+        @selected = selected
+      end
+
+      def add_city_filter(city)
+        @city_filter.push(city)
+      end
+
+      def add_state_filter(state)
+        @state_filter.push(state)
+      end
+
+      def add_zip_filter(zip)
+        @zip_filter.push(zip)
+      end
+
+      def add_state_exclusion(state)
+        @exclude_states.push(state)
+      end
+
+      def add_preferred_city(city)
+        @prefer_cities.push(city)
+      end
+
+      def add_preferred_state(state)
+        @prefer_states.push(state)
+      end
+
+      def add_preferred_zip(zip)
+        @prefer_zip_codes.push(zip)
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_autocomplete_pro/suggestion.rb

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

data/lib/smartystreets_ruby_sdk/us_street/analysis.rb

@@ -3,13 +3,14 @@ module SmartyStreets
     # See "https://smartystreets.com/docs/cloud/us-street-api#analysis"
     class Analysis
       attr_reader :lacs_link_code, :active, :footnotes, :lacs_link_indicator, :dpv_match_code, :is_suite_link_match,
-                  :is_ews_match, :dpv_footnotes, :cmra, :vacant
+                  :is_ews_match, :dpv_footnotes, :cmra, :vacant, :no_stat
 
       def initialize(obj)
         @dpv_match_code = obj['dpv_match_code']
         @dpv_footnotes = obj['dpv_footnotes']
         @cmra = obj['dpv_cmra']
         @vacant = obj['dpv_vacant']
+        @no_stat = obj['dpv_no_stat']
         @active = obj['active']
         @is_ews_match = obj['ews_match']
         @footnotes = obj['footnotes']

data/lib/smartystreets_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreets
-  VERSION = '5.9.2' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '5.10.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.9.2
+  version: 5.10.0
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-01 00:00:00.000000000 Z
+date: 2021-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,6 +92,7 @@ files:
 - docker-compose.yml
 - 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
 - examples/us_street_multiple_address_example.rb
@@ -134,6 +135,11 @@ files:
 - 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
+- lib/smartystreets_ruby_sdk/us_autocomplete_pro/lookup.rb
+- lib/smartystreets_ruby_sdk/us_autocomplete_pro/suggestion.rb
 - lib/smartystreets_ruby_sdk/us_extract.rb
 - lib/smartystreets_ruby_sdk/us_extract/address.rb
 - lib/smartystreets_ruby_sdk/us_extract/client.rb