easypost 4.12.0 → 4.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a3e6fa9af948ab36d6bb75ebf7d744f5580f4225b1181fb1d31bc7f834501bb
-  data.tar.gz: 5befe3b07667cb4494249eb6524c5ec8584e3f746475ec9162ae8cc6831ffaab
+  metadata.gz: 656588820c3668029b926bac6eaa73fb57aad0d074be9b4ea0eb59d22444c3ae
+  data.tar.gz: 40050887f75ea9287cd6c5a5d71a22d6ec70508f0170bf9685f0c8c1d515caed
 SHA512:
-  metadata.gz: 41e81f89a10321e694087652862c373b41c88a704a02584c5978ba1a72c1554f79d45277bea81c679a4211072e6b9d56b2829c8c2d6b832c74177018dc469b5e
-  data.tar.gz: 2f4180afe87daf91d6128e555b1ffb3d3befb1a07f8879dea7918887b0f394723901767c394de5e0f3530d03e24f7c355fdf97c68648b2a5c2f6ef47a09daf69
+  metadata.gz: 4d7f27ead8d8687e6e592bbd5669c0a6d22adf8f2aa721c49dc8522030af86297403ccbddd2f030b87ba867c0c880441fb274c6ef1e7afb6d7c086c77875e3c1
+  data.tar.gz: 7a7c9fd6c0160ac5a8453cb3cf82bae9b7f82d2288e960d1e991bf7a022fd05084196799d049dc4bac65d0308d96af025f49f7345a70f44b5f2c6320e47e5d48

data/.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: "CI"
+name: 'CI'
 
 on:
   push:
@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rubyversion: ["2.5", "2.6", "2.7", "3.0", "3.1"]
+        rubyversion: ['2.5', '2.6', '2.7', '3.0', '3.1', '3.2']
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3
@@ -19,7 +19,7 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.rubyversion }}
-          rubygems: "3.0.0"
+          rubygems: '3.0.0'
           bundler-cache: true
       - name: Install Dependencies
         run: make install
@@ -30,7 +30,7 @@ jobs:
         uses: coverallsapp/github-action@master
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          path-to-lcov: "./coverage/lcov/easypost-ruby.lcov"
+          path-to-lcov: './coverage/lcov/easypost-ruby.lcov'
   lint:
     runs-on: ubuntu-latest
     steps:
@@ -39,8 +39,8 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "3.1"
-          rubygems: "3.0.0"
+          ruby-version: '3.2'
+          rubygems: '3.0.0'
           bundler-cache: true
       - name: Install Dependencies
         run: make install

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v4.13.0 (2023-04-04)
+
+- Adds `get_next_page` function to each object which retrieves the next page of a collection when the `has_more` key is present in the response
+
 ## v4.12.0 (2023-02-21)
 
 - Adds beta `retrieve_stateless_rates` function

data/README.md

@@ -117,6 +117,12 @@ Library documentation can be found on the web at: <https://easypost.github.io/ea
 
 Upgrading major versions of this project? Refer to the [Upgrade Guide](UPGRADE_GUIDE.md).
 
