easypost 4.8.1 → 4.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ad992fe480aa1a1c8b1fc7e85dd06c7af4478bca9bcc3a2f083daaeeedcc39e
-  data.tar.gz: f37a2a32dac1dcc1efa0121dce6b6edbf14e3aa690308d393815ecaabddedda4
+  metadata.gz: 057d480c3fb244a62cb6d325f33f94bda4575bb0f9499026aba18bca47a8db2a
+  data.tar.gz: 056a2ebcd3081730bc0ac6337d5194dbbdcdcbd0c09dbea332e09d7dbddb4bbc
 SHA512:
-  metadata.gz: 6f0e9c8cbfb299608c58c865a2193e163739ca3543fb5bbea44026930bbecf34ae8d772fc2377909492a89d8c7d3d1440c7a9f7ebf25935927db35bc6ba1b7c3
-  data.tar.gz: 8b02eee4c36c0c918e4a3f4884694c48d453bbf3aba7db653669618462d67bad30c0cf0ceec96ee44de0b335626e0992b493ad06e4457feeb5f661ebe55ceb70
+  metadata.gz: 2e8d610408f118cf2e3eaa236e47a3c83979d78c56b4f1a2eb856a2b3125fa01c4a81e139091546f1cd05cdebe7165b8f5879330032ca5dd7d640abe46efd0b2
+  data.tar.gz: 128704a6508a3f9ad29e72886abff6c5f3f37b5f13c0d8f7b1f2423ebbc232bd5ba1d195a1b9b4249ccefee9e2a284c707332ac7e26e234c06f35d656ed46551

data/.gitattributes

@@ -1,4 +1,9 @@
 * text=auto
 
+# Cassettes
 spec/cassettes/**/* -diff
 spec/cassettes/**/* linguist-generated
+
+# Docs
+docs/**/* -diff
+docs/**/* linguist-generated

data/.github/workflows/ci.yml

@@ -19,11 +19,18 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.rubyversion }}
+          rubygems: "3.0.0"
           bundler-cache: true
       - name: Install Dependencies
         run: make install
       - name: run tests
         run: EASYPOST_TEST_API_KEY=123 EASYPOST_PROD_API_KEY=123 make test
+      - name: Coveralls
+        if: github.ref == 'refs/heads/master'
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: "./coverage/lcov/easypost-ruby.lcov"
   lint:
     runs-on: ubuntu-latest
     steps:
@@ -33,6 +40,7 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: "3.1"
+          rubygems: "3.0.0"
           bundler-cache: true
       - name: Install Dependencies
         run: make install

data/.gitignore

@@ -1,9 +1,11 @@
-*.gem
-*.rbc
 .bundle
 .config
-Gemfile.lock
+.idea/
+*.gem
+*.rbc
 coverage
+dist
+Gemfile.lock
 InstalledFiles
 lib/bundler/man
 pkg
@@ -12,21 +14,15 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.idea/
-dist
 
-# YARD artifacts
-.yardoc
-_yardoc
-doc/
 
-# iOS
-.DS_Store
+# macOS
+._*
 .AppleDouble
+.DS_Store
+.env
 .LSOverride
-Icon
-._*
 .Spotlight-V100
 .Trashes
+Icon
 vendor/
-.env

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## v4.10.0 (2023-01-11)
+
+- Added new beta billing functionality for referral customer users, accessible via `EasyPost::Beta::Referral`
+  - `add_payment_method` to add an existing Stripe bank account or credit card to your EasyPost account
+  - `refund_by_amount` refunds you wallet balance by a specified amount
+  - `refund_by_payment_log` refunds you wallet balance by a specified payment log
+- Fix bug where bank account and credit card payment methods were not deserializing to the `EasyPost::PaymentMethod` class
+
+## v4.9.0 (2022-12-07)
+
+- Routes requests for creating a carrier account with a custom workflow (eg: FedEx, UPS) to the correct endpoint when using the `create` function
+
 ## v4.8.1 (2022-10-24)
 
 - Concatenates `error.message` if it incorrectly comes back from the API as an array

data/Makefile

@@ -12,6 +12,14 @@ build:
 clean:
 	rm -rf coverage doc *.gem dist
 
+## coverage - Generate a test coverage report
+coverage:
+	make test
+
+## docs - Generate documentation for the library
+docs:
+	bundle exec rdoc lib -o docs --title "EasyPost Ruby Docs"
+
 ## fix - Fix Rubocop errors
 fix:
 	bundle exec rubocop -A
@@ -41,11 +49,11 @@ scan:
 
 ## test - Test the project (and ignore warnings for test output)
 test:
-	RUBYOPT="-W0" bundle exec rspec
+	bundle exec rspec
 
 ## update - Updates dependencies
 update:
 	git submodule init
 	git submodule update --remote
 
-.PHONY: help build clean fix install lint publish release scan test update
+.PHONY: help build clean coverage docs fix install lint publish release scan test update

data/README.md

