lob 5.4.2 → 5.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b69d606dfce94ccad4b1bb4cb584a7e3d0ac341e4a117775aba88f31123d0de5
-  data.tar.gz: 8c82f0edfbadfaeb5aac1f922107c138349581ca8f7590ec294dd1141a7c7f6a
+  metadata.gz: ba5df9cb717ab1c37b9ee4741304e8d5afa77d2e78c323d25f6d81e541f463ae
+  data.tar.gz: f0b0e80db2cfafa53427676ff2ff66edf02f85f1e7b1c98acaeb7f5e5426de84
 SHA512:
-  metadata.gz: e5f1f78dedb730277f86ce1d4f74105121d72927e1843de558bfbe89546f5cad7e838d0517348619aef0d62e9d1693058efbd57662cd10a24930385f6d11cdd9
-  data.tar.gz: b5475fe1716dda1aaebe194f2f1c8af7fe4f7a9b4a3e55e8124e057c1d76c6d2434631754dcf7bc801c5129e9598b137acda021e5b796ca4a8442eeb77f7704d
+  metadata.gz: 40ad0b305524f54b28a1a08c83108aed912e6c23c096fb55be0d8f713bb6a2a1108f334c0d8949e88aa0139ab0e0fed71077b4e9af140829ab41643c9d0cc235
+  data.tar.gz: 7e9cbf18e676c609a09ff2bc32c60931c69c5fd5334ef82b905d2f7bc62c36086121ccd48e67e4b3a3f1cf5b64e87c5237f6ccd5bbcaaa36ef0d680bbccbd070

data/.github/workflows/forked_tests_job.yml

@@ -0,0 +1,36 @@
+name: Run tests from Forked Repo
+
+on: 
+  pull_request_target:
+    types: [labeled]
+jobs:
+  ruby_tests:
+    runs-on: ubuntu-latest
+    if: contains(github.event.pull_request.labels.*.name, 'Approved')
+
+    strategy:
+      matrix:
+        ruby-version: ['jruby-9.2.9.0', '2.6', '2.7', '3.0']
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+    - name: Install Dependencies
+      run: bundle install
+    - name: Run Tests
+      env:
+        API_KEY: ${{ secrets.API_KEY }}
+        JRUBY_OPT: --2.0
+      run: bundle exec rake test
+    - name: Send coverage to Coveralls
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        path-to-lcov: ./coverage/lcov/lcov.info
+
+
+
+
+  

data/.github/workflows/run_tests_job.yml

@@ -1,10 +1,6 @@
 name: Run tests
 
-on:
-  pull_request:
-    types: [ created, reopened ]
-    branches:
-      - master
+on: [pull_request]
 jobs:
   ruby_tests:
     runs-on: ubuntu-latest
@@ -28,7 +24,7 @@ jobs:
       uses: coverallsapp/github-action@master
       with:
         github-token: ${{ secrets.GITHUB_TOKEN }}
-        
+        path-to-lcov: ./coverage/lcov/lcov.info
 
 
 

data/.github/workflows/update_gem.yml

@@ -7,15 +7,12 @@ on:
 jobs:
   publish_gem:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['jruby-9.2.9.0', '2.6', '2.7', '3.0']
     steps:
     - uses: actions/checkout@v2
     - name: Setup
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: ${{ matrix.ruby-version }}
+        ruby-version: 2.7
     - name: Install Dependencies
       run: bundle install
     - name: Publish Gem

data/.gitignore

@@ -4,6 +4,7 @@
 .config
 .yardoc
 .DS_Store
