smartystreets_ruby_sdk 5.11.1 → 5.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76535338d0306bc77ed2b85bf80c0fb8de67f4c75597fe5680a8d20b79709a12
-  data.tar.gz: 485f697dfc44b1a9bb8589cecd8495f770d3f65e513a29ea2e6a390ac6c03eb4
+  metadata.gz: 423a76efb5b1f719deb33c17e0a7799e9ed6a6e7b6b570a2ffb19d1fb5aa89d1
+  data.tar.gz: 6b307ac880704d629a735f3d32f0535e7cee3678ebef7db6611f01299c786b72
 SHA512:
-  metadata.gz: c822627163eca11ccffd2bde54e08b853f6d782d82e05abbf17ea295bedf0ac7f41a5dba3261dbf3350527910b222031cf94f0ed2103d683fcea00028f55122a
-  data.tar.gz: 730369107a715aa070314d6be7b59603ef10516108954d7d93314418f38b0f4d0f485cb9e8336f4ca085d115dfd1b64092ad5d672e710201dd0e606e8ef58530
+  metadata.gz: 509b66bf2ea805128a40c0603be38d283407015c9e179e2c635bad3b947efd228a287fd52959b24b80a7682c4ccadbd8e6b7f7750f04766d9b4a5cac42f8377d
+  data.tar.gz: 343069ee8fd58bea6f4c90bdf90baa5cd050456c0521d93f2fa43064ea04d1d524c3e027ec83dd14844dae66f04f62d74a85fd7c8cc806b4bbd5375fb7700c26

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

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

@@ -3,7 +3,7 @@ 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, :no_stat, :match_mode, :match_details
+                  :is_ews_match, :dpv_footnotes, :cmra, :vacant, :no_stat, :enhanced_match
 
       def initialize(obj)
         @dpv_match_code = obj['dpv_match_code']
@@ -17,8 +17,7 @@ module SmartyStreets
         @lacs_link_code = obj['lacslink_code']
         @lacs_link_indicator = obj['lacslink_indicator']
         @is_suite_link_match = obj['suitelink_match']
-        @match_mode = obj['match_mode']
-        @match_details = obj['match_details']
+        @enhanced_match = obj['enhanced_match']
       end
     end
   end

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.1' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '5.13.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.1
+  version: 5.13.0
 platform: ruby
 authors:
 - SmartyStreets SDK Team
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-15 00:00:00.000000000 Z
+date: 2021-09-23 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: []
@@ -91,7 +91,6 @@ files:
 - bin/setup
 - 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
@@ -175,7 +174,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 +189,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