lob 5.3.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11eb162180fd2d34bf35f62e3b3e0abdb3319c55d126c0cde0b8653952bc3663
-  data.tar.gz: 7631ad45c98fdd77acaef477d2ce59f63adad41c4f765f9f738a42808f7d2ba6
+  metadata.gz: 6d920a5ff8b4358b54f44f6812d0e38f976c1b248c5a7b9154c3d6eff9226869
+  data.tar.gz: b26009d8e3757fbebb1af09028667288481d7acb5afe79b0b7617c096017d7b3
 SHA512:
-  metadata.gz: 1ce91dceebe1903673e9b782c5af29012f06c7b8aea44d399b49d7efd06cc5975b336db6c369cea13cab0c160511606ecd85fefdff52fe5f9761bd04bd8e5730
-  data.tar.gz: 7cc830a0ac6fba54f81352c050b7baa2f732bb50146ac3dcedf5c9fc53b41dd2d1c4b3eed428639f254e25dfd77abd7aca67ae596986a236ff1d153073ad3d67
+  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,3 +1,6 @@
+## [**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)

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)

data/examples/README.md

@@ -1,37 +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>"
+)

data/examples/postcards_remote.rb

@@ -0,0 +1,87 @@
+$:.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: 'https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/4x6_pc_template.pdf',
+  back: 'https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/4x6_pc_template.pdf'
+)

data/examples/postcards_send_date.rb

@@ -0,0 +1,97 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'lob.rb'
+require 'pp'
+require 'date'
+
+# 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
+)
+
+def get_date()
+  time = Time.new
+  if time.month == 12
+    return "#{time.year + 1}-01-#{time.day}"
+  else
+    return "#{time.year}-#{time.month + 1}-#{time.day}"
+  end
+end
+
+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>",
+  send_date: get_date()
+)

data/examples/postcards_template.rb

@@ -0,0 +1,98 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'lob.rb'
+require 'pp'
+
+# initialize Lob object
+# this key is publicly available in the legacy docs, so it's hardcoded
+# since the templates are associated with this dummy account
+# you can replace this key with your own, and the IDs below with any
+# saved templates you have
+lob = Lob::Client.new(api_key: 'test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc')
+
+# 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" },
+    # you can replace these template IDs
+    "front": 'tmpl_b846a20859ae11a',
+    "back": 'tmpl_01b0d396a10c268'
+  }
+)

data/examples/self_mailers.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 a to address
 to_address = lob.addresses.create(
@@ -26,7 +27,7 @@ from_address = lob.addresses.create(
 
 
 # send a self mailer
-puts lob.self_mailers.create(
+pp lob.self_mailers.create(
   description: "Beach Postcard",
   to: to_address["id"],
   from: from_address["id"],

data/lib/lob/client.rb

@@ -10,6 +10,7 @@ require "lob/resources/letter"
 require "lob/resources/postcard"
 require "lob/resources/self_mailer"
 require "lob/resources/us_autocompletions"
+require "lob/resources/us_reverse_geocode_lookups"
 require "lob/resources/us_verifications"
 require "lob/resources/us_zip_lookups"
 
@@ -74,6 +75,10 @@ module Lob
       Lob::Resources::USAutocompletions.new(config)
     end
 
+    def us_reverse_geocode_lookups
+      Lob::Resources::USReverseGeocodeLookups.new(config)
+    end
+
     def us_verifications
       Lob::Resources::USVerifications.new(config)
     end

data/lib/lob/resources/us_reverse_geocode_lookups.rb

@@ -0,0 +1,26 @@
+require "lob/resources/resource_base"
+
+module Lob
+  module Resources
+    class USReverseGeocodeLookups < Lob::Resources::ResourceBase
+
+      undef_method :list, :find, :create, :destroy
+
+      def initialize(config)
+        super(config)
+        @endpoint = "us_reverse_geocode_lookups"
+      end
+
+      def lookup(body={})
+        request = {
+          method: :post,
+          url: endpoint_url,
+          body: body
+        }
+
+        submit request
+      end
+
+    end
+  end
+end

data/lib/lob/version.rb

@@ -1,3 +1,3 @@
 module Lob
-  VERSION = "5.3.0"
+  VERSION = "5.4.0"
 end

data/lob.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "minitest", "~> 5.6.1"
   spec.add_development_dependency "webmock", "~> 1.2"
-  spec.add_development_dependency "coveralls", "~> 0.8.13"
-  spec.add_development_dependency "simplecov", "~> 0.11.0"
+  spec.add_development_dependency "coveralls", "~> 0.8.23"
+  spec.add_development_dependency "simplecov", "~> 0.16.1"
+  spec.add_development_dependency "json", "~> 2.3.1"
+  spec.add_development_dependency "uri", "~> 0.10.1"
 end

data/spec/lob/resources/us_reverse_geocode_lookups_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe Lob::Resources::USReverseGeocodeLookups do
+
+  before :each do
+    @sample_params = {
+      latitude: 37.777456,
+      longitude: -122.393039
+    }
+  end
+
+  subject { Lob::Client.new(api_key: API_KEY) }
+
+  describe "lookup" do
+    it "should reverse geocode a valid US location" do
+      result = subject.us_reverse_geocode_lookups.lookup @sample_params
+      puts result["addresses"][0]["components"]["zip_code"].class
+      result["addresses"].length.must_equal(5)
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lob
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.4.0
 platform: ruby
 authors:
 - Lob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-25 00:00:00.000000000 Z
+date: 2021-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -78,28 +78,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.13
+        version: 0.8.23
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.13
+        version: 0.8.23
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
 description: Lob API Ruby wrapper
 email:
 - support@lob.com
@@ -129,7 +157,13 @@ files:
 - examples/csv_verify/input.csv
 - examples/csv_verify/verify.rb
 - examples/letters.rb
+- examples/list_postcards_metadata.rb
 - examples/postcards.rb
+- examples/postcards_idempotent.rb
+- examples/postcards_intl.rb
+- examples/postcards_remote.rb
+- examples/postcards_send_date.rb
+- examples/postcards_template.rb
 - examples/self_mailers.rb
 - lib/lob.rb
 - lib/lob/client.rb
@@ -148,6 +182,7 @@ files:
 - lib/lob/resources/resource_base.rb
 - lib/lob/resources/self_mailer.rb
 - lib/lob/resources/us_autocompletions.rb
+- lib/lob/resources/us_reverse_geocode_lookups.rb
 - lib/lob/resources/us_verifications.rb
 - lib/lob/resources/us_zip_lookups.rb
 - lib/lob/version.rb
@@ -166,6 +201,7 @@ files:
 - spec/lob/resources/resource_base_spec.rb
 - spec/lob/resources/self_mailer_spec.rb
 - spec/lob/resources/us_autocompletions_spec.rb
+- spec/lob/resources/us_reverse_geocode_lookups_spec.rb
 - spec/lob/resources/us_verifications_spec.rb
 - spec/lob/resources/us_zip_lookups_spec.rb
 - spec/lob_spec.rb
@@ -215,6 +251,7 @@ test_files:
 - spec/lob/resources/resource_base_spec.rb
 - spec/lob/resources/self_mailer_spec.rb
 - spec/lob/resources/us_autocompletions_spec.rb
+- spec/lob/resources/us_reverse_geocode_lookups_spec.rb
 - spec/lob/resources/us_verifications_spec.rb
 - spec/lob/resources/us_zip_lookups_spec.rb
 - spec/lob_spec.rb