smartystreets_ruby_sdk 3.0.0 → 3.1.0

data/Makefile

@@ -1,6 +1,6 @@
 #!/usr/bin/make -f
 
-SOURCE_VERSION := 3.0
+SOURCE_VERSION := 3.1
 
 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/README.md

@@ -6,6 +6,12 @@ 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/122129.png)](https://asciinema.org/a/122129)
+
+---
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,8 +26,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install smartystreets_ruby_sdk
-
+    $ gem install smartystreets_ruby_sdk    
 
 
 

data/lib/smartystreets_ruby_sdk/client_builder.rb

@@ -27,8 +27,9 @@ class ClientBuilder
     @serializer = NativeSerializer.new
     @http_sender = nil
     @max_retries = 5
-    @max_timeout = 10000
+    @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)
@@ -73,6 +74,15 @@ class ClientBuilder
     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)
@@ -101,7 +111,7 @@ class ClientBuilder
   def build_sender
     return @http_sender unless @http_sender.nil?
 
-    sender = NativeSender.new(@max_timeout)
+    sender = NativeSender.new(@max_timeout, @proxy)
 
     sender = StatusCodeSender.new(sender)
 

data/lib/smartystreets_ruby_sdk/native_sender.rb

@@ -3,16 +3,16 @@ require_relative 'version'
 require_relative 'response'
 
 class NativeSender
-  def initialize(max_timeout=10000)
+  def initialize(max_timeout = 10_000, proxy = nil)
     @max_timeout = max_timeout
+    @proxy = proxy
   end
 
   def send(smarty_request)
     request = self.class.build_request(smarty_request)
-    uri = request.uri
 
     begin
-      http = Net::HTTP.new(uri.hostname, uri.port)
+      http = build_http(request)
       http.use_ssl = true
       http.ssl_version = :TLSv1_2
       http.read_timeout = @max_timeout
@@ -20,7 +20,7 @@ class NativeSender
       response = http.request(request)
 
       http.finish if http.started?
-    rescue Exception => err
+    rescue StandardError => err
       return Response.new(nil, nil, err)
     end
 
@@ -29,11 +29,13 @@ class NativeSender
 
   def self.build_request(smarty_request)
     query = create_query(smarty_request)
+
     if smarty_request.payload.nil?
       request = Net::HTTP::Get.new(URI.parse("#{smarty_request.url_prefix}?#{query}"))
     else
       request = Net::HTTP::Post.new(URI.parse("#{smarty_request.url_prefix}?#{query}"))
     end
+
     request.content_type = 'application/json'
     request.body = smarty_request.payload
     request['User-Agent'] = "smartystreets (sdk:ruby@#{SmartystreetsRubySdk::VERSION})"
@@ -46,6 +48,19 @@ class NativeSender
     Response.new(native_response.body, native_response.code)
   end
 
+  def build_http(request)
+    uri = request.uri
+
+    if @proxy.nil?
+      http = Net::HTTP.new(uri.hostname, uri.port)
+    else
+      http = Net::HTTP.new(uri.hostname, uri.port, @proxy.host,
+                           @proxy.port, @proxy.username, @proxy.password)
+    end
+
+    http
+  end
+
   def self.create_query(smarty_request)
     query_string = ''
 

data/lib/smartystreets_ruby_sdk/proxy.rb

@@ -0,0 +1,16 @@
+module SmartystreetsRubySdk
+  # Contains information about the proxy through which all requests will be sent.
+  #
+  # host should not include a scheme
+  class Proxy
+
+    attr_accessor :port, :host, :username, :password
+
+    def initialize(host, port, username = nil, password = nil)
+      @host = host
+      @port = port
+      @username = username
+      @password = password
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/version.rb

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

data/ruby-sdk-demo.json

