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.

Always use relationships in the serializers (#12530)

Damian Kaczmarczyk09e35b48d0aa
diff --git a/api/app/serializers/spree/v2/storefront/estimated_shipping_rate_serializer.rb b/api/app/serializers/spree/v2/storefront/estimated_shipping_rate_serializer.rb
index ba250d27d3..604d0cb59d 100644
--- a/api/app/serializers/spree/v2/storefront/estimated_shipping_rate_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/estimated_shipping_rate_serializer.rb
@@ -6,7 +6,13 @@ module Spree
cache_options store: nil
- attributes :name, :selected, :cost, :tax_amount, :shipping_method_id
+ attributes :name, :selected, :cost, :tax_amount
+
+ attribute :shipping_method_id do |shipping_rate|
+ shipping_rate.shipping_method_id.to_s
+ end
+
+ belongs_to :shipping_method
attribute :final_price do |shipping_rate|
shipping_rate.cost
diff --git a/api/app/serializers/spree/v2/storefront/payment_serializer.rb b/api/app/serializers/spree/v2/storefront/payment_serializer.rb
index 84baf8aca9..0e9ed08a64 100644
--- a/api/app/serializers/spree/v2/storefront/payment_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/payment_serializer.rb
@@ -7,8 +7,11 @@ module Spree
has_one :source, polymorphic: true
has_one :payment_method
- attributes :amount, :response_code, :number, :cvv_response_code, :cvv_response_message,
- :payment_method_id, :payment_method_name, :state, :public_metadata
+ attributes :amount, :response_code, :number, :cvv_response_code, :cvv_response_message, :payment_method_name, :state, :public_metadata
+
+ attribute :payment_method_id do |payment|
+ payment.payment_method_id.to_s
+ end
end
end
end
diff --git a/api/app/serializers/spree/v2/storefront/shipping_rate_serializer.rb b/api/app/serializers/spree/v2/storefront/shipping_rate_serializer.rb
index ba17558396..7c4510e5fd 100644
--- a/api/app/serializers/spree/v2/storefront/shipping_rate_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/shipping_rate_serializer.rb
@@ -5,7 +5,13 @@ module Spree
set_type :shipping_rate
attributes :name, :selected, :final_price, :display_final_price, :cost,
- :display_cost, :tax_amount, :display_tax_amount, :shipping_method_id
+ :display_cost, :tax_amount, :display_tax_amount
+
+ attribute :shipping_method_id do |shipping_rate|
+ shipping_rate.shipping_method_id.to_s
+ end
+
+ belongs_to :shipping_method
attribute :free do |shipping_rate|
shipping_rate.free?
diff --git a/api/spec/requests/spree/api/v2/storefront/cart_spec.rb b/api/spec/requests/spree/api/v2/storefront/cart_spec.rb
index c3813eda0e..8469321e9c 100644
--- a/api/spec/requests/spree/api/v2/storefront/cart_spec.rb
+++ b/api/spec/requests/spree/api/v2/storefront/cart_spec.rb
@@ -918,7 +918,7 @@ describe 'API V2 Storefront Cart Spec', type: :request do
it 'returns valid shipments JSON' do
[{ shipping_method: shipping_method, shipping_rate: shipping_rate }, { shipping_method: shipping_method_2, shipping_rate: shipping_rate_2 }].each do |shipping|
expect(json_response['data']).to include(have_type('shipping_rate').and(have_attribute(:name).with_value(shipping[:shipping_method].name)))
- expect(json_response['data']).to include(have_type('shipping_rate').and(have_attribute(:shipping_method_id).with_value(shipping[:shipping_method].id)))
+ expect(json_response['data']).to include(have_type('shipping_rate').and(have_attribute(:shipping_method_id).with_value(shipping[:shipping_method].id.to_s)))
expect(json_response['data']).to include(have_type('shipping_rate').and(have_attribute(:cost).with_value(shipping[:shipping_rate].cost.to_s)))
expect(json_response['data']).to include(have_type('shipping_rate').and(have_attribute(:tax_amount).with_value(shipping[:shipping_rate].tax_amount.to_s)))
expect(json_response['data']).to include(have_type('shipping_rate').and(have_attribute(:selected).with_value(shipping[:shipping_rate].selected)))
@@ -927,6 +927,7 @@ describe 'API V2 Storefront Cart Spec', type: :request do
expect(json_response['data']).to include(have_type('shipping_rate').and(have_attribute(:display_final_price).with_value(shipping[:shipping_rate].display_final_price.to_s)))
expect(json_response['data']).to include(have_type('shipping_rate').and(have_attribute(:display_cost).with_value(shipping[:shipping_rate].display_cost.to_s)))
expect(json_response['data']).to include(have_type('shipping_rate').and(have_attribute(:display_tax_amount).with_value(shipping[:shipping_rate].display_tax_amount.to_s)))
+ expect(json_response['data']).to include(have_type('shipping_rate').and(have_relationship(:shipping_method).with_data({ 'id' => shipping[:shipping_method].id.to_s, 'type' => 'shipping_method' })))
end
end
end
diff --git a/api/spec/requests/spree/api/v2/storefront/checkout_spec.rb b/api/spec/requests/spree/api/v2/storefront/checkout_spec.rb
index 88a6a593ef..618c61c4f6 100644
--- a/api/spec/requests/spree/api/v2/storefront/checkout_spec.rb
+++ b/api/spec/requests/spree/api/v2/storefront/checkout_spec.rb
@@ -737,22 +737,23 @@ describe 'API V2 Storefront Checkout Spec', type: :request do
expect(json_response['data'][0]).to have_relationships(:shipping_rates)
expect(json_response['included']).to be_present
expect(json_response['included'].size).to eq(shipment.shipping_rates.count + 2)
- [{shipping_method: shipping_method, shipping_rate: shipping_rate}, {shipping_method: shipping_method_2, shipping_rate: shipping_rate_2}].each do |shipping|
- expect(json_response['included']).to include(have_type('shipping_rate').and have_attribute(:name).with_value(shipping[:shipping_method].name))
- expect(json_response['included']).to include(have_type('shipping_rate').and have_attribute(:shipping_method_id).with_value(shipping[:shipping_method].id))
- expect(json_response['included']).to include(have_type('shipping_rate').and have_id(shipping[:shipping_rate].id.to_s))
- expect(json_response['included']).to include(have_type('shipping_rate').and have_attribute(:cost).with_value(shipping[:shipping_rate].cost.to_s))
- expect(json_response['included']).to include(have_type('shipping_rate').and have_attribute(:tax_amount).with_value(shipping[:shipping_rate].tax_amount.to_s))
- expect(json_response['included']).to include(have_type('shipping_rate').and have_attribute(:selected).with_value(shipping[:shipping_rate].selected))
- expect(json_response['included']).to include(have_type('shipping_rate').and have_attribute(:final_price).with_value(shipping[:shipping_rate].final_price.to_s))
- expect(json_response['included']).to include(have_type('shipping_rate').and have_attribute(:free).with_value(shipping[:shipping_rate].free?))
- expect(json_response['included']).to include(have_type('shipping_rate').and have_attribute(:display_final_price).with_value(shipping[:shipping_rate].display_final_price.to_s))
- expect(json_response['included']).to include(have_type('shipping_rate').and have_attribute(:display_cost).with_value(shipping[:shipping_rate].display_cost.to_s))
- expect(json_response['included']).to include(have_type('shipping_rate').and have_attribute(:display_tax_amount).with_value(shipping[:shipping_rate].display_tax_amount.to_s))
+ [{ shipping_method: shipping_method, shipping_rate: shipping_rate }, { shipping_method: shipping_method_2, shipping_rate: shipping_rate_2 }].each do |shipping|
+ expect(json_response['included']).to include(have_type('shipping_rate').and(have_attribute(:name).with_value(shipping[:shipping_method].name)))
+ expect(json_response['included']).to include(have_type('shipping_rate').and(have_attribute(:shipping_method_id).with_value(shipping[:shipping_method].id.to_s)))
+ expect(json_response['included']).to include(have_type('shipping_rate').and(have_relationship(:shipping_method).with_data({ 'id' => shipping[:shipping_method].id.to_s, 'type' => 'shipping_method' })))
+ expect(json_response['included']).to include(have_type('shipping_rate').and(have_id(shipping[:shipping_rate].id.to_s)))
+ expect(json_response['included']).to include(have_type('shipping_rate').and(have_attribute(:cost).with_value(shipping[:shipping_rate].cost.to_s)))
+ expect(json_response['included']).to include(have_type('shipping_rate').and(have_attribute(:tax_amount).with_value(shipping[:shipping_rate].tax_amount.to_s)))
+ expect(json_response['included']).to include(have_type('shipping_rate').and(have_attribute(:selected).with_value(shipping[:shipping_rate].selected)))
+ expect(json_response['included']).to include(have_type('shipping_rate').and(have_attribute(:final_price).with_value(shipping[:shipping_rate].final_price.to_s)))
+ expect(json_response['included']).to include(have_type('shipping_rate').and(have_attribute(:free).with_value(shipping[:shipping_rate].free?)))
+ expect(json_response['included']).to include(have_type('shipping_rate').and(have_attribute(:display_final_price).with_value(shipping[:shipping_rate].display_final_price.to_s)))
+ expect(json_response['included']).to include(have_type('shipping_rate').and(have_attribute(:display_cost).with_value(shipping[:shipping_rate].display_cost.to_s)))
+ expect(json_response['included']).to include(have_type('shipping_rate').and(have_attribute(:display_tax_amount).with_value(shipping[:shipping_rate].display_tax_amount.to_s)))
end
- expect(json_response['included']).to include(have_type('stock_location').and have_id(shipment.stock_location_id.to_s))
- expect(json_response['included']).to include(have_type('stock_location').and have_attribute(:name).with_value(shipment.stock_location.name))
- expect(json_response['included']).to include(have_type('line_item').and have_id(shipment.line_items.first.id.to_s))
+ expect(json_response['included']).to include(have_type('stock_location').and(have_id(shipment.stock_location_id.to_s)))
+ expect(json_response['included']).to include(have_type('stock_location').and(have_attribute(:name).with_value(shipment.stock_location.name)))
+ expect(json_response['included']).to include(have_type('line_item').and(have_id(shipment.line_items.first.id.to_s)))
end
end
@@ -1045,7 +1046,7 @@ describe 'API V2 Storefront Checkout Spec', type: :request do
it_behaves_like 'returns valid cart JSON'
- it 'should return an error' do
+ it 'returns an error' do
expect(json_response['meta']['messages']).to eq(["#{product.name} was removed because it was discontinued"])
end
end
@@ -1061,7 +1062,7 @@ describe 'API V2 Storefront Checkout Spec', type: :request do
it_behaves_like 'returns valid cart JSON'
- it 'should return an error' do
+ it 'returns an error' do
expect(json_response['meta']['messages']).to eq(['Cart changed'])
end
end
@@ -1092,7 +1093,7 @@ describe 'API V2 Storefront Checkout Spec', type: :request do
post '/api/v2/storefront/checkout/validate_order_for_payment', headers: headers, params: { skip_state: true }
end
- it 'should return a valid cart' do
+ it 'returns a valid cart' do
expect(json_response['data']).to have_id(order.id.to_s)
expect(response.status).to eq(200)
end
@@ -1106,7 +1107,7 @@ describe 'API V2 Storefront Checkout Spec', type: :request do
post '/api/v2/storefront/checkout/validate_order_for_payment', headers: headers
end
- it 'should return an error' do
+ it 'returns an error' do
expect(response.status).to eq(422)
expect(json_response['meta']['messages']).to eq(['Cart changed'])
end
diff --git a/docs/api-reference/storefront.yaml b/docs/api-reference/storefront.yaml
index fb95a16e9d..09ff8671c2 100644
--- a/docs/api-reference/storefront.yaml
+++ b/docs/api-reference/storefront.yaml
@@ -3818,10 +3818,20 @@ components:
type: boolean
example: true
description: 'Indicates if the Shipping Rate is free, eg. when Free shipping promo applied to Cart'
+ relationships:
+ type: object
+ properties:
+ shipping_method:
+ type: object
+ description: Shipping method for which this shipping rate belongs to
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
+ - relationships
StockLocation:
title: Stock Location
type: object
@@ -5186,7 +5196,7 @@ components:
number: PN43O2GK
cvv_response_code: null
cvv_response_message: null
- payment_method_id: 2
+ payment_method_id: "2"
payment_method_name: Check
state: completed
relationships:
@@ -5596,7 +5606,7 @@ components:
number: PN43O2GK
cvv_response_code: null
cvv_response_message: null
- payment_method_id: 2
+ payment_method_id: "2"
payment_method_name: Check
state: completed
relationships:
@@ -15957,8 +15967,13 @@ components:
display_cost: $5.00
tax_amount: '0.0'
display_tax_amount: $0.00
- shipping_method_id: 1
+ shipping_method_id: "1"
free: false
+ relationships:
+ shipping_method:
+ data:
+ id: "1"
+ type: shipping_method
- id: '11'
type: shipping_rate
attributes:
@@ -15970,8 +15985,13 @@ components:
display_cost: $10.00
tax_amount: '0.0'
display_tax_amount: $0.00
- shipping_method_id: 2
+ shipping_method_id: "2"
free: false
+ relationships:
+ shipping_method:
+ data:
+ id: "2"
+ type: "shipping_method"
- id: '12'
type: shipping_rate
attributes:
@@ -15983,8 +16003,13 @@ components:
display_cost: $15.00
tax_amount: '0.0'
display_tax_amount: $0.00
- shipping_method_id: 3
+ shipping_method_id: "3"
free: false
+ relationships:
+ shipping_method:
+ data:
+ id: "3"
+ type: shipping_method
- id: '1'
type: stock_location
attributes:
@@ -16013,12 +16038,17 @@ components:
selected: true
cost: '5.0'
tax_amount: '0.0'
- shipping_method_id: 1
final_price: '5.0'
+ shipping_method_id: "1"
display_cost: $5.00
display_final_price: $5.00
display_tax_amount: $0.00
free: false
+ relationships:
+ shipping_method:
+ data:
+ type: shipping_method
+ id: "1"
- id: null
type: shipping_rate
attributes:
@@ -16026,12 +16056,17 @@ components:
selected: false
cost: '10.0'
tax_amount: '0.0'
- shipping_method_id: 2
final_price: '10.0'
+ shipping_method_id: "2"
display_cost: $10.00
display_final_price: $10.00
display_tax_amount: $0.00
free: false
+ relationships:
+ shipping_method:
+ data:
+ id: "2"
+ type: shipping_method
- id: null
type: shipping_rate
attributes:
@@ -16039,12 +16074,17 @@ components:
selected: false
cost: '15.0'
tax_amount: '0.0'
- shipping_method_id: 3
final_price: '15.0'
+ shipping_method_id: "3"
display_cost: $15.00
display_final_price: $15.00
display_tax_amount: $0.00
free: false
+ relationships:
+ shipping_method:
+ data:
+ id: "3"
+ type: shipping_method
Menu:
description: 200 Success - Returns the `menu` object.
content: