lob 1.4 → 1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73c25870f258cf39d0d433b254712629a7ca7e91
-  data.tar.gz: 6c7b1d259b1e8d8ee8f48398ac03290608d567a7
+  metadata.gz: da1de55d24c191d96b977778bc662314c4a6523d
+  data.tar.gz: 1a6bf843e2f9730735a0aa6ad5c89b228eb77c75
 SHA512:
-  metadata.gz: 08df0587f62aa357c84323426dbc3cb81906be0c56a888fd5c283222ef29734373ac775e27722911525669554476545bd028ede36fa313c1dfee2c5258522151
-  data.tar.gz: 97597db31774db70091e0dc49f2a6e71ab1a9ce28545e4c34a715094b4aa97dfed4252b9f91721ca7ae92ac95777b117f1085cb594f994c1e8871387b1f56e2f
+  metadata.gz: 22cddc118df4adee9bad8bc045a98138e82353b9d4783a9912dec8e75e87dede1183ba0f59c5715b8c91b416111b6cba38a96ac6175b201259cbe29547835504
+  data.tar.gz: 151991770ed6e72b43710473c35b9d5f34c09f2c66aaf72d5bbda99aab89955161261fddfe9bc0dd7c44f3d2bf4953947cd5746f9b5f8a14678f43d94fa14556

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.DS_Store
 Gemfile.lock
 InstalledFiles
 _yardoc
@@ -16,4 +17,4 @@ test/tmp
 test/version_tmp
 tmp
 spec/vcr_cassettes/
-spec/samples/
+spec/samples/

data/README.md

@@ -1,6 +1,6 @@
 # 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) ![](http://ruby-gem-downloads-badge.herokuapp.com/lob?color=green)
