spree_api 5.3.5 → 5.4.0.beta

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

@@ -1,147 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class ShipmentsController < ResourceController
-          include NumberResource
-
-          before_action :load_variant, only: %i[transfer_to_location transfer_to_shipment]
-
-          SHIPMENT_STATES = %w[ready ship cancel resume pend]
-
-          def create
-            # FIXME: support saving metadata
-            result = create_service.call(
-              store: current_store,
-              shipment_attributes: params.require(:shipment).permit(
-                :order_id, :stock_location_id, :variant_id, :quantity
-              )
-            )
-            render_result(result, 201)
-          end
-
-          def update
-            result = update_service.call(shipment: resource, shipment_attributes: permitted_resource_params)
-            render_result(result)
-          end
-
-          SHIPMENT_STATES.each do |state|
-            define_method state do
-              result = change_state_service.call(shipment: resource, state: state)
-              render_result(result)
-            end
-          end
-
-          def add_item
-            result = add_item_service.call(
-              shipment: resource,
-              variant_id: params.dig(:shipment, :variant_id),
-              quantity: params.dig(:shipment, :quantity)
-            )
-            render_result(result)
-          end
-
-          def remove_item
-            result = remove_item_service.call(
-              shipment: resource,
-              variant_id: params.dig(:shipment, :variant_id),
-              quantity: params.dig(:shipment, :quantity)
-            )
-
-            if result.success?
-              if result.value == :shipment_deleted
-                head 204
-              else
-                render_serialized_payload { serialize_resource(result.value) }
-              end
-            else
-              render_error_payload(result.error)
-            end
-          end
-
-          def transfer_to_location
-            stock_location = Spree::StockLocation.find(params.dig(:shipment, :stock_location_id))
-            quantity = params.dig(:shipment, :quantity)&.to_i || 1
-
-            unless quantity > 0
-              render_error_payload("#{I18n.t('spree.api.shipment_transfer_errors_occurred')} \n #{I18n.t('spree.api.negative_quantity')}")
-              return
-            end
-
-            transfer = resource.transfer_to_location(@variant, quantity, stock_location)
-            if transfer.valid? && transfer.run!
-              render json: { message: I18n.t('spree.api.shipment_transfer_success') }, status: 201
-            else
-              render_error_payload(transfer.errors)
-            end
-          end
-
-          def transfer_to_shipment
-            target_shipment = Spree::Shipment.find_by!(number: params.dig(:shipment, :target_shipment_number))
-            quantity = params.dig(:shipment, :quantity)&.to_i || 1
-
-            error =
-              if quantity < 0 && target_shipment == resource
-                "#{I18n.t('spree.api.negative_quantity')}, \n#{I18n.t('spree.api.wrong_shipment_target')}"
-              elsif target_shipment == resource
-                I18n.t('spree.api.wrong_shipment_target')
-              elsif quantity < 0
-                I18n.t('spree.api.negative_quantity')
-              end
-
-            if error
-              render_error_payload("#{I18n.t('spree.api.shipment_transfer_errors_occurred')} \n#{error}")
-            else
-              transfer = resource.transfer_to_shipment(@variant, quantity, target_shipment)
-              if transfer.valid? && transfer.run!
-                render json: { message: I18n.t('spree.api.shipment_transfer_success') }, status: 201
-              else
-                render_error_payload(transfer.errors)
-              end
-            end
-          end
-
-          private
-
-          def model_class
-            Spree::Shipment
-          end
-
-          def load_variant
-            @variant = current_store.variants.find_by(id: params.dig(:shipment, :variant_id))
-          end
-
-          def spree_permitted_attributes
-            Spree::Shipment.json_api_permitted_attributes + [
-              :selected_shipping_rate_id
-            ]
-          end
-
-          def create_service
-            Spree.api.platform_shipment_create_service
-          end
-
-          def update_service
-            Spree.api.platform_shipment_update_service
-          end
-
-          def change_state_service
-            Spree.api.platform_shipment_change_state_service
-          end
-
-          def add_item_service
-            Spree.api.platform_shipment_add_item_service
-          end
-
-          def remove_item_service
-            Spree.api.platform_shipment_remove_item_service
-          end
-
-          def resource_serializer
-            Spree.api.platform_shipment_serializer
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class ShippingCategoriesController < ResourceController
-          private
-
-          def model_class
-            Spree::ShippingCategory
-          end
-
-          def resource_serializer
-            Spree.api.platform_shipping_category_serializer
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class ShippingMethodsController < ResourceController
-          private
-
-          def model_class
-            Spree::ShippingMethod
-          end
-
-          def spree_permitted_attributes
-            super + [
-              {
-                shipping_category_ids: [],
-                calculator_attributes: {}
-              }
-            ]
-          end
-
-          def resource_serializer
-            Spree.api.platform_shipping_method_serializer
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class StatesController < ResourceController
-          private
-
-          def model_class
-            Spree::State
-          end
-
-          def scope_includes
-            [:country]
-          end
-
-          def resource_serializer
-            Spree.api.platform_state_serializer
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class StockItemsController < ResourceController
-          private
-
-          def model_class
-            Spree::StockItem
-          end
-
-          def scope_includes
-            [:variant, :stock_location]
-          end
-
-          def resource_serializer
-            Spree.api.platform_stock_item_serializer
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class StockLocationsController < ResourceController
-          private
-
-          def model_class
-            Spree::StockLocation
-          end
-
-          def scope_includes
-            [:country]
-          end
-
-          def resource_serializer
-            Spree.api.platform_stock_location_serializer
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class StoreCreditCategoriesController < ResourceController
-          private
-
-          def model_class
-            Spree::StoreCreditCategory
-          end
-
-          def resource_serializer
-            Spree.api.platform_store_credit_category_serializer
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class StoreCreditTypesController < ResourceController
-          private
-
-          def model_class
-            Spree::StoreCreditType
-          end
-
-          def resource_serializer
-            Spree.api.platform_store_credit_type_serializer
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class StoreCreditsController < ResourceController
-          private
-
-          def model_class
-            Spree::StoreCredit
-          end
-
-          def scope_includes
-            [:user, :created_by, :category, :credit_type]
-          end
-
-          def resource_serializer
-            Spree.api.platform_store_credit_serializer
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class TaxCategoriesController < ResourceController
-          private
-
-          def model_class
-            Spree::TaxCategory
-          end
-
-          def scope_includes
-            [:tax_rates]
-          end
-
-          def resource_serializer
-            Spree.api.platform_tax_category_serializer
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class TaxRatesController < ResourceController
-          private
-
-          def model_class
-            Spree::TaxRate
-          end
-
-          def scope_includes
-            [:zone, :tax_category]
-          end
-
-          def spree_permitted_attributes
-            super + [calculator_attributes: Spree::Calculator.json_api_permitted_attributes]
-          end
-
-          def resource_serializer
-            Spree.api.platform_tax_rate_serializer
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class TaxonomiesController < ResourceController
-          private
-
-          def model_class
-            Spree::Taxonomy
-          end
-
-          def scope_includes
-            [:taxons, :root]
-          end
-
-          def resource_serializer
-            Spree.api.platform_taxonomy_serializer
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,59 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class TaxonsController < ResourceController
-          include ::Spree::Api::V2::Platform::NestedSetRepositionConcern
-
-          private
-
-          def successful_reposition_actions
-            reload_taxon_and_set_new_permalink(resource)
-            update_permalinks_on_child_taxons
-
-            render_serialized_payload { serialize_resource(resource) }
-          end
-
-          def reload_taxon_and_set_new_permalink(taxon)
-            taxon.reload
-            taxon.set_permalink
-            taxon.save!
-          end
-
-          def update_permalinks_on_child_taxons
-            resource.descendants.each do |taxon|
-              reload_taxon_and_set_new_permalink(taxon)
-            end
-          end
-
-          def model_class
-            Spree::Taxon
-          end
-
-          def scope_includes
-            node_includes = %i[icon parent taxonomy]
-
-            {
-              parent: node_includes,
-              children: node_includes,
-              taxonomy: [root: node_includes],
-              icon: [attachment_attachment: :blob]
-            }
-          end
-
-          def serializer_params
-            super.merge(include_products: action_name == 'show')
-          end
-
-          def spree_permitted_attributes
-            super + [:new_parent_id, :new_position_idx]
-          end
-
-          def resource_serializer
-            Spree.api.platform_taxon_serializer
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,37 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class UsersController < ResourceController
-          private
-
-          def model_class
-            Spree.user_class
-          end
-
-          def resource_serializer
-            Spree.api.platform_user_serializer
-          end
-
-          def scope_includes
-            [:ship_address, :bill_address]
-          end
-
-          # we need to define this here as developers can configure their own `user_class`
-          def model_param_name
-            'user'
-          end
-
-          def spree_permitted_attributes
-            super + [:password, :password_confirmation]
-          end
-
-          # we need to override this method to avoid trying to create user role when creating a user
-          def ensure_current_store(_resource)
-            # do nothing
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class VariantsController < ResourceController
-          private
-
-          def model_class
-            Spree::Variant
-          end
-
-          def spree_permitted_attributes
-            super + [:option_value_ids, :price, :currency]
-          end
-
-          def resource_serializer
-            Spree.api.platform_variant_serializer
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class WishedItemsController < ResourceController
-          private
-
-          def scope_includes
-            [:variant]
-          end
-
-          def model_class
-            Spree::WishedItem
-          end
-
-          def resource_serializer
-            Spree.api.platform_wished_item_serializer
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class WishlistsController < ResourceController
-          private
-
-          def model_class
-            Spree::Wishlist
-          end
-
-          def scope_includes
-            [:wished_items]
-          end
-
-          def resource_serializer
-            Spree.api.platform_wishlist_serializer
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class ZonesController < ResourceController
-          private
-
-          def model_class
-            Spree::Zone
-          end
-
-          def scope_includes
-            [:zone_members]
-          end
-
-          def resource_serializer
-            Spree.api.platform_zone_serializer
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,79 +0,0 @@
-module Spree
-  module Api
-    module V2
-      class ResourceController < ::Spree::Api::V2::BaseController
-        include Spree::Api::V2::CollectionOptionsHelpers
-        include Spree::Api::V2::Caching
-
-        def index
-          render_serialized_payload do
-            Rails.cache.fetch(collection_cache_key(paginated_collection), collection_cache_opts) do
-              serialize_collection(paginated_collection)
-            end
-          end
-        end
-
-        def show
-          render_serialized_payload { serialize_resource(resource) }
-        end
-
-        protected
-
-        def sorted_collection
-          @sorted_collection ||= collection_sorter.new(collection, params, allowed_sort_attributes).call
-        end
-
-        def allowed_sort_attributes
-          default_sort_attributes
-        end
-
-        def default_sort_attributes
-          [:id, :name, :slug, :number, :position, :updated_at, :created_at, :deleted_at]
-        end
-
-        def scope(skip_cancancan: false)
-          base_scope = model_class.for_store(current_store)
-          base_scope = base_scope.accessible_by(current_ability, :show) unless skip_cancancan
-          base_scope = base_scope.includes(scope_includes) if scope_includes.any? && action_name == 'index'
-          model_class.include?(TranslatableResource) ? base_scope.i18n : base_scope
-        end
-
-        def scope_includes
-          []
-        end
-
-        def resource
-          @resource ||= if defined?(resource_finder)
-                          resource_finder.new(scope: scope, params: finder_params).execute
-                        else
-                          scope.find(params[:id])
-                        end
-        end
-
-        def collection
-          @collection ||= begin
-            result = if defined?(collection_finder)
-                       collection_finder.new(scope: scope, params: finder_params).execute
-                     else
-                       scope
-                     end
-            result.preload_associations_lazily
-          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.storefront_collection_sorter
-        end
-      end
-    end
-  end
-end