spree_api 5.3.5 → 5.4.0.beta

data/app/controllers/spree/api/v2/platform/gift_cards_controller.rb

@@ -1,23 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class GiftCardsController < ResourceController
-          private
-
-          def model_class
-            Spree::GiftCard
-          end
-
-          def permitted_resource_params
-            params.require(:gift_card).permit(permitted_gift_card_attributes)
-          end
-
-          def resource_serializer
-            Spree.api.platform_gift_card_serializer
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v2/platform/line_items_controller.rb

@@ -1,63 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class LineItemsController < ResourceController
-          def create
-            order = current_store.orders.find(permitted_resource_params[:order_id])
-
-            result = create_service.call(order: order, line_item_attributes: permitted_resource_params)
-
-            if result.success?
-              render_serialized_payload(201) { serialize_resource(result.value) }
-            else
-              render_error_payload(result.error)
-            end
-          end
-
-          def update
-            result = update_service.call(line_item: resource, line_item_attributes: permitted_resource_params)
-
-            if result.success?
-              render_serialized_payload { serialize_resource(result.value) }
-            else
-              render_error_payload(resource.errors)
-            end
-          end
-
-          def destroy
-            result = destroy_service.call(line_item: resource)
-
-            if result.success?
-              head 204
-            else
-              render_error_payload(result.error)
-            end
-          end
-
-          private
-
-          def model_class
-            Spree::LineItem
-          end
-
-          def create_service
-            Spree.api.platform_line_item_create_service
-          end
-
-          def update_service
-            Spree.api.platform_line_item_update_service
-          end
-
-          def destroy_service
-            Spree.api.platform_line_item_destroy_service
-          end
-
-          def resource_serializer
-            Spree.api.platform_line_item_serializer
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v2/platform/option_types_controller.rb

@@ -1,19 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class OptionTypesController < ResourceController
-          private
-
-          def model_class
-            Spree::OptionType
-          end
-
-          def resource_serializer
-            Spree.api.platform_option_type_serializer
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v2/platform/option_values_controller.rb

@@ -1,23 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class OptionValuesController < ResourceController
-          private
-
-          def model_class
-            Spree::OptionValue
-          end
-
-          def scope_includes
-            [:option_type]
-          end
-
-          def resource_serializer
-            Spree.api.platform_option_value_serializer
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v2/platform/orders_controller.rb

@@ -1,167 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class OrdersController < ResourceController
-          include CouponCodesHelper
-          include NumberResource
-
-          def create
-            resource = current_store.orders.new(permitted_resource_params)
-
-            if resource.save
-              render_serialized_payload(201) { serialize_resource(resource) }
-            else
-              render_error_payload(resource.errors)
-            end
-          end
-
-          def update
-            result = update_service.call(
-              order: resource,
-              params: params,
-              permitted_attributes: spree_permitted_attributes,
-              request_env: request.headers.env
-            )
-
-            render_result(result)
-          end
-
-          def next
-            result = next_service.call(order: resource)
-
-            render_result(result)
-          end
-
-          def advance
-            result = advance_service.call(order: resource)
-
-            render_result(result)
-          end
-
-          def complete
-            result = complete_service.call(order: resource)
-
-            render_result(result)
-          end
-
-          def empty
-            result = empty_service.call(order: resource)
-
-            render_result(result)
-          end
-
-          def cancel
-            result = cancel_service.call(order: resource, canceler: spree_current_user)
-
-            render_result(result)
-          end
-
-          def approve
-            result = approve_service.call(order: resource, approver: spree_current_user)
-
-            render_result(result)
-          end
-
-          def destroy
-            result = destroy_service.call(order: resource)
-
-            if result.success?
-              head 204
-            else
-              render_error_payload(result.error)
-            end
-          end
-
-          def apply_coupon_code
-            resource.coupon_code = params[:coupon_code]
-            result = coupon_handler.new(resource).apply
-
-            if result.error.blank?
-              render_serialized_payload { serialize_resource(resource.reload) }
-            else
-              render_error_payload(result.error)
-            end
-          end
-
-          def use_store_credit
-            result = use_store_credit_service.call(
-              order: resource,
-              amount: params[:amount].try(:to_f)
-            )
-
-            render_result(result)
-          end
-
-          private
-
-          def model_class
-            Spree::Order
-          end
-
-          def allowed_sort_attributes
-            super.push(:available_on, :make_active_at, :total, :payment_total, :item_total, :shipment_total,
-                       :adjustment_total, :promo_total, :included_tax_total, :additional_tax_total,
-                       :item_count, :tax_total, :completed_at)
-          end
-
-          def update_service
-            Spree.api.platform_order_update_service
-          end
-
-          def next_service
-            Spree.api.platform_order_next_service
-          end
-
-          def advance_service
-            Spree.api.platform_order_advance_service
-          end
-
-          def use_store_credit_service
-            Spree.api.platform_order_use_store_credit_service
-          end
-
-          def complete_service
-            Spree.api.platform_order_complete_service
-          end
-
-          def empty_service
-            Spree.api.platform_order_empty_service
-          end
-
-          def destroy_service
-            Spree.api.platform_order_destroy_service
-          end
-
-          def approve_service
-            Spree.api.platform_order_approve_service
-          end
-
-          def cancel_service
-            Spree.api.platform_order_cancel_service
-          end
-
-          def coupon_handler
-            Spree.api.platform_coupon_handler
-          end
-
-          def spree_permitted_attributes
-            super + [
-              bill_address_attributes: Spree::Address.json_api_permitted_attributes,
-              ship_address_attributes: Spree::Address.json_api_permitted_attributes,
-              line_items_attributes: Spree::LineItem.json_api_permitted_attributes,
-              payments_attributes: Spree::Payment.json_api_permitted_attributes + [
-                source_attributes: Spree::CreditCard.json_api_permitted_attributes
-              ],
-              shipments_attributes: Spree::Shipment.json_api_permitted_attributes
-            ]
-          end
-
-          def resource_serializer
-            Spree.api.platform_order_serializer
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v2/platform/payment_methods_controller.rb

