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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
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.rbindex 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 Spreeprivate- 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_paramsparams.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.rbindex 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 Spreemodule V3module Adminmodule 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/adjustmentsdef createwith_order_lock do@@ -64,20 +58,6 @@ module Spree:adjustmentsend- 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_paramsparams.permit(:amount, :label, :eligible)enddiff --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.rbnew file mode 100644index 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+enddiff --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.rbindex 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 Spreemodule V3module Adminmodule 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_itemsdef createwith_order_lock do@@ -79,27 +73,15 @@ module Spree:line_itemsend- 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+ privatedef 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: {} })- endendendenddiff --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.rbindex 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 Spreemodule V3module Adminmodule 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/paymentsdef create@@ -68,36 +64,9 @@ module Spree:paymentsend- 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_paramsparams.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- endendendenddiff --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.rbindex 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 Spreemodule V3module Adminmodule 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/refundsdef createwith_order_lock do@@ -41,15 +36,6 @@ module SpreeSpree.api.admin_refund_serializerend- 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 scopeSpree::Refund.where(payment_id: @parent.payment_ids)enddiff --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.rbindex 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 Spreemodule V3module Adminmodule 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/:iddef update@@ -96,36 +92,9 @@ module Spree:shipmentsend- 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_paramsparams.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- endendendenddiff --git a/spree/api/app/controllers/spree/api/v3/admin/orders_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/orders_controller.rbindex 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 Spreeprivate- 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_userreturn 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.rbindex 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 Spreeprivate- 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_paramsparams.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.rbindex 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 Spreeprivate- # 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)enddiff --git a/spree/api/app/controllers/spree/api/v3/admin/resource_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/resource_controller.rbindex 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 SpreeJWT_AUDIENCE_ADMINend+ # 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+privatedef set_no_store_cachediff --git a/spree/api/app/controllers/spree/api/v3/resource_controller.rb b/spree/api/app/controllers/spree/api/v3/resource_controller.rbindex 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 Spreemodel_class.new(permitted_params)endresource.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)resourceend