easypost 4.2.1 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9106fd21b72e0361b541741ba63630f8a2edb3d51cc2c911af06a2bd55c413df
-  data.tar.gz: 9333539ff70f45618cb81b83dc427469048f7f2585deeb2ea044983dfa7b2955
+  metadata.gz: '02404008f0fc1078e49e1e418c5a208fbca5d646f31886c3c7fab55d932def70'
+  data.tar.gz: b8a2f7d514f9f22fa5b7ec3daf010adbfcc793c689954102b6ccbaafd7742e6a
 SHA512:
-  metadata.gz: d59cd4adcf74d2018d6a76bedfc583d9b0cc79c88a28742c0cffb12fa5756552c99cc30e1c720e29f9b26ca4063b93873a5faf82d8adbdca1c9731005e75ff88
-  data.tar.gz: ebce5da4126834f9b76c67b6912717047b8396eed2a51be10e0057860b4268487f3ff91eb7857b88976e0402bc352220af984cebd280774470de22cdca418f4c
+  metadata.gz: f6c9af835a6ff8ccb7574fd5a14ef96f850784e6600249a8441d23a521763ad3fb40d826cdce0f758cd4b87213a65c6ee733476d34824dabbb7fb09db2af0de0
+  data.tar.gz: c492ad0635133598e8535a2a0c72949b0acd6f0095b511bb91011c50cec67e6d8999b5358da8aa7ae4543e38a30bc029367d8c0cfd791e4944f46fac3cdf75d9

data/.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
           ruby-version: ${{ matrix.rubyversion }}
           bundler-cache: true
       - name: run tests
