spree_api 4.2.0.rc1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ca201da4875f262850ded05d71868a5161f3e8055c6047b544bef63f536e5d3
-  data.tar.gz: cfc2c37c3bdd2041b91cfa4cffad2643f4131a69fb8793b6eb6c793e5ae17ee6
+  metadata.gz: aa0ba5ffcc873cf68159260e0b7f52879f39f54f7140887a438c73f1257293d2
+  data.tar.gz: 1f05304db222d36a1f31d563ea5a071a01cfe7eb80fa4c13a002b6a4dd6775f8
 SHA512:
-  metadata.gz: dfd25ddcca9e0fb04dd7141cfa5fb153ff43de9f0137fa3d78618300a71372c5057de303ab0728da69aa08c3e0a0eba0675493bf0bf42caa8f325207fb94603c
-  data.tar.gz: 4798f5ddbfc85d778adcfd0509ea7d2361f1464a61ae6a194d4d8f7d1014738e570a89c17b95c735317f25394ca8ad75c148e1fc81d4a2f195a986a8ac63f55a
+  metadata.gz: 0d83abd3762d05c58b37e8290d0fddc8ead28edc15ad3dd1267915ed2abb234399a36071a8250d4d7a3e08a0871e5e438acff6a28a67d2512460ec718c1785dd
+  data.tar.gz: 41eee02e45c3491b25333eecda173b23a520e0595ba39ef4c38ad1eb7d356d4c206ee7f16d19fd927f5e291475e3a40f6a785a634f0c1055f29cf60ad1e82ea8

data/app/controllers/concerns/spree/api/v2/storefront/order_concern.rb

@@ -34,16 +34,16 @@ module Spree
             )
           end
 
-          def supported_currencies
-            current_store.supported_currencies_list
+          def serialized_current_order
+            serialize_resource(spree_current_order)
           end
 
           def serialize_order(order)
-            resource_serializer.new(order.reload, include: resource_includes, fields: sparse_fields).serializable_hash
-          end
-
-          def serialized_current_order
-            serialize_order(spree_current_order)
+            ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+              `OrderConcern#serialize_order` is deprecated and will be removed in Spree 5.0.
+              Please use `serializer_resource` method
+            DEPRECATION
+            serialize_resource(order)
           end
         end
       end

data/app/controllers/spree/api/base_controller.rb

@@ -6,6 +6,8 @@ module Spree
       include Spree::Api::ControllerSetup
       include Spree::Core::ControllerHelpers::Store
       include Spree::Core::ControllerHelpers::StrongParameters
+      include Spree::Core::ControllerHelpers::Locale
+      include Spree::Core::ControllerHelpers::Currency
 
       attr_accessor :current_api_user
 
@@ -81,10 +83,16 @@ module Spree
       end
 
       def error_during_processing(exception)
-        Rails.logger.error exception.message
+        message = if exception.respond_to?(:original_message)
+                    exception.original_message
+                  else
+                    exception.message
+                  end
+
+        Rails.logger.error message
         Rails.logger.error exception.backtrace.join("\n")
 
-        unprocessable_entity(exception.message)
+        unprocessable_entity(message)
       end
 
       def unprocessable_entity(message)

data/app/controllers/spree/api/v1/shipments_controller.rb

@@ -92,12 +92,17 @@ module Spree
           @stock_location = Spree::StockLocation.find(params[:stock_location_id])
 
           unless @quantity > 0
-            unprocessable_entity("#{Spree.t(:shipment_transfer_errors_occured, scope: 'api')} \n #{Spree.t(:negative_quantity, scope: 'api')}")
+            unprocessable_entity("#{Spree.t(:shipment_transfer_errors_occurred, scope: 'api')} \n #{Spree.t(:negative_quantity, scope: 'api')}")
             return
           end
 
-          @original_shipment.transfer_to_location(@variant, @quantity, @stock_location)
-          render json: { success: true, message: Spree.t(:shipment_transfer_success) }, status: 201
+          transfer = @original_shipment.transfer_to_location(@variant, @quantity, @stock_location)
+          if transfer.valid?
+            transfer.run!
+            render json: { message: Spree.t(:shipment_transfer_success) }, status: 201
+          else
+            render json: { message: transfer.errors.full_messages.to_sentence }, status: 422
+          end
         end
 
         def transfer_to_shipment
@@ -113,10 +118,15 @@ module Spree
             end
 
           if error
-            unprocessable_entity("#{Spree.t(:shipment_transfer_errors_occured, scope: 'api')} \n#{error}")
+            unprocessable_entity("#{Spree.t(:shipment_transfer_errors_occurred, scope: 'api')} \n#{error}")
           else
-            @original_shipment.transfer_to_shipment(@variant, @quantity, @target_shipment)
-            render json: { success: true, message: Spree.t(:shipment_transfer_success) }, status: 201
+            transfer = @original_shipment.transfer_to_shipment(@variant, @quantity, @target_shipment)
+            if transfer.valid?
+              transfer.run!
+              render json: { message: Spree.t(:shipment_transfer_success) }, status: 201
+            else
+              render json: { message: transfer.errors.full_messages }, status: 422
+            end
           end
         end
 