@@ -0,0 +1,366 @@
+{
+  "version": 1,
+  "width": 100,
+  "height": 45,
+  "duration": 25.40302,
+  "command": null,
+  "title": null,
+  "env": {
+    "TERM": "xterm-256color",
+    "SHELL": "/bin/bash"
+  },
+  "stdout": [
+    [
+      0.000875,
+      "\u001b[?1034hbash-3.2$ "
+    ],
+    [
+      1.0,
+      "g"
+    ],
+    [
+      0.096613,
+      "e"
+    ],
+    [
+      0.199543,
+      "m"
+    ],
+    [
+      0.120305,
+      " "
+    ],
+    [
+      0.360287,
+      "i"
+    ],
+    [
+      0.167696,
+      "n"
+    ],
+    [
+      0.119548,
+      "s"
+    ],
+    [
+      0.143402,
+      "t"
+    ],
+    [
+      0.096943,
+      "a"
+    ],
+    [
+      0.159451,
+      "l"
+    ],
+    [
+      0.152755,
+      "l"
+    ],
+    [
+      0.472194,
+      " "
+    ],
+    [
+      0.415625,
+      "s"
+    ],
+    [
+      0.128058,
+      "m"
+    ],
+    [
+      0.136152,
+      "a"
+    ],
+    [
+      0.263332,
+      "r"
+    ],
+    [
+      0.224605,
+      "t"
+    ],
+    [
+      0.44166,
+      "y"
+    ],
+    [
+      0.254094,
+      "s"
+    ],
+    [
+      0.127964,
+      "t"
+    ],
+    [
+      0.112037,
+      "r"
+    ],
+    [
+      0.256337,
+      "e"
+    ],
+    [
+      0.135907,
+      "e"
+    ],
+    [
+      0.271188,
+      "t"
+    ],
+    [
+      0.096752,
+      "s"
+    ],
+    [
+      0.543902,
+      "_"
+    ],
+    [
+      0.303509,
+      "r"
+    ],
+    [
+      0.208053,
+      "u"
+    ],
+    [
+      0.248442,
+      "b"
+    ],
+    [
+      0.263945,
+      "y"
+    ],
+    [
+      0.472192,
+      "_"
+    ],
+    [
+      0.583879,
+      "s"
+    ],
+    [
+      0.136072,
+      "d"
+    ],
+    [
+      0.335389,
+      "k"
+    ],
+    [
+      0.711499,
+      "\r\n"
+    ],
+    [
+      0.622611,
+      "Successfully installed smartystreets_ruby_sdk-3.0.0\r\n"
+    ],
+    [
+      0.112475,
+      "Parsing documentation for smartystreets_ruby_sdk-3.0.0\r\n"
+    ],
+    [
+      0.233239,
+      "Installing ri documentation for smartystreets_ruby_sdk-3.0.0\r\n"
+    ],
+    [
+      0.076259,
+      "Done installing documentation for smartystreets_ruby_sdk after 0 seconds\r\n1 gem installed\r\n"
+    ],
+    [
+      0.011916,
+      "bash-3.2$ "
+    ],
+    [
+      1.0,
+      "\r\n"
+    ],
+    [
+      4e-05,
+      "bash-3.2$ "
+    ],
+    [
+      0.144236,
+      "\r\n"
+    ],
+    [
+      3.9e-05,
+      "bash-3.2$ "
+    ],
+    [
+      0.305081,
+      "c"
+    ],
+    [
+      0.103617,
+      "a"
+    ],
+    [
+      0.287387,
+      "t"
+    ],
+    [
+      0.960198,
+      " "
+    ],
+    [
+      1.0,
+      "e"
+    ],
+    [
+      0.503401,
+      "x"
+    ],
+    [
+      0.144016,
+      "a"
+    ],
+    [
+      0.320538,
+      "m"
+    ],
+    [
+      0.136119,
+      "p"
+    ],
+    [
+      0.327256,
+      "l"
+    ],
+    [
+      0.400419,
+      "e"
+    ],
+    [
+      0.592251,
+      "."
+    ],
+    [
+      0.535542,
+      "r"
+    ],
+    [
+      0.320377,
+      "b"
+    ],
+    [
+      0.230569,
+      "\r\n"
+    ],
+    [
+      0.00306,
+      "require 'smartystreets_ruby_sdk/client_builder'\r\nrequire 'smartystreets_ruby_sdk/static_credentials'\r\nrequire 'smartystreets_ruby_sdk/us_street'\r\n\r\n\r\nclass Example\r\n  def run\r\n    # This keypair will have been deleted by the time you are watching this video... \r\n    auth_id = 'c4df4ec8-2be0-8ccc-8762-d899ce38d1db'\r\n    auth_token = 'KXb5V3XlB537Fx3XIgaa'\r\n    credentials = StaticCredentials.new(auth_id, auth_token)\r\n\r\n    puts 'Step 0. Wire up the client with your keypair.'\r\n    client = ClientBuilder.new(credentials).build_us_street_api_client\r\n\r\n    puts 'Step 1. Make a lookup. (BTW, you can also send entire batches of lookups...)'\r\n    lookup = USStreet::Lookup.new\r\n    lookup.street = '1 Rosedale'\r\n    lookup.lastline = 'Baltimore MD'\r\n    lookup.candidates = 10\r\n\r\n    puts 'Step 2. Send the lookup.'\r\n    client.send_lookup(lookup)\r\n\r\n    puts 'Step 3. Show the resulting candidate addresses:'\r\n    lookup.result.each_with_index do |candidate, c|\r\n      puts \"- #{c}: #{candidate.delivery_line_1}, #{candidat"
+    ],
+    [
+      3e-05,
+      "e.last_line}\\n\"\r\n    end\r\n  end\r\nend\r\n\r\nExample.new.run"
+    ],
+    [
+      0.000304,
+      "bash-3.2$ "
+    ],
+    [
+      1.0,
+      "\r\n"
+    ],
+    [
+      2.5e-05,
+      "bash-3.2$ "
+    ],
+    [
+      0.14381,
+      "\r\n"
+    ],
+    [
+      6.9e-05,
+      "bash-3.2$ "
+    ],
+    [
+      0.14446,
+      "\r\n"
+    ],
+    [
+      3.7e-05,
+      "bash-3.2$ "
+    ],
+    [
+      1.0,
+      "r"
+    ],
+    [
+      0.144148,
+      "u"
+    ],
+    [
+      0.183292,
+      "b"
+    ],
+    [
+      0.160194,
+      "y"
+    ],
+    [
+      0.143947,
+      " "
+    ],
+    [
+      0.223659,
+      "e"
+    ],
+    [
+      0.465012,
+      "x"
+    ],
+    [
+      0.135554,
+      "a"
+    ],
+    [
+      0.21534,
+      "m"
+    ],
+    [
+      0.112946,
+      "p"
+    ],
+    [
+      0.217044,
+      "l"
+    ],
+    [
+      0.614323,
+      "e"
+    ],
+    [
+      0.648622,
+      "."
+    ],
+    [
+      0.399935,
+      "r"
+    ],
+    [
+      0.271424,
+      "b"
+    ],
+    [
+      0.687326,
+      "\r\n"
+    ],
+    [
+      0.072413,
+      "Step 0. Wire up the client with your keypair.\r\nStep 1. Make a lookup. (BTW, you can also send entire batches of lookups...)\r\nStep 2. Send the lookup.\r\n"
+    ],
+    [
+      0.248917,
+      "Step 3. Show the resulting candidate addresses:\r\n- 0: 1 N Rosedale St, Baltimore MD 21229-3737\r\n- 1: 1 S Rosedale St, Baltimore MD 21229-3739\r\n"
+    ],
+    [
+      0.007523,
+      "bash-3.2$ "
+    ]
+  ]
+}

