easypost 4.6.0 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16942dad76e2a3abbfa17dacaaa75f391f65a04a4daaea979bbba2c0e308ac30
-  data.tar.gz: 90d5b71e9c45c952296ed1dcb3769d1d69902c2917dc4a8fa1ca6842e5918129
+  metadata.gz: e9995cfcc5bc7cce1ebefa6343fc31ba18f6f0f4b36dfb7502225b7abb1b40f8
+  data.tar.gz: 64d814764933ba53e3de2b01f39ba6fd2195a3a65ec4ec6c01b720078750fc42
 SHA512:
-  metadata.gz: 9a91982b9ed19df4cf8ddea05d6da1a43d6caf86e6b49d67cf54d32ba71632e06d89822f695016d30e14a4f3577e600ebba29adedf38ed0c18797413c7589c80
-  data.tar.gz: 83201c6700dfdff58ca200780efdc83272fe3943a071879529ddb3a9ee8d526e505219c0584a8b91571400e3330be53f4aeefc568efdb5717f35df522a6b62fb
+  metadata.gz: 44179f3818dd5d9098eed96f3263b12a67dd7ec415c49fb9efc976b07b858e63ed326c68b0a07415a62da8311cd5b4e72c406bf6650e197ad69956c674b03d76
+  data.tar.gz: 86007bac46665593dc205c9c231409698401af9b58da3d2d22049c0510b29528303a625c2be2945814ceffd7ee93838049dba5a8a34dcbf3afe3879f583cee80

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/CHANGELOG.md

@@ -1,5 +1,10 @@
 # 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

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.6.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/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/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,
@@ -41,7 +41,7 @@ module EasyPost::Util
     '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.rb

@@ -21,6 +21,7 @@ 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.6.0
+  version: 4.7.0
 platform: ruby
 authors:
 - EasyPost Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-02 00:00:00.000000000 Z
+date: 2022-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brakeman
@@ -164,6 +164,7 @@ files:
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/workflows/ci.yml"
 - ".gitignore"
+- ".gitmodules"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -195,6 +196,7 @@ files:
 - 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