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.

Return only Orders from current store in Storefront API

Damian Legawiecf7ba423a692b
diff --git a/api/app/controllers/spree/api/v2/resource_controller.rb b/api/app/controllers/spree/api/v2/resource_controller.rb
index ede0b17411..dbc8f80d2c 100644
--- a/api/app/controllers/spree/api/v2/resource_controller.rb
+++ b/api/app/controllers/spree/api/v2/resource_controller.rb
@@ -27,7 +27,15 @@ module Spree
end
def scope
- model_class.accessible_by(current_ability, :show).includes(scope_includes)
+ base_scope = if model_class.respond_to?(:store_id)
+ model_class.where(store_id: current_store.id)
+ elsif model_class.respond_to?(:for_store)
+ model_class.for_store(current_store)
+ else
+ model_class
+ end
+
+ base_scope.accessible_by(current_ability, :show).includes(scope_includes)
end
def scope_includes
@@ -36,7 +44,7 @@ module Spree
def resource
@resource ||= if defined?(resource_finder)
- resource_finder.new(scope: scope, params: params).execute
+ resource_finder.new(scope: scope, params: finder_params).execute
else
scope.find(params[:id])
end
@@ -44,12 +52,21 @@ module Spree
def collection
@collection ||= if defined?(collection_finder)
- collection_finder.new(scope: scope, params: params).execute
+ collection_finder.new(scope: scope, params: finder_params).execute
else
scope
end
end
+ def finder_params
+ params.merge(
+ store: current_store,
+ locale: current_locale,
+ currency: current_currency,
+ user: spree_current_user
+ )
+ end
+
def collection_sorter
Spree::Api::Dependencies.storefront_collection_sorter.constantize
end
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 77276f42f5..6924f8ac67 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
@@ -33,7 +33,7 @@ module Spree
private
def collection
- collection_finder.new(scope: scope, params: params).execute
+ collection_finder.new(scope: scope, params: finder_params).execute
end
def scope
diff --git a/api/app/controllers/spree/api/v2/storefront/account/orders_controller.rb b/api/app/controllers/spree/api/v2/storefront/account/orders_controller.rb
index 11cc7d1d57..3609b54eb8 100644
--- a/api/app/controllers/spree/api/v2/storefront/account/orders_controller.rb
+++ b/api/app/controllers/spree/api/v2/storefront/account/orders_controller.rb
@@ -9,11 +9,11 @@ module Spree
private
def collection
- collection_finder.new(user: spree_current_user).execute
+ collection_finder.new(user: spree_current_user, store: current_store).execute
end
def resource
- resource = resource_finder.new(user: spree_current_user, number: params[:id]).execute.take
+ resource = resource_finder.new(user: spree_current_user, number: params[:id], store: current_store).execute.take
raise ActiveRecord::RecordNotFound if resource.nil?
resource
diff --git a/api/app/controllers/spree/api/v2/storefront/order_status_controller.rb b/api/app/controllers/spree/api/v2/storefront/order_status_controller.rb
index ee4aadf7fe..ec09b5ef1e 100644
--- a/api/app/controllers/spree/api/v2/storefront/order_status_controller.rb
+++ b/api/app/controllers/spree/api/v2/storefront/order_status_controller.rb
@@ -10,7 +10,7 @@ module Spree
private
def resource
- resource = resource_finder.new(number: params[:number], token: order_token).execute.take
+ resource = resource_finder.new(number: params[:number], token: order_token, store: current_store).execute.take
raise ActiveRecord::RecordNotFound if resource.nil?
resource
diff --git a/api/spec/controllers/spree/api/v2/resource_controller_spec.rb b/api/spec/controllers/spree/api/v2/resource_controller_spec.rb
new file mode 100644
index 0000000000..1352c2905c
--- /dev/null
+++ b/api/spec/controllers/spree/api/v2/resource_controller_spec.rb
@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+class ApiV2DummyController < Spree::Api::V2::ResourceController
+ private
+
+ def model_class
+ Spree::Order
+ end
+end
+
+describe Spree::Api::V2::ResourceController, type: :controller do
+ let(:dummy_controller) { ApiV2DummyController.new }
+ let(:store) { Spree::Store.default }
+
+ describe '#finder_params' do
+ let(:currency) { store.default_currency }
+ let(:locale) { store.default_locale }
+ let(:user) { nil }
+ let(:params) { {} }
+
+ shared_examples 'returns proper values' do
+ before do
+ allow(dummy_controller).to receive(:current_store).and_return(store)
+ allow(dummy_controller).to receive(:current_currency).and_return(currency)
+ allow(dummy_controller).to receive(:current_locale).and_return(locale)
+ allow(dummy_controller).to receive(:spree_current_user).and_return(user)
+ allow(dummy_controller).to receive(:params).and_return(params)
+ end
+
+ it do
+ expect(dummy_controller.send(:finder_params)).to eq(
+ params.merge(
+ store: store,
+ currency: currency,
+ user: user,
+ locale: locale
+ )
+ )
+ end
+ end
+
+ context 'default values' do
+ it_behaves_like 'returns proper values'
+ end
+
+ context 'non-default values' do
+ let(:user) { create(:user) }
+ let(:currency) { 'EUR' }
+ let(:locale) { 'de' }
+ let(:store) { create(:store, default_locale: locale, default_currency: currency) }
+ let(:params) { { filter: {}, page: 1, per_page: 10 } }
+
+ it_behaves_like 'returns proper values'
+ end
+ end
+end
diff --git a/api/spec/requests/spree/api/v2/storefront/account/orders_spec.rb b/api/spec/requests/spree/api/v2/storefront/account/orders_spec.rb
index cb65c5c4f2..081c357e2b 100644
--- a/api/spec/requests/spree/api/v2/storefront/account/orders_spec.rb
+++ b/api/spec/requests/spree/api/v2/storefront/account/orders_spec.rb
@@ -1,8 +1,9 @@
require 'spec_helper'
describe 'Storefront API v2 Orders spec', type: :request do
+ let(:store) { Spree::Store.default }
let!(:user) { create(:user_with_addresses) }
- let!(:order) { create(:order, state: 'complete', user: user, completed_at: Time.current) }
+ let!(:order) { create(:order, state: 'complete', user: user, completed_at: Time.current, store: store) }
before { Spree::Api::Config[:api_v2_per_page_limit] = 2 }
@@ -52,10 +53,10 @@ describe 'Storefront API v2 Orders spec', type: :request do
end
context 'when per_page is between 1 and default value' do
- let!(:order) { create(:order, state: 'complete', user: user, completed_at: Time.current) }
- let!(:order_1) { create(:order, state: 'complete', user: user, completed_at: Time.current + 1.day) }
- let!(:order_2) { create(:order, state: 'complete', user: user, completed_at: Time.current + 2.days) }
- let!(:order_3) { create(:order, state: 'complete', user: user, completed_at: Time.current + 3.days) }
+ let!(:order) { create(:order, state: 'complete', user: user, completed_at: Time.current, store: store) }
+ let!(:order_1) { create(:order, state: 'complete', user: user, completed_at: Time.current + 1.day, store: store) }
+ let!(:order_2) { create(:order, state: 'complete', user: user, completed_at: Time.current + 2.days, store: store) }
+ let!(:order_3) { create(:order, state: 'complete', user: user, completed_at: Time.current + 3.days, store: store) }
context 'with specified pagination params' do
before { get '/api/v2/storefront/account/orders?page=1&per_page=2', headers: headers_bearer }
@@ -124,7 +125,6 @@ describe 'Storefront API v2 Orders spec', type: :request do
end
end
-
context 'sort orders' do
let!(:order) { create(:order, state: 'complete', user: user, completed_at: Time.current) }
let!(:order_1) { create(:order, state: 'complete', user: user, completed_at: Time.current + 1.day) }
@@ -138,8 +138,8 @@ describe 'Storefront API v2 Orders spec', type: :request do
it_behaves_like 'returns 200 HTTP status'
it 'returns orders sorted by completed_at' do
- expect(json_response['data'].count).to eq Spree::Order.count
- expect(json_response['data'].pluck(:id)).to eq Spree::Order.select('*').order(completed_at: :asc).pluck(:id).map(&:to_s)
+ expect(json_response['data'].count).to eq store.orders.count
+ expect(json_response['data'].pluck(:id)).to eq store.orders.select('*').order(completed_at: :asc).pluck(:id).map(&:to_s)
end
end
@@ -149,13 +149,26 @@ describe 'Storefront API v2 Orders spec', type: :request do
it_behaves_like 'returns 200 HTTP status'
it 'returns orders sorted by completed_at' do
- expect(json_response['data'].count).to eq Spree::Order.count
- expect(json_response['data'].pluck(:id)).to eq Spree::Order.select('*').order(completed_at: :desc).pluck(:id).map(&:to_s)
+ expect(json_response['data'].count).to eq store.orders.count
+ expect(json_response['data'].pluck(:id)).to eq store.orders.select('*').order(completed_at: :desc).pluck(:id).map(&:to_s)
end
end
end
end
+ context 'do not return orders from different stores' do
+ let!(:order_2) { create(:order, state: 'complete', user: user, completed_at: Time.current, store: create(:store)) }
+
+ before { get '/api/v2/storefront/account/orders', headers: headers_bearer }
+
+ it_behaves_like 'returns 200 HTTP status'
+
+ it 'returns orders sorted by completed_at' do
+ expect(json_response['data'].count).to eq 1
+ expect(json_response['data'].pluck(:id)).not_to include(order_2.id.to_s)
+ end
+ end
+
context 'with missing authorization token' do
before { get '/api/v2/storefront/account/orders' }
@@ -165,7 +178,7 @@ describe 'Storefront API v2 Orders spec', type: :request do
describe 'orders#show' do
let(:user) { create(:user_with_addresses) }
- let(:order) { create(:order, state: 'complete', user: user, completed_at: Time.current) }
+ let(:order) { create(:order, state: 'complete', user: user, completed_at: Time.current, store: store) }
context 'without option: include' do
before { get "/api/v2/storefront/account/orders/#{order.number}", headers: headers_bearer }
@@ -195,5 +208,13 @@ describe 'Storefront API v2 Orders spec', type: :request do
it_behaves_like 'returns 403 HTTP status'
end
+
+ context 'do not return order from different stores' do
+ let!(:order_2) { create(:order, state: 'complete', user: user, completed_at: Time.current, store: create(:store)) }
+
+ before { get "/api/v2/storefront/account/orders/#{order_2.number}", headers: headers_bearer }
+
+ it_behaves_like 'returns 404 HTTP status'
+ end
end
end
diff --git a/api/spec/requests/spree/api/v2/storefront/order_status_spec.rb b/api/spec/requests/spree/api/v2/storefront/order_status_spec.rb
index 46b43ea599..77398e91b9 100644
--- a/api/spec/requests/spree/api/v2/storefront/order_status_spec.rb
+++ b/api/spec/requests/spree/api/v2/storefront/order_status_spec.rb
@@ -1,7 +1,10 @@
require 'spec_helper'
describe 'Storefront API v2 OrderStatus spec', type: :request do
- let!(:order) { create(:order, state: 'complete', completed_at: Time.current) }
+ let(:store) { Spree::Store.default }
+ let!(:order) { create(:order, state: 'complete', completed_at: Time.current, store: store) }
+ let(:store_2) { create(:store) }
+ let(:order_2) { create(:order, state: 'complete', completed_at: Time.current, store: store_2) }
include_context 'API v2 tokens'
@@ -32,6 +35,7 @@ describe 'Storefront API v2 OrderStatus spec', type: :request do
context 'as a guest user with valid token' do
before { get "/api/v2/storefront/order_status/#{order.number}", headers: headers_order_token }
+ it_behaves_like 'returns 200 HTTP status'
it_behaves_like 'returns valid cart JSON'
end
end
@@ -41,5 +45,11 @@ describe 'Storefront API v2 OrderStatus spec', type: :request do
it_behaves_like 'returns 404 HTTP status'
end
+
+ context 'with Order from different Store' do
+ before { get "/api/v2/storefront/order_status/#{order_2.number}", headers: headers_order_token }
+
+ it_behaves_like 'returns 404 HTTP status'
+ end
end
end
diff --git a/core/app/finders/spree/orders/find_complete.rb b/core/app/finders/spree/orders/find_complete.rb
index fc40aa79c7..3e1f39787f 100644
--- a/core/app/finders/spree/orders/find_complete.rb
+++ b/core/app/finders/spree/orders/find_complete.rb
@@ -1,18 +1,20 @@
module Spree
module Orders
class FindComplete
- attr_reader :user, :number, :token
+ attr_reader :user, :number, :token, :store
- def initialize(user: nil, number: nil, token: nil)
+ def initialize(user: nil, number: nil, token: nil, store: nil)
@user = user
@number = number
@token = token
+ @store = store
end
def execute
orders = by_user(scope)
orders = by_number(orders)
orders = by_token(orders)
+ orders = by_store(orders)
orders
end
@@ -35,6 +37,10 @@ module Spree
token.present?
end
+ def store?
+ store.present?
+ end
+
def by_user(orders)
return orders unless user?
@@ -53,6 +59,12 @@ module Spree
orders.where(token: token)
end
+ def by_store(orders)
+ return orders unless store?
+
+ orders.where(store: store)
+ end
+
def scope_includes
{
line_items: [