lob 1.5 → 1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da1de55d24c191d96b977778bc662314c4a6523d
-  data.tar.gz: 1a6bf843e2f9730735a0aa6ad5c89b228eb77c75
+  metadata.gz: 1b67da6c7e2938a86f2c5884a070c81a366b410d
+  data.tar.gz: 1166c4df4106f04b383b56514189745646b17e2f
 SHA512:
-  metadata.gz: 22cddc118df4adee9bad8bc045a98138e82353b9d4783a9912dec8e75e87dede1183ba0f59c5715b8c91b416111b6cba38a96ac6175b201259cbe29547835504
-  data.tar.gz: 151991770ed6e72b43710473c35b9d5f34c09f2c66aaf72d5bbda99aab89955161261fddfe9bc0dd7c44f3d2bf4953947cd5746f9b5f8a14678f43d94fa14556
+  metadata.gz: e70dba9281e47906d648e12b0367ef3687d2d99f4bd764e714711f7ea8c1f59b99c755d9e75068a00891803e9c7c28468a1e71707d45e86311ca7ee27fd91443
+  data.tar.gz: a05e6868b870375aad6d889063b0fd13a97b36e8d05451190023f162bed5c717c79b31f33f92179c224459638aa30b5ee8eabd420fe9d8141236e6f4e0b2cb62

data/README.md

@@ -1,11 +1,22 @@
 # 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)](https://rubygems.org/gems/lob)
+[![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)
 
 Ruby wrapper for the [Lob.com](http://lob.com) API. This gem gives you an ActiveRecord-style syntax to use the Lob.com API.
 
 Supports Ruby 1.9.3 and greater.
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Supported Image Types](#supported-image-types)
+- [Initialization and Configuration](#initialization-and-configuration)
+- [API Reference](#api-reference)
+- [Developing](#developing)
+- [Testing](#testing)
+- [Contributing](#contributing)
+
 ## Installation
 
 Add this line to your application's `Gemfile`:
@@ -16,14 +27,14 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or manually install it yourself:
 
     $ gem install lob
 
 ## 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://www.lob.com/account).
+You'll need a Lob.com API key. It's free and you can get yours [here](https://dashboard.lob.com/account).
 
 For optional parameters and other details, refer the docs here - <https://lob.com/docs>
 
@@ -33,8 +44,8 @@ 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.
 
-Supported Image Types
---------
+## Supported Image Types
+
 The lob.com API supports the following image types:
 
 - PDF
@@ -43,13 +54,11 @@ The lob.com API supports the following image types:
 
 For more information on prepping the images please see the [Lob documentation](https://lob.com/docs#prepping)
 
-Creating a PDF
--------
+#### 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)
 
-Initialization and configuration
-------
+## Initialization and Configuration
 
 ```ruby
 # To initialize a Lob object
@@ -71,87 +80,63 @@ 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
-
-```ruby
-# name, address, city, state, country and zip are required parameters
-@lob.addresses.create(
-  name: "John Doe",
-  address_line1: "104, Printing Boulevard",
-  city: "Boston",
-  state: "MA",
-  country: "US",
-  zip: 12345
-)
-
-# You can also pass address_line2
-@lob.addresses.create(
-  name: "John Doe",
-  email: "test@test.com",  # see you can also pass other optional parameters?
-  address_line1: "104, Printing Boulevard",
-  address_line2: "Sunset Town",
-  city: "Boston",
-  state: "MA",
-  country: "US",
-  zip: 12345
-)
-```
-
-#### List addresses
-
-```ruby
-# returns an array of addresses
-@lob.addresses.list
-
-#you can also pass count and offset
-@lob.addresses.list(count: 10, offset: 3)
-```
-
-#### Find a specific address
-
-```ruby
-# returns the address with the corresponding ID
-@lob.addresses.find("some-address-id")
-```
-
-#### Deletes a specific address
-
-```ruby
-# deletes the address with the corresponding ID
-@lob.addresses.destroy("some-address-id")
-```
-
-### Address verification
-
-```ruby
-# verifies and returns an address with more details
-@lob.addresses.verify(
-      address_line1: "220 WILLIAM T MORRISSEY BLVD",
-      city:    "Boston",
-      state:   "MA",
-      zip:     "02125"
-  )
-```
-
-### Jobs
-
-#### Create jobs
+## API Reference
+
+- [Simple Print Service](#simple-print-service)
+  - [lob.jobs](#lobjobs)
+    - [lob.jobs.create](#lobjobscreate)
+    - [lob.jobs.list](#lobjobslist)
+    - [lob.jobs.find](#lobjobsfind)
+  - [lob.addresses](#lobaddresses)
+    - [lob.addresses.create](#lobaddressescreate)
+    - [lob.addresses.list](#lobaddresseslist)
+    - [lob.addresses.find](#lobaddressesfind)
+    - [lob.addresses.destroy](#lobaddressesdestroy)
+    - [lob.addresses.verify](#lobaddressesverify)
+  - [lob.objects](#lobobjects)
+    - [lob.objects.create](#lobobjectscreate)
+    - [lob.objects.list](#lobobjectslist)
+    - [lob.objects.find](#lobobjectsfind)
+    - [lob.objects.destroy](#lobobjectsdestroy)
+  - [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)
+  - [lob.postcards](#lobpostcards)
+    - [lob.postcards.create](#lobpostcardscreate)
+    - [lob.postcards.list](#lobpostcardslist)
+    - [lob.postcards.find](#lobpostcardsfind)
+- [Simple Check Service](#simple-check-service)
+  - [lob.checks](#lobchecks)
+    - [lob.checks.create](#lobcheckscreate)
+    - [lob.checks.list](#lobcheckslist)
+    - [lob.checks.find](#lobchecksfind)
+  - [lob.bank_accounts](#lobbank_accounts)
+    - [lob.bank_accounts.create](#lobbank_accountscreate)
+    - [lob.bank_accounts.list](#lobbank_accountslist)
+    - [lob.bank_accounts.find](#lobbank_accountsfind)
+- [Simple Area Mail](#simple-area-mail)
+  - [lob.areas](#lobareas)
+    - [lob.areas.create](#lobareascreate)
+    - [lob.areas.list](#lobareaslist)
+    - [lob.areas.find](#lobareasfind)
+  - [lob.routes](#lobroutes)
+    - [lob.routes.find](#lobroutesfind)
+- [Resources](#lobresources)
+  - [lob.countries](#lobcountries)
+    - [lob.countries.list](#lobcountrieslist)
+  - [lob.states](#lobstates)
+    - [lob.states.list](#lobstateslist)
+
+## Simple Print Service
+
+### lob.jobs
+
+#### lob.jobs.create
 
 ```ruby
 
@@ -181,7 +166,7 @@ end
   },
   objects: {
     name: "Local File Object",
-    file:      File.new(File.expand_path("<<YOUR PATH>>/letter.pdf", __FILE__)),
+    file: File.new("/path/to/file.pdf"),
     setting_id: 100
   })
 
@@ -244,7 +229,7 @@ end
 
 ```
 
-#### List jobs
+#### lob.jobs.list
 
 ```ruby
 # returns an array of jobs
@@ -254,16 +239,70 @@ end
 @lob.jobs.list(count: 10, offset: 3)
 ```
 
-#### Find a specific job
+#### lob.jobs.find
 
 ```ruby
 # returns the job with the corresponding ID
 @lob.jobs.find("some-job-id")
 ```
 
-### Objects
+### lob.addresses
+
+#### lob.addresses.create
+
+```ruby
+# name, address, city, state, country and zip are required parameters
+@lob.addresses.create(
+  name: "John Doe",
+  email: "test@test.com",  # optional
+  address_line1: "104, Printing Boulevard",
+  address_line2: "Sunset Town", # optional
+  city: "Boston",
+  state: "MA",
+  country: "US",
+  zip: 12345
+)
+```
+
+#### lob.addresses.list
+
+```ruby
+# returns an array of addresses
+@lob.addresses.list
+
+#you can also pass count and offset
+@lob.addresses.list(count: 10, offset: 3)
+```
+
+#### lob.addresses.find
+
+```ruby
+# returns the address with the corresponding ID
+@lob.addresses.find("some-address-id")
+```
 
-#### Create objects
+#### lob.addresses.destroy
+
+```ruby
+# deletes the address with the corresponding ID
+@lob.addresses.destroy("some-address-id")
+```
+
+#### lob.addresses.verify
+
+```ruby
+# verifies and returns an address with more details
+@lob.addresses.verify(
+      address_line1: "220 WILLIAM T MORRISSEY BLVD",
+      city:    "Boston",
+      state:   "MA",
+      zip:     "02125"
+  )
+```
+
+### lob.objects
+
+#### lob.objects.create
 
 ```ruby
 # You can create an onject by passing the name, file url and setting ID, quantity is defaulted to 1
@@ -283,7 +322,7 @@ end
 )
 ```
 
-#### List objects
+#### lob.objects.list
 
 ```ruby
 # returns an array of objects
@@ -293,32 +332,57 @@ end
 @lob.objects.list(count: 10, offset: 3)
 ```
 
-#### Find a specific object
+#### lob.objects.find
 
 ```ruby
 # returns the object with the corresponding ID
 @lob.objects.find("some-object-id")
 ```
 
-#### Delete a specific object
+#### lob.objects.destroy
 
 ```ruby
 # deletes the object with the corresponding ID
 @lob.objects.destroy("some-object-id")
 ```
 
-### Packagings
+### lob.settings
+
+#### lob.settings.list
+```ruby
+# returns an array of settings
+@lob.settings.list
+```
+
+#### lob.settings.find
+```ruby
+# returns a setting object
+@lob.settings.find("setting_id")
+```
 
-#### List packagings
+### lob.packagings
+
+#### lob.packagings.list
 
 ```ruby
 # returns a list of packagings
 @lob.packagings.list
 ```
 
-### Postcards
+### lob.services
 
-#### Creating postcards
+#### lob.services.list
+
+```ruby
+# returns a list of services
+@lob.services.list
+```
+
+## Simple Postcard Service
+
+### lob.postcards
+
+#### lob.postcards.create
 
 You'll have to specify either the `message` option or the `back` option.
 
@@ -381,7 +445,7 @@ You'll have to specify either the `message` option or the `back` option.
 )
 ```
 
-#### List postcards
+#### lob.postcards.list
 
 ```ruby
 @lob.postcards.list
@@ -390,21 +454,111 @@ You'll have to specify either the `message` option or the `back` option.
 @lob.postcards.list(count: 10, offset: 3)
 ```
 
-#### Find a postcard
+#### lob.postcards.find
 
 ```ruby
 @lob.postcards.find("post-card-id")
 ```
 
-### Simple Area Mail
+## Simple Check Service
 
-#### Create areas
+### lob.checks
+
+#### lob.checks.create
+
+```ruby
+# For the "to" address, you can pass params
+# Transfer $5000 to a bank account.
+@lob.checks.create(
+  bank_account: "bank-account-id",
+  to: {
+    name: "FromAddress",
+    address_line1: "120, 6th Ave",
+    city: "Boston",
+    state: "MA",
+    country: "US",
+    zip: 12345
+  },
+  amount: 5000
+)
+
+# or an address ID
+@lob.checks.create(
+  bank_account: "bank-account-id",
+  to: "to-address-ID",
+  amount: 5000
+)
+
+# You can also specify an optional 4th argument, with other options.
+```
+
+#### lob.checks.list
+
+```ruby
+@lob.checks.list
+```
+
+#### lob.checks.find
+
+```ruby
+@lob.checks.find("check-id")
+```
+
+### lob.bank_accounts
+
+#### lob.bank_accounts.create
+
+```ruby
+bank_address =
+
+account_address =
+
+# Pass address params or address IDs
+# The 5th argument is the options argument and is optional
+@lob.bank_accounts.create(
+  routing_number: "routing_number",
+  account_number: "account_number",
+  bank_address: {
+    name: "ToAddress",
+    address_line1: "120 6th Ave",
+    city: "Boston",
+    country: "US",
+    zip: 12345
+  },
+  account_address: {
+    name: "ToAddress",
+    address_line1: "120 6th Ave",
+    city: "Boston",
+    country: "US",
+    zip: 12345
+  }
+)
+```
+
+#### lob.bank_accounts.list
+
+```ruby
+# returns a list of accounts
+@lob.bank_accounts.list
+```
+
+#### lob.bank_accounts.find
+
+```ruby
+@lob.bank_accounts.find("bank-account-id")
+```
+
+## Simple Area Mail
+
+### lob.areas
+
+#### lob.areas.create
 
 You'll have to specify front, back, and either zip_codes or routes
 
 ```ruby
 # create an area request with routes
-@lob.area.create(
+@lob.areas.create(
   name: "My Area",
   front: "https://www.lob.com/areafront.pdf",
   back: "https://www.lob.com/areaback.pdf",
@@ -414,7 +568,7 @@ You'll have to specify front, back, and either zip_codes or routes
 )
 
 # create an area request with zip_codes
-@lob.area.create(
+@lob.areas.create(
   name: "My Area",
   front: "https://www.lob.com/areafront.pdf",
   back: "https://www.lob.com/areaback.pdf",
@@ -426,7 +580,7 @@ You'll have to specify front, back, and either zip_codes or routes
 
 zip_codes and routes can be a string or an array of strings
 
-#### List areas
+#### lob.areas.list
 ```ruby
 @lob.areas.list
 
@@ -434,17 +588,16 @@ zip_codes and routes can be a string or an array of strings
 @lob.areas.list(count: 10, offset: 3)
 ```
 
-
-#### Find an area
+#### lob.areas.find
 ```ruby
 @lob.areas.find("area_id")
 ```
 
-### Routes
+### lob.routes
 
 You'll have to specify zip_codes
 
-#### Find routes
+#### lob.routes.find
 
 ```ruby
 @lob.routes.find(
@@ -454,81 +607,24 @@ You'll have to specify zip_codes
 
 zip_codes can be a string or an array of strings
 
-### Services
-
-#### List services
-
-```ruby
-# returns a list of services
-@lob.services.list
-```
-
-### Bank accounts
-
-#### List bank accounts
-
-```ruby
-# returns a list of accounts
-@lob.bank_accounts.list
-```
-
-#### Add a bank account
-
-```ruby
-bank_address = {name: "ToAddress", address_line1: "120, 6th Ave", city: "Boston", country: "US", zip: 12345}
-account_address = {name: "ToAddress", address_line1: "120, 6th Ave", city: "Boston", country: "US", zip: 12345}
-
-# Pass address params or address IDs
-# The 5th argument is the options argument and is optional
-@lob.bank_accounts.create(
-  routing_number: "routing_number",
-  bank_address: bank_address,
-  account_number: "account_number",
-  account_address: account_address
-)
-```
-
-#### Find a bank account
-
-```ruby
-@lob.bank_accounts.find("bank-account-id")
-```
-
-### Checks
-
-#### Create a check
-
-```ruby
-# Transfer $5000 to a bank account.
-@lob.checks.create(
-  bank_account: "bank-account-id",
-  to: "to-address-ID",
-  amount: 5000
-)
-
-# For the "to" address, you can pass params or an address ID
-# You can also specify an optional 4th argument, with other options.
-```
-
-#### List checks
+## Resources
 
-```ruby
-@lob.checks.list
-```
+### lob.countries
 
-#### Find a check
+#### lob.countries.list
 
 ```ruby
-@lob.checks.find("check-id")
+# returns a list of countries
+@lob.countries.list
 ```
 
-### Supported countries
+### lob.states
 
-#### List supported countries
+#### lob.states.list
 
 ```ruby
-# returns a list of countries
-@lob.countries.list
+# returns a list of states
+@lob.states.list
 ```
 
 ## Developing
@@ -541,7 +637,7 @@ Make sure you have Ruby 2.0 installed. Copy and paste the following commands in
 
 You are powered up and ready to roll ~!
 
-## Running the test-suite
+## Testing
 
 To run the tests, download the required sample files by running the following command:
 

data/examples/checks.rb

@@ -5,13 +5,45 @@ require 'lob'
 Lob.api_key = 'test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc'
 @lob = Lob.load
 
+# create an address
+to_address = @lob.addresses.create(
+  name: "John Doe",
+  address_line1: "104 Printing Boulevard",
+  city: "Boston",
+  state: "MA",
+  country: "US",
+  zip: 12345
+)
+
+# create a bank account
+bank_account = @lob.bank_accounts.create(
+  routing_number: "322271627",
+  account_number: "123456789",
+  bank_address: {
+    name: "Bank Address",
+    address_line1: "120 6th Ave",
+    city: "Boston",
+    state: "MA",
+    country: "US",
+    zip: 12345
+  },
+  account_address: {
+    name: "Account Address",
+    address_line1: "120 6th Ave",
+    city: "Boston",
+    state: "MA",
+    country: "US",
+    zip: 12345
+  }
+)
+
 # 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',
+  name: "Test Check",
+  check_number: "10000",
+  bank_account: bank_account["id"],
+  to: to_address["id"],
   amount: 100,
-  memo: 'This is my first Check',
-  message: 'This check is for laundry'
+  memo: "This is my first Check",
+  message: "This check is for laundry"
 )

data/examples/jobs.rb

@@ -10,37 +10,38 @@ 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
+# create a file object to user later
 michigan_logo = @lob.objects.create(
   name: "Michigan Logo Document",
+  file: "https://www.lob.com/goblue.pdf",
+  setting_id: setting_id
+)
+
+# create a to address
+to_address = @lob.addresses.create(
+  name: "ToAddress",
+  address_line1: "120 6th Ave",
+  city: "Boston",
+  state: "MA",
+  country: "US",
+  zip: 12345
+)
+
+# create a from address
+from_address = @lob.addresses.create(
+  name: "FromAddress",
+  address_line1: "120 6th Ave",
+  city: "Boston",
+  state: "MA",
+  country: "US",
+  zip: 12345
 )
 
 
-@lob.jobs.create(
+# send the object you created
+puts @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
-  }
+  to: to_address["id"],
+  from: from_address["id"],
+  objects: michigan_logo["id"]
 )

data/examples/postcards.rb

@@ -5,53 +5,31 @@ require 'lob'
 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
-
+# create a to address
 to_address = @lob.addresses.create(
   name: "ToAddress",
-  address_line1: "120, 6th Ave",
+  address_line1: "120 6th Ave",
   city: "Boston",
   state: "MA",
   country: "US",
   zip: 12345
 )
 
+# create a from address
 from_address = @lob.addresses.create(
   name: "FromAddress",
-  address_line1: "120, 6th Ave",
+  address_line1: "120 6th Ave",
   city: "Boston",
   state: "MA",
   country: "US",
   zip: 12345
 )
 
+# send a postcard
 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")
+  back: "https://www.lob.com/postcardback.pdf"
 )

data/lib/lob.rb

@@ -6,7 +6,6 @@ require "lob/lob_error"
 Dir[File.join(File.dirname(__FILE__), 'lob', 'v*', '*.rb')].each {|file| require file }
 
 module Lob
-
   class << self
     attr_accessor :api_key,
                   :api_version,
@@ -29,8 +28,18 @@ module Lob
 
 
   def self.submit(method, url, parameters={})
-    parameters = {:params => parameters} if method == :get
-    JSON(RestClient.send(method, url, parameters))
+    clientVersion = Gem.latest_spec_for('lob').version.to_s
+
+    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

data/lib/lob/v1/resource.rb

@@ -16,6 +16,18 @@ module Lob
         Lob::V1::Address.new(self)
       end
 
+      def bank_accounts
+        Lob::V1::BankAccount.new(self)
+      end
+
+      def checks
+        Lob::V1::Check.new(self)
+      end
+
+      def countries
+        Lob::V1::Country.new(self)
+      end
+
       def jobs
         Lob::V1::Job.new(self)
       end
@@ -44,19 +56,10 @@ module Lob
         Lob::V1::Setting.new(self)
       end
 
-      def countries
-        Lob::V1::Country.new(self)
-      end
-
-      def checks
-        Lob::V1::Check.new(self)
+      def states
+        Lob::V1::State.new(self)
       end
 
-      def bank_accounts
-        Lob::V1::BankAccount.new(self)
-      end
-
-
       def base_url
         "#{@options[:protocol]}://#{@options[:api_key]}:@#{@options[:api_host]}/v1"
       end

data/lib/lob/v1/state.rb

@@ -0,0 +1,21 @@
+module Lob
+  module V1
+    class State
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def list(options={})
+        Lob.submit(:get, state_url, options)["data"] || []
+      end
+
+      private
+
+      def state_url
+        @resource.construct_url("states")
+      end
+
+    end
+  end
+end

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.5"
+  spec.version       = "1.6"
   spec.authors       = ["Lob"]
   spec.email         = ["support@lob.com"]
   spec.description   = %q{Lob API Ruby wrapper}

data/spec/lob/v1/country_spec.rb

@@ -1,7 +1,6 @@
 require "spec_helper"
 
 describe Lob::V1::Country do
-
   subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
 
   describe "list" do
@@ -12,5 +11,4 @@ describe Lob::V1::Country do
       end
     end
   end
-
 end

data/spec/lob/v1/state_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe Lob::V1::State do
+  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+
+  describe "list" do
+    it "should list states" do
+      VCR.use_cassette('list_states') do
+        result = subject.states.list
+        result.length.must_be :>, 0
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lob
 version: !ruby/object:Gem::Version
-  version: '1.5'
+  version: '1.6'
 platform: ruby
 authors:
 - Lob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-01 00:00:00.000000000 Z
+date: 2014-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -163,12 +163,10 @@ 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
@@ -184,6 +182,7 @@ files:
 - lib/lob/v1/route.rb
 - lib/lob/v1/service.rb
 - lib/lob/v1/setting.rb
+- lib/lob/v1/state.rb
 - lob.gemspec
 - spec/lob/v1/address_spec.rb
 - spec/lob/v1/area_spec.rb
@@ -198,6 +197,7 @@ files:
 - spec/lob/v1/route_spec.rb
 - spec/lob/v1/service_spec.rb
 - spec/lob/v1/setting_spec.rb
+- spec/lob/v1/state_spec.rb
 - spec/lob_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/lob/lob-ruby
@@ -238,5 +238,6 @@ test_files:
 - spec/lob/v1/route_spec.rb
 - spec/lob/v1/service_spec.rb
 - spec/lob/v1/setting_spec.rb
+- spec/lob/v1/state_spec.rb
 - spec/lob_spec.rb
 - spec/spec_helper.rb

data/examples/addresses.rb

@@ -1,16 +0,0 @@
-$:.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/verification.rb

@@ -1,14 +0,0 @@
-$:.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"
-)