smartystreets_ruby_sdk 5.7.0 → 5.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1863a52e98b279161d6c028994eb9a9badfad7001b274337bc2fb7f29c12ea9d
-  data.tar.gz: 15f3567c1b708bf07dd00008eabb39d654f01acd51aa70e0edd09b674d30abd6
+  metadata.gz: f3f797e2c9674c76b4aa28327d6025f8dafbc03c821e4b40c33ad4b860b2b384
+  data.tar.gz: dcf25fb1ff0beda7ecb68dbb68fdf08ac4fdf47e1df83b71962e8bb7a514ec68
 SHA512:
-  metadata.gz: d2e8b8ac4436bcc4d88160ffb519737f72fd3fb8795a93dec23223e7f47c364ef121c56366639e4ee0d05d3b58719412d867698138bd2b2ccaca8686dee5af85
-  data.tar.gz: 1327e2f48a6f746636bf2016371fa3177fcbb0be5d484152fc8335a7996623375ba212d9789de7d204cfd48b09f9064cf393e1a2cc30df31661864c25a638357
+  metadata.gz: 5145440547a474124f14556947e1b7ada72145f6359e1b3f7e23a667418dcaf9f9c13770e1de0bc10d22a374065dc247b760151c8419d5b3587447cd1686fb55
+  data.tar.gz: 104c0f77fa4d74cf8e3cbad86ab5fe41a13a41f773009e0cccfad394f35d94035d717bb5f15a7db44b17c1d075cc5c763d4a4c4462bc54fe114e54ef31cb7b90

data/examples/international_example.rb

@@ -16,12 +16,24 @@ class InternationalExample
     credentials = SmartyStreets::StaticCredentials.new(auth_id, auth_token)
     client = SmartyStreets::ClientBuilder.new(credentials).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

@@ -19,11 +19,22 @@ class USStreetMultipleAddressExample
     client = SmartyStreets::ClientBuilder.new(credentials).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].match = SmartyStreets::USStreet::MatchType::INVALID
+    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).
@@ -56,6 +67,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,14 +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.match = SmartyStreets::USStreet::MatchType::INVALID
+    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)
@@ -40,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/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

@@ -1,10 +1,11 @@
 module SmartyStreets
   module InternationalStreet
     class RootLevel
-      attr_reader :organization, :address1, :address2, :address3, :address4, :address5, :address6, :address7, :address8,
-                  :address9, :address10, :address11, :address12
+      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)

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/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.7.0' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '5.7.1' # 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.7.0
+  version: 5.7.1
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-14 00:00:00.000000000 Z
+date: 2019-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -175,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An official library for the SmartyStreets APIs