lob 2.5.1 → 3.0.0

data/lib/lob/resources/route.rb

@@ -0,0 +1,24 @@
+require "lob/resources/resource_base"
+
+module Lob
+  module Resources
+    class Route < Lob::Resources::ResourceBase
+
+      undef_method :create, :destroy
+
+      def initialize(config)
+        super(config)
+        @endpoint = "routes"
+      end
+
+      def list(options = {})
+        if options.is_a?(String)
+          submit :get, resource_url(options)
+        else
+          submit :get, endpoint_url, options
+        end
+      end
+
+    end
+  end
+end

data/lib/lob/resources/state.rb

@@ -0,0 +1,16 @@
+require "lob/resources/resource_base"
+
+module Lob
+  module Resources
+    class State < Lob::Resources::ResourceBase
+
+      undef_method :find, :create, :destroy
+
+      def initialize(config)
+        super(config)
+        @endpoint = "states"
+      end
+
+    end
+  end
+end

data/lib/lob/version.rb

@@ -1,3 +1,3 @@
 module Lob
-  VERSION = "2.5.1"
+  VERSION = "3.0.0"
 end

data/spec/lob/{v1 → resources}/address_spec.rb

@@ -1,9 +1,9 @@
 require "spec_helper"
 
-describe Lob::V1::Address do
+describe Lob::Resources::Address do
 
-  let(:sample_params) {
-    {
+  before :each do
+    @sample_params = {
       name: "John Doe",
       address_line1: "325 Berry Street",
       address_city: "San Francisco",
@@ -14,18 +14,18 @@ describe Lob::V1::Address do
         test: 'stuff'
       }
     }
-  }
+  end
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
+  subject { Lob::Client.new(api_key: API_KEY) }
 
   describe "verify" do
 
     it "should verify an address" do
       result = subject.addresses.verify(
-        address_line1: sample_params[:address_line1],
-        address_city:  sample_params[:address_city],
-        address_state: sample_params[:address_state],
-        address_zip:   sample_params[:address_zip]
+        address_line1: @sample_params[:address_line1],
+        address_city:  @sample_params[:address_city],
+        address_state: @sample_params[:address_state],
+        address_zip:   @sample_params[:address_zip]
       )
 
       result["address"]["address_country"].must_equal("US")
@@ -42,25 +42,26 @@ describe Lob::V1::Address do
 
   describe "create" do
     it "should create an address" do
-      result = subject.addresses.create sample_params
-      assert /#{result["name"]}/i =~ sample_params[:name]
+      result = subject.addresses.create @sample_params
+
+      result["name"].must_equal(@sample_params[:name])
     end
   end
 
 
   describe "find" do
     it "should find an address" do
-      new_address = subject.addresses.create sample_params
+      new_address = subject.addresses.create @sample_params
 
       find_result = subject.addresses.find(new_address["id"])
-      assert /#{find_result["name"]}/i =~ sample_params[:name]
+      find_result["name"].must_equal(@sample_params[:name])
     end
   end
 
 
   describe "destroy" do
     it "should delete an 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_equal(new_address["id"], delete_result["id"])

data/spec/lob/{v1 → resources}/area_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe Lob::V1::Area do
+describe Lob::Resources::Area do
   before :each do
     @sample_area_params = {
       description: "Test Area",
@@ -10,7 +10,7 @@ describe Lob::V1::Area do
     }
   end
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
+  subject { Lob::Client.new(api_key: API_KEY) }
 
   describe "list" do
     it "should list areas" do

data/spec/lob/{v1 → resources}/bank_account_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe Lob::V1::BankAccount do
+describe Lob::Resources::BankAccount do
 
   before :each do
     @sample_bank_account_params = {
@@ -11,7 +11,7 @@ describe Lob::V1::BankAccount do
     }
   end
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
+  subject { Lob::Client.new(api_key: API_KEY) }
 
   describe "list" do
     it "should list bank accounts" do

