smartystreets_ruby_sdk 5.6.0 → 5.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 794413a1e06521762ba503facba2cb26a1c3ca7394611d2fe1aebc48d57720d4
-  data.tar.gz: dee93752476e4fd1c7ef53795ecddd497a7d02bae3cef58c001f9df139052cc0
+  metadata.gz: 535dcd015e5d60cfb19fceef8fcaaf21571bc32a1273e59f8b21b3fcb71e7361
+  data.tar.gz: f994e9282f74263c7fbdc411c7a90cc5a41f04cdfe58fd7d5a41668e8ce90090
 SHA512:
-  metadata.gz: f817be4207343dee1d4fe04afc4c2619d6b571feafb16d09dea1e5173dfb58cac6017fbed9b892b7cb676712a8c69cc521577ee60ca647dcbe43db18f6079d5a
-  data.tar.gz: b030694e778f413b5e5018968638fed3d4f0f963ea23a580a6deca8f6b54e7ea6cb881323cc729ddcab42f897722cb9d21b685f49a9b0166124043c7f2733082
+  metadata.gz: 503dd289bba672c6068784ca929a14b265a57f80f30e5faa9840a3962b67937c0a200e8ad450783077723d0eff1ff8e7681dafc6a4d98d4fe6ac68171ac17cf8
+  data.tar.gz: ea7e7babd854b053bdda4ddfc43ad88f47c6b12ed26a53f2681b72635a191b46b3e70e46c5cd15d292d146d8ba546251acf129e4dcb81260bb499d1b499c36dc

data/CHANGELOG.md

@@ -1,29 +1,5 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
+See the changelog repository:
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-
-## [Unreleased]
-
-### Changed:
-
-- Using `warn` instead of `log` to avoid conflict with builtin function.
-
-## [5.5.4] - 2018-09-18
-
-### Changed:
-
-- Standardized `Makefile`.
-
-
-## [Earlier]
-
-For details on earlier changes, please see the [releases listing](https://github.com/smartystreets/smartystreets-ruby-sdk/releases).
-
-------------
-
-[Unreleased]: https://github.com/smartystreets/smartystreets-ruby-sdk/compare/5.5.4...HEAD
-[5.5.4]: https://github.com/smartystreets/smartystreets-ruby-sdk/compare/5.5.3...5.5.4
-[Earlier]: https://github.com/smartystreets/smartystreets-ruby-sdk/releases
+github.com/smartystreets/changelog/blob/master/sdk/ruby.md

data/README.md

@@ -27,7 +27,3 @@ And then execute:
 Or install it yourself as:
 
     $ gem install smartystreets_ruby_sdk    
-
-
-
-

data/examples/international_example.rb

@@ -14,14 +14,27 @@ class InternationalExample
     # auth_token = ENV['SMARTY_AUTH_TOKEN']
 
     credentials = SmartyStreets::StaticCredentials.new(auth_id, auth_token)
-    client = SmartyStreets::ClientBuilder.new(credentials).build_international_street_api_client
+    client = SmartyStreets::ClientBuilder.new(credentials) # .with_licenses(%w(international-fake-license))
+                 .build_international_street_api_client
 
-    lookup = Lookup.new("Rua Padre Antonio D'Angelo 121 Casa Verde, Sao Paulo", 'Brazil')
+    # Documentation for input fields can be found at:
+    # https://smartystreets.com/docs/cloud/international-street-api
+
+    lookup = Lookup.new()
+    lookup.inputId = 'ID-8675309' # Optional ID from your system
     lookup.geocode = true # Must be expressly set to get latitude and longitude.
+    lookup.organization = 'John Doe'
+    lookup.address1 = "Rua Padre Antonio D'Angelo 121"
+    lookup.address2 = 'Casa Verde'
+    lookup.locality = 'Sao Paulo'
+    lookup.administrative_area = 'SP'
+    lookup.country = 'Brazil'
+    lookup.postal_code = '02516-050'
 
     candidates = client.send(lookup) # The candidates are also stored in the lookup's 'result' field.
 
     first_candidate = candidates[0]
+    puts "Input ID: #{first_candidate.input_id}"
     puts "Address is #{first_candidate.analysis.verification_status}"
     puts "Address precision: #{first_candidate.analysis.address_precision}\n\n"
     puts "First Line: #{first_candidate.address1}"

data/examples/us_autocomplete_example.rb

@@ -15,7 +15,12 @@ class USAutocompleteExample
 
     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)
 
@@ -25,8 +30,11 @@ class USAutocompleteExample
       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
 

