lob 4.3.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8225f20dd05a0f5b903f986a88f5e93254dec38e28361076a9724cfef0c50661
-  data.tar.gz: d0e4ccd13e9bd6f5b9b4010f48a7b6e9f2926c57de5a6a914d4f6153ecfd43a0
+  metadata.gz: 58d9c6ae15fcc102d200e7f5658c0ec7ffabe144a5c1c7a5dad4b3d73c7a446c
+  data.tar.gz: b52642eddc9ccad70128c13d9c4a2686216117592e8aa65132742d42dbc5d782
 SHA512:
-  metadata.gz: 7f21d43ad6e066f4c94d00365d92bc155947bd4c56c2b0794aebfcecd75cd9f5189dab7583a39585eedc8060a788d0fa20ee6111097291ddefb06ef7f38ae37e
-  data.tar.gz: c8df84c18215df4af65573cd1109b80d6bb053160a5958a867cfc5ab0bfcf3b09f9bb568c2235e4830a1c270f69512ae9727ea2704312316043e1d6073fdf581
+  metadata.gz: 0704b2ada68338190157031692d209082b261a0701208eb9dbdcac0145a4a014d0a86e13e5b6215e2a57f04f4a26dc253b3bd8113fbdea827fb11f48dfe26c57
+  data.tar.gz: 503e570a1803fc459ce45ba4fb7fc7dd99fae7c0a848d8946db9cbabda744cff5d01edbee6eed88ab207130e0689b6288c751c1c9be27204b4c59311408bf45d

data/.travis.yml

@@ -1,19 +1,13 @@
 language: ruby
 
-sudo: false
-
 rvm:
-  - jruby-9.0.5.0
   - jruby-9.1.9.0
-  - 2.1
-  - 2.2
-  - 2.3
+  - jruby-9.2.9.0
   - 2.4
-
+  - 2.5
+  - 2.6
+  - 2.7
 env:
   JRUBY_OPTS=--2.0
 