data/spec/lob/{v1 → resources}/check_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe Lob::V1::Check do
+describe Lob::Resources::Check do
 
   before :each do
 
@@ -21,9 +21,10 @@ describe Lob::V1::Check do
       account_type: "company",
       signatory: "John Doe"
     }
+
   end
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
+  subject { Lob::Client.new(api_key: API_KEY) }
 
   describe "list" do
     it "should list checks" do

data/spec/lob/{v1 → resources}/country_spec.rb

@@ -1,8 +1,8 @@
 require "spec_helper"
 
-describe Lob::V1::Country do
+describe Lob::Resources::Country do
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
+  subject { Lob::Client.new(api_key: API_KEY) }
 
   describe "list" do
     it "should list countries" do

data/spec/lob/{v1 → resources}/letter_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe Lob::V1::Letter do
+describe Lob::Resources::Letter do
 
   before :each do
     @sample_address_params = {
@@ -15,7 +15,7 @@ describe Lob::V1::Letter do
     }
   end
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
+  subject { Lob::Client.new(api_key: API_KEY) }
 
   describe "list" do
     it "should list letter" do

data/spec/lob/{v1 → resources}/postcard_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe Lob::V1::Postcard do
+describe Lob::Resources::Postcard do
 
   before :each do
     @sample_address_params = {
@@ -20,7 +20,7 @@ describe Lob::V1::Postcard do
     }
   end
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
+  subject { Lob::Client.new(api_key: API_KEY) }
 
   describe "list" do
     it "should list postcards" do

data/spec/lob/resources/resource_base_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe Lob::Resources::ResourceBase do
+
+  before :each do
+    @api_key = "test"
+  end
+
+  subject { Lob::Client.new(api_key: @api_key) }
+
+  describe "when Lob is initialized" do
+    it "should have API key in config" do
+      subject.config[:api_key].must_equal @api_key
+    end
+  end
+
+  it "should return areas resource" do
+    subject.areas.must_be_kind_of(Lob::Resources::Area)
+  end
+
+  it "should return addresses resource" do
+    subject.addresses.must_be_kind_of(Lob::Resources::Address)
+  end
+
+  it "should return bank accounts resource" do
+    subject.bank_accounts.must_be_kind_of(Lob::Resources::BankAccount)
+  end
+
+  it "should return checks resource" do
+    subject.checks.must_be_kind_of(Lob::Resources::Check)
+  end
+
+  it "should return countries resource" do
+    subject.countries.must_be_kind_of(Lob::Resources::Country)
+  end
+
+  it "should return letters resource" do
+    subject.letters.must_be_kind_of(Lob::Resources::Letter)
+  end
+
+  it "should return postcards resource" do
+    subject.postcards.must_be_kind_of(Lob::Resources::Postcard)
+  end
+
+  it "should return routes resource" do
+    subject.routes.must_be_kind_of(Lob::Resources::Route)
+  end
+
+  it "should return states resource" do
+    subject.states.must_be_kind_of(Lob::Resources::State)
+  end
+
+end

data/spec/lob/{v1 → resources}/route_spec.rb

@@ -1,8 +1,8 @@
 require "spec_helper"
 
-describe Lob::V1::Route do
+describe Lob::Resources::Route do
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
+  subject { Lob::Client.new(api_key: API_KEY) }
 
   describe "find" do
 

data/spec/lob/{v1 → resources}/state_spec.rb

@@ -1,8 +1,8 @@
 require "spec_helper"
 
-describe Lob::V1::State do
+describe Lob::Resources::State do
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
+  subject { Lob::Client.new(api_key: API_KEY) }
 
   describe "list" do
     it "should list states" do

data/spec/lob_spec.rb

@@ -2,77 +2,44 @@ require "spec_helper"
 
 describe Lob do
 