data/examples/us_extract_example.rb

@@ -21,7 +21,13 @@ class USExtractExample
            "\r\nLos Vegas, Nevada." \
            "\r\nMeet me at 1 Rosedale Baltimore Maryland, not at 123 Phony Street, Boise Idaho."
 
+    # Documentation for input fields can be found at:
+    # https://smartystreets.com/docs/cloud/us-extract-api
+
     lookup = Lookup.new(text)
+    lookup.aggressive = true
+    lookup.addresses_have_line_breaks = false
+    lookup.addresses_per_line = 2
 
     result = client.send(lookup)
 

data/examples/us_street_multiple_address_example.rb

@@ -16,13 +16,26 @@ class USStreetMultipleAddressExample
 
     credentials = SmartyStreets::StaticCredentials.new(auth_id, auth_token)
 
-    client = SmartyStreets::ClientBuilder.new(credentials).build_us_street_api_client
+    client = SmartyStreets::ClientBuilder.new(credentials) # .with_licenses(%w(us-rooftop-geocoding-cloud))
+                 .build_us_street_api_client
     batch = SmartyStreets::Batch.new
 
+    # Documentation for input fields can be found at:
+    # https://smartystreets.com/docs/cloud/us-street-api
+
     batch.add(Lookup.new)
+    batch[0].input_id = '8675309'  # Optional ID from your system
+    batch[0].addressee = 'John Doe'
     batch[0].street = '1600 amphitheatre parkway'
-    batch[0].city = 'Mountain view'
-    batch[0].state = 'california'
+    batch[0].street2 = 'second star to the right'
+    batch[0].secondary = 'APT 2'
+    batch[0].urbanization = ''  # Only applies to Puerto Rico addresses
+    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,
+                                      # this will always return at least one result even if the address is invalid.
+                                      # Refer to the documentation for additional Match Strategy options.
 
     batch.add(Lookup.new('1 Rosedale, Baltimore, Maryland')) # Freeform addresses work too.
     batch[1].candidates = 10 # Allows up to ten possible matches to be returned (default is 1).
@@ -55,6 +68,7 @@ class USStreetMultipleAddressExample
         metadata = candidate.metadata
 
         puts "\nCandidate #{candidate.candidate_index} : "
+        puts "Input ID: #{candidate.input_id}"
         puts "Delivery line 1: #{candidate.delivery_line_1}"
         puts "Last line:       #{candidate.last_line}"
         puts "ZIP Code:        #{components.zipcode}-#{components.plus4_code}"

data/examples/us_street_single_address_example.rb

@@ -14,13 +14,26 @@ class USStreetSingleAddressExample
     credentials = SmartyStreets::StaticCredentials.new(auth_id, auth_token)
 
     client = SmartyStreets::ClientBuilder.new(credentials).
-                 # with_proxy('localhost', 8080, 'proxyUser', 'proxyPassword'). # Uncomment this line to try it with a proxy
-                 build_us_street_api_client
+        # with_proxy('localhost', 8080, 'proxyUser', 'proxyPassword'). # Uncomment this line to try it with a proxy
+        build_us_street_api_client
+
+    # Documentation for input fields can be found at:
+    # https://smartystreets.com/docs/cloud/us-street-api
 
     lookup = SmartyStreets::USStreet::Lookup.new
+    lookup.input_id = '24601'  # Optional ID from your system
+    lookup.addressee = 'John Doe'
     lookup.street = '1600 Amphitheatre Pkwy'
+    lookup.street2 = 'closet under the stairs'
+    lookup.secondary = 'APT 2'
+    lookup.urbanization = ''  # Only applies to Puerto Rico addresses
     lookup.city = 'Mountain View'
     lookup.state = 'CA'
+    lookup.zipcode = '21229'
+    lookup.candidates = 3
+    lookup.match = 'invalid'.freeze # "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.
 
     begin
       client.send_lookup(lookup)
@@ -39,6 +52,7 @@ class USStreetSingleAddressExample
     first_candidate = result[0]
 
     puts "Address is valid. (There is at least one candidate)\n"
+    puts "Input ID: #{first_candidate.input_id}"
     puts "ZIP Code: #{first_candidate.components.zipcode}"
     puts "County: #{first_candidate.metadata.county_name}"
     puts "Latitude: #{first_candidate.metadata.latitude}"

data/examples/us_zipcode_multiple_lookup_example.rb

