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.

Add request specs for cart item and product validation failures

Damian Legawiec7db66705c842
diff --git a/packages/admin-sdk/src/types/generated/Store.ts b/packages/admin-sdk/src/types/generated/Store.ts
index 0ef69afd6b..7c90399a7f 100644
--- a/packages/admin-sdk/src/types/generated/Store.ts
+++ b/packages/admin-sdk/src/types/generated/Store.ts
@@ -26,6 +26,7 @@ interface Store {
preferred_storefront_access: string;
preferred_guest_checkout: boolean;
preferred_company_field_enabled: boolean;
+ preferred_address_requires_company: boolean;
preferred_address_requires_phone: boolean;
preferred_capture_method: string;
preferred_track_inventory_levels: boolean;
diff --git a/spree/api/app/controllers/spree/api/v3/admin/store_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/store_controller.rb
index 6486e54dc5..4af8ec4547 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/store_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/store_controller.rb
@@ -56,6 +56,7 @@ module Spree
:preferred_storefront_url,
:preferred_guest_checkout,
:preferred_company_field_enabled,
+ :preferred_address_requires_company,
:preferred_address_requires_phone,
:preferred_capture_method,
# @deprecated Superseded by preferred_capture_method; the model
diff --git a/spree/api/app/serializers/spree/api/v3/admin/store_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/store_serializer.rb
index 29a296076e..ad61a99609 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/store_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/store_serializer.rb
@@ -26,6 +26,7 @@ module Spree
preferred_storefront_access: :string,
preferred_guest_checkout: :boolean,
preferred_company_field_enabled: :boolean,
+ preferred_address_requires_company: :boolean,
preferred_address_requires_phone: :boolean,
preferred_capture_method: :string,
preferred_track_inventory_levels: :boolean,
@@ -62,6 +63,7 @@ module Spree
:preferred_storefront_access,
:preferred_guest_checkout,
:preferred_company_field_enabled,
+ :preferred_address_requires_company,
:preferred_address_requires_phone,
:preferred_capture_method,
:preferred_track_inventory_levels,
diff --git a/spree/api/spec/integration/spree/api/v3/admin/products_spec.rb b/spree/api/spec/integration/spree/api/v3/admin/products_spec.rb
index f03f72f11e..f4dabb6ccf 100644
--- a/spree/api/spec/integration/spree/api/v3/admin/products_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/admin/products_spec.rb
@@ -346,6 +346,29 @@ RSpec.describe 'Admin Products API', type: :request, swagger_doc: 'api-reference
expect(product.reload.deleted_at).not_to be_nil
end
end
+
+ # A store rule registered on 'products.destroy.validate' can refuse the
+ # deletion outright — a product still under a supplier contract, or one
+ # a live campaign points at.
+ response '422', 'deletion refused by a store rule' do
+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }
+ let(:id) { product.prefixed_id }
+
+ before do
+ Spree.hooks.register('products.destroy.validate') do |workflow|
+ workflow.errors.add(:base, :under_contract, message: 'This product is under an active supplier contract.')
+ workflow.reject!
+ end
+ end
+
+ after { Spree.hooks.clear! }
+
+ schema '$ref' => '#/components/schemas/ErrorResponse'
+
+ run_test! do
+ expect(product.reload.deleted_at).to be_nil
+ end
+ end
end
end
diff --git a/spree/api/spec/integration/spree/api/v3/store/line_items_spec.rb b/spree/api/spec/integration/spree/api/v3/store/line_items_spec.rb
index fbbf7e132d..a3108c5a23 100644
--- a/spree/api/spec/integration/spree/api/v3/store/line_items_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/store/line_items_spec.rb
@@ -78,6 +78,38 @@ RSpec.describe 'Cart Items API', type: :request, swagger_doc: 'api-reference/sto
run_test!
end
+
+ # A store rule registered on 'carts.add_item.validate' — a purchase
+ # limit, a B2B eligibility check — rejects the add. The field name and
+ # symbolic code come from the handler, so clients read it exactly like a
+ # model validation failure.
+ response '422', 'rejected by a store rule' do
+ let(:new_product) { create(:product) }
+ let(:new_variant) { new_product.default_variant }
+ let(:'x-spree-api-key') { api_key.token }
+ let(:'Authorization') { "Bearer #{jwt_token}" }
+ let(:body) { { variant_id: new_variant.prefixed_id, quantity: 99 } }
+
+ before do
+ Spree.hooks.register('carts.add_item.validate') do |workflow|
+ next if workflow.quantity <= 10
+
+ workflow.errors.add(:quantity, :purchase_limit_exceeded,
+ message: 'You can order at most 10 of this item.')
+ workflow.reject!
+ end
+ end
+
+ after { Spree.hooks.clear! }
+
+ schema '$ref' => '#/components/schemas/ErrorResponse'
+
+ run_test! do |response|
+ data = JSON.parse(response.body)
+ expect(data['error']['details']['quantity']).to eq(['You can order at most 10 of this item.'])
+ expect(order.reload.line_items.count).to eq(1)
+ end
+ end
end
end
@@ -130,6 +162,37 @@ RSpec.describe 'Cart Items API', type: :request, swagger_doc: 'api-reference/sto
expect(line_item.reload.metadata).to include('engraving' => 'J.D.')
end
end
+
+ # Quantity changes run the same rules as adding, but a rejection here is
+ # NOT an error: the item keeps its previous quantity and the reason comes
+ # back in the cart's warnings, so a client updating several lines still
+ # gets the ones that were allowed.
+ response '200', 'quantity change rejected, reported in warnings' do
+ let(:'x-spree-api-key') { api_key.token }
+ let(:'Authorization') { "Bearer #{jwt_token}" }
+ let(:id) { line_item.to_param }
+ let(:body) { { quantity: 99 } }
+
+ before do
+ Spree.hooks.register('carts.upsert_items.validate') do |workflow|
+ next if workflow.quantity <= 10
+
+ workflow.errors.add(:quantity, :purchase_limit_exceeded,
+ message: 'You can order at most 10 of this item.')
+ workflow.reject!
+ end
+ end
+
+ after { Spree.hooks.clear! }
+
+ schema '$ref' => '#/components/schemas/Cart'
+
+ run_test! do |response|
+ data = JSON.parse(response.body)
+ expect(data['warnings'].first['code']).to eq('purchase_limit_exceeded')
+ expect(line_item.reload.quantity).to eq(1)
+ end
+ end
end
delete 'Remove line item from cart' do