lob 1.2 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc23512932804b6f7ab2f1e15f2db402fbd51517
-  data.tar.gz: da3019d42bf5dd557c1fa4369a217fe13792c652
+  metadata.gz: 28b1bd25b6896a7a20910ff62e4aecb86cc73877
+  data.tar.gz: 6e52736c7c0b7f380bb841d659d3c9372137ef07
 SHA512:
-  metadata.gz: 9a2f560d31987b814e11b8e2baa0e592b698547601fe18f723852eca913f8db7b93682f9a309bc482ed2cbe1823c3e4500b700ba8cb4ebce77f48b099126c756
-  data.tar.gz: 7541054ab21ad31ee44d03baa99f55812023b549d46c5691f9cdc568ce99f0dd724fa0c371cf3ddbe07a6e0894fbab611c573fef82c82c69d6e055d7c3d4cda5
+  metadata.gz: e4243be1598476f54d6eda19a384a66da23b258e702d9c39dbb3f164038eda1de726ce195916b1308767385c3a4dd497cf6137af8b594f5b398d223bd6c9eea8
+  data.tar.gz: 17e5b1d1118920e1026dac87382c610f5e0ef602bc8412bfda38cdf4b91fcbb9b667f0fd88bc2dfa95b8c95bbb65a6ebe0d50d0dfc26d86098a535353ee21957

data/README.md

@@ -1,6 +1,8 @@
 # lob-ruby
 