@@ -19,7 +19,11 @@ class USZipcodeMultipleLookupExample
     client = SmartyStreets::ClientBuilder.new(credentials).build_us_zipcode_api_client
     batch = SmartyStreets::Batch.new
 
+    # Documentation for input fields can be found at:
+    # https://smartystreets.com/docs/cloud/us-zipcode-api
+
     batch.add(Lookup.new)
+    batch[0].input_id = '01189998819991197253' # Optional ID from your system
     batch[0].zipcode = '12345' # A Lookup may have a ZIP Code, city and state, or city, state, and ZIP Code
 
     batch.add(Lookup.new)

data/examples/us_zipcode_single_lookup_example.rb

@@ -15,9 +15,14 @@ class UsZipcodeSingleLookupExample
 
     client = SmartyStreets::ClientBuilder.new(credentials).build_us_zipcode_api_client
 
+    # Documentation for input fields can be found at:
+    # https://smartystreets.com/docs/cloud/us-zipcode-api
+
     lookup = SmartyStreets::USZipcode::Lookup.new
+    lookup.input_id = 'dfc33cb6-829e-4fea-aa1b-b6d6580f0817'  # Optional ID from your system
     lookup.city = 'Mountain View'
     lookup.state = 'California'
+    lookup.zipcode = '94043'
 
     begin
       client.send_lookup(lookup)
@@ -30,6 +35,8 @@ class UsZipcodeSingleLookupExample
     zipcodes = result.zipcodes
     cities = result.cities
 
+    puts "Input ID: #{result.input_id}"
+
     cities.each do |city|
       puts "\nCity: #{city.city}"
       puts "State: #{city.state}"

data/lib/smartystreets_ruby_sdk.rb

@@ -14,6 +14,7 @@ require 'smartystreets_ruby_sdk/native_serializer'
 require 'smartystreets_ruby_sdk/request'
 require 'smartystreets_ruby_sdk/response'
 require 'smartystreets_ruby_sdk/retry_sender'
+require 'smartystreets_ruby_sdk/license_sender'
 require 'smartystreets_ruby_sdk/shared_credentials'
 require 'smartystreets_ruby_sdk/signing_sender'
 require 'smartystreets_ruby_sdk/static_credentials'

data/lib/smartystreets_ruby_sdk/client_builder.rb

@@ -4,6 +4,7 @@ require_relative 'status_code_sender'
 require_relative 'signing_sender'
 require_relative 'retry_sender'
 require_relative 'url_prefix_sender'
+require_relative 'license_sender'
 require_relative 'sleeper'
 require_relative 'logger'
 require_relative 'proxy'
@@ -34,6 +35,7 @@ module SmartyStreets
       @url_prefix = nil
       @proxy = nil
       @headers = nil
+      @licenses = %w()
       @debug = nil
     end
 
@@ -96,6 +98,14 @@ module SmartyStreets
       self
     end
 
+    # Allows the caller to specify the subscription license (aka "track") they wish to use.
+    #
+    # Returns self to accommodate method chaining.
+    def with_licenses(licenses)
+      @licenses.concat licenses
+      self
+    end
+
     # Enables debug mode, which will print information about the HTTP request and response to $stdout.
     #
     # Returns self to accommodate method chaining.
@@ -146,6 +156,8 @@ module SmartyStreets
 
       sender = RetrySender.new(@max_retries, sender, SmartyStreets::Sleeper.new,SmartyStreets::Logger.new) if @max_retries > 0
 
+      sender = LicenseSender.new(sender, @licenses)
+
       URLPrefixSender.new(@url_prefix, sender)
     end
 

data/lib/smartystreets_ruby_sdk/international_street/analysis.rb

@@ -1,14 +1,16 @@
+require_relative 'changes'
 module SmartyStreets
   module InternationalStreet
     # See "https://smartystreets.com/docs/cloud/international-street-api#analysis"
     class Analysis
 
-      attr_reader :max_address_precision, :verification_status, :address_precision
+      attr_reader :max_address_precision, :verification_status, :address_precision, :changes
 
       def initialize(obj)
         @verification_status = obj.fetch('verification_status', nil)
         @address_precision = obj.fetch('address_precision', nil)
         @max_address_precision = obj.fetch('max_address_precision', nil)
+        @changes = Changes.new(obj.fetch('changes', {}))
       end
     end
   end

data/lib/smartystreets_ruby_sdk/international_street/candidate.rb

@@ -1,6 +1,7 @@
 require_relative 'components'
 require_relative 'metadata'
 require_relative 'analysis'
