smartystreets_ruby_sdk 3.1.0 → 4.0.0

data/Makefile

@@ -1,6 +1,6 @@
 #!/usr/bin/make -f
 
-SOURCE_VERSION := 3.1
+SOURCE_VERSION := 4.0
 
 tests:
 	ruby -Ilib -e 'ARGV.each { |f| require f }' ./test/smartystreets_ruby_sdk/test*.rb ./test/smartystreets_ruby_sdk/us_street/test*.rb ./test/smartystreets_ruby_sdk/us_zipcode/test*.rb

data/examples/international_example.rb

@@ -3,13 +3,13 @@ require 'smartystreets_ruby_sdk/client_builder'
 require 'smartystreets_ruby_sdk/international_street/lookup'
 
 class InternationalExample
-  Lookup = InternationalStreet::Lookup
+  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']
-    credentials = StaticCredentials.new(auth_id, auth_token)
-    client = ClientBuilder.new(credentials).build_international_street_api_client
+    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')
     lookup.geocode = true # Must be expressly set to get latitude and longitude.

data/examples/us_autocomplete_example.rb

@@ -3,13 +3,13 @@ require 'smartystreets_ruby_sdk/client_builder'
 require 'smartystreets_ruby_sdk/us_autocomplete/lookup'
 
 class USAutocompleteExample
-  Lookup = USAutocomplete::Lookup
+  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']
-    credentials = StaticCredentials.new(auth_id, auth_token)
-    client = ClientBuilder.new(credentials).build_us_autocomplete_api_client
+    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')
 
     client.send(lookup)

data/examples/us_extract_example.rb

@@ -3,14 +3,14 @@ require 'smartystreets_ruby_sdk/client_builder'
 require 'smartystreets_ruby_sdk/us_extract/lookup'
 
 class USExtractExample
-  Lookup = USExtract::Lookup
+  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']
-    credentials = StaticCredentials.new(auth_id, auth_token)
+    credentials = SmartyStreets::StaticCredentials.new(auth_id, auth_token)
 
-    client = ClientBuilder.new(credentials).build_us_extract_api_client
+    client = SmartyStreets::ClientBuilder.new(credentials).build_us_extract_api_client
 
     text = "Here is some text.\r\nMy address is 3785 Las Vegs Av." \
            "\r\nLos Vegas, Nevada." \

data/examples/us_street_multiple_address_example.rb

@@ -1,17 +1,18 @@
 require 'smartystreets_ruby_sdk/static_credentials'
 require 'smartystreets_ruby_sdk/client_builder'
+require 'smartystreets_ruby_sdk/batch'
 require 'smartystreets_ruby_sdk/us_street/lookup'
 
 class USStreetMultipleAddressExample
-  Lookup = USStreet::Lookup
+  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']
-    credentials = StaticCredentials.new(auth_id, auth_token)
+    credentials = SmartyStreets::StaticCredentials.new(auth_id, auth_token)
 
-    client = ClientBuilder.new(credentials).build_us_street_api_client
-    batch = Batch.new
+    client = SmartyStreets::ClientBuilder.new(credentials).build_us_street_api_client
+    batch = SmartyStreets::Batch.new
 
     batch.add(Lookup.new)
     batch[0].street = '1600 amphitheatre parkway'
@@ -29,7 +30,7 @@ class USStreetMultipleAddressExample
 
     begin
       client.send_batch(batch)
-    rescue SmartyException => err
+    rescue SmartyError => err
       puts err
       return
     end

data/examples/us_street_single_address_example.rb

@@ -6,25 +6,25 @@ class USStreetSingleAddressExample
   def run
     auth_id = ENV['SMARTY_AUTH_ID'] # We recommend storing your keys in environment variables
     auth_token = ENV['SMARTY_AUTH_TOKEN']
-    credentials = StaticCredentials.new(auth_id, auth_token)
+    credentials = SmartyStreets::StaticCredentials.new(auth_id, auth_token)
 
-    client = ClientBuilder.new(credentials).build_us_street_api_client
+    client = SmartyStreets::ClientBuilder.new(credentials).build_us_street_api_client
 
-    lookup = USStreet::Lookup.new
+    lookup = SmartyStreets::USStreet::Lookup.new
     lookup.street = '1600 Amphitheatre Pkwy'
     lookup.city = 'Mountain View'
     lookup.state = 'CA'
 
     begin
       client.send_lookup(lookup)
