smartystreets_ruby_sdk 5.2.2 → 5.3.0

data/examples/international_example.rb

@@ -6,8 +6,13 @@ class InternationalExample
   Lookup = SmartyStreets::InternationalStreet::Lookup
 
   def run
-    auth_id = ENV['SMARTY_AUTH_ID'] # We recommend storing your keys in environment variables
-    auth_token = ENV['SMARTY_AUTH_TOKEN']
+    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_international_street_api_client
 

data/examples/us_autocomplete_example.rb

@@ -6,8 +6,13 @@ class USAutocompleteExample
   Lookup = SmartyStreets::USAutocomplete::Lookup
 
   def run
-    auth_id = ENV['SMARTY_AUTH_ID'] # We recommend storing your keys in environment variables
-    auth_token = ENV['SMARTY_AUTH_TOKEN']
+    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
     lookup = Lookup.new('4770 Lincoln Ave O')

data/examples/us_extract_example.rb

@@ -6,8 +6,13 @@ class USExtractExample
   Lookup = SmartyStreets::USExtract::Lookup
 
   def run
-    auth_id = ENV['SMARTY_AUTH_ID'] # We recommend storing your keys in environment variables
-    auth_token = ENV['SMARTY_AUTH_TOKEN']
+    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_extract_api_client

data/examples/us_street_multiple_address_example.rb

@@ -7,8 +7,13 @@ class USStreetMultipleAddressExample
   Lookup = SmartyStreets::USStreet::Lookup
 
   def run
-    auth_id = ENV['SMARTY_AUTH_ID'] # We recommend storing your keys in environment variables.
-    auth_token = ENV['SMARTY_AUTH_TOKEN']
+    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_street_api_client

data/examples/us_street_single_address_example.rb

@@ -4,8 +4,13 @@ require 'smartystreets_ruby_sdk/us_street/lookup'
 
 class USStreetSingleAddressExample
   def run
-    auth_id = ENV['SMARTY_AUTH_ID'] # We recommend storing your keys in environment variables
-    auth_token = ENV['SMARTY_AUTH_TOKEN']
+    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).
@@ -26,7 +31,7 @@ class USStreetSingleAddressExample
 
     result = lookup.result
 
-    if result.nil?
+    if result.empty?
       puts 'No candidates. This means the address is not valid.'
       return
     end

data/examples/us_zipcode_multiple_lookup_example.rb

@@ -7,8 +7,13 @@ class USZipcodeMultipleLookupExample
   Lookup = SmartyStreets::USZipcode::Lookup
 
   def run
-    auth_id = ENV['SMARTY_AUTH_ID'] # We recommend storing your keys in environment variables
-    auth_token = ENV['SMARTY_AUTH_TOKEN']
+    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_zipcode_api_client

data/examples/us_zipcode_single_lookup_example.rb

@@ -4,8 +4,13 @@ require 'smartystreets_ruby_sdk/us_zipcode/lookup'
 
 class UsZipcodeSingleLookupExample
   def run
-    auth_id = ENV['SMARTY_AUTH_ID'] # We recommend storing your keys in environment variables.
-    auth_token = ENV['SMARTY_AUTH_TOKEN']
+    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_zipcode_api_client
@@ -16,7 +21,7 @@ class UsZipcodeSingleLookupExample
 
     begin
       client.send_lookup(lookup)
-    rescue SmartyError => err
+    rescue SmartyStreets::SmartyError => err
       puts err
       return
     end

data/lib/smartystreets_ruby_sdk/client_builder.rb

@@ -29,7 +29,7 @@ module SmartyStreets
       @serializer = NativeSerializer.new
       @http_sender = nil
       @max_retries = 5
-      @max_timeout = 10_000
+      @max_timeout = 10
       @url_prefix = nil
       @proxy = nil
     end
@@ -42,8 +42,7 @@ module SmartyStreets
       self
     end
 
-    # The maximum time (in milliseconds) to wait for a connection, and also to wait for
-    # the response to be read. (Default is 10000)
+    # The maximum time (in seconds) to wait for the response to be read. (Default is 10)
     #
     # Returns self to accommodate method chaining.
     def with_max_timeout(max_timeout)

data/lib/smartystreets_ruby_sdk/international_street/components.rb

@@ -3,7 +3,7 @@ module SmartyStreets
     # See "https://smartystreets.com/docs/cloud/international-street-api#components"
     class Components
       attr_reader :premise, :thoroughfare_trailing_type, :sub_building, :locality, :post_box_number,
-                  :thoroughfare_name, :thoroughfare_postdirection, :dependent_thoroughfare,
+                  :thoroughfare_name, :thoroughfare_postdirection, :dependent_thoroughfare, :premise_prefix_number,
                   :thoroughfare, :dependent_thoroughfare_name, :postal_code_short, :dependent_thoroughfare_trailing_type,
                   :administrative_area, :post_box, :building_leading_type, :dependent_locality_name, :thoroughfare_type,
                   :dependent_thoroughfare_postdirection, :double_dependent_locality, :premise_number,
@@ -27,6 +27,7 @@ module SmartyStreets
         @premise = obj.fetch('premise', nil)
         @premise_extra = obj.fetch('premise_extra', nil)
         @premise_number = obj.fetch('premise_number', nil)
+        @premise_prefix_number = obj.fetch('premise_prefix_number', nil)
         @premise_type = obj.fetch('premise_type', nil)
         @thoroughfare = obj.fetch('thoroughfare', nil)
         @thoroughfare_predirection = obj.fetch('thoroughfare_predirection', nil)

data/lib/smartystreets_ruby_sdk/native_sender.rb

@@ -4,7 +4,7 @@ require_relative 'response'
 
 module SmartyStreets
   class NativeSender
-    def initialize(max_timeout = 10_000, proxy = nil)
+    def initialize(max_timeout = 10, proxy = nil)
       @max_timeout = max_timeout
       @proxy = proxy
     end

data/lib/smartystreets_ruby_sdk/us_street/client.rb

@@ -26,14 +26,19 @@ module SmartyStreets
         return if batch.empty?
 
         converted_lookups = remap_keys(batch.all_lookups)
-        smarty_request.payload = @serializer.serialize(converted_lookups)
+
+        if batch.size > 1
+          smarty_request.payload = @serializer.serialize(converted_lookups)
+        else
+          smarty_request.parameters = converted_lookups[0]
+        end
 
         response = @sender.send(smarty_request)
 
         raise response.error if response.error
 
         candidates = @serializer.deserialize(response.payload)
-        candidates = [] if candidates == nil
+        candidates = [] if candidates.nil?
 
         assign_candidates_to_lookups(batch, candidates)
       end

data/lib/smartystreets_ruby_sdk/us_zipcode/client.rb

@@ -26,14 +26,19 @@ module SmartyStreets
         return if batch.empty?
 
         converted_lookups = remap_keys(batch.all_lookups)
-        smarty_request.payload = @serializer.serialize(converted_lookups)
+
+        if batch.size > 1
+          smarty_request.payload = @serializer.serialize(converted_lookups)
+        else
+          smarty_request.parameters = converted_lookups[0]
+        end
 
         response = @sender.send(smarty_request)
 
         raise response.error if response.error
 
         results = @serializer.deserialize(response.payload)
-        results = [] if results == nil
+        results = [] if results.nil?
         assign_results_to_lookups(batch, results)
       end
 

data/lib/smartystreets_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreets
-  VERSION = '5.2.2' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '5.3.0' # DO NOT EDIT (this is updated by a build job when a new release is published)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smartystreets_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 5.2.2
+  version: 5.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-15 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler