lob 1.13.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acd5e9c0fe20145d83f62c1c915f0b2ca6893e7e
-  data.tar.gz: 2edc15946a536dcac2b9ade028754a5b30db385e
+  metadata.gz: 4ceb1823e07362d2a8fbadfa23749bc78c6e49b8
+  data.tar.gz: 2ac14476bb2ba3c2ab7bd76bb9f0d644ce90dad1
 SHA512:
-  metadata.gz: 296539b5631661d1c11290efb7bc42fea6f2475305aab47f6cd9e1939b4dff1bf286a78e1b5a75b75717590af722ffca702cc2ab09231b6a59736f1106ec8edd
-  data.tar.gz: 45a9466effaa2ead82c9bbb0607ee507c957f332d69f203a72367a6068506bfe9499f4ee3a70fd2e07a6b90fa000890155ea2756efd1c3afc43e7f50d14cfde3
+  metadata.gz: ca4df9c124eb0ff74fb7c048ff8ae58a3ef7b5caa273cb21c56a461985d856197f34e8f751ee92cee5cccd5d01d00017728cc7009df63acc18a7dbeb2e620b3a
+  data.tar.gz: 080a64c572bed68a9c10ccd4e2a99b3ac93feb952003921fac1094bde74745fdd44594214a45317507aa31cfb1f574d930c079f20d5fd773461195c4457a9cc1

data/.gitignore

@@ -16,4 +16,3 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-spec/vcr_cassettes/

data/.travis.yml

@@ -12,8 +12,4 @@ env:
   JRUBY_OPTS=--2.0
   - LOB_API_KEY=test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc
 