-    rescue SmartyException => err
+    rescue SmartyStreets::SmartyError => err
       puts err
       return
     end
 
     result = lookup.result
 
-    if result nil?
+    if result.nil?
       puts 'No candidates. This means the address is not valid.'
       return
     end

data/examples/us_zipcode_multiple_lookup_example.rb

@@ -1,17 +1,18 @@
 require 'smartystreets_ruby_sdk/static_credentials'
 require 'smartystreets_ruby_sdk/client_builder'
+require 'smartystreets_ruby_sdk/batch'
 require 'smartystreets_ruby_sdk/us_zipcode/lookup'
 
 class USZipcodeMultipleLookupExample
-  Lookup = USZipcode::Lookup
+  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']
-    credentials = StaticCredentials.new(auth_id, auth_token)
+    credentials = SmartyStreets::StaticCredentials.new(auth_id, auth_token)
 
-    client = ClientBuilder.new(credentials).build_us_zipcode_api_client
-    batch = Batch.new
+    client = SmartyStreets::ClientBuilder.new(credentials).build_us_zipcode_api_client
+    batch = SmartyStreets::Batch.new
 
     batch.add(Lookup.new)
     batch[0].zipcode = '12345' # A Lookup may have a ZIP Code, city and state, or city, state, and ZIP Code
@@ -25,7 +26,7 @@ class USZipcodeMultipleLookupExample
 
     begin
       client.send_batch(batch)
-    rescue SmartyException => err
+    rescue SmartyError => err
       puts err
       return
     end

data/examples/us_zipcode_single_lookup_example.rb

@@ -6,17 +6,17 @@ class UsZipcodeSingleLookupExample
   def run
     auth_id = ENV['SMARTY_AUTH_ID'] # We recommend storing your keys in environment variables.
     auth_token = ENV['SMARTY_AUTH_TOKEN']
-    credentials = StaticCredentials.new(auth_id, auth_token)
+    credentials = SmartyStreets::StaticCredentials.new(auth_id, auth_token)
 
-    client = ClientBuilder.new(credentials).build_us_zipcode_api_client
+    client = SmartyStreets::ClientBuilder.new(credentials).build_us_zipcode_api_client
 
-    lookup = USZipcode::Lookup.new
+    lookup = SmartyStreets::USZipcode::Lookup.new
     lookup.city = 'Mountain View'
     lookup.state = 'California'
 
     begin
       client.send_lookup(lookup)
-    rescue SmartyException => err
+    rescue SmartyError => err
       puts err
       return
     end

data/lib/smartystreets_ruby_sdk.rb

@@ -1,6 +1,28 @@
-require_relative 'smartystreets_ruby_sdk/version'
-require_relative 'smartystreets_ruby_sdk/logger'
-require_relative 'smartystreets_ruby_sdk/sleeper'
+require 'smartystreets_ruby_sdk/version'
+require 'smartystreets_ruby_sdk/logger'
+require 'smartystreets_ruby_sdk/sleeper'
 
-module SmartystreetsRubySdk
+require 'smartystreets_ruby_sdk/batch'
+require 'smartystreets_ruby_sdk/client_builder'
+require 'smartystreets_ruby_sdk/custom_header_sender'
+require 'smartystreets_ruby_sdk/errors'
+require 'smartystreets_ruby_sdk/exceptions'
+require 'smartystreets_ruby_sdk/json_able'
+require 'smartystreets_ruby_sdk/logger'
+require 'smartystreets_ruby_sdk/native_sender'
+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/shared_credentials'
+require 'smartystreets_ruby_sdk/signing_sender'
+require 'smartystreets_ruby_sdk/static_credentials'
+require 'smartystreets_ruby_sdk/status_code_sender'
+require 'smartystreets_ruby_sdk/url_prefix_sender'
+
+require 'smartystreets_ruby_sdk/us_extract'
+require 'smartystreets_ruby_sdk/us_street'
+require 'smartystreets_ruby_sdk/us_zipcode'
+
+module SmartyStreets
 end

data/lib/smartystreets_ruby_sdk/batch.rb

@@ -1,56 +1,59 @@
-class Batch
-  include Enumerable
-  MAX_BATCH_SIZE = 100
+module SmartyStreets
+  # The Batch class is used to send up to 100 lookups at once
+  class Batch
+    include Enumerable
+    MAX_BATCH_SIZE = 100
 
