RubyGems - lob - Versions diffs - 4.3.0 → 5.2.0 - Mend

lob 4.3.0 → 5.2.0

Files changed (40) hide show

checksums.yaml +4 -4
data/.travis.yml +4 -10
data/CHANGELOG.md +30 -0
data/README.md +15 -20
data/examples/README.md +4 -0
data/examples/checks.rb +1 -1
data/examples/csv_checks/create_checks.rb +1 -1
data/examples/csv_letters/create_letters.rb +1 -1
data/examples/csv_letters/letter_template.html +1 -1
data/examples/csv_postcards/create_postcards.rb +1 -1
data/examples/csv_postcards/input.csv +7 -7
data/examples/csv_postcards/postcard_back.html +1 -1
data/examples/csv_verify/verify.rb +1 -1
data/examples/letters.rb +2 -2
data/examples/postcards.rb +3 -3
data/examples/self_mailers.rb +37 -0
data/lib/lob/client.rb +13 -8
data/lib/lob/resources/{area.rb → group.rb} +2 -4
data/lib/lob/resources/groups_member.rb +66 -0
data/lib/lob/resources/resource_base.rb +8 -5
data/lib/lob/resources/self_mailer.rb +14 -0
data/lib/lob/version.rb +1 -1
data/lob.gemspec +4 -7
data/spec/lob/resources/check_spec.rb +21 -0
data/spec/lob/resources/group_spec.rb +50 -0
data/spec/lob/resources/intl_verifications_spec.rb +4 -7
data/spec/lob/resources/letter_spec.rb +24 -4
data/spec/lob/resources/member_spec.rb +65 -0
data/spec/lob/resources/postcard_spec.rb +30 -5
data/spec/lob/resources/resource_base_spec.rb +4 -16
data/spec/lob/resources/self_mailer_spec.rb +177 -0
data/spec/samples/sfm-12x9-inside.pdf +0 -0
data/spec/samples/sfm-12x9-outside.pdf +0 -0
data/spec/samples/sfm-6x18-inside.pdf +0 -0
data/spec/samples/sfm-6x18-outside.pdf +0 -0
data/spec/spec_helper.rb +3 -3
metadata +29 -60
data/lib/lob/resources/route.rb +0 -33
data/spec/lob/resources/area_spec.rb +0 -59
data/spec/lob/resources/route_spec.rb +0 -39

data/lib/lob/resources/resource_base.rb CHANGED Viewed

@@ -19,7 +19,7 @@ module Lob
           query: query
         }
-        submit request
+        submit(request)
       end
       def find(resource_id)
@@ -28,7 +28,7 @@ module Lob
           url: resource_url(resource_id)
         }
-        submit request
+        submit(request)
       end
       def create(body={}, headers={}, query={})
@@ -40,7 +40,7 @@ module Lob
           query: query
         }
-        submit request
+        submit(request)
       end
       def destroy(resource_id)
@@ -49,7 +49,7 @@ module Lob
           url: resource_url(resource_id)
         }
-        submit request
+        submit(request)
       end
       private
@@ -71,11 +71,14 @@ module Lob
         if query != {}
           url = "#{url}?#{build_nested_query(query)}"
         end
         begin
           if method == :get || method == :delete
             response = RestClient.send(method, url, headers)
           else
+            if body[:merge_variables] and body[:merge_variables].class == Hash
+              body[:merge_variables] = body[:merge_variables].to_json()
+            end
             response = RestClient.send(method, url, body, headers)
           end

data/lib/lob/resources/self_mailer.rb ADDED Viewed

@@ -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 CHANGED Viewed

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

data/lob.gemspec CHANGED Viewed

