lob 5.1.1 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 47d2c198be9a0a184ee2dce528a17019598aa1a8
-  data.tar.gz: 56d0ba7f17dc902a89409c7229c3de2a9f5859b2
+SHA256:
+  metadata.gz: 6d920a5ff8b4358b54f44f6812d0e38f976c1b248c5a7b9154c3d6eff9226869
+  data.tar.gz: b26009d8e3757fbebb1af09028667288481d7acb5afe79b0b7617c096017d7b3
 SHA512:
-  metadata.gz: 4c4acfe6abfa733ed7d417514303433006d3fa9719ca1ff190661e3d9f911e21e044ca536d4da0cb7a5807f629fb34994e31541a6c31bfc3a018b7c748a4bfdd
-  data.tar.gz: a84371070b0a83fbf9101a12803bc9e300c3aca145d7b432c16d63b5dcc1effb6219e8bdca9e21f454c09ad6b1aeb44bd409d4c17a2e83be374e719923478d33
+  metadata.gz: 4f37e760d4b69d4cedcc9226c800807f8a100031a0c27dfc9a3390bf7851fd873f4b597332deec652e4c20ff27cf92d9aa949b7f92c574f6b66cf18373fd92c8
+  data.tar.gz: a4af769be0508a03a1f0b87223f07ebdb468971b2374aaaa8de099342d877950c6a25b9c7f92f845214c6586d0d563f7cec0039dafecce70191f3f0fb1ef740c

data/.travis.yml

@@ -3,10 +3,9 @@ language: ruby
 rvm:
   - jruby-9.1.9.0
   - jruby-9.2.9.0
-  - 2.4
-  - 2.5
   - 2.6
-
+  - 2.7
+  - 3.0
 env:
   JRUBY_OPTS=--2.0
 

data/CHANGELOG.md

