easypost 4.4.0 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c07c842f7ff2eb209a6f447259afce469b6e1f0f481ea2bf68585869167ea8f9
-  data.tar.gz: 0ffb89bcb615cd1835f12e70d3c23ffa9ca9033daddddaad9db20a363f483212
+  metadata.gz: e9995cfcc5bc7cce1ebefa6343fc31ba18f6f0f4b36dfb7502225b7abb1b40f8
+  data.tar.gz: 64d814764933ba53e3de2b01f39ba6fd2195a3a65ec4ec6c01b720078750fc42
 SHA512:
-  metadata.gz: f03686d79b7d2023c26dc3c69362955465f3f99efc9b666d101a3499697ed155061afa2e8a47767bd83ae78bdd265d5363339ad4fb7686f47e5cff472483fa6a
-  data.tar.gz: 25f79bcc1b8c745ae9556c675d3aad56a06518853b4389081325170d2c1c1e425906bb8ded8925d40805ef961c5ccea3394da7bfe1f845117a8701f80526d526
+  metadata.gz: 44179f3818dd5d9098eed96f3263b12a67dd7ec415c49fb9efc976b07b858e63ed326c68b0a07415a62da8311cd5b4e72c406bf6650e197ad69956c674b03d76
+  data.tar.gz: 86007bac46665593dc205c9c231409698401af9b58da3d2d22049c0510b29528303a625c2be2945814ceffd7ee93838049dba5a8a34dcbf3afe3879f583cee80

data/.github/CODEOWNERS

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

data/.github/workflows/ci.yml

@@ -19,6 +19,8 @@ jobs:
         with:
           ruby-version: ${{ matrix.rubyversion }}
           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
   lint:
@@ -35,4 +37,4 @@ jobs:
       - name: Lint Project
         run: make lint
       - name: Run security analysis
-        run: make brakeman
+        run: make scan

data/.gitignore

@@ -13,6 +13,7 @@ test/tmp
 test/version_tmp
 tmp
 .idea/
+dist
 
 # YARD artifacts
 .yardoc

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "examples"]
+	path = examples
+	url = https://github.com/EasyPost/examples

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,24 @@
 # CHANGELOG
 
+## v4.7.0 (2022-08-25)
+
+- Moves EndShipper out of beta to the general library namespace
+- Ensure the Easypost object will respond to `.id` when it has one in @values
+
+## 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/Makefile

@@ -2,17 +2,15 @@
 help:
 	@cat Makefile | grep '^## ' --color=never | cut -c4- | sed -e "`printf 's/ - /\t- /;'`" | column -s "`printf '\t'`" -t
 
-## brakeman - Runs security analysis on the project with Brakeman
-brakeman:
-	brakeman lib --force
-
 ## build - Builds the project
 build:
-	gem build easypost.gemspec
+	gem build easypost.gemspec --strict
+	mkdir -p dist
+	mv *.gem dist/
 
 ## clean - Cleans the project
 clean:
-	rm -rf coverage doc *.gem
+	rm -rf coverage doc *.gem dist
 
 ## fix - Fix Rubocop errors
 fix:
@@ -20,18 +18,34 @@ fix:
 
 ## install - Install globally from source
 install:
+	git submodule init
+	git submodule update
 	bundle install
 
 ## lint - Lint the project
 lint:
 	rubocop
 