+[![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)](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.
 
@@ -33,18 +33,23 @@ When using zip codes with zero-prefixes, always quote them. For example when spe
 
 The Ruby interpreter assumes it's not of base-10 and tries to convert it to base-10 number. So that might result in an entirely different zip-code than intended.
 
-### Initialization and configuration
+Supported Image Types
+--------
+The lob.com API supports the following image types:
 
-```ruby
-# To initialize a Lob object
-@lob = Lob(api_key: "your-api-key")
+- PDF
+- PNG
+- JPEG
 
-# Alternatively, to set the API key for all calls in the future
-Lob.api_key = "your-api-key"
-@lob = Lob()   # don't forget the paranthesis!
-```
+For more information on prepping the images please see the [Lob documentation](https://lob.com/docs#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)
 
-### Alternatively, you can use initialize and configure like this
+Initialization and configuration
+------
 
 ```ruby
 # To initialize a Lob object
@@ -66,6 +71,20 @@ Lob.configure do |config|
 end
 ```
 
+### Settings
+
+#### List settings
+```ruby
+# returns an array of settings
+@lob.settings.list
+```
+
+#### Find a setting
+```ruby
+# returns a setting object
+@lob.settings.find("setting_id")
+```
+
 ### Addresses
 
 #### To create an address
@@ -409,10 +428,10 @@ zip_codes and routes can be a string or an array of strings
 
 #### List areas
 ```ruby
-  @lob.areas.list
+@lob.areas.list
 
-  # you can also pass count and offset
-  @lob.areas.list(count: 10, offset: 3)
+# you can also pass count and offset
+@lob.areas.list(count: 10, offset: 3)
 ```
 
 

data/examples/addresses.rb

@@ -0,0 +1,16 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'lob'
+
+# initialize Lob object
+Lob.api_key = 'test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc'
+@lob = Lob.load
+
+# create an address
+puts @lob.addresses.create(
+  name: "John Doe",
+  address_line1: "104, Printing Boulevard",
+  city: "Boston",
+  state: "MA",
+  country: "US",
+  zip: 12345
+)

data/examples/checks.rb

@@ -0,0 +1,17 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'lob'
+
+# initialize Lob object
+Lob.api_key = 'test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc'
+@lob = Lob.load
+
+# send a $1000 check using an already created bank and address
+puts @lob.checks.create(
+  name: 'Test Check',
+  check_number: '10000',
+  bank_account: 'bank_3e64d9904356b20',
+  to: 'adr_0e418aa8d1eb41fb',
+  amount: 100,
+  memo: 'This is my first Check',
+  message: 'This check is for laundry'
+)

data/examples/create_pdf.rb

@@ -0,0 +1,25 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'open-uri'
+require 'prawn'
+require 'lob'
+
+# initialize Lob object
+Lob.api_key = 'test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc'
+@lob = Lob.load
+
+POINTS_PER_INCH = 72 # 72 PostScript Points per Inch
+
+pdf = Prawn::Document.new(:page_size => [4.25 * POINTS_PER_INCH, 6.25 * POINTS_PER_INCH])
+pdf.image open('https://www.lob.com/assets/images/printing_icon.png'), :position => :center
+pdf.text 'Print with Lob!', :align => :center, :size => 32
+
+pdf.render_file 'sample.pdf'
+
+object = @lob.objects.create(
+  name: 'Test Object',
+  file: File.new('sample.pdf'),
+  setting_id: 201,
+  full_bleed: 1
+)
+
+puts 'You can view your created PDF here: ' + object['url']

data/examples/jobs.rb

@@ -0,0 +1,46 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'lob'
+
+# initialize Lob object
+Lob.api_key = 'test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc'
+@lob = Lob.load
+
+# find the setting_id for the object you want to create
+settings = @lob.settings.list
+setting_index = settings.find_index { |setting| setting["type"] === "documents" }
+setting_id = settings[setting_index]["id"]
+
+# create a file object to user laterA
+michigan_logo = @lob.objects.create(
+  name: "Michigan Logo Document",
+)
+
+
+@lob.jobs.create(
+  name: "Michigan Logo to Harry",
+  from: {
+    name:    "Leore Avidar",
+    email:  "test@test.com",
+    address_line1: "123 Test Street",
+    address_line2: "Unit 199",
+    city:    "Mountain View",
+    state:  "CA",
+    country: "US",
+    zip:    94085
+  },
+  to: {
+    name:    "Harry Avidar",
+    email:  "test@test.com",
+    address_line1: "123 Test Street",
+    address_line2: "Unit 199",
+    city:    "Mountain View",
+    state:  "CA",
+    country: "US",
+    zip:    94085
+  },
+  objects: {
+    name: "Michigan Logo",
+    file: "https://www.lob.com/goblue.pdf",
+    setting_id: setting_id
+  }
+)

data/examples/postcards.rb

@@ -0,0 +1,57 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'lob'
+
+# initialize Lob object
+Lob.api_key = 'test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc'
+@lob = Lob.load
+
+# create a postcard with in-line addresses
+puts @lob.postcards.create(
+  name: "John Joe",
+  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/postcardfront.pdf",
+  back: File.new("../spec/samples/postcardback.pdf")
+)
+
+# create a postcard with stored addresses
+
+to_address = @lob.addresses.create(
+  name: "ToAddress",
+  address_line1: "120, 6th Ave",
+  city: "Boston",
+  state: "MA",
+  country: "US",
+  zip: 12345
+)
+
+from_address = @lob.addresses.create(
+  name: "FromAddress",
+  address_line1: "120, 6th Ave",
+  city: "Boston",
+  state: "MA",
+  country: "US",
+  zip: 12345
+)
+
+puts @lob.postcards.create(
+  name: "John Joe",
+  to: to_address["id"],
+  from: from_address["id"],
+  front: "https://www.lob.com/postcardfront.pdf",
+  back: File.new("../spec/samples/postcardback.pdf")
+)

data/examples/verification.rb

@@ -0,0 +1,14 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'lob'
+
+# initialize Lob object
+Lob.api_key = 'test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc'
+@lob = Lob.load
+
+# verify an address
+puts @lob.addresses.verify(
+  address_line1: "220 WILLIAM T MORRISSEY BLVD",
+  city:    "Boston",
+  state:   "MA",
+  zip:     "02125"
+)

data/lib/lob/v1/bank_account.rb

@@ -26,6 +26,9 @@ module Lob
         Lob.submit :post, bank_account_url, options
       end
 
+      def destroy(bank_account_id)
+        Lob.submit :delete, bank_account_url(bank_account_id)
+      end
 
       private
 

data/lob.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "lob"
-  spec.version       = "1.4"
+  spec.version       = "1.5"
   spec.authors       = ["Lob"]
   spec.email         = ["support@lob.com"]
   spec.description   = %q{Lob API Ruby wrapper}
@@ -18,7 +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", ">= 0"
+  spec.add_dependency "rest-client", "~> 1.7.0"
+
+  spec.add_dependency "prawn", ">= 0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.3.2"

data/spec/lob/v1/address_spec.rb

@@ -4,13 +4,12 @@ describe Lob::V1::Address do
 
   let(:sample_params) {
     {
-      name:    "Test",
-      email:   "test@test.com",
-      address_line1: "220 WILLIAM T MORRISSEY BLVD",
-      city:    "Boston",
-      state:   "MA",
+      name: "John Doe",
+      address_line1: "325 Berry Street",
+      city: "San Francisco",
+      state: "CA",
       country: "US",
-      zip:     02125
+      zip: 94158
     }
   }
 

data/spec/lob/v1/bank_account_spec.rb

@@ -15,7 +15,7 @@ describe Lob::V1::BankAccount do
     }
 
     @sample_bank_account_params = {
-      routing_number: "123456789",
+      routing_number: "122100024",
       account_number: "123456789"
     }
   end
@@ -91,4 +91,19 @@ describe Lob::V1::BankAccount do
     end
   end
 
+  describe "destroy" do
+    it "should delete a bank_account" do
+      VCR.use_cassette('delete_bank_account') do
+        new_bank_account = subject.bank_accounts.create(
+          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
+        )
+
+        delete_result = subject.bank_accounts.destroy(new_bank_account["id"])
+        assert_equal(new_bank_account["id"], delete_result["id"])
+      end
+    end
+  end
 end

data/spec/lob/v1/check_spec.rb

@@ -15,7 +15,7 @@ describe Lob::V1::Check do
     }
 
     @sample_bank_account_params = {
-      routing_number: "123456789",
+      routing_number: "122100024",
       account_number: "123456789"
     }
   end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: lob
 version: !ruby/object:Gem::Version
-  version: '1.4'
+  version: '1.5'
 platform: ruby
 authors:
 - Lob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-01 00:00:00.000000000 Z
+date: 2014-10-01 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.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: prawn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -149,6 +163,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/addresses.rb
+- examples/checks.rb
+- examples/create_pdf.rb
+- examples/jobs.rb
+- examples/postcards.rb
+- examples/verification.rb
 - lib/lob.rb
 - lib/lob/lob_error.rb
 - lib/lob/v1/address.rb