-[![Build Status](https://travis-ci.org/lob/lob-ruby.png?branch=master)](https://travis-ci.org/lob/lob-ruby)
+[![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)
+
+[![Coverage Status](https://img.shields.io/coveralls/lob/lob-ruby.svg)](https://coveralls.io/r/lob/lob-ruby?branch=master)
 
 Ruby wrapper for the [Lob.com](http://lob.com) API. This gem gives you an ActiveRecord-style syntax to use the Lob.com API.
 
@@ -41,7 +43,7 @@ The Ruby interpreter assumes it's not of base-10 and tries to convert it to base
 
 
 # Alternatively, to set the API key for all calls in the future
-Lob.api_key = "you-api-key"
+Lob.api_key = "your-api-key"
 @lob = Lob()   # don't forget the paranthesis!
 ```
 
@@ -125,6 +127,38 @@ end
 #### Create jobs
 
 ```ruby
+
+# Below is an example with inline addresses and object creation
+
+@lob.jobs.create(
+  name: "Inline Test Job",
+  from: {
+    name:    "Test Address",
+    email:  "test@test.com",
+    address_line1: "123 Test Street",
+    address_line2: "Unit 199",
+    city:    "Mountain View",
+    state:  "CA",
+    country: "US",
+    zip:    94085
+  },
+  to: {
+    name:    "TestAddress",
+    email:  "test@test.com",
+    address_line1: "123 Test Street",
+    address_line2: "Unit 199",
+    city:    "Mountain View",
+    state:  "CA",
+    country: "US",
+    zip:    94085
+  },
+  objects: {
+    name: "Local File Object",
+    file:      File.new(File.expand_path("<<YOUR PATH>>/letter.pdf", __FILE__)),
+    setting_id: 100
+  })
+
+
 # name, to-address and object are the arguments
 # to-address can be specified as an address-id
 @lob.jobs.create(
@@ -134,7 +168,7 @@ end
   objects: "object-id"
 )
 
-# to-address can also be specified as address params to create new address
+# mixing inline objects with ids
 @lob.jobs.create(
   name: "New Cool Posters",
   from: {
@@ -145,14 +179,7 @@ end
     country: "US",
     zip: 12345
   },
-  to: {
-    name: "ToAddress",
-    address_line1: "120, 6th Ave",
-    city: "Boston",
-    state: "MA",
-    country: "US",
-    zip: 12345
-  },
+  to: "to-address-id",
   objects: "object-id"
 )
 
@@ -170,7 +197,7 @@ end
   }
 )
 
-# Or add a job with multiple objects
+# Multi Object Jobs (include more than 1 file)
 
 @lob.jobs.create(
   name: "New Cool Posters",
@@ -186,6 +213,8 @@ end
   objects: ["object-id", "another-object-id"]
 )
 
+
+
 ```
 
 #### List jobs
@@ -210,11 +239,11 @@ end
 #### Create objects
 
 ```ruby
-# You can create by passing the name, file url and setting ID
+# You can create an onject by passing the name, file url and setting ID, quantity is defaulted to 1
 @lob.objects.create(
   name: "Your fantistic object",
-  file: "http://test.com/file.pdf",
-  setting_id: "some-setting-id"
+  file: "https://www.lob.com/test.pdf",
+  setting_id: "201"
 )
 
 # You can also pass the quantity as an option
@@ -262,20 +291,38 @@ end
 
 ### Postcards
 
-#### Creating post cards
+#### Creating postcards
 
 You'll have to specify either the `message` option or the `back` option.
 
 ```ruby
-# accepts the name, address-id to send to and options
+
+
+# create postcard with complete customization
 @lob.postcards.create(
   name: "John Joe",
-  to: "to-address-id",
-  message: "Hey buddy. Waiting to hear your stories",
-  front: File.new("/path/to/file.pdf")
+  to: {
+    name: "ToAddress",
+    address_line1: "120, 6th Ave",
+    city: "Boston",
+    state: "MA",
+    country: "US",
+    zip: 12345
+  },
+  from: {
+    name: "FromAddress",
+    address_line1: "120, 6th Ave",
+    city: "Boston",
+    state: "MA",
+    country: "US",
+    zip: 12345
+  }
+  front: "https://www.lob.com/postcardback.pdf",
+  back: File.new("/path/to/file.pdf")
 )
 
-# create using address params, front, back and from address
+# create postcard with templated back
+
 @lob.postcards.create(
   name: "John Joe",
   to: {
@@ -286,9 +333,6 @@ You'll have to specify either the `message` option or the `back` option.
     country: "US",
     zip: 12345
   },
-  message: "Hey buddy. Waiting to hear your stories",
-  front: "https://www.lob.com/postcardback.pdf",
-  back: File.new("/path/to/file.pdf"),
   from: {
     name: "FromAddress",
     address_line1: "120, 6th Ave",
@@ -297,6 +341,16 @@ You'll have to specify either the `message` option or the `back` option.
     country: "US",
     zip: 12345
   }
+  front: "https://www.lob.com/postcardback.pdf",
+  message: "Hey Buddy, Thanks for Visiting"
+)
+
+# sending a new postcard with stored address id
+@lob.postcards.create(
+  name: "John Joe",
+  to: "to-address-id",
+  message: "Hey buddy. Waiting to hear your stories",
+  front: File.new("/path/to/file.pdf")
 )
 ```
 
@@ -427,8 +481,9 @@ You can also configure, TravisCI for your fork of the repository and it'll run t
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Make sure the tests pass and add tests if required
-6. Create new Pull Request
+5. Make sure the tests pass
+6. Open up coverage/index.html in your browser and add tests if required
+7. Create new Pull Request
 
 ## Credits
 

data/lib/lob.rb

@@ -41,10 +41,10 @@ module Lob
   def self.submit(method, url, parameters={})
     parameters = {:params => parameters} if method == :get
     JSON(RestClient.send(method, url, parameters))
+  # :nocov:
   rescue => e
-    error_message = nil
-    raise e unless e.respond_to? :http_body
     begin
+      # Parse the error to raise a nice Lob::Error
       json = JSON(e.http_body)
 
       if json.has_key? 'errors'
@@ -54,10 +54,13 @@ module Lob
       else
         error_message = "Unknown error: #{json}"
       end
-    rescue => e
+
+      raise Lob::Error.new(error_message)
+    rescue
+      # If error parsing failed re-raise the original error
       raise e
     end
-    raise Lob::Error.new(error_message)
+  # :nocov:
   end
 
 end

data/lib/lob/v1/resource.rb

@@ -44,10 +44,6 @@ module Lob
         Lob::V1::Check.new(self)
       end
 
-      def cheques
-        Lob::V1::Check.new(self)
-      end
-
       def bank_accounts
         Lob::V1::BankAccount.new(self)
       end

data/lob.gemspec

@@ -5,9 +5,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "lob"
-  spec.version       = "1.2"
-  spec.authors       = ["Akash Manohar J"]
-  spec.email         = ["akash@akash.im"]
+  spec.version       = "1.3.1"
+  spec.authors       = ["Lob"]
+  spec.email         = ["support@lob.com"]
   spec.description   = %q{Lob API Ruby wrapper}
   spec.summary       = %q{Ruby wrapper for Lob.com API with ActiveRecord-style syntax}
   spec.homepage      = "https://github.com/lob/lob-ruby"
@@ -21,8 +21,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rest-client", ">= 0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "webmock", '~> 1.2'
-  spec.add_development_dependency "travis-lint"
-  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "rake", "~> 10.3.2"
+  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.7.0"
+  spec.add_development_dependency "simplecov", "~> 0.7.1"
+  spec.add_development_dependency "pry", "~> 0.10.0"
 end

data/spec/lob/v1/address_spec.rb

@@ -1,17 +1,6 @@
 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
-    }
-  }
 
   let(:sample_params) {
     {
@@ -28,20 +17,6 @@ describe Lob::V1::Address do
   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("United States")
-        end
-      end
-    end
 
     it "should verify an address" do
       VCR.use_cassette('verify_address') do
@@ -52,7 +27,7 @@ describe Lob::V1::Address do
           zip:   sample_params[:zip]
         )
 
-        result["address"]["address_country"].must_equal("United States")
+        result["address"]["address_country"].must_equal("US")
       end
     end
   end
@@ -98,7 +73,7 @@ describe Lob::V1::Address do
         new_address = subject.addresses.create sample_params
 
         delete_result = subject.addresses.destroy(new_address["id"])
-        assert /has been deleted/ =~ delete_result["message"]
+        assert_equal(new_address["id"], delete_result["id"])
       end
     end
   end

data/spec/lob/v1/job_spec.rb

@@ -198,7 +198,7 @@ describe Lob::V1::Job do
           objects: new_object["id"]
         )
 
-        result  = subject.jobs.find(new_job["id"])
+        result = subject.jobs.find(new_job["id"])
         result["name"].must_equal(@sample_job_params[:name])
       end
     end

data/spec/lob/v1/object_spec.rb

@@ -86,7 +86,7 @@ describe Lob::V1::Object do
         )
 
         delete_result = subject.objects.destroy(new_object["id"])
-        assert /has been deleted/ =~ delete_result["message"]
+        assert_equal(new_object["id"], delete_result["id"])
       end
     end
   end

data/spec/lob/v1/postcard_spec.rb

@@ -14,7 +14,7 @@ describe Lob::V1::Postcard do
       zip:     94085
     }
 