@@ -1,6 +1,7 @@
 # EasyPost Ruby Client Library
 
 [![Build Status](https://github.com/EasyPost/easypost-ruby/workflows/CI/badge.svg)](https://github.com/EasyPost/easypost-ruby/actions?query=workflow%3ACI)
+[![Coverage Status](https://coveralls.io/repos/github/EasyPost/easypost-ruby/badge.svg?branch=master)](https://coveralls.io/github/EasyPost/easypost-ruby?branch=master)
 [![Gem Version](https://badge.fury.io/rb/easypost.svg)](https://badge.fury.io/rb/easypost)
 
 EasyPost, the simple shipping solution. You can sign up for an account at <https://easypost.com>.
@@ -130,6 +131,9 @@ EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make test
 # Run security analysis
 make scan
 
+# Generate library documentation
+make docs
+
 # Update submodules
 git submodule init
 git submodule update --remote
@@ -137,7 +141,7 @@ git submodule update --remote
 
 ### Testing
 
-The test suite in this project was specifically built to produce consistent results on every run, regardless of when they run or who is running them. This project uses [VCR](https://github.com/vcr/vcr) to record and replay HTTP requests and responses via "cassettes". When the suite is run, the HTTP requests and responses for each test function will be saved to a cassette if they do not exist already and replayed from this saved file if they do, which saves the need to make live API calls on every test run.
+The test suite in this project was specifically built to produce consistent results on every run, regardless of when they run or who is running them. This project uses [VCR](https://github.com/vcr/vcr) to record and replay HTTP requests and responses via "cassettes". When the suite is run, the HTTP requests and responses for each test function will be saved to a cassette if they do not exist already and replayed from this saved file if they do, which saves the need to make live API calls on every test run. If you receive errors about a cassette expiring, delete and re-record the cassette to ensure the data is up-to-date.
 
 **Sensitive Data:** We've made every attempt to include scrubbers for sensitive data when recording cassettes so that PII or sensitive info does not persist in version control; however, please ensure when recording or re-recording cassettes that prior to committing your changes, no PII or sensitive information gets persisted by inspecting the cassette.
 
@@ -155,5 +159,5 @@ The following are required on every test run:
 Some tests may require an EasyPost user with a particular set of enabled features such as a `Partner` user when creating referrals. We have attempted to call out these functions in their respective docstrings. The following are required when you need to re-record cassettes for applicable tests:
 
 - `USPS_CARRIER_ACCOUNT_ID` (eg: one-call buying a shipment for non-EasyPost employees)
-- `PARTNER_USER_PROD_API_KEY` (eg: creating a referral user)
-- `REFERRAL_USER_PROD_API_KEY` (eg: adding a credit card to a referral user)
+- `PARTNER_USER_PROD_API_KEY` (eg: creating a referral customer)
+- `REFERRAL_CUSTOMER_PROD_API_KEY` (eg: adding a credit card to a referral customer)

data/VERSION

@@ -1 +1 @@
-4.8.1
+4.10.0

data/docs/EasyPost/Address.html

@@ -0,0 +1,222 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class EasyPost::Address - EasyPost Ruby Docs</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../";
+  var index_rel_prefix = "../";
+</script>
+
+<script src="../js/navigation.js" defer></script>
+<script src="../js/search.js" defer></script>
+<script src="../js/search_index.js" defer></script>
+<script src="../js/searcher.js" defer></script>
+<script src="../js/darkfish.js" defer></script>
+
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="../index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="../table_of_contents.html#pages">Pages</a>
+    <a href="../table_of_contents.html#classes">Classes</a>
+    <a href="../table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    
+<div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  <p class="link"><a href="Resource.html">EasyPost::Resource</a>
+</div>
+
+    
+    
+    
+<!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+  <h3>Methods</h3>
+
+  <ul class="link-list" role="directory">
+    <li ><a href="#method-c-create">::create</a>
+    <li ><a href="#method-c-create_and_verify">::create_and_verify</a>
+    <li ><a href="#method-i-verify">#verify</a>
+  </ul>
+</div>
+
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-EasyPost::Address">
+  <h1 id="class-EasyPost::Address" class="class">
+    class EasyPost::Address
+  </h1>
+
+  <section class="description">
+    
+<p><a href="Address.html"><code>Address</code></a> objects are used to represent people, places, and organizations in a number of contexts.</p>
+
+  </section>
+
+  <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+    <section class="attribute-method-details" class="method-section">
+      <header>
+        <h3>Attributes</h3>
+      </header>
+
+      <div id="attribute-i-message" class="method-detail">
+        <div class="method-heading attribute-method-heading">
+          <span class="method-name">message</span><span
+            class="attribute-access-type">[RW]</span>
+        </div>
+
+        <div class="method-description">
+        
+        </div>
+      </div>
+    </section>
+
+
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Class Methods</h3>
+       </header>
+
+      <div id="method-c-create" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">create</span><span
+            class="method-args">(params = {}, api_key = nil)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+
+        <div class="method-description">
+          <p>Create an <a href="Address.html"><code>Address</code></a>.</p>
+
+          <div class="method-source-code" id="create-source">
+            <pre><span class="ruby-comment"># File lib/easypost/address.rb, line 8</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">create</span>(<span class="ruby-identifier">params</span> = {}, <span class="ruby-identifier">api_key</span> = <span class="ruby-keyword">nil</span>)
+  <span class="ruby-identifier">address</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">reject</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">_</span><span class="ruby-operator">|</span> [<span class="ruby-value">:verify</span>, <span class="ruby-value">:verify_strict</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">k</span>) }
+
+  <span class="ruby-identifier">wrapped_params</span> = { <span class="ruby-value">address:</span> <span class="ruby-identifier">address</span> }
+
+  <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:verify</span>]
+    <span class="ruby-identifier">wrapped_params</span>[<span class="ruby-value">:verify</span>] = <span class="ruby-identifier">params</span>[<span class="ruby-value">:verify</span>]
+  <span class="ruby-keyword">end</span>
+
+  <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:verify_strict</span>]
+    <span class="ruby-identifier">wrapped_params</span>[<span class="ruby-value">:verify_strict</span>] = <span class="ruby-identifier">params</span>[<span class="ruby-value">:verify_strict</span>]
+  <span class="ruby-keyword">end</span>
+
+  <span class="ruby-identifier">response</span> = <span class="ruby-constant">EasyPost</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:post</span>, <span class="ruby-identifier">url</span>, <span class="ruby-identifier">api_key</span>, <span class="ruby-identifier">wrapped_params</span>)
+  <span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">convert_to_easypost_object</span>(<span class="ruby-identifier">response</span>, <span class="ruby-identifier">api_key</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+
+
+      </div>
+
+      <div id="method-c-create_and_verify" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">create_and_verify</span><span
+            class="method-args">(params = {}, api_key = nil)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+
+        <div class="method-description">
+          <p>Create and verify an <a href="Address.html"><code>Address</code></a> in one call.</p>
+
+          <div class="method-source-code" id="create_and_verify-source">
+            <pre><span class="ruby-comment"># File lib/easypost/address.rb, line 26</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">create_and_verify</span>(<span class="ruby-identifier">params</span> = {}, <span class="ruby-identifier">api_key</span> = <span class="ruby-keyword">nil</span>)
+  <span class="ruby-identifier">wrapped_params</span> = {}
+  <span class="ruby-identifier">wrapped_params</span>[<span class="ruby-identifier">class_name</span>.<span class="ruby-identifier">to_sym</span>] = <span class="ruby-identifier">params</span>
+  <span class="ruby-identifier">response</span> = <span class="ruby-constant">EasyPost</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:post</span>, <span class="ruby-node">&quot;#{url}/create_and_verify&quot;</span>, <span class="ruby-identifier">api_key</span>, <span class="ruby-identifier">wrapped_params</span>)
+
+  <span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">convert_to_easypost_object</span>(<span class="ruby-identifier">response</span>[<span class="ruby-string">&#39;address&#39;</span>], <span class="ruby-identifier">api_key</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+
+
+      </div>
+
+    </section>
+
+     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Instance Methods</h3>
+       </header>
+
+      <div id="method-i-verify" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">verify</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+
+        <div class="method-description">
+          <p>Verify an <a href="Address.html"><code>Address</code></a>.</p>
+
+          <div class="method-source-code" id="verify-source">
+            <pre><span class="ruby-comment"># File lib/easypost/address.rb, line 35</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">verify</span>
+  <span class="ruby-identifier">response</span> = <span class="ruby-constant">EasyPost</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:get</span>, <span class="ruby-node">&quot;#{url}/verify&quot;</span>, <span class="ruby-ivar">@api_key</span>)
+
+  <span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">convert_to_easypost_object</span>(<span class="ruby-identifier">response</span>[<span class="ruby-string">&#39;address&#39;</span>], <span class="ruby-identifier">api_key</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+
+
+      </div>
+
+    </section>
+
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+

data/docs/EasyPost/ApiKey.html

@@ -0,0 +1,99 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class EasyPost::ApiKey - EasyPost Ruby Docs</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../";
+  var index_rel_prefix = "../";
+</script>
+
+<script src="../js/navigation.js" defer></script>
+<script src="../js/search.js" defer></script>
+<script src="../js/search_index.js" defer></script>
+<script src="../js/searcher.js" defer></script>
+<script src="../js/darkfish.js" defer></script>
+
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="../index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="../table_of_contents.html#pages">Pages</a>
+    <a href="../table_of_contents.html#classes">Classes</a>
+    <a href="../table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    
+<div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  <p class="link"><a href="Resource.html">EasyPost::Resource</a>
+</div>
+
+    
+    
+    
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-EasyPost::ApiKey">
+  <h1 id="class-EasyPost::ApiKey" class="class">
+    class EasyPost::ApiKey
+  </h1>
+
+  <section class="description">
+    
+<p>An <a href="ApiKey.html"><code>ApiKey</code></a> allows you to authenticate with the <a href="../EasyPost.html"><code>EasyPost</code></a> API.</p>
+
+  </section>
+
+  <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+