lob 1.8 → 1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d111537d5990b2be463c22fe1f24b5f707c6b7e
-  data.tar.gz: 4605b327af3dcafcb45b0d092576000a65faf074
+  metadata.gz: 74f9905edbe7eab01d1846eb252742078a8c8f1c
+  data.tar.gz: 9806e7634aced9b07deeebab5aacbaaf4c89af9b
 SHA512:
-  metadata.gz: de7f9937d1a207eb86c14d99fd71ffe59efdc0f3c4a91e4356b1b14950ca658efb26f69ebe59c77852096446f02e4fa8de75b2449dc36c4d81d3099b1982d82c
-  data.tar.gz: cbd24374e3d79375530826112701f91f9b2e4ec41dbd3e0da04bdf37c89b35cfcf1445f18b434c16845416b22a886243f711abb2027bf1479b3ab32db610aa2d
+  metadata.gz: 738fcbbaf6f1133a1e007da326e8262cda4db77cde4d1c78bde2634259a55a3744f6cad91378167223f555a236f4fd188e709f6fa86dd69c1861a8deebb0c402
+  data.tar.gz: 2ca3f28e17083574efd9cadd198d33e542cd0aa3ac3154f2ca2041ecb3f3bb86fb350a54cf746bc74ce09f54108661819bbc47abec923ba23833cfe3f2714a36

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [**1.9**](https://github.com/lob/lob-ruby/releases/tag/v1.8)
+- [**#88**] (https://github.com/lob/lob-ruby/pull/88) default prawn to 1.3.0 for ruby 1.9.3
+- [**#91**] (https://github.com/lob/lob-ruby/pull/91) reduce strictness of rest-client version
+
 ## [**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

data/README.md

@@ -1,6 +1,8 @@
 # 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) [![Downloads](http://ruby-gem-downloads-badge.herokuapp.com/lob?color=green&type=total)](https://rubygems.org/gems/lob)
+[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/lob/lob-ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+[![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://coveralls.io/repos/lob/lob-ruby/badge.svg?branch=master)](https://coveralls.io/r/lob/lob-ruby?branch=master) [![Downloads](http://ruby-gem-downloads-badge.herokuapp.com/lob?color=green&type=total)](https://rubygems.org/gems/lob)
 
 Ruby wrapper for the [Lob.com](http://lob.com) API. This gem gives you an ActiveRecord-style syntax to use the Lob.com API.
 
@@ -34,9 +36,9 @@ Or manually install it yourself:
 ## Usage
 
 The library uses an ActiveRecord-style interface. You'll feel right at home.
-You'll need a Lob.com API key. It's free and you can get yours [here](https://dashboard.lob.com/account).
+You'll need a Lob.com API key. It's free and you can get yours [here](https://dashboard.lob.com/settings).
 
-For optional parameters and other details, refer the docs here - <https://lob.com/docs>
+For optional parameters and other details, refer to the docs [here](https://lob.com/docs/ruby).
 
 #### Caution: Pass zero-prefixed zip codes as strings
 
@@ -46,17 +48,23 @@ The Ruby interpreter assumes it's not of base-10 and tries to convert it to base
 
 ## Supported Image Types
 
-The lob.com API supports the following image types:
+The Lob.com API supports the following image types:
 
 - PDF
 - PNG
 - JPEG
 
-For more information on prepping the images please see the [Lob documentation](https://lob.com/docs#prepping)
+For more information on prepping images please see the [Lob documentation](https://lob.com/docs/ruby#prepping).
 
 #### Creating a PDF
 
-If you need to generate your own PDF programmatically we recommend using [prawn](https://github.com/prawnpdf/prawn). There is an example provided in the examples folder [here](examples/create_pdf.rb)
+If you need to generate your own PDF programmatically we recommend using [prawn](https://github.com/prawnpdf/prawn). There is an example provided in the examples folder [here](examples/create_pdf.rb).
+
+## HTML Support
+
+The Lob.com API also supports HTML strings in leiu of a file of the above type. See below for examples of submitting with HTML strings.
+
+For templates and more information regarding HTML, please see the [Lob documentation](https://lob.com/docs/ruby#html-fonts). 
 
 ## Initialization and Configuration
 
@@ -99,8 +107,6 @@ end
   - [lob.settings](#lobsettings)
     - [lob.settings.list](#lobsettingslist)
     - [lob.settings.find](#lobsettingsfind)
-  - [lob.packagings](#lobpackagings)
-    - [lob.packagings.list](#lobpackagingslist)
   - [lob.services](#lobservices)
     - [lob.services.list](#lobserviceslist)
 - [Simple Postcard Service](#simple-postcard-service)
@@ -165,7 +171,7 @@ end
   objects: {
     name: "Local File Object",
     file: File.new("/path/to/file.pdf"),
-    setting_id: 100
+    setting: 100
   })
 
 
@@ -194,7 +200,7 @@ end
 )
 
 # You can also pass new object params for the object
-# and other options like packaging_id an setting_id
+# and other options like setting
 @lob.jobs.create(
   name: "New Cool Posters",
   from: "from-address-id",
@@ -203,7 +209,7 @@ end
   {
     name: "Your fantistic object",
     file: "http://test.com/file.pdf",
-    setting_id: "some-setting-id"
+    setting: "some-setting"
   }
 )
 
@@ -303,21 +309,28 @@ end
 #### lob.objects.create
 
 ```ruby
-# You can create an onject by passing the name, file url and setting ID, quantity is defaulted to 1
+# You can create an object by passing the name, file url and setting ID, quantity is defaulted to 1
 @lob.objects.create(
-  name: "Your fantistic object",
+  name: "Your fantastic object",
   file: "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
-  setting_id: "201"
+  setting: "201"
 )
 
 # You can also pass the quantity as an option
 # Or pass a file for upload instead of a url
 @lob.objects.create(
-  name: "Your fantistic object",
+  name: "Your fantastic object",
   file: File.new("/path/to/file.pdf"),
-  setting_id: "some-setting-id",
+  setting: "some-setting",
   quantity: 12
 )
+
+# You can also pass an HTML string instead of a file
+@lob.objects.create(
+  name: "Your fantastic object",
+  file: "<html style='margin: 130px; font-size: 50;'>HTML here</html>",
+  setting: "some-setting"
+)
 ```
 
 #### lob.objects.list
@@ -355,16 +368,7 @@ end
 #### lob.settings.find
 ```ruby
 # returns a setting object
-@lob.settings.find("setting_id")
-```
-
-### lob.packagings
-
-#### lob.packagings.list
-
-```ruby
-# returns a list of packagings
-@lob.packagings.list
+@lob.settings.find("setting")
 ```
 
 ### lob.services
@@ -386,8 +390,8 @@ You'll have to specify either the `message` option or the `back` option.
 
 ```ruby
 
+# create postcard with message
 
-# create postcard with complete customization
 @lob.postcards.create(
   name: "John Joe",
   to: {
@@ -405,13 +409,13 @@ You'll have to specify either the `message` option or the `back` option.
     state: "MA",
     country: "US",
     zip: 12345
-  }
-  front: "https://s3-us-west-2.amazonaws.com/lob-assets/postcardback.pdf",
-  back: File.new("/path/to/file.pdf")
+  },
+  front: "https://lob.com/postcardfront.pdf",
+  message: "Hey Buddy, Thanks for Visiting",
+  full_bleed: 1
 )
 
-# create postcard with templated back
-
+# create postcard with your own back, adhering to lob's template
 @lob.postcards.create(
   name: "John Joe",
   to: {
@@ -429,17 +433,19 @@ You'll have to specify either the `message` option or the `back` option.
     state: "MA",
     country: "US",
     zip: 12345
-  }
-  front: "https://s3-us-west-2.amazonaws.com/lob-assets/postcardback.pdf",
-  message: "Hey Buddy, Thanks for Visiting"
+  },
+  front: "https://lob.com/postcardfront.pdf",
+  back: File.new("/path/to/file.pdf"),
+  full_bleed: 1,
+  template: 1
 )
 
-# sending a new postcard with stored address id
+# create postcard with HTML string & a 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")
+  front:  "<html style='margin: 130px; font-size: 50;'>HTML here</html>",
+  message: "Hey buddy. Waiting to hear your stories."
 )
 ```
 
@@ -477,14 +483,16 @@ You'll have to specify either the `message` option or the `back` option.
     country: "US",
     zip: 12345
   },
-  amount: 5000
+  amount: 5000,
+  logo: "https://s3-us-west-2.amazonaws.com/lob-assets/lob_check_logo.png" # optional
 )
 
 # or an address ID
 @lob.checks.create(
   bank_account: "bank-account-id",
   to: "to-address-ID",
-  amount: 5000
+  amount: 5000,
+  logo: "https://s3-us-west-2.amazonaws.com/lob-assets/lob_check_logo.png" # optional
 )
 
 # You can also specify an optional 4th argument, with other options.
@@ -516,6 +524,7 @@ account_address =
 @lob.bank_accounts.create(
   routing_number: "routing_number",
   account_number: "account_number",
+  signatory: "John Doe",
   bank_address: {
     name: "ToAddress",
     address_line1: "120 6th Ave",
@@ -555,7 +564,7 @@ account_address =
 You'll have to specify front, back, and either zip_codes or routes
 
 ```ruby
-# create an area request with routes
+# create an area request with remote files & with routes
 @lob.areas.create(
   name: "My Area",
   front: "https://s3-us-west-2.amazonaws.com/lob-assets/areafront.pdf",
@@ -565,11 +574,11 @@ You'll have to specify front, back, and either zip_codes or routes
   full_bleed: "1"
 )
 
-# create an area request with zip_codes
+# create an area request with HTML & with zip codes
 @lob.areas.create(
   name: "My Area",
-  front: "https://s3-us-west-2.amazonaws.com/lob-assets/areafront.pdf",
-  back: "https://s3-us-west-2.amazonaws.com/lob-assets/areaback.pdf",
+  front: "<html style='margin: 130px; font-size: 50;'>HTML here</html>",
+  back: "<html style='margin: 130px; font-size: 50;'>HTML here</html>",
   zip_codes: ["95678", "94158"],
   target_type: "all",
   full_bleed: "1"

data/examples/checks.rb

@@ -19,6 +19,7 @@ to_address = @lob.addresses.create(
 bank_account = @lob.bank_accounts.create(
   routing_number: "322271627",
   account_number: "123456789",
+  signatory: "John Doe",
   bank_address: {
     name: "Bank Address",
     address_line1: "120 6th Ave",

data/examples/create_pdf.rb

@@ -18,7 +18,7 @@ pdf.render_file 'sample.pdf'
 object = @lob.objects.create(
   name: 'Test Object',
   file: File.new('sample.pdf'),
-  setting_id: 201,
+  setting: 201,
   full_bleed: 1
 )
 

data/examples/jobs.rb

@@ -14,7 +14,7 @@ setting_id = settings[setting_index]["id"]
 michigan_logo = @lob.objects.create(
   name: "Michigan Logo Document",
   file: "https://s3-us-west-2.amazonaws.com/lob-assets/goblue.pdf",
-  setting_id: setting_id
+  setting: 101
 )
 
 # create a to address

data/lib/lob/version.rb

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

data/lob.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rest-client", "~> 1.7.0"
+  spec.add_dependency "rest-client", "~> 1.7"
 
-  spec.add_dependency "prawn", ">= 0"
+  spec.add_dependency "prawn", "~> 1.3.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.3.2"

data/spec/lob/v1/bank_account_spec.rb

@@ -30,7 +30,8 @@ describe Lob::V1::BankAccount do
           routing_number: @sample_bank_account_params[:routing_number],
           bank_address: @sample_address_params.clone,
           account_number: @sample_bank_account_params[:account_number],
-          account_address: @sample_address_params.clone
+          account_address: @sample_address_params.clone,
+          signatory: "John Doe"
         )
 
         list_result = subject.bank_accounts.list
@@ -49,7 +50,8 @@ describe Lob::V1::BankAccount do
           routing_number: @sample_bank_account_params[:routing_number],
           bank_address: new_address["id"],
           account_number: @sample_bank_account_params[:account_number],
-          account_address: new_address["id"]
+          account_address: new_address["id"],
+          signatory: "John Doe"
         )
 
         result["account_number"].must_equal(@sample_bank_account_params[:account_number])
@@ -64,7 +66,8 @@ describe Lob::V1::BankAccount do
           routing_number: @sample_bank_account_params[:routing_number],
           bank_address: @sample_address_params.clone,
           account_number: @sample_bank_account_params[:account_number],
-          account_address: @sample_address_params.clone
+          account_address: @sample_address_params.clone,
+          signatory: "John Doe"
         )
 
         result["account_number"].must_equal(@sample_bank_account_params[:account_number])
@@ -82,7 +85,8 @@ describe Lob::V1::BankAccount do
           routing_number: @sample_bank_account_params[:routing_number],
           bank_address: new_address["id"],
           account_number: @sample_bank_account_params[:account_number],
-          account_address: new_address["id"]
+          account_address: new_address["id"],
+          signatory: "John Doe"
         )
 
         result  = subject.bank_accounts.find(new_bank_account["id"])
@@ -98,7 +102,8 @@ describe Lob::V1::BankAccount do
           routing_number: @sample_bank_account_params[:routing_number],
           bank_address: @sample_address_params.clone,
           account_number: @sample_bank_account_params[:account_number],
-          account_address: @sample_address_params.clone
+          account_address: @sample_address_params.clone,
+          signatory: "John Doe"
         )
 
         delete_result = subject.bank_accounts.destroy(new_bank_account["id"])

data/spec/lob/v1/check_spec.rb

@@ -31,7 +31,8 @@ describe Lob::V1::Check do
           routing_number: @sample_bank_account_params[:routing_number],
           bank_address: @sample_address_params,
           account_number: @sample_bank_account_params[:account_number],
-          account_address: @sample_address_params
+          account_address: @sample_address_params,
+          signatory: "John Doe"
         )
 
         new_check = subject.checks.create(
@@ -56,7 +57,8 @@ describe Lob::V1::Check do
           routing_number: @sample_bank_account_params[:routing_number],
           bank_address: @sample_address_params,
           account_number: @sample_bank_account_params[:account_number],
-          account_address: @sample_address_params
+          account_address: @sample_address_params,
+          signatory: "John Doe"
         )
 
         result = subject.checks.create(
@@ -80,7 +82,8 @@ describe Lob::V1::Check do
           routing_number: @sample_bank_account_params[:routing_number],
           bank_address: @sample_address_params,
           account_number: @sample_bank_account_params[:account_number],
-          account_address: @sample_address_params
+          account_address: @sample_address_params,
+          signatory: "John Doe"
         )
 
         new_check = subject.checks.create(

data/spec/lob/v1/job_spec.rb

@@ -30,7 +30,7 @@ describe Lob::V1::Job do
         new_object = subject.objects.create(
           name: @sample_object_params[:name],
           file: "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
-          setting_id: @test_setting_id
+          setting: @test_setting_id
         )
 
         new_job = subject.jobs.create(
@@ -56,7 +56,7 @@ describe Lob::V1::Job do
         new_object = subject.objects.create(
           name: @sample_object_params[:name],
           file: "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
-          setting_id: @test_setting_id
+          setting: @test_setting_id
         )
 
         result = subject.jobs.create(
@@ -77,15 +77,15 @@ describe Lob::V1::Job do
         settings_list = subject.settings.list
 
         new_object_params = {
-          name:      @sample_object_params[:name],
-          file:      "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
-          setting_id: @test_setting_id
+          name:    @sample_object_params[:name],
+          file:    "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
+          setting: 500
         }
 
         another_object_params = {
-          name:      "Another #{@sample_object_params[:name]}",
-          file:      "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
-          setting_id: @test_setting_id
+          name:    "Another #{@sample_object_params[:name]}",
+          file:    "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
+          setting: 500
         }
 
         result = subject.jobs.create(
@@ -106,15 +106,15 @@ describe Lob::V1::Job do
         new_address = subject.addresses.create @sample_address_params
 
         new_object_params = {
-          name:      @sample_object_params[:name],
-          file:      File.new(File.expand_path("../../../samples/test.pdf", __FILE__)),
-          setting_id: @test_setting_id
+          name:    @sample_object_params[:name],
+          file:    File.new(File.expand_path("../../../samples/test.pdf", __FILE__)),
+          setting: 500
         }
 
         another_object_params = {
-          name:      "Another #{@sample_object_params[:name]}",
-          file:      "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
-          setting_id: @test_setting_id
+          name:    "Another #{@sample_object_params[:name]}",
+          file:    "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
+          setting: 500
         }
 
         result = subject.jobs.create(
@@ -143,7 +143,7 @@ describe Lob::V1::Job do
         new_object = subject.objects.create(
           name: @sample_object_params[:name],
           file: "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
-          setting_id: @test_setting_id
+          setting: @test_setting_id
         )
 
         result = subject.jobs.create(
@@ -164,7 +164,7 @@ describe Lob::V1::Job do
         new_object_params = {
           name:      @sample_object_params[:name],
           file:      "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
-          setting_id: @test_setting_id
+          setting: @test_setting_id
         }
 
         result = subject.jobs.create(
@@ -188,7 +188,7 @@ describe Lob::V1::Job do
         new_object = subject.objects.create(
           name: @sample_object_params[:name],
           file: "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
-          setting_id: @test_setting_id
+          setting: @test_setting_id
         )
 
         new_job = subject.jobs.create(

data/spec/lob/v1/object_spec.rb

@@ -18,7 +18,7 @@ describe Lob::V1::Object do
         new_object = subject.objects.create(
           name: @sample_params[:name],
           file: "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
-          setting_id: @test_setting_id
+          setting: @test_setting_id
         )
 
         list_result = subject.objects.list
@@ -34,7 +34,7 @@ describe Lob::V1::Object do
         result = subject.objects.create(
           name: @sample_params[:name],
           file: "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
-          setting_id: @test_setting_id
+          setting: @test_setting_id
         )
 
         result["name"].must_equal(@sample_params[:name])
@@ -47,25 +47,11 @@ describe Lob::V1::Object do
         result = subject.objects.create(
           name: @sample_params[:name],
           file: File.new(File.expand_path("../../../samples/test.pdf", __FILE__), "rb"),
-          setting_id: @test_setting_id
-        )
-
-        result["name"].must_equal(@sample_params[:name])
-      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
 
@@ -76,7 +62,7 @@ describe Lob::V1::Object do
         new_object = subject.objects.create(
           name: @sample_params[:name],
           file: "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
-          setting_id: @test_setting_id
+          setting: @test_setting_id
         )
 
         find_result = subject.objects.find(new_object["id"])
@@ -92,7 +78,7 @@ describe Lob::V1::Object do
         new_object = subject.objects.create(
           name: @sample_params[:name],
           file: "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
-          setting_id: @test_setting_id
+          setting: @test_setting_id
         )
 
         delete_result = subject.objects.destroy(new_object["id"])

data/spec/lob_spec.rb

@@ -1,6 +1,11 @@
 require "spec_helper"
 
 describe Lob do
+
+  after do
+    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
@@ -34,7 +39,7 @@ describe Lob do
     Lob.api_key = "test"
     Lob.load.wont_be_nil
 
-    Lob.load(api_key: "test", api_version: "2014-11-24").must_be_kind_of(Lob::V1::Resource)
+    Lob.load(api_key: "test").must_be_kind_of(Lob::V1::Resource)
   end
 
   it "should handle API errors gracefully" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lob
 version: !ruby/object:Gem::Version
-  version: '1.8'
+  version: '1.9'
 platform: ruby
 authors:
 - Lob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-20 00:00:00.000000000 Z
+date: 2015-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: prawn
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement