Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Destroy account address via API v2 (#10985)

Piotr Milewskif85d6b54f602
diff --git a/api/app/controllers/spree/api/v2/storefront/account/addresses_controller.rb b/api/app/controllers/spree/api/v2/storefront/account/addresses_controller.rb
index 2b1d885942..003d1e4c25 100644
--- a/api/app/controllers/spree/api/v2/storefront/account/addresses_controller.rb
+++ b/api/app/controllers/spree/api/v2/storefront/account/addresses_controller.rb
@@ -7,15 +7,29 @@ module Spree
before_action :require_spree_current_user
def create
+ spree_authorize! :create, model_class
+
result = create_service.call(user: spree_current_user, address_params: address_params)
render_result(result)
end
def update
+ spree_authorize! :update, resource
+
result = update_service.call(address: resource, address_params: address_params)
render_result(result)
end
+ def destroy
+ spree_authorize! :destroy, resource
+
+ if resource.destroy
+ head 204
+ else
+ render_error_payload(resource.errors)
+ end
+ end
+
private
def collection
diff --git a/api/config/routes.rb b/api/config/routes.rb
index 3ee9862068..e38294c515 100644
--- a/api/config/routes.rb
+++ b/api/config/routes.rb
@@ -152,7 +152,7 @@ Spree::Core::Engine.add_routes do
resource :account, controller: :account, only: %i[show]
namespace :account do
- resources :addresses, controller: :addresses, only: %i[index create update]
+ resources :addresses, controller: :addresses
resources :credit_cards, controller: :credit_cards, only: %i[index show]
resources :orders, controller: :orders, only: %i[index show]
end
diff --git a/api/docs/v2/storefront/index.yaml b/api/docs/v2/storefront/index.yaml
index 3f3f67311d..e02be7f86f 100644
--- a/api/docs/v2/storefront/index.yaml
+++ b/api/docs/v2/storefront/index.yaml
@@ -238,6 +238,21 @@ paths:
security:
- bearerAuth: []
'/api/v2/storefront/account/addresses/{id}':
+ delete:
+ description: 'Removes selected Address for the signed in User. It uses soft-delete for addresses with shipments and orders.'
+ tags:
+ - Account
+ operationId: Remove Address
+ parameters:
+ - $ref: '#/components/parameters/AddressId'
+ responses:
+ '204':
+ description: Requested Address has been removed from the User Account
+ '404':
+ $ref: '#/components/responses/404NotFound'
+ security:
+ - bearerAuth: []
+ summary: Remove Address
patch:
description: Update selected Address for the signed in User
summary: List of Addresses
@@ -245,13 +260,7 @@ paths:
- Account
operationId: Update Address
parameters:
- - name: id
- in: path
- required: true
- description: Selected Address for update
- schema:
- type: string
- example: '1'
+ - $ref: '#/components/parameters/AddressId'
requestBody:
required: true
content:
@@ -5380,6 +5389,14 @@ components:
- state_name
- country_iso
parameters:
+ AddressId:
+ name: address_id
+ in: path
+ required: true
+ description: Address ID
+ schema:
+ type: string
+ example: '1'
CreditCardIncludeParam:
name: include
in: query
diff --git a/api/spec/requests/spree/api/v2/storefront/account/addresses_spec.rb b/api/spec/requests/spree/api/v2/storefront/account/addresses_spec.rb
index 73faaeaab2..a7d082feda 100644
--- a/api/spec/requests/spree/api/v2/storefront/account/addresses_spec.rb
+++ b/api/spec/requests/spree/api/v2/storefront/account/addresses_spec.rb
@@ -175,4 +175,36 @@ describe 'Storefront API v2 Addresses spec', type: :request do
it_behaves_like 'returns 403 HTTP status'
end
end
+
+ describe 'addresses#destroy' do
+ let(:address) { addresses.last }
+
+ context 'valid request' do
+ before { delete "/api/v2/storefront/account/addresses/#{address.id}", headers: headers_bearer }
+
+ it 'destroys address permanently' do
+ expect { Spree::Address.unscoped.find(address.id) }.to raise_exception(ActiveRecord::RecordNotFound)
+ expect { address.reload }.to raise_exception(ActiveRecord::RecordNotFound)
+ end
+ end
+
+ context 'valid request with existing shipment' do
+ let!(:order) { create :completed_order_with_totals, ship_address: address, bill_address: address}
+
+ before {
+ delete "/api/v2/storefront/account/addresses/#{address.id}", headers: headers_bearer
+ address.reload
+ }
+
+ it 'sets deleted_at date for address' do
+ expect(address.deleted_at).not_to be_nil
+ end
+ end
+
+ context 'with missing authorization token' do
+ before { delete "/api/v2/storefront/account/addresses/#{address.id}" }
+
+ it_behaves_like 'returns 403 HTTP status'
+ end
+ end
end