-  after do
-    Lob.api_key = nil
-    Lob.api_version = nil
-  end
-
-  it "should return the resource object for the valid version" do
-    Lob(api_key: "test", api_version: "2014-11-25").must_be_kind_of(Lob::V1::Resource)
-  end
-
-  it "should *not* raise an error if API key has been on module and not passed as option" do
-    Lob.api_key = "test"
-    Lob().wont_be_nil
+  it "should return the client object for the valid version" do
+    lob = Lob::Client.new(api_key: "test", api_version: "2014-11-25")
+    lob.must_be_kind_of(Lob::Client)
+    assert lob.config[:api_version] == "2014-11-25"
   end
 
   it "should pass the API key to the resource for the version" do
-    Lob(api_key: "test").options[:api_key].must_equal "test"
+    Lob::Client.new(api_key: "test").config[:api_key].must_equal "test"
   end
 
   it "should raise an error if no API key is supplied" do
     assert_raises ArgumentError do
-      Lob()
-    end
-  end
-
-  it "should allow detailed configuration" do
-    Lob.configure do |config|
-      config.api_key = "test"
-      config.api_version = "2014-11-24"
-      config.protocol = "https"
-      config.api_host = "api.lob.com"
+      Lob::Client.new()
     end
-
-    Lob.api_key.must_equal "test"
-    Lob.api_version.must_equal "2014-11-24"
-    Lob.protocol.must_equal "https"
-    Lob.api_host.must_equal "api.lob.com"
-  end
-
-  it "should work with Lob.load" do
-    Lob.load(api_key: "test").options[:api_key].must_equal "test"
-
-    Lob.api_key = "test"
-    Lob.load.wont_be_nil
-
-    Lob.load(api_key: "test").must_be_kind_of(Lob::V1::Resource)
   end
 
   it "should handle API errors gracefully" do
-    lob = Lob.load(api_key: ENV["LOB_API_KEY"])
+    lob = Lob::Client.new(api_key: API_KEY)
     assert_raises Lob::InvalidRequestError do
-      lob.objects.create(name: "Test", file: "https://lob.com/test.pdf", bad_param: "bad_value")
+      lob.postcards.create(name: "Test", file: "https://lob.com/test.pdf", bad_param: "bad_value")
     end
   end
 
   it "should work when no api_version is provided" do
-    lob = Lob.load(api_key: ENV["LOB_API_KEY"])
-    Lob.api_version = nil
+    lob = Lob::Client.new(api_key: API_KEY)
     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"])
