smartystreets_ruby_sdk 0.0.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: a5a4cbefe11b18791ae311d7f78bf3c74a9ae0ff05857d36e775f1341128fb75
-  data.tar.gz: 0bd00361cee6dd7428cf8c0edd375cc7fa9a308c679340197c838827addd0413
+SHA1:
+  metadata.gz: 06e2310024c72482dc0038e5cdd34585b1785c3f
+  data.tar.gz: 40495a70b76067b52485cbb8212fb61056bac537
 SHA512:
-  metadata.gz: bc4f3a3e49f8a8cf856857cbe08526c0f2ef3205b60669c83fa3f4fc486f5d50d01491a28adcc507aab11904fb139d4ca77bf608f80e7ce3ace743169462e5f3
-  data.tar.gz: 4277f3287956cd54754fd2a33c291b7615f8a6651100adfcb5c3bf47dbb693372bbcc75e41f03857a7483a8500d7ada2b18c875c0df45db554edd2869df9fe18
+  metadata.gz: 14ed487aeeba73664aa271b85672e28058dec66d3fac29972e2030e16c4b1237db046733c7d87f2f60f8887d8b665fabd0f5c6c66accbd5be577ad03d92af461
+  data.tar.gz: bfe3fadf0b7a177b529453754efde3a641f6b4c50cb58612aeac4b4d75a8421367d00bb953c62ab721da286dc0200896d3967289dbcb6f28ef2b93ad118f909d

data/.gitignore

@@ -1,4 +1,3 @@
 *.lock
 .idea
 coverage
-*.gem

data/{LICENSE.md → LICENSE.txt}

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright Smarty
+   Copyright SmartyStreets
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/Makefile

@@ -1,33 +1,19 @@
 #!/usr/bin/make -f
 
-VERSION       := $(shell tagit -p --dry-run)
-VERSION_FILE  := lib/smartystreets_ruby_sdk/version.rb
-
-clean:
-	rm -f *.gem
-	git checkout "$(VERSION_FILE)"
-
-test:
-	rake test
-
-dependencies:
-	gem install minitest
-
-package: clean dependencies test
-	sed -i "s/0\.0\.0/$(VERSION)/g" "$(VERSION_FILE)" \
-		&& gem build *.gemspec \
-		&& git checkout "$(VERSION_FILE)"
-
-publish: package
-	chmod 0600 /root/.gem/credentials
-	gem push *.gem
-
-#####################################################################
-
-workspace:
-	docker-compose run sdk /bin/sh
-
-release:
-	docker-compose run sdk make publish && tagit -p && git push origin --tags
-
-.PHONY: clean test dependencies package publish workspace release
+SOURCE_VERSION := 1.0
+
+publish: version
+	git push origin --tags
+	gem build smartystreets_ruby_sdk.gemspec
+	gem push smartystreets_ruby_sdk-$(shell git describe).gem
+	git checkout lib/smartystreets_ruby_sdk/version.rb
+
+version: tag
+	@sed -i -r "s/0\.0\.0/$(shell git describe)/g" lib/smartystreets_ruby_sdk/version.rb
+
+tag:
+	$(eval PREFIX := $(SOURCE_VERSION).)
+	$(eval CURRENT := $(shell git describe 2>/dev/null))
+	$(eval EXPECTED := $(PREFIX)$(shell git tag -l "$(PREFIX)*" | wc -l | xargs expr -1 +))
+	$(eval INCREMENTED := $(PREFIX)$(shell git tag -l "$(PREFIX)*" | wc -l | xargs expr 0 +))
+	@if [ "$(CURRENT)" != "$(EXPECTED)" ]; then git tag -a "$(INCREMENTED)" -m "" 2>/dev/null || true; fi

data/README.md

@@ -1,5 +1,3 @@
-# SMARTY DISCLAIMER: Subject to the terms of the associated license agreement, this software is freely available for your use. This software is FREE, AS IN PUPPIES, and is a gift. Enjoy your new responsibility. This means that while we may consider enhancement requests, we may or may not choose to entertain requests at our sole and absolute discretion.
-
 # SmartyStreets Ruby SDK
 
 The official client libraries for accessing SmartyStreets APIs from Ruby
