lob 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60cbebd187822d990d08ff1ce74e6b41faf7db5c
-  data.tar.gz: dc579e12bbaf88d3103ee6d85b6ea02eb7c709fc
+  metadata.gz: b3b68ba605652bb33bfc8268a5206535c789e782
+  data.tar.gz: 021b89f967b4068c187dda6e28ba0596f60b8eed
 SHA512:
-  metadata.gz: 73bd53c29b259fc11aefde2eea25b56e9a3edad30d01ebcc603f438f160d2b28b18542f7b4d76a5729b8f4196a03eb2f5d14460e31445639b8e6fd6f1e74927c
-  data.tar.gz: 5b47f1f99342c3d6dfdee5308535a1d92034a410892fa6383d4be83935c160a820fb487a4a464e2b6493bb191af953460347996c4f0b0eb21eca1828fb8ec0f8
+  metadata.gz: 31aa41cf8e88f3539f9b55a79b94e263531dcade74e788a93aa13f691e9319f48c6a29a3ae1802ee34f9b5fb2f56d8c06af5ba15731dbb09467a25eff2516b62
+  data.tar.gz: 9b7c0e47589e6967f3fda9f11b5012045d48da12c8c59cc5ee5aa387f3520885c9dc3b5f8928b0dbd5c769fc02f0f4c9d6d708f8816eb8bc966c05d0c44c9a1a

data/README.md

@@ -119,11 +119,12 @@ end
 ```ruby
 # name, to-address and object are the arguments
 # to-address can be specified as an address-id
-@lob.jobs.create("New Cool Posters", "to-address-id", "object-id")
+@lob.jobs.create("New Cool Posters", "from-address-id", "to-address-id", "object-id")
 
 # to-address can also be specified as address params to create new address
 @lob.jobs.create(
   "New Cool Posters",
+  {name: "FromAddress", address_line1: "120, 6th Ave", city: "Boston", country: "USA", zip: 12345},
   {name: "ToAddress", address_line1: "120, 6th Ave", city: "Boston", country: "USA", zip: 12345},
   "object-id"
 )
@@ -132,6 +133,7 @@ end
 # and other options like packaging_id an setting_id
 @lob.jobs.create(
   "New Cool Posters",
+  "from-address-id",
   "to-address-id",
   "object-id",
   {
@@ -140,6 +142,16 @@ end
     setting_id: "some-setting-id"
   }
 )
+
+# Or add a job with multiple objects
+
+@lob.jobs.create(
+  "New Cool Posters",
+  "from-address-id",
+  {name: "ToAddress", address_line1: "120, 6th Ave", city: "Boston", country: "USA", zip: 12345},
+  ["object-id", "another-object-id"]
+)
+
 ```
 
 #### List jobs
@@ -263,13 +275,63 @@ You'll have to specify either the `message` option or the `back` option.
 @lob.services.list
 ```
 
-### Settings
+### Bank accounts
+
+#### List bank accounts
+
+```ruby
+# returns a list of accounts
+@lob.bank_accounts.list
+```
+
+#### Add a bank account
+
+```ruby
+bank_address = {name: "ToAddress", address_line1: "120, 6th Ave", city: "Boston", country: "USA", zip: 12345}
+account_address = {name: "ToAddress", address_line1: "120, 6th Ave", city: "Boston", country: "USA", zip: 12345}
+
+# Pass address params or address IDs
+# The 5th argument is the options argument and is optional
+@lob.bank_accounts.create("routing_number", bank_address, "account_number", account_address)
+```
+
+#### Find a bank account
+
+```ruby
+@lob.bank_accounts.find "bank-account-id"
+```
+
+### Checks
+
+#### Create a check
+
+```ruby
+# Transfer $5000 to a bank account.
+@lob.checks.create("bank-account-id", "to-address-ID", 5000)
+
+# For the "to" address, you can pass params or an address ID
+# You can also specify an optional 4th argument, with other options.
+```
+
+#### List checks
+
+```ruby
+@lob.checks.list
+```
+
+#### Find a check
+
+```ruby
+@lob.checks.find("check-id")
+```
+
+### Supported countries
 
-#### List settings
+#### List supported countries
 
 ```ruby