metadata

@@ -1,75 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: smartystreets_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
+  prerelease: 
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-28 00:00:00.000000000 Z
+date: 2017-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.8'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 5.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.8'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 5.8.3
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.12.0
 description: 
@@ -79,7 +88,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - Makefile
@@ -113,6 +122,7 @@ files:
 - lib/smartystreets_ruby_sdk/logger.rb
 - lib/smartystreets_ruby_sdk/native_sender.rb
 - lib/smartystreets_ruby_sdk/native_serializer.rb
+- lib/smartystreets_ruby_sdk/proxy.rb
 - lib/smartystreets_ruby_sdk/request.rb
 - lib/smartystreets_ruby_sdk/response.rb
 - lib/smartystreets_ruby_sdk/retry_sender.rb
@@ -149,29 +159,31 @@ files:
 - lib/smartystreets_ruby_sdk/us_zipcode/result.rb
 - lib/smartystreets_ruby_sdk/us_zipcode/zip_code.rb
 - lib/smartystreets_ruby_sdk/version.rb
+- ruby-sdk-demo.json
 - smartystreets_ruby_sdk.gemspec
 homepage: https://github.com/smartystreets/smartystreets-ruby-sdk
 licenses:
 - Apache-2.0
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: An official library for the SmartyStreets APIs
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 64962ee9e3575877e78359805f3a0aad0bb6ab33
-  data.tar.gz: a7fe26f68f4dc756ae3955aca126fba7c4c3f0c4
-SHA512:
-  metadata.gz: 5aeb2e1c9161f295dd43400ae198147e357628740c6432c1ee25f28e51d4d89fcf79c4533f89d720bdfc4ec0d1a1cc1cee5d1e6c122fac49c22d67f66bcf18bf
-  data.tar.gz: dc7caf151400097419930d2b8009b6fa7e8b94eef69000c3d0f5287cc4a5266c36f7d78993f6e44efd20205defaf81257d92e31ee01788d0f12c755201637cbb