lob 5.1.2 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13cf985be48a2293b60d39581618b3ec1d6dd55627060e4276e0219839707dda
-  data.tar.gz: 0d157d5f90ab10bfae3a58959be1478adcac54606e37dbecaf8c8b8fabf6dacb
+  metadata.gz: 58d9c6ae15fcc102d200e7f5658c0ec7ffabe144a5c1c7a5dad4b3d73c7a446c
+  data.tar.gz: b52642eddc9ccad70128c13d9c4a2686216117592e8aa65132742d42dbc5d782
 SHA512:
-  metadata.gz: 910a721a953d8bf7a714b71e8ab47dfecd7ab294055cd57b1736f2f84aa3d71ed8b54693a9f09112c0b991f6489b23437005dc4ae146a0aff9ecb38cd2121ffc
-  data.tar.gz: 922c3a7b56174b13a390e7294dd3421ec9eb1305eadbdeccddf007e544ac000e8844b82d5183c5f7c9832dd8c8a4b72b735b0b141f831a95ff0280af81b3bffa
+  metadata.gz: 0704b2ada68338190157031692d209082b261a0701208eb9dbdcac0145a4a014d0a86e13e5b6215e2a57f04f4a26dc253b3bd8113fbdea827fb11f48dfe26c57
+  data.tar.gz: 503e570a1803fc459ce45ba4fb7fc7dd99fae7c0a848d8946db9cbabda744cff5d01edbee6eed88ab207130e0689b6288c751c1c9be27204b4c59311408bf45d

data/CHANGELOG.md

@@ -1,9 +1,11 @@
-#### 5.1.2 (2021-02-18)
+## [**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)
+- [**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

@@ -146,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)

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/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

@@ -6,6 +6,7 @@ require "lob/resources/groups_member"
 require "lob/resources/intl_verifications"
 require "lob/resources/letter"
 require "lob/resources/postcard"
+require "lob/resources/self_mailer"
 require "lob/resources/us_autocompletions"
 require "lob/resources/us_verifications"
 require "lob/resources/us_zip_lookups"
@@ -55,6 +56,10 @@ module Lob
       Lob::Resources::Postcard.new(config)
     end
 
+    def self_mailers
+      Lob::Resources::SelfMailer.new(config)
+    end
+
     def us_autocompletions
       Lob::Resources::USAutocompletions.new(config)
     end

data/lib/lob/resources/self_mailer.rb

@@ -0,0 +1,14 @@
+require "lob/resources/resource_base"
+
+module Lob
+  module Resources
+    class SelfMailer < Lob::Resources::ResourceBase
+
+      def initialize(config)
+        super(config)
+        @endpoint = "self_mailers"
+      end
+
+    end
+  end
+end

data/lib/lob/version.rb

@@ -1,3 +1,3 @@
 module Lob
-  VERSION = "5.1.2"
+  VERSION = "5.2.0"
 end

data/spec/lob/resources/self_mailer_spec.rb