-# returns a list of settings
-@lob.settings.list
+# returns a list of countries
+@lob.countries.list
 ```
 
 ## Developing

data/lib/lob.rb

@@ -10,7 +10,9 @@ require "lob/v1/packaging"
 require "lob/v1/postcard"
 require "lob/v1/service"
 require "lob/v1/setting"
-
+require "lob/v1/country"
+require "lob/v1/check"
+require "lob/v1/bank_account"
 
 module Lob
 
@@ -43,8 +45,16 @@ module Lob
     error_message = nil
     raise e unless e.respond_to? :http_body
     begin
-      error_message = JSON(e.http_body)["errors"].first.values.first
-    rescue
+      json = JSON(e.http_body)
+
+      if json.has_key? 'errors'
+        error_message = json["errors"].first.values.first
+      elsif json.has_key? 'message'
+        error_message = json["message"]
+      else
+        error_message = "Unknown error: #{json}"
+      end
+    rescue => e
       raise e
     end
     raise Lob::Error.new(error_message)

data/lib/lob/v1/bank_account.rb

@@ -0,0 +1,45 @@
+module Lob
+  module V1
+    class BankAccount
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def list(options={})
+        Lob.submit(:get, bank_account_url, options)["data"] || []
+      end
+
+      def find(bank_account_id)
+        Lob.submit :get, bank_account_url(bank_account_id)
+      end
+
+      def create(routing_number, bank_address, account_number, account_address, options = {})
+        options = {
+          routing_number: routing_number,
+          bank_address:   bank_address,
+          account_number:  account_number,
+          account_address: account_address
+        }.merge(options)
+
+        if !options[:bank_address].is_a?(String)
+          options[:bank_address] = @resource.format_address_params(options[:bank_address])
+        end
+
+        if !options[:account_address].is_a?(String)
+          options[:account_address] = @resource.format_address_params(options[:account_address])
+        end
+
+        Lob.submit :post, bank_account_url, options
+      end
+
+
+      private
+
+      def bank_account_url(bank_account_id = nil)
+        @resource.construct_url("bank_accounts", bank_account_id)
+      end
+
+    end
+  end
+end

data/lib/lob/v1/check.rb

@@ -0,0 +1,36 @@
+module Lob
+  module V1
+    class Check
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def list(options={})
+        Lob.submit(:get, check_url, options)["data"] || []
+      end
+
+      def find(check_id)
+        Lob.submit :get, check_url(check_id)
+      end
+
+      def create(bank_account, to, amount, options = {})
+        params = { bank_account: bank_account, to: to, amount: amount }.merge(options)
+
+        if !params[:to].is_a?(String)
+          params[:to] = @resource.format_address_params(params[:to])
+        end
+
+        Lob.submit :post, check_url, params
+      end
+
+
+      private
+
+      def check_url(check_id = nil)
+        @resource.construct_url("checks", check_id)
+      end
+
+    end
+  end
+end

data/lib/lob/v1/country.rb

@@ -0,0 +1,21 @@
+module Lob
+  module V1
+    class Country
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def list(options={})
+        Lob.submit(:get, country_url, options)["data"] || []
+      end
+
+      private
+
+      def country_url
+        @resource.construct_url("countries")
+      end
+
+    end
+  end
+end

data/lib/lob/v1/job.rb

@@ -14,8 +14,16 @@ module Lob
         Lob.submit :get, job_url(job_id)
       end
 
-      def create(name, to, object1, options = {})
-        options = { name: name, to: to, object1: object1 }.merge(options)
+      def create(name, from, to, objects, options = {})
+        options = { name: name, to: to, from: from}.merge(options)
+
+        if objects.is_a?(Array)
+          objects.each_with_index do |object, index|
+            options["object#{index}"] = object
+          end
+        else
+          options["object1"] = objects
+        end
 
         if options[:to] && !options[:to].is_a?(String)
           options[:to] = @resource.format_address_params(options[:to])

data/lib/lob/v1/resource.rb

@@ -36,6 +36,23 @@ module Lob
         Lob::V1::Setting.new(self)
       end
 
+      def countries
+        Lob::V1::Country.new(self)
+      end
+
+      def checks
+        Lob::V1::Check.new(self)
+      end
+
+      def cheques
+        Lob::V1::Check.new(self)
+      end
+
+      def bank_accounts
+        Lob::V1::BankAccount.new(self)
+      end
+
+
       def base_url
         "#{@options[:protocol]}://#{@options[:api_key]}:@#{@options[:api_host]}/v1"
       end
@@ -50,12 +67,14 @@ module Lob
           Lob.require_options(params, :name, :address_line1, :city, :state, :zip, :country)
         end
 
+        new_params = params.clone
+
         [:city, :state, :zip, :country].each do |option|
-          params["address_#{option}".to_sym] = params[option] if params[option]
-          params.delete(option)
+          new_params["address_#{option}".to_sym] = params[option] if params[option]
+          new_params.delete(option)
         end
 
-        params
+        new_params
       end
 
     end

data/lob.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "lob"
-  spec.version       = "1.0.3"
+  spec.version       = "1.0.5"
   spec.authors       = ["Akash Manohar J"]
   spec.email         = ["akash@akash.im"]
   spec.description   = %q{Lob API Ruby wrapper}

data/spec/lob/v1/address_spec.rb

@@ -1,9 +1,20 @@
 require "spec_helper"
 
 describe Lob::V1::Address do
+  let(:sample_params2) {
+    {
+      name:    "Russell Smith",
+      email:   "test@test.com",
+      address_line1: "673 Brannan",
+      city:    "San Francisco",
+      state:   "CA",
+      country: "US",
+      zip:     94107
+    }
+  }
 
-  before :each do
-    @sample_params = {
+  let(:sample_params) {
+    {
       name:    "Test",
       email:   "test@test.com",
       address_line1: "220 WILLIAM T MORRISSEY BLVD",
@@ -12,18 +23,33 @@ describe Lob::V1::Address do
       country: "US",
       zip:     02125
     }
-  end
+  }
 
   subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
 
   describe "verify" do
+    it "should verify an address" do
+      assert_raises(Lob::Error) do
+        VCR.use_cassette('verify_address2') do
+          result = subject.addresses.verify(
+            address_line1: sample_params2[:address_line1],
+            city:  sample_params2[:city],
+            state: sample_params2[:state],
+            zip:   sample_params2[:zip]
+          )
+
+          result["address"]["address_country"].must_equal("US")
+        end
+      end
+    end
+
     it "should verify an address" do
       VCR.use_cassette('verify_address') do
         result = subject.addresses.verify(
-          address_line1: @sample_params[:address_line1],
-          city:  @sample_params[:city],
-          state: @sample_params[:state],
-          zip:   @sample_params[:zip]
+          address_line1: sample_params[:address_line1],
+          city:  sample_params[:city],
+          state: sample_params[:state],
+          zip:   sample_params[:zip]
         )
 
         result["address"]["address_country"].must_equal("US")
@@ -35,10 +61,10 @@ describe Lob::V1::Address do
   describe "list" do
     it "should list addresses" do
       VCR.use_cassette('list_addresses') do
-        new_address = subject.addresses.create @sample_params
+        new_address = subject.addresses.create sample_params
 
         list_result = subject.addresses.list
-        assert /#{new_address["name"]}/ =~ list_result.to_s
+        assert /#{new_address["name"]}/i =~ list_result.to_s
       end
     end
   end
@@ -47,8 +73,8 @@ describe Lob::V1::Address do
   describe "create" do
     it "should create an address" do
       VCR.use_cassette('create_address') do
-        result = subject.addresses.create @sample_params
-        result["name"].must_equal(@sample_params[:name])
+        result = subject.addresses.create sample_params
+        assert /#{result["name"]}/i =~ sample_params[:name]
       end
     end
   end
@@ -57,10 +83,10 @@ describe Lob::V1::Address do
   describe "find" do
     it "should find an address" do
       VCR.use_cassette('find_address') do
-        new_address = subject.addresses.create @sample_params
+        new_address = subject.addresses.create sample_params
 
         find_result = subject.addresses.find(new_address["id"])
-        find_result["name"].must_equal(@sample_params[:name])
+        assert /#{find_result["name"]}/i =~ sample_params[:name]
       end
     end
   end
@@ -69,7 +95,7 @@ describe Lob::V1::Address do
   describe "destroy" do
     it "should delete an address" do
       VCR.use_cassette('delete_address') do
-        new_address = subject.addresses.create @sample_params
+        new_address = subject.addresses.create sample_params
 
         delete_result = subject.addresses.destroy(new_address["id"])
         assert /has been deleted/ =~ delete_result["message"]

data/spec/lob/v1/bank_account_spec.rb

@@ -0,0 +1,94 @@
+require "spec_helper"
+
+describe Lob::V1::BankAccount do
+
+  before :each do
+    @sample_address_params = {
+      name:    "TestAddress",
+      email:   "test@test.com",
+      address_line1: "123 Test Street",
+      address_line2: "Unit 199",
+      city:    "Mountain View",
+      state:   "CA",
+      country: "US",
+      zip:     94085
+    }
+
+    @sample_bank_account_params = {
+      routing_number: "123456789",
+      account_number: "123456789"
+    }
+  end
+
+  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+
+  describe "list" do
+    it "should list bank accounts" do
+      VCR.use_cassette('list_bank_accounts') do
+
+        new_bank_account = subject.bank_accounts.create(
+          @sample_bank_account_params[:routing_number],
+          @sample_address_params.clone,
+          @sample_bank_account_params[:account_number],
+          @sample_address_params.clone
+        )
+
+        list_result = subject.bank_accounts.list
+        assert /#{new_bank_account["id"]}/i =~ list_result.to_s
+      end
+    end
+  end
+
+
+  describe "create" do
+    it "should create a bank account with address_id" do
+      VCR.use_cassette('create_bank_account_with_address_id') do
+        new_address = subject.addresses.create @sample_address_params
+
+        result = subject.bank_accounts.create(
+          @sample_bank_account_params[:routing_number],
+          new_address["id"],
+          @sample_bank_account_params[:account_number],
+          new_address["id"]
+        )
+
+        result["account_number"].must_equal(@sample_bank_account_params[:account_number])
+      end
+    end
+
+
+    it "should create a bank account with address params" do
+      VCR.use_cassette('create_bank_account_with_address_params') do
+
+        result = subject.bank_accounts.create(
+          @sample_bank_account_params[:routing_number],
+          @sample_address_params.clone,
+          @sample_bank_account_params[:account_number],
+          @sample_address_params.clone
+        )
+
+        result["account_number"].must_equal(@sample_bank_account_params[:account_number])
+      end
+    end
+  end
+
+
+  describe "find" do
+    it "should find a bank account" do
+      VCR.use_cassette('find_bank_account') do
+        new_address = subject.addresses.create @sample_address_params
+
+        new_bank_account = subject.bank_accounts.create(
+          @sample_bank_account_params[:routing_number],
+          new_address["id"],
+          @sample_bank_account_params[:account_number],
+          new_address["id"]
+        )
+
+        result  = subject.bank_accounts.find(new_bank_account["id"])
+        result["id"].must_equal(new_bank_account["id"])
+      end
+    end
+  end
+
+end

data/spec/lob/v1/check_spec.rb

@@ -0,0 +1,93 @@
+require "spec_helper"
+
+describe Lob::V1::Check do
+
+  before :each do
+    @sample_address_params = {
+      name:    "TestAddress",
+      email:   "test@test.com",
+      address_line1: "123 Test Street",
+      address_line2: "Unit 199",
+      city:    "Mountain View",
+      state:   "CA",
+      country: "US",
+      zip:     94085
+    }
+
+    @sample_bank_account_params = {
+      routing_number: "123456789",
+      account_number: "123456789"
+    }
+  end
+
+  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+
+  describe "list" do
+    it "should list checks" do
+      VCR.use_cassette('list_checks') do
+        new_address = subject.addresses.create @sample_address_params
+
+        new_bank_account = subject.bank_accounts.create(
+          @sample_bank_account_params[:routing_number],
+          @sample_address_params,
+          @sample_bank_account_params[:account_number],
+          @sample_address_params
+        )
+
+
+        new_check = subject.checks.create(
+          new_bank_account["id"], @sample_address_params, 2000
+        )
+
+        list_result = subject.checks.list
+        assert /#{new_check["id"]}/i =~ list_result.to_s
+      end
+    end
+  end
+
+
+  describe "create" do
+    it "should create a check with bank account id" do
+      VCR.use_cassette('create_check_with_bank_account_id') do
+        new_address = subject.addresses.create @sample_address_params
+
+        new_bank_account = subject.bank_accounts.create(
+          @sample_bank_account_params[:routing_number],
+          @sample_address_params,
+          @sample_bank_account_params[:account_number],
+          @sample_address_params
+        )
+
+        result = subject.checks.create(
+          new_bank_account["id"], new_address["id"], "2000"
+        )
+
+        result["amount"].to_s.must_equal("2000.00")
+      end
+    end
+  end
+
+
+  describe "find" do
+    it "should find a check" do
+      VCR.use_cassette('find_check') do
+        new_address = subject.addresses.create @sample_address_params
+
+        new_bank_account = subject.bank_accounts.create(
+          @sample_bank_account_params[:routing_number],
+          @sample_address_params,
+          @sample_bank_account_params[:account_number],
+          @sample_address_params
+        )
+
+        new_check = subject.checks.create(
+          new_bank_account["id"], new_address["id"], 2000
+        )
+
+        result = subject.checks.find(new_check["id"])
+        result["id"].must_equal(new_check["id"])
+      end
+    end
+  end
+
+end

data/spec/lob/v1/country_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+describe Lob::V1::Country do
+
+  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+
+  describe "list" do
+    it "should list countries" do
+      VCR.use_cassette('list_countries') do
+        result = subject.countries.list
+        result.length.must_be :>, 0
+      end
+    end
+  end
+
+end

data/spec/lob/v1/job_spec.rb

@@ -36,6 +36,7 @@ describe Lob::V1::Job do
         new_job = subject.jobs.create(
           @sample_job_params[:name],
           new_address["id"],
+          new_address["id"],
           new_object["id"]
         )
 
@@ -58,11 +59,42 @@ describe Lob::V1::Job do
           @test_setting_id
         )
 
-        result = subject.jobs.create(@sample_job_params[:name], new_address["id"], new_object["id"])
+        result = subject.jobs.create(@sample_job_params[:name], new_address["id"], new_address["id"], new_object["id"])
         result["name"].must_equal(@sample_job_params[:name])
       end
     end
 
+
+    it "should be able to create multiple jobs" do
+      VCR.use_cassette('create_multiple_jobs') do
+        new_address = subject.addresses.create @sample_address_params
+
+        settings_list = subject.settings.list
+
+        new_object_params = {
+          name:      @sample_object_params[:name],
+          file:      "https://www.lob.com/test.pdf",
+          setting_id: @test_setting_id
+        }
+
+        another_object_params = {
+          name:      "Another #{@sample_object_params[:name]}",
+          file:      "https://www.lob.com/test.pdf",
+          setting_id: @test_setting_id
+        }
+
+        result = subject.jobs.create(
+          @sample_job_params[:name],
+          new_address["id"],
+          new_address["id"],
+          [new_object_params, another_object_params]
+        )
+
+        result["name"].must_equal(@sample_job_params[:name])
+      end
+    end
+
+
     it "should create a job with address params" do
       VCR.use_cassette('create_job_with_address_params') do
         settings_list = subject.settings.list
@@ -72,7 +104,12 @@ describe Lob::V1::Job do
           @test_setting_id
         )
 
-        result = subject.jobs.create(@sample_job_params[:name], @sample_address_params, new_object["id"])
+        result = subject.jobs.create(
+          @sample_job_params[:name],
+          @sample_address_params,
+          @sample_address_params,
+          new_object["id"]
+        )
         result["name"].must_equal(@sample_job_params[:name])
       end
     end
@@ -88,7 +125,12 @@ describe Lob::V1::Job do
           setting_id: @test_setting_id
         }
 
-        result = subject.jobs.create(@sample_job_params[:name], new_address["id"], new_object_params)
+        result = subject.jobs.create(
+          @sample_job_params[:name],
+          new_address["id"],
+          new_address["id"],
+          new_object_params
+        )
         result["name"].must_equal(@sample_job_params[:name])
       end
     end
@@ -107,7 +149,12 @@ describe Lob::V1::Job do
           @test_setting_id
         )
 
-        new_job = subject.jobs.create(@sample_job_params[:name], new_address["id"], new_object["id"])
+        new_job = subject.jobs.create(
+          @sample_job_params[:name],
+          new_address["id"],
+          new_address["id"],
+          new_object["id"]
+        )
 
         result  = subject.jobs.find(new_job["id"])
         result["name"].must_equal(@sample_job_params[:name])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lob
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - Akash Manohar J
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-10 00:00:00.000000000 Z
+date: 2013-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -95,6 +95,9 @@ files:
 - lib/lob.rb
 - lib/lob/lob_error.rb
 - lib/lob/v1/address.rb
+- lib/lob/v1/bank_account.rb
+- lib/lob/v1/check.rb
+- lib/lob/v1/country.rb
 - lib/lob/v1/job.rb
 - lib/lob/v1/object.rb
 - lib/lob/v1/packaging.rb
@@ -102,9 +105,11 @@ files:
 - lib/lob/v1/resource.rb
 - lib/lob/v1/service.rb
 - lib/lob/v1/setting.rb
-- lib/lob/version.rb
 - lob.gemspec
 - spec/lob/v1/address_spec.rb
+- spec/lob/v1/bank_account_spec.rb
+- spec/lob/v1/check_spec.rb
+- spec/lob/v1/country_spec.rb
 - spec/lob/v1/job_spec.rb
 - spec/lob/v1/object_spec.rb
 - spec/lob/v1/packaging_spec.rb
@@ -140,6 +145,9 @@ specification_version: 4
 summary: Ruby wrapper for Lob.com API with ActiveRecord-style syntax
 test_files:
 - spec/lob/v1/address_spec.rb
+- spec/lob/v1/bank_account_spec.rb
+- spec/lob/v1/check_spec.rb
+- spec/lob/v1/country_spec.rb
 - spec/lob/v1/job_spec.rb
 - spec/lob/v1/object_spec.rb
 - spec/lob/v1/packaging_spec.rb

data/lib/lob/version.rb

@@ -1,3 +0,0 @@
-module Lob
-  VERSION = "0.0.1"
-end