lob 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a8c0c830106e832bbae29edd30ba92113856d60
-  data.tar.gz: cd9b46196b888da5ea9e7a4d85d692283b3c2adf
+  metadata.gz: 8e9405bed02fc2ea005d649b4563639b37a2a5d5
+  data.tar.gz: 238e9a1101eaf3aaf8848028a350508c60358a15
 SHA512:
-  metadata.gz: bed40a4effe60e29f7ab30dbac740c0fc4be8d99a170acf0349a62d053878261d7d1d823f21fc35b731ef17d4766860090390949b6bd40fb2b0bbcf5ea017e0c
-  data.tar.gz: 7686f7bf43a5f9ab78e08334dd072342569795d3b0c754518cf5f9dd37d5dc754ce57c3eb037e4af7de99daaca7211c8761956534fdddd14c05aa49022f2430a
+  metadata.gz: e762ca6ab03b0c90b578616270b7747ead4cc6152e73417656086d1cc09ff8b525118d3fbdc7e14851ee0463035d3d16c93d55c15a558088ae17993151ecf5fe
+  data.tar.gz: 1651326d4d44a238bbc1ff17ab4d9d4704bd80335eb298dbaad05f5f63296ab6275bb7b66d1da146c79318779955367956b6b7bfb1c64595f1f09cd2646b2b74

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [**2.5.0**](https://github.com/lob/lob-ruby/releases/tag/v2.5.0)
+- [**#140**] (https://github.com/lob/lob-ruby/pull/140) Adds access to response and headers
+
 ## [**2.4.0**](https://github.com/lob/lob-ruby/releases/tag/v2.4.0)
 - [**#136**] (https://github.com/lob/lob-ruby/pull/136) Adds find to routes
 

data/README.md

@@ -1,7 +1,5 @@
 # lob-ruby
 
-[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/lob/lob-ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
 [![Build Status](https://travis-ci.org/lob/lob-ruby.svg?branch=master)](https://travis-ci.org/lob/lob-ruby)
 [![Gem Version](https://badge.fury.io/rb/lob.svg)](http://badge.fury.io/rb/lob)
 [![Dependency Status](https://gemnasium.com/lob/lob-ruby.svg)](https://gemnasium.com/lob/lob-ruby)
@@ -85,6 +83,34 @@ When using zip codes with zero-prefixes, always quote them. For example when spe
 
 The Ruby interpreter assumes it's not of base-10 and tries to convert it to base-10 number. So that might result in an entirely different zip-code than intended.
 
+#### Accessing Response Headers
+
+You can access response headers via a hidden `headers` method on the response hash.
+
+```ruby
+addresses = @lob.addresses.list
+
+addresses._response.headers[:content_type]
+# => "application/json; charset=utf-8"
+
+addresses._response.headers[:rate_limit_window]
+# => "60"
+
+addresses._response.headers[:rate_limit_remaining]
+# => "1234"
+```
+
+You can also access headers from `Lob::InvalidRequestError`s.
+
+```ruby
+begin
+  @lob.objects.create(name: "Test", file: "https://lob.com/test.pdf", bad_param: "bad_value")
+rescue Lob::InvalidRequestError => e
+  e._response.headers[:content_type]
+  # => "application/json; charset=utf-8"
+end
+```
+
 ## Examples
 
 We've provided various examples for you to try out [here](https://github.com/lob/lob-ruby/tree/master/examples).

data/examples/checks.rb

@@ -2,7 +2,7 @@ $:.unshift File.expand_path("../lib", File.dirname(__FILE__))
 require 'lob'
 
 # initialize Lob object
-Lob.api_key = 'test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc'
+Lob.api_key = 'test_799ff27291c166d10ba191902ad02fb059c'
 @lob = Lob.load
 
 # create an address
@@ -29,6 +29,7 @@ from_address = @lob.addresses.create(
 bank_account = @lob.bank_accounts.create(
   routing_number: "322271627",
   account_number: "123456789",
+  account_type: "company",
   signatory: "John Doe"
 )
 

data/examples/csv_postcards/create_postcards.rb

@@ -3,7 +3,7 @@ require 'lob'
 require 'csv'
 
 # Initialize Lob object
-Lob.api_key = 'test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc'
+Lob.api_key = 'test_799ff27291c166d10ba191902ad02fb059c'
 @lob = Lob.load
 
 # Load the HTML from postcard_front.html and postcard_back.html.

data/examples/jobs.rb

@@ -3,7 +3,7 @@ require 'open-uri'
 require 'lob'
 
 # initialize Lob object
-Lob.api_key = 'test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc'
+Lob.api_key = 'test_799ff27291c166d10ba191902ad02fb059c'
 @lob = Lob.load
 
 html = %{

data/examples/letters.rb

@@ -2,7 +2,7 @@ $:.unshift File.expand_path("../lib", File.dirname(__FILE__))
 require 'lob'
 
 # initialize Lob object
-Lob.api_key = 'test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc'
+Lob.api_key = 'test_799ff27291c166d10ba191902ad02fb059c'
 @lob = Lob.load
 
 html = %{

data/examples/postcards.rb

@@ -2,7 +2,7 @@ $:.unshift File.expand_path("../lib", File.dirname(__FILE__))
 require 'lob'
 
 # initialize Lob object
-Lob.api_key = 'test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc'
+Lob.api_key = 'test_799ff27291c166d10ba191902ad02fb059c'
 @lob = Lob.load
 
 # HTML to send to the server

data/examples/verify/verify.rb

@@ -7,7 +7,7 @@ require 'lob'
 require 'street_address'
 
 # Initialize Lob object
-Lob.api_key = 'test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc'
+Lob.api_key = 'test_799ff27291c166d10ba191902ad02fb059c'
 @lob = Lob.load
 
 output = File.open(File.expand_path('../output.csv', __FILE__), 'w')

data/lib/lob.rb

@@ -26,17 +26,25 @@ module Lob
       if method == :get || method == :delete
         # Hack to URL encode nested objects like metadata.
         url = "#{url}?#{build_nested_query(parameters)}"
-        JSON.parse(RestClient.send(method, url, {
+        response = RestClient.send(method, url, {
           user_agent: 'Lob/v1 RubyBindings/' + clientVersion,
           "Lob-Version" => self.api_version
-        }))
+        })
       else
-        JSON.parse(RestClient.send(method, url, parameters, {
+        response = RestClient.send(method, url, parameters, {
           user_agent: 'Lob/v1 RubyBindings/' + clientVersion,
           "Lob-Version" => self.api_version
-        }))
+        })
       end
 
+      body = JSON.parse(response)
+
+      body.define_singleton_method(:_response) do
+        response
+      end
+
+      return body
+
     rescue RestClient::ExceptionWithResponse => e
       handle_api_error(e)
     end

data/lib/lob/errors/lob_error.rb

@@ -1,4 +1,5 @@
 module Lob
+
   class LobError < StandardError
     attr_reader :http_status, :http_body, :json_body
 
@@ -9,5 +10,11 @@ module Lob
       status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
       super("#{status_string}#{message} \n #{@http_body}")
     end
+
+    def _response
+      @json_body
+    end
+
   end
+
 end

data/lib/lob/version.rb

@@ -1,3 +1,3 @@
 module Lob
-  VERSION = "2.4.0"
+  VERSION = "2.5.0"
 end

data/spec/lob/v1/bank_account_spec.rb

@@ -5,7 +5,9 @@ describe Lob::V1::BankAccount do
   before :each do
     @sample_bank_account_params = {
       routing_number: "122100024",
-      account_number: "123456789"
+      account_number: "123456789",
+      account_type: "company",
+      signatory: "John Doe"
     }
   end
 
@@ -21,11 +23,7 @@ describe Lob::V1::BankAccount do
   describe "create" do
 
     it "should create a bank account" do
-      result = subject.bank_accounts.create(
-        routing_number: @sample_bank_account_params[:routing_number],
-        account_number: @sample_bank_account_params[:account_number],
-        signatory: "John Doe"
-      )
+      result = subject.bank_accounts.create(@sample_bank_account_params)
 
       result["account_number"].must_equal(@sample_bank_account_params[:account_number])
     end
@@ -35,11 +33,7 @@ describe Lob::V1::BankAccount do
 
   describe "find" do
     it "should find a bank account" do
-      new_bank_account = subject.bank_accounts.create(
-        routing_number: @sample_bank_account_params[:routing_number],
-        account_number: @sample_bank_account_params[:account_number],
-        signatory: "John Doe"
-      )
+      new_bank_account = subject.bank_accounts.create(@sample_bank_account_params)
 
       result  = subject.bank_accounts.find(new_bank_account["id"])
       result["id"].must_equal(new_bank_account["id"])
@@ -48,11 +42,7 @@ describe Lob::V1::BankAccount do
 
   describe "destroy" do
     it "should delete a bank_account" do
-      new_bank_account = subject.bank_accounts.create(
-        routing_number: @sample_bank_account_params[:routing_number],
-        account_number: @sample_bank_account_params[:account_number],
-        signatory: "John Doe"
-      )
+      new_bank_account = subject.bank_accounts.create(@sample_bank_account_params)
 
       delete_result = subject.bank_accounts.destroy(new_bank_account["id"])
       assert_equal(new_bank_account["id"], delete_result["id"])
@@ -61,11 +51,7 @@ describe Lob::V1::BankAccount do
 
   describe "verify" do
     it "should verify a bank account" do
-      new_bank_account = subject.bank_accounts.create(
-        routing_number: @sample_bank_account_params[:routing_number],
-        account_number: @sample_bank_account_params[:account_number],
-        signatory: "John Doe"
-      )
+      new_bank_account = subject.bank_accounts.create(@sample_bank_account_params)
 
       verify_result = subject.bank_accounts.verify(new_bank_account["id"], amounts: [12, 34])
       assert_equal(new_bank_account["id"], verify_result["id"])

data/spec/lob/v1/check_spec.rb

@@ -17,7 +17,9 @@ describe Lob::V1::Check do
 
     @sample_bank_account_params = {
       routing_number: "122100024",
-      account_number: "123456789"
+      account_number: "123456789",
+      account_type: "company",
+      signatory: "John Doe"
     }
   end
 
@@ -33,11 +35,7 @@ describe Lob::V1::Check do
     it "should create a check with bank account id" do
       new_address = subject.addresses.create @sample_address_params
 
-      new_bank_account = subject.bank_accounts.create(
-        routing_number: @sample_bank_account_params[:routing_number],
-        account_number: @sample_bank_account_params[:account_number],
-        signatory: "John Doe"
-      )
+      new_bank_account = subject.bank_accounts.create(@sample_bank_account_params)
 
       subject.bank_accounts.verify(new_bank_account["id"], amounts: [1, 2])
 
@@ -57,11 +55,7 @@ describe Lob::V1::Check do
     it "should find a check" do
       new_address = subject.addresses.create @sample_address_params
 
-      new_bank_account = subject.bank_accounts.create(
-        routing_number: @sample_bank_account_params[:routing_number],
-        account_number: @sample_bank_account_params[:account_number],
-        signatory: "John Doe"
-      )
+      new_bank_account = subject.bank_accounts.create(@sample_bank_account_params)
 
       subject.bank_accounts.verify(new_bank_account["id"], amounts: [1, 2])
 

data/spec/lob_spec.rb

@@ -62,4 +62,20 @@ describe Lob do
     lob.addresses.list
     Lob.api_version = "2014-11-24"
   end
+
+  it "should include the raw response" do
+    lob = Lob.load(api_key: ENV["LOB_API_KEY"])
+    result = lob.addresses.list
+    assert result._response.headers.include?(:content_type)
+  end
+
+  it "should include response headers for errors" do
+    lob = Lob.load(api_key: ENV["LOB_API_KEY"])
+    begin
+      lob.objects.create(name: "Test", file: "https://lob.com/test.pdf", bad_param: "bad_value")
+    rescue Lob::InvalidRequestError => e
+      assert e._response.headers.include?(:content_type)
+    end
+  end
+
 end

metadata

@@ -1,139 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: lob
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Lob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-12 00:00:00.000000000 Z
+date: 2016-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.4.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 5.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 5.6.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: travis-lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
 description: Lob API Ruby wrapper
@@ -143,8 +143,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -208,17 +208,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Lob.com API with ActiveRecord-style syntax