spree_api 5.1.0.beta3 → 5.1.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 372516f7b98eecd75dbb03724a3bc7472b9d09745502f5cf8980aff4bf511847
-  data.tar.gz: 0e0f426db7f21e2efdec616e922e63efc5da81867117e64020be18ec5933b900
+  metadata.gz: 18576a5979e028efde302e65a1fec8f6695ecbf4d0a93d94c98872614880ca98
+  data.tar.gz: 4625d7f902a5806987ddcc368afeeda68ff41a9bbb1b7813f1287606c49bfccd
 SHA512:
-  metadata.gz: e775c684859f3dde910518f1acd5ed7545215c2ee8ad5562a1085197c1a9c1ab064875fc4fe9827d56881622523be8f93d467a1c4d97d8ee315dd6efa8b80560
-  data.tar.gz: 270e2536eef094252293a2888e75347e15446e6c405261cd6b8c57d3d24712e8361d9ce99a7d50622a9af8d384cf02bb0f29fcdd23ca19f7eff7ba02ecf4cd91
+  metadata.gz: 03bff840b60ec12ec91fed698ac45e5265852aedfbf638a1010ca6f59b9217e625ff010347dabd768b00d27caffd750b942eb6985b5c323562dc7dabe4f7ed1f
+  data.tar.gz: c5970c9e510bf18a09410424a2b10bbf9879e30d8031196df60a503a6d1434f199fb6bbfeae47b30f4d7a3c87bb4c72875542ffbc774d08aef37b0eef113cda1

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

@@ -20,6 +20,8 @@ module Spree
         rescue_from ArgumentError, with: :error_during_processing
         rescue_from ActionDispatch::Http::Parameters::ParseError, with: :error_during_processing
 
+        # Returns the content type for the API
+        # @return [String] The content type, eg 'application/vnd.api+json'
         def content_type
           Spree::Api::Config[:api_v2_content_type]
         end
@@ -42,18 +44,28 @@ module Spree
           ).serializable_hash
         end
 
+        # Returns a paginated collection
+        # @return [Array] The paginated collection
         def paginated_collection
           @paginated_collection ||= collection_paginator.new(sorted_collection, params).call
         end
 
+        # Returns the collection paginator
+        # @return [Class] The collection paginator class, default is Spree::Shared::Paginate
         def collection_paginator
           Spree::Api::Dependencies.storefront_collection_paginator.constantize
         end
 
+        # Renders a serialized payload with the given status code
+        # @param status [Integer] HTTP status code to return, eg 200, 201, 204
+        # @yield [Hash] The serialized data to render
         def render_serialized_payload(status = 200)
           render json: yield, status: status, content_type: content_type
         end
 
+        # Renders a serialized error payload with the given status code
+        # @param status [Integer] HTTP status code to return
+        # @yield [Hash] The serialized data to render
         def render_error_payload(error, status = 422)
           json = if error.is_a?(ActiveModel::Errors)
                    { error: error.full_messages.to_sentence, errors: error.messages }
@@ -66,6 +78,9 @@ module Spree
           render json: json, status: status, content_type: content_type
         end
 
+        # Renders a serialized result payload with the given status code
+        # @param result [Object] The result to render
+        # @param ok_status [Integer] HTTP status code to return if the result is successful, eg 200, 201, 204
         def render_result(result, ok_status = 200)
           if result.success?
             render_serialized_payload(ok_status) { serialize_resource(result.value) }
@@ -74,6 +89,8 @@ module Spree
           end
         end
 
+        # Returns the current Spree user
+        # @return [Spree.user_class] The current Spree user
         def spree_current_user
           return nil unless doorkeeper_token
           return @spree_current_user if defined?(@spree_current_user)
@@ -86,10 +103,17 @@ module Spree
 
         alias try_spree_current_user spree_current_user  # for compatibility with spree_legacy_frontend
 