+require_relative 'rootlevel'
 
 module SmartyStreets
   module InternationalStreet
@@ -8,27 +9,14 @@ module SmartyStreets
     # candidates if the address was ambiguous.
     #
     # See "https://smartystreets.com/docs/cloud/international-street-api#root"
-    class Candidate
-      attr_reader :metadata, :address3, :address11, :address2, :address12, :address1, :address10,
-                  :address9, :address8, :address7, :organization, :address6, :address5, :address4, :components, :analysis
+    class Candidate < RootLevel
+      attr_reader :metadata, :components, :analysis
 
       def initialize(obj)
-        @organization = obj.fetch('organization', nil)
-        @address1 = obj.fetch('address1', nil)
-        @address2 = obj.fetch('address2', nil)
-        @address3 = obj.fetch('address3', nil)
-        @address4 = obj.fetch('address4', nil)
-        @address5 = obj.fetch('address5', nil)
-        @address6 = obj.fetch('address6', nil)
-        @address7 = obj.fetch('address7', nil)
-        @address8 = obj.fetch('address8', nil)
-        @address9 = obj.fetch('address9', nil)
-        @address10 = obj.fetch('address10', nil)
-        @address11 = obj.fetch('address11', nil)
-        @address12 = obj.fetch('address12', nil)
         @components = Components.new(obj.fetch('components', {}))
         @metadata = Metadata.new(obj.fetch('metadata', {}))
         @analysis = Analysis.new(obj.fetch('analysis', {}))
+        super(obj)
       end
     end
   end

data/lib/smartystreets_ruby_sdk/international_street/changes.rb

@@ -0,0 +1,15 @@
+require_relative 'rootlevel'
+require_relative 'components'
+
+module SmartyStreets
+  module InternationalStreet
+    class Changes < RootLevel
+      attr_reader :components
+
+      def initialize(obj)
+        @components = Components.new(obj.fetch('components', {}))
+        super(obj)
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/international_street/client.rb

@@ -26,6 +26,7 @@ module SmartyStreets
       def build_request(lookup)
         request = SmartyStreets::Request.new
 
+        add_parameter(request, 'input_id', lookup.input_id)
         add_parameter(request, 'country', lookup.country)
         add_parameter(request, 'geocode', lookup.geocode.to_s)
         add_parameter(request, 'language', lookup.language)

data/lib/smartystreets_ruby_sdk/international_street/lookup.rb

@@ -14,13 +14,13 @@ module SmartyStreets
     #     When set to language_mode.LATIN, the results will always be provided using a Latin character set.
     class Lookup
 
-      attr_accessor :freeform, :locality, :postal_code, :address3, :address2, :inputId, :address1,
+      attr_accessor :input_id, :freeform, :locality, :postal_code, :address3, :address2, :inputId, :address1,
                     :geocode, :administrative_area, :country, :organization, :language, :address4, :result
 
       def initialize(freeform=nil, country=nil)
         @result = []
 
-        @inputId = nil
+        @input_id = nil
         @country = country
         @geocode = nil
         @language = nil

data/lib/smartystreets_ruby_sdk/international_street/rootlevel.rb

@@ -0,0 +1,25 @@
+module SmartyStreets
+  module InternationalStreet
+    class RootLevel
+      attr_reader :input_id, :organization, :address1, :address2, :address3, :address4, :address5, :address6, :address7,
+                  :address8, :address9, :address10, :address11, :address12
+
+      def initialize(obj)
+        @input_id = obj.fetch('input_id', nil)
+        @organization = obj.fetch('organization', nil)
+        @address1 = obj.fetch('address1', nil)
+        @address2 = obj.fetch('address2', nil)
+        @address3 = obj.fetch('address3', nil)
+        @address4 = obj.fetch('address4', nil)
+        @address5 = obj.fetch('address5', nil)
+        @address6 = obj.fetch('address6', nil)
+        @address7 = obj.fetch('address7', nil)
+        @address8 = obj.fetch('address8', nil)
+        @address9 = obj.fetch('address9', nil)
+        @address10 = obj.fetch('address10', nil)
+        @address11 = obj.fetch('address11', nil)
+        @address12 = obj.fetch('address12', nil)
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/license_sender.rb

@@ -0,0 +1,15 @@
+module SmartyStreets
+  class LicenseSender
+    def initialize(inner, licenses)
+      @inner = inner
+      @licenses = licenses
+    end
+
+    def send(request)
+      if @licenses.length > 0
+        request.parameters['license'] = @licenses.join(',')
+      end
+      @inner.send(request)
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/retry_sender.rb