-  attr_reader :all_lookups, :named_lookups
+    attr_reader :all_lookups, :named_lookups
 
-  def initialize
-    @named_lookups = {}
-    @all_lookups = []
-  end
+    def initialize
+      @named_lookups = {}
+      @all_lookups = []
+    end
 
-  def add(lookup)
-    return false if full?
+    def add(lookup)
+      return false if full?
 
-    @all_lookups.push(lookup)
+      @all_lookups.push(lookup)
 
-    return true if lookup.input_id.nil?
+      return true if lookup.input_id.nil?
 
-    @named_lookups[lookup.input_id] = lookup
-    true
-  end
+      @named_lookups[lookup.input_id] = lookup
+      true
+    end
 
-  def clear
-    @named_lookups.clear
-    @all_lookups.clear
-  end
+    def clear
+      @named_lookups.clear
+      @all_lookups.clear
+    end
 
-  def full?
-    size >= MAX_BATCH_SIZE
-  end
+    def full?
+      size >= MAX_BATCH_SIZE
+    end
 
-  def empty?
-    size.zero?
-  end
+    def empty?
+      size.zero?
+    end
 
-  def size
-    @all_lookups.length
-  end
+    def size
+      @all_lookups.length
+    end
 
-  def get_by_input_id(input_id)
-    @named_lookups[input_id]
-  end
+    def get_by_input_id(input_id)
+      @named_lookups[input_id]
+    end
 
-  def get_by_index(index)
-    @all_lookups[index]
-  end
+    def get_by_index(index)
+      @all_lookups[index]
+    end
 
-  def each(&block)
-    @all_lookups.each(&block)
-  end
+    def each(&block)
+      @all_lookups.each(&block)
+    end
 
-  def [](index)
-    @all_lookups[index]
-  end
+    def [](index)
+      @all_lookups[index]
+    end
 
-end
+  end
+end

data/lib/smartystreets_ruby_sdk/client_builder.rb

@@ -12,117 +12,119 @@ require_relative 'us_extract/client'
 require_relative 'us_autocomplete/client'
 require_relative 'international_street/client'
 
-# The ClientBuilder class helps you build a client object for one of the supported SmartyStreets APIs.
-# You can use ClientBuilder's methods to customize settings like maximum retries or timeout duration.
-# These methods are chainable, so you can usually get set up with one line of code.
-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_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
-
-  def initialize(signer)
-    @signer = signer
-    @serializer = NativeSerializer.new
-    @http_sender = nil
-    @max_retries = 5
-    @max_timeout = 10_000
-    @url_prefix = nil
-    @proxy = nil
+module SmartyStreets
+  # The ClientBuilder class helps you build a client object for one of the supported SmartyStreets APIs.
+  # You can use ClientBuilder's methods to customize settings like maximum retries or timeout duration.
+  # These methods are chainable, so you can usually get set up with one line of code.
+  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_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
+
+    def initialize(signer)
+      @signer = signer
+      @serializer = NativeSerializer.new
+      @http_sender = nil
+      @max_retries = 5
+      @max_timeout = 10_000
+      @url_prefix = nil
+      @proxy = nil
+    end
+
+    # Sets the maximum number of times to retry sending the request to the API. (Default is 5)
+    #
+    # Returns self to accommodate method chaining.
+    def retry_at_most(max_retries)
+      @max_retries = max_retries
+      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)
+    #
+    # Returns self to accommodate method chaining.
+    def with_max_timeout(max_timeout)
+      @max_timeout = max_timeout
+      self
+    end
+
+    # Default is a series of nested senders. (See build_sender()
+    #
+    # Returns self to accommodate method chaining.
+    def with_sender(sender)
+      @http_sender = sender
+      self
+    end
+
+    # Changes the Serializer from the default.
+    #
+    # Returns self to accommodate method chaining.
+    def with_serializer(serializer)
+      @serializer = serializer
+      self
+    end
+
+    # This may be useful when using a local installation of the SmartyStreets APIs.
+    # base_url is a string that defaults to the URL for the API corresponding to the Client object being built.
+    #
+    # Returns self to accommodate method chaining.
+    def with_base_url(base_url)
+      @url_prefix = base_url
+      self
+    end
+
+    # Assigns a proxy through which all requests will be sent.
+    # proxy is a Proxy object from this module.
+    #
+    # Returns self to accommodate method chaining.
+    def with_proxy(proxy)
+      @proxy = proxy
+      self
+    end
+
+    def build_international_street_api_client
+      ensure_url_prefix_not_null(INTERNATIONAL_STREET_API_URL)
+      InternationalStreet::Client.new(build_sender, @serializer)
+    end
+
+    def build_us_autocomplete_api_client
+      ensure_url_prefix_not_null(US_AUTOCOMPLETE_API_URL)
+      USAutocomplete::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)
+    end
+
+    def build_us_street_api_client
+      ensure_url_prefix_not_null(US_STREET_API_URL)
+      USStreet::Client.new(build_sender, @serializer)
+    end
+
+    def build_us_zipcode_api_client
+      ensure_url_prefix_not_null(US_ZIP_CODE_API_URL)
+      USZipcode::Client.new(build_sender, @serializer)
+    end
+
+    def build_sender
+      return @http_sender unless @http_sender.nil?
+
+      sender = NativeSender.new(@max_timeout, @proxy)
+
+      sender = StatusCodeSender.new(sender)
+
+      sender = SigningSender.new(@signer, sender) unless @signer.nil?
+
+      sender = RetrySender.new(@max_retries, sender, SmartyStreets::Sleeper.new,SmartyStreets::Logger.new) if @max_retries > 0
+
+      URLPrefixSender.new(@url_prefix, sender)
+    end
+
+    def ensure_url_prefix_not_null(url)
+      @url_prefix = url if @url_prefix.nil?
+    end
   end