-        run: bundle exec rspec
+        run: EASYPOST_TEST_API_KEY=123 EASYPOST_PROD_API_KEY=123 bundle exec rspec
   lint:
     runs-on: ubuntu-latest
     steps:

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## v4.3.0 (2022-05-19)
+
+- Adds the `EndShipper` Beta class with `create`, `retrieve`, `all`, and `save` functions
+- Requests will now fail fast with an error if an API key is not provided instead of making a live API call with no key
+- Fixes a bug where the library could not properly parse the response of deleting a child user
+- Fixes a bug where you could not update a webhook due to a `wrong number of arguments` error
+
 ## v4.2.1 (2022-05-11)
 
 - Corrects the `Beta` namespace for the new Referral class

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://github.com/EasyPost/easypost-ruby/workflows/CI/badge.svg)](https://github.com/EasyPost/easypost-ruby/actions?query=workflow%3ACI)
 [![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.
+EasyPost, the simple shipping solution. You can sign up for an account at <https://easypost.com>.
 
 ## Install
 
@@ -110,7 +110,7 @@ end
 
 ## Documentation
 
-API Documentation can be found at: https://easypost.com/docs/api.
+API Documentation can be found at: <https://easypost.com/docs/api>.
 
 ## Development
 
@@ -126,8 +126,22 @@ EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... bundle exec rspec
 
 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 make an addition to this project, the request/response will get recorded automatically for you. When making changes to this project, you'll need to re-record the associated cassette to force a new live API call for that test which will then record the request/response used on the next run.
+**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.
 
-The test suite has been populated with various helpful fixtures that are available for use, each completely independent from a particular user **with the exception of the USPS carrier account ID** which has a fallback value to our internal testing user's ID. If you are a non-EasyPost employee and are re-recording cassettes, you may need to provide the `USPS_CARRIER_ACCOUNT_ID` environment variable with the ID associated with your USPS account (which will be associated with your API keys in use) for tests that use this fixture.
+**Making Changes:** If you make an addition to this project, the request/response will get recorded automatically for you. When making changes to this project, you'll need to re-record the associated cassette to force a new live API call for that test which will then record the request/response used on the next run.
 
-**Note on dates:** Some fixtures use hard-coded dates that may need to be incremented if cassettes get re-recorded (such as reports or pickups).
+**Test Data:** The test suite has been populated with various helpful fixtures that are available for use, each completely independent from a particular user **with the exception of the USPS carrier account ID** (see [Unit Test API Keys](#unit-test-api-keys) for more information) which has a fallback value of our internal testing user's ID. Some fixtures use hard-coded dates that may need to be incremented if cassettes get re-recorded (such as reports or pickups).
+
+#### Unit Test API Keys
+
+The following are required on every test run:
+
+- `EASYPOST_TEST_API_KEY`
+- `EASYPOST_PROD_API_KEY`
+
+The following are required when you need to re-record cassettes for applicable tests (fallback values are used otherwise):
+
+- `USPS_CARRIER_ACCOUNT_ID` (eg: one-call buying a shipment for non-EasyPost employees)
+- `REFERRAL_USER_PROD_API_KEY` (eg: adding a credit card to a referral user)
+
+Some tests may require a 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.

data/VERSION

@@ -1 +1 @@
-4.2.1
+4.3.0

data/lib/easypost/beta/end_shipper.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# EndShipper objects are fully-qualified Address objects that require all parameters and get verified upon creation.
+class EasyPost::Beta::EndShipper < EasyPost::Resource
+  # Create an EndShipper object.
+  def self.create(params = {}, api_key = nil)
+    response = EasyPost.make_request(:post, '/beta/end_shippers', api_key, { address: params })
+    EasyPost::Util.convert_to_easypost_object(response, api_key)
+  end
+
+  # Retrieves an EndShipper object.
+  def self.retrieve(id, params = {}, api_key = nil)
+    response = EasyPost.make_request(:get, "/beta/end_shippers/#{id}", api_key, params)
+    EasyPost::Util.convert_to_easypost_object(response, api_key)
+  end
+
+  # Retrieves a list of EndShipper objects.
+  def self.all(params = {}, api_key = nil)
+    response = EasyPost.make_request(:get, '/beta/end_shippers', api_key, params)
+    EasyPost::Util.convert_to_easypost_object(response, api_key)
+  end
+
+  # Updates (saves) an EndShipper object. This requires all parameters to be set.
+  def save
+    if @unsaved_values.length.positive?
+      values = {}
+      @unsaved_values.each { |k| values[k] = @values[k] }
+
+      wrapped_params = { address: values }
+
+      response = EasyPost.make_request(:put, "/beta/end_shippers/#{id}", @api_key, wrapped_params)
+      refresh_from(response, api_key)
+    end
+    self
+  end
+end

data/lib/easypost/beta/referral.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Referral objects are User objects created from a Partner user.
 class EasyPost::Beta::Referral < EasyPost::Resource
   # Create a referral user. This function requires the Partner User's API key.
   def self.create(params = {}, api_key = nil)
@@ -14,7 +15,7 @@ class EasyPost::Beta::Referral < EasyPost::Resource
         email: email,
       },
     }
-    _ = EasyPost.make_request(:put, "/beta/referral_customers/#{user_id}", api_key, wrapped_params)
+    EasyPost.make_request(:put, "/beta/referral_customers/#{user_id}", api_key, wrapped_params)
 
     # return true if API succeeds, else an error is throw if it fails.
     true

data/lib/easypost/beta.rb

@@ -3,4 +3,5 @@
 module EasyPost::Beta
 end
 
+require_relative 'beta/end_shipper'
 require_relative 'beta/referral'

data/lib/easypost/connection.rb

@@ -10,6 +10,10 @@ EasyPost::Connection = Struct.new(:uri, :config, keyword_init: true) do
   # @raise [EasyPost::Error] if the response has a non-2xx status code
   # @return [Hash] JSON object parsed from the response body
   def call(method, path, api_key = nil, body = nil)
+    if api_key.nil?
+      raise EasyPost::Error, 'No API key provided.'
+    end
+
     connection =
       if config[:proxy]
         proxy_uri = URI(config[:proxy])
@@ -51,11 +55,12 @@ EasyPost::Connection = Struct.new(:uri, :config, keyword_init: true) do
     request['Authorization'] = EasyPost.authorization(api_key) if api_key
 
     response = connection.request(request)
+    response_is_json = response['Content-Type'] ? response['Content-Type'].start_with?('application/json') : false
 
     EasyPost.parse_response(
       status: response.code.to_i,
       body: response.body,
-      json: response['Content-Type'].start_with?('application/json'),
+      json: response_is_json,
     )
   end
 end

data/lib/easypost/user.rb

@@ -22,6 +22,12 @@ class EasyPost::User < EasyPost::Resource
     self
   end
 
+  # Delete a User.
+  def delete
+    EasyPost.make_request(:delete, url, @api_key)
+    self
+  end
+
   # Retrieve the authenticated User.
   def self.retrieve_me
     all

data/lib/easypost/util.rb

@@ -62,6 +62,7 @@ module EasyPost::Util
       'CarrierAccount' => EasyPost::CarrierAccount,
       'CustomsInfo' => EasyPost::CustomsInfo,
       'CustomsItem' => EasyPost::CustomsItem,
+      'EndShipper' => EasyPost::Beta::EndShipper,
       'Event' => EasyPost::Event,
       'Insurance' => EasyPost::Insurance,
       'Order' => EasyPost::Order,
@@ -71,14 +72,15 @@ module EasyPost::Util
       'PickupRate' => EasyPost::PickupRate,
       'PostageLabel' => EasyPost::PostageLabel,
       'Rate' => EasyPost::Rate,
+      'Referral' => EasyPost::Beta::Referral,
       'Refund' => EasyPost::Refund,
       'RefundReport' => EasyPost::Report,
       'Report' => EasyPost::Report,
       'ScanForm' => EasyPost::ScanForm,
       'Shipment' => EasyPost::Shipment,
-      'TaxIdentifier' => EasyPost::TaxIdentifier,
       'ShipmentInvoiceReport' => EasyPost::Report,
       'ShipmentReport' => EasyPost::Report,
+      'TaxIdentifier' => EasyPost::TaxIdentifier,
       'Tracker' => EasyPost::Tracker,
       'TrackerReport' => EasyPost::Report,
       'User' => EasyPost::User,
@@ -92,6 +94,7 @@ module EasyPost::Util
       'ca' => EasyPost::CarrierAccount,
       'cstinfo' => EasyPost::CustomsInfo,
       'cstitem' => EasyPost::CustomsItem,
+      'es' => EasyPost::Beta::EndShipper,
       'evt' => EasyPost::Event,
       'hook' => EasyPost::Webhook,
       'ins' => EasyPost::Insurance,

data/lib/easypost/webhook.rb

@@ -13,7 +13,7 @@ class EasyPost::Webhook < EasyPost::Resource
     instance_url = "#{self.class.url}/#{CGI.escape(id)}"
 
     response = EasyPost.make_request(:put, instance_url, @api_key, params)
-    refresh_from(response, api_key, true)
+    refresh_from(response, api_key)
 
     self
   end

data/lib/easypost.rb

@@ -134,7 +134,7 @@ module EasyPost
       )
     end
 
-    json ? JSON.parse(body) : body
+    json || !body.nil? && !body.match(/\A\s+\z/) ? JSON.parse(body) : body
   rescue JSON::ParserError
     raise "Invalid response object from API, unable to decode.\n#{body}"
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.3.0
 platform: ruby
 authors:
 - EasyPost Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-11 00:00:00.000000000 Z
+date: 2022-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -168,6 +168,7 @@ files:
 - lib/easypost/api_key.rb
 - lib/easypost/batch.rb
 - lib/easypost/beta.rb
+- lib/easypost/beta/end_shipper.rb
 - lib/easypost/beta/referral.rb
 - lib/easypost/brand.rb
 - lib/easypost/carrier_account.rb