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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
SD-1361 Add destroy endpoint for basket in spree-api. (#11149)
Kacper Mękarski45ac4620068e
diff --git a/api/app/controllers/spree/api/v1/orders_controller.rb b/api/app/controllers/spree/api/v1/orders_controller.rbindex 88d7e971ef..d9b0dcff81 100644--- a/api/app/controllers/spree/api/v1/orders_controller.rb+++ b/api/app/controllers/spree/api/v1/orders_controller.rb@@ -56,7 +56,7 @@ module Spreedef emptyauthorize! :update, @order, order_token- @order.empty!+ cart_empty_service.call(order: @order)render plain: nil, status: 204end@@ -150,6 +150,10 @@ module Spreedef order_idsuper || params[:id]end++ def cart_empty_service+ Spree::Dependencies.cart_empty_service.constantize+ endendendenddiff --git a/api/app/controllers/spree/api/v2/storefront/cart_controller.rb b/api/app/controllers/spree/api/v2/storefront/cart_controller.rbindex 7440191bd1..f200e0d7d1 100644--- a/api/app/controllers/spree/api/v2/storefront/cart_controller.rb+++ b/api/app/controllers/spree/api/v2/storefront/cart_controller.rb@@ -50,11 +50,25 @@ module Spreedef emptyspree_authorize! :update, spree_current_order, order_token- # TODO: we should extract this logic into service and let- # developers overwrite it- spree_current_order.empty!+ result = empty_cart_service.call(order: spree_current_order)- render_serialized_payload { serialized_current_order }+ if result.success?+ render_serialized_payload { serialized_current_order }+ else+ render_error_payload(result.error)+ end+ end++ def destroy+ spree_authorize! :update, spree_current_order, order_token++ result = destroy_cart_service.call(order: spree_current_order)++ if result.success?+ head 204+ else+ render_error_payload(result.error)+ endenddef set_quantity@@ -128,6 +142,14 @@ module SpreeSpree::Api::Dependencies.storefront_cart_add_item_service.constantizeend+ def empty_cart_service+ Spree::Api::Dependencies.storefront_cart_empty_service.constantize+ end++ def destroy_cart_service+ Spree::Api::Dependencies.storefront_cart_destroy_service.constantize+ end+def set_item_quantity_serviceSpree::Api::Dependencies.storefront_cart_set_item_quantity_service.constantizeenddiff --git a/api/app/models/spree/api_dependencies.rb b/api/app/models/spree/api_dependencies.rbindex 45d41b4f17..79ed056f44 100644--- a/api/app/models/spree/api_dependencies.rb+++ b/api/app/models/spree/api_dependencies.rb@@ -18,7 +18,8 @@ module Spree:storefront_cart_estimate_shipping_rates_service, :storefront_estimated_shipment_serializer,:storefront_store_serializer, :storefront_address_serializer, :storefront_order_serializer,:storefront_account_create_address_service, :storefront_account_update_address_service, :storefront_address_finder,- :storefront_account_create_service, :storefront_account_update_service, :storefront_collection_sorter, :error_handler+ :storefront_account_create_service, :storefront_account_update_service, :storefront_collection_sorter, :error_handler,+ :storefront_cart_empty_service, :storefront_cart_destroy_service].freezeattr_accessor *INJECTION_POINTS@@ -40,6 +41,8 @@ module Spree@storefront_cart_set_item_quantity_service = Spree::Dependencies.cart_set_item_quantity_service@storefront_cart_recalculate_service = Spree::Dependencies.cart_recalculate_service@storefront_cart_estimate_shipping_rates_service = Spree::Dependencies.cart_estimate_shipping_rates_service+ @storefront_cart_empty_service = Spree::Dependencies.cart_empty_service+ @storefront_cart_destroy_service = Spree::Dependencies.cart_destroy_service# coupon code handler@storefront_coupon_handler = Spree::Dependencies.coupon_handlerdiff --git a/api/config/routes.rb b/api/config/routes.rbindex b3addbd8cd..c2ab4bb68d 100644--- a/api/config/routes.rb+++ b/api/config/routes.rb@@ -128,7 +128,7 @@ Spree::Core::Engine.add_routes donamespace :v2 donamespace :storefront do- resource :cart, controller: :cart, only: %i[show create] do+ resource :cart, controller: :cart, only: %i[show create destroy] dopost :add_itempatch :emptydelete 'remove_line_item/:line_item_id', to: 'cart#remove_line_item', as: :cart_remove_line_itemdiff --git a/api/docs/v2/storefront/index.yaml b/api/docs/v2/storefront/index.yamlindex 6042c343f1..305ea1c6a5 100644--- a/api/docs/v2/storefront/index.yaml+++ b/api/docs/v2/storefront/index.yaml@@ -634,6 +634,23 @@ paths:- $ref: '#/components/parameters/CartIncludeParam'- $ref: '#/components/parameters/SparseFieldsParam'summary: Empty the Cart+ /api/v2/storefront/cart:+ delete:+ description: |-+ Deletes Cart.+ Endpoint can be called after PATCH /api/v2/storefront/cart/empty, or individually.+ Shipments are canceled, payments are voided, then Line Items, Shipments & Payments are deleted.+ tags:+ - Cart+ operationId: Deletes Cart+ responses:+ '204':+ description: Current Cart has been removed.+ '404':+ $ref: '#/components/responses/404NotFound'+ security:+ - bearerAuth: [ ]+ summary: Deletes Cart/api/v2/storefront/cart/apply_coupon_code:patch:description: Applies a coupon code to the Cartdiff --git a/api/spec/requests/spree/api/v2/storefront/cart_spec.rb b/api/spec/requests/spree/api/v2/storefront/cart_spec.rbindex b0eb93a3f9..50bd46c5c4 100644--- a/api/spec/requests/spree/api/v2/storefront/cart_spec.rb+++ b/api/spec/requests/spree/api/v2/storefront/cart_spec.rb@@ -322,6 +322,42 @@ describe 'API V2 Storefront Cart Spec', type: :request doendend+ describe 'cart#destroy' do+ let(:execute) { delete '/api/v2/storefront/cart', headers: headers }++ shared_examples 'destroying order' do+ it 'destroys the order' do+ expect{ execute }.to change { Spree::Order.count }.by(-1)+ end+ end++ shared_examples '204 status returned' do+ before { execute }++ it_behaves_like 'returns 204 HTTP status'+ end++ context 'as a signed in user' do+ context 'with existing order with line item' do+ include_context 'creates order with line item'++ it_behaves_like 'destroying order'+ it_behaves_like '204 status returned'+ it_behaves_like 'no current order'+ end+ end++ context 'as a guest user' do+ context 'with existing guest order with line item' do+ include_context 'creates guest order with guest token'++ it_behaves_like 'destroying order'+ it_behaves_like '204 status returned'+ it_behaves_like 'no current order'+ end+ end+ end+describe 'cart#set_quantity' dolet(:line_item) { create(:line_item, order: order) }let(:params) { { order: order, line_item_id: line_item.id, quantity: 5 } }diff --git a/core/app/models/spree/app_dependencies.rb b/core/app/models/spree/app_dependencies.rbindex 79fee44393..d0d9d8f28d 100644--- a/core/app/models/spree/app_dependencies.rb+++ b/core/app/models/spree/app_dependencies.rb@@ -12,7 +12,7 @@ module Spree:completed_order_finder, :order_sorter, :cart_compare_line_items_service, :collection_paginator, :products_sorter,:products_finder, :taxon_finder, :line_item_by_variant_finder, :cart_estimate_shipping_rates_service,:account_create_address_service, :account_update_address_service, :account_create_service, :account_update_service,- :address_finder, :collection_sorter, :error_handler, :current_store_finder+ :address_finder, :collection_sorter, :error_handler, :current_store_finder, :cart_empty_service, :cart_destroy_service].freezeattr_accessor *INJECTION_POINTS@@ -40,6 +40,8 @@ module Spree@cart_remove_line_item_service = 'Spree::Cart::RemoveLineItem'@cart_set_item_quantity_service = 'Spree::Cart::SetQuantity'@cart_estimate_shipping_rates_service = 'Spree::Cart::EstimateShippingRates'+ @cart_empty_service = 'Spree::Cart::Empty'+ @cart_destroy_service = 'Spree::Cart::Destroy'# checkout@checkout_next_service = 'Spree::Checkout::Next'diff --git a/core/app/models/spree/order.rb b/core/app/models/spree/order.rbindex 31a4c1aa83..d3a170e98c 100644--- a/core/app/models/spree/order.rb+++ b/core/app/models/spree/order.rb@@ -422,21 +422,15 @@ module Spreeenddef empty!- if completed?- raise Spree.t(:cannot_empty_completed_order)- else- line_items.destroy_all- updater.update_item_count- adjustments.destroy_all- shipments.destroy_all- state_changes.destroy_all- order_promotions.destroy_all+ ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)+ `Order#empty!` is deprecated and will be removed in Spree 5.0.+ Please use `Spree::Cart::Empty.call(order: order)` instead.+ DEPRECATION- update_totals- persist_totals- restart_checkout_flow- self- end+ raise Spree.t(:cannot_empty_completed_order) if completed?++ result = Spree::Dependencies.cart_empty_service.constantize.call(order: self)+ result.valueenddef has_step?(step)@@ -574,6 +568,10 @@ module Spree!approved?end+ def can_be_destroyed?+ !completed? && payments.completed.empty?+ end+def consider_riskconsidered_risky! if is_risky? && !approved?enddiff --git a/core/app/services/spree/cart/destroy.rb b/core/app/services/spree/cart/destroy.rbnew file mode 100644index 0000000000..7a37c39280--- /dev/null+++ b/core/app/services/spree/cart/destroy.rb@@ -0,0 +1,40 @@+module Spree+ module Cart+ class Destroy+ prepend Spree::ServiceModule::Base++ def call(order:)+ run :check_if_can_be_destroyed+ run :cancel_shipments+ run :void_payments+ run :destroy_order+ end++ private++ def check_if_can_be_destroyed(order:)+ return failure(Spree.t(:cannot_be_destroyed)) unless order&.can_be_destroyed?++ success(order: order)+ end++ def cancel_shipments(order:)+ order.shipments.each(&:cancel!)++ success(order: order)+ end++ def void_payments(order:)+ order.payments.each(&:void!)++ success(order: order)+ end++ def destroy_order(order:)+ order.destroy++ success(order)+ end+ end+ end+enddiff --git a/core/app/services/spree/cart/empty.rb b/core/app/services/spree/cart/empty.rbnew file mode 100644index 0000000000..ac097d2d10--- /dev/null+++ b/core/app/services/spree/cart/empty.rb@@ -0,0 +1,36 @@+module Spree+ module Cart+ class Empty+ prepend Spree::ServiceModule::Base++ def call(order:)+ run :check_if_can_be_empty+ run :empty_order+ end++ private++ def check_if_can_be_empty(order:)+ return failure(Spree.t(:cannot_empty)) if order.nil? || order.completed?++ success(order: order)+ end++ def empty_order(order:)+ ActiveRecord::Base.transaction do+ order.line_items.destroy_all+ order.updater.update_item_count+ order.adjustments.destroy_all+ order.shipments.destroy_all+ order.state_changes.destroy_all+ order.order_promotions.destroy_all+ order.update_totals+ order.persist_totals+ order.restart_checkout_flow++ success(order)+ end+ end+ end+ end+enddiff --git a/core/config/locales/en.yml b/core/config/locales/en.ymlindex edfe466260..e3a763df47 100644--- a/core/config/locales/en.yml+++ b/core/config/locales/en.yml@@ -771,6 +771,8 @@ en:canceled: Canceledcanceler: Cancelercanceled_at: Canceled at+ cannot_be_destroyed: Order cannot be destroyed.+ cannot_empty: Cannot empty order.cannot_empty_completed_order: Order has already been processed so it cannot be emptiedcannot_create_payment_without_payment_methods: You cannot create a payment for an order without any payment methods defined.cannot_create_customer_returns: Cannot create customer returns as this order has no shipped units.diff --git a/core/spec/models/spree/order_spec.rb b/core/spec/models/spree/order_spec.rbindex 51e060b0a6..6c66bc8d29 100644--- a/core/spec/models/spree/order_spec.rb+++ b/core/spec/models/spree/order_spec.rb@@ -743,6 +743,32 @@ describe Spree::Order, type: :model doendend+ context '#can_be_destroyed?' do+ shared_examples 'cannot be destroyed' do+ it { expect(order.can_be_destroyed?).to be false }+ end++ context 'when order is completed' do+ let(:order) { create(:completed_order_with_pending_payment) }++ it_behaves_like 'cannot be destroyed'+ end++ context 'when order has finalized payments' do+ let(:order) { create(:order_ready_to_ship) }++ it_behaves_like 'cannot be destroyed'+ end++ context 'when order is not completed and does not have finalized payments' do+ let(:order) { create(:order) }++ it 'can be destroyed' do+ expect(order.can_be_destroyed?).to be true+ end+ end+ end+context '#uneditable?' dolet(:order) { Spree::Order.create }diff --git a/core/spec/services/spree/cart/destroy_spec.rb b/core/spec/services/spree/cart/destroy_spec.rbnew file mode 100644index 0000000000..261a200de2--- /dev/null+++ b/core/spec/services/spree/cart/destroy_spec.rb@@ -0,0 +1,82 @@+require 'spec_helper'++module Spree+ describe Cart::Destroy do+ subject { described_class.call order: order }++ context 'when order is given' do+ context 'when can be destroyed' do+ let(:order) { create(:order_with_line_items) }+ let(:shipment) { order.shipments.take }+ let!(:payment) { create(:payment, amount: order.total, order: order) }+ let!(:line_item_ids) { order.line_item_ids }+ let!(:shipment_ids) { order.shipment_ids }+ let!(:payment_ids) { order.payment_ids }++ it 'returns success' do+ expect(subject.success?).to be true+ end++ it 'voids pending payments' do+ expect_any_instance_of(Spree::Payment).to receive(:void!).exactly(order.payments.count).times++ subject+ end++ it 'cancel not shipped shipments' do+ expect_any_instance_of(Spree::Shipment).to receive(:cancel!).exactly(order.shipments.count).times++ subject+ end++ it 'destroys the order' do+ expect(order.destroyed?).not_to be true++ subject++ expect(order.destroyed?).to be true+ end++ it 'destroys line_items, shipments and payments' do+ subject++ expect(Spree::LineItem.where(id: line_item_ids)).to be_empty+ expect(Spree::Shipment.where(id: shipment_ids)).to be_empty+ expect(Spree::Payment.where(id: payment_ids)).to be_empty+ end++ context 'when empty service is called first' do+ before { Spree::Cart::Empty.call(order: order) }++ it 'destroys the order' do+ expect(order.destroyed?).not_to be true++ subject++ expect(order.destroyed?).to be true+ end+ end+ end++ context 'when cannot be destroyed' do+ let(:order) { create(:completed_order_with_totals) }++ it 'returns failure' do+ expect(subject.success?).to be false+ expect(subject.value).to eq Spree.t(:cannot_be_destroyed)+ end+ end+ end++ context 'when nil is given' do+ let(:order) { nil }++ before { subject }++ it 'returns failure' do+ expect(subject.success?).to be false+ expect(subject.value).to eq Spree.t(:cannot_be_destroyed)+ end+ end+ end+enddiff --git a/core/spec/services/spree/cart/empty_spec.rb b/core/spec/services/spree/cart/empty_spec.rbnew file mode 100644index 0000000000..8c8e62e51b--- /dev/null+++ b/core/spec/services/spree/cart/empty_spec.rb@@ -0,0 +1,57 @@+require 'spec_helper'++module Spree+ describe Cart::Empty do+ subject { described_class.call order: order }++ context 'when order is given' do+ let(:order) { Spree::Order.create(email: '[email protected]') }+ let(:promotion) { create :promotion, code: '10off' }++ before do+ promotion.orders << order+ end++ context 'completed order' do+ before do+ order.update_columns(state: 'complete', completed_at: Time.current)+ end++ it 'returns failure' do+ expect(subject.success?).to be false+ expect(subject.value).to eq Spree.t(:cannot_empty)+ end+ end++ context 'incomplete order' do+ before { subject }++ it 'returns success' do+ expect(subject.success?).to be true+ expect(subject.value).to eq(order)+ end++ it 'clears out line items, adjustments and update totals' do+ expect(order.line_items.count).to be_zero+ expect(order.adjustments.count).to be_zero+ expect(order.shipments.count).to be_zero+ expect(order.order_promotions.count).to be_zero+ expect(order.promo_total).to be_zero+ expect(order.item_total).to be_zero+ expect(order.ship_total).to be_zero+ end+ end+ end++ context 'when nil is given' do+ let(:order) { nil }++ before { subject }++ it 'returns failure' do+ expect(subject.success?).to be false+ expect(subject.value).to eq Spree.t(:cannot_empty)+ end+ end+ end+enddiff --git a/frontend/app/controllers/spree/orders_controller.rb b/frontend/app/controllers/spree/orders_controller.rbindex b41d6bac5b..9fe8a8dddc 100644--- a/frontend/app/controllers/spree/orders_controller.rb+++ b/frontend/app/controllers/spree/orders_controller.rb@@ -38,7 +38,7 @@ module Spreeenddef empty- current_order.try(:empty!)+ cart_empty_service.call(order: current_order)redirect_to spree.cart_pathend@@ -85,5 +85,9 @@ module Spreedef cart_add_item_serviceSpree::Dependencies.cart_add_item_service.constantizeend++ def cart_empty_service+ Spree::Dependencies.cart_empty_service.constantize+ endendenddiff --git a/frontend/spec/controllers/spree/orders_controller_spec.rb b/frontend/spec/controllers/spree/orders_controller_spec.rbindex 9503ea1633..73d46496d6 100644--- a/frontend/spec/controllers/spree/orders_controller_spec.rb+++ b/frontend/spec/controllers/spree/orders_controller_spec.rb@@ -38,12 +38,19 @@ describe Spree::OrdersController, type: :controller docontext '#empty' dobefore doallow(controller).to receive :check_authorization+ allow(controller).to receive(:current_order).and_return(order)+ put :emptyendit 'destroys line items in the current order' do- allow(controller).to receive(:current_order).and_return(order)- expect(order).to receive(:empty!)- put :empty+ expect(order.reload.line_items).to be_empty+ end++ it 'destroys adjustments' do+ expect(order.reload.adjustments).to be_empty+ end++ it 'redirects to spree cart path' doexpect(response).to redirect_to(spree.cart_path)endend