easypost 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db8276b780ceb6bde1e8b72185385da6458cb152babd4bccf3b1f75e5da4af93
-  data.tar.gz: 103f3173ab91f5521204aee15694a31a7bb61875a955967049342ca250f04813
+  metadata.gz: 31efd6b963670a4dc229385c0ca537e37c55adaeb8174b7a55d048fcb66ee09d
+  data.tar.gz: 724dfd0bc8dc98ff5c5a7a9c91e1be3adc2f5160f9a7d32827c55e2b0b029993
 SHA512:
-  metadata.gz: 3b4bff8f08265b7821605dec9ea8ee2b8de3261975dbe860ee33aa0746bfb2238c615d527a8db9b51716886845229437f535e8d41e541285e04cf97102120f20
-  data.tar.gz: e0828a81e8c006ba589fe899cff31d3fe67bbf6e77577c44224224bf818d4650ebe8c76fe6f014fd3d00330c4f9974d8f9dda5fe79ee90dadc45ceefb3cd6a10
+  metadata.gz: 1bcb89b64cade19b65e91b29223329d3d0353b856b056e65690cd3d0e1ea155a548a73fc8c7e5b4a17ffae034b7bd23f5c36abf76ff974a5e615c7fa6fb05dc0
+  data.tar.gz: cfe4bb3cc5cc89e4e9f165cc17d1bfe91f4f583d535883510d3ed8088ce690709acca8de0d66573dfd5e8f6cc10fc97a21586b2f4dbb61c34854cc3ca089cb23

data/{CHANGELOG → CHANGELOG.md}