@@ -1,31 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class PaymentMethodsController < ResourceController
-          private
-
-          def model_class
-            Spree::PaymentMethod
-          end
-
-          def spree_permitted_attributes
-            preferred_attributes = []
-
-            if action_name == 'update'
-              resource.defined_preferences.each do |preference|
-                preferred_attributes << "preferred_#{preference}".to_sym
-              end
-            end
-
-            super + preferred_attributes
-          end
-
-          def resource_serializer
-            Spree.api.platform_payment_method_serializer
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v2/platform/payments_controller.rb

@@ -1,21 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class PaymentsController < ResourceController
-          include NumberResource
-
-          private
-
-          def model_class
-            Spree::Payment
-          end
-
-          def resource_serializer
-            Spree.api.platform_payment_serializer
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v2/platform/products_controller.rb

@@ -1,41 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class ProductsController < ResourceController
-          include ::Spree::Api::V2::ProductListIncludes
-
-          private
-
-          def model_class
-            Spree::Product
-          end
-
-          def scope_includes
-            product_list_includes
-          end
-
-          def spree_permitted_attributes
-            super.push(:price)
-          end
-
-          def allowed_sort_attributes
-            super.push(:available_on, :make_active_at)
-          end
-
-          def sorted_collection
-            collection_sorter.new(collection, current_currency, params, allowed_sort_attributes).call
-          end
-
-          def collection_sorter
-            Spree.api.platform_products_sorter
-          end
-
-          def resource_serializer
-            Spree.api.platform_product_serializer
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v2/platform/promotion_actions_controller.rb

@@ -1,34 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class PromotionActionsController < ResourceController
-          include ::Spree::Api::V2::Platform::PromotionCalculatorParams
-
-          private
-
-          def model_class
-            Spree::PromotionAction
-          end
-
-          def scope_includes
-            [:promotion]
-          end
-
-          def spree_permitted_attributes
-            conditional_params = action_name == 'update' ? [:id] : []
-
-            super + [{
-              promotion_action_line_items_attributes: Spree::PromotionActionLineItem.json_api_permitted_attributes.concat(conditional_params),
-              calculator_attributes: Spree::Calculator.json_api_permitted_attributes.concat(conditional_params, calculator_params)
-            }]
-          end
-
-          def resource_serializer
-            Spree.api.platform_promotion_action_serializer
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v2/platform/promotion_categories_controller.rb

@@ -1,23 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class PromotionCategoriesController < ResourceController
-          private
-
-          def model_class
-            Spree::PromotionCategory
-          end
-
-          def scope_includes
-            [:promotions]
-          end
-
-          def resource_serializer
-            Spree.api.platform_promotion_category_serializer
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v2/platform/promotion_rules_controller.rb

@@ -1,29 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class PromotionRulesController < ResourceController
-          include ::Spree::Api::V2::Platform::PromotionRuleParams
-
-          private
-
-          def model_class
-            Spree::PromotionRule
-          end
-
-          def scope_includes
-            [:promotion]
-          end
-
-          def spree_permitted_attributes
-            super + rule_params
-          end
-
-          def resource_serializer
-            Spree.api.platform_promotion_rule_serializer
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v2/platform/promotions_controller.rb

@@ -1,35 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class PromotionsController < ResourceController
-          include ::Spree::Api::V2::Platform::PromotionRuleParams
-          include ::Spree::Api::V2::Platform::PromotionCalculatorParams
-
-          private
-
-          def model_class
-            Spree::Promotion
-          end
-
-          def scope_includes
-            [:promotion_category, :promotion_rules, :promotion_actions]
-          end
-
-          def spree_permitted_attributes
-            conditional_params = action_name == 'update' ? [:id] : []
-
-            super + [{ promotion_actions_attributes: Spree::PromotionAction.json_api_permitted_attributes.concat(conditional_params) + [{
-              promotion_action_line_items_attributes: Spree::PromotionActionLineItem.json_api_permitted_attributes.concat(conditional_params),
-              calculator_attributes: Spree::Calculator.json_api_permitted_attributes.concat(conditional_params, calculator_params)
-            }], promotion_rules_attributes: Spree::PromotionRule.json_api_permitted_attributes.concat(conditional_params, rule_params) }]
-          end
-
-          def resource_serializer
-            Spree.api.platform_promotion_serializer
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v2/platform/resource_controller.rb

