lob 1.7 → 1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d4aeceb1ade65ead19ded055406c8bab5bca3a9
-  data.tar.gz: 6c299cf9833d544f30bf16aef7fba96306504cce
+  metadata.gz: 2d111537d5990b2be463c22fe1f24b5f707c6b7e
+  data.tar.gz: 4605b327af3dcafcb45b0d092576000a65faf074
 SHA512:
-  metadata.gz: 0d33be867b0a13cafff7e9fa4f7cdd190fa39b11af000123d0607e45aa18c1a1e8e0a5aa70c3a08179312ae9e361cfd8fdb333f86a622251c491d8b572741d1e
-  data.tar.gz: 7ce7dd4aae901a8a37fda89d4290ff7feb8f4bacaa66618d97bc397e9722c6474e9baee3a450b14e9230535e5b836efd42db04050aa9555cee72f19e8b1b7737
+  metadata.gz: de7f9937d1a207eb86c14d99fd71ffe59efdc0f3c4a91e4356b1b14950ca658efb26f69ebe59c77852096446f02e4fa8de75b2449dc36c4d81d3099b1982d82c
+  data.tar.gz: cbd24374e3d79375530826112701f91f9b2e4ec41dbd3e0da04bdf37c89b35cfcf1445f18b434c16845416b22a886243f711abb2027bf1479b3ab32db610aa2d

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## [**1.8**](https://github.com/lob/lob-ruby/releases/tag/v1.8)
+- [**#69**] (https://github.com/lob/lob-ruby/pull/69) fixed spelling in documentation
+- [**#71**] (https://github.com/lob/lob-ruby/pull/71) fixed syntax in documentation
+- [**#73**] (https://github.com/lob/lob-ruby/pull/73) fixed failing tests
+- [**#74**] (https://github.com/lob/lob-ruby/pull/74) added support for setting api_version
+- [**#75**] (https://github.com/lob/lob-ruby/pull/75) added version module
+- [**#76**] (https://github.com/lob/lob-ruby/pull/76) better error handling
+
+
+## [**1.7**](https://github.com/lob/lob-ruby/releases/tag/v1.7)
+- [**#64**] (https://github.com/lob/lob-ruby/pull/64) changed asset URLs to use lob-assets bucket

data/README.md

@@ -73,10 +73,8 @@ Lob.api_key = "your-api-key"
 
 ```ruby
 Lob.configure do |config|
-  config.api_key = "your-api-key"  # get your own at http://lob.com :)
-  config.api_version = "v1"        # default version
-  config.protocol = "https"        # default protocol
-  config.api_host = "api.lob.com"  # ofcourse it's Lob
+  config.api_key = "your-api-key"    # get your own at http://lob.com :)
+  config.api_version = "2014-12-18"  # override the API version
 end
 ```
 
@@ -564,7 +562,7 @@ You'll have to specify front, back, and either zip_codes or routes
   back: "https://s3-us-west-2.amazonaws.com/lob-assets/areaback.pdf",
   routes: ["94158-C001", "94107-C031"],
   target_type: "all",
-  full_blled = "1"
+  full_bleed: "1"
 )
 
 # create an area request with zip_codes
@@ -574,7 +572,7 @@ You'll have to specify front, back, and either zip_codes or routes
   back: "https://s3-us-west-2.amazonaws.com/lob-assets/areaback.pdf",
   zip_codes: ["95678", "94158"],
   target_type: "all",
-  full_blled = "1"
+  full_bleed: "1"
 )
 ```
 

data/lib/lob.rb

@@ -1,22 +1,20 @@
 require "rest-client"
 require "json"
-require "lob/lob_error"
+require "lob/version"
+require "lob/errors/lob_error"
+require "lob/errors/invalid_request_error"
 
 # Dynamically require files
 Dir[File.join(File.dirname(__FILE__), 'lob', 'v*', '*.rb')].each {|file| require file }
 
 module Lob
   class << self
-    attr_accessor :api_key,
-                  :api_version,
-                  :protocol,
-                  :api_host
+    attr_accessor :api_key, :api_version, :protocol, :api_host
 
     def configure
       yield self
       true
     end
-
     alias :config :configure
   end
 
@@ -26,61 +24,53 @@ module Lob
     end
   end
 
-
   def self.submit(method, url, parameters={})
-    clientVersion = Gem.latest_spec_for('lob').version.to_s
+    clientVersion = Lob::VERSION
 
-    if method == :get || method == :delete
-      JSON(RestClient.send(method, url, {
-        user_agent: 'Lob/v1 RubyBindings/' + clientVersion,
-        params: parameters
-      }))
-    else
-      JSON(RestClient.send(method, url, parameters, {
-        user_agent: 'Lob/v1 RubyBindings/' + clientVersion
-      }))
-    end
-  # :nocov:
-  rescue => e
     begin
-      # Parse the error to raise a nice Lob::Error
-      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"]
+      if method == :get || method == :delete
+        JSON.parse(RestClient.send(method, url, {
+          user_agent: 'Lob/v1 RubyBindings/' + clientVersion,
+          params: parameters,
+          "Lob-Version" => self.api_version
+        }))
       else
-        error_message = "Unknown error: #{json}"
+        JSON.parse(RestClient.send(method, url, parameters, {
+          user_agent: 'Lob/v1 RubyBindings/' + clientVersion,
+          "Lob-Version" => self.api_version
+        }))
       end
 
-      raise Lob::Error.new(error_message)
-    rescue
-      # If error parsing failed re-raise the original error
-      raise e
+    rescue RestClient::ExceptionWithResponse => e
+      handle_api_error(e)
     end
-  # :nocov:
   end
 
   def self.load(options={})
     Lob(options)
   end
-end
 
+  def self.handle_api_error(error)
+    begin
+      response = JSON.parse(error.http_body)
+      error_obj = response["errors"].first
+      message = error_obj["message"]
+      raise InvalidRequestError.new(message, error.http_code, error.http_body, error.response)
+    rescue JSON::ParserError
+      raise LobError.new("Invalid response object: #{}", error.http_code, error.http_body)
+    end
+  end
+end
 
 def Lob(options={})
   options[:api_host]     ||= Lob.api_host    || "api.lob.com"
   options[:protocol]     ||= Lob.protocol    || "https"
-  options[:api_version]  ||= Lob.api_version || "v1"
+  options[:api_version]  ||= Lob.api_version
   options[:api_key]      ||= Lob.api_key
 
   if options[:api_key].nil?
     raise ArgumentError.new(":api_key is a required argument to initialize Lob")
   end
 
-  if Dir[File.join(File.dirname(__FILE__), 'lob', options[:api_version])].empty?
-    raise Lob::VersionInvalidError.new("api version #{options[:api_version]} doesn't exist")
-  end
-
-  Lob.const_get(options[:api_version].capitalize).const_get("Resource").new(options)
+  Lob::V1::Resource.new(options)
 end

data/lib/lob/errors/invalid_request_error.rb

@@ -0,0 +1,4 @@
+module Lob
+  class InvalidRequestError < LobError
+  end
+end

data/lib/lob/errors/lob_error.rb

@@ -0,0 +1,17 @@
+module Lob
+  class LobError < StandardError
+    attr_reader :message, :http_status, :http_body, :json_body
+
+    def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+      @json_body = json_body
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+end

data/lib/lob/version.rb

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

data/lob.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
 
+require "lob/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "lob"
-  spec.version       = "1.7"
+  spec.version       = Lob::VERSION
   spec.authors       = ["Lob"]
   spec.email         = ["support@lob.com"]
   spec.description   = %q{Lob API Ruby wrapper}

data/spec/lob/errors/lob_error_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Lob::LobError do
+
+  describe "#to_s" do
+    it "should return a string with the status code and message" do
+      error = Lob::LobError.new("hello", 404)
+      error.to_s.must_equal("(Status 404) hello")
+    end
+
+    it "should returna a message without the status code if not provided" do
+      error = Lob::LobError.new("hello")
+      error.to_s.must_equal("hello")
+    end
+  end
+
+end

data/spec/lob/v1/address_spec.rb

@@ -13,7 +13,7 @@ describe Lob::V1::Address do
     }
   }
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
 
   describe "verify" do
 

data/spec/lob/v1/area_spec.rb

@@ -9,7 +9,7 @@ describe Lob::V1::Area do
     }
   end
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
 
   describe "list" do
     it "should list areas" do
@@ -59,18 +59,7 @@ describe Lob::V1::Area do
 
     it "should create an area object with zip_codes" do
       VCR.use_cassette('create_area_object_with_zip') do
-        @sample_area_params.delete("routes")
-        @sample_area_params[:zip_codes] = "94158"
-        result = subject.areas.create @sample_area_params
-
-        result["object"].must_equal("area")
-      end
-    end
-
-    it "should error without routes required params" do
-      VCR.use_cassette('create_area_object_with_zip') do
-        @sample_area_params.delete("routes")
-        @sample_area_params[:zip_codes] = "94158"
+        @sample_area_params[:routes] = ["94158"];
         result = subject.areas.create @sample_area_params
 
         result["object"].must_equal("area")

data/spec/lob/v1/bank_account_spec.rb

@@ -20,7 +20,7 @@ describe Lob::V1::BankAccount do
     }
   end
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
 
   describe "list" do
     it "should list bank accounts" do

data/spec/lob/v1/check_spec.rb

@@ -20,7 +20,7 @@ describe Lob::V1::Check do
     }
   end
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
 
   describe "list" do
     it "should list checks" do

data/spec/lob/v1/country_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe Lob::V1::Country do
-  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
 
   describe "list" do
     it "should list countries" do

data/spec/lob/v1/job_spec.rb

@@ -19,7 +19,7 @@ describe Lob::V1::Job do
     @test_setting_id = 201
   end
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
 
 
   describe "list" do

data/spec/lob/v1/object_spec.rb

@@ -9,8 +9,7 @@ describe Lob::V1::Object do
     @test_setting_id = 201
   end
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
-
+  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
 
   describe "list" do
     it "should list objects" do
@@ -28,7 +27,6 @@ describe Lob::V1::Object do
     end
   end
 
-
   describe "create" do
     it "should create an object with file url" do
       VCR.use_cassette('create_object_with_url') do
@@ -55,8 +53,21 @@ describe Lob::V1::Object do
         result["name"].must_equal(@sample_params[:name])
       end
     end
-  end
 
+    it "should create an object with a new api version" do
+      Lob.api_version = "2014-12-18"
+      VCR.use_cassette("create_object_with_new_version") do
+        result = subject.objects.create(
+          name: @sample_params[:name],
+          file: "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
+          setting: @test_setting_id
+        )
+
+        result["name"].must_equal(@sample_params[:name])
+      end
+      Lob.api_version = "2014-11-24"
+    end
+  end
 
   describe "find" do
     it "should find an object" do
@@ -74,7 +85,6 @@ describe Lob::V1::Object do
     end
   end
 
-
   describe "destroy" do
     it "should delete an object" do
       VCR.use_cassette('delete_object') do

data/spec/lob/v1/packaging_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 describe Lob::V1::Packaging do
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
 
   describe "list" do
     it "should list packagings" do

data/spec/lob/v1/postcard_spec.rb

@@ -20,7 +20,7 @@ describe Lob::V1::Postcard do
     }
   end
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
 
   describe "list" do
     it "should list postcards" do

data/spec/lob/v1/route_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe Lob::V1::Route do
-  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
 
   describe "list" do
     it "should list routes" do

data/spec/lob/v1/service_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 describe Lob::V1::Service do
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
 
   describe "list" do
     it "should list services" do

data/spec/lob/v1/setting_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 describe Lob::V1::Setting do
 
-  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
 
   describe "list" do
     it "should list settings" do

data/spec/lob/v1/state_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe Lob::V1::State do
-  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+  subject { Lob(api_key: ENV["LOB_API_KEY"]) }
 
   describe "list" do
     it "should list states" do

data/spec/lob_spec.rb

@@ -2,16 +2,7 @@ require "spec_helper"
 
 describe Lob do
   it "should return the resource object for the valid version" do
-    Lob(api_key: "test", api_version: "v1").must_be_kind_of(Lob::V1::Resource)
-  end
-
-  it "should raise an error if the version doesn't exist" do
-    ->{Lob(api_key: "test", api_version: "test")}.must_raise(Lob::VersionInvalidError)
-  end
-
-  it "should raise an error if API key is not passed as an option or set on module" do
-    Lob.api_key = nil  # make sure API key is nil
-    ->{ Lob() }.must_raise(ArgumentError)
+    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
@@ -26,13 +17,13 @@ describe Lob do
   it "should allow detailed configuration" do
     Lob.configure do |config|
       config.api_key = "test"
-      config.api_version = "v1"
+      config.api_version = "2014-11-24"
       config.protocol = "https"
       config.api_host = "api.lob.com"
     end
 
     Lob.api_key.must_equal "test"
-    Lob.api_version.must_equal "v1"
+    Lob.api_version.must_equal "2014-11-24"
     Lob.protocol.must_equal "https"
     Lob.api_host.must_equal "api.lob.com"
   end
@@ -43,11 +34,24 @@ describe Lob do
     Lob.api_key = "test"
     Lob.load.wont_be_nil
 
-    Lob.api_key = nil  # make sure API key is nil
-    ->{ Lob.load }.must_raise(ArgumentError)
+    Lob.load(api_key: "test", api_version: "2014-11-24").must_be_kind_of(Lob::V1::Resource)
+  end
 
-    ->{Lob.load(api_key: "test", api_version: "test")}.must_raise(Lob::VersionInvalidError)
+  it "should handle API errors gracefully" do
+    lob = Lob.load(api_key: ENV["LOB_API_KEY"])
+    assert_raises Lob::InvalidRequestError do
+      VCR.use_cassette('bad_request') do
+        lob.objects.create(name: "Test", file: "https://lob.com/test.pdf", bad_param: "bad_value")
+      end
+    end
+  end
 
-    Lob.load(api_key: "test", api_version: "v1").must_be_kind_of(Lob::V1::Resource)
+  it "should work when no api_version is provided" do
+    lob = Lob.load(api_key: ENV["LOB_API_KEY"])
+    Lob.api_version = nil
+    VCR.use_cassette('no_api_version') do
+      lob.addresses.list
+    end
+    Lob.api_version = "2014-11-24"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lob
 version: !ruby/object:Gem::Version
-  version: '1.7'
+  version: '1.8'
 platform: ruby
 authors:
 - Lob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 2014-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -159,6 +159,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -168,7 +169,8 @@ files:
 - examples/jobs.rb
 - examples/postcards.rb
 - lib/lob.rb
-- lib/lob/lob_error.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
@@ -183,7 +185,9 @@ files:
 - lib/lob/v1/service.rb
 - lib/lob/v1/setting.rb
 - lib/lob/v1/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
@@ -220,11 +224,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.0.14
 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

data/lib/lob/lob_error.rb

@@ -1,6 +0,0 @@
-module Lob
-  class Error < StandardError
-  end
-  class VersionInvalidError < StandardError
-  end
-end