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.

DRY-up admin api controllers

Damian Legawiec5838b4f2f9cb
diff --git a/spree/api/app/controllers/spree/api/v3/admin/option_types_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/option_types_controller.rb
index aee062bc31..6da4249e94 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/option_types_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/option_types_controller.rb
@@ -50,17 +50,6 @@ module Spree
private
- def render_result_error(result)
- error = result.error
- errors = error.respond_to?(:value) ? error.value : error
-
- if errors.is_a?(ActiveModel::Errors)
- render_validation_error(errors)
- else
- render_service_error(error)
- end
- end
-
def option_type_service_params
params.permit(
:name, :presentation, :position, :filterable,
diff --git a/spree/api/app/controllers/spree/api/v3/admin/orders/adjustments_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/orders/adjustments_controller.rb
index f9dd7d5ba5..e4365441e1 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/orders/adjustments_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/orders/adjustments_controller.rb
@@ -3,13 +3,7 @@ module Spree
module V3
module Admin
module Orders
- class AdjustmentsController < ResourceController
- include Spree::Api::V3::OrderLock
-
- before_action :authorize_order_access!
- skip_before_action :set_resource, only: [:index, :create]
- before_action :set_adjustment, only: [:show, :update, :destroy]
-
+ class AdjustmentsController < BaseController
# POST /api/v3/admin/orders/:order_id/adjustments
def create
with_order_lock do
@@ -64,20 +58,6 @@ module Spree
:adjustments
end
- def set_parent
- @parent = current_store.orders.find_by_prefix_id!(params[:order_id])
- @order = @parent
- end
-
- def authorize_order_access!
- authorize!(:show, @parent)
- end
-
- def set_adjustment
- @resource = @parent.adjustments.find_by_prefix_id!(params[:id])
- authorize_resource!(@resource)
- end
-
def permitted_params
params.permit(:amount, :label, :eligible)
end
diff --git a/spree/api/app/controllers/spree/api/v3/admin/orders/base_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/orders/base_controller.rb
new file mode 100644
index 0000000000..f543e784d5
--- /dev/null
+++ b/spree/api/app/controllers/spree/api/v3/admin/orders/base_controller.rb
@@ -0,0 +1,26 @@
+module Spree
+ module Api
+ module V3
+ module Admin
+ module Orders
+ class BaseController < ResourceController
+ include Spree::Api::V3::OrderLock
+
+ before_action :authorize_order_access!
+
+ protected
+
+ def set_parent
+ @parent = current_store.orders.find_by_prefix_id!(params[:order_id])
+ @order = @parent
+ end
+
+ def authorize_order_access!
+ authorize!(:show, @parent)
+ end
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/spree/api/app/controllers/spree/api/v3/admin/orders/line_items_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/orders/line_items_controller.rb
index b07e767f10..cdf6921c72 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/orders/line_items_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/orders/line_items_controller.rb
@@ -3,13 +3,7 @@ module Spree
module V3
module Admin
module Orders
- class LineItemsController < ResourceController
- include Spree::Api::V3::OrderLock
-
- before_action :authorize_order_access!
- skip_before_action :set_resource, only: [:index, :create]
- before_action :set_line_item, only: [:show, :update, :destroy]
-
+ class LineItemsController < BaseController
# POST /api/v3/admin/orders/:order_id/line_items
def create
with_order_lock do
@@ -79,27 +73,15 @@ module Spree
:line_items
end
- def set_parent
- @parent = current_store.orders.find_by_prefix_id!(params[:order_id])
- @order = @parent # needed for OrderLock
+ def permitted_params
+ params.permit(*Spree::PermittedAttributes.line_item_attributes, { options: {} })
end
- def authorize_order_access!
- authorize!(:show, @parent)
- end
-
- def set_line_item
- @resource = @parent.line_items.find_by_prefix_id!(params[:id])
- authorize_resource!(@resource)
- end
+ private
def variant
@variant ||= current_store.variants.find_by_prefix_id!(permitted_params[:variant_id])
end
-
- def permitted_params
- params.permit(*Spree::PermittedAttributes.line_item_attributes, { options: {} })
- end
end
end
end
diff --git a/spree/api/app/controllers/spree/api/v3/admin/orders/payments_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/orders/payments_controller.rb
index 4a00b9e64d..63fc479891 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/orders/payments_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/orders/payments_controller.rb
@@ -3,12 +3,8 @@ module Spree
module V3
module Admin
module Orders
- class PaymentsController < ResourceController
- include Spree::Api::V3::OrderLock
-
- before_action :authorize_order_access!
- skip_before_action :set_resource, only: [:index, :create]
- before_action :set_payment, only: [:show, :capture, :void]
+ class PaymentsController < BaseController
+ before_action :set_resource, only: [:show, :capture, :void]
# POST /api/v3/admin/orders/:order_id/payments
def create
@@ -68,36 +64,9 @@ module Spree
:payments
end
- def set_parent
- @parent = current_store.orders.find_by_prefix_id!(params[:order_id])
- @order = @parent
- end
-
- def authorize_order_access!
- authorize!(:show, @parent)
- end
-
- def set_payment
- @resource = @parent.payments.find_by_prefix_id!(params[:id])
- authorize_resource!(@resource)
- end
-
def permitted_params
params.permit(*Spree::PermittedAttributes.payment_attributes, :source_id)
end
-
- private
-
- def render_result_error(result)
- error = result.error
- errors = error.respond_to?(:value) ? error.value : error
-
- if errors.is_a?(ActiveModel::Errors)
- render_validation_error(errors)
- else
- render_service_error(error)
- end
- end
end
end
end
diff --git a/spree/api/app/controllers/spree/api/v3/admin/orders/refunds_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/orders/refunds_controller.rb
index af5f38d2f5..70f3906530 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/orders/refunds_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/orders/refunds_controller.rb
@@ -3,12 +3,7 @@ module Spree
module V3
module Admin
module Orders
- class RefundsController < ResourceController
- include Spree::Api::V3::OrderLock
-
- before_action :authorize_order_access!
- skip_before_action :set_resource, only: [:index, :create]
-
+ class RefundsController < BaseController
# POST /api/v3/admin/orders/:order_id/refunds
def create
with_order_lock do
@@ -41,15 +36,6 @@ module Spree
Spree.api.admin_refund_serializer
end
- def set_parent
- @parent = current_store.orders.find_by_prefix_id!(params[:order_id])
- @order = @parent
- end
-
- def authorize_order_access!
- authorize!(:show, @parent)
- end
-
def scope
Spree::Refund.where(payment_id: @parent.payment_ids)
end
diff --git a/spree/api/app/controllers/spree/api/v3/admin/orders/shipments_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/orders/shipments_controller.rb
index 4705e8f5b5..a42d40b57e 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/orders/shipments_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/orders/shipments_controller.rb
@@ -3,12 +3,8 @@ module Spree
module V3
module Admin
module Orders
- class ShipmentsController < ResourceController
- include Spree::Api::V3::OrderLock
-
- before_action :authorize_order_access!
- skip_before_action :set_resource, only: [:index, :show, :update, :ship, :cancel, :resume, :split]
- before_action :set_shipment, only: [:show, :update, :ship, :cancel, :resume, :split]
+ class ShipmentsController < BaseController
+ before_action :set_resource, only: [:show, :update, :ship, :cancel, :resume, :split]
# PATCH /api/v3/admin/orders/:order_id/shipments/:id
def update
@@ -96,36 +92,9 @@ module Spree
:shipments
end
- def set_parent
- @parent = current_store.orders.find_by_prefix_id!(params[:order_id])
- @order = @parent
- end
-
- def authorize_order_access!
- authorize!(:show, @parent)
- end
-
- def set_shipment
- @resource = @parent.shipments.find_by_prefix_id!(params[:id])
- authorize_resource!(@resource)
- end
-
def permitted_params
params.permit(*Spree::PermittedAttributes.shipment_attributes - [:id])
end
-
- private
-
- def render_result_error(result)
- error = result.error
- errors = error.respond_to?(:value) ? error.value : error
-
- if errors.is_a?(ActiveModel::Errors)
- render_validation_error(errors)
- else
- render_service_error(error)
- end
- end
end
end
end
diff --git a/spree/api/app/controllers/spree/api/v3/admin/orders_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/orders_controller.rb
index 533e56dbd0..efde09f43e 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/orders_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/orders_controller.rb
@@ -157,17 +157,6 @@ module Spree
private
- def render_result_error(result)
- error = result.error
- errors = error.respond_to?(:value) ? error.value : error
-
- if errors.is_a?(ActiveModel::Errors)
- render_validation_error(errors)
- else
- render_service_error(error)
- end
- end
-
def resolve_user
return unless params[:user_id].present?
diff --git a/spree/api/app/controllers/spree/api/v3/admin/products/variants_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/products/variants_controller.rb
index 1784a65896..aa9ceae8ef 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/products/variants_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/products/variants_controller.rb
@@ -61,17 +61,6 @@ module Spree
private
- def render_result_error(result)
- error = result.error
- errors = error.respond_to?(:value) ? error.value : error
-
- if errors.is_a?(ActiveModel::Errors)
- render_validation_error(errors)
- else
- render_service_error(error)
- end
- end
-
def variant_service_params
params.permit(
:sku, :barcode, :price, :compare_at_price,
diff --git a/spree/api/app/controllers/spree/api/v3/admin/products_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/products_controller.rb
index 2c09ec1715..fc8bb1c4f0 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/products_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/products_controller.rb
@@ -103,19 +103,6 @@ module Spree
private
- # Render error from ServiceModule::Result, extracting ActiveModel::Errors
- # from the ResultError wrapper to get proper validation_error responses.
- def render_result_error(result)
- error = result.error
- errors = error.respond_to?(:value) ? error.value : error
-
- if errors.is_a?(ActiveModel::Errors)
- render_validation_error(errors)
- else
- render_service_error(error)
- end
- end
-
def custom_sort_requested?
CUSTOM_SORT_SCOPES.key?(sort_param)
end
diff --git a/spree/api/app/controllers/spree/api/v3/admin/resource_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/resource_controller.rb
index c1bccfaacf..52142138db 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/resource_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/resource_controller.rb
@@ -16,6 +16,19 @@ module Spree
JWT_AUDIENCE_ADMIN
end
+ # Render error from ServiceModule::Result, extracting ActiveModel::Errors
+ # from the ResultError wrapper to get proper validation_error responses.
+ def render_result_error(result)
+ error = result.error
+ errors = error.respond_to?(:value) ? error.value : error
+
+ if errors.is_a?(ActiveModel::Errors)
+ render_validation_error(errors)
+ else
+ render_service_error(error)
+ end
+ end
+
private
def set_no_store_cache
diff --git a/spree/api/app/controllers/spree/api/v3/resource_controller.rb b/spree/api/app/controllers/spree/api/v3/resource_controller.rb
index 7fb565f56f..b02e069d9e 100644
--- a/spree/api/app/controllers/spree/api/v3/resource_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/resource_controller.rb
@@ -88,6 +88,7 @@ module Spree
model_class.new(permitted_params)
end
resource.store = current_store if resource.respond_to?(:store_id) && resource.store_id.blank?
+ resource.store_ids = [current_store.id] if resource.respond_to?(:store_ids) && resource.store_ids.blank?
resource.created_by = try_spree_current_user if resource.respond_to?(:created_by_id)
resource
end