lob 5.4.0 → 5.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d920a5ff8b4358b54f44f6812d0e38f976c1b248c5a7b9154c3d6eff9226869
-  data.tar.gz: b26009d8e3757fbebb1af09028667288481d7acb5afe79b0b7617c096017d7b3
+  metadata.gz: b0a60dcd0cd6c3caef1d72f172c78ac2d544532a006c00ede921f397de1c2897
+  data.tar.gz: ebd88e4908500dba5f7814dd0e74b4a3e114c95395cb3511f2a66868acf3a739
 SHA512:
-  metadata.gz: 4f37e760d4b69d4cedcc9226c800807f8a100031a0c27dfc9a3390bf7851fd873f4b597332deec652e4c20ff27cf92d9aa949b7f92c574f6b66cf18373fd92c8
-  data.tar.gz: a4af769be0508a03a1f0b87223f07ebdb468971b2374aaaa8de099342d877950c6a25b9c7f92f845214c6586d0d563f7cec0039dafecce70191f3f0fb1ef740c
+  metadata.gz: 5e8f68abd55e2626148f6ec248e2c9efcc7eeaaf58b6257370f33a91354d9924ebd660498b6704cf39fb6ba51919d120a306d6eef6e6aefb471d5cd19470d76f
+  data.tar.gz: d49279834a27c4665da66e509bcc9bf6625b3121ad644691a6ed76921917cb93e090b28f595c1c31ee7517d97073a68806b39ee8f404688bd4553303c02720a9

data/.github/workflows/run_tests_job.yml

@@ -0,0 +1,32 @@
+name: Run tests
+
+on: [pull_request]
+jobs:
+  ruby_tests:
+    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 }}
+    - 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/update_gem.yml

@@ -0,0 +1,27 @@
+name: Publish Gem
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish_gem:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - name: Install Dependencies
+      run: bundle install
+    - name: Publish Gem
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

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

data/CHANGELOG.md

