spree_api 4.2.0.rc2 → 4.2.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 870bda309064df374e65aee63ddd2d7abb72004dbb6d218f0b1b77b7f5b0219f
-  data.tar.gz: e8fd20974f60d065473f2fb1303dd86221de56173f6a1e957c7efc8d5dba2aed
+  metadata.gz: 91e71f07d6f92ec8d91766b639b1b8cac45eb77d7b315cb9f1c64386781f4e93
+  data.tar.gz: 30599040f61b4ce8a2b43f806d7b5a1ecb06caab6412de565da6eed3370924b5
 SHA512:
-  metadata.gz: 37e0a2ef4037067d2ffd5391d70b7c9fd6953d0529721e83ba7935755b1bca9515bc047e16525cae1df3d68e0815082f21e3e5579521f80259c717abe06d0b76
-  data.tar.gz: 87d24be4132f732043258a35db7b5398f3a63fe99908141e6bbba92786e5897a2c9c9ddf0c3ed5efa9b3da6b65a73f2ac5e4a895fc4bb69038ab5e597ece2932
+  metadata.gz: c5b26dc1484564a4fc64da2ef148a2662c6b9d5ac11f059b894feb1362659e4841c496bc2c8926f8e60536251a1b5d8ff8f17bcc23eecd265edc5ee95d12e458
+  data.tar.gz: 4d7e2cf195104266d197256c0b9fb1fd08cbe13855f11dfead0246c780f6fa92b0c2f0ca86483b1708eebd77b03bec6ece68f40d28cf97b1f53c06cc5b9db1b7

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

@@ -81,10 +81,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/v2/base_controller.rb

@@ -13,31 +13,6 @@ module Spree
           Spree::Api::Config[:api_v2_content_type]
         end
 
-        private
-
-        def serialize_collection(collection)
-          collection_serializer.new(
-            collection,
-            collection_options(collection)
-          ).serializable_hash
-        end
-
-        def serialize_resource(resource)
-          resource_serializer.new(
-            resource,
-            include: resource_includes,
-            fields: sparse_fields
-          ).serializable_hash
-        end
-
-        def paginated_collection
-          collection_paginator.new(sorted_collection, params).call
-        end
-
-        def collection_paginator
-          Spree::Api::Dependencies.storefront_collection_paginator.constantize
-        end
-
         def render_serialized_payload(status = 200)
           render json: yield, status: status, content_type: content_type
         rescue ArgumentError => exception

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

@@ -0,0 +1,82 @@
+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 serialize_collection(collection)
+          collection_serializer.new(
+            collection,
+            collection_options(collection)
+          ).serializable_hash
+        end
+
+        def serialize_resource(resource)
+          resource_serializer.new(
+            resource,
+            include: resource_includes,
+            fields: sparse_fields
+          ).serializable_hash
+        end
+
+        def paginated_collection
+          collection_paginator.new(sorted_collection, params).call
+        end
+
+        def collection_paginator
+          Spree::Api::Dependencies.storefront_collection_paginator.constantize
+        end
+
+        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,6 +19,10 @@ module Spree
               resource
             end
 
+            def allowed_sort_attributes
+              super << :completed_at
+            end
+
             def collection_serializer
               Spree::Api::Dependencies.storefront_order_serializer.constantize
             end
@@ -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/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

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

@@ -2,15 +2,11 @@ module Spree
   module Api
     module V2
       module Storefront
-        class OrderStatusController < ::Spree::Api::V2::BaseController
+        class OrderStatusController < ::Spree::Api::V2::ResourceController
           include Spree::Api::V2::Storefront::OrderConcern
 
           before_action :ensure_order_token
 
-          def show
-            render_serialized_payload { serialize_resource(resource) }
-          end
-
           private
 
           def resource

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

@@ -2,21 +2,11 @@ module Spree
   module Api
     module V2
       module Storefront
-        class ProductsController < ::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
-
+        class ProductsController < ::Spree::Api::V2::ResourceController
           private
 
           def sorted_collection
-            collection_sorter.new(collection, params, current_currency).call
+            collection_sorter.new(collection, current_currency, params, allowed_sort_attributes).call
           end
 
           def collection
@@ -43,8 +33,8 @@ module Spree
             Spree::Api::Dependencies.storefront_product_serializer.constantize
           end
 
-          def scope
-            Spree::Product.accessible_by(current_ability, :show).includes(scope_includes)
+          def model_class
+            Spree::Product
           end
 
           def scope_includes

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

@@ -2,14 +2,10 @@ module Spree
   module Api
     module V2
       module Storefront
-        class StoresController < ::Spree::Api::V2::BaseController
-          def show
-            render_serialized_payload { serialize_resource(resource) }
-          end
-
+        class StoresController < ::Spree::Api::V2::ResourceController
           private
 
-          def scope
+          def model_class
             Spree::Store
           end