@@ -0,0 +1,177 @@
+require "spec_helper"
+
+describe Lob::Resources::SelfMailer do
+
+  before :each do
+    @sample_address_params = {
+      name: "TestAddress",
+      email: "test@test.com",
+      address_line1: "123 Test Street",
+      address_line2: "Unit 199",
+      address_city: "Mountain View",
+      address_state: "CA",
+      address_country: "US",
+      address_zip: 94085
+    }
+
+    @sample_self_mailer_params = {
+      description: "Test Self Mailer",
+      outside: "<h1>Sample Self Mailer Outside</h1>",
+      inside: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/self_mailers/6x18_sfm_inside.pdf",
+    }
+  end
+
+  subject { Lob::Client.new(api_key: API_KEY) }
+
+  describe "list" do
+    it "should list self mailers" do
+      self_mailers = subject.self_mailers.list()
+      assert self_mailers["object"] == "list"
+    end
+  end
+
+
+  describe "create" do
+    it "should create a self mailer with address_id" do
+      new_address = subject.addresses.create @sample_address_params
+
+      result = subject.self_mailers.create(
+        description: @sample_self_mailer_params[:description],
+        to: new_address["id"],
+        outside: @sample_self_mailer_params[:outside],
+        inside: @sample_self_mailer_params[:inside],
+      )
+
+      result["description"].must_equal(@sample_self_mailer_params[:description])
+    end
+
+    it "should create a self mailer with to address params" do
+      result = subject.self_mailers.create(
+        description: @sample_self_mailer_params[:description],
+        to: @sample_address_params,
+        outside: @sample_self_mailer_params[:outside],
+        inside: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/self_mailers/6x18_sfm_inside.pdf"
+      )
+
+      result["description"].must_equal(@sample_self_mailer_params[:description])
+    end
+
+    it "should create a self mailer with from address params" do
+      new_address = subject.addresses.create @sample_address_params
+
+      result = subject.self_mailers.create(
+        description: @sample_self_mailer_params[:description],
+        to: new_address["id"],
+        from: @sample_address_params,
+        outside: @sample_self_mailer_params[:outside],
+        inside: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/self_mailers/6x18_sfm_inside.pdf"
+      )
+
+      result["description"].must_equal(@sample_self_mailer_params[:description])
+    end
+
+    it "should create a self mailer with front and back as urls" do
+      new_address = subject.addresses.create @sample_address_params
+
+      result = subject.self_mailers.create(
+        description: @sample_self_mailer_params[:description],
+        to: new_address["id"],
+        outside: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/self_mailers/6x18_sfm_outside.pdf",
+        inside:  "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/self_mailers/6x18_sfm_inside.pdf"
+      )
+
+      result["description"].must_equal(@sample_self_mailer_params[:description])
+    end
+
+
+    it "should create a self mailer with front and back as PDFs" do
+      new_address = subject.addresses.create @sample_address_params
+
+      result = subject.self_mailers.create(
+        description: @sample_self_mailer_params[:description],
+        to: new_address["id"],
+        outside: File.new(File.expand_path("../../../samples/sfm-6x18-outside.pdf", __FILE__)),
+        inside: File.new(File.expand_path("../../../samples/sfm-6x18-inside.pdf", __FILE__))
+      )
+
+      result["description"].must_equal(@sample_self_mailer_params[:description])
+    end
+
+    it "should create a self mailer with front and back as 12x9 PDFs" do
+      new_address = subject.addresses.create @sample_address_params
+
+      result = subject.self_mailers.create(
+        description: @sample_self_mailer_params[:description],
+        to: new_address["id"],
+        size: "12x9_bifold",
+        outside: File.new(File.expand_path("../../../samples/sfm-12x9-outside.pdf", __FILE__)),
+        inside: File.new(File.expand_path("../../../samples/sfm-12x9-inside.pdf", __FILE__))
+      )
+
+      result["description"].must_equal(@sample_self_mailer_params[:description])
+    end
+
+
+    it "should create a self mailer with a merge variable list" do
+      new_address = subject.addresses.create @sample_address_params
+      merge_variables = {
+        list: [
+          {
+            name: "Larissa"
+          },
+          {
+            name: "Larry"
+          }
+        ]
+      }
+
+      result = subject.self_mailers.create(
+        description: @sample_self_mailer_params[:description],
+        to: new_address["id"],
+        outside: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/self_mailers/6x18_sfm_inside.pdf",
+        inside: "<html>{{#list}} {{name}} {{/list}}</html>",
+        merge_variables: merge_variables
+      )
+
+      result["description"].must_equal(@sample_self_mailer_params[:description])
+      result["merge_variables"]["list"][0]["name"].must_equal("Larissa")
+      result["merge_variables"]["list"][1]["name"].must_equal("Larry")
+    end
+  end
+
+
+  describe "find" do
+    it "should find a self mailer" do
+      new_address = subject.addresses.create @sample_address_params
+
+      new_self_mailer = subject.self_mailers.create(
+        description: @sample_self_mailer_params[:description],
+        to: new_address["id"],
+        outside: @sample_self_mailer_params[:outside],
+        inside: @sample_self_mailer_params[:inside]
+      )
+
+      result  = subject.self_mailers.find(new_self_mailer["id"])
+      result["description"].must_equal(@sample_self_mailer_params[:description])
+    end
+  end
+
+
+  describe "destroy" do
+    it "should destroy a self mailer" do
+      new_address = subject.addresses.create @sample_address_params
+
+      new_self_mailer = subject.self_mailers.create(
+        description: @sample_self_mailer_params[:description],
+        to: new_address["id"],
+        outside: @sample_self_mailer_params[:outside],
+        inside: @sample_self_mailer_params[:inside]
+      )
+
+      result = subject.self_mailers.destroy(new_self_mailer["id"])
+      result["id"].must_equal(new_self_mailer["id"])
+      result["deleted"].must_equal(true)
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lob
 version: !ruby/object:Gem::Version
-  version: 5.1.2
+  version: 5.2.0
 platform: ruby
 authors:
 - Lob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2021-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -130,6 +130,7 @@ files:
 - examples/csv_verify/verify.rb
 - examples/letters.rb
 - examples/postcards.rb
+- examples/self_mailers.rb
 - lib/lob.rb
 - lib/lob/client.rb
 - lib/lob/errors/invalid_request_error.rb
@@ -143,6 +144,7 @@ files:
 - lib/lob/resources/letter.rb
 - lib/lob/resources/postcard.rb
 - lib/lob/resources/resource_base.rb
+- lib/lob/resources/self_mailer.rb
 - lib/lob/resources/us_autocompletions.rb
 - lib/lob/resources/us_verifications.rb
 - lib/lob/resources/us_zip_lookups.rb
@@ -158,6 +160,7 @@ files:
 - spec/lob/resources/member_spec.rb
 - spec/lob/resources/postcard_spec.rb
 - 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_verifications_spec.rb
 - spec/lob/resources/us_zip_lookups_spec.rb
@@ -165,6 +168,10 @@ files:
 - spec/samples/8.5x11.pdf
 - spec/samples/postcardback.pdf
 - spec/samples/postcardfront.pdf
+- spec/samples/sfm-12x9-inside.pdf
+- spec/samples/sfm-12x9-outside.pdf
+- spec/samples/sfm-6x18-inside.pdf
+- spec/samples/sfm-6x18-outside.pdf
 - spec/spec_helper.rb
 homepage: https://github.com/lob/lob-ruby
 licenses:
@@ -200,6 +207,7 @@ test_files:
 - spec/lob/resources/member_spec.rb
 - spec/lob/resources/postcard_spec.rb
 - 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_verifications_spec.rb
 - spec/lob/resources/us_zip_lookups_spec.rb
@@ -207,4 +215,8 @@ test_files:
 - spec/samples/8.5x11.pdf
 - spec/samples/postcardback.pdf
 - spec/samples/postcardfront.pdf
+- spec/samples/sfm-12x9-inside.pdf
+- spec/samples/sfm-12x9-outside.pdf
+- spec/samples/sfm-6x18-inside.pdf
+- spec/samples/sfm-6x18-outside.pdf
 - spec/spec_helper.rb