data/app/controllers/spree/api/v1/taxons_controller.rb

@@ -37,7 +37,7 @@ module Spree
             invalid_resource!(@taxon) and return
           end
 
-          @taxon.parent_id = taxonomy.root.id unless params[:taxon][:parent_id]
+          @taxon.parent_id = taxonomy.root_id unless params[:taxon][:parent_id]
 
           if @taxon.save
             respond_with(@taxon, status: 201, default_template: :show)

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

@@ -5,26 +5,31 @@ module Spree
         include CanCan::ControllerAdditions
         include Spree::Core::ControllerHelpers::StrongParameters
         include Spree::Core::ControllerHelpers::Store
+        include Spree::Core::ControllerHelpers::Locale
+        include Spree::Core::ControllerHelpers::Currency
         rescue_from ActiveRecord::RecordNotFound, with: :record_not_found
         rescue_from CanCan::AccessDenied, with: :access_denied
         rescue_from Spree::Core::GatewayError, with: :gateway_error
+        rescue_from ActionController::ParameterMissing, with: :error_during_processing
+        rescue_from ArgumentError, with: :error_during_processing
 
         def content_type
           Spree::Api::Config[:api_v2_content_type]
         end
 
-        private
+        protected
 
         def serialize_collection(collection)
           collection_serializer.new(
             collection,
-            collection_options(collection)
+            collection_options(collection).merge(params: serializer_params)
           ).serializable_hash
         end
 
         def serialize_resource(resource)
           resource_serializer.new(
             resource,
+            params: serializer_params,
             include: resource_includes,
             fields: sparse_fields
           ).serializable_hash
@@ -40,8 +45,6 @@ module Spree
 
         def render_serialized_payload(status = 200)
           render json: yield, status: status, content_type: content_type
-        rescue ArgumentError => exception
-          render_error_payload(exception.message, 400)
         end
 
         def render_error_payload(error, status = 422)
@@ -107,6 +110,10 @@ module Spree
           fields.presence
         end
 
+        def serializer_params
+          { currency: current_currency, store: current_store, user: spree_current_user }
+        end
+
         def record_not_found
           render_error_payload(I18n.t(:resource_not_found, scope: 'spree.api'), 404)
         end
@@ -118,6 +125,16 @@ module Spree
         def gateway_error(exception)
           render_error_payload(exception.message)
         end
+
+        def error_during_processing(exception)
+          result = error_handler.call(exception: exception, opts: { user: spree_current_user })
+
+          render_error_payload(result.value[:message], 400)
+        end
+
+        def error_handler
+          Spree::Api::Dependencies.error_handler.constantize
+        end
       end
     end
   end

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

@@ -0,0 +1,59 @@
+module Spree
+  module Api
+    module V2
+      class ResourceController < ::Spree::Api::V2::BaseController
+        include Spree::Api::V2::CollectionOptionsHelpers
+
+        def index
+          render_serialized_payload { serialize_collection(paginated_collection) }
+        end
+
+        def show
+          render_serialized_payload { serialize_resource(resource) }
+        end
+
+        protected
+
+        def sorted_collection
+          collection_sorter.new(collection, params, allowed_sort_attributes).call
+        end
+
+        def allowed_sort_attributes
+          default_sort_atributes
+        end
+
+        def default_sort_atributes
+          [:id, :updated_at, :created_at]
+        end
+
+        def scope
+          model_class.accessible_by(current_ability, :show).includes(scope_includes)
+        end
+
+        def scope_includes
+          []
+        end
+
+        def resource
+          @resource ||= if defined?(resource_finder)
+                          resource_finder.new(scope: scope, params: params).execute
+                        else
+                          scope.find(params[:id])
+                        end
+        end
+
+        def collection
+          @collection ||= if defined?(collection_finder)
+                            collection_finder.new(scope: scope, params: params).execute
+                          else
+                            scope
+                          end
+        end
+
+        def collection_sorter
+          Spree::Api::Dependencies.storefront_collection_sorter.constantize
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/storefront/account/addresses_controller.rb

@@ -3,13 +3,9 @@ module Spree
     module V2
       module Storefront
         module Account
-          class AddressesController < ::Spree::Api::V2::BaseController
+          class AddressesController < ::Spree::Api::V2::ResourceController
             before_action :require_spree_current_user
 
-            def index
-              render_serialized_payload { serialize_collection(collection) }
-            end
-
             def create
               result = create_service.call(user: spree_current_user, address_params: address_params)
               render_result(result)
@@ -26,12 +22,8 @@ module Spree
               collection_finder.new(scope: scope, params: params).execute
             end
 
-            def resource
-              @resource ||= scope.find(params[:id])
-            end
-
-            def scope
-              spree_current_user.addresses
+            def model_class
+              Spree::Address
             end
 
             def collection_finder

data/app/controllers/spree/api/v2/storefront/account/credit_cards_controller.rb

