Update carrier create and update function to account UPS endpoints (#305)

Author: jchen293

CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## Next Release
+
+- Routes `UpsAccount`, `UpsMailInnovationsAccount`, and `UpsSurepostAccount` create/update requests to the new `/ups_oauth_registrations` endpoint
+  - Starting `2024-08-05`, UPS accounts will require a new payload to register or update. See [UPS OAuth 2.0 Update](https://support.easypost.com/hc/en-us/articles/26635027512717-UPS-OAuth-2-0-Update?utm_medium=email&_hsenc=p2ANqtz-96MmFtWICOzy9sKRbbcZSiMovZSrY3MSX1_bgY9N3f9yLVfWQdLhjAGq-SmNcOnDIS6GYhZ0OApjDBrGkKyLLMx1z6_TFOVp6-wllhEFQINrkuRuc&_hsmi=313130292&utm_content=313130292&utm_source=hs_email) for more details
+
 ## v6.2.0 (2024-04-10)
 
 - Fix payment method funding and deletion failures due to undetermined payment method type

Makefile

@@ -24,8 +24,13 @@ docs:
 install-styleguide: | update-examples-submodule
 	sh examples/symlink_directory_files.sh examples/style_guides/ruby .
 
+## init-examples-submodule - Initialize the examples submodule
+init-examples-submodule:
+	git submodule init
+	git submodule update
+
 ## install - Install globally from source
-install: | update-examples-submodule
+install: | init-examples-submodule
 	bundle install
 
 ## lint - Lint the project

lib/easypost/services/carrier_account.rb

@@ -1,16 +1,20 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::CarrierAccount < EasyPost::Services::Service
-  CUSTOM_WORKFLOW_CARRIER_TYPES = %w[UpsAccount FedexAccount FedexSmartpostAccount].freeze
+  CUSTOM_WORKFLOW_CARRIER_TYPES = %w[FedexAccount FedexSmartpostAccount].freeze
+  UPS_OAUTH_CARRIER_ACCOUNT_TYPES = %w[UpsAccount UpsMailInnovationsAccount UpsSurepostAccount].freeze
   MODEL_CLASS = EasyPost::Models::CarrierAccount
 
   # Create a carrier account
   def create(params = {})
-    wrapped_params = { carrier_account: params }
+    carrier_account_type = params[:type]
+    wrapped_params = { select_top_layer_key(carrier_account_type).to_sym => params }
 
     # For UPS and FedEx the endpoint is different
-    create_url = if CUSTOM_WORKFLOW_CARRIER_TYPES.include?(params[:type])
+    create_url = if CUSTOM_WORKFLOW_CARRIER_TYPES.include?(carrier_account_type)
                    'carrier_accounts/register'
+                 elsif UPS_OAUTH_CARRIER_ACCOUNT_TYPES.include?(carrier_account_type)
+                   'ups_oauth_registrations'
                  else
                    'carrier_accounts'
                  end
@@ -33,8 +37,14 @@ def all(params = {})
 
   # Update a carrier account
   def update(id, params = {})
-    wrapped_params = { carrier_account: params }
-    response = @client.make_request(:put, "carrier_accounts/#{id}", wrapped_params)
+    carrier_account = retrieve(id)
+    wrapped_params = { select_top_layer_key(carrier_account[:type]).to_sym => params }
+    update_url = if UPS_OAUTH_CARRIER_ACCOUNT_TYPES.include?(params[:type])
+                   'ups_oauth_registrations/'
+                 else
+                   'carrier_accounts/'
+                 end
+    response = @client.make_request(:put, "#{update_url}#{id}", wrapped_params)
 
     EasyPost::InternalUtilities::Json.convert_json_to_object(response, MODEL_CLASS)
   end
@@ -46,4 +56,15 @@ def delete(id)
     # Return true if succeeds, an error will be thrown if it fails
     true
   end
+
+  private
+
+  # Select the top-layer key for the carrier account creation/update request based on the carrier type.
+  def select_top_layer_key(carrier_account_type)
+    if UPS_OAUTH_CARRIER_ACCOUNT_TYPES.include?(carrier_account_type)
+      'ups_oauth_registrations'
+    else
+      'carrier_account'
+    end
+  end
 end

spec/carrier_account_spec.rb

@@ -17,6 +17,17 @@
       client.carrier_account.delete(carrier_account.id)
     end
 
+    it 'creates an UPS account' do
+      carrier_account = client.carrier_account.create({ type: 'UpsAccount', account_number: '123456789' })
+
+      expect(carrier_account).to be_an_instance_of(EasyPost::Models::CarrierAccount)
+      expect(carrier_account.id).to match('ca_')
+      expect(carrier_account.type).to eq('UpsAccount')
+
+      # Remove the carrier account once we have tested it so we don't pollute the account with test accounts
+      client.carrier_account.delete(carrier_account.id)
+    end
+
     it 'sends FedexAccount to the correct endpoint' do
       allow(client).to receive(:make_request).with(
         :post, 'carrier_accounts/register',
@@ -65,6 +76,19 @@
       # Remove the carrier account once we have tested it so we don't pollute the account with test accounts
       client.carrier_account.delete(carrier_account.id)
     end
+
+    it 'updates an ups account' do
+      ups_account = client.carrier_account.create({ type: 'UpsAccount', account_number: '123456789' })
+
+      updated_ups_account = client.carrier_account.update(ups_account.id, account_number: '987654321')
+
+      expect(updated_ups_account).to be_an_instance_of(EasyPost::Models::CarrierAccount)
+      expect(updated_ups_account.id).to match('ca_')
+      expect(updated_ups_account.type).to eq('UpsAccount')
+
+      # Remove the carrier account once we have tested it so we don't pollute the account with test accounts
+      client.carrier_account.delete(ups_account.id)
+    end
   end
 
   describe '.delete' do