@@ -1,221 +1,243 @@
-=== 3.3.0 2021-06-10
+# CHANGELOG
+
+
+## 3.4.0 2021-07-13
+
+* Removed deprecated `Item` object
+* Sorted EasyPost Resources list
+* Remove 2015-vintage experimental `all_updated` method on Tracker
+* Fixes API key retrieval (#120, thanks @andychongyz)
+* Adds `regenerate_rates` method for new rerate API
+* Adds `deconstruct_keys` method to allow for pattern matching on EasyPost objects
+
+
+## 3.3.0 2021-06-10
 
 * Adds `SmartRate` functionality to the `Shipments` object (available by calling `get_smartrates` on a shipment)
 * Fix bug where `EasyPost::CarrierAccount.types` was hitting the wrong endpoint
 
-=== 3.2.0 2021-01-14
+
+## 3.2.0 2021-01-14
 
 * Replace Travis CI with Github Actions
 * Add Ruby 3.0 to supported platforms (#110; thanks @maxwell)
 
-=== 3.1.5 2020-12-16
+
+## 3.1.5 2020-12-16
 
 * Fix attribute lookup when manually constructing objects (#105; thanks @drewtempelmeyer)
 * Flatten class names and clean up some other style issues
 * Fix `EasyPost::Address.create_and_verify`, broken since 3.1.0 (#108; thanks @rajbirverma)
 
-=== 3.1.4 2020-09-29
+
+## 3.1.4 2020-09-29
 
 * Don't modify params passed into Address#create (#78; thanks @TheRusskiy)
 * Don't modify `carriers` and `services` parameters to `Shipment.lowest_rate` (#71 / #103, thanks @vladvinnikov and @jurisgalang)
 * When constructing an easypost object, convert the key to a string (#102; thanks @Geesu)
 * Expose the raw HTTP response as `#http_body` on `EasyPost::Error` objects (#101; thanks @Geesu)
 
-=== 3.1.3 2020-06-26
+
+## 3.1.3 2020-06-26
 
 * Fix bug causing Authorization header to be included in User-Agent header. All users must upgrade.
 
-=== 3.1.2 2020-06-24
+
+## 3.1.2 2020-06-24
 
 * Bad gem push. New version required.
 
-=== 3.1.1 2020-06-23
+
+## 3.1.1 2020-06-23
 
 * Fix bug where EasyPost.http_config was invalid when not explicitly initialized.
 
-=== 3.1.0 2020-06-23
+
+## 3.1.0 2020-06-23
 
 * Add Shipment Invoice and Refund Report
 * Remove dependencies on `RestClient` and `MultiJson`
 * Remove some deprecated endpoints
 
-=== 3.0.1 2018-05-17
+
+## 3.0.1 2018-05-17
 
 * Enforce TLS certificate validity by default
 
-=== 3.0.0 2018-02-15
+
+## 3.0.0 2018-02-15
 
 * Require use of ruby ~> 2.0 and TLSv1.2
 
 
-=== 2.7.3 2018-02-05
+## 2.7.3 2018-02-05
 
 * Fix bug with introduced around certain JSON objects with IDs (thanks vladvinnikov!)
 
 
-=== 2.7.2 2018-02-01
+## 2.7.2 2018-02-01
 
 * Removed unused and unsupported code paths for Container model
 * Removed unused and unsupported code path for Stamp and Barcode methods on the Shipment model
 * Fixed a bug with non-model JSON object with an "id" key being treated as models and raising errors
 
 
-=== 2.7.1 2017-05-25
+## 2.7.1 2017-05-25
 
 * Allow reports to be retrieved without passing a type
 
 
-=== 2.7.0 2017-04-04
+## 2.7.0 2017-04-04
 
 * Changed Report CRUD signatures. requires report type to be passed
 
 
-=== 2.6.2 2017-02-14
+## 2.6.2 2017-02-14
 
 * Added get_rates method for Orders
 
 
-=== 2.6.1 2017-01-19
+## 2.6.1 2017-01-19
 
 * Updated create method for ScanForms
 
 
-=== 2.6.0 2017-01-17
+## 2.6.0 2017-01-17
 
 * Add basic CRUD methods for Webhooks
 
 
-=== 2.5.0 2016-12-19
+## 2.5.0 2016-12-19
 
 * Add prefixes to report in utils
 
 
-=== 2.4.0 2016-12-08
+## 2.4.0 2016-12-08
 
 * Add report resource to ruby client
 
 
-=== 2.3.0 2016-11-25
+## 2.3.0 2016-11-25
 
 * Updated dependencies to allow rest-client 2.0.0 and above
 
 
-=== 2.2.0 2016-07-26
+## 2.2.0 2016-07-26
 
 * Added standalone Insurance model
 
 
-=== 2.1.11 2016-02-04
+## 2.1.11 2016-02-04
 
 * Allowed user creation for top-level users
 
 
-=== 2.1.10 2015-12-23
+## 2.1.10 2015-12-23
 
 * Added verify and verify_strict params to Address.create
 * Added Tracker.create_list and Tracker.all_updated for working with large
 numbers of Trackers.
 
 
-=== 2.1.9 2015-11-04
+## 2.1.9 2015-11-04
 
 * Added new tests for Tracker.all
 * Updated some old examples
 
 
-=== 2.1.8 2015-10-21
+## 2.1.8 2015-10-21
 
 * Added Cancel method for Pickups (thanks Ramie Blatt!)
 
 
-=== 2.1.7 2015-10-05
+## 2.1.7 2015-10-05
 
 * Fixed Address.create_and_verify and changed how errors are raised (thanks Dimitri Roche!)
 * Require newer version of the multi_json package
 
 
-=== 2.1.6 2015-06-10
+## 2.1.6 2015-06-10
 
 * Added Address message accessor for backwards compatability
 
 
-=== 2.1.5 2015-06-10
+## 2.1.5 2015-06-10
 
 * Removed Address.message
 
 
-=== 2.1.4 2015-06-03
+## 2.1.4 2015-06-03
 
 * Add Printer and PrintJob resources.
 
 
-=== 2.1.3 2015-04-30
+## 2.1.3 2015-04-30
 
 * Bux fix, EasyPost::Errors no longer break with a nil json body.
 
 
-=== 2.1.2 2015-04-29
+## 2.1.2 2015-04-29
 
 * EasyPost::Errors now correctly parse field errors and error codes.
 
 
-=== 2.1.1 2015-04-15
+## 2.1.1 2015-04-15
 
 * CarrierAccount will now correctly save in-place modifications to credentials
 * Nested variables should now be saved correctly across all models
 * Fixed version numbering confusion (the previous version was 2.0.15, not 2.1.0)
 
 
-=== 2.0.15 2015-04-15
+## 2.0.15 2015-04-15
 
 * Added tracker to shipment buy response
 * Updated tracker tests
 
 
-=== 2.0.14 2015-04-15
+## 2.0.14 2015-04-15
 
 * Added User and CarrierAccount models with CRUD functionality
 
 
-=== 2.0.13 2014-10-30
+## 2.0.13 2014-10-30
 
 * Added Pickup, PickupRate resources.
 * Added ability to pass api_key to a few resources that were missing it.
 
 
-=== 2.0.12 2014-07-07
+## 2.0.12 2014-07-07
 
 * Added Item, Container, and Order resources.
 * Fixed and added a lot of tests.
 
 
-=== 2.0.11 2013-12-16
+## 2.0.11 2013-12-16
 
 * Added Event.receive method for parsing events sent by webhook.
 * Fixed tests to account for the tracking code returning and array of details instead of a Hash
 
 
-=== 2.0.10 2013-10-03
+## 2.0.10 2013-10-03
 
 * API Addition: Event resource added for webhook consumption.
 
 
-=== 2.0.9 2013-09-19
+## 2.0.9 2013-09-19
 
 * Interface Change: Changed batch.scan_form to batch.create_scan_form to support the ability to refer to scan forms associated to batches.
 
 
-=== 2.0.3 2013-07-31
+## 2.0.3 2013-07-31
 
 * API Addition: Tracker resource added. Trackers can be used to register any tracking code with EasyPost webhooks.
 
 
-=== 2.0.2 2013-07-23
+## 2.0.2 2013-07-23
 
 * API Addition: Shipment.track_with_code returns tracking details for any tracking code.
 
 
-=== 2.0.1 2013-07-07
+## 2.0.1 2013-07-07
 
 * API Addition: Address.create_and_verify returns a verified address in one step.
 * API Addition: Shipment.label forces the creation of additional label formats (pdf, epl2, zpl).

data/README.md

@@ -4,29 +4,27 @@
 [![Gem Version](https://badge.fury.io/rb/easypost.svg)](https://badge.fury.io/rb/easypost)
 
 
-EasyPost is a simple shipping API. You can sign up for an account at https://easypost.com
+EasyPost is a simple shipping API. You can sign up for an account at https://easypost.com.
 
-Installation
----------------
+## Installation
 
 Install the gem:
 
-```
+```bash
 gem install easypost
 ```
 
 Import the EasyPost client in your application:
 
-```
+```ruby
 require 'easypost'
 ```
 
-Example
-------------------
+## Example
 
 ```ruby
 require 'easypost'
-EasyPost.api_key = 'cueqNZUb3ldeWTNX7MU3Mel8UXtaAMUi'
+EasyPost.api_key = 'API_KEY'
 
 to_address = EasyPost::Address.create(
   :name => 'Dr. Steve Brule',
@@ -37,6 +35,7 @@ to_address = EasyPost::Address.create(
   :country => 'US',
   :phone => '310-808-5243'
 )
+
 from_address = EasyPost::Address.create(
   :company => 'EasyPost',
   :street1 => '118 2nd Street',
@@ -62,6 +61,7 @@ customs_item = EasyPost::CustomsItem.create(
   :origin_country => 'us',
   :hs_tariff_number => 123456
 )
+
 customs_info = EasyPost::CustomsInfo.create(
   :integrated_form_type => 'form_2976',
   :customs_certify => true,
@@ -91,17 +91,23 @@ shipment.insure(amount: 100)
 puts shipment.insurance
 
 puts shipment.postage_label.label_url
-
 ```
 
-Documentation
---------------------
+## Documentation
 
 Up-to-date documentation at: https://easypost.com/docs
 
-Tests
---------------------
+## Development
 
+```bash
+# Run tests
+bundle exec rspec
 ```
-rspec spec
-```
+
+## Releasing
+
+1. Update the version in `VERSION`
+1. Update the `CHANGELOG`
+1. Tag a release on GitHub
+1. Build the Gem `gem build easypost.gemspec`
+1. Publish the Gem `gem push easypost-X.X.X.gem` (replace `X.X.X` with the version being released)

data/VERSION

@@ -1 +1 @@
-3.3.0
+3.4.0

data/lib/easypost.rb

@@ -2,38 +2,38 @@ require "base64"
 require "cgi"
 require "net/http"
 
-# Resources
 require "easypost/version"
 require "easypost/util"
 require "easypost/object"
 require "easypost/resource"
+require "easypost/error"
+
+# Resources
 require "easypost/address"
-require "easypost/parcel"
-require "easypost/customs_item"
+require "easypost/api_key"
+require "easypost/batch"
+require "easypost/carrier_account"
+require "easypost/carrier_type"
 require "easypost/customs_info"
-require "easypost/shipment"
-require "easypost/rate"
-require "easypost/postage_label"
-require "easypost/scan_form"
-require "easypost/refund"
-require "easypost/insurance"
+require "easypost/customs_item"
 require "easypost/event"
-require "easypost/batch"
-require "easypost/tracker"
-require "easypost/item"
+require "easypost/insurance"
 require "easypost/order"
-require "easypost/pickup"
+require "easypost/parcel"
 require "easypost/pickup_rate"
-require "easypost/printer"
+require "easypost/pickup"
+require "easypost/postage_label"
 require "easypost/print_job"
-require "easypost/carrier_type"
-require "easypost/carrier_account"
-require "easypost/user"
+require "easypost/printer"
+require "easypost/rate"
+require "easypost/refund"
 require "easypost/report"
+require "easypost/scan_form"
+require "easypost/shipment"
+require "easypost/tracker"
+require "easypost/user"
 require "easypost/webhook"
 
-require "easypost/error"
-
 module EasyPost
   @api_key = nil
   @api_base = "https://api.easypost.com"

data/lib/easypost/api_key.rb

@@ -0,0 +1,2 @@
+class EasyPost::ApiKey < EasyPost::Resource
+end

data/lib/easypost/object.rb

@@ -75,6 +75,10 @@ class EasyPost::EasyPostObject
     @values
   end
 
+  def deconstruct_keys(_keys)
+    @values.transform_keys(&:to_sym)
+  end
+
   def each(&blk)
     @values.each(&blk)
   end

data/lib/easypost/shipment.rb

@@ -6,6 +6,13 @@ class EasyPost::Shipment < EasyPost::Resource
     return self
   end
 
+  def regenerate_rates(params={})
+    response = EasyPost.make_request(:post, url + '/rerate', @api_key, params)
+    self.refresh_from(response, @api_key, true)
+
+    return self
+  end
+
   def get_smartrates
     response = EasyPost.make_request(:get, url + '/smartrate', @api_key)
 

data/lib/easypost/tracker.rb

@@ -4,10 +4,4 @@ class EasyPost::Tracker < EasyPost::Resource
     response = EasyPost.make_request(:post, url, api_key, params)
     return true
   end
-
-  def self.all_updated(params={}, api_key=nil)
-    url = self.url + '/all_updated'
-    response = EasyPost.make_request(:get, url, api_key, params)
-    return EasyPost::Util.convert_to_easypost_object(response, api_key)
-  end
 end

data/lib/easypost/user.rb

@@ -22,8 +22,7 @@ class EasyPost::User < EasyPost::Resource
   end
 
   def self.all_api_keys
-    response = EasyPost.make_request(:get, "/api_keys", @api_key)
-    return EasyPost::Util.convert_to_easypost_object(response, api_key)
+    EasyPost::ApiKey.all
   end
 
   def api_keys

data/lib/easypost/util.rb

@@ -22,63 +22,61 @@ module EasyPost::Util
   def self.convert_to_easypost_object(response, api_key, parent=nil, name=nil)
     types = {
       'Address' => EasyPost::Address,
-      'ScanForm' => EasyPost::ScanForm,
-      'CustomsItem' => EasyPost::CustomsItem,
+      'Batch' => EasyPost::Batch,
+      'CarrierAccount' => EasyPost::CarrierAccount,
       'CustomsInfo' => EasyPost::CustomsInfo,
-      'Parcel' => EasyPost::Parcel,
-      'Shipment' => EasyPost::Shipment,
-      'Rate' => EasyPost::Rate,
-      'Refund' => EasyPost::Refund,
+      'CustomsItem' => EasyPost::CustomsItem,
       'Event' => EasyPost::Event,
-      'Batch' => EasyPost::Batch,
-      'Tracker' => EasyPost::Tracker,
-      'Item' => EasyPost::Item,
       'Insurance' => EasyPost::Insurance,
       'Order' => EasyPost::Order,
+      'Parcel' => EasyPost::Parcel,
+      'PaymentLogReport' => EasyPost::Report,
       'Pickup' => EasyPost::Pickup,
       'PickupRate' => EasyPost::PickupRate,
       'PostageLabel' => EasyPost::PostageLabel,
       'Printer' => EasyPost::Printer,
       'PrintJob' => EasyPost::PrintJob,
-      'CarrierAccount' => EasyPost::CarrierAccount,
-      'User' => EasyPost::User,
+      'Rate' => EasyPost::Rate,
+      'Refund' => EasyPost::Refund,
+      'RefundReport' => EasyPost::Report,
       'Report' => EasyPost::Report,
+      'ScanForm' => EasyPost::ScanForm,
+      'Shipment' => EasyPost::Shipment,
+      'ShipmentInvoiceReport' => EasyPost::Report,
       'ShipmentReport' => EasyPost::Report,
-      'PaymentLogReport' => EasyPost::Report,
+      'Tracker' => EasyPost::Tracker,
       'TrackerReport' => EasyPost::Report,
-      'RefundReport' => EasyPost::Report,
-      'ShipmentInvoiceReport' => EasyPost::Report,
+      'User' => EasyPost::User,
       'Webhook' => EasyPost::Webhook
     }
 
     prefixes = {
       'adr' => EasyPost::Address,
-      'sf' => EasyPost::ScanForm,
-      'cstitem' => EasyPost::CustomsItem,
+      'batch' => EasyPost::Batch,
+      'ca' => EasyPost::CarrierAccount,
       'cstinfo' => EasyPost::CustomsInfo,
-      'prcl' => EasyPost::Parcel,
-      'shp' => EasyPost::Shipment,
-      'rate' => EasyPost::Rate,
-      'rfnd' => EasyPost::Refund,
+      'cstitem' => EasyPost::CustomsItem,
       'evt' => EasyPost::Event,
-      'batch' => EasyPost::Batch,
-      'trk' => EasyPost::Tracker,
-      'item' => EasyPost::Item,
+      'hook' => EasyPost::Webhook,
       'ins' => EasyPost::Insurance,
       'order' => EasyPost::Order,
       'pickup' => EasyPost::Pickup,
       'pickuprate' => EasyPost::PickupRate,
       'pl' => EasyPost::PostageLabel,
+      'plrep' => EasyPost::Report,
+      'prcl' => EasyPost::Parcel,
       'printer' => EasyPost::Printer,
       'printjob' => EasyPost::PrintJob,
-      'ca' => EasyPost::CarrierAccount,
-      'user' => EasyPost::User,
-      'shprep' => EasyPost::Report,
-      'plrep' => EasyPost::Report,
-      'trkrep' => EasyPost::Report,
+      'rate' => EasyPost::Rate,
       'refrep' => EasyPost::Report,
+      'rfnd' => EasyPost::Refund,
+      'sf' => EasyPost::ScanForm,
+      'shp' => EasyPost::Shipment,
       'shpinvrep' => EasyPost::Report,
-      'hook' => EasyPost::Webhook
+      'shprep' => EasyPost::Report,
+      'trk' => EasyPost::Tracker,
+      'trkrep' => EasyPost::Report,
+      'user' => EasyPost::User
     }
 
     case response

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Jake Epstein
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-10 00:00:00.000000000 Z
+date: 2021-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -91,7 +91,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
-- CHANGELOG
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -101,6 +101,7 @@ files:
 - easypost.gemspec
 - lib/easypost.rb
 - lib/easypost/address.rb
+- lib/easypost/api_key.rb
 - lib/easypost/batch.rb
 - lib/easypost/carrier_account.rb
 - lib/easypost/carrier_type.rb
@@ -109,7 +110,6 @@ files:
 - lib/easypost/error.rb
 - lib/easypost/event.rb
 - lib/easypost/insurance.rb
-- lib/easypost/item.rb
 - lib/easypost/object.rb
 - lib/easypost/order.rb
 - lib/easypost/parcel.rb

data/lib/easypost/item.rb

@@ -1,6 +0,0 @@
-class EasyPost::Item < EasyPost::Resource
-  def self.retrieve_reference(params={}, api_key=nil)
-    response = EasyPost.make_request(:get, url + '/retrieve_reference', api_key, params)
-    return EasyPost::Util::convert_to_easypost_object(response, api_key) if response
-  end
-end