easypost 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 043543a947c3d50354a25d984eded8e68e37d9af9d7e2c6158176201426cafa1
-  data.tar.gz: 15ebc3486ec63ac23b0dfa6de82001537a72697863e1587fd9a1d909cde33a9a
+  metadata.gz: 759f5d1f9b9695bab8f8b3f251891bcbd47c80c788c02bbd6931a7394ced4e28
+  data.tar.gz: d53c1a16d32deb694dc155079020aa49c0b1be479d16f13635684e2a881308ae
 SHA512:
-  metadata.gz: 8a004acaa7797b54fd7226e4321a47e9aaa11aa055ee39dd886456d547f3e9ec847046c77f2f548a3f510c9d992842c4896fcb5beb6ee060280098e87ee2ae40
-  data.tar.gz: 7b4f5377749b4d65278f744befef446cfcfe7372f171e64a6b42996b9c0c988b0a6370f949d2986698fc5484f66d4bc3cb879b0f714b04a25e9216c196d960ee
+  metadata.gz: 332993e711d82b3c8b3f68363df38a56f94e5dfcb7abd43c6c53eb86171a3c518ca07ecf93a679b0c8db6fb72cf869012b81c293ee953220bf6cb258d3670940
+  data.tar.gz: 49323ec48974fe364913cf7f9201231b843a242d15206a98b5e8f34440c7cd6a640bd7a2972ca18292fb7c6af4e2b090a4dcc7f6b402752d3472ececf0084750

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v5.3.0 (2023-10-11)
+
+- Migrate API Key-related functions out of `user` service into `api_key` service, deprecating the old and introducing the new
+
 ## v5.2.0 (2023-09-14)
 
 - Add `carrier_type` service + `carrier_type.all` method

data/VERSION

@@ -1 +1 @@
-5.2.0
+5.3.0

data/lib/easypost/constants.rb

@@ -6,6 +6,7 @@ class EasyPost::Constants
   INVALID_PAYMENT_METHOD = 'The chosen payment method is not valid. Please try again.'
   MISSING_REQUIRED_PARAMETER = 'Required parameter %s is missing.'
   NO_MATCHING_RATES = 'No matching rates found.'
+  NO_USER_FOUND = 'No user found with the given id.'
   NO_MORE_PAGES = 'There are no more pages to retrieve.'
   NO_PAYMENT_METHODS = 'Billing has not been setup for this user. Please add a payment method.'
   STRIPE_CARD_CREATE_FAILED = 'Could not send card details to Stripe, please try again later.'

data/lib/easypost/services/api_key.rb

@@ -1,8 +1,27 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::ApiKey < EasyPost::Services::Service
-  # Retrieve all api keys.
+  # Retrieve a list of all ApiKey objects.
   def all
     @client.make_request(:get, 'api_keys', EasyPost::Models::ApiKey)
   end
+
+  # Retrieve a list of ApiKey objects (works for the authenticated user or a child user).
+  def retrieve_api_keys_for_user(id)
+    api_keys = all
+
+    if api_keys.id == id
+      # This function was called on the authenticated user
+      return api_keys.keys
+    end
+
+    # This function was called on a child user (authenticated as parent, only return this child user's details).
+    api_keys.children.each do |child|
+      if child.id == id
+        return child.keys
+      end
+    end
+
+    raise EasyPost::Errors::FilteringError.new(EasyPost::Constants::NO_USER_FOUND)
+  end
 end

data/lib/easypost/services/user.rb

@@ -33,11 +33,15 @@ class EasyPost::Services::User < EasyPost::Services::Service
 
   # Retrieve a list of all ApiKey objects.
   def all_api_keys
+    warn '[DEPRECATION] `all_api_keys` is deprecated. Please use `all` in the `api_key` service instead.'
     @client.make_request(:get, 'api_keys', EasyPost::Models::ApiKey)
   end
 
   # Retrieve a list of ApiKey objects (works for the authenticated user or a child user).
   def api_keys(id)
+    warn '[DEPRECATION] `api_keys` is deprecated.
+Please use `retrieve_api_keys_for_user` in the `api_key` service instead.'
+
     api_keys = all_api_keys
 
     if api_keys.id == id

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - EasyPost Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-14 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brakeman