-before_install:
-    - gem install bundler
-
 script: bundle exec rake test

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+## [**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
+
+* **intl-verification:**  update international verifications test mode fix ([#179](https://github.com/lob/lob-ruby/pull/179)) ([4ab7e7e2](https://github.com/lob/lob-ruby/commit/4ab7e7e2852706c37b00bd8f2df58207897bc0a3))
+
+##### Bug Fixes
+
+* **merge-variables:**  convert to json ([fa93885f](https://github.com/lob/lob-ruby/commit/fa93885f2aab4537e100b82d8a9f53cdec042f2e))
+
+## [**5.1.0**](https://github.com/lob/lob-ruby/releases/tag/v5.1.0)
+- [**176**](https://github.com/lob/lob-ruby/pull/176) Adds support for Group Members (beta feature)
+- [**175**](https://github.com/lob/lob-ruby/pull/175) Adds support for Groups (beta feature)
+- [**174**](https://github.com/lob/lob-ruby/pull/174) Add Ruby 2.5-6, remove API keys, other cleanup
+- [**173**](https://github.com/lob/lob-ruby/pull/173) Update example asset links
+
+## 5.0.0
+
+Version 5.0.0 introduces a breaking change. It removes support for the area mail resources (`Areas` and `Routes`).
+
+* Removes `Lob.areas`.
+* Removes `Lob.routes`.
+
 ## [**4.3.0**](https://github.com/lob/lob-ruby/releases/tag/v4.3.0)
 - [**171**](https://github.com/lob/lob-ruby/pull/171) add USAutocompletions
 - [**170**](https://github.com/lob/lob-ruby/pull/170) Fix test name

data/README.md

@@ -1,12 +1,11 @@
 # 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)
+[![Gem Version](https://badge.fury.io/rb/lob.svg)](https://badge.fury.io/rb/lob)
 [![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)
+[![Downloads](https://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. See the full Lob.com [API Documentation](https://lob.com/docs/ruby).  For best results, be sure that you're using [the latest version](https://lob.com/docs/ruby#version) of the Lob API and the latest version of the ruby wrapper. This gem gives you an ActiveRecord-style syntax to use the Lob.com API.
+Ruby wrapper for the [Lob.com](https://lob.com) API. See the full Lob.com [API Documentation](https://lob.com/docs/ruby).  For best results, be sure that you're using [the latest version](https://lob.com/docs/ruby#version) of the Lob API and the latest version of the ruby wrapper. This gem gives you an ActiveRecord-style syntax to use the Lob.com API.
 
 Supports Ruby 2.0.0 and greater.
 
@@ -25,11 +24,10 @@ Supports Ruby 2.0.0 and greater.
 
 Here's a general overview of the Lob services available, click through to read more.
 
-- [Postcards API](https://lob.com/services/postcards)
-- [Letters API](https://lob.com/services/letters)
-- [Checks API](https://lob.com/services/checks)
-- [Area Mail API](https://lob.com/services/area)
-- [Address Verification API](https://lob.com/services/verifications)
+- [Postcards API](https://lob.com/products/print-mail/postcards)
+- [Letters API](https://lob.com/products/print-mail/letters)
+- [Checks API](https://lob.com/products/print-mail/checks)
+- [Address Verification API](https://lob.com/products/address-verification)
 
 Please read through the official [API Documentation](#api-documentation) to get a complete sense of what to expect from each endpoint.
 
@@ -96,7 +94,7 @@ You can also access headers from `Lob::InvalidRequestError`s.
 
 ```ruby
 begin
-  lob.objects.create(name: "Test", file: "https://lob.com/test.pdf", bad_param: "bad_value")
+  lob.objects.create(name: "Test", file: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/incorrect_size.pdf", bad_param: "bad_value")
 rescue Lob::InvalidRequestError => e
   e._response.headers[:content_type]
   # => "application/json; charset=utf-8"
@@ -148,6 +146,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)
@@ -169,16 +174,6 @@ There are simple scripts to demonstrate how to create all the core Lob objects (
     - [Delete a Bank Account](https://lob.com/docs/ruby#bankaccounts_delete)
     - [Verify a Bank Account](https://lob.com/docs/ruby#bankaccounts_verify)
     - [List all Bank Accounts](https://lob.com/docs/ruby#bankaccounts_list)
-- **Area Mail API**
-  - [Areas](https://lob.com/docs/ruby#areas)
-    - [The Area Object](https://lob.com/docs/ruby#areas_object)
-    - [Create an Area Mailing](https://lob.com/docs/ruby#areas_create)
-    - [Retrieve an Area Mailing](https://lob.com/docs/ruby#areas_retrieve)
-    - [List all Area Mailings](https://lob.com/docs/ruby#areas_list)
-  - [Routes](https://lob.com/docs/ruby#routes)
-    - [The Routes Object](https://lob.com/docs/ruby#routes_object)
-    - [Retrieve Routes](https://lob.com/docs/ruby#routes_retrieve)
-    - [List all Routes](https://lob.com/docs/ruby#routes_list)
 - **Appendix**
   - [API Changelog](https://lob.com/docs/ruby#changelog)
   - [The Tracking Event Object](https://lob.com/docs/ruby#tracking_event_object)

data/examples/README.md

@@ -31,3 +31,7 @@ An example showing how to create a letter using Lob's [Letters API](https://lob.
 ## /postcards.rb
 
 An example showing how to create a postcard using Lob's [Postcards API](https://lob.com/services/postcards).
+
+## /self_mailers.rb
+
+An example showing how to create a self mailer using Lob's Self Mailers API.

data/examples/checks.rb

@@ -2,7 +2,7 @@ $:.unshift File.expand_path("../lib", File.dirname(__FILE__))
 require 'lob'
 
 # initialize Lob object
-lob = Lob::Client.new(api_key: 'test_799ff27291c166d10ba191902ad02fb059c')
+lob = Lob::Client.new(api_key: 'YOUR_API_KEY_HERE')
 
 # create an address
 to_address = lob.addresses.create(

data/examples/csv_checks/create_checks.rb

@@ -3,7 +3,7 @@ require 'lob'
 require 'csv'
 
 # Initialize Lob object
-lob = Lob::Client.new(api_key: 'test_799ff27291c166d10ba191902ad02fb059c')
+lob = Lob::Client.new(api_key: 'YOUR_API_KEY_HERE')
 
 # Create a bank account
 bank_account = lob.bank_accounts.create(

data/examples/csv_letters/create_letters.rb

@@ -3,7 +3,7 @@ require 'lob'
 require 'csv'
 
 # Initialize Lob object
-lob = Lob::Client.new(api_key: 'test_799ff27291c166d10ba191902ad02fb059c')
+lob = Lob::Client.new(api_key: 'YOUR_API_KEY_HERE')
 
 # Load the HTML from letter_template.html
 letter_html = File.open(File.expand_path('../letter_template.html', __FILE__)).read

data/examples/csv_letters/letter_template.html

@@ -11,7 +11,7 @@
     font-family: 'Loved by the King';
     font-style: normal;
     font-weight: 400;
-    src: url('https://s3-us-west-2.amazonaws.com/lob-assets/LovedbytheKing.ttf') format('truetype');
+    src: url('https://s3-us-west-2.amazonaws.com/public.lob.com/fonts/lovedByTheKing/LovedbytheKing.ttf') format('truetype');
   }
 
   .text {

data/examples/csv_postcards/create_postcards.rb

@@ -3,7 +3,7 @@ require 'lob'
 require 'csv'
 
 # Initialize Lob object
-lob = Lob::Client.new(api_key: 'test_799ff27291c166d10ba191902ad02fb059c')
+lob = Lob::Client.new(api_key: 'YOUR_API_KEY_HERE')
 
 # Load the HTML from postcard_front.html and postcard_back.html.
 front_html = File.open(File.expand_path('../postcard_front.html', __FILE__)).read

data/examples/csv_postcards/input.csv

@@ -1,7 +1,7 @@
-Peter,https://s3-us-west-2.amazonaws.com/lob-assets/df-car2.jpg,LightBlue,Jeep Wrangler,65000,Peter,123 Main Street,Apt. 101,San Francisco,CA,94107,US
-Marcus,https://s3-us-west-2.amazonaws.com/lob-assets/df-car.jpg,Bisque,Honda Pilot,65000,Marcus,456 Oak Street ,Apt. 102,San Francisco,CA,94185,US
-Leore,https://s3-us-west-2.amazonaws.com/lob-assets/df-car2.jpg,PaleGreen,Jeep Wrangler,50000,Leore,123 Test Street,Apt. 101,San Francisco,CA,94105,US
-Harry,https://s3-us-west-2.amazonaws.com/lob-assets/df-car.jpg,Thistle,Jeep Wrangler,50000,Harry,789 Elm Street,Apt. 101,San Francisco,CA,94107,US
-Elnaz,https://s3-us-west-2.amazonaws.com/lob-assets/df-car2.jpg,PaleTurqoise,Jeep Wrangler,35000,Elnaz,111 Washington Street,Apt. 101,San Francisco,CA,94112,US
-Robin,https://s3-us-west-2.amazonaws.com/lob-assets/df-car.jpg,Wheat,Jeep Wrangler,35000,Robin,888 Jefferson Street,Apt. 101,San Francisco,CA,94197,US
-Russell,https://s3-us-west-2.amazonaws.com/lob-assets/df-car2.jpg,WhiteSmoke,Jeep Wrangler,15000,Russell,1212 Fourth Street,Apt. 101,San Francisco,CA,94166,US
+Peter,https://s3-us-west-2.amazonaws.com/public.lob.com/assets/example_companies/df-car2.jpg,LightBlue,Jeep Wrangler,65000,Peter,123 Main Street,Apt. 101,San Francisco,CA,94107,US
+Marcus,https://s3-us-west-2.amazonaws.com/public.lob.com/assets/example_companies/df-car.jpg,Bisque,Honda Pilot,65000,Marcus,456 Oak Street ,Apt. 102,San Francisco,CA,94185,US
+Leore,https://s3-us-west-2.amazonaws.com/public.lob.com/assets/example_companies/df-car2.jpg,PaleGreen,Jeep Wrangler,50000,Leore,123 Test Street,Apt. 101,San Francisco,CA,94105,US
+Harry,https://s3-us-west-2.amazonaws.com/public.lob.com/assets/example_companies/df-car.jpg,Thistle,Jeep Wrangler,50000,Harry,789 Elm Street,Apt. 101,San Francisco,CA,94107,US
+Elnaz,https://s3-us-west-2.amazonaws.com/public.lob.com/assets/example_companies/df-car2.jpg,PaleTurqoise,Jeep Wrangler,35000,Elnaz,111 Washington Street,Apt. 101,San Francisco,CA,94112,US
+Robin,https://s3-us-west-2.amazonaws.com/public.lob.com/assets/example_companies/df-car.jpg,Wheat,Jeep Wrangler,35000,Robin,888 Jefferson Street,Apt. 101,San Francisco,CA,94197,US
+Russell,https://s3-us-west-2.amazonaws.com/public.lob.com/assets/example_companies/df-car2.jpg,WhiteSmoke,Jeep Wrangler,15000,Russell,1212 Fourth Street,Apt. 101,San Francisco,CA,94166,US

data/examples/csv_postcards/postcard_back.html

@@ -6,7 +6,7 @@
     font-family: 'Arimo';
     font-style: normal;
     font-weight: 400;
-    src: url('https://s3-us-west-2.amazonaws.com/lob-assets/Arimo-Regular.ttf') format('truetype');
+    src: url('https://s3-us-west-2.amazonaws.com/public.lob.com/fonts/arimo/Arimo-Regular.ttf') format('truetype');
   }
   body {
     width:11.25in;

data/examples/csv_verify/verify.rb

@@ -4,7 +4,7 @@ require 'csv'
 require 'lob'
 
 # Initialize Lob object
-lob = Lob::Client.new(api_key: 'test_799ff27291c166d10ba191902ad02fb059c')
+lob = Lob::Client.new(api_key: 'YOUR_API_KEY_HERE')
 
 output = File.open(File.expand_path('../output.csv', __FILE__), 'w')
 

data/examples/letters.rb

@@ -2,7 +2,7 @@ $:.unshift File.expand_path("../lib", File.dirname(__FILE__))
 require 'lob'
 
 # initialize Lob object
-lob = Lob::Client.new(api_key: 'test_799ff27291c166d10ba191902ad02fb059c')
+lob = Lob::Client.new(api_key: 'YOUR_API_KEY_HERE')
 
 html = %{
 <html>
@@ -18,7 +18,7 @@ html = %{
     font-family: 'Loved by the King';
     font-style: normal;
     font-weight: 400;
-    src: url('https://s3-us-west-2.amazonaws.com/lob-assets/LovedbytheKing.ttf') format('truetype');
+    src: url('https://s3-us-west-2.amazonaws.com/public.lob.com/fonts/lovedByTheKing/LovedbytheKing.ttf') format('truetype');
   }
 
   .text {

data/examples/postcards.rb

@@ -2,7 +2,7 @@ $:.unshift File.expand_path("../lib", File.dirname(__FILE__))
 require 'lob'
 
 # initialize Lob object
-lob = Lob::Client.new(api_key: 'test_799ff27291c166d10ba191902ad02fb059c')
+lob = Lob::Client.new(api_key: 'YOUR_API_KEY_HERE')
 
 # HTML to send to the server
 html = %{
@@ -20,7 +20,7 @@ html = %{
     font-family: 'Loved by the King';
     font-style: normal;
     font-weight: 400;
-    src: url('https://s3-us-west-2.amazonaws.com/lob-assets/LovedbytheKing.ttf') format('truetype');
+    src: url('https://s3-us-west-2.amazonaws.com/public.lob.com/fonts/lovedByTheKing/LovedbytheKing.ttf') format('truetype');
   }
 
   body {
@@ -29,7 +29,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/lob-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;
   }

data/examples/self_mailers.rb

@@ -0,0 +1,37 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'lob'
+
+# initialize Lob object
+lob = Lob::Client.new(api_key: 'YOUR_API_KEY_HERE')
+
+# 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 self mailer
+puts lob.self_mailers.create(
+  description: "Beach Postcard",
+  to: to_address["id"],
+  from: from_address["id"],
+  metadata: { campaign: "Summer 2021 Beach" },
+  merge_variables: { name: "Albert" },
+  outside: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/self_mailers/6x18_sfm_outside.pdf",
+  inside: "<h1>Hi {{name}}, please RSVP as soon as possible to reserve your lounge chair.</h1>"
+)

data/lib/lob/client.rb

@@ -1,11 +1,12 @@
 require "lob/resources/address"
-require "lob/resources/area"
 require "lob/resources/bank_account"
 require "lob/resources/check"
+require "lob/resources/group"
+require "lob/resources/groups_member"
 require "lob/resources/intl_verifications"
 require "lob/resources/letter"
 require "lob/resources/postcard"
-require "lob/resources/route"
+require "lob/resources/self_mailer"
 require "lob/resources/us_autocompletions"
 require "lob/resources/us_verifications"
 require "lob/resources/us_zip_lookups"
@@ -23,10 +24,6 @@ module Lob
       @config = config
     end
 
-    def areas
-      Lob::Resources::Area.new(config)
-    end
-
     def addresses
       Lob::Resources::Address.new(config)
     end
@@ -38,6 +35,14 @@ module Lob
     def checks
       Lob::Resources::Check.new(config)
     end
+    
+    def groups
+      Lob::Resources::Group.new(config)
+    end
+    
+    def groups_members
+      Lob::Resources::GroupsMember.new(config)
+    end
 
     def intl_verifications
       Lob::Resources::IntlVerifications.new(config)
@@ -51,8 +56,8 @@ module Lob
       Lob::Resources::Postcard.new(config)
     end
 
-    def routes
-      Lob::Resources::Route.new(config)
+    def self_mailers
+      Lob::Resources::SelfMailer.new(config)
     end
 
     def us_autocompletions

data/lib/lob/resources/{area.rb → group.rb}

@@ -2,13 +2,11 @@ require "lob/resources/resource_base"
 
 module Lob
   module Resources
-    class Area < Lob::Resources::ResourceBase
-
-      undef_method :destroy
+    class Group < Lob::Resources::ResourceBase
 
       def initialize(config)
         super(config)
-        @endpoint = "areas"
+        @endpoint = "groups"
       end
 
     end

data/lib/lob/resources/groups_member.rb

@@ -0,0 +1,66 @@
+require "rest-client"
+require "json"
+require "uri"
+
+module Lob
+  module Resources
+    class GroupsMember < Lob::Resources::ResourceBase
+
+      attr_reader :config, :endpoint
+
+      def initialize(config)
+        super(config)
+        @endpoint = "members"
+      end
+
+      def list(group_id, query={})
+        request = {
+          method: :get,
+          url: endpoint_url(group_id),
+          query: query
+        }
+
+        submit request
+      end
+
+      def find(group_id, resource_id)
+        request = {
+          method: :get,
+          url: resource_url(group_id, resource_id)
+        }
+
+        submit request
+      end
+
+      def create(group_id, body={}, headers={}, query={})
+        request = {
+          method: :post,
+          url: endpoint_url(group_id),
+          body: body,
+          headers: headers,
+          query: query
+        }
+
+        submit request
+      end
+
+      def destroy(group_id, resource_id)
+        request = {
+          method: :delete,
+          url: resource_url(group_id, resource_id)
+        }
+
+        submit request
+      end
+
+      def endpoint_url(group_id)
+        "#{base_url}/groups/#{group_id}/#{endpoint}"
+      end
+
+      def resource_url(group_id, resource_id)
+        "#{endpoint_url(group_id)}/#{resource_id}"
+      end
+
+    end
+  end
+end