@@ -3,27 +3,23 @@ module Spree
     module V2
       module Storefront
         module Account
-          class CreditCardsController < ::Spree::Api::V2::BaseController
+          class CreditCardsController < ::Spree::Api::V2::ResourceController
             before_action :require_spree_current_user
 
-            def index
-              render_serialized_payload { serialize_collection(resource) }
-            end
-
-            def show
-              render_serialized_payload { serialize_resource(resource) }
-            end
-
             private
 
-            def resource
-              resource_finder.new.execute(scope: scope, params: params)
+            def model_class
+              Spree::CreditCard
             end
 
             def collection_serializer
               Spree::Api::Dependencies.storefront_credit_card_serializer.constantize
             end
 
+            def collection_finder
+              Spree::Api::Dependencies.storefront_credit_card_finder.constantize
+            end
+
             def resource_serializer
               Spree::Api::Dependencies.storefront_credit_card_serializer.constantize
             end
@@ -39,10 +35,6 @@ module Spree
                 fields: sparse_fields
               ).serializable_hash
             end
-
-            def scope
-              spree_current_user.credit_cards.accessible_by(current_ability, :show)
-            end
           end
         end
       end

data/app/controllers/spree/api/v2/storefront/account/orders_controller.rb

@@ -3,26 +3,11 @@ module Spree
     module V2
       module Storefront
         module Account
-          class OrdersController < ::Spree::Api::V2::BaseController
-            include Spree::Api::V2::CollectionOptionsHelpers
+          class OrdersController < ::Spree::Api::V2::ResourceController
             before_action :require_spree_current_user
 
-            def index
-              render_serialized_payload { serialize_collection(paginated_collection) }
-            end
-
-            def show
-              spree_authorize! :show, resource
-
-              render_serialized_payload { serialize_resource(resource) }
-            end
-
             private
 
-            def sorted_collection
-              collection_sorter.new(collection, params).call
-            end
-
             def collection
               collection_finder.new(user: spree_current_user).execute
             end
@@ -34,12 +19,16 @@ module Spree
               resource
             end
 
+            def allowed_sort_attributes
+              super << :completed_at
+            end
+
             def collection_serializer
-              Spree::Api::Dependencies.storefront_cart_serializer.constantize
+              Spree::Api::Dependencies.storefront_order_serializer.constantize
             end
 
             def resource_serializer
-              Spree::Api::Dependencies.storefront_cart_serializer.constantize
+              Spree::Api::Dependencies.storefront_order_serializer.constantize
             end
 
             def collection_finder
@@ -49,14 +38,6 @@ module Spree
             def resource_finder
               Spree::Api::Dependencies.storefront_completed_order_finder.constantize
             end
-
-            def collection_sorter
-              Spree::Api::Dependencies.storefront_order_sorter.constantize
-            end
-
-            def collection_paginator
-              Spree::Api::Dependencies.storefront_collection_paginator.constantize
-            end
           end
         end
       end

data/app/controllers/spree/api/v2/storefront/account_controller.rb

@@ -2,13 +2,9 @@ module Spree
   module Api
     module V2
       module Storefront
-        class AccountController < ::Spree::Api::V2::BaseController
+        class AccountController < ::Spree::Api::V2::ResourceController
           before_action :require_spree_current_user
 
-          def show
-            render_serialized_payload { serialize_resource(resource) }
-          end
-
           private
 
           def resource

data/app/controllers/spree/api/v2/storefront/cart_controller.rb

@@ -19,7 +19,7 @@ module Spree
             order   = spree_current_order if spree_current_order.present?
             order ||= create_service.call(order_params).value
 
-            render_serialized_payload(201) { serialize_order(order) }
+            render_serialized_payload(201) { serialize_resource(order) }
           end
 
           def add_item

data/app/controllers/spree/api/v2/storefront/countries_controller.rb

@@ -2,17 +2,7 @@ module Spree
   module Api
     module V2
       module Storefront
-        class CountriesController < ::Spree::Api::V2::BaseController
-          include Spree::Api::V2::CollectionOptionsHelpers
-
-          def index
-            render_serialized_payload { serialize_collection(collection) }
-          end
-
-          def show
-            render_serialized_payload { serialize_resource(resource) }
-          end
-
+        class CountriesController < ::Spree::Api::V2::ResourceController
           private
 
           def serialize_collection(collection)
@@ -24,12 +14,15 @@ module Spree
               resource,
               include: resource_includes,
               fields: sparse_fields,
-              params: { include_states: true }
+              params: resource_serializer_params
             ).serializable_hash
           end
 
-          def collection
-            collection_finder.new(scope, params).call
+          def resource_serializer_params
+            {
+              include_states: true,
+              current_store: current_store
+            }
           end
 
           def resource
@@ -52,8 +45,8 @@ module Spree
             Spree::Api::Dependencies.storefront_country_finder.constantize
           end
 
-          def scope
-            Spree::Country.accessible_by(current_ability, :show)
+          def model_class
+            Spree::Country
           end
         end
       end