-## push - Pushes the built gem to Rubygems
-push:
-	gem push *.gem
+## publish - Publishes the built gem to Rubygems
+publish:
+	gem push dist/*.gem
+
+## release - Cuts a release for the project on GitHub (requires GitHub CLI)
+# tag = The associated tag title of the release
+release:
+	gh release create ${tag} dist/*
+
+## scan - Runs security analysis on the project with Brakeman
+scan:
+	brakeman lib --force
 
 ## test - Test the project
 test:
 	bundle exec rspec
 
-.PHONY: help build clean fix install lint push test
+## update - Updates dependencies
+update:
+	git submodule init
+	git submodule update --remote
+
+.PHONY: help build clean fix install lint publish release scan test update

data/README.md

@@ -121,8 +121,18 @@ make install
 # Lint project
 make lint
 
+# Fix linting errors
+make fix
+
 # Run tests (coverage is generated on a successful test suite run)
 EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make test
+
+# Run security analysis
+make scan
+
+# Update submodules
+git submodule init
+git submodule update --remote
 ```
 
 ### Testing
@@ -142,9 +152,8 @@ 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):
+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)
-
-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.4.0
+4.7.0

data/lib/easypost/beta/end_shipper.rb

@@ -2,26 +2,30 @@
 
 # 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.
+  # <b>DEPRECATED:</b> Please use <tt>EndShipper</tt> in the main namespace instead.
   def self.create(params = {}, api_key = nil)
+    warn '[DEPRECATION] Please use `EndShipper.create` in the main namespace instead.'
     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)
+    warn '[DEPRECATION] Please use `EndShipper.retrieve` in the main namespace instead.'
     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)
+    warn '[DEPRECATION] Please use `EndShipper.all` in the main namespace instead.'
     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
+    warn '[DEPRECATION] Please use `endShipper.save` in the main namespace instead.'
     if @unsaved_values.length.positive?
       values = {}
       @unsaved_values.each { |k| values[k] = @values[k] }

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# EndShipper objects are fully-qualified Address objects that require all parameters and get verified upon creation.
+class EasyPost::EndShipper < EasyPost::Resource
+  # Create an EndShipper object.
+  def self.create(params = {}, api_key = nil)
+    response = EasyPost.make_request(:post, url, api_key, { address: 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, url, @api_key, wrapped_params)
+      refresh_from(response, api_key)
+    end
+    self
+  end
+end

data/lib/easypost/object.rb

@@ -49,14 +49,18 @@ class EasyPost::EasyPostObject
       add_accessors(added)
     end
 
-    # IDs don't change, do not update it
-    @values.delete(:id)
+    # IDs should never change. But to be safe, only delete if they are different.
+    @values.delete(:id) if values[:id] != @values[:id]
 
     values.each do |k, v|
       @values[k.to_s] = EasyPost::Util.convert_to_easypost_object(v, api_key, self, k)
       @transient_values.delete(k)
       @unsaved_values.delete(k)
     end
+
+    return if @values[:id] || (values[:id].nil? && values['id'].nil?)
+
+    @values[:id] = values[:id] || values['id']
   end
 
   # Get element of an array.

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

@@ -11,7 +11,7 @@ module EasyPost::Util
     'ca' => EasyPost::CarrierAccount,
     'cstinfo' => EasyPost::CustomsInfo,
     'cstitem' => EasyPost::CustomsItem,
-    'es' => EasyPost::Beta::EndShipper,
+    'es' => EasyPost::EndShipper,
     'evt' => EasyPost::Event,
     'hook' => EasyPost::Webhook,
     'ins' => EasyPost::Insurance,
@@ -37,10 +37,11 @@ module EasyPost::Util
     'Address' => EasyPost::Address,
     'Batch' => EasyPost::Batch,
     'Brand' => EasyPost::Brand,
+    'CarbonOffset' => EasyPost::CarbonOffset,
     'CarrierAccount' => EasyPost::CarrierAccount,
     'CustomsInfo' => EasyPost::CustomsInfo,
     'CustomsItem' => EasyPost::CustomsItem,
-    'EndShipper' => EasyPost::Beta::EndShipper,
+    'EndShipper' => EasyPost::EndShipper,
     'Event' => EasyPost::Event,
     'Insurance' => EasyPost::Insurance,
     'Order' => EasyPost::Order,

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,10 +16,12 @@ 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'
 require 'easypost/customs_item'
+require 'easypost/end_shipper'
 require 'easypost/event'
 require 'easypost/insurance'
 require 'easypost/order'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.7.0
 platform: ruby
 authors:
 - EasyPost Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-11 00:00:00.000000000 Z
+date: 2022-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brakeman
@@ -158,11 +158,13 @@ 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"
 - ".github/workflows/ci.yml"
 - ".gitignore"
+- ".gitmodules"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -188,11 +190,13 @@ 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
 - lib/easypost/customs_info.rb
 - lib/easypost/customs_item.rb
+- lib/easypost/end_shipper.rb
 - lib/easypost/error.rb
 - lib/easypost/event.rb
 - lib/easypost/insurance.rb