@@ -18,14 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
-  spec.add_dependency "rest-client", ">= 1.8", "< 3.0"
+  spec.add_dependency "rest-client", ">= 2.0.1", "< 3.0"
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake", "~> 10.4.2"
+  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 "travis-lint", "~> 2.0.0"
-  spec.add_development_dependency "coveralls", "~> 0.8.1"
-  spec.add_development_dependency "simplecov", "~> 0.10.0"
-  spec.add_development_dependency "pry", "~> 0.10.0"
+  spec.add_development_dependency "coveralls", "~> 0.8.13"
+  spec.add_development_dependency "simplecov", "~> 0.11.0"
 end

data/spec/lob/resources/check_spec.rb CHANGED Viewed

@@ -50,6 +50,27 @@ describe Lob::Resources::Check do
       result["amount"].to_s.must_equal("2000.12")
     end
+    it "should create a check with a merge variable conditional" do
+      new_address = subject.addresses.create @sample_address_params
+      new_bank_account = subject.bank_accounts.create(@sample_bank_account_params)
+      subject.bank_accounts.verify(new_bank_account["id"], amounts: [1, 2])
+      result = subject.checks.create(
+        bank_account: new_bank_account["id"],
+        to: new_address["id"],
+        from: new_address["id"],
+        amount: "2000.12",
+        attachment: "<html>{{#is_awesome}}You are awesome!{{/is_awesome}}</html>",
+        merge_variables: {
+          is_awesome: false
+        }
+      )
+      result["merge_variables"]["is_awesome"].must_equal(false)
+    end
   end

data/spec/lob/resources/group_spec.rb ADDED Viewed

@@ -0,0 +1,50 @@
+require "spec_helper"
+describe Lob::Resources::Group do
+  before :each do
+    @sample_params = {
+      description: "Unsubscribe group",
+      metadata: {
+        test: 'stuff'
+      }
+    }
+  end
+  subject { Lob::Client.new(api_key: API_KEY) }
+  describe "list" do
+    it "should list groups" do
+      assert subject.groups.list["object"] == "list"
+    end
+  end
+  describe "create" do
+    it "should create a group" do
+      result = subject.groups.create @sample_params
+      result["description"].must_equal(@sample_params[:description])
+    end
+  end
+  describe "find" do
+    it "should find a group" do
+      new_group = subject.groups.create @sample_params
+      find_result = subject.groups.find(new_group["id"])
+      find_result["description"].must_equal(@sample_params[:description])
+    end
+  end
+  describe "destroy" do
+    it "should delete a group" do
+      new_group = subject.groups.create @sample_params
+      delete_result = subject.groups.destroy(new_group["id"])
+      assert_equal(new_group["id"], delete_result["id"])
+    end
+  end
+end

data/spec/lob/resources/intl_verifications_spec.rb CHANGED Viewed

@@ -15,13 +15,10 @@ describe Lob::Resources::IntlVerifications do
   subject { Lob::Client.new(api_key: API_KEY) }
   describe "verify" do
-    it "should return a 403 in test mode" do
-      begin
-        subject.intl_verifications.verify @sample_params
-      rescue Lob::InvalidRequestError => e
-        assert e.http_status == 403
-        assert e._response.headers.include?(:content_type)
-      end
+    it "should verify an international address" do
+      result = subject.intl_verifications.verify @sample_params
+      result["recipient"].must_equal("TEST KEYS DO NOT VERIFY ADDRESSES")
     end
   end

data/spec/lob/resources/letter_spec.rb CHANGED Viewed

@@ -31,7 +31,7 @@ describe Lob::Resources::Letter do
       new_letter = subject.letters.create(
         description: "TestLetter",
         color: true,
-        file: "https://s3-us-west-2.amazonaws.com/lob-assets/letter-goblue.pdf",
+        file: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/us_letter_1pg.pdf",
         to: new_address["id"],
         from: @sample_address_params
       )
@@ -52,6 +52,26 @@ describe Lob::Resources::Letter do
       new_letter["description"].must_equal("TestLetter")
     end
+    it "should create a letter with a merge variable object" do
+      new_address = subject.addresses.create @sample_address_params
+      new_letter = subject.letters.create(
+        description: "TestLetter",
+        color: true,
+        file: "<html>{{data.name}}</html>",
+        to: new_address["id"],
+        from: @sample_address_params,
+        merge_variables: {
+          data: {
+            name: "Kobe"
+          }
+        }
+      )
+      new_letter["description"].must_equal("TestLetter")
+      new_letter["merge_variables"]["data"]["name"].must_equal("Kobe")
+    end
   end
@@ -62,13 +82,13 @@ describe Lob::Resources::Letter do
       new_letter = subject.letters.create(
         description: "TestLetter",
         color: true,
-        file: "https://s3-us-west-2.amazonaws.com/lob-assets/letter-goblue.pdf",
+        file: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/us_letter_1pg.pdf",
         to: new_address["id"],
         from: new_address["id"]
       )
       result = subject.letters.find(new_letter["id"])
-      assert /#{new_letter["description"]}/ =~ result.to_s
+      assert %r{#{new_letter["description"]}} =~ result.to_s
     end
   end
@@ -80,7 +100,7 @@ describe Lob::Resources::Letter do
       new_letter = subject.letters.create(
         description: "TestLetter",
         color: true,
-        file: "https://s3-us-west-2.amazonaws.com/lob-assets/letter-goblue.pdf",
+        file: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/us_letter_1pg.pdf",
         to: new_address["id"],
         from: new_address["id"]
       )

data/spec/lob/resources/member_spec.rb ADDED Viewed

@@ -0,0 +1,65 @@
+require "spec_helper"
+describe Lob::Resources::GroupsMember do
+  before :each do
+    @sample_group_params = {
+      description: "Unsubscribe group",
+      metadata: {
+        test: 'stuff'
+      }
+    }
+    @sample_member_params = {
+      recipient: {
+        name: 'Sophie',
+        address_line1: '185 Berry St',
+        address_line2: '6100',
+        address_city: 'San Francisco',
+        address_state: 'CA',
+        address_zip: '94107'
+      },
+      description: "Some Member",
+      metadata: {
+        test: 'stuff'
+      }
+    }
+    @new_group = subject.groups.create @sample_group_params
+  end
+  subject { Lob::Client.new(api_key: API_KEY) }
+  describe "list" do
+    it "should list members in a group" do
+      assert subject.groups_members.list(@new_group["id"])["object"] == "list"
+    end
+  end
+  describe "create" do
+    it "should create a member" do
+      result = subject.groups_members.create(@new_group["id"], @sample_member_params)
+      result["description"].must_equal(@sample_member_params[:description])
+    end
+  end
+  describe "find" do
+    it "should find a member" do
+      new_member = subject.groups_members.create(@new_group["id"], @sample_member_params)
+      find_result = subject.groups_members.find(@new_group["id"], new_member["id"])
+      find_result["description"].must_equal(@sample_member_params[:description])
+    end
+  end
+  describe "destroy" do
+    it "should delete a member" do
+      new_member = subject.groups_members.create(@new_group["id"], @sample_member_params)
+      delete_result = subject.groups_members.destroy(@new_group["id"], new_member["id"])
+      assert_equal(new_member["id"], delete_result["id"])
+    end
+  end
+end

data/spec/lob/resources/postcard_spec.rb CHANGED Viewed

@@ -37,7 +37,7 @@ describe Lob::Resources::Postcard do
         description: @sample_postcard_params[:description],
         to: new_address["id"],
         back: @sample_postcard_params[:back],
-        front: "https://lob.com/postcardfront.pdf"
+        front: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/pc_4x6_front.pdf"
       )
       result["description"].must_equal(@sample_postcard_params[:description])
@@ -48,7 +48,7 @@ describe Lob::Resources::Postcard do
         description: @sample_postcard_params[:description],
         to: @sample_address_params,
         back: @sample_postcard_params[:back],