@@ -1,154 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class ResourceController < ::Spree::Api::V2::ResourceController
-          # doorkeeper scopes usage: https://github.com/doorkeeper-gem/doorkeeper/wiki/Using-Scopes
-          before_action :validate_token_client
-          before_action -> { doorkeeper_authorize! :read, :admin }
-          before_action -> { doorkeeper_authorize! :write, :admin }, if: :write_request?
-
-          # optional authorization if using a user token instead of app token
-          before_action :authorize_spree_user
-
-          # index and show actions are defined in Spree::Api::V2::ResourceController
-
-          def create
-            resource = model_class.new(permitted_resource_params)
-            ensure_current_store(resource)
-
-            if resource.save
-              render_serialized_payload(201) { serialize_resource(resource) }
-            else
-              render_error_payload(resource.errors)
-            end
-          end
-
-          def update
-            resource.assign_attributes(permitted_resource_params)
-            ensure_current_store(resource)
-
-            if resource.save
-              render_serialized_payload { serialize_resource(resource) }
-            else
-              render_error_payload(resource.errors)
-            end
-          end
-
-          def destroy
-            if resource.destroy
-              head 204
-            else
-              render_error_payload(resource.errors)
-            end
-          end
-
-          protected
-
-          def resource_serializer
-            serializer_base_name = model_class.to_s.sub('Spree::', '')
-            "Spree::Api::V2::Platform::#{serializer_base_name}Serializer".constantize
-          end
-
-          def collection_serializer
-            resource_serializer
-          end
-
-          # overwriting to utilize ransack gem for filtering
-          # https://github.com/activerecord-hackery/ransack#search-matchers
-          def collection
-            @collection ||= scope.ransack(params[:filter]).result
-          end
-
-          # overwriting to skip cancancan check if API is consumed by an application
-          def scope
-            return super if spree_current_user.present?
-
-            super(skip_cancancan: true)
-          end
-
-          # We're overwriting this method because the original one calls `dookreeper_authorize`
-          # which breaks our application authorizations defined on top of this controller
-          def spree_current_user
-            return nil unless doorkeeper_token
-            return nil if doorkeeper_token.resource_owner_id.nil?
-            return @spree_current_user if @spree_current_user
-
-            @spree_current_user ||= doorkeeper_token.resource_owner
-          end
-
-          def access_denied(exception)
-            access_denied_401(exception)
-          end
-
-          def validate_token_client
-            return if doorkeeper_token.nil?
-
-            raise Doorkeeper::Errors::DoorkeeperError if doorkeeper_token.application.nil?
-          end
-
-          # if using a user oAuth token we need to check CanCanCan abilities
-          # defined in https://github.com/spree/spree/blob/main/core/app/models/spree/ability.rb
-          def authorize_spree_user
-            return if spree_current_user.nil?
-
-            case action_name
-            when 'create'
-              spree_authorize! :create, model_class
-            when 'destroy'
-              spree_authorize! :destroy, resource
-            when 'index'
-              spree_authorize! :read, model_class
-            when 'show'
-              spree_authorize! :read, resource
-            else
-              spree_authorize! :update, resource
-            end
-          end
-
-          def model_param_name
-            model_class.to_s.demodulize.underscore
-          end
-
-          def spree_permitted_attributes
-            store_ids = if model_class.method_defined?(:stores)
-                          [{ store_ids: [] }]
-                        else
-                          []
-                        end
-
-            model_class.json_api_permitted_attributes + store_ids + metadata_params + metafields_params
-          end
-
-          def metadata_params
-            if model_class.include?(Metadata)
-              [{ public_metadata: {}, private_metadata: {} }]
-            else
-              []
-            end
-          end
-
-          def metafields_params
-            if Spree::MetafieldDefinition.available_resources.map(&:name).include?(model_class.name) && model_class.method_defined?(:metafields)
-              [{ metafields_attributes: Spree::PermittedAttributes.metafield_attributes }]
-            else
-              []
-            end
-          end
-
-          def permitted_resource_params
-            params.require(model_param_name).permit(spree_permitted_attributes)
-          end
-
-          def allowed_sort_attributes
-            (super << spree_permitted_attributes).uniq.compact
-          end
-
-          def write_request?
-            %w[put patch post delete].include?(request.request_method.downcase)
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v2/platform/roles_controller.rb

@@ -1,19 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class RolesController < ResourceController
-          private
-
-          def model_class
-            Spree::Role
-          end
-
-          def resource_serializer
-            Spree.api.platform_role_serializer
-          end
-        end
-      end
-    end
-  end
-end