spree_api 4.2.0.rc5 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d89085eb3c34e7174431d231b1e9a883b6cbf3d7ee838d633125c352bd3a6db
-  data.tar.gz: 3402c8e857912d6655aea610e7092c4f749faf2f0b31a9f0c3f8601b292c43ba
+  metadata.gz: aa0ba5ffcc873cf68159260e0b7f52879f39f54f7140887a438c73f1257293d2
+  data.tar.gz: 1f05304db222d36a1f31d563ea5a071a01cfe7eb80fa4c13a002b6a4dd6775f8
 SHA512:
-  metadata.gz: bef7abadbdf0a40b95b04b45811eade8884c5f782c9720a3b009e90aabc133b9384122e65fcc443245102b6e444636e30f423d357efefebc8e63910240525efe
-  data.tar.gz: a1824c2bccb63b030b8d6cfe64237b1ce3b57dfd36adacdf71367b5a0408cec84a7d019bec4017c4d83f273a2de0e595d734cf506cb517b03b78932f9a871285
+  metadata.gz: 0d83abd3762d05c58b37e8290d0fddc8ead28edc15ad3dd1267915ed2abb234399a36071a8250d4d7a3e08a0871e5e438acff6a28a67d2512460ec718c1785dd
+  data.tar.gz: 41eee02e45c3491b25333eecda173b23a520e0595ba39ef4c38ad1eb7d356d4c206ee7f16d19fd927f5e291475e3a40f6a785a634f0c1055f29cf60ad1e82ea8

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

@@ -34,12 +34,16 @@ module Spree
             )
           end
 
-          def serialize_order(order)
-            resource_serializer.new(order.reload, include: resource_includes, fields: sparse_fields).serializable_hash
+          def serialized_current_order
+            serialize_resource(spree_current_order)
           end
 
-          def serialized_current_order
-            serialize_order(spree_current_order)
+          def serialize_order(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/v2/base_controller.rb

@@ -10,15 +10,41 @@ module Spree
         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
 
+        protected
+
+        def serialize_collection(collection)
+          collection_serializer.new(
+            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
+        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
-          render_error_payload(exception.message, 400)
         end
 
         def render_error_payload(error, status = 422)
@@ -99,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

@@ -14,30 +14,6 @@ module Spree
 
         protected
 
-        def serialize_collection(collection)
-          collection_serializer.new(
-            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
-        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

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/helpers/spree/api/api_helpers.rb

@@ -163,7 +163,7 @@ module Spree
         :id, :name, :url, :meta_description, :meta_keywords, :seo_title,
         :mail_from_address, :customer_support_email, :default_currency,
         :code, :default, :facebook, :twitter, :instagram,
-        :supported_currencies
+        :supported_currencies, :default_locale, :supported_locales
       ]
 
       @@tag_attributes = [:id, :name]

data/app/models/spree/api_configuration.rb

@@ -2,5 +2,6 @@ module Spree
   class ApiConfiguration < Preferences::Configuration
     preference :requires_authentication, :boolean, default: true
     preference :api_v2_content_type, :string, default: 'application/vnd.api+json'
+    preference :api_v2_per_page_limit, :integer, default: 100
   end
 end

data/app/models/spree/api_dependencies.rb

@@ -16,7 +16,7 @@ module Spree
       :storefront_cart_update_service, :storefront_cart_estimate_shipping_rates_service, :storefront_estimated_shipment_serializer,
       :storefront_store_serializer, :storefront_address_serializer, :storefront_order_serializer,
       :storefront_account_create_address_service, :storefront_account_update_address_service, :storefront_address_finder,
-      :storefront_collection_sorter
+      :storefront_collection_sorter, :error_handler
     ].freeze
 
     attr_accessor *INJECTION_POINTS
@@ -86,6 +86,8 @@ module Spree
       @storefront_find_by_variant_finder = Spree::Dependencies.line_item_by_variant_finder
       @storefront_products_finder = Spree::Dependencies.products_finder
       @storefront_taxon_finder = Spree::Dependencies.taxon_finder
+
+      @error_handler = 'Spree::Api::ErrorHandler'
     end
   end
 end

data/app/serializers/spree/v2/storefront/store_serializer.rb

@@ -6,7 +6,7 @@ module Spree
 
         attributes :name, :url, :meta_description, :meta_keywords, :seo_title, :default_currency, :default, :supported_currencies, :facebook,
                    :twitter, :instagram, :default_locale, :customer_support_email, :default_country_id, :description,
-                   :address, :contact_phone
+                   :address, :contact_phone, :supported_locales
 
         has_one :default_country, serializer: :country, record_type: :country, id_method_name: :default_country_id
       end

data/app/services/spree/api/error_handler.rb

@@ -0,0 +1,40 @@
+module Spree
+  module Api
+    class ErrorHandler
+      prepend ::Spree::ServiceModule::Base
+
+      def call(exception:, opts: {})
+        run :format_message
+        run :log_error
+        run :report_error
+      end
+
+      protected
+
+      def format_message(exception:, opts:)
+        message = if exception.respond_to?(:original_message)
+                    exception.original_message
+                  else
+                    exception.message
+                  end
+
+        success(exception: exception, message: message, opts: opts)
+      end
+
+      def log_error(exception:, message:, opts:)
+        Rails.logger.error message
+        Rails.logger.error "User ID: #{opts[:user]&.id}" if opts[:user]
+        Rails.logger.error exception.backtrace.join("\n")
+
+        success(exception: exception, message: message, opts: opts)
+      end
+
+      def report_error(exception:, message:, opts:)
+        # overwrite this method in your application to support different error handlers
+        # eg. Sentry, Rollbar, etc
+
+        success(exception: exception, message: message)
+      end
+    end
+  end
+end

data/config/initializers/doorkeeper.rb

@@ -3,6 +3,8 @@ Doorkeeper.configure do
   use_refresh_token
   api_only
 
+  skip_client_authentication_for_password_grant { true } if defined?(skip_client_authentication_for_password_grant)
+
   resource_owner_authenticator { current_spree_user }
 
   resource_owner_from_credentials do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 4.2.0.rc5
+  version: 4.2.0
 platform: ruby
 authors:
 - Ryan Bigg
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-04 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-rspec
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.rc5
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.rc5
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: rabl
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +181,7 @@ files:
 - app/serializers/spree/v2/storefront/taxonomy_serializer.rb
 - app/serializers/spree/v2/storefront/user_serializer.rb
 - app/serializers/spree/v2/storefront/variant_serializer.rb
+- app/services/spree/api/error_handler.rb
 - app/views/spree/api/errors/gateway_error.rabl
 - app/views/spree/api/errors/invalid_api_key.rabl
 - app/views/spree/api/errors/invalid_resource.rabl
@@ -309,9 +310,9 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/spree/spree/issues
-  changelog_uri: https://github.com/spree/spree/releases/tag/v4.2.0.rc5
+  changelog_uri: https://github.com/spree/spree/releases/tag/v4.2.0
   documentation_uri: https://guides.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v4.2.0.rc5
+  source_code_uri: https://github.com/spree/spree/tree/v4.2.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -323,9 +324,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.4
 signing_key: