lob 4.3.0 → 5.4.6

data/lib/lob/client.rb

@@ -1,12 +1,17 @@
 require "lob/resources/address"
-require "lob/resources/area"
 require "lob/resources/bank_account"
+require "lob/resources/bulk_intl_verifications"
+require "lob/resources/bulk_us_verifications"
+require "lob/resources/card"
 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_reverse_geocode_lookups"
 require "lob/resources/us_verifications"
 require "lob/resources/us_zip_lookups"
 
@@ -23,10 +28,6 @@ module Lob
       @config = config
     end
 
-    def areas
-      Lob::Resources::Area.new(config)
-    end
-
     def addresses
       Lob::Resources::Address.new(config)
     end
@@ -35,9 +36,29 @@ module Lob
       Lob::Resources::BankAccount.new(config)
     end
 
+    def bulk_intl_verifications
+      Lob::Resources::BulkIntlVerifications.new(config)
+    end
+
+    def bulk_us_verifications
+      Lob::Resources::BulkUSVerifications.new(config)
+    end
+
+    def cards
+      Lob::Resources::Card.new(config)
+    end
+
     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,14 +72,18 @@ 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
       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/bulk_intl_verifications.rb

@@ -0,0 +1,27 @@
+require "lob/resources/resource_base"
+
+module Lob
+  module Resources
+    class BulkIntlVerifications < Lob::Resources::ResourceBase
+
+      undef_method :list, :find, :create, :destroy
+
+      def initialize(config)
+        super(config)
+        @endpoint = "bulk/intl_verifications"
+      end
+
+      def verify(body={})
+        body[:addresses] = body[:addresses].to_json
+        request = {
+          method: :post,
+          url: endpoint_url,
+          body: body
+        }
+
+        submit request
+      end
+
+    end
+  end
+end

data/lib/lob/resources/bulk_us_verifications.rb

@@ -0,0 +1,28 @@
+require "lob/resources/resource_base"
+
+module Lob
+  module Resources
+    class BulkUSVerifications < Lob::Resources::ResourceBase
+
+      undef_method :list, :find, :create, :destroy
+
+      def initialize(config)
+        super(config)
+        @endpoint = "bulk/us_verifications"
+      end
+
+      def verify(body={}, query={})
+        body[:addresses] = body[:addresses].to_json
+        request = {
+          method: :post,
+          url: endpoint_url,
+          body: body,
+          query: query
+        }
+
+        submit request
+      end
+
+    end
+  end
+end

data/lib/lob/resources/card.rb

@@ -0,0 +1,46 @@
+require "lob/resources/resource_base"
+
+module Lob
+  module Resources
+    class Card < Lob::Resources::ResourceBase
+
+      def initialize(config)
+        super(config)
+        @endpoint = "cards"
+      end
+      
+      def update(resource_id, body={}, headers={})
+        request = {
+          method: :post,
+          url: resource_url(resource_id),
+          body: body,
+          headers: headers
+        }
+
+        submit(request)
+      end
+
+      def create_order(resource_id, body={}, headers={})
+        request = {
+          method: :post,
+          url: "#{resource_url(resource_id)}/orders",
+          body: body,
+          headers: headers
+        }
+
+        submit(request)
+      end
+
+      def list_orders(resource_id, query={})
+        request = {
+          method: :get,
+          url: "#{resource_url(resource_id)}/orders",
+          query: query
+        }
+
+        submit(request)
+      end
+
+    end
+  end
+end

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

data/lib/lob/resources/resource_base.rb

@@ -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
@@ -72,13 +72,24 @@ module Lob
           url = "#{url}?#{build_nested_query(query)}"
         end
 
-        begin
-          if method == :get || method == :delete
-            response = RestClient.send(method, url, headers)
-          else
-            response = RestClient.send(method, url, body, headers)
+        client_params = {
+          headers: headers,
+          method: method,
+          url: url,
+        }
+
+        client_params[:proxy] = config[:proxy] if config.key?(:proxy)
+
+        unless method == :delete || method == :get
+          if body and body[:merge_variables] and body[:merge_variables].class == Hash
+            body[:merge_variables] = body[:merge_variables].to_json
           end
 
+          client_params[:payload] = body
+        end
+        begin
+          response = RestClient::Request.execute(client_params)
+
           body = JSON.parse(response)
 
           body.define_singleton_method(:_response) do

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/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 = "4.3.0"
+  VERSION = "5.4.6"
 end

data/lob.gemspec

@@ -18,14 +18,14 @@ 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 "simplecov-lcov"
+  spec.add_development_dependency "coveralls_reborn", "~> 0.23.1"
+  spec.add_development_dependency "simplecov", "~> 0.21.0"
+  spec.add_development_dependency "json", "~> 2.3.1"
+  spec.add_development_dependency "uri", "~> 0.10.1"
 end

data/spec/lob/resources/bulk_intl_verifications_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe Lob::Resources::BulkIntlVerifications do
+
+  before :each do
+    @sample_params = {
+      addresses: [
+        {
+          primary_line: "123 Test St",
+          city: "HEARST",
+          state: "ONTARIO",
+          postal_code: "P0L1N0",
+          country: "CA"
+        },
+        {
+          primary_line: "123 Test St",
+          city: "HEARST",
+          state: "ONTARIO",
+          postal_code: "P0L1N0",
+          country: "CA"
+        }
+      ]
+    }
+  end
+
+  subject { Lob::Client.new(api_key: API_KEY) }
+
+  describe "verify" do
+    it "should verify an international address" do
+      result = subject.bulk_intl_verifications.verify @sample_params
+      addresses = result["addresses"]
+      address = addresses.first
+      address["recipient"].must_equal("TEST KEYS DO NOT VERIFY ADDRESSES")
+      address = addresses[1]
+      address["recipient"].must_equal("TEST KEYS DO NOT VERIFY ADDRESSES")
+    end
+  end
+
+end