-        front: "https://lob.com/postcardfront.pdf"
+        front: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/pc_4x6_front.pdf"
       )
       result["description"].must_equal(@sample_postcard_params[:description])
@@ -62,7 +62,7 @@ describe Lob::Resources::Postcard do
         to: new_address["id"],
         from: @sample_address_params,
         back: @sample_postcard_params[:back],
-        front: "https://lob.com/postcardfront.pdf"
+        front: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/pc_4x6_front.pdf"
       )
       result["description"].must_equal(@sample_postcard_params[:description])
@@ -74,8 +74,8 @@ describe Lob::Resources::Postcard do
       result = subject.postcards.create(
         description: @sample_postcard_params[:description],
         to: new_address["id"],
-        front: "https://lob.com/postcardfront.pdf",
-        back:  "https://lob.com/postcardback.pdf"
+        front: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/pc_4x6_front.pdf",
+        back:  "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/pc_4x6_back.pdf"
       )
       result["description"].must_equal(@sample_postcard_params[:description])
@@ -95,6 +95,31 @@ describe Lob::Resources::Postcard do
       result["description"].must_equal(@sample_postcard_params[:description])
     end
+    it "should create a postcard with a merge variable list" do
+      new_address = subject.addresses.create @sample_address_params
+      merge_variables = {
+        list: [
+          {
+            name: "Larissa"
+          },
+          {
+            name: "Larry"
+          }
+        ]
+      }
+      result = subject.postcards.create(
+        description: @sample_postcard_params[:description],
+        to: new_address["id"],
+        back: "<html>{{#list}} {{name}} {{/list}}</html>",
+        front: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/pc_4x6_front.pdf",
+        merge_variables: merge_variables
+      )
+      result["description"].must_equal(@sample_postcard_params[:description])
+      result["merge_variables"]["list"][0]["name"].must_equal("Larissa")
+      result["merge_variables"]["list"][1]["name"].must_equal("Larry")
+    end
   end

data/spec/lob/resources/resource_base_spec.rb CHANGED Viewed

@@ -2,22 +2,14 @@ require "spec_helper"
 describe Lob::Resources::ResourceBase do
-  before :each do
-    @api_key = API_KEY
-  end
-  subject { Lob::Client.new(api_key: @api_key) }
+  subject { Lob::Client.new(api_key: API_KEY) }
   describe "when Lob is initialized" do
     it "should have API key in config" do
-      subject.config[:api_key].must_equal @api_key
+      subject.config[:api_key].must_equal API_KEY
     end
   end
-  it "should return areas resource" do
-    subject.areas.must_be_kind_of(Lob::Resources::Area)
-  end
   it "should return addresses resource" do
     subject.addresses.must_be_kind_of(Lob::Resources::Address)
   end
@@ -38,10 +30,6 @@ describe Lob::Resources::ResourceBase do
     subject.postcards.must_be_kind_of(Lob::Resources::Postcard)
   end
-  it "should return routes resource" do
-    subject.routes.must_be_kind_of(Lob::Resources::Route)
-  end
   it "should accept an idempotency_key" do
     sample_address_params = {
       name:    "TestAddress",
@@ -67,7 +55,7 @@ describe Lob::Resources::ResourceBase do
       description: sample_postcard_params[:description],
       to: new_address["id"],
       back: sample_postcard_params[:back],
-      front: "https://lob.com/postcardfront.pdf"
+      front: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/pc_4x6_front.pdf"
     }, {
       "Idempotency-Key" => idempotency_key
     })
@@ -76,7 +64,7 @@ describe Lob::Resources::ResourceBase do
       description: sample_postcard_params[:description],
       to: new_address["id"],
       back: sample_postcard_params[:back],
-      front: "https://lob.com/postcardfront.pdf"
+      front: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/pc_4x6_front.pdf"
     }, {
       "Idempotency-Key" => idempotency_key
     })

data/spec/lob/resources/self_mailer_spec.rb ADDED Viewed

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