easypost 4.4.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c07c842f7ff2eb209a6f447259afce469b6e1f0f481ea2bf68585869167ea8f9
-  data.tar.gz: 0ffb89bcb615cd1835f12e70d3c23ffa9ca9033daddddaad9db20a363f483212
+  metadata.gz: 16942dad76e2a3abbfa17dacaaa75f391f65a04a4daaea979bbba2c0e308ac30
+  data.tar.gz: 90d5b71e9c45c952296ed1dcb3769d1d69902c2917dc4a8fa1ca6842e5918129
 SHA512:
-  metadata.gz: f03686d79b7d2023c26dc3c69362955465f3f99efc9b666d101a3499697ed155061afa2e8a47767bd83ae78bdd265d5363339ad4fb7686f47e5cff472483fa6a
-  data.tar.gz: 25f79bcc1b8c745ae9556c675d3aad56a06518853b4389081325170d2c1c1e425906bb8ded8925d40805ef961c5ccea3394da7bfe1f845117a8701f80526d526
+  metadata.gz: 9a91982b9ed19df4cf8ddea05d6da1a43d6caf86e6b49d67cf54d32ba71632e06d89822f695016d30e14a4f3577e600ebba29adedf38ed0c18797413c7589c80
+  data.tar.gz: 83201c6700dfdff58ca200780efdc83272fe3943a071879529ddb3a9ee8d526e505219c0584a8b91571400e3330be53f4aeefc568efdb5717f35df522a6b62fb

data/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Ping the DevEx team for reviews on every PR
+* @EasyPost/devex

data/.rubocop.yml

@@ -3,3 +3,7 @@ inherit_from: easycop.yml
 # We are ignoring RSpec/FilePath because Simplecov doesn't play nice with nested spec files
 RSpec/FilePath:
   Enabled: false
+# TODO: Remove this once we start using keyword arguments
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'lib/easypost/shipment.rb'

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## v4.6.0 (2022-08-02)
+
+- Adds Carbon Offset support
+  - Adds ability to create a shipment with carbon_offset
+  - Adds ability to buy a shipment with carbon_offset
+  - Adds ability to one-call-buy a shipment with carbon_offset
+  - Adds ability to rerate a shipment with carbon_offset
+- Adds `validate_webhook` function that returns your webhook or raises an error if there is a `webhook_secret` mismatch
+- Deprecated `PaymentMethod` class, please use `Billing` class for retrieve all payment method function
+
+## v4.5.0 (2022-07-18)
+
+- Adds ability to generate shipment forms via `generate_form` function
+
 ## v4.4.0 (2022-07-11)
 
 - Adds `Billing.retrieve_payment_methods()`, `Billing.fund_wallet()`, and `Billing.delete_payment_method()` functions

data/VERSION

@@ -1 +1 @@
-4.4.0
+4.6.0

data/lib/easypost/carbon_offset.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# The CarbonOffset object is a summary of carbon offset data for a given rate, including grams, price and currency
+class EasyPost::CarbonOffset < EasyPost::Resource
+end

data/lib/easypost/payment_method.rb

@@ -2,14 +2,10 @@
 
 # PaymentMethod objects represent a payment method of a user.
 class EasyPost::PaymentMethod < EasyPost::Resource
-  # Retrieve all payment methods.
+  # <b>DEPRECATED:</b> Please use <tt>Billing class</tt> instead.
+  # Deprecated: v4.5.0 - v6.0.0
   def self.all(api_key = nil)
-    response = EasyPost.make_request(:get, url, api_key)
-
-    if response['id'].nil?
-      raise EasyPost::Error.new('Billing has not been setup for this user. Please add a payment method.')
-    end
-
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
+    warn '[DEPRECATION] `all` is deprecated.  Please use `Billing.retrieve_payment_methods` instead.'
+    EasyPost::Billing.retrieve_payment_methods(api_key)
   end
 end

data/lib/easypost/shipment.rb

@@ -5,8 +5,22 @@ require 'set'
 # The workhorse of the EasyPost API, a Shipment is made up of a "to" and "from" Address, the Parcel
 # being shipped, and any customs forms required for international deliveries.
 class EasyPost::Shipment < EasyPost::Resource
+  # Create a Shipment.
+  def self.create(params = {}, api_key = nil, with_carbon_offset = false)
+    wrapped_params = {
+      shipment: params,
+      carbon_offset: with_carbon_offset,
+    }
+
+    response = EasyPost.make_request(:post, url, api_key, wrapped_params)
+    EasyPost::Util.convert_to_easypost_object(response, api_key)
+  end
+
   # Regenerate the rates of a Shipment.