@@ -27,7 +27,7 @@ module SmartyStreets
     def backoff(attempt)
       backoff_duration = [attempt, MAX_BACKOFF_DURATION].min
 
-      @logger.warn("There was an error processing the request. Retrying in #{backoff_duration} seconds...")
+      @logger.log("There was an error processing the request. Retrying in #{backoff_duration} seconds...")
       @sleeper.sleep(backoff_duration)
     end
   end

data/lib/smartystreets_ruby_sdk/us_extract/result.rb

@@ -13,7 +13,7 @@ module SmartyStreets
         @addresses = []
 
         addresses.each {|address|
-          @addresses.push(Address.new(address))
+          @addresses.push(SmartyStreets::USExtract::Address.new(address))
         }
       end
     end

data/lib/smartystreets_ruby_sdk/us_street/analysis.rb

@@ -11,7 +11,7 @@ module SmartyStreets
         @cmra = obj['dpv_cmra']
         @vacant = obj['dpv_vacant']
         @active = obj['active']
-        @is_ews_match = "Deprecated, refer to metadata.is_ews_match"
+        @is_ews_match = obj['ews_match']
         @footnotes = obj['footnotes']
         @lacs_link_code = obj['lacslink_code']
         @lacs_link_indicator = obj['lacslink_indicator']

data/lib/smartystreets_ruby_sdk/us_street/candidate.rb

@@ -6,10 +6,11 @@ module SmartyStreets
   module USStreet
     # See "https://smartystreets.com/docs/cloud/us-street-api#metadata"
     class Candidate
-      attr_reader :input_index, :candidate_index, :addressee, :delivery_line_1, :delivery_line_2, :delivery_point_barcode,
+      attr_reader :input_id, :input_index, :candidate_index, :addressee, :delivery_line_1, :delivery_line_2, :delivery_point_barcode,
                   :last_line, :metadata, :components, :analysis
 
       def initialize(obj)
+        @input_id = obj['input_id']
         @input_index = obj['input_index']
         @candidate_index = obj['candidate_index']
         @addressee = obj['addressee']

data/lib/smartystreets_ruby_sdk/us_street/client.rb

@@ -48,6 +48,7 @@ module SmartyStreets
         obj.each do |lookup|
           converted_lookup = {}
 
+          converted_lookup['input_id'] = lookup.input_id
           converted_lookup['street'] = lookup.street
           converted_lookup['street2'] = lookup.street2
           converted_lookup['secondary'] = lookup.secondary

data/lib/smartystreets_ruby_sdk/us_zipcode/result.rb

@@ -5,11 +5,12 @@ module SmartyStreets
   module USZipcode
     # See "https://smartystreets.com/docs/cloud/us-zipcode-api#root"
     class Result
-      attr_reader :reason, :input_index, :cities, :zipcodes, :status
+      attr_reader :reason, :input_id, :input_index, :cities, :zipcodes, :status
 
       def initialize(obj)
         @status = obj['status']
         @reason = obj['reason']
+        @input_id = obj['input_id']
         @input_index = obj['input_index']
         @cities = obj.fetch('city_states', [])
         @zipcodes = obj.fetch('zipcodes', [])

data/lib/smartystreets_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreets
-  VERSION = '5.6.0' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '5.8.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.6.0
+  version: 5.8.0
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-25 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,12 +106,15 @@ files:
 - lib/smartystreets_ruby_sdk/international_street.rb
 - lib/smartystreets_ruby_sdk/international_street/analysis.rb
 - lib/smartystreets_ruby_sdk/international_street/candidate.rb
+- lib/smartystreets_ruby_sdk/international_street/changes.rb
 - lib/smartystreets_ruby_sdk/international_street/client.rb
 - lib/smartystreets_ruby_sdk/international_street/components.rb
 - lib/smartystreets_ruby_sdk/international_street/language_mode.rb
 - lib/smartystreets_ruby_sdk/international_street/lookup.rb
 - lib/smartystreets_ruby_sdk/international_street/metadata.rb
+- lib/smartystreets_ruby_sdk/international_street/rootlevel.rb
 - lib/smartystreets_ruby_sdk/json_able.rb
+- lib/smartystreets_ruby_sdk/license_sender.rb
 - lib/smartystreets_ruby_sdk/logger.rb
 - lib/smartystreets_ruby_sdk/native_sender.rb
 - lib/smartystreets_ruby_sdk/native_serializer.rb
@@ -173,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: An official library for the SmartyStreets APIs