@@ -1,6 +1,14 @@
+## [**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)
-- [**192**](https://github.com/lob/lob-ruby/pull/192) updated to 3.0.0 
-- [**191**](https://github.com/lob/lob-ruby/pull/191) feat(us_verifications): Reverse Geocoding endpoint
+- [**191**](https://github.com/lob/lob-ruby/pull/191) Add support for reverse geocoding endpoint
 ## [**5.3.0**](https://github.com/lob/lob-ruby/releases/tag/v5.3.0) (2021-08-25)
 - [**190**](https://github.com/lob/lob-ruby/pull/190) Adds support for bulk AV endpoints
 ## [**5.2.0**](https://github.com/lob/lob-ruby/releases/tag/v5.2.0) (2021-05-03)

data/README.md

@@ -113,80 +113,7 @@ There are simple scripts to demonstrate how to create all the core Lob objects (
 
 ## API Documentation
 
-- [Introduction](https://lob.com/docs/ruby#introduction)
-- [Versioning](https://lob.com/docs/ruby#version)
-- [Errors](https://lob.com/docs/ruby#errors)
-- [Rate Limiting](https://lob.com/docs/ruby#rate-limits)
-- [Webhooks](https://lob.com/docs/ruby#webhooks)
-- [Cancellation Windows](https://lob.com/docs/ruby#cancellation)
-- [Scheduled Mailings](https://lob.com/docs/ruby#scheduled)
-- [Metadata](https://lob.com/docs/ruby#metadata)
-- [HTML Templates](https://lob.com/docs/ruby#templates)
-- [Asset URLs](https://lob.com/docs/ruby#urls)
-- **Addresses**
-  - [Address Book](https://lob.com/docs/ruby#addresses)
-    - [The Address Object](https://lob.com/docs/ruby#addresses_object)
-    - [Create an Address](https://lob.com/docs/ruby#addresses_create)
-    - [Retrieve an Address](https://lob.com/docs/ruby#addresses_retrieve)
-    - [Delete an Address](https://lob.com/docs/ruby#addresses_delete)
-    - [List all Addresses](https://lob.com/docs/ruby#addresses_list)
-- **US Verification API**
-  - [US Verification API](https://lob.com/docs/ruby#us_verifications)
-    - [The US Verification Object](https://lob.com/docs/ruby#us_verifications_object)
-    - [Verify a US Address](https://lob.com/docs/ruby#us_verifications_create)
-    - [Bulk Verify US Addresses](https://lob.com/docs/ruby#bulk_us_verifications_create)
-    - [The US Zip Lookup Object](https://lob.com/docs/ruby#us_zip_lookups_object)
-    - [Lookup a US Zip Code](https://lob.com/docs/ruby#us_zip_lookups_create)
-  - [US Autocompletion API](https://lob.com/docs/ruby#us_autocompletions)
-    - [The US Autocompletion Object](https://lob.com/docs/ruby#us_autocompletions_object)
-    - [Autocomplete a US Address](https://lob.com/docs/ruby#us_autocompletions_create)
-    - [The US Autocompletion Test Environment](https://lob.com/docs/ruby#us-autocompletions-test-environment)
-- **Int'l Verification API**
-  - [International Verifications](https://lob.com/docs/ruby#intl_verifications)
-    - [Verify an International Address](https://lob.com/docs/ruby#intl_verifications_create)
-    - [Bulk Verify International Addresses](https://lob.com/docs/ruby#bulk_intl_verifications_create)
-- **Postcards API**
-  - [Postcards](https://lob.com/docs/ruby#postcards)
-    - [The Postcard Object](https://lob.com/docs/ruby#postcards_object)
-    - [Create a Postcard](https://lob.com/docs/ruby#postcards_create)
-    - [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)
-    - [Create a Letter](https://lob.com/docs/ruby#letters_create)
-    - [Retrieve a Letter](https://lob.com/docs/ruby#letters_retrieve)
-    - [Cancel a Letter](https://lob.com/docs/ruby#letters_delete)
-    - [List all Letters](https://lob.com/docs/ruby#letters_list)
-- **Checks API**
-  - [Checks](https://lob.com/docs/ruby#checks)
-    - [The Check Object](https://lob.com/docs/ruby#checks_object)
-    - [Create a Check](https://lob.com/docs/ruby#checks_create)
-    - [Retrieve a Check](https://lob.com/docs/ruby#checks_retrieve)
-    - [Cancel a Check](https://lob.com/docs/ruby#checks_delete)
-    - [List all Checks](https://lob.com/docs/ruby#checks_list)
-  - [Bank Accounts](https://lob.com/docs/ruby#bank-accounts)
-    - [The Bank Account Object](https://lob.com/docs/ruby#bankaccounts_object)
-    - [Create a Bank Account](https://lob.com/docs/ruby#bankaccounts_create)
-    - [Retrieve a Bank Account](https://lob.com/docs/ruby#bankaccounts_retrieve)
-    - [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)
-- **Appendix**
-  - [API Changelog](https://lob.com/docs/ruby#changelog)
-  - [The Tracking Event Object](https://lob.com/docs/ruby#tracking_event_object)
-  - [Events](https://lob.com/docs/ruby#events)
-  - [HTML Examples](https://lob.com/docs/ruby#html-examples)
-  - [Image Prepping](https://lob.com/docs/ruby#prepping)
-  - [US Verification Details](https://lob.com/docs/ruby#us_verification_details)
+The full and comprehensive documentation of Lob's APIs is available [here](https://docs.lob.com/).
 
 ## Contributing
 

data/examples/README.md

@@ -1,10 +1,10 @@
 # Ruby Examples
 
-Here we have put together a handful of ruby examples to help get you started. Please read through the official [API Documentation](https://docs.lob.com) to get a complete sense of what to expect from each endpoint. As always, feel free to [contact us](https://lob.com/support) directly if you have any questions on implementation.
+Here we have put together a handful of ruby examples to help get you started. Please read through the official [API Documentation](https://docs.lob.com) to get a complete sense of what to expect from each endpoint. As always, feel free to [contact us](https://lob.com/support) directly if you have any questions on implementation. Thank you for using Lob!
 
 To run these example commands, make sure you have a supported version of Ruby installed, including all the necessary gems.
 
-## /csv_checks/
+## [/csv_checks/](./csv_checks/)
 
 An example showing how to dynamically create checks from a CSV using HTML, merge variables, and Lob's [Checks API](https://lob.com/services/checks).
 
@@ -12,7 +12,7 @@ An example showing how to dynamically create checks from a CSV using HTML, merge
 bundle exec ruby examples/csv_checks/create_checks.rb
 ```
 
-## /csv_letters/
+## [/csv_letters/](./csv_letters/)
 
 An example showing how to dynamically create letters from a CSV using HTML, a custom font, merge variables, and Lob's [Letters API](https://lob.com/services/letters).
 
@@ -20,7 +20,7 @@ An example showing how to dynamically create letters from a CSV using HTML, a cu
 bundle exec ruby examples/csv_letters/create_letters.rb
 ```
 
-## /csv_postcards/
+## [/csv_postcards/](./csv_postcards/)
 
 An example showing how to dynamically create postcards from a CSV using HTML, a custom font, merge variables, and Lob's [Postcards API](https://lob.com/services/postcards).
 
@@ -28,7 +28,7 @@ An example showing how to dynamically create postcards from a CSV using HTML, a
 bundle exec ruby examples/csv_postcards/create_postcards.rb
 ```
 
-## /csv_verify/
+## [/csv_verify/](./csv_verify/)
 
 An example showing how to validate and cleanse a CSV spreadsheet full of shipping addresses using Lob's [US Verification API](https://lob.com/services/verifications).
   		  
@@ -38,7 +38,7 @@ Please note that if you are running this with a Test API Key, the verification A
 bundle exec ruby examples/csv_verify/verify.rb
 ```
 
-## /checks.rb
+## [/checks.rb](./checks.rb)
 
 An example showing how to create a check using Lob's [Checks API](https://lob.com/services/checks).
 
@@ -46,7 +46,7 @@ An example showing how to create a check using Lob's [Checks API](https://lob.co
 bundle exec ruby examples/checks.rb
 ```
 
-## /letters.rb
+## [/letters.rb](./letters.rb)
 
 An example showing how to create a letter using Lob's [Letters API](https://lob.com/services/letters).
 
@@ -54,7 +54,7 @@ An example showing how to create a letter using Lob's [Letters API](https://lob.
 bundle exec ruby examples/letters.rb
 ```
 
-## /postcards.rb
+## [/postcards.rb](./postcards.rb)
 
 An example showing how to create a postcard using Lob's [Postcards API](https://lob.com/services/postcards).
 
@@ -62,7 +62,7 @@ An example showing how to create a postcard using Lob's [Postcards API](https://
 bundle exec ruby examples/postcards.rb
 ```
 
-## /postcards_idempotent.rb
+## [/postcards_idempotent.rb](./postcards_idempotent.rb)
 
 An example showing how to create an idempotent postcard request using Lob's [Postcards API](https://lob.com/services/postcards).
 
@@ -70,7 +70,7 @@ An example showing how to create an idempotent postcard request using Lob's [Pos
 bundle exec ruby examples/postcards_idempotent.rb
 ```
 
-## /postcards_intl.rb
+## [/postcards_intl.rb](./postcards_intl.rb)
 
 An example showing how to create an international postcard using Lob's [Postcards API](https://lob.com/services/postcards).
 
@@ -78,7 +78,7 @@ An example showing how to create an international postcard using Lob's [Postcard
 bundle exec ruby examples/postcards_intl.rb
 ```
 
-## /postcards_remote.rb
+## [/postcards_remote.rb](./postcards_remote.rb)
 
 An example showing how to create a postcard with remote files, using Lob's [Postcards API](https://lob.com/services/postcards).
 
@@ -86,7 +86,7 @@ An example showing how to create a postcard with remote files, using Lob's [Post
 bundle exec ruby examples/postcards_remote.rb
 ```
 
-## /postcards_send_date.rb
+## [/postcards_send_date.rb](./postcards_send_date.rb)
 
 An example showing how to create a postcard with a specified send date, using Lob's [Postcards API](https://lob.com/services/postcards).
 
@@ -94,7 +94,7 @@ An example showing how to create a postcard with a specified send date, using Lo
 bundle exec ruby examples/postcards_send_date.rb
 ```
 
-## /postcards_template.rb
+## [/postcards_template.rb](./postcards_template.rb)
 
 An example showing how to create a postcard with a saved template, using Lob's [Postcards API](https://lob.com/services/postcards).
 
@@ -102,7 +102,7 @@ An example showing how to create a postcard with a saved template, using Lob's [
 bundle exec ruby examples/postcards_template.rb
 ```
 
-## /self_mailers.rb
+## [/self_mailers.rb](./self_mailers.rb)
 
 An example showing how to create a self mailer using Lob's Self Mailers API.
 

data/examples/csv_verify/verify.rb

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

data/lib/lob/resources/resource_base.rb

@@ -71,17 +71,22 @@ 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,
+        }
+        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.0"
+  VERSION = "5.4.4"
 end

data/lob.gemspec

@@ -23,8 +23,9 @@ 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 "coveralls", "~> 0.8.23"
-  spec.add_development_dependency "simplecov", "~> 0.16.1"
+  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/spec_helper.rb

@@ -3,10 +3,12 @@ $:.unshift File.expand_path("../lib", File.dirname(__FILE__))
 require "simplecov"
 require "coveralls"
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-])
+require 'simplecov-lcov'
+
+SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
+SimpleCov::Formatter::LcovFormatter.config.lcov_file_name = 'lcov.info'
+
+SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
 SimpleCov.start
 
 require "lob"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lob
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.4.4
 platform: ruby
 authors:
 - Lob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -73,33 +73,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.23
+        version: 0.23.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.23
+        version: 0.23.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: 0.21.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: 0.21.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -135,8 +149,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/run_tests_job.yml"
+- ".github/workflows/update_gem.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -232,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Lob.com API with ActiveRecord-style syntax

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-
-rvm:
-  - jruby-9.1.9.0
-  - jruby-9.2.9.0
-  - 2.6
-  - 2.7
-  - 3.0
-env:
-  JRUBY_OPTS=--2.0
-
-script: bundle exec rake test