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.

Fixed integration tests, improved Order-nested API endpoints

Damian Legawiecb2c034ea4f8b
diff --git a/api/app/controllers/spree/api/v3/store/orders/payment_methods_controller.rb b/api/app/controllers/spree/api/v3/store/orders/payment_methods_controller.rb
index 8254b69890..c701471c87 100644
--- a/api/app/controllers/spree/api/v3/store/orders/payment_methods_controller.rb
+++ b/api/app/controllers/spree/api/v3/store/orders/payment_methods_controller.rb
@@ -6,12 +6,13 @@ module Spree
class PaymentMethodsController < Store::BaseController
include Spree::Api::V3::OrderConcern
- before_action :set_order, only: [:index]
+ before_action :set_parent
+ before_action :authorize_order_read!
# GET /api/v3/store/orders/:order_id/payment_methods
# Returns available payment methods for the current order
def index
- payment_methods = @order.collect_frontend_payment_methods
+ payment_methods = @parent.collect_frontend_payment_methods
render json: {
data: serialize_collection(payment_methods),
meta: { count: payment_methods.size }
@@ -20,10 +21,8 @@ module Spree
protected
- def set_order
- @order = current_store.orders.friendly.find(params[:order_id])
- # Order access is verified through order ownership or token
- unless can?(:show, @order) || order_token == @order.token
+ def authorize_order_read!
+ unless can?(:show, @parent) || order_token == @parent.token
raise CanCan::AccessDenied, 'You are not authorized to access this page.'
end
end
diff --git a/api/app/controllers/spree/api/v3/store/orders/payments_controller.rb b/api/app/controllers/spree/api/v3/store/orders/payments_controller.rb
index bfb67c8aab..2695ded006 100644
--- a/api/app/controllers/spree/api/v3/store/orders/payments_controller.rb
+++ b/api/app/controllers/spree/api/v3/store/orders/payments_controller.rb
@@ -7,12 +7,13 @@ module Spree
include Spree::Api::V3::OrderConcern
include Spree::Api::V3::ResourceSerializer
- before_action :set_order
+ before_action :set_parent
+ before_action :authorize_order_read!
before_action :set_payment, only: [:show]
# GET /api/v3/store/orders/:order_id/payments
def index
- payments = @order.payments.includes(:payment_method)
+ payments = @parent.payments.includes(:payment_method)
render json: {
data: serialize_payments(payments),
meta: {}
@@ -26,13 +27,12 @@ module Spree
private
- def set_order
- @order = current_store.orders.friendly.find(params[:order_id])
- authorize!(:show, @order, order_token)
+ def authorize_order_read!
+ authorize!(:show, @parent, order_token)
end
def set_payment
- @payment = @order.payments.find_by!(prefix_id: params[:id])
+ @payment = @parent.payments.find_by!(prefix_id: params[:id])
end
def serializer_class
diff --git a/api/app/controllers/spree/api/v3/store/orders/promotions_controller.rb b/api/app/controllers/spree/api/v3/store/orders/promotions_controller.rb
index dc8059d73e..064f241534 100644
--- a/api/app/controllers/spree/api/v3/store/orders/promotions_controller.rb
+++ b/api/app/controllers/spree/api/v3/store/orders/promotions_controller.rb
@@ -36,10 +36,6 @@ module Spree
protected
- def set_parent
- @parent = current_store.orders.friendly.find(params[:order_id])
- end
-
def parent_association
:order_promotions
end
diff --git a/api/app/controllers/spree/api/v3/store/orders/shipments_controller.rb b/api/app/controllers/spree/api/v3/store/orders/shipments_controller.rb
index 33f4581883..a19633f752 100644
--- a/api/app/controllers/spree/api/v3/store/orders/shipments_controller.rb
+++ b/api/app/controllers/spree/api/v3/store/orders/shipments_controller.rb
@@ -23,10 +23,6 @@ module Spree
protected
- def set_parent
- @parent = current_store.orders.friendly.find(params[:order_id])
- end
-
def parent_association
:shipments
end
diff --git a/api/app/controllers/spree/api/v3/store/orders/store_credits_controller.rb b/api/app/controllers/spree/api/v3/store/orders/store_credits_controller.rb
index 9dcf6ecc95..0eb6b40004 100644
--- a/api/app/controllers/spree/api/v3/store/orders/store_credits_controller.rb
+++ b/api/app/controllers/spree/api/v3/store/orders/store_credits_controller.rb
@@ -8,17 +8,18 @@ module Spree
include Spree::Api::V3::ResourceSerializer
before_action :require_authentication!
- before_action :set_order
+ before_action :set_parent
+ before_action :authorize_order_access!
# POST /api/v3/store/orders/:order_id/store_credits
def create
result = Spree.checkout_add_store_credit_service.call(
- order: @order,
+ order: @parent,
amount: params[:amount].try(:to_f)
)
if result.success?
- render json: serialize_resource(@order.reload)
+ render json: serialize_resource(@parent.reload)
else
render_service_error(result.error)
end
@@ -26,10 +27,10 @@ module Spree
# DELETE /api/v3/store/orders/:order_id/store_credits
def destroy
- result = Spree.checkout_remove_store_credit_service.call(order: @order)
+ result = Spree.checkout_remove_store_credit_service.call(order: @parent)
if result.success?
- render json: serialize_resource(@order.reload)
+ render json: serialize_resource(@parent.reload)
else
render_service_error(result.error)
end
@@ -37,11 +38,6 @@ module Spree
protected
- def set_order
- @order = current_store.orders.friendly.find(params[:order_id])
- authorize!(:update, @order, order_token)
- end
-
def serializer_class
Spree.api.order_serializer
end
diff --git a/api/spec/controllers/spree/api/v3/store/orders/payment_methods_controller_spec.rb b/api/spec/controllers/spree/api/v3/store/orders/payment_methods_controller_spec.rb
new file mode 100644
index 0000000000..5392e2194c
--- /dev/null
+++ b/api/spec/controllers/spree/api/v3/store/orders/payment_methods_controller_spec.rb
@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Api::V3::Store::Orders::PaymentMethodsController, type: :controller do
+ render_views
+
+ include_context 'API v3 Store'
+
+ let(:order) { create(:order_with_line_items, user: user, store: store, state: 'payment') }
+ let!(:payment_method) { create(:credit_card_payment_method, stores: [store], display_on: 'both') }
+ let!(:backend_only_pm) { create(:credit_card_payment_method, stores: [store], display_on: 'back_end') }
+
+ before do
+ request.headers['X-Spree-Api-Key'] = api_key.token
+ request.headers['Authorization'] = "Bearer #{jwt_token}"
+ end
+
+ describe 'GET #index' do
+ it 'returns available payment methods for the order' do
+ get :index, params: { order_id: order.to_param }
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['data'].map { |pm| pm['id'] }).to include(payment_method.prefix_id)
+ end
+
+ it 'excludes backend-only payment methods' do
+ get :index, params: { order_id: order.to_param }
+
+ expect(json_response['data'].map { |pm| pm['id'] }).not_to include(backend_only_pm.prefix_id)
+ end
+
+ it 'includes payment method count in meta' do
+ get :index, params: { order_id: order.to_param }
+
+ expect(json_response['meta']['count']).to be_present
+ end
+
+ context 'with order token (guest)' do
+ let(:guest_order) { create(:order_with_line_items, store: store, state: 'payment') }
+
+ before { request.headers['Authorization'] = nil }
+
+ it 'returns payment methods with valid order token' do
+ request.headers['X-Spree-Order-Token'] = guest_order.token
+ get :index, params: { order_id: guest_order.to_param }
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['data']).to be_present
+ end
+
+ it 'returns forbidden without order token' do
+ get :index, params: { order_id: guest_order.to_param }
+
+ expect(response).to have_http_status(:forbidden)
+ expect(json_response['error']['code']).to eq('access_denied')
+ end
+ end
+
+ context 'error handling' do
+ it 'returns not found for non-existent order' do
+ get :index, params: { order_id: 'invalid' }
+
+ expect(response).to have_http_status(:not_found)
+ expect(json_response['error']['code']).to eq('order_not_found')
+ end
+
+ it 'returns forbidden for other users order' do
+ other_order = create(:order, store: store)
+
+ get :index, params: { order_id: other_order.to_param }
+
+ expect(response).to have_http_status(:forbidden)
+ expect(json_response['error']['code']).to eq('access_denied')
+ end
+ end
+ end
+end
diff --git a/api/spec/controllers/spree/api/v3/store/orders/payments_controller_spec.rb b/api/spec/controllers/spree/api/v3/store/orders/payments_controller_spec.rb
new file mode 100644
index 0000000000..1e308785e0
--- /dev/null
+++ b/api/spec/controllers/spree/api/v3/store/orders/payments_controller_spec.rb
@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Api::V3::Store::Orders::PaymentsController, type: :controller do
+ render_views
+
+ include_context 'API v3 Store'
+
+ let(:order) { create(:order_with_line_items, user: user, store: store, state: 'payment') }
+ let(:payment_method) { create(:credit_card_payment_method, stores: [store]) }
+ let!(:payment) { create(:payment, order: order, payment_method: payment_method, amount: order.total) }
+
+ before do
+ request.headers['X-Spree-Api-Key'] = api_key.token
+ request.headers['Authorization'] = "Bearer #{jwt_token}"
+ end
+
+ describe 'GET #index' do
+ it 'returns a list of payments for the order' do
+ get :index, params: { order_id: order.to_param }
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['data'].size).to eq(1)
+ expect(json_response['data'].first['id']).to eq(payment.prefix_id)
+ end
+
+ it 'includes payment method information' do
+ get :index, params: { order_id: order.to_param }
+
+ expect(json_response['data'].first['payment_method_id']).to eq(payment_method.prefix_id)
+ end
+
+ context 'with order token (guest)' do
+ let(:guest_order) { create(:order_with_line_items, store: store, state: 'payment') }
+ let!(:guest_payment) { create(:payment, order: guest_order, payment_method: payment_method) }
+
+ before { request.headers['Authorization'] = nil }
+
+ it 'returns payments with valid order token' do
+ request.headers['X-Spree-Order-Token'] = guest_order.token
+ get :index, params: { order_id: guest_order.to_param }
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['data'].size).to eq(1)
+ end
+
+ it 'returns forbidden without order token' do
+ get :index, params: { order_id: guest_order.to_param }
+
+ expect(response).to have_http_status(:forbidden)
+ expect(json_response['error']['code']).to eq('access_denied')
+ end
+ end
+
+ context 'error handling' do
+ it 'returns not found for non-existent order' do
+ get :index, params: { order_id: 'invalid' }
+
+ expect(response).to have_http_status(:not_found)
+ expect(json_response['error']['code']).to eq('order_not_found')
+ end
+
+ it 'returns forbidden for other users order' do
+ other_order = create(:order, store: store)
+
+ get :index, params: { order_id: other_order.to_param }
+
+ expect(response).to have_http_status(:forbidden)
+ expect(json_response['error']['code']).to eq('access_denied')
+ end
+ end
+ end
+
+ describe 'GET #show' do
+ it 'returns a single payment' do
+ get :show, params: { order_id: order.to_param, id: payment.to_param }
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['id']).to eq(payment.prefix_id)
+ expect(json_response['state']).to eq(payment.state)
+ expect(json_response['amount']).to eq(payment.amount.to_s)
+ end
+
+ context 'error handling' do
+ it 'returns not found for non-existent payment' do
+ get :show, params: { order_id: order.to_param, id: 'invalid' }
+
+ expect(response).to have_http_status(:not_found)
+ expect(json_response['error']['code']).to eq('record_not_found')
+ end
+
+ it 'returns not found for payment from another order' do
+ other_order = create(:order_with_line_items, user: user, store: store, state: 'payment')
+ other_payment = create(:payment, order: other_order, payment_method: payment_method, amount: other_order.total)
+
+ get :show, params: { order_id: order.to_param, id: other_payment.to_param }
+
+ expect(response).to have_http_status(:not_found)
+ expect(json_response['error']['code']).to eq('record_not_found')
+ end
+ end
+ end
+end
diff --git a/api/spec/controllers/spree/api/v3/store/orders/shipments_controller_spec.rb b/api/spec/controllers/spree/api/v3/store/orders/shipments_controller_spec.rb
new file mode 100644
index 0000000000..6dbafec5ed
--- /dev/null
+++ b/api/spec/controllers/spree/api/v3/store/orders/shipments_controller_spec.rb
@@ -0,0 +1,140 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Api::V3::Store::Orders::ShipmentsController, type: :controller do
+ render_views
+
+ include_context 'API v3 Store'
+
+ let(:order) do
+ create(:order_with_line_items, user: user, store: store, state: 'delivery').tap do |o|
+ o.create_proposed_shipments
+ o.shipments.first.refresh_rates
+ o.reload
+ end
+ end
+ let(:shipment) { order.shipments.first }
+
+ before do
+ request.headers['X-Spree-Api-Key'] = api_key.token
+ request.headers['Authorization'] = "Bearer #{jwt_token}"
+ request.headers['X-Spree-Order-Token'] = order.token
+ end
+
+ describe 'GET #index' do
+ it 'returns a list of shipments for the order' do
+ get :index, params: { order_id: order.to_param }
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['data'].size).to eq(order.shipments.count)
+ expect(json_response['data'].first['id']).to eq(shipment.prefix_id)
+ end
+
+ context 'with order token (guest)' do
+ let(:guest_order) do
+ create(:order_with_line_items, store: store, state: 'delivery').tap do |o|
+ o.create_proposed_shipments
+ o.reload
+ end
+ end
+
+ before { request.headers['Authorization'] = nil }
+
+ it 'returns shipments with valid order token' do
+ request.headers['X-Spree-Order-Token'] = guest_order.token
+ get :index, params: { order_id: guest_order.to_param }
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['data']).to be_present
+ end
+
+ it 'returns forbidden without order token' do
+ request.headers['X-Spree-Order-Token'] = nil
+ get :index, params: { order_id: guest_order.to_param }
+
+ expect(response).to have_http_status(:forbidden)
+ expect(json_response['error']['code']).to eq('access_denied')
+ end
+ end
+
+ context 'error handling' do
+ it 'returns not found for non-existent order' do
+ get :index, params: { order_id: 'invalid' }
+
+ expect(response).to have_http_status(:not_found)
+ expect(json_response['error']['code']).to eq('order_not_found')
+ end
+
+ it 'returns forbidden for other users order' do
+ other_order = create(:order_with_line_items, store: store)
+ request.headers['X-Spree-Order-Token'] = nil
+
+ get :index, params: { order_id: other_order.to_param }
+
+ expect(response).to have_http_status(:forbidden)
+ expect(json_response['error']['code']).to eq('access_denied')
+ end
+ end
+ end
+
+ describe 'GET #show' do
+ it 'returns a single shipment' do
+ get :show, params: { order_id: order.to_param, id: shipment.to_param }
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['id']).to eq(shipment.prefix_id)
+ expect(json_response['state']).to eq(shipment.state)
+ end
+
+ context 'error handling' do
+ it 'returns not found for non-existent shipment' do
+ get :show, params: { order_id: order.to_param, id: 'invalid' }
+
+ expect(response).to have_http_status(:not_found)
+ expect(json_response['error']['code']).to eq('record_not_found')
+ end
+
+ it 'returns not found for shipment from another order' do
+ other_order = create(:order_with_line_items, user: user, store: store).tap do |o|
+ o.create_proposed_shipments
+ o.reload
+ end
+ other_shipment = other_order.shipments.first
+
+ get :show, params: { order_id: order.to_param, id: other_shipment.to_param }
+
+ expect(response).to have_http_status(:not_found)
+ expect(json_response['error']['code']).to eq('record_not_found')
+ end
+ end
+ end
+
+ describe 'PATCH #update' do
+ let(:shipping_rate) { shipment.shipping_rates.first }
+
+ it 'selects a shipping rate' do
+ skip 'Shipping rate setup requires more complex factory' unless shipping_rate.present?
+
+ patch :update, params: {
+ order_id: order.to_param,
+ id: shipment.to_param,
+ shipment: { selected_shipping_rate_id: shipping_rate.to_param }
+ }
+
+ expect(response).to have_http_status(:ok)
+ expect(shipment.reload.selected_shipping_rate_id).to eq(shipping_rate.id)
+ end
+
+ context 'error handling' do
+ it 'returns not found for non-existent shipping rate' do
+ patch :update, params: {
+ order_id: order.to_param,
+ id: shipment.to_param,
+ shipment: { selected_shipping_rate_id: 'invalid' }
+ }
+
+ expect(response).to have_http_status(:not_found)
+ expect(json_response['error']['code']).to eq('record_not_found')
+ end
+ end
+ end
+end
diff --git a/api/spec/controllers/spree/api/v3/store/orders/store_credits_controller_spec.rb b/api/spec/controllers/spree/api/v3/store/orders/store_credits_controller_spec.rb
new file mode 100644
index 0000000000..8787cbbc1b
--- /dev/null
+++ b/api/spec/controllers/spree/api/v3/store/orders/store_credits_controller_spec.rb
@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Api::V3::Store::Orders::StoreCreditsController, type: :controller do
+ render_views
+
+ include_context 'API v3 Store'
+
+ let(:order) { create(:order_with_line_items, user: user, store: store, state: 'payment') }
+ let!(:store_credit_payment_method) { create(:store_credit_payment_method, stores: [store]) }
+ let!(:store_credit) { create(:store_credit, user: user, store: store, amount: 100) }
+
+ before do
+ request.headers['X-Spree-Api-Key'] = api_key.token
+ request.headers['Authorization'] = "Bearer #{jwt_token}"
+ end
+
+ describe 'POST #create' do
+ it 'applies store credit to the order' do
+ post :create, params: { order_id: order.to_param, amount: 10 }
+
+ expect(response).to have_http_status(:ok)
+ expect(order.reload.payments.store_credits.count).to eq(1)
+ end
+
+ it 'returns the updated order' do
+ post :create, params: { order_id: order.to_param, amount: 10 }
+
+ expect(json_response['id']).to eq(order.prefix_id)
+ end
+
+ context 'without available store credit' do
+ let(:user_without_credit) { create(:user) }
+ let(:order_without_credit) { create(:order_with_line_items, user: user_without_credit, store: store, state: 'payment') }
+
+ it 'returns an error' do
+ jwt = Spree::Api::V3::TestingSupport.generate_jwt(user_without_credit)
+ request.headers['Authorization'] = "Bearer #{jwt}"
+ post :create, params: { order_id: order_without_credit.to_param, amount: 10 }
+
+ expect(response).to have_http_status(:unprocessable_entity)
+ expect(json_response['error']).to be_present
+ end
+ end
+
+ context 'authentication' do
+ it 'requires authentication' do
+ request.headers['Authorization'] = nil
+
+ post :create, params: { order_id: order.to_param, amount: 10 }
+
+ expect(response).to have_http_status(:unauthorized)
+ end
+ end
+
+ context 'error handling' do
+ it 'returns not found for non-existent order' do
+ post :create, params: { order_id: 'invalid', amount: 10 }
+
+ expect(response).to have_http_status(:not_found)
+ expect(json_response['error']['code']).to eq('order_not_found')
+ end
+
+ it 'returns forbidden for other users order' do
+ other_order = create(:order, store: store)
+
+ post :create, params: { order_id: other_order.to_param, amount: 10 }
+
+ expect(response).to have_http_status(:forbidden)
+ expect(json_response['error']['code']).to eq('access_denied')
+ end
+ end
+ end
+
+ describe 'DELETE #destroy' do
+ it 'returns the updated order' do
+ # First add store credit, then remove it
+ Spree.checkout_add_store_credit_service.call(order: order, amount: 10)
+
+ delete :destroy, params: { order_id: order.to_param }
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['id']).to eq(order.prefix_id)
+ end
+
+ context 'authentication' do
+ it 'requires authentication' do
+ request.headers['Authorization'] = nil
+
+ delete :destroy, params: { order_id: order.to_param }
+
+ expect(response).to have_http_status(:unauthorized)
+ end
+ end
+
+ context 'error handling' do
+ it 'returns not found for non-existent order' do
+ delete :destroy, params: { order_id: 'invalid' }
+
+ expect(response).to have_http_status(:not_found)
+ expect(json_response['error']['code']).to eq('order_not_found')
+ end
+ end
+ end
+end
diff --git a/api/spec/integration/spree/api/v3/store/addresses_spec.rb b/api/spec/integration/spree/api/v3/store/addresses_spec.rb
index 7db2a4019d..cd87ed918f 100644
--- a/api/spec/integration/spree/api/v3/store/addresses_spec.rb
+++ b/api/spec/integration/spree/api/v3/store/addresses_spec.rb
@@ -133,7 +133,7 @@ RSpec.describe 'Addresses API', type: :request, swagger_doc: 'api-reference/stor
response '200', 'address found' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { address.prefix_id }
+ let(:id) { address.to_param }
schema '$ref' => '#/components/schemas/StoreAddress'
@@ -178,7 +178,7 @@ RSpec.describe 'Addresses API', type: :request, swagger_doc: 'api-reference/stor
response '200', 'address updated' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { address.prefix_id }
+ let(:id) { address.to_param }
let(:body) { { address: { city: 'Los Angeles' } } }
schema '$ref' => '#/components/schemas/StoreAddress'
@@ -202,7 +202,7 @@ RSpec.describe 'Addresses API', type: :request, swagger_doc: 'api-reference/stor
response '204', 'address deleted' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { address.prefix_id }
+ let(:id) { address.to_param }
run_test!
end
diff --git a/api/spec/integration/spree/api/v3/store/line_items_spec.rb b/api/spec/integration/spree/api/v3/store/line_items_spec.rb
index 1296897991..85769a4a2f 100644
--- a/api/spec/integration/spree/api/v3/store/line_items_spec.rb
+++ b/api/spec/integration/spree/api/v3/store/line_items_spec.rb
@@ -39,7 +39,7 @@ RSpec.describe 'Line Items API', type: :request, swagger_doc: 'api-reference/sto
let(:new_variant) { new_product.master }
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:order_id) { order.number }
+ let(:order_id) { order.to_param }
let(:body) { { line_item: { variant_id: new_variant.prefix_id, quantity: 2 } } }
schema '$ref' => '#/components/schemas/StoreLineItem'
@@ -53,7 +53,7 @@ RSpec.describe 'Line Items API', type: :request, swagger_doc: 'api-reference/sto
response '404', 'variant not found' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:order_id) { order.number }
+ let(:order_id) { order.to_param }
let(:body) { { line_item: { variant_id: 'invalid', quantity: 1 } } }
schema '$ref' => '#/components/schemas/ErrorResponse'
@@ -98,8 +98,8 @@ RSpec.describe 'Line Items API', type: :request, swagger_doc: 'api-reference/sto
response '200', 'line item updated' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:order_id) { order.number }
- let(:id) { line_item.prefix_id }
+ let(:order_id) { order.to_param }
+ let(:id) { line_item.to_param }
let(:body) { { line_item: { quantity: 5 } } }
schema '$ref' => '#/components/schemas/StoreLineItem'
@@ -127,8 +127,8 @@ RSpec.describe 'Line Items API', type: :request, swagger_doc: 'api-reference/sto
response '204', 'line item removed' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:order_id) { order.number }
- let(:id) { line_item.prefix_id }
+ let(:order_id) { order.to_param }
+ let(:id) { line_item.to_param }
run_test! do
expect(order.reload.line_items).to be_empty
@@ -138,7 +138,7 @@ RSpec.describe 'Line Items API', type: :request, swagger_doc: 'api-reference/sto
response '404', 'line item not found' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:order_id) { order.number }
+ let(:order_id) { order.to_param }
let(:id) { 'non-existent' }
schema '$ref' => '#/components/schemas/ErrorResponse'
diff --git a/api/spec/integration/spree/api/v3/store/orders_spec.rb b/api/spec/integration/spree/api/v3/store/orders_spec.rb
index 39d1474585..9795569611 100644
--- a/api/spec/integration/spree/api/v3/store/orders_spec.rb
+++ b/api/spec/integration/spree/api/v3/store/orders_spec.rb
@@ -127,7 +127,7 @@ RSpec.describe 'Orders API', type: :request, swagger_doc: 'api-reference/store.y
response '200', 'order found (authenticated)' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { order.number }
+ let(:id) { order.to_param }
schema '$ref' => '#/components/schemas/StoreOrder'
@@ -139,7 +139,7 @@ RSpec.describe 'Orders API', type: :request, swagger_doc: 'api-reference/store.y
response '200', 'order found (guest with token)' do
let(:'x-spree-api-key') { api_key.token }
- let(:id) { order.number }
+ let(:id) { order.to_param }
let(:order_token) { order.token }
schema '$ref' => '#/components/schemas/StoreOrder'
@@ -162,7 +162,7 @@ RSpec.describe 'Orders API', type: :request, swagger_doc: 'api-reference/store.y
let(:other_order) { create(:order, store: store, user: other_user) }
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { other_order.number }
+ let(:id) { other_order.to_param }
schema '$ref' => '#/components/schemas/ErrorResponse'
@@ -199,7 +199,7 @@ RSpec.describe 'Orders API', type: :request, swagger_doc: 'api-reference/store.y
response '200', 'order updated' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { order.number }
+ let(:id) { order.to_param }
let(:body) { { order: { special_instructions: 'Leave at door' } } }
schema '$ref' => '#/components/schemas/StoreOrder'
@@ -214,7 +214,7 @@ RSpec.describe 'Orders API', type: :request, swagger_doc: 'api-reference/store.y
let(:completed_order) { create(:completed_order_with_totals, store: store, user: user) }
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { completed_order.number }
+ let(:id) { completed_order.to_param }
let(:body) { { order: { special_instructions: 'Test' } } }
schema '$ref' => '#/components/schemas/ErrorResponse'
@@ -240,7 +240,7 @@ RSpec.describe 'Orders API', type: :request, swagger_doc: 'api-reference/store.y
let(:advanceable_order) { create(:order_with_line_items, store: store, user: user) }
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { advanceable_order.number }
+ let(:id) { advanceable_order.to_param }
schema '$ref' => '#/components/schemas/StoreOrder'
@@ -251,7 +251,7 @@ RSpec.describe 'Orders API', type: :request, swagger_doc: 'api-reference/store.y
let(:invalid_order) { create(:order, store: store, user: user, state: 'address', bill_address: nil, ship_address: nil) }
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { invalid_order.number }
+ let(:id) { invalid_order.to_param }
schema '$ref' => '#/components/schemas/ErrorResponse'
@@ -276,7 +276,7 @@ RSpec.describe 'Orders API', type: :request, swagger_doc: 'api-reference/store.y
let(:advanceable_order) { create(:order_with_line_items, store: store, user: user) }
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { advanceable_order.number }
+ let(:id) { advanceable_order.to_param }
schema '$ref' => '#/components/schemas/StoreOrder'
@@ -309,7 +309,7 @@ RSpec.describe 'Orders API', type: :request, swagger_doc: 'api-reference/store.y
end
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { completable_order.number }
+ let(:id) { completable_order.to_param }
schema '$ref' => '#/components/schemas/StoreOrder'
@@ -320,7 +320,7 @@ RSpec.describe 'Orders API', type: :request, swagger_doc: 'api-reference/store.y
let(:incomplete_order) { create(:order_with_line_items, store: store, user: user) }
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { incomplete_order.number }
+ let(:id) { incomplete_order.to_param }
schema '$ref' => '#/components/schemas/ErrorResponse'
@@ -353,7 +353,7 @@ RSpec.describe 'Orders API', type: :request, swagger_doc: 'api-reference/store.y
let(:store_credit) { create(:store_credit, user: user, store: store, amount: 50) }
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:order_id) { order.number }
+ let(:order_id) { order.to_param }
let(:body) { { amount: 10 } }
before do
@@ -369,7 +369,7 @@ RSpec.describe 'Orders API', type: :request, swagger_doc: 'api-reference/store.y
response '422', 'no store credit available' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:order_id) { order.number }
+ let(:order_id) { order.to_param }
let(:body) { {} }
schema '$ref' => '#/components/schemas/ErrorResponse'
@@ -392,7 +392,7 @@ RSpec.describe 'Orders API', type: :request, swagger_doc: 'api-reference/store.y
response '200', 'store credit removed' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:order_id) { order.number }
+ let(:order_id) { order.to_param }
schema '$ref' => '#/components/schemas/StoreOrder'
diff --git a/api/spec/integration/spree/api/v3/store/payment_methods_spec.rb b/api/spec/integration/spree/api/v3/store/payment_methods_spec.rb
index 389ceaf875..e79394371f 100644
--- a/api/spec/integration/spree/api/v3/store/payment_methods_spec.rb
+++ b/api/spec/integration/spree/api/v3/store/payment_methods_spec.rb
@@ -25,7 +25,7 @@ RSpec.describe 'Payment Methods API', type: :request, swagger_doc: 'api-referenc
response '200', 'payment methods found' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:order_id) { order.number }
+ let(:order_id) { order.to_param }
schema type: :object,
properties: {
@@ -58,7 +58,7 @@ RSpec.describe 'Payment Methods API', type: :request, swagger_doc: 'api-referenc
response '401', 'unauthorized' do
let(:'x-spree-api-key') { 'invalid' }
- let(:order_id) { order.number }
+ let(:order_id) { order.to_param }
schema '$ref' => '#/components/schemas/ErrorResponse'
diff --git a/api/spec/integration/spree/api/v3/store/payments_spec.rb b/api/spec/integration/spree/api/v3/store/payments_spec.rb
index 2657f14f99..c8c3e2987b 100644
--- a/api/spec/integration/spree/api/v3/store/payments_spec.rb
+++ b/api/spec/integration/spree/api/v3/store/payments_spec.rb
@@ -6,14 +6,14 @@ RSpec.describe 'Payments API', type: :request, swagger_doc: 'api-reference/store
include_context 'API v3 Store'
let(:order) { create(:order_with_line_items, store: store, user: user, state: 'payment') }
- let(:order_id) { order.number }
+ let(:order_id) { order.to_param }
let(:payment_method) { create(:credit_card_payment_method, stores: [store]) }
let!(:payment) { create(:payment, order: order, payment_method: payment_method, amount: order.total) }
path '/api/v3/store/orders/{order_id}/payments' do
parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
parameter name: 'Authorization', in: :header, type: :string, required: true
- parameter name: :order_id, in: :path, type: :string, description: 'Order number or ID'
+ parameter name: :order_id, in: :path, type: :string, description: 'Order prefix ID'
get 'List payments' do
tags 'Payments'
@@ -55,7 +55,7 @@ RSpec.describe 'Payments API', type: :request, swagger_doc: 'api-reference/store
path '/api/v3/store/orders/{order_id}/payments/{id}' do
parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
parameter name: 'Authorization', in: :header, type: :string, required: true
- parameter name: :order_id, in: :path, type: :string, description: 'Order number or ID'
+ parameter name: :order_id, in: :path, type: :string, description: 'Order prefix ID'
parameter name: :id, in: :path, type: :string, description: 'Payment ID'
get 'Get payment' do
@@ -67,7 +67,7 @@ RSpec.describe 'Payments API', type: :request, swagger_doc: 'api-reference/store
response '200', 'payment found' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { payment.prefix_id }
+ let(:id) { payment.to_param }
schema '$ref' => '#/components/schemas/StorePayment'
diff --git a/api/spec/integration/spree/api/v3/store/products_spec.rb b/api/spec/integration/spree/api/v3/store/products_spec.rb
index b865f21262..b9e1fe087e 100644
--- a/api/spec/integration/spree/api/v3/store/products_spec.rb
+++ b/api/spec/integration/spree/api/v3/store/products_spec.rb
@@ -91,7 +91,7 @@ RSpec.describe 'Products API', type: :request, swagger_doc: 'api-reference/store
response '200', 'product found by prefix ID' do
let(:'x-spree-api-key') { api_key.token }
- let(:id) { product.prefix_id }
+ let(:id) { product.to_param }
schema '$ref' => '#/components/schemas/StoreProduct'
diff --git a/api/spec/integration/spree/api/v3/store/shipments_spec.rb b/api/spec/integration/spree/api/v3/store/shipments_spec.rb
index 41b7e742c9..fa04d73cd7 100644
--- a/api/spec/integration/spree/api/v3/store/shipments_spec.rb
+++ b/api/spec/integration/spree/api/v3/store/shipments_spec.rb
@@ -23,7 +23,7 @@ RSpec.describe 'Shipments API', type: :request, swagger_doc: 'api-reference/stor
response '200', 'shipments found' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:order_id) { order.number }
+ let(:order_id) { order.to_param }
schema type: :object,
properties: {
@@ -68,8 +68,8 @@ RSpec.describe 'Shipments API', type: :request, swagger_doc: 'api-reference/stor
response '200', 'shipment found' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:order_id) { order.number }
- let(:id) { shipment.prefix_id }
+ let(:order_id) { order.to_param }
+ let(:id) { shipment.to_param }
let(:token) { order.token }
schema '$ref' => '#/components/schemas/StoreShipment'
@@ -83,7 +83,7 @@ RSpec.describe 'Shipments API', type: :request, swagger_doc: 'api-reference/stor
response '404', 'shipment not found' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:order_id) { order.number }
+ let(:order_id) { order.to_param }
let(:id) { 'shp_nonexistent' }
let(:token) { order.token }
@@ -123,10 +123,10 @@ RSpec.describe 'Shipments API', type: :request, swagger_doc: 'api-reference/stor
let(:shipping_rate) { shipment.shipping_rates.first }
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:order_id) { order.number }
- let(:id) { shipment.prefix_id }
+ let(:order_id) { order.to_param }
+ let(:id) { shipment.to_param }
let(:token) { order.token }
- let(:body) { { shipment: { selected_shipping_rate_id: shipping_rate.prefix_id } } }
+ let(:body) { { shipment: { selected_shipping_rate_id: shipping_rate.to_param } } }
schema '$ref' => '#/components/schemas/StoreShipment'
@@ -136,8 +136,8 @@ RSpec.describe 'Shipments API', type: :request, swagger_doc: 'api-reference/stor
response '404', 'shipping rate not found' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:order_id) { order.number }
- let(:id) { shipment.prefix_id }
+ let(:order_id) { order.to_param }
+ let(:id) { shipment.to_param }
let(:token) { order.token }
let(:body) { { shipment: { selected_shipping_rate_id: 'shprt_invalid' } } }
diff --git a/api/spec/integration/spree/api/v3/store/taxonomies_spec.rb b/api/spec/integration/spree/api/v3/store/taxonomies_spec.rb
index 9843a617e3..cccaab2261 100644
--- a/api/spec/integration/spree/api/v3/store/taxonomies_spec.rb
+++ b/api/spec/integration/spree/api/v3/store/taxonomies_spec.rb
@@ -63,7 +63,7 @@ RSpec.describe 'Taxonomies API', type: :request, swagger_doc: 'api-reference/sto
response '200', 'taxonomy found' do
let(:'x-spree-api-key') { api_key.token }
- let(:id) { taxonomy.prefix_id }
+ let(:id) { taxonomy.to_param }
schema '$ref' => '#/components/schemas/StoreTaxonomy'
@@ -84,7 +84,7 @@ RSpec.describe 'Taxonomies API', type: :request, swagger_doc: 'api-reference/sto
response '404', 'taxonomy from other store' do
let(:'x-spree-api-key') { api_key.token }
- let(:id) { other_taxonomy.prefix_id }
+ let(:id) { other_taxonomy.to_param }
schema '$ref' => '#/components/schemas/ErrorResponse'
diff --git a/api/spec/integration/spree/api/v3/store/taxons_spec.rb b/api/spec/integration/spree/api/v3/store/taxons_spec.rb
index 27ed8f324d..9d0a149ab9 100644
--- a/api/spec/integration/spree/api/v3/store/taxons_spec.rb
+++ b/api/spec/integration/spree/api/v3/store/taxons_spec.rb
@@ -40,7 +40,7 @@ RSpec.describe 'Taxons API', type: :request, swagger_doc: 'api-reference/store.y
response '200', 'taxon found by prefix ID' do
let(:'x-spree-api-key') { api_key.token }
- let(:id) { taxon.prefix_id }
+ let(:id) { taxon.to_param }
schema '$ref' => '#/components/schemas/StoreTaxon'
diff --git a/api/spec/integration/spree/api/v3/store/wishlists_spec.rb b/api/spec/integration/spree/api/v3/store/wishlists_spec.rb
index 0dc1fd4628..b18094bb95 100644
--- a/api/spec/integration/spree/api/v3/store/wishlists_spec.rb
+++ b/api/spec/integration/spree/api/v3/store/wishlists_spec.rb
@@ -113,7 +113,7 @@ RSpec.describe 'Wishlists API', type: :request, swagger_doc: 'api-reference/stor
response '200', 'wishlist found' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { wishlist.prefix_id }
+ let(:id) { wishlist.to_param }
schema '$ref' => '#/components/schemas/StoreWishlist'
@@ -157,7 +157,7 @@ RSpec.describe 'Wishlists API', type: :request, swagger_doc: 'api-reference/stor
response '200', 'wishlist updated' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { wishlist.prefix_id }
+ let(:id) { wishlist.to_param }
let(:body) { { wishlist: { name: 'Updated Name' } } }
schema '$ref' => '#/components/schemas/StoreWishlist'
@@ -180,7 +180,7 @@ RSpec.describe 'Wishlists API', type: :request, swagger_doc: 'api-reference/stor
response '204', 'wishlist deleted' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:id) { wishlist.prefix_id }
+ let(:id) { wishlist.to_param }
run_test!
end
@@ -212,7 +212,7 @@ RSpec.describe 'Wishlists API', type: :request, swagger_doc: 'api-reference/stor
let(:new_variant) { new_product.master }
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:wishlist_id) { wishlist.prefix_id }
+ let(:wishlist_id) { wishlist.to_param }
let(:body) { { wished_item: { variant_id: new_variant.id.to_s, quantity: 1 } } }
schema '$ref' => '#/components/schemas/StoreWishedItem'
@@ -235,8 +235,8 @@ RSpec.describe 'Wishlists API', type: :request, swagger_doc: 'api-reference/stor
response '204', 'item removed' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:wishlist_id) { wishlist.prefix_id }
- let(:id) { wished_item.prefix_id }
+ let(:wishlist_id) { wishlist.to_param }
+ let(:id) { wished_item.to_param }
run_test!
end
@@ -244,7 +244,7 @@ RSpec.describe 'Wishlists API', type: :request, swagger_doc: 'api-reference/stor
response '404', 'item not found' do
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:wishlist_id) { wishlist.prefix_id }
+ let(:wishlist_id) { wishlist.to_param }
let(:id) { 'non-existent' }
schema '$ref' => '#/components/schemas/ErrorResponse'
diff --git a/core/app/models/concerns/spree/product_scopes.rb b/core/app/models/concerns/spree/product_scopes.rb
index 5ff49dd05e..3622a8f26a 100644
--- a/core/app/models/concerns/spree/product_scopes.rb
+++ b/core/app/models/concerns/spree/product_scopes.rb
@@ -288,11 +288,8 @@ module Spree
# Can't use add_search_scope for this as it needs a default argument
def self.available(available_on = nil, currency = nil)
- scope = if available_on
- not_discontinued.where("#{Product.quoted_table_name}.available_on <= ?", available_on)
- else
- not_discontinued.where(status: 'active')
- end
+ scope = not_discontinued.where(status: 'active')
+ scope = scope.where("#{Product.quoted_table_name}.available_on <= ?", available_on) if available_on
unless Spree::Config.show_products_without_price
currency ||= Spree::Store.default.default_currency
diff --git a/core/app/models/spree/wishlist.rb b/core/app/models/spree/wishlist.rb
index 886ccebc51..2cde08126c 100644
--- a/core/app/models/spree/wishlist.rb
+++ b/core/app/models/spree/wishlist.rb
@@ -26,10 +26,6 @@ module Spree
wished_items.exists?(variant_id: variant_id)
end
- def to_param
- token
- end
-
# returns the number of wished items in the wishlist
#
# @return [Integer]
@@ -44,10 +40,6 @@ module Spree
@variant_ids ||= wished_items.pluck(:variant_id)
end
- def self.get_by_param(param)
- find_by(token: param)
- end
-
private
def ensure_default_exists_and_is_unique
diff --git a/core/spec/models/spree/product_spec.rb b/core/spec/models/spree/product_spec.rb
index 280d53eef9..17a0e9b57f 100644
--- a/core/spec/models/spree/product_spec.rb
+++ b/core/spec/models/spree/product_spec.rb
@@ -1580,9 +1580,19 @@ describe Spree::Product, type: :model do
context 'when available_on is specified' do
subject(:available_products) { described_class.available(Time.current) }
+ let!(:draft_product) { create(:product, available_on: 1.day.ago, status: 'draft', stores: [store]) }
+
+ before do
+ draft_product.default_variant.set_price('USD', 10)
+ end
+
it 'returns products available before or on the specified date' do
expect(available_products).to contain_exactly(active_product)
end
+
+ it 'excludes draft products even if available_on is in the past' do
+ expect(available_products).not_to include(draft_product)
+ end
end
context 'when available_on is not specified' do
diff --git a/core/spec/models/spree/wishlist_spec.rb b/core/spec/models/spree/wishlist_spec.rb
index b0e99a645f..84f83a59df 100644
--- a/core/spec/models/spree/wishlist_spec.rb
+++ b/core/spec/models/spree/wishlist_spec.rb
@@ -99,25 +99,6 @@ describe Spree::Wishlist, type: :model do
end
end
- describe '.to_param' do
- it 'returns the wishlists token' do
- expect(wishlist.to_param).to eq wishlist.token
- end
- end
-
- describe '.get_by_param' do
- it 'returns the wishlist of the token' do
- hash = wishlist.token
- result = described_class.get_by_param(hash)
- expect(result).to eq wishlist
- end
-
- it 'returns nil when not found' do
- result = described_class.get_by_param('nope')
- expect(result).to be_nil
- end
- end
-
describe '#destroy' do
let!(:wished_item) { create(:wished_item) }