+## Support
+
+New features and bug fixes are released on the latest major release of this library. If you are on an older major release of this library, we recommend upgrading to the most recent release to take advantage of new features, bug fixes, and security patches. Older versions of this library will continue to work and be available as long as the API version they are tied to remains active; however, they will not receive updates and are considered EOL.
+
+For additional support, see our [org-wide support policy](https://github.com/EasyPost/.github/blob/main/SUPPORT.md).
+
 ## Development
 
 ```bash

data/VERSION

@@ -1 +1 @@
-4.12.0
+4.13.0

data/lib/easypost/address.rb

@@ -37,4 +37,19 @@ class EasyPost::Address < EasyPost::Resource
 
     EasyPost::Util.convert_to_easypost_object(response['address'], api_key)
   end
+
+  # Get the next page of addresses.
+  def self.get_next_page(collection, page_size = nil)
+    get_next_page_exec(method(:all), collection, collection.addresses, page_size)
+  end
+
+  # Build the next page parameters.
+  def self.build_next_page_params(_collection, current_page_items, page_size = nil)
+    params = {}
+    params[:before_id] = current_page_items.last.id
+    unless page_size.nil?
+      params[:page_size] = page_size
+    end
+    params
+  end
 end

data/lib/easypost/batch.rb

@@ -47,4 +47,6 @@ class EasyPost::Batch < EasyPost::Resource
   def create_scan_form(params = {})
     EasyPost.make_request(:post, "#{url}/scan_form", @api_key, params)
   end
+
+  # TODO: Add support getting the next page of batches when the API supports it.
 end

data/lib/easypost/end_shipper.rb

@@ -21,4 +21,6 @@ class EasyPost::EndShipper < EasyPost::Resource
     end
     self
   end
+
+  # TODO: Add support for getting the next page of end shippers when the API supports it.
 end

data/lib/easypost/event.rb

@@ -20,4 +20,19 @@ class EasyPost::Event < EasyPost::Resource
     response = EasyPost.make_request(:get, "#{url}/payloads/#{payload_id}", api_key)
     EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
+
+  # Get the next page of events.
+  def self.get_next_page(collection, page_size = nil)
+    get_next_page_exec(method(:all), collection, collection.events, page_size)
+  end
+
+  # Build the next page parameters.
+  def self.build_next_page_params(_collection, current_page_items, page_size = nil)
+    params = {}
+    params[:before_id] = current_page_items.last.id
+    unless page_size.nil?
+      params[:page_size] = page_size
+    end
+    params
+  end
 end

data/lib/easypost/insurance.rb

@@ -3,4 +3,18 @@
 # An Insurance object represents insurance for packages purchased both via the EasyPost API as well
 # as shipments purchased through third parties and later registered with EasyPost.
 class EasyPost::Insurance < EasyPost::Resource
+  # Get the next page of insurances.
+  def self.get_next_page(collection, page_size = nil)
+    get_next_page_exec(method(:all), collection, collection.insurances, page_size)
+  end
+
+  # Build the next page parameters.
+  def self.build_next_page_params(_collection, current_page_items, page_size = nil)
+    params = {}
+    params[:before_id] = current_page_items.last.id
+    unless page_size.nil?
+      params[:page_size] = page_size
+    end
+    params
+  end
 end

data/lib/easypost/pickup.rb

@@ -29,4 +29,19 @@ class EasyPost::Pickup < EasyPost::Resource
   def lowest_rate(carriers = [], services = [])
     EasyPost::Util.get_lowest_object_rate(self, carriers, services, 'pickup_rates')
   end
+
+  # Get the next page of pickups.
+  def self.get_next_page(collection, page_size = nil)
+    get_next_page_exec(method(:all), collection, collection.pickups, page_size)
+  end
+
+  # Build the next page parameters.
+  def self.build_next_page_params(_collection, current_page_items, page_size = nil)
+    params = {}
+    params[:before_id] = current_page_items.last.id
+    unless page_size.nil?
+      params[:page_size] = page_size
+    end
+    params
+  end
 end

data/lib/easypost/referral.rb

@@ -80,6 +80,21 @@ class EasyPost::Referral < EasyPost::Resource
     EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
 
+  # Get the next page of referral customers.
+  def self.get_next_page(collection, page_size = nil)
+    get_next_page_exec(method(:all), collection, collection.referral_customers, page_size)
+  end
+
+  # Build the next page parameters.
+  def self.build_next_page_params(_collection, current_page_items, page_size = nil)
+    params = {}
+    params[:before_id] = current_page_items.last.id
+    unless page_size.nil?
+      params[:page_size] = page_size
+    end
+    params
+  end
+
   # Add credit card to a referral customer. This function requires the Referral Customer's API key.
   def self.add_credit_card(referral_api_key, number, expiration_month, expiration_year, cvc, priority = 'primary')
     easypost_stripe_api_key = retrieve_easypost_stripe_api_key

data/lib/easypost/refund.rb

@@ -2,4 +2,18 @@
 
 # The Refund object contains details about the Refund of a Shipment.
 class EasyPost::Refund < EasyPost::Resource
+  # Get the next page of refunds.
+  def self.get_next_page(collection, page_size = nil)
+    get_next_page_exec(method(:all), collection, collection.refunds, page_size)
+  end
+
+  # Build the next page parameters.
+  def self.build_next_page_params(_collection, current_page_items, page_size = nil)
+    params = {}
+    params[:before_id] = current_page_items.last.id
+    unless page_size.nil?
+      params[:page_size] = page_size
+    end
+    params
+  end
 end

data/lib/easypost/report.rb

@@ -18,6 +18,27 @@ class EasyPost::Report < EasyPost::Resource
     url = "#{self.url}/#{filters[:type]}"
 
     response = EasyPost.make_request(:get, url, api_key, filters)
-    EasyPost::Util.convert_to_easypost_object(response, api_key)
+    collection = EasyPost::Util.convert_to_easypost_object(response, api_key)
+
+    # Store the filters used to retrieve the collection.
+    collection.refresh_from({ type: filters[:type] }, api_key)
+
+    collection
+  end
+
+  # Get the next page of addresses.
+  def self.get_next_page(collection, page_size = nil)
+    get_next_page_exec(method(:all), collection, collection.reports, page_size)
+  end
+
+  # Build the next page parameters.
+  def self.build_next_page_params(collection, current_page_items, page_size = nil)
+    params = {}
+    params[:before_id] = current_page_items.last.id
+    unless page_size.nil?
+      params[:page_size] = page_size
+    end
+    params[:type] = collection.type
+    params
   end
 end

data/lib/easypost/resource.rb

@@ -103,4 +103,22 @@ class EasyPost::Resource < EasyPost::EasyPostObject
     end
     self
   end
+
+  # Build the next page parameters and call the next page function.
+  def self.get_next_page_exec(api_func, collection, current_page_items, page_size = nil)
+    has_more = collection.has_more || false
+    unless !has_more || current_page_items.nil? || current_page_items.empty?
+      # if no issues, then we can get the next page
+      params = build_next_page_params(collection, current_page_items, page_size)
+      return api_func.call(params)
+    end
+
+    # issue with getting the next page
+    raise EasyPost::Error.new('There are no more pages to retrieve.')
+  end
+
+  # Build the next page parameters. This is a stub method that should be overridden by the child class.
+  def self.build_next_page_params(_collection, _current_page_items, _page_size = nil)
+    {}
+  end
 end

data/lib/easypost/scan_form.rb

@@ -8,4 +8,19 @@ class EasyPost::ScanForm < EasyPost::Resource
     response = EasyPost.make_request(:post, url, api_key, params)
     EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
+
+  # Get the next page of scan forms.
+  def self.get_next_page(collection, page_size = nil)
+    get_next_page_exec(method(:all), collection, collection.scan_forms, page_size)
+  end
+
+  # Build the next page parameters.
+  def self.build_next_page_params(_collection, current_page_items, page_size = nil)
+    params = {}
+    params[:before_id] = current_page_items.last.id
+    unless page_size.nil?
+      params[:page_size] = page_size
+    end
+    params
+  end
 end

data/lib/easypost/shipment.rb

@@ -34,6 +34,37 @@ class EasyPost::Shipment < EasyPost::Resource
     response.fetch('result', [])
   end
 
+  # Retrieve a list of Shipment objects.
+  def self.all(filters = {}, api_key = nil)
+    collection = super(filters, api_key)
+
+    # Store the filters used to retrieve the collection.
+    collection.refresh_from({ include_children: filters[:include_children], purchased: filters[:purchased] }, api_key)
+
+    collection
+  end
+
+  # Get the next page of shipments.
+  def self.get_next_page(collection, page_size = nil)
+    get_next_page_exec(method(:all), collection, collection.shipments, page_size)
+  end
+
+  # Build the next page parameters.
+  def self.build_next_page_params(collection, current_page_items, page_size = nil)
+    params = {}
+    params[:before_id] = current_page_items.last.id
+    unless page_size.nil?
+      params[:page_size] = page_size
+    end
+    unless collection.include_children.nil?
+      params[:include_children] = collection.include_children
+    end
+    unless collection.purchased.nil?
+      params[:purchased] = collection.purchased
+    end
+    params
+  end
+
   # Buy a Shipment.
   def buy(params = {}, with_carbon_offset = false, end_shipper_id = nil)
     if params.instance_of?(EasyPost::Rate)

data/lib/easypost/tracker.rb

@@ -9,4 +9,35 @@ class EasyPost::Tracker < EasyPost::Resource
     EasyPost.make_request(:post, url, api_key, new_params)
     true # This endpoint does not return a response so we return true here instead
   end
+
+  # Retrieve a list of Tracker objects.
+  def self.all(filters = {}, api_key = nil)
+    collection = super(filters, api_key)
+
+    # Store the filters used to retrieve the collection.
+    collection.refresh_from({ tracking_code: filters[:tracking_code], carrier: filters[:carrier] }, api_key)
+
+    collection
+  end
+
+  # Get the next page of trackers.
+  def self.get_next_page(collection, page_size = nil)
+    get_next_page_exec(method(:all), collection, collection.trackers, page_size)
+  end
+
+  # Build the next page parameters.
+  def self.build_next_page_params(collection, current_page_items, page_size = nil)
+    params = {}
+    params[:before_id] = current_page_items.last.id
+    unless page_size.nil?
+      params[:page_size] = page_size
+    end
+    unless collection.tracking_code.nil?
+      params[:tracking_code] = collection.tracking_code
+    end
+    unless collection.carrier.nil?
+      params[:carrier] = collection.carrier
+    end
+    params
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 4.12.0
+  version: 4.13.0
 platform: ruby
 authors:
 - EasyPost Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-21 00:00:00.000000000 Z
+date: 2023-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brakeman