-  def regenerate_rates(params = {})
+  def regenerate_rates(with_carbon_offset = false)
+    params = {}
+    params[:carbon_offset] = with_carbon_offset
+
     response = EasyPost.make_request(:post, "#{url}/rerate", @api_key, params)
     refresh_from(response, @api_key)
 
@@ -21,13 +35,15 @@ class EasyPost::Shipment < EasyPost::Resource
   end
 
   # Buy a Shipment.
-  def buy(params = {})
+  def buy(params = {}, with_carbon_offset = false)
     if params.instance_of?(EasyPost::Rate)
       temp = params.clone
       params = {}
       params[:rate] = temp
     end
 
+    params[:carbon_offset] = with_carbon_offset
+
     response = EasyPost.make_request(:post, "#{url}/buy", @api_key, params)
     refresh_from(response, @api_key)
 
@@ -112,4 +128,19 @@ class EasyPost::Shipment < EasyPost::Resource
 
     lowest_smartrate
   end
+
+  # Generate a form for a Shipment.
+  def generate_form(form_type, form_options = {})
+    params = {}
+    params[:type] = form_type
+    merged_params = params.merge(form_options)
+    wrapped_params = {
+      form: merged_params,
+    }
+
+    response = EasyPost.make_request(:post, "#{url}/forms", @api_key, wrapped_params)
+    refresh_from(response, @api_key)
+
+    self
+  end
 end

data/lib/easypost/util.rb

@@ -37,6 +37,7 @@ module EasyPost::Util
     'Address' => EasyPost::Address,
     'Batch' => EasyPost::Batch,
     'Brand' => EasyPost::Brand,
+    'CarbonOffset' => EasyPost::CarbonOffset,
     'CarrierAccount' => EasyPost::CarrierAccount,
     'CustomsInfo' => EasyPost::CustomsInfo,
     'CustomsItem' => EasyPost::CustomsItem,

data/lib/easypost/webhook.rb

@@ -32,4 +32,26 @@ class EasyPost::Webhook < EasyPost::Resource
 
     self
   end
+
+  # Validate a webhook by comparing the HMAC signature header sent from EasyPost to your shared secret.
+  # If the signatures do not match, an error will be raised signifying the webhook either did not originate
+  # from EasyPost or the secrets do not match. If the signatures do match, the `event_body` will be returned
+  # as JSON.
+  def self.validate_webhook(event_body, headers, webhook_secret)
+    easypost_hmac_signature = headers['X-Hmac-Signature']
+
+    if easypost_hmac_signature.nil?
+      raise EasyPost::Error.new('Webhook received does not contain an HMAC signature.')
+    end
+
+    encoded_webhook_secret = webhook_secret.unicode_normalize(:nfkd).encode('utf-8')
+
+    expected_signature = OpenSSL::HMAC.hexdigest('sha256', encoded_webhook_secret, event_body)
+    digest = "hmac-sha256-hex=#{expected_signature}"
+    unless digest == easypost_hmac_signature
+      raise EasyPost::Error.new('Webhook received did not originate from EasyPost or had a webhook secret mismatch.')
+    end
+
+    JSON.parse(event_body)
+  end
 end

data/lib/easypost.rb

@@ -16,6 +16,7 @@ require 'easypost/api_key'
 require 'easypost/batch'
 require 'easypost/billing'
 require 'easypost/brand'
+require 'easypost/carbon_offset'
 require 'easypost/carrier_account'
 require 'easypost/carrier_type'
 require 'easypost/customs_info'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.6.0
 platform: ruby
 authors:
 - EasyPost Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-11 00:00:00.000000000 Z
+date: 2022-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brakeman
@@ -158,6 +158,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitattributes"
+- ".github/CODEOWNERS"
 - ".github/ISSUE_TEMPLATE/bug_report.yml"
 - ".github/ISSUE_TEMPLATE/feature_request.yml"
 - ".github/PULL_REQUEST_TEMPLATE.md"
@@ -188,6 +189,7 @@ files:
 - lib/easypost/beta/referral.rb
 - lib/easypost/billing.rb
 - lib/easypost/brand.rb
+- lib/easypost/carbon_offset.rb
 - lib/easypost/carrier_account.rb
 - lib/easypost/carrier_type.rb
 - lib/easypost/connection.rb