-before_script:
-  - bundle exec rake dev:setup
-  - rm -rf spec/vcr_cassettes
-
 script: bundle exec rake test

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 2.0.0
+
+Version 2.0.0 introduces several breaking changes. It requires a minimum API version of `2015-04-11`.
+
+* The lob-ruby gem no longer converts `city`, `state`, etc. parameters into `address_city`, `address_state`, etc. This change was made to be more consistent with the API and other Lob wrappers, and to prevent confusion.
+* The wrapper now returns the raw JSON from the API in all `list` endpoints rather than just the `data` field in the response. This will allow access to additional fields like `count` and `offset`.
+* The `packagings` endpoint is not longer supporter in the API, and therefore has been taken out of lob-ruby.
+
+In addition to these breaking changes, the test suite was cleaned up by removing the unnecessary VCR gem and committing sample upload files to the repository rather than downloading them in rake task.
+
 ## [**1.13.0**](https://github.com/lob/lob-ruby/releases/tag/v1.13.0)
 - [**#112**] (https://github.com/lob/lob-ruby/pull/112) removes Rack dependency
 

data/README.md

@@ -180,11 +180,7 @@ Make sure you have Ruby 2.0 installed. Copy and paste the following commands in
 
 ## Testing
 
-To run the tests, download the required sample files by running the following command:
-
-    bundle exec rake dev:setup
-
-Tests are written using MiniTest, a testing library that comes with Ruby stdlib. The remote responses are tested using [vcr](https://github.com/vcr/vcr).
+Tests are written using MiniTest, a testing library that comes with Ruby stdlib.
 
 You'll need to pass in your Lob.com API as the environment variable `LOB_API_KEY`, to run the tests. Be sure to use your Test API key, and not the Live one.
 
@@ -192,8 +188,6 @@ Here's how you can run the tests:
 
     LOB_API_KEY=your_test_api_key bundle exec rake test
 
-When you make changes to failed tests, then clear out the vcr cassettes to re-record the http requests. You can clear out all the cassettes by running `rm -rf spec/vcr_cassettes`.
-
 You can also configure, TravisCI for your fork of the repository and it'll run the tests for you, when you push.
 
 =======================
@@ -201,3 +195,4 @@ You can also configure, TravisCI for your fork of the repository and it'll run t
 Copyright © 2013 Lob.com
 
 Released under the MIT License, which can be found in the repository in `LICENSE.txt`.
+

data/Rakefile

@@ -1,27 +1,8 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
-
 Rake::TestTask.new do |t|
   t.libs.push "lib", "spec"
   t.test_files = FileList['spec/**/*_spec.rb']
   t.verbose = true
 end
-
-
-namespace :dev do
-
-  desc "Download sample files to run tests with"
-  task :setup do
-    Dir.mkdir("spec/samples") unless File.exist?("spec/samples")
-    files = [
-      {url: "https://lob.com/postcardfront.pdf",                               name: "postcardfront.pdf"},
-      {url: "https://lob.com/postcardback.pdf",                                name: "postcardback.pdf"},
-      {url: "https://s3-us-west-2.amazonaws.com/lob-assets/letter-goblue.pdf", name: "8.5x11.pdf"},
-    ]
-    files.each do |f|
-      system "curl #{f[:url]} -o spec/samples/#{f[:name]}"
-    end
-
-  end
-end

data/lib/lob.rb

@@ -19,12 +19,6 @@ module Lob
     alias :config :configure
   end
 
-  def self.require_options(options, *keys)
-    keys.each do |key|
-      raise ArgumentError.new(":#{key} is required") unless options.key?(key)
-    end
-  end
-
   def self.submit(method, url, parameters={})
     clientVersion = Lob::VERSION
 
@@ -55,9 +49,9 @@ module Lob
   def self.handle_api_error(error)
     begin
       response = JSON.parse(error.http_body)
-      message = response["error"]["message"]
+      message = response.fetch("error").fetch("message")
       raise InvalidRequestError.new(message, error.http_code, error.http_body, error.response)
-    rescue JSON::ParserError
+    rescue JSON::ParserError, KeyError
       raise LobError.new("Invalid response object: #{}", error.http_code, error.http_body)
     end
   end

data/lib/lob/v1/address.rb

@@ -7,12 +7,11 @@ module Lob
       end
 
       def verify(options={})
-        params = @resource.format_address_params(options, false)
-        Lob.submit(:post, address_verify_url, params)
+        Lob.submit(:post, address_verify_url, options)
       end
 
       def list(options={})
-        Lob.submit(:get, address_url, options)["data"] || []
+        Lob.submit(:get, address_url, options)
       end
 
       def find(address_id)
@@ -20,7 +19,7 @@ module Lob
       end
 
       def create(options = {})
-        Lob.submit :post, address_url, @resource.format_address_params(options)
+        Lob.submit :post, address_url, options
       end
 
       def destroy(address_id)

data/lib/lob/v1/area.rb

@@ -6,7 +6,7 @@ module Lob
       end
 
       def list(options = {})
-        Lob.submit(:get, area_url, options)["data"] || []
+        Lob.submit(:get, area_url, options)
       end
 
       def find(lob_object_id)

data/lib/lob/v1/bank_account.rb

@@ -7,7 +7,7 @@ module Lob
       end
 
       def list(options={})
-        Lob.submit(:get, bank_account_url, options)["data"] || []
+        Lob.submit(:get, bank_account_url, options)
       end
 
       def find(bank_account_id)
@@ -15,14 +15,6 @@ module Lob
       end
 
       def create(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
 

data/lib/lob/v1/check.rb

@@ -7,7 +7,7 @@ module Lob
       end
 
       def list(options={})
-        Lob.submit(:get, check_url, options)["data"] || []
+        Lob.submit(:get, check_url, options)
       end
 
       def find(check_id)
@@ -15,10 +15,6 @@ module Lob
       end
 
       def create(options = {})
-        if !options[:to].is_a?(String)
-          options[:to] = @resource.format_address_params(options[:to])
-        end
-
         Lob.submit :post, check_url, options
       end
 

data/lib/lob/v1/country.rb

@@ -7,7 +7,7 @@ module Lob
       end
 
       def list(options={})
-        Lob.submit(:get, country_url, options)["data"] || []
+        Lob.submit(:get, country_url, options)
       end
 
       private

data/lib/lob/v1/job.rb

@@ -7,7 +7,7 @@ module Lob
       end
 
       def list(options={})
-        Lob.submit(:get, job_url, options)["data"] || []
+        Lob.submit(:get, job_url, options)
       end
 
       def find(job_id)
@@ -24,14 +24,6 @@ module Lob
         end
         options.delete(:objects)
 
-        if options[:to] && !options[:to].is_a?(String)
-          options[:to] = @resource.format_address_params(options[:to])
-        end
-
-        if options[:from] && !options[:from].is_a?(String)
-          options[:from] = @resource.format_address_params(options[:from])
-        end
-
         Lob.submit :post, job_url, options
       end
 

data/lib/lob/v1/letter.rb

@@ -7,7 +7,7 @@ module Lob
       end
 
       def list(options={})
-        Lob.submit(:get, letter_url, options)["data"] || []
+        Lob.submit(:get, letter_url, options)
       end
 
       def find(job_id)
@@ -15,19 +15,9 @@ module Lob
       end
 
       def create(options = {})
-
-        if options[:to] && !options[:to].is_a?(String)
-          options[:to] = @resource.format_address_params(options[:to])
-        end
-
-        if options[:from] && !options[:from].is_a?(String)
-          options[:from] = @resource.format_address_params(options[:from])
-        end
-
         Lob.submit :post, letter_url, options
       end
 
-
       private
 
       def letter_url(job_id = nil)

data/lib/lob/v1/object.rb

@@ -7,7 +7,7 @@ module Lob
       end
 
       def list(options = {})
-        Lob.submit(:get, object_url, options)["data"] || []
+        Lob.submit(:get, object_url, options)
       end
 
       def find(lob_object_id)

data/lib/lob/v1/postcard.rb

@@ -7,7 +7,7 @@ module Lob
       end
 
       def list(options={})
-        Lob.submit(:get, postcard_url, options)["data"] || []
+        Lob.submit(:get, postcard_url, options)
       end
 
       def find(postcard_id)
@@ -15,14 +15,6 @@ module Lob
       end
 
       def create(options = {})
-        if options[:to] && !options[:to].is_a?(String)
-          options[:to] = @resource.format_address_params(options[:to])
-        end
-
-        if options[:from] && !options[:from].is_a?(String)
-          options[:from] = @resource.format_address_params(options[:from])
-        end
-
         Lob.submit :post, postcard_url, options
       end
 

data/lib/lob/v1/resource.rb

@@ -72,22 +72,6 @@ module Lob
         "#{base_url}/#{resource_type}#{'/' + resource_id if resource_id}"
       end
 
-      #NOTE to format address param names into API-compatible ones
-      def format_address_params(params, check_required_options=true)
-        if check_required_options
-          Lob.require_options(params, :name, :address_line1, :city, :state, :zip, :country)
-        end
-
-        new_params = params.clone
-
-        [:city, :state, :zip, :country].each do |option|
-          new_params["address_#{option}".to_sym] = params[option] if params[option]
-          new_params.delete(option)
-        end
-
-        new_params
-      end
-
     end
   end
 end

data/lib/lob/v1/route.rb

@@ -6,7 +6,7 @@ module Lob
       end
 
       def list(options = {})
-        Lob.submit(:get, route_url, options)["data"] || []
+        Lob.submit(:get, route_url, options)
       end
 
       private

data/lib/lob/v1/service.rb

@@ -7,7 +7,7 @@ module Lob
       end
 
       def list(options={})
-        Lob.submit(:get, service_url, options)["data"] || []
+        Lob.submit(:get, service_url, options)
       end
 
       private

data/lib/lob/v1/setting.rb

@@ -7,7 +7,7 @@ module Lob
       end
 
       def list(options={})
-        Lob.submit(:get, setting_url, options)["data"] || []
+        Lob.submit(:get, setting_url, options)
       end
 
       def find(setting_id)

data/lib/lob/v1/state.rb

@@ -7,7 +7,7 @@ module Lob
       end
 
       def list(options={})
-        Lob.submit(:get, state_url, options)["data"] || []
+        Lob.submit(:get, state_url, options)
       end
 
       private

data/lib/lob/version.rb

@@ -1,3 +1,3 @@
 module Lob
-  VERSION = "1.13.0"
+  VERSION = "2.0.0"
 end

data/lob.gemspec

@@ -27,7 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 5.6.1"
   spec.add_development_dependency "webmock", "~> 1.2"
   spec.add_development_dependency "travis-lint", "~> 2.0.0"
-  spec.add_development_dependency "vcr", "~> 2.9.2"
   spec.add_development_dependency "coveralls", "~> 0.8.1"
   spec.add_development_dependency "simplecov", "~> 0.10.0"
   spec.add_development_dependency "pry", "~> 0.10.0"

data/spec/lob/v1/address_spec.rb

@@ -6,10 +6,10 @@ describe Lob::V1::Address do
     {
       name: "John Doe",
       address_line1: "325 Berry Street",
-      city: "San Francisco",
-      state: "CA",
-      country: "US",
-      zip: 94158
+      address_city: "San Francisco",
+      address_state: "CA",
+      address_country: "US",
+      address_zip: 94158
     }
   }
 
@@ -18,62 +18,49 @@ describe Lob::V1::Address do
   describe "verify" do
 
     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]
-        )
-
-        result["address"]["address_country"].must_equal("US")
-      end
+      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]
+      )
+
+      result["address"]["address_country"].must_equal("US")
     end
   end
 
 
   describe "list" do
     it "should list addresses" do
-      VCR.use_cassette('list_addresses') do
-        new_address = subject.addresses.create sample_params
-
-        list_result = subject.addresses.list
-        assert /#{new_address["name"]}/i =~ list_result.to_s
-      end
+      assert subject.addresses.list["object"] == "list"
     end
   end
 
 
   describe "create" do
     it "should create an address" do
-      VCR.use_cassette('create_address') do
-        result = subject.addresses.create sample_params
-        assert /#{result["name"]}/i =~ sample_params[:name]
-      end
+      result = subject.addresses.create sample_params
+      assert /#{result["name"]}/i =~ sample_params[:name]
     end
   end
 
 
   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"])
-        assert /#{find_result["name"]}/i =~ sample_params[:name]
-      end
+      find_result = subject.addresses.find(new_address["id"])
+      assert /#{find_result["name"]}/i =~ sample_params[:name]
     end
   end
 
 
   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_equal(new_address["id"], delete_result["id"])
-      end
+      delete_result = subject.addresses.destroy(new_address["id"])
+      assert_equal(new_address["id"], delete_result["id"])
     end
   end
 end