-
-  # Sets the maximum number of times to retry sending the request to the API. (Default is 5)
-  #
-  # Returns self to accommodate method chaining.
-  def retry_at_most(max_retries)
-    @max_retries = max_retries
-    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)
-  #
-  # Returns self to accommodate method chaining.
-  def with_max_timeout(max_timeout)
-    @max_timeout = max_timeout
-    self
-  end
-
-  # Default is a series of nested senders. (See build_sender()
-  #
-  # Returns self to accommodate method chaining.
-  def with_sender(sender)
-    @http_sender = sender
-    self
-  end
-
-  # Changes the Serializer from the default.
-  #
-  # Returns self to accommodate method chaining.
-  def with_serializer(serializer)
-    @serializer = serializer
-    self
-  end
-
-  # This may be useful when using a local installation of the SmartyStreets APIs.
-  # base_url is a string that defaults to the URL for the API corresponding to the Client object being built.
-  #
-  # Returns self to accommodate method chaining.
-  def with_base_url(base_url)
-    @url_prefix = base_url
-    self
-  end
-
-  # Assigns a proxy through which all requests will be sent.
-  # proxy is a Proxy object from this module.
-  #
-  # Returns self to accommodate method chaining.
-  def with_proxy(proxy)
-    @proxy = proxy
-    self
-  end
-
-  def build_international_street_api_client
-    ensure_url_prefix_not_null(INTERNATIONAL_STREET_API_URL)
-    InternationalStreet::Client.new(build_sender, @serializer)
-  end
-
-  def build_us_autocomplete_api_client
-    ensure_url_prefix_not_null(US_AUTOCOMPLETE_API_URL)
-    USAutocomplete::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)
-  end
-
-  def build_us_street_api_client
-    ensure_url_prefix_not_null(US_STREET_API_URL)
-    USStreet::Client.new(build_sender, @serializer)
-  end
-
-  def build_us_zipcode_api_client
-    ensure_url_prefix_not_null(US_ZIP_CODE_API_URL)
-    USZipcode::Client.new(build_sender, @serializer)
-  end
-
-  def build_sender
-    return @http_sender unless @http_sender.nil?
-
-    sender = NativeSender.new(@max_timeout, @proxy)
-
-    sender = StatusCodeSender.new(sender)
-
-    sender = SigningSender.new(@signer, sender) unless @signer.nil?
-
-    sender = RetrySender.new(@max_retries, sender, SmartystreetsRubySdk::Sleeper.new, SmartystreetsRubySdk::Logger.new) if @max_retries > 0
-
-    URLPrefixSender.new(@url_prefix, sender)
-  end
-
-  def ensure_url_prefix_not_null(url)
-    @url_prefix = url if @url_prefix.nil?
-  end
-end
+end