+.idea
 Gemfile.lock
 InstalledFiles
 _yardoc

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [**5.4.6**](https://github.com/lob/lob-ruby/releases/tag/v5.4.6) (2022-01-25)
+- [**206**](https://github/com/lob/lob-ruby/pull/206) added additional parsing to make sure we can pass hashes into bulk verify methods
+## [**5.4.5**](https://github.com/lob/lob-ruby/releases/tag/v5.4.5) (2022-01-11)
+- [**203**](https://github.com/lob/lob-ruby/pull/203) Pass through proxy to rest-client if supplied
+## [**5.4.4**](https://github.com/lob/lob-ruby/releases/tag/v5.4.4) (2021-12-16)
+- [**202**](https://github.com/lob/lob-ruby/pull/202) Fix for coveralls API for GH actions and fix for error in resource_base.rb
+## [**5.4.3**](https://github.com/lob/lob-ruby/releases/tag/v5.4.3) (2021-12-15)
+- [**199**](https://github.com/lob/lob-ruby/pull/199) Refactor ResourceBase to make the options sent to rest-client more configurable
+## [**5.4.2**](https://github.com/lob/lob-ruby/releases/tag/v5.4.2) (2021-12-08)
+- [**198**](https://github.com/lob/lob-ruby/pull/198) specified ruby version in publish action
+- [**195**](https://github.com/lob/lob-ruby/pull/195) added links to example scripts in README file & gh actions to release
 ## [**5.4.1**](https://github.com/lob/lob-ruby/releases/tag/v5.4.1) (2021-09-28)
 - [**193**](https://github.com/lob/lob-ruby/pull/193) Minor patches
 ## [**5.4.0**](https://github.com/lob/lob-ruby/releases/tag/v5.4.0) (2021-09-21)

data/README.md

@@ -69,6 +69,9 @@ lob = Lob::Client.new(api_key: "your-api-key")
 
 # To initialize a Lob object with an older API version
 lob = Lob::Client.new(api_key: "your-api-key", api_version: "2014-12-18")
+
+# To initialize a Lob object that needs to communicate via a proxy
+lob = Lob::Client.new(api_key: "your-api-key", proxy: "http://proxy.example.com)
 ```
 
 #### Caution: Pass zero-prefixed zip codes as strings

data/examples/README.md

@@ -38,6 +38,14 @@ Please note that if you are running this with a Test API Key, the verification A
 bundle exec ruby examples/csv_verify/verify.rb
 ```
 
+## [/cards.rb](./cards.rb)
+
+An example showing how to create a card using Lob's [Cards API](https://docs.lob.com/#tag/Cards).
+
+```
+bundle exec ruby examples/cards.rb
+```
+
 ## [/checks.rb](./checks.rb)
 
 An example showing how to create a check using Lob's [Checks API](https://lob.com/services/checks).

data/examples/cards.rb

@@ -0,0 +1,51 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'lob.rb'
+require 'pp'
+
+# initialize Lob object
+LOB_LIVE_API_KEY = ENV['LOB_LIVE_API_KEY']
+lob = Lob::Client.new(api_key: LOB_LIVE_API_KEY)
+
+front_template = 'https://s3-us-west-2.amazonaws.com/public.lob.com/assets/card_horizontal.pdf'
+back_template = 'https://s3-us-west-2.amazonaws.com/public.lob.com/assets/card_horizontal.pdf'
+
+# create a card
+pp lob.cards.create(
+  front: front_template, # required
+  back: back_template, # optional; default: 'https://s3.us-west-2.amazonaws.com/public.lob.com/assets/card_blank_horizontal.pdf'
+  description: 'Test Card', # optional
+  size: '2.125x3.375' # optional, default: '2.125x3.375'
+)
+
+# find a card
+card_id = 'YOUR_CARD_ID'
+pp lob.cards.find(
+  card_id # required
+)
+
+# update a card
+card_id = 'YOUR_CARD_ID'
+pp lob.cards.update(
+  card_id, # required
+  { description: 'Updated Test Card Desc' }
+)
+
+# delete a card
+card_id = 'YOUR_CARD_ID'
+pp lob.cards.destroy(
+  card_id # required
+)
+
+# create a card order
+card_id = 'YOUR_CARD_ID'
+pp lob.cards.create_order(
+  card_id, # required
+  { quantity: 10000 } # required
+)
+
+# List orders for a given card a card order
+card_id = 'YOUR_CARD_ID'
+pp lob.cards.list_orders(
+  card_id # required
+)
+

data/lib/lob/client.rb

@@ -2,6 +2,7 @@ require "lob/resources/address"
 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"
@@ -43,6 +44,10 @@ module Lob
       Lob::Resources::BulkUSVerifications.new(config)
     end
 
+    def cards
+      Lob::Resources::Card.new(config)
+    end
+
     def checks
       Lob::Resources::Check.new(config)
     end

data/lib/lob/resources/bulk_intl_verifications.rb

@@ -12,6 +12,7 @@ module Lob
       end
 
       def verify(body={})
+        body[:addresses] = body[:addresses].to_json
         request = {
           method: :post,
           url: endpoint_url,

data/lib/lob/resources/bulk_us_verifications.rb

@@ -12,6 +12,7 @@ module Lob
       end
 
       def verify(body={}, query={})
+        body[:addresses] = body[:addresses].to_json
         request = {
           method: :post,
           url: endpoint_url,

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/resource_base.rb

@@ -71,17 +71,25 @@ 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)
+
+        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/version.rb

@@ -1,3 +1,3 @@
 module Lob
-  VERSION = "5.4.2"
+  VERSION = "5.4.6"
 end

data/lob.gemspec

@@ -23,6 +23,7 @@ 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 "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"

data/spec/lob/resources/bulk_intl_verifications_spec.rb

@@ -5,6 +5,13 @@ 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",
@@ -24,6 +31,8 @@ describe Lob::Resources::BulkIntlVerifications do
       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
 

data/spec/lob/resources/bulk_us_verifications_spec.rb

@@ -11,6 +11,13 @@ describe Lob::Resources::BulkUSVerifications do
           city: "SAN FRANCISCO",
           state: "CA",
           zip_code: "94107"
+        },
+        {
+          recipient: "Harry Zhou",
+          primary_line: "325 BERRY ST",
+          city: "SAN FRANCISCO",
+          state: "CA",
+          zip_code: "94107"
         }
       ]
     }
@@ -24,6 +31,10 @@ describe Lob::Resources::BulkUSVerifications do
       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
@@ -31,6 +42,9 @@ describe Lob::Resources::BulkUSVerifications do
       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
 

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