+        # Authorizes the current Spree user for the given action and subject
+        # @param action [Symbol] The action to authorize
+        # @param subject [Object] The subject to authorize
+        # @param args [Array] Additional arguments to pass to the authorize! method
+        # @return [void]
         def spree_authorize!(action, subject, *args)
           authorize!(action, subject, *args)
         end
 
+        # Raises an AccessDenied error if the current Spree user is nil
+        # @raise [CanCan::AccessDenied] If the current Spree user is nil
         def require_spree_current_user
           raise CanCan::AccessDenied if spree_current_user.nil?
         end
@@ -100,10 +124,13 @@ module Spree
         end
 
         # this method can be extended in extensions or developer applications
+        # @return [Hash] The ability options
         def ability_options
           { store: current_store }
         end
 
+        # Returns the requested includes
+        # @return [Array] The requested includes
         def request_includes
           # if API user wants to receive only the bare-minimum
           # the API will return only the main resource without any included
@@ -114,6 +141,8 @@ module Spree
           end
         end
 
+        # Returns the resource includes, useful to avoid N+1 queries
+        # @return [Array] The resource includes, eg [:images, :variants]
         def resource_includes
           (request_includes || default_resource_includes).map(&:intern)
         end
@@ -127,6 +156,8 @@ module Spree
           []
         end
 
+        # Returns the JSON API sparse fields
+        # @return [Hash] The sparse fields, eg { product: [:name, :description] }
         def sparse_fields
           return unless params[:fields]&.respond_to?(:each)
 
@@ -137,6 +168,9 @@ module Spree
           fields.presence
         end
 
+        # Returns the serializer global params
+        # all of these params are passed down to the serializer
+        # @return [Hash] The serializer params
         def serializer_params
           {
             currency: current_currency,
@@ -149,28 +183,43 @@ module Spree
           }
         end
 
+        # Renders a 404 error payload
+        # @param exception [Exception] The exception to render
+        # @return [void]
         def record_not_found(exception)
           Rails.error.report(exception, context: { user_id: spree_current_user&.id }, source: 'spree.api')
 
           render_error_payload(I18n.t(:resource_not_found, scope: 'spree.api'), 404)
         end
 
+        # Renders a 403 error payload
+        # @param exception [Exception] The exception to render
+        # @return [void]
         def access_denied(exception)
           Rails.error.report(exception, context: { user_id: spree_current_user&.id }, source: 'spree.api')
 
           render_error_payload(exception.message, 403)
         end
 
+        # Renders a 401 error payload
+        # @param exception [Exception] The exception to render
+        # @return [void]
         def access_denied_401(exception)
           render_error_payload(exception.message, 401)
         end
 
+        # Renders a 500 error payload when a payment gateway error occurs
+        # @param exception [Exception] The exception to render
+        # @return [void]
         def gateway_error(exception)
           Rails.error.report(exception, context: { user_id: spree_current_user&.id }, source: 'spree.api')
 
           render_error_payload(exception.message)
         end
 
+        # Renders a 400 error payload when an error occurs during parameter parsing
+        # @param exception [Exception] The exception to render
+        # @return [void]
         def error_during_processing(exception)
           Rails.error.report(exception, context: { user_id: spree_current_user&.id }, source: 'spree.api')
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 5.1.0.beta3
+  version: 5.1.0.beta4
 platform: ruby
 authors:
 - Ryan Bigg
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-29 00:00:00.000000000 Z
+date: 2025-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-rspec
@@ -102,14 +102,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.0.beta3
+        version: 5.1.0.beta4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.0.beta3
+        version: 5.1.0.beta4
 description: Spree's API
 email:
 - hello@spreecommerce.org
@@ -364,9 +364,9 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/spree/spree/issues
-  changelog_uri: https://github.com/spree/spree/releases/tag/v5.1.0.beta3
+  changelog_uri: https://github.com/spree/spree/releases/tag/v5.1.0.beta4
   documentation_uri: https://docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v5.1.0.beta3
+  source_code_uri: https://github.com/spree/spree/tree/v5.1.0.beta4
 post_install_message:
 rdoc_options: []
 require_paths: