lob 1.9.2 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdc58b192a30897179b9f0b8b2229115e3e26b94
-  data.tar.gz: ce6dbe15de20924629d3390ebbcb388c51f6001a
+  metadata.gz: 041bd3b823b10d752fabc4401a2fc20b304101b5
+  data.tar.gz: 47ab28cfd82b796c50bd7f70df075a71a4836dee
 SHA512:
-  metadata.gz: 86a27b72507cf64f2eca79f6d75708304108ddda1b0601138111fa7c058ec6829e44c2255c656bd354d5579f9298cacaaa9243056b9165d26333c90b528412c3
-  data.tar.gz: ccec81496d6cf6204274d0b58e6f0c6054d8b9135447eaf2620ff6e44ba4fa3a1fddd8857291a83468ad271cd038eea1f6a70ba2da71cf606088cd3af89e0898
+  metadata.gz: 166e26c4d59ef45e94f7d804f97bb55ecaf892afe3a258d2d3f171ec7a20ec32112bc76673da35926e3bdaebd215b482906bb99689e5292dea58095c36800d28
+  data.tar.gz: 4f4385149c826ca82dd1fcaa3687c90fceaa978b13a1b1401c1044221cf7afee7783ccbdd5a6db24266041cdd111ef7f010362f7a762e5e016e851ba270b70e0

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [**1.10.0**](https://github.com/lob/lob-ruby/releases/tag/v1.10.0)
+- [**#100**] (https://github.com/lob/lob-ruby/pull/100) adds support for Simple Letter Service
+
 ## [**1.9.2**](https://github.com/lob/lob-ruby/releases/tag/v1.9.2)
 - [**#94**] (https://github.com/lob/lob-ruby/pull/94) added bank account verify support
 

data/README.md

@@ -4,22 +4,39 @@
 
 [![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.
+Ruby wrapper for the [Lob.com](http://lob.com) API. See the full Lob.com [API Documentation](https://lob.com/docs/ruby). 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)
+- [Getting Started](#getting-started)
+  - [Registration](#registration)
+  - [Installation](#installation)
+  - [Usage](#usage)
+- [Examples](#examples)
+- [API Documentation](#api-documentation)
 - [Contributing](#contributing)
+- [Testing](#testing)
+
+## Getting Started
+
+Here's a general overview of the Lob services available, click through to read more.
+
+- [Simple Postcard Service](https://lob.com/services/postcards)
+- [Simple Letter Service](https://lob.com/services/letters)
+- [Simple Check Service](https://lob.com/services/checks)
+- [Simple Print Service](https://lob.com/services/sps)
+- [Simple Area Mail](https://lob.com/services/sam)
+- [Address Verification](https://lob.com/verification/address)
+
+### Registration
 
-## Installation
+First, you will need to first create an account at [Lob.com](https://dashboard.lob.com/#/register) and obtain your Test and Live API Keys.
+
+Once you have created an account, you can access your API Keys from the [Settings Panel](https://dashboard.lob.com/#/settings).
+
+### Installation
 
 Add this line to your application's `Gemfile`:
 
@@ -33,40 +50,13 @@ Or manually install it yourself:
 
     $ gem install lob
 
-## Usage
+### 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/settings).
 
 For optional parameters and other details, refer to the docs [here](https://lob.com/docs/ruby).
 
-#### Caution: Pass zero-prefixed zip codes as strings
-
-When using zip codes with zero-prefixes, always quote them. For example when specifying `02125`, pass it as a string `"02125"`, instead of an integer.
-
-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
-
-The Lob.com API supports the following image types:
-
-- PDF
-- PNG
-- JPEG
-
-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).
-
-## 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
+#### Initialization and Configuration
 
 ```ruby
 # To initialize a Lob object
@@ -86,555 +76,84 @@ Lob.configure do |config|
 end
 ```
 
-## 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.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
-
-# 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("/path/to/file.pdf"),
-    setting: 100
-  })
-
-
-# name, to-address and object are the arguments
-# to-address can be specified as an address-id
-@lob.jobs.create(
-  name: "New Cool Posters",
-  from: "from-address-id",
-  to: "to-address-id",
-  objects: "object-id"
-)
-
-# mixing inline objects with ids
-@lob.jobs.create(
-  name: "New Cool Posters",
-  from: {
-    name: "FromAddress",
-    address_line1: "120, 6th Ave",
-    city: "Boston",
-    state: "MA",
-    country: "US",
-    zip: 12345
-  },
-  to: "to-address-id",
-  objects: "object-id"
-)
-
-# You can also pass new object params for the object
-# and other options like setting
-@lob.jobs.create(
-  name: "New Cool Posters",
-  from: "from-address-id",
-  to: "to-address-id",
-  objects: "object-id",
-  {
-    name: "Your fantistic object",
-    file: "http://test.com/file.pdf",
-    setting: "some-setting"
-  }
-)
-
-# Multi Object Jobs (include more than 1 file)
-
-@lob.jobs.create(
-  name: "New Cool Posters",
-  from: "from-address-id",
-  to: {
-    name: "ToAddress",
-    address_line1: "120, 6th Ave",
-    city: "Boston",
-    state: "MA",
-    country: "US",
-    zip: 12345
-  },
-  objects: ["object-id", "another-object-id"]
-)
-
-
-
-```
-
-#### lob.jobs.list
-
-```ruby
-# returns an array of jobs
-@lob.jobs.list
-
-#you can also pass count and offset
-@lob.jobs.list(count: 10, offset: 3)
-```
-
-#### lob.jobs.find
-
-```ruby
-# returns the job with the corresponding ID
-@lob.jobs.find("some-job-id")
-```
-
-### 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")
-```
-
-#### 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 object by passing the name, file url and setting ID, quantity is defaulted to 1
-@lob.objects.create(
-  name: "Your fantastic object",
-  file: "https://s3-us-west-2.amazonaws.com/lob-assets/test.pdf",
-  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 fantastic object",
-  file: File.new("/path/to/file.pdf"),
-  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
-
-```ruby
-# returns an array of objects
-@lob.objects.list
-
-#you can also pass count and offset
-@lob.objects.list(count: 10, offset: 3)
-```
-
-#### lob.objects.find
-
-```ruby
-# returns the object with the corresponding ID
-@lob.objects.find("some-object-id")
-```
-
-#### lob.objects.destroy
-
-```ruby
-# deletes the object with the corresponding ID
-@lob.objects.destroy("some-object-id")
-```
-
-### 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")
-```
-
-### lob.services
-
-#### 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.
-
-```ruby
-
-# create postcard with message
-
-@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://lob.com/postcardfront.pdf",
-  message: "Hey Buddy, Thanks for Visiting",
-  full_bleed: 1
-)
-
-# create postcard with your own back, adhering to lob's template
-@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://lob.com/postcardfront.pdf",
-  back: File.new("/path/to/file.pdf"),
-  full_bleed: 1,
-  template: 1
-)
-
-# create postcard with HTML string & a stored address id
-@lob.postcards.create(
-  name: "John Joe",
-  to: "to-address-id",
-  front:  "<html style='margin: 130px; font-size: 50;'>HTML here</html>",
-  message: "Hey buddy. Waiting to hear your stories."
-)
-```
-
-#### lob.postcards.list
-
-```ruby
-@lob.postcards.list
-
-#you can also pass count and offset
-@lob.postcards.list(count: 10, offset: 3)
-```
-
-#### lob.postcards.find
-
-```ruby
-@lob.postcards.find("post-card-id")
-```
-
-## Simple Check Service
-
-### 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,
-  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,
-  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.
-```
-
-#### 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",
-  signatory: "John Doe",
-  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 remote files & with routes
-@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",
-  routes: ["94158-C001", "94107-C031"],
-  target_type: "all",
-  full_bleed: "1"
-)
-
-# create an area request with HTML & with zip codes
-@lob.areas.create(
-  name: "My Area",
-  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"
-)
-```
-
-zip_codes and routes can be a string or an array of strings
-
-#### lob.areas.list
-```ruby
-@lob.areas.list
-
-# you can also pass count and offset
-@lob.areas.list(count: 10, offset: 3)
-```
-
-#### lob.areas.find
-```ruby
-@lob.areas.find("area_id")
-```
-
-### lob.routes
-
-You'll have to specify zip_codes
-
-#### lob.routes.find
-
-```ruby
-@lob.routes.find(
-  zip_codes: ["95678, 94158"]
-)
-```
-
-zip_codes can be a string or an array of strings
-
-## Resources
-
-### lob.countries
-
-#### lob.countries.list
+#### Caution: Pass zero-prefixed zip codes as strings
 
-```ruby
-# returns a list of countries
-@lob.countries.list
-```
+When using zip codes with zero-prefixes, always quote them. For example when specifying `02125`, pass it as a string `"02125"`, instead of an integer.
 
-### lob.states
+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.
 
-#### lob.states.list
+## Examples
+
+We've provided various examples for you to try out [here](https://github.com/lob/lob-ruby/tree/master/examples).
+
+## API Documentation
+
+- [Introduction](https://lob.com/docs/ruby#introduction)
+- [Versioning](https://lob.com/docs/ruby#version)
+- [Image Prepping](https://lob.com/docs/ruby#prepping)
+- **Addresses**
+  - [Address Book](https://lob.com/docs/ruby#addresses)
+    - [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)
+    - [List all Addresses](https://lob.com/docs/ruby#addresses_list)
+  - [Simple Address Verification](https://lob.com/docs/ruby#verify)
+    - [Verify an Address](https://lob.com/docs/ruby#verify_create)
+- **Simple Postcard Service**
+  - [Postcards](https://lob.com/docs/ruby#postcards)
+    - [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)
+- **Simple Letter Service**
+  - [Letters](https://lob.com/docs/ruby#letters)
+    - [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)
+- **Simple Check Service**
+  - [Checks](https://lob.com/docs/ruby#checks)
+    - [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)
+    - [Create a Bank Account](https://lob.com/docs/ruby#bankaccounts_create)
+    - [Retrieve a Bank Account](https://lob.com/docs/ruby#bankaccounts_retrieve)
+    - [List all Bank Accounts](https://lob.com/docs/ruby#bankaccounts_list)
+    - [Verify a Bank Account](https://lob.com/docs/ruby#bankaccounts_verify)
+    - [Delete a Bank Account](https://lob.com/docs/ruby#bankaccounts_delete)
+- **Simple Print Service**
+  - [Jobs](https://lob.com/docs/ruby#jobs)
+    - [Create a Job](https://lob.com/docs/ruby#jobs_create)
+    - [Retrieve a Job](https://lob.com/docs/ruby#jobs_retrieve)
+    - [List all Jobs](https://lob.com/docs/ruby#jobs_list)
+  - [Objects](https://lob.com/docs/ruby#objects)
+    - [Create an Object](https://lob.com/docs/ruby#objects_create)
+    - [Retrieve an Object](https://lob.com/docs/ruby#objects_retrieve)
+    - [Delete an Object](https://lob.com/docs/ruby#objects_delete)
+    - [List all Objects](https://lob.com/docs/ruby#objects_list)
+  - [Settings](https://lob.com/docs/ruby#settings)
+    - [Retrieve a Setting](https://lob.com/docs/ruby#settings_retrieve)
+    - [List all Settings](https://lob.com/docs/ruby#settings_list)
+- **Simple Area Mail**
+  - [Areas](https://lob.com/docs/ruby#areas)
+    - [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)
+- **Resources**
+  - [Countries](https://lob.com/docs/ruby#countries)
+    - [List all Countries](https://lob.com/docs/ruby#countries_list)
+  - [States](https://lob.com/docs/ruby#states)
+    - [List all States](https://lob.com/docs/ruby#states_list)
+- **Appendix**
+  - [SPS Templates](https://lob.com/docs/ruby#sps-templates)
+  - [Custom Fonts with HTML](https://lob.com/docs/ruby#html-fonts)
+  - [Postcard HTML Examples](https://lob.com/docs/ruby#postcard-examples)
+  - [Area HTML Examples](https://lob.com/docs/ruby#area-examples)
+  - [Letter HTML Examples](https://lob.com/docs/ruby#letter-examples)
 
-```ruby
-# returns a list of states
-@lob.states.list
-```
-
-## Developing
+## Contributing
 
 Make sure you have Ruby 2.0 installed. Copy and paste the following commands in your projects directory.
 
@@ -642,7 +161,15 @@ Make sure you have Ruby 2.0 installed. Copy and paste the following commands in
     cd lob-ruby
     bundle install
 
-You are powered up and ready to roll ~!
+### 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
 
 ## Testing
 
@@ -658,24 +185,11 @@ Here's how you can run the tests:
 
     LOB_API_KEY=your_test_api_key bundle exec rake test
 
-
 When you make changes to failed tests, then clear out the vcr cassettes to re-record the http requests. You can clear out all the cassettes by running `rm -rf spec/vcr_cassettes`.
 
 You can also configure, TravisCI for your fork of the repository and it'll run the tests for you, when you push.
 
-## Contributing
-
-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
-
-## Credits
-
-* [Akash Manohar J](http://github.com/HashNuke)
+=======================
 
 Copyright &copy; 2013 Lob.com