@@ -1,4 +1,16 @@
-#### 5.1.1 (2020-05-21)
+## [**5.4.0**](https://github.com/lob/lob-ruby/releases/tag/v5.4.0) (2021-09-21)
+- [**192**](https://github.com/lob/lob-ruby/pull/192) updated to 3.0.0 
+- [**191**](https://github.com/lob/lob-ruby/pull/191) feat(us_verifications): Reverse Geocoding endpoint
+## [**5.3.0**](https://github.com/lob/lob-ruby/releases/tag/v5.3.0) (2021-08-25)
+- [**190**](https://github.com/lob/lob-ruby/pull/190) Adds support for bulk AV endpoints
+## [**5.2.0**](https://github.com/lob/lob-ruby/releases/tag/v5.2.0) (2021-05-03)
+- [**188**](https://github.com/lob/lob-ruby/pull/188) Adds support for Self Mailers
+## 5.1.2 (2021-02-18)
+
+##### Chores and Bug Fixes
+
+- [**185**](https://github.com/lob/lob-ruby/pull/185) Bumps rake to 12.3.3, adds Ruby 2.7, update example asset links, other cleanup.
+## 5.1.1 (2020-05-21)
 
 ##### Chores
 

data/README.md

@@ -11,10 +11,14 @@ Supports Ruby 2.0.0 and greater.
 
 ## Table of Contents
 
+- [Table of Contents](#table-of-contents)
 - [Getting Started](#getting-started)
   - [Registration](#registration)
   - [Installation](#installation)
   - [Usage](#usage)
+    - [Initialization and Configuration](#initialization-and-configuration)
+    - [Caution: Pass zero-prefixed zip codes as strings](#caution-pass-zero-prefixed-zip-codes-as-strings)
+    - [Accessing Response Headers](#accessing-response-headers)
 - [Examples](#examples)
 - [API Documentation](#api-documentation)
 - [Contributing](#contributing)
@@ -130,6 +134,7 @@ There are simple scripts to demonstrate how to create all the core Lob objects (
   - [US Verification API](https://lob.com/docs/ruby#us_verifications)
     - [The US Verification Object](https://lob.com/docs/ruby#us_verifications_object)
     - [Verify a US Address](https://lob.com/docs/ruby#us_verifications_create)
+    - [Bulk Verify US Addresses](https://lob.com/docs/ruby#bulk_us_verifications_create)
     - [The US Zip Lookup Object](https://lob.com/docs/ruby#us_zip_lookups_object)
     - [Lookup a US Zip Code](https://lob.com/docs/ruby#us_zip_lookups_create)
   - [US Autocompletion API](https://lob.com/docs/ruby#us_autocompletions)
@@ -139,6 +144,7 @@ There are simple scripts to demonstrate how to create all the core Lob objects (
 - **Int'l Verification API**
   - [International Verifications](https://lob.com/docs/ruby#intl_verifications)
     - [Verify an International Address](https://lob.com/docs/ruby#intl_verifications_create)
+    - [Bulk Verify International Addresses](https://lob.com/docs/ruby#bulk_intl_verifications_create)
 - **Postcards API**
   - [Postcards](https://lob.com/docs/ruby#postcards)
     - [The Postcard Object](https://lob.com/docs/ruby#postcards_object)
@@ -146,6 +152,13 @@ There are simple scripts to demonstrate how to create all the core Lob objects (
     - [Retrieve a Postcard](https://lob.com/docs/ruby#postcards_retrieve)
     - [Cancel a Postcard](https://lob.com/docs/ruby#postcards_delete)
     - [List all Postcards](https://lob.com/docs/ruby#postcards_list)
+- **Self Mailers API**
+  - [Self Mailers](https://lob.com/docs/ruby#self_mailers)
+    - [The Self Mailer Object](https://lob.com/docs/ruby#self_mailers_object)
+    - [Create a Self Mailer](https://lob.com/docs/ruby#self_mailers_create)
+    - [Retrieve a Self Mailer](https://lob.com/docs/ruby#self_mailers_retrieve)
+    - [Cancel a Self Mailer](https://lob.com/docs/ruby#self_mailers_delete)
+    - [List all Self Mailers](https://lob.com/docs/ruby#self_mailers_list)
 - **Letters API**
   - [Letters](https://lob.com/docs/ruby#letters)
     - [The Letter Object](https://lob.com/docs/ruby#letters_object)

data/examples/README.md

@@ -1,33 +1,111 @@
 # Ruby Examples
 
-Here we have put together a hand full of ruby examples to help get you started. Please read through the official [API Documentation](../README.md#api-documentation) to get a complete sense of what to expect from each endpoint. As always, feel free to [contact us](https://lob.com/support) directly if you have any questions on implementation.
+Here we have put together a handful of ruby examples to help get you started. Please read through the official [API Documentation](https://docs.lob.com) to get a complete sense of what to expect from each endpoint. As always, feel free to [contact us](https://lob.com/support) directly if you have any questions on implementation.
+
+To run these example commands, make sure you have a supported version of Ruby installed, including all the necessary gems.
 
 ## /csv_checks/
 
 An example showing how to dynamically create checks from a CSV using HTML, merge variables, and Lob's [Checks API](https://lob.com/services/checks).
 
+```
+bundle exec ruby examples/csv_checks/create_checks.rb
+```
+
 ## /csv_letters/
 
 An example showing how to dynamically create letters from a CSV using HTML, a custom font, merge variables, and Lob's [Letters API](https://lob.com/services/letters).
 
+```
+bundle exec ruby examples/csv_letters/create_letters.rb
+```
+
 ## /csv_postcards/
 
 An example showing how to dynamically create postcards from a CSV using HTML, a custom font, merge variables, and Lob's [Postcards API](https://lob.com/services/postcards).
 
+```
+bundle exec ruby examples/csv_postcards/create_postcards.rb
+```
+
 ## /csv_verify/
 
 An example showing how to validate and cleanse a CSV spreadsheet full of shipping addresses using Lob's [US Verification API](https://lob.com/services/verifications).
   		  
-Please note that if you are running this with a Test API Key, the verification API will always return [a dummy address](https://lob.com/docs#us_verifications_create).
+Please note that if you are running this with a Test API Key, the verification API will always return [a dummy address](https://docs.lob.com/#section/US-Verifications-Test-Env).
+
+```
+bundle exec ruby examples/csv_verify/verify.rb
+```
 
 ## /checks.rb
 
 An example showing how to create a check using Lob's [Checks API](https://lob.com/services/checks).
 
+```
+bundle exec ruby examples/checks.rb
+```
+
 ## /letters.rb
 
 An example showing how to create a letter using Lob's [Letters API](https://lob.com/services/letters).
 
+```
+bundle exec ruby examples/letters.rb
+```
+
 ## /postcards.rb
 
 An example showing how to create a postcard using Lob's [Postcards API](https://lob.com/services/postcards).
+
+```
+bundle exec ruby examples/postcards.rb
+```
+
+## /postcards_idempotent.rb
+
+An example showing how to create an idempotent postcard request using Lob's [Postcards API](https://lob.com/services/postcards).
+
+```
+bundle exec ruby examples/postcards_idempotent.rb
+```
+
+## /postcards_intl.rb
+
+An example showing how to create an international postcard using Lob's [Postcards API](https://lob.com/services/postcards).
+
+```
+bundle exec ruby examples/postcards_intl.rb
+```
+
+## /postcards_remote.rb
+
+An example showing how to create a postcard with remote files, using Lob's [Postcards API](https://lob.com/services/postcards).
+
+```
+bundle exec ruby examples/postcards_remote.rb
+```
+
+## /postcards_send_date.rb
+
+An example showing how to create a postcard with a specified send date, using Lob's [Postcards API](https://lob.com/services/postcards).
+
+```
+bundle exec ruby examples/postcards_send_date.rb
+```
+
+## /postcards_template.rb
+
+An example showing how to create a postcard with a saved template, using Lob's [Postcards API](https://lob.com/services/postcards).
+
+```
+bundle exec ruby examples/postcards_template.rb
+```
+
+## /self_mailers.rb
+
+An example showing how to create a self mailer using Lob's Self Mailers API.
+
+```
+bundle exec ruby examples/self_mailers.rb
+```

data/examples/checks.rb

@@ -1,8 +1,9 @@
 $:.unshift File.expand_path("../lib", File.dirname(__FILE__))
 require 'lob'
+require 'pp'
 
 # initialize Lob object
-lob = Lob::Client.new(api_key: 'YOUR_API_KEY_HERE')
+lob = Lob::Client.new(api_key: 'YOUR_API_KEY')
 
 # create an address
 to_address = lob.addresses.create(
@@ -32,11 +33,11 @@ bank_account = lob.bank_accounts.create(
   signatory: "John Doe"
 )
 
-puts bank_account
+pp bank_account
 lob.bank_accounts.verify(bank_account['id'], amounts: [23, 12])
 
 # send a $100 check using an already created bank and address
-puts lob.checks.create(
+pp lob.checks.create(
   description: "Test Check",
   check_number: "10000",
   bank_account: bank_account["id"],

data/examples/csv_checks/create_checks.rb

@@ -1,9 +1,10 @@
 $:.unshift File.expand_path("../../lib", File.dirname(__FILE__))
 require 'lob'
 require 'csv'
+require 'pp'
 
 # Initialize Lob object
-lob = Lob::Client.new(api_key: 'YOUR_API_KEY_HERE')
+lob = Lob::Client.new(api_key: 'YOUR_API_KEY')
 
 # Create a bank account
 bank_account = lob.bank_accounts.create(
@@ -43,5 +44,5 @@ CSV.foreach(File.expand_path('../input.csv', __FILE__)) do |row|
     amount: row[7],
     memo: "For travel reimbursement"
   )
-  puts check['url']
+  pp check['url']
 end

data/examples/csv_letters/create_letters.rb

@@ -1,9 +1,10 @@
 $:.unshift File.expand_path("../../lib", File.dirname(__FILE__))
 require 'lob'
 require 'csv'
+require 'pp'
 
 # Initialize Lob object
-lob = Lob::Client.new(api_key: 'YOUR_API_KEY_HERE')
+lob = Lob::Client.new(api_key: 'YOUR_API_KEY')
 
 # Load the HTML from letter_template.html
 letter_html = File.open(File.expand_path('../letter_template.html', __FILE__)).read
@@ -36,5 +37,5 @@ CSV.foreach(File.expand_path('../input.csv', __FILE__)) do |row|
     },
     color: false
   )
-  puts letter['url']
+  pp letter['url']
 end

data/examples/csv_postcards/create_postcards.rb

@@ -1,9 +1,10 @@
 $:.unshift File.expand_path("../../lib", File.dirname(__FILE__))
 require 'lob'
 require 'csv'
+require 'pp'
 
 # Initialize Lob object
-lob = Lob::Client.new(api_key: 'YOUR_API_KEY_HERE')
+lob = Lob::Client.new(api_key: 'YOUR_API_KEY')
 
 # Load the HTML from postcard_front.html and postcard_back.html.
 front_html = File.open(File.expand_path('../postcard_front.html', __FILE__)).read
@@ -41,5 +42,5 @@ CSV.foreach(File.expand_path('../input.csv', __FILE__)) do |row|
       mileage: row[4]
     }
   )
-  puts postcard['url']
+  pp postcard['url']
 end

data/examples/csv_verify/verify.rb

@@ -2,9 +2,10 @@ $:.unshift File.expand_path("../../lib", File.dirname(__FILE__))
 
 require 'csv'
 require 'lob'
+require 'pp'
 
 # Initialize Lob object
-lob = Lob::Client.new(api_key: 'YOUR_API_KEY_HERE')
+lob = Lob::Client.new(api_key: 'live_ef27c53a56d2b1a4f6cff194f98eae91175')
 
 output = File.open(File.expand_path('../output.csv', __FILE__), 'w')
 
@@ -22,7 +23,7 @@ File.open(File.expand_path('../input.csv', __FILE__)).each_line do |line|
     state: address_components[4],
     zip_code: address_components[5]
   )
-
+  
   output.puts [
     verified_address['primary_line'],
     verified_address['secondary_line'],

data/examples/letters.rb

@@ -1,8 +1,9 @@
 $:.unshift File.expand_path("../lib", File.dirname(__FILE__))
 require 'lob'
+require 'pp'
 
 # initialize Lob object
-lob = Lob::Client.new(api_key: 'YOUR_API_KEY_HERE')
+lob = Lob::Client.new(api_key: 'YOUR_API_KEY')
 
 html = %{
 <html>
@@ -61,7 +62,7 @@ from_address = lob.addresses.create(
 )
 
 # send the letter
-puts lob.letters.create(
+pp lob.letters.create(
   description: "Test letter",
   to: to_address["id"],
   from: from_address["id"],

data/examples/list_postcards_metadata.rb

@@ -0,0 +1,94 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'lob.rb'
+require 'pp'
+
+# initialize Lob object
+lob = Lob::Client.new(api_key: 'YOUR_API_KEY')
+
+# HTML to send to the server
+html = %{
+<html>
+<head>
+<title>Lob.com Sample 4x6 Postcard Front</title>
+<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/public.lob.com/fonts/lovedByTheKing/LovedbytheKing.ttf') format('truetype');
+  }
+
+  body {
+    width: 6.25in;
+    height: 4.25in;
+    margin: 0;
+    padding: 0;
+    /* If using an image, the background image should have dimensions of 1875x1275 pixels. */
+    background-image: url('https://s3-us-west-2.amazonaws.com/public.lob.com/assets/beach.jpg');
+    background-size: 6.25in 4.25in;
+    background-repeat: no-repeat;
+  }
+
+  .text {
+    margin: 50px;
+    width: 400px;
+    font-family: 'Loved by the King';
+    font-size: 50px;
+    font-weight: 700;
+    color: white;
+    text-shadow: 3px 3px black;
+  }
+</style>
+</head>
+
+<body>
+  <h1 class="text">Hello {{name}}!</h1>
+  <p class="text">Join us for the {{event}}!</p>
+</body>
+
+</html>
+}
+
+# create a to address
+to_address = lob.addresses.create(
+  name: "ToAddress",
+  address_line1: "120 6th Ave",
+  address_city: "Boston",
+  address_state: "MA",
+  address_country: "US",
+  address_zip: 12345
+)
+
+# create a from address
+from_address = lob.addresses.create(
+  name: "FromAddress",
+  address_line1: "120 6th Ave",
+  address_city: "Boston",
+  address_state: "MA",
+  address_country: "US",
+  address_zip: 12345
+)
+
+# send a postcard
+pp lob.postcards.create(
+  description: "Beach Postcard",
+  to: to_address["id"],
+  from: from_address["id"],
+  metadata: { campaign: "Summer 2015 Beach" },
+  merge_variables: { name: "Albert", event: "Summer 2015 Beach-athon" },
+  front: html,
+  back: "<h1>Please RSVP as soon as possible to reserve your lounge chair.</h1>"
+)
+
+pp lob.postcards.list(
+    metadata: {
+      campaign: 'Summer 2015 Beach'
+    },
+    limit: 1
+)

data/examples/postcards.rb

@@ -1,8 +1,9 @@
 $:.unshift File.expand_path("../lib", File.dirname(__FILE__))
-require 'lob'
+require 'lob.rb'
+require 'pp'
 
 # initialize Lob object
-lob = Lob::Client.new(api_key: 'YOUR_API_KEY_HERE')
+lob = Lob::Client.new(api_key: 'YOUR_API_KEY')
 
 # HTML to send to the server
 html = %{
@@ -29,7 +30,7 @@ html = %{
     margin: 0;
     padding: 0;
     /* If using an image, the background image should have dimensions of 1875x1275 pixels. */
-    background-image: url(https://s3-us-west-2.amazonaws.com/public.lob.com/assets/beach.jpg);
+    background-image: url('https://s3-us-west-2.amazonaws.com/public.lob.com/assets/beach.jpg');
     background-size: 6.25in 4.25in;
     background-repeat: no-repeat;
   }
@@ -75,7 +76,7 @@ from_address = lob.addresses.create(
 )
 
 # send a postcard
-puts lob.postcards.create(
+pp lob.postcards.create(
   description: "Beach Postcard",
   to: to_address["id"],
   from: from_address["id"],

data/examples/postcards_idempotent.rb

@@ -0,0 +1,92 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'lob.rb'
+require 'pp'
+
+# initialize Lob object
+lob = Lob::Client.new(api_key: 'YOUR_API_KEY')
+
+# HTML to send to the server
+html = %{
+<html>
+<head>
+<title>Lob.com Sample 4x6 Postcard Front</title>
+<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/public.lob.com/fonts/lovedByTheKing/LovedbytheKing.ttf') format('truetype');
+  }
+
+  body {
+    width: 6.25in;
+    height: 4.25in;
+    margin: 0;
+    padding: 0;
+    /* If using an image, the background image should have dimensions of 1875x1275 pixels. */
+    background-image: url('https://s3-us-west-2.amazonaws.com/public.lob.com/assets/beach.jpg');
+    background-size: 6.25in 4.25in;
+    background-repeat: no-repeat;
+  }
+
+  .text {
+    margin: 50px;
+    width: 400px;
+    font-family: 'Loved by the King';
+    font-size: 50px;
+    font-weight: 700;
+    color: white;
+    text-shadow: 3px 3px black;
+  }
+</style>
+</head>
+
+<body>
+  <h1 class="text">Hello {{name}}!</h1>
+  <p class="text">Join us for the {{event}}!</p>
+</body>
+
+</html>
+}
+
+# create a to address
+to_address = lob.addresses.create(
+  name: "ToAddress",
+  address_line1: "120 6th Ave",
+  address_city: "Boston",
+  address_state: "MA",
+  address_country: "US",
+  address_zip: 12345
+)
+
+# create a from address
+from_address = lob.addresses.create(
+  name: "FromAddress",
+  address_line1: "120 6th Ave",
+  address_city: "Boston",
+  address_state: "MA",
+  address_country: "US",
+  address_zip: 12345
+)
+
+# send a postcard
+pp lob.postcards.create(
+  {
+    description: "Beach Postcard",
+    to: to_address["id"],
+    from: from_address["id"],
+    metadata: { campaign: "Summer 2015 Beach" },
+    merge_variables: { name: "Albert", event: "Summer 2015 Beach-athon" },
+    front: html,
+    back: "<h1>Please RSVP as soon as possible to reserve your lounge chair.</h1>"
+  },
+  {
+    'Idempotency-Key': '026e7634-24d7-486c-a0bb-4a17fd0eebc5'
+  }
+)

data/examples/postcards_intl.rb

@@ -0,0 +1,87 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'lob'
+require 'pp'
+
+# initialize Lob object
+lob = Lob::Client.new(api_key: 'YOUR_API_KEY')
+
+# HTML to send to the server
+html = %{
+<html>
+<head>
+<title>Lob.com Sample 4x6 Postcard Front</title>
+<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/public.lob.com/fonts/lovedByTheKing/LovedbytheKing.ttf') format('truetype');
+  }
+
+  body {
+    width: 6.25in;
+    height: 4.25in;
+    margin: 0;
+    padding: 0;
+    /* If using an image, the background image should have dimensions of 1875x1275 pixels. */
+    background-image: url('https://s3-us-west-2.amazonaws.com/public.lob.com/assets/beach.jpg');
+    background-size: 6.25in 4.25in;
+    background-repeat: no-repeat;
+  }
+
+  .text {
+    margin: 50px;
+    width: 400px;
+    font-family: 'Loved by the King';
+    font-size: 50px;
+    font-weight: 700;
+    color: white;
+    text-shadow: 3px 3px black;
+  }
+</style>
+</head>
+
+<body>
+  <h1 class="text">Hello {{name}}!</h1>
+  <p class="text">Join us for the {{event}}!</p>
+</body>
+
+</html>
+}
+
+# create a to address
+to_address = lob.addresses.create(
+  name: "ToAddress",
+  address_line1: "370 Water St",
+  address_city: "Summerside",
+  address_state: "Prince Edward Island",
+  address_country: "CA",
+  address_zip: "C1N 1C4"
+)
+
+# create a from address
+from_address = lob.addresses.create(
+  name: "FromAddress",
+  address_line1: "120 6th Ave",
+  address_city: "Boston",
+  address_state: "MA",
+  address_country: "US",
+  address_zip: 12345
+)
+
+# send a postcard
+pp lob.postcards.create(
+  description: "Beach Postcard",
+  to: to_address["id"],
+  from: from_address["id"],
+  metadata: { campaign: "Summer 2015 Beach" },
+  merge_variables: { name: "Albert", event: "Summer 2015 Beach-athon" },
+  front: html,
+  back: "<h1>Please RSVP as soon as possible to reserve your lounge chair.</h1>"
+)