+    lob = Lob::Client.new(api_key: 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"])
+    lob = Lob::Client.new(api_key: API_KEY)
     begin
-      lob.objects.create(name: "Test", file: "https://lob.com/test.pdf", bad_param: "bad_value")
+      lob.postcards.create(bad_param: "bad_value")
     rescue Lob::InvalidRequestError => e
       assert e._response.headers.include?(:content_type)
     end

data/spec/spec_helper.rb

@@ -13,3 +13,5 @@ require "lob"
 require "minitest/spec"
 require "minitest/pride"
 require "minitest/autorun"
+
+API_KEY = 'test_799ff27291c166d10ba191902ad02fb059c'

metadata

@@ -1,145 +1,145 @@
 --- !ruby/object:Gem::Specification
 name: lob
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Lob
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-27 00:00:00.000000000 Z
+date: 2016-10-11 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'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-  name: rest-client
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-  name: bundler
-  prerelease: false
   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
-  name: rake
-  prerelease: false
   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
-  name: minitest
-  prerelease: false
   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'
-  name: webmock
-  prerelease: false
   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
-  name: travis-lint
-  prerelease: false
   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
-  name: coveralls
-  prerelease: false
   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
-  name: simplecov
-  prerelease: false
   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
-  name: pry
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
 description: Lob API Ruby wrapper
@@ -149,56 +149,56 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - examples/README.md
 - examples/checks.rb
+- examples/csv_checks/create_checks.rb
+- examples/csv_checks/input.csv
+- examples/csv_letters/create_letters.rb
+- examples/csv_letters/input.csv
+- examples/csv_letters/letter_template.html
 - examples/csv_postcards/create_postcards.rb
 - examples/csv_postcards/input.csv
 - examples/csv_postcards/postcard_back.html
 - examples/csv_postcards/postcard_front.html
-- examples/jobs.rb
 - examples/letters.rb
 - examples/postcards.rb
 - examples/verify/input.txt
 - examples/verify/verify.rb
 - lib/lob.rb
+- lib/lob/client.rb
 - lib/lob/errors/invalid_request_error.rb
 - lib/lob/errors/lob_error.rb
-- lib/lob/v1/address.rb
-- lib/lob/v1/area.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/letter.rb
-- lib/lob/v1/object.rb
-- lib/lob/v1/postcard.rb
-- lib/lob/v1/resource.rb
-- lib/lob/v1/route.rb
-- lib/lob/v1/setting.rb
-- lib/lob/v1/state.rb
+- lib/lob/resources/address.rb
+- lib/lob/resources/area.rb
+- lib/lob/resources/bank_account.rb
+- lib/lob/resources/check.rb
+- lib/lob/resources/country.rb
+- lib/lob/resources/letter.rb
+- lib/lob/resources/postcard.rb
+- lib/lob/resources/resource_base.rb
+- lib/lob/resources/route.rb
+- lib/lob/resources/state.rb
 - lib/lob/version.rb
 - lob.gemspec
 - spec/lob/errors/lob_error_spec.rb
-- spec/lob/v1/address_spec.rb
-- spec/lob/v1/area_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/letter_spec.rb
-- spec/lob/v1/object_spec.rb
-- spec/lob/v1/postcard_spec.rb
-- spec/lob/v1/resource_spec.rb
-- spec/lob/v1/route_spec.rb
-- spec/lob/v1/setting_spec.rb
-- spec/lob/v1/state_spec.rb
+- spec/lob/resources/address_spec.rb
+- spec/lob/resources/area_spec.rb
+- spec/lob/resources/bank_account_spec.rb
+- spec/lob/resources/check_spec.rb
+- spec/lob/resources/country_spec.rb
+- spec/lob/resources/letter_spec.rb
+- spec/lob/resources/postcard_spec.rb
+- spec/lob/resources/resource_base_spec.rb
+- spec/lob/resources/route_spec.rb
+- spec/lob/resources/state_spec.rb
 - spec/lob_spec.rb
 - spec/samples/8.5x11.pdf
 - spec/samples/postcardback.pdf
@@ -208,41 +208,38 @@ homepage: https://github.com/lob/lob-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 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.4.5
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Lob.com API with ActiveRecord-style syntax
 test_files:
 - spec/lob/errors/lob_error_spec.rb
-- spec/lob/v1/address_spec.rb
-- spec/lob/v1/area_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/letter_spec.rb
-- spec/lob/v1/object_spec.rb
-- spec/lob/v1/postcard_spec.rb
-- spec/lob/v1/resource_spec.rb
-- spec/lob/v1/route_spec.rb
-- spec/lob/v1/setting_spec.rb
-- spec/lob/v1/state_spec.rb
+- spec/lob/resources/address_spec.rb
+- spec/lob/resources/area_spec.rb
+- spec/lob/resources/bank_account_spec.rb
+- spec/lob/resources/check_spec.rb
+- spec/lob/resources/country_spec.rb
+- spec/lob/resources/letter_spec.rb
+- spec/lob/resources/postcard_spec.rb
+- spec/lob/resources/resource_base_spec.rb
+- spec/lob/resources/route_spec.rb
+- spec/lob/resources/state_spec.rb
 - spec/lob_spec.rb
 - spec/samples/8.5x11.pdf
 - spec/samples/postcardback.pdf