lob 2.5.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aeb6af163fc361fdb79c8f88e9ea9e8570349e75
-  data.tar.gz: 916b2af3487b3d83ea4a00be2d6e832533b0345e
+  metadata.gz: 37c8b30c17f9f1e2bf17d7fb3030e6a5f503ed08
+  data.tar.gz: f3be769fb4eb543072f637e89c5a2a382391872b
 SHA512:
-  metadata.gz: 4167e151a4e13a8a213114f2d44802d0a7ae515156467203f23e469d9f76b8fcae73413f179612c22f4c992151e707139d92467dabde8725b3e6be283c99ceae
-  data.tar.gz: e25f982538eba19b6a79017785e302e3cda7e94e24f877ed879aca61971588b34a5b2cf0999e6c0eefd417f490adb9bb1ee0b8a77fcd098e4310dd876e0c7019
+  metadata.gz: 83785a95d0f3bed197b7ce4f89269b8c695715f5aafc1591651229ed2ffe47888209097320919befa9a20b25d17ec5a72b77a496b69ca648bb6f543248c85365
+  data.tar.gz: 20bca49d8ab6271f0c4c9b0186aa55e3b4a2dc8277b68bc2795f01477b426185589e465afab92697c809a605cb8b7d016a5876ef8cf078e1592c052be84c0daf

data/.travis.yml

@@ -3,14 +3,14 @@ language: ruby
 sudo: false
 
 rvm:
-  - 1.9.3
   - jruby
   - 2.0.0
   - 2.1
   - 2.2
+  - 2.3.0
+  - 2.3.1
 
 env:
   JRUBY_OPTS=--2.0