-    @sample_postcard_params    = {
+    @sample_postcard_params = {
       name:    "TestPostcard",
       message: "Sample postcard message"
     }
@@ -57,10 +57,8 @@ describe Lob::V1::Postcard do
       end
     end
 
-
-    it "should create a postcard with address params" do
-      VCR.use_cassette('create_postcard_with_address_params') do
-
+    it "should create a postcard with to address params" do
+      VCR.use_cassette('create_postcard_with_to_address_params') do
         result = subject.postcards.create(
           name: @sample_postcard_params[:name],
           to: @sample_address_params,
@@ -72,6 +70,21 @@ describe Lob::V1::Postcard do
       end
     end
 
+    it "should create a postcard with from address params" do
+      VCR.use_cassette('create_postcard_with_from_address_params') do
+        new_address = subject.addresses.create @sample_address_params
+
+        result = subject.postcards.create(
+          name: @sample_postcard_params[:name],
+          to: new_address["id"],
+          from: @sample_address_params,
+          message: @sample_postcard_params[:message],
+          front: "https://www.lob.com/postcardfront.pdf"
+        )
+
+        result["name"].must_equal(@sample_postcard_params[:name])
+      end
+    end
 
     it "should create a postcard with front and back as urls" do
       VCR.use_cassette('create_postcard_with_front_and_back_urls') do

data/spec/lob_spec.rb

@@ -11,9 +11,7 @@ module Lob
   end
 end
 
-
 describe Lob do
-
   it "should return the resource object for the specified version" do
     Lob(api_key: "test", api_version: "test").must_be_kind_of(Lob::Test::Resource)
   end
@@ -31,4 +29,18 @@ describe Lob do
   it "should pass the API key to the resource for the version" do
     Lob(api_key: "test").options[:api_key].must_equal "test"
   end
+
+  it "should allow detailed configuration" do
+    Lob.configure do |config|
+      config.api_key = "test"
+      config.api_version = "v1"
+      config.protocol = "https"
+      config.api_host = "api.lob.com"
+    end
+
+    Lob.api_key.must_equal "test"
+    Lob.api_version.must_equal "v1"
+    Lob.protocol.must_equal "https"
+    Lob.api_host.must_equal "api.lob.com"
+  end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,14 @@
 $:.unshift File.expand_path("../lib", File.dirname(__FILE__))
 
+require "simplecov"
+require "coveralls"
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
 require "lob"
 require "minitest/spec"
 require "minitest/pride"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lob
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: 1.3.1
 platform: ruby
 authors:
-- Akash Manohar J
+- Lob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-14 00:00:00.000000000 Z
+date: 2014-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -42,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.3.2
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -70,33 +70,75 @@ dependencies:
   name: travis-lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.9.2
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !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
 email:
-- akash@akash.im
+- support@lob.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -154,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Lob.com API with ActiveRecord-style syntax