@@ -8,12 +6,6 @@ You may have noticed this page is curiously sparse. Don't panic, there's [docume
 
 [Apache 2.0 License](LICENSE.txt)
 
----
-
-[![asciicast](https://asciinema.org/a/124457.png)](https://asciinema.org/a/124457)
-
----
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,4 +20,9 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install smartystreets_ruby_sdk    
+    $ gem install smartystreets_ruby_sdk
+
+
+
+
+

data/Rakefile

@@ -1,5 +1,2 @@
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-	t.pattern = 'test/**/test_*.rb'
-end
+require 'bundler/gem_tasks'
+task :default => :spec

data/examples/us_street_multiple_address_example.rb

@@ -1,77 +1,52 @@
 require 'smartystreets_ruby_sdk/static_credentials'
-require 'smartystreets_ruby_sdk/client_builder'
-require 'smartystreets_ruby_sdk/batch'
+require 'smartystreets_ruby_sdk/us_street/client_builder'
 require 'smartystreets_ruby_sdk/us_street/lookup'
 
 class USStreetMultipleAddressExample
-  Lookup = SmartyStreets::USStreet::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_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)
-
-    # The appropriate license values to be used for your subscriptions
-    # can be found on the Subscriptions page of the account dashboard.
-    # https://www.smartystreets.com/docs/cloud/licensing
-    client = SmartyStreets::ClientBuilder.new(credentials).with_licenses(['us-core-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
+    client = USStreet::ClientBuilder.new(credentials).build
+    batch = Batch.new
 
-    batch.add(Lookup.new)
-    batch[0].input_id = '8675309'  # Optional ID from your system
-    batch[0].addressee = 'John Doe'
+    batch.add(USStreet::Lookup.new)
     batch[0].street = '1600 amphitheatre parkway'
-    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 = 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.
+    batch[0].city = 'Mountain view'
+    batch[0].state = 'california'
 
-    batch.add(Lookup.new('1 Rosedale, Baltimore, Maryland')) # Freeform addresses work too.
+    batch.add(USStreet::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).
 
-    batch.add(Lookup.new('123 Bogus Street, Pretend Lake, Oklahoma'))
+    batch.add(USStreet::Lookup.new('123 Bogus Street, Pretend Lake, Oklahoma'))
 
-    batch.add(Lookup.new)
+    batch.add(USStreet::Lookup.new)
     batch[3].street = '1 Infinite Loop'
     batch[3].zipcode = '95014' # You can just input the street and ZIP if you want.
 
     begin
       client.send_batch(batch)
-    rescue SmartyStreets::SmartyError => err
-      puts err
+    rescue SmartyException => err
+      print(err)
       return
     end
 
     batch.each_with_index do |lookup, i|
       candidates = lookup.result
 
-      if candidates.empty?
+      if candidates.length == 0
         puts "Address #{i} is invalid.\n\n"
         next
       end
 
-      puts "Address #{i} has at least one candidate.\n If the match parameter is set to STRICT, the address is valid.\n Otherwise, check the Analysis output fields to see if the address is valid."
+      puts "Address #{i} is valid. (There is at least one candidate)"
 
       candidates.each do |candidate|
         components = candidate.components
         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

@@ -1,61 +1,37 @@
 require 'smartystreets_ruby_sdk/static_credentials'
-require 'smartystreets_ruby_sdk/client_builder'
+require 'smartystreets_ruby_sdk/us_street/client_builder'
 require 'smartystreets_ruby_sdk/us_street/lookup'
 
 class USStreetSingleAddressExample
   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_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)
-
-    # The appropriate license values to be used for your subscriptions
-    # can be found on the Subscriptions page of the account dashboard.
-    # https://www.smartystreets.com/docs/cloud/licensing
-    client = SmartyStreets::ClientBuilder.new(credentials).with_licenses(['us-core-cloud'])
-        # 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
+    client = USStreet::ClientBuilder.new(credentials).build
 
-    lookup = SmartyStreets::USStreet::Lookup.new
-    lookup.input_id = '24601'  # Optional ID from your system
-    lookup.addressee = 'John Doe'
+    lookup = USStreet::Lookup.new
     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 = 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.
 
     begin
       client.send_lookup(lookup)
-    rescue SmartyStreets::SmartyError => err
+    rescue SmartyException => err
       puts err
       return
     end
 
     result = lookup.result
 
-    if result.empty?
+    if result == nil
       puts 'No candidates. This means the address is not valid.'
       return
     end
 
     first_candidate = result[0]
 
-    puts "There is at least one candidate.\n If the match parameter is set to STRICT, the address is valid.\n Otherwise, check the Analysis output fields to see if the address is valid.\n"
-    puts "Input ID: #{first_candidate.input_id}"
+    puts "Address is valid. (There is at least one candidate)\n"
     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

@@ -1,41 +1,29 @@
 require 'smartystreets_ruby_sdk/static_credentials'
-require 'smartystreets_ruby_sdk/client_builder'
-require 'smartystreets_ruby_sdk/batch'
+require 'smartystreets_ruby_sdk/us_zipcode/client_builder'
 require 'smartystreets_ruby_sdk/us_zipcode/lookup'
 
 class USZipcodeMultipleLookupExample
-  Lookup = SmartyStreets::USZipcode::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_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 = 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
+    client = USZipcode::ClientBuilder.new(credentials).build
+    batch = Batch.new
 
-    batch.add(Lookup.new)
-    batch[0].input_id = '01189998819991197253' # Optional ID from your system
+    batch.add(USZipcode::Lookup.new)
     batch[0].zipcode = '12345' # A Lookup may have a ZIP Code, city and state, or city, state, and ZIP Code
 
-    batch.add(Lookup.new)
+    batch.add(USZipcode::Lookup.new)
     batch[1].city = 'Phoenix'
     batch[1].state = 'Arizona'
 
-    batch.add(Lookup.new('cupertino', 'CA', '95014')) # You can also set these with arguments
+    batch.add(USZipcode::Lookup.new('cupertino', 'CA', '95014')) # You can also set these with arguments
 
 
     begin
       client.send_batch(batch)
-    rescue SmartyError => err
+    rescue SmartyException => err
       puts err
       return
     end

data/examples/us_zipcode_single_lookup_example.rb

@@ -1,32 +1,22 @@
 require 'smartystreets_ruby_sdk/static_credentials'
-require 'smartystreets_ruby_sdk/client_builder'
+require 'smartystreets_ruby_sdk/us_zipcode/client_builder'
 require 'smartystreets_ruby_sdk/us_zipcode/lookup'
 
 class UsZipcodeSingleLookupExample
   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_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 = SmartyStreets::ClientBuilder.new(credentials).build_us_zipcode_api_client
+    client = USZipcode::ClientBuilder.new(credentials).build
 
-    # 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 = USZipcode::Lookup.new
     lookup.city = 'Mountain View'
     lookup.state = 'California'
-    lookup.zipcode = '94043'
 
     begin
       client.send_lookup(lookup)
-    rescue SmartyStreets::SmartyError => err
+    rescue SmartyException => err
       puts err
       return
     end
@@ -35,8 +25,6 @@ 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/batch.rb

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

data/lib/smartystreets_ruby_sdk/core_client_builder.rb

@@ -0,0 +1,56 @@
+require_relative 'native_serializer'
+require_relative 'native_sender'
+require_relative 'status_code_sender'
+require_relative 'signing_sender'
+require_relative 'retry_sender'
+require_relative 'url_prefix_sender'
+require_relative 'sleeper'
+
+class CoreClientBuilder
+  def initialize(signer)
+    @signer = signer
+    @serializer = NativeSerializer.new
+    @http_sender = nil
+    @max_retries = 5
+    @max_timeout = 10000
+    @url_prefix = ''
+  end
+
+  def retry_at_most(max_retries)
+    @max_retries = max_retries
+    self
+  end
+
+  def with_max_timeout(max_timeout)
+    @max_timeout = max_timeout
+    self
+  end
+
+  def with_serializer(serializer)
+    @serializer = serializer
+    self
+  end
+
+  def with_url(url_prefix)
+    @url_prefix = url_prefix
+    self
+  end
+
+  def build
+    # Implemented in child classes
+  end
+
+  def build_sender
+    return @http_sender if @http_sender != nil
+
+    sender = NativeSender.new(@max_timeout)
+
+    sender = StatusCodeSender.new(sender)
+
+    sender = SigningSender.new(@signer, sender) if @signer != nil
+
+    sender = RetrySender.new(@max_retries, sender, Sleeper.new) if @max_retries > 0
+
+    URLPrefixSender.new(@url_prefix, sender)
+  end
+end

data/lib/smartystreets_ruby_sdk/custom_header_sender.rb

@@ -1,13 +1,11 @@
-module SmartyStreets
-  class CustomHeaderSender
-    def initialize(inner, headers)
-      @inner = inner
-      @headers = headers
-    end
+class CustomHeaderSender
+  def initialize(inner, headers)
+    @inner = inner
+    @headers = headers
+  end
 
-    def send(request)
-      request.headers = @headers
-      @inner.send(request)
-    end
+  def send(request)
+    request.headers = @headers
+    @inner.send(request)
   end
 end

data/lib/smartystreets_ruby_sdk/errors.rb

@@ -1,27 +1,17 @@
-module SmartyStreets
-  BAD_CREDENTIALS = 'Unauthorized: The credentials were provided incorrectly or did not match any existing,
- active credentials.'.freeze
+BAD_CREDENTIALS = 'Unauthorized: The credentials were provided incorrectly or did not match any existing,
+ active credentials.'
 
-  PAYMENT_REQUIRED = 'Payment Required: There is no active subscription
- for the account associated with the credentials submitted with the request.'.freeze
+PAYMENT_REQUIRED = 'Payment Required: There is no active subscription
+ for the account associated with the credentials submitted with the request.'
 
-  FORBIDDEN = 'Because the international service is currently in a limited release phase, only approved accounts' \
-            ' may access the service.'.freeze
+REQUEST_ENTITY_TOO_LARGE = 'Request Entity Too Large: The request body has exceeded the maximum size.'
 
-  REQUEST_ENTITY_TOO_LARGE = 'Request Entity Too Large: The request body has exceeded the maximum size.'.freeze
+BAD_REQUEST = 'Bad Request (Malformed Payload): A GET request lacked a street field or the request body of a
+ POST request contained malformed JSON.'
 
-  BAD_REQUEST = 'Bad Request (Malformed Payload): A GET request lacked a street field or the request body of a
- POST request contained malformed JSON, possibly because a value was submitted as a number rather than as a string.'.freeze
+TOO_MANY_REQUESTS = 'When using public "website key" authentication,
+we restrict the number of requests coming from a given source over too short of a time.'
 
-  UNPROCESSABLE_ENTITY = 'GET request lacked required fields.'.freeze
+INTERNAL_SERVER_ERROR = 'Internal Server Error.'
 
-  TOO_MANY_REQUESTS = 'When using public "website key" authentication,
-we restrict the number of requests coming from a given source over too short of a time.'.freeze
-
-  INTERNAL_SERVER_ERROR = 'Internal Server Error.'.freeze
-
-  SERVICE_UNAVAILABLE = 'Service Unavailable. Try again later.'.freeze
-
-  GATEWAY_TIMEOUT = 'The upstream data provider did not respond in a timely fashion and the request failed. ' \
-                  'A serious, yet rare occurrence indeed.'.freeze
-end
+SERVICE_UNAVAILABLE = 'Service Unavailable. Try again later.'

data/lib/smartystreets_ruby_sdk/exceptions.rb

@@ -1,39 +1,28 @@
-module SmartyStreets
-
-  class SmartyError < StandardError
-  end
+class SmartyException < Exception
+end
 
-  class BadCredentialsError < SmartyError
-  end
+class BadCredentialsError < SmartyException
+end
 
-  class ForbiddenError < SmartyError
-  end
+class PaymentRequiredError < SmartyException
+end
 
-  class PaymentRequiredError < SmartyError
-  end
 
-  class RequestEntityTooLargeError < SmartyError
-  end
+class RequestEntityTooLargeError < SmartyException
+end
 
-  class BadRequestError < SmartyError
-  end
 
-  class UnprocessableEntityError < SmartyError
-  end
+class BadRequestError < SmartyException
+end
 
-  class TooManyRequestsError < SmartyError
-  end
 
-  class InternalServerError < SmartyError
-  end
+class TooManyRequestsError < SmartyException
+end
 
-  class ServiceUnavailableError < SmartyError
-  end
 
-  class GatewayTimeoutError < SmartyError
-  end
+class InternalServerError < SmartyException
+end
 
-  class BatchFullError < SmartyError
-  end
 
-end
+class ServiceUnavailableError < SmartyException
+end