-  - LOB_API_KEY=test_799ff27291c166d10ba191902ad02fb059c
 
 script: bundle exec rake test

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 3.0.0
+
+Version 3.0.0 introduces several breaking changes. It requires a minimum API version of `2015-04-11`.
+
+* Ruby 1.9.3 is no longer supported. lob-ruby now supports Ruby versions at or above 2.0.0.
+* Jobs and Objects resources have been deprecated from the gem.
+* Resources have been moved from `Lob::V1` to the `Lob::Resources` namespace and have been refactored to contain the HTTP request/response logic..
+* Configuration for the Lob Client has been changed. `Lob()`, `Lob.load`, and `Lob.configure` have all been deprecated and replaced with a single method of configuration: `Lob::Client.new(api_key: "your-api-key")`.
+
 ## [**2.5.1**](https://github.com/lob/lob-ruby/releases/tag/v2.5.1)
 - [**#145**] (https://github.com/lob/lob-ruby/pull/145) More lenient rest-client version restriction
 

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# How to contribute
+
+We welcome contributions from the community and are pleased to have them. Please follow this guide when logging issues or making code changes.
+
+Make sure you have Ruby 2.0 installed. Copy and paste the following commands in your projects directory.
+
+    git clone https://github.com/lob/lob-ruby.git
+    cd lob-ruby
+    bundle install
+
+## Contributing Instructions
+
+1. Fork it
+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
+6. Open up coverage/index.html in your browser and add tests if required
+7. Create new Pull Request

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in lob.gemspec
 gemspec
-
-gem 'prawn', '~> 1.3.0', platform: :ruby_19

data/README.md

@@ -8,7 +8,7 @@
 
 Ruby wrapper for the [Lob.com](http://lob.com) API. See the full Lob.com [API Documentation](https://lob.com/docs/ruby).  For best results, be sure that you're using [the latest version](https://lob.com/docs/ruby#version) of the Lob API and the latest version of the ruby wrapper. This gem gives you an ActiveRecord-style syntax to use the Lob.com API.
 
-Supports Ruby 1.9.3 and greater.
+Supports Ruby 2.0.0 and greater.
 
 ## Table of Contents
 
@@ -61,20 +61,10 @@ For optional parameters and other details, refer to the docs [here](https://lob.
 
 ```ruby
 # To initialize a Lob object
-@lob = Lob.load(api_key: "your-api-key")
+lob = Lob::Client.new(api_key: "your-api-key")
 
-# Alternatively, to set the API key for all calls in the future
-Lob.api_key = "your-api-key"
-@lob = Lob.load
-```
-
-#### Or if you want some detailed configuration
-
-```ruby
-Lob.configure do |config|
-  config.api_key = "your-api-key"    # get your own at http://lob.com :)
-  config.api_version = "2014-12-18"  # override the API version
-end
+# To initialize a Lob object with an older API version
+lob = Lob::Client.new(api_key: "your-api-key", api_version: "2014-12-18")
 ```
 
 #### Caution: Pass zero-prefixed zip codes as strings
@@ -88,7 +78,7 @@ The Ruby interpreter assumes it's not of base-10 and tries to convert it to base
 You can access response headers via a hidden `headers` method on the response hash.
 
 ```ruby
-addresses = @lob.addresses.list
+addresses = lob.addresses.list
 
 addresses._response.headers[:content_type]
 # => "application/json; charset=utf-8"
@@ -104,7 +94,7 @@ You can also access headers from `Lob::InvalidRequestError`s.
 
 ```ruby
 begin
-  @lob.objects.create(name: "Test", file: "https://lob.com/test.pdf", bad_param: "bad_value")
+  lob.objects.create(name: "Test", file: "https://lob.com/test.pdf", bad_param: "bad_value")
 rescue Lob::InvalidRequestError => e
   e._response.headers[:content_type]
   # => "application/json; charset=utf-8"
@@ -126,8 +116,10 @@ There are simple scripts to demonstrate how to create all the core Lob products
 - [Errors](https://lob.com/docs/ruby#errors)
 - [Rate Limiting](https://lob.com/docs/ruby#rate-limits)
 - [Metadata](https://lob.com/docs/ruby#metadata)
+- [Asset URLs](https://lob.com/docs/ruby#urls)
 - **Addresses**
   - [Address Book](https://lob.com/docs/ruby#addresses)
+    - [The Address Object](https://lob.com/docs/ruby#addresses_object)
     - [Create an Address](https://lob.com/docs/ruby#addresses_create)
     - [Retrieve an Address](https://lob.com/docs/ruby#addresses_retrieve)
     - [Delete an Address](https://lob.com/docs/ruby#addresses_delete)
@@ -136,20 +128,24 @@ There are simple scripts to demonstrate how to create all the core Lob products
     - [Verify an Address](https://lob.com/docs/ruby#verify_create)
 - **Postcards API**
   - [Postcards](https://lob.com/docs/ruby#postcards)
+    - [The Postcard Object](https://lob.com/docs/ruby#postcards_object)
     - [Create a Postcard](https://lob.com/docs/ruby#postcards_create)
     - [Retrieve a Postcard](https://lob.com/docs/ruby#postcards_retrieve)
     - [List all Postcards](https://lob.com/docs/ruby#postcards_list)
 - **Letters API**
   - [Letters](https://lob.com/docs/ruby#letters)
+    - [The Letter Object](https://lob.com/docs/ruby#letters_object)
     - [Create a Letter](https://lob.com/docs/ruby#letters_create)
     - [Retrieve a Letter](https://lob.com/docs/ruby#letters_retrieve)
     - [List all Letters](https://lob.com/docs/ruby#letters_list)
 - **Checks API**
   - [Checks](https://lob.com/docs/ruby#checks)
+    - [The Check Object](https://lob.com/docs/ruby#checks_object)
     - [Create a Check](https://lob.com/docs/ruby#checks_create)
     - [Retrieve a Check](https://lob.com/docs/ruby#checks_retrieve)
     - [List all Checks](https://lob.com/docs/ruby#checks_list)
   - [Bank Accounts](https://lob.com/docs/ruby#bank-accounts)
+    - [The Bank Account Object](https://lob.com/docs/ruby#bankaccounts_object)
     - [Create a Bank Account](https://lob.com/docs/ruby#bankaccounts_create)
     - [Retrieve a Bank Account](https://lob.com/docs/ruby#bankaccounts_retrieve)
     - [Delete a Bank Account](https://lob.com/docs/ruby#bankaccounts_delete)
@@ -157,12 +153,14 @@ There are simple scripts to demonstrate how to create all the core Lob products
     - [List all Bank Accounts](https://lob.com/docs/ruby#bankaccounts_list)
 - **Area Mail API**
   - [Areas](https://lob.com/docs/ruby#areas)
+    - [The Area Object](https://lob.com/docs/ruby#areas_object)
     - [Create an Area Mailing](https://lob.com/docs/ruby#areas_create)
     - [Retrieve an Area Mailing](https://lob.com/docs/ruby#areas_retrieve)
     - [List all Area Mailings](https://lob.com/docs/ruby#areas_list)
   - [Routes](https://lob.com/docs/ruby#routes)
-    - [Retrieve a Zip Code](https://lob.com/docs/ruby#routes_retrieve)
-    - [List all Zip Codes](https://lob.com/docs/ruby#routes_list)
+    - [The Routes Object](https://lob.com/docs/ruby#routes_object)
+    - [Retrieve Routes](https://lob.com/docs/ruby#routes_retrieve)
+    - [List all Routes](https://lob.com/docs/ruby#routes_list)
 - **Resources**
   - [Countries](https://lob.com/docs/ruby#countries)
     - [List all Countries](https://lob.com/docs/ruby#countries_list)
@@ -170,36 +168,21 @@ There are simple scripts to demonstrate how to create all the core Lob products
     - [List all States](https://lob.com/docs/ruby#states_list)
 - **Appendix**
   - [API Changelog](https://lob.com/docs/ruby#changelog)
+  - [The Tracking Event Object](https://lob.com/docs/ruby#tracking_event_object)
   - [HTML Examples](https://lob.com/docs/ruby#html-examples)
   - [Image Prepping](https://lob.com/docs/ruby#prepping)
 
 ## Contributing
 
-Make sure you have Ruby 2.0 installed. Copy and paste the following commands in your projects directory.
-
-    git clone https://github.com/lob/lob-ruby.git
-    cd lob-ruby
-    bundle install
-
-### Contributing Instructions
-
-1. Fork it
-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
-6. Open up coverage/index.html in your browser and add tests if required
-7. Create new Pull Request
+To contribute, please see the [CONTRIBUTING.md](CONTRIBUTING.md) file.
 
 ## Testing
 
 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.
-
 Here's how you can run the tests:
 
-    LOB_API_KEY=your_test_api_key bundle exec rake test
+    bundle exec rake test
 
 You can also configure, TravisCI for your fork of the repository and it'll run the tests for you, when you push.
 

data/examples/README.md

@@ -2,26 +2,34 @@
 
 This directory contains a collection of ruby example to help get you started using the Lob API. As always, feel free to [contact us](https://lob.com/support) directly if you have any questions.
 
+## /csv_checks/
+
+An example showing how to dynamically create checks from a CSV using HTML, variable data, and Lob's [Checks API](https://lob.com/services/checks).
+
+## /csv_letters/
+
+An example showing how to dynamically create letters from a CSV using HTML, a custom font, variable data, and Lob's [Letters API](https://lob.com/services/letters).
+
 ## /csv_postcards/
 
-An example showing how to dynamically create postcards from a CSV using HTML, a custom font, variable data, and Lob's [Simple Postcard Service](https://lob.com/services/postcards).
+An example showing how to dynamically create postcards from a CSV using HTML, a custom font, variable data, and Lob's [Postcards API](https://lob.com/services/postcards).
 
 ## /checks.rb
 
-An example showing how to create a check using Lob's [Simple Check Service](https://lob.com/services/checks).
+An example showing how to create a check using Lob's [Checks API](https://lob.com/services/checks).
 
 ## /jobs.rb
 
-An example showing how to create objects and jobs using Lob's [Simple Print Service](https://lob.com/services/sps).
+An example showing how to create objects and jobs using Lob's [Jobs API](https://lob.com/services/sps).
 
 ## /letters.rb
 
-And example showing how to create letters using Lob's [Simple Letter Service](https://lob.com/services/letters).
+An example showing how to create a letter using Lob's [Letters API](https://lob.com/services/letters).
 
 ## /postcards.rb
 
-An example showing how to create postcards using Lob's [Simple Postcard Service](https://lob.com/services/postcards).
+An example showing how to create a postcard using Lob's [Postcards API](https://lob.com/services/postcards).
 
-## /verify.rb
+## /verify/
 
 An example showing how to verify an address using the [StreetAddress gem](https://github.com/derrek/street-address) and Lob's verify endpoint. This example saves verified addresses in a CSV file.

data/examples/checks.rb

@@ -2,11 +2,10 @@ $:.unshift File.expand_path("../lib", File.dirname(__FILE__))
 require 'lob'
 
 # initialize Lob object
-Lob.api_key = 'test_799ff27291c166d10ba191902ad02fb059c'
-@lob = Lob.load
+lob = Lob::Client.new(api_key: 'test_799ff27291c166d10ba191902ad02fb059c')
 
 # create an address
-to_address = @lob.addresses.create(
+to_address = lob.addresses.create(
   name: "John Doe",
   address_line1: "104 Printing Boulevard",
   address_city: "Boston",
@@ -16,7 +15,7 @@ to_address = @lob.addresses.create(
 )
 
 # create a from address
-from_address = @lob.addresses.create(
+from_address = lob.addresses.create(
   name: "Jane Doe",
   address_line1: "123 Hello Ave",
   address_city: "Providence",
@@ -26,7 +25,7 @@ from_address = @lob.addresses.create(
 )
 
 # create a bank account
-bank_account = @lob.bank_accounts.create(
+bank_account = lob.bank_accounts.create(
   routing_number: "322271627",
   account_number: "123456789",
   account_type: "company",
@@ -34,10 +33,10 @@ bank_account = @lob.bank_accounts.create(
 )
 
 puts bank_account
-@lob.bank_accounts.verify(bank_account['id'], amounts: [23, 12])
+lob.bank_accounts.verify(bank_account['id'], amounts: [23, 12])
 
 # send a $1000 check using an already created bank and address
-puts @lob.checks.create(
+puts lob.checks.create(
   description: "Test Check",
   check_number: "10000",
   bank_account: bank_account["id"],

data/examples/csv_checks/create_checks.rb

@@ -0,0 +1,47 @@
+$:.unshift File.expand_path("../../lib", File.dirname(__FILE__))
+require 'lob'
+require 'csv'
+
+# Initialize Lob object
+lob = Lob::Client.new(api_key: 'test_799ff27291c166d10ba191902ad02fb059c')
+
+# Create a bank account
+bank_account = lob.bank_accounts.create(
+  routing_number: "322271627",
+  account_number: "123456789",
+  account_type: "company",
+  signatory: "John Doe"
+)
+
+puts bank_account
+
+# Verify bank account
+lob.bank_accounts.verify(bank_account['id'], amounts: [23, 12])
+
+# Parse the CSV and create the checks
+CSV.foreach(File.expand_path('../input.csv', __FILE__)) do |row|
+  check = lob.checks.create(
+    description: 'CSV Test',
+    bank_account: bank_account["id"],
+    to: {
+      name: row[0],
+      address_line1: row[1],
+      address_line2: row[2],
+      address_city: row[3],
+      address_state: row[4],
+      address_zip: row[5],
+      address_country: row[6]
+    },
+    from: {
+      name: 'Lob',
+      address_line1: '123 Main Street',
+      address_city: 'San Francisco',
+      address_state: 'CA',
+      address_zip: '94185',
+      address_country: 'US'
+    },
+    amount: row[7],
+    memo: "For travel reimbursement"
+  )
+  puts check['url']
+end

data/examples/csv_checks/input.csv

@@ -0,0 +1,6 @@
+Pallavi,353 King Street,Apt. 432,San Francisco,CA,94158,US,600.00
+Dom,456 Oak Street,Apt. 102,San Francisco,CA,94185,US,500.00
+Kyle,123 Test Street,Apt. 101,San Francisco,CA,94105,US,400.00
+Kienan,789 Elm Street,Apt. 101,San Francisco,CA,94107,US,300.00
+Sid,111 Washington Street,Apt. 101,San Francisco,CA,94112,US,200.00
+Will,888 Jefferson Street,Apt. 101,San Francisco,CA,94197,US,100.00

data/examples/csv_letters/create_letters.rb

@@ -0,0 +1,40 @@
+$:.unshift File.expand_path("../../lib", File.dirname(__FILE__))
+require 'lob'
+require 'csv'
+
+# Initialize Lob object
+lob = Lob::Client.new(api_key: 'test_799ff27291c166d10ba191902ad02fb059c')
+
+# Load the HTML from letter_template.html
+letter_html = File.open(File.expand_path('../letter_template.html', __FILE__)).read
+
+# Parse the CSV and create the letters.
+CSV.foreach(File.expand_path('../input.csv', __FILE__)) do |row|
+  letter = lob.letters.create(
+    description: 'CSV Test',
+    to: {
+      name: row[0],
+      address_line1: row[1],
+      address_line2: row[2],
+      address_city: row[3],
+      address_state: row[4],
+      address_zip: row[5],
+      address_country: row[6]
+    },
+    from: {
+      name: 'Lob',
+      address_line1: '123 Main Street',
+      address_city: 'San Francisco',
+      address_state: 'CA',
+      address_zip: '94185',
+      address_country: 'US'
+    },
+    file: letter_html,
+    data: {
+      name: row[0],
+      city: row[3]
+    },
+    color: false
+  )
+  puts letter['url']
+end

data/examples/csv_letters/input.csv

@@ -0,0 +1,6 @@
+Pallavi,353 King Street,Apt. 432,San Francisco,CA,94158,US
+Dom,456 Oak Street ,Apt. 102,San Francisco,CA,94185,US
+Kyle,123 Test Street,Apt. 101,San Francisco,CA,94105,US
+Kienan,789 Elm Street,Apt. 101,San Francisco,CA,94107,US
+Sid,111 Washington Street,Apt. 101,San Francisco,CA,94112,US
+Will,888 Jefferson Street,Apt. 101,San Francisco,CA,94197,US

data/examples/csv_letters/letter_template.html

@@ -0,0 +1,33 @@
+<html>
+<head>
+<style>
+  *, *:before, *:after {
+    -webkit-box-sizing: border-box;
+    -moz-box-sizing: border-box;
+    box-sizing: border-box;
+  }
+
+  @font-face {
+    font-family: 'Loved by the King';
+    font-style: normal;
+    font-weight: 400;
+    src: url('https://s3-us-west-2.amazonaws.com/lob-assets/LovedbytheKing.ttf') format('truetype');
+  }
+
+  .text {
+    margin-left: 75px;
+    padding-top: 250px;
+    width: 400px;
+    font-family: 'Loved by the King';
+    font-size: 50px;
+    font-weight: 700;
+    color: black;
+  }
+</style>
+</head>
+
+<body>
+  <p class="text">Hello {{name}}!<br/><br/>Join us for this year's summer celebration in {{city}}!</p>
+</body>
+
+</html>

data/examples/csv_postcards/create_postcards.rb

@@ -3,8 +3,7 @@ require 'lob'
 require 'csv'
 
 # Initialize Lob object
-Lob.api_key = 'test_799ff27291c166d10ba191902ad02fb059c'
-@lob = Lob.load
+lob = Lob::Client.new(api_key: 'test_799ff27291c166d10ba191902ad02fb059c')
 
 # Load the HTML from postcard_front.html and postcard_back.html.
 front_html = File.open(File.expand_path('../postcard_front.html', __FILE__)).read
@@ -12,7 +11,7 @@ back_html = File.open(File.expand_path('../postcard_back.html', __FILE__)).read
 
 # Parse the CSV and create the postcards.
 CSV.foreach(File.expand_path('../input.csv', __FILE__)) do |row|
-  postcard = @lob.postcards.create(
+  postcard = lob.postcards.create(
     description: 'CSV Test',
     to: {
       name: row[5],