data/spec/lob/resources/bulk_us_verifications_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+describe Lob::Resources::BulkUSVerifications do
+
+  before :each do
+    @sample_params = {
+      addresses: [
+        {
+          recipient: "LOB.COM",
+          primary_line: "185 BERRY ST STE 6600",
+          city: "SAN FRANCISCO",
+          state: "CA",
+          zip_code: "94107"
+        },
+        {
+          recipient: "Harry Zhou",
+          primary_line: "325 BERRY ST",
+          city: "SAN FRANCISCO",
+          state: "CA",
+          zip_code: "94107"
+        }
+      ]
+    }
+  end
+
+  subject { Lob::Client.new(api_key: API_KEY) }
+
+  describe "verify" do
+    it "should verify a US address" do
+      result = subject.bulk_us_verifications.verify @sample_params
+      addresses = result["addresses"]
+      address = addresses.first
+      address["recipient"].must_equal("TEST KEYS DO NOT VERIFY ADDRESSES")
+      address = addresses[1]
+      address["recipient"].must_equal("TEST KEYS DO NOT VERIFY ADDRESSES")
+
+
+    end
+
+    it "should allow 'case' in query params" do
+      result = subject.bulk_us_verifications.verify @sample_params, {case: "proper"}
+      addresses = result["addresses"]
+      address = addresses.first
+      address["recipient"].must_equal("Test Keys Do Not Verify Addresses")
+      address = addresses[1]
+      address["recipient"].must_equal("Test Keys Do Not Verify Addresses")
+
+    end
+  end
+
+end

data/spec/lob/resources/card_spec.rb

@@ -0,0 +1,145 @@
+require "spec_helper"
+
+describe Lob::Resources::Card do
+
+  before :each do
+    @horizontal_card_url = "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/card_horizontal.pdf"
+    @horizontal_card_front = File.new(File.expand_path("../../../samples/card.pdf", __FILE__))
+    @horizontal_card_back = File.new(File.expand_path("../../../samples/card.pdf", __FILE__))
+
+    @sample_card_params = {
+      description: "Test Card",
+      front: @horizontal_card_url
+    }
+  end
+
+  subject { Lob::Client.new(api_key: API_KEY) }
+
+  describe "list" do
+    it "should list cards" do
+      assert subject.cards.list({ include: ['total_count'] })["object"] == "list"
+    end
+  end
+
+  describe "create" do
+    it "should create a card with a front url" do
+      result = subject.cards.create(@sample_card_params)
+
+      result["description"].must_equal(@sample_card_params[:description])
+    end
+
+    it "should create a card with front and back as urls" do
+      result = subject.cards.create(
+        @sample_card_params.merge(back: @horizontal_card_url)
+      )
+
+      result["description"].must_equal(@sample_card_params[:description])
+    end
+
+    it "should create a card with a front PDF" do
+      result = subject.cards.create(
+        @sample_card_params.merge(front: @horizontal_card_front)
+      )
+
+      result["description"].must_equal(@sample_card_params[:description])
+    end
+
+    it "should create a card with front and back as PDFs" do
+      result = subject.cards.create(
+        @sample_card_params.merge({
+          front: @horizontal_card_front,
+          back: @horizontal_card_back
+        })
+      )
+
+      result["description"].must_equal(@sample_card_params[:description])
+    end
+
+    it "should return an error without a front" do
+      assert_raises Lob::InvalidRequestError do
+        subject.cards.create(
+          @sample_card_params.merge({ front: nil })
+        )
+      end
+    end
+  end
+
+
+  describe "find" do
+    it "should find a card" do
+      new_card = subject.cards.create(
+        @sample_card_params.merge(front: @horizontal_card_front)
+      )
+
+      result  = subject.cards.find(new_card["id"])
+      result["description"].must_equal(@sample_card_params[:description])
+    end
+  end
+
+
+  describe "update" do
+    it "should update a card" do
+      new_card = subject.cards.create(
+        @sample_card_params.merge(front: @horizontal_card_front)
+      )
+
+      result  = subject.cards.update(
+        new_card["id"],
+        { description: "Updated card description" }
+      )
+      result["description"].must_equal("Updated card description")
+    end
+  end
+
+
+  describe "destroy" do
+    it "should destroy a card" do
+      new_card = subject.cards.create(
+        @sample_card_params.merge(front: @horizontal_card_front)
+      )
+
+      result = subject.cards.destroy(new_card["id"])
+      result["id"].must_equal(new_card["id"])
+      result["deleted"].must_equal(true)
+    end
+  end
+
+
+  describe "create_order" do
+    it "should create an order for a card" do
+      new_card = subject.cards.create(
+        @sample_card_params.merge(front: @horizontal_card_front)
+      )
+
+      card_order_params = {
+        quantity: 10001
+      }
+
+      result = subject.cards.create_order(new_card["id"], card_order_params)
+      result["card_id"].must_equal(new_card["id"])
+      result["quantity_ordered"].must_equal(card_order_params[:quantity])
+      result["object"].must_equal("card_order")
+    end
+  end
+
+
+  describe "list_orders" do
+    it "should list all orders for a card" do
+      new_card = subject.cards.create(
+        @sample_card_params.merge(front: @horizontal_card_front)
+      )
+      card_order_params = {
+        quantity: 10001
+      }
+      new_card_order = subject.cards.create_order(
+        new_card["id"],
+        card_order_params
+      )
+
+      result = subject.cards.list_orders(new_card["id"])
+      result["object"].must_equal("list")
+      result["count"].must_equal(1)
+    end
+  end
+
+end

data/spec/lob/resources/check_spec.rb

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