spree_api 5.1.0.beta3 → 5.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 372516f7b98eecd75dbb03724a3bc7472b9d09745502f5cf8980aff4bf511847
-  data.tar.gz: 0e0f426db7f21e2efdec616e922e63efc5da81867117e64020be18ec5933b900
+  metadata.gz: a0f927e718e33bb6fd02e6700486268417da7fa69705112444a289cd2e0f6c02
+  data.tar.gz: 8882e1d01b9a4d13c2f53a7f59a965d9a82de59cc7b81d299c51e36d7f7e2a82
 SHA512:
-  metadata.gz: e775c684859f3dde910518f1acd5ed7545215c2ee8ad5562a1085197c1a9c1ab064875fc4fe9827d56881622523be8f93d467a1c4d97d8ee315dd6efa8b80560
-  data.tar.gz: 270e2536eef094252293a2888e75347e15446e6c405261cd6b8c57d3d24712e8361d9ce99a7d50622a9af8d384cf02bb0f29fcdd23ca19f7eff7ba02ecf4cd91
+  metadata.gz: a2cd84be93d0300cd3cb45a0093c70e373d725c7ada5bf9772931321b5c5a9e7b347fb29109e9d78d3a3f5ee5ade0e507e624695ddd5382a9b3e8a1a3fa20634
+  data.tar.gz: 7be8feeea237ce2247fa9ecb02a629342fb802a3351ec703f0b376aed4b729d63eba16a939ad6eebc62a7e5ab2bb96d4b5bcfd7dd03dc3e0cb30f08eb9ef1e64

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')
 

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

@@ -0,0 +1,19 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class GiftCardsController < ResourceController
+          private
+
+          def model_class
+            Spree::GiftCard
+          end
+
+          def permitted_resource_params
+            params.require(:gift_card).permit(permitted_gift_card_attributes)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -25,6 +25,11 @@ module Spree
           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

data/app/serializers/spree/api/v2/platform/gift_card_serializer.rb

@@ -0,0 +1,17 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class GiftCardSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          set_type :gift_card
+
+          belongs_to :user
+
+          has_many :orders
+        end
+      end
+    end
+  end
+end

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

@@ -58,6 +58,7 @@ module Spree
                    id_method_name: :ship_address_id,
                    serializer: :address,
                    record_type: :address
+        belongs_to :gift_card, serializer: :gift_card
       end
     end
   end

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

@@ -0,0 +1,14 @@
+module Spree
+  module V2
+    module Storefront
+      class GiftCardSerializer < BaseSerializer
+        set_type   :gift_card
+
+        attributes :amount, :amount_used, :amount_remaining, :display_amount, :display_amount_used,
+                   :display_amount_remaining, :expires_at
+
+        attribute :code, &:display_code
+      end
+    end
+  end
+end

data/config/locales/en.yml

@@ -29,6 +29,9 @@ en:
         digitals:
           missing_file: 'Missing Digital Item: attachment'
           unauthorized: Error, you are not authorized to access this asset
+        gift_card:
+          amount_not_valid: Gift card amount is not valid
+          not_found: Gift card is not found
         metadata:
           invalid_params: Public and private metadata parameters should be objects
         wishlist:

data/config/routes.rb

@@ -205,6 +205,9 @@ Spree::Core::Engine.add_routes do
           resources :events, only: :index
           resources :subscribers
         end
+
+        # Gift Cards API
+        resources :gift_cards
       end
 
       namespace :data_feeds do

data/lib/spree/api/dependencies.rb

@@ -32,6 +32,10 @@ module Spree
         storefront_checkout_get_shipping_rates_service: -> { Spree::Dependencies.checkout_get_shipping_rates_service },
         storefront_checkout_select_shipping_method_service: -> { Spree::Dependencies.checkout_select_shipping_method_service },
 
+        # gift cards
+        storefront_gift_card_apply_service: -> { Spree::Dependencies.gift_card_apply_service },
+        storefront_gift_card_remove_service: -> { Spree::Dependencies.gift_card_remove_service },
+
         # account services
         storefront_account_create_service: -> { Spree::Dependencies.account_create_service },
         storefront_account_update_service: -> { Spree::Dependencies.account_update_service },

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.rc1
 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-07-02 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.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.0.beta3
+        version: 5.1.0.rc1
 description: Spree's API
 email:
 - hello@spreecommerce.org
@@ -137,6 +137,7 @@ files:
 - app/controllers/spree/api/v2/platform/data_feeds_controller.rb
 - app/controllers/spree/api/v2/platform/digital_links_controller.rb
 - app/controllers/spree/api/v2/platform/digitals_controller.rb
+- app/controllers/spree/api/v2/platform/gift_cards_controller.rb
 - app/controllers/spree/api/v2/platform/line_items_controller.rb
 - app/controllers/spree/api/v2/platform/option_types_controller.rb
 - app/controllers/spree/api/v2/platform/option_values_controller.rb
@@ -225,6 +226,7 @@ files:
 - app/serializers/spree/api/v2/platform/data_feed_serializer.rb
 - app/serializers/spree/api/v2/platform/digital_link_serializer.rb
 - app/serializers/spree/api/v2/platform/digital_serializer.rb
+- app/serializers/spree/api/v2/platform/gift_card_serializer.rb
 - app/serializers/spree/api/v2/platform/image_serializer.rb
 - app/serializers/spree/api/v2/platform/inventory_unit_serializer.rb
 - app/serializers/spree/api/v2/platform/line_item_serializer.rb
@@ -291,6 +293,7 @@ files:
 - app/serializers/spree/v2/storefront/credit_card_serializer.rb
 - app/serializers/spree/v2/storefront/digital_link_serializer.rb
 - app/serializers/spree/v2/storefront/estimated_shipping_rate_serializer.rb
+- app/serializers/spree/v2/storefront/gift_card_serializer.rb
 - app/serializers/spree/v2/storefront/image_serializer.rb
 - app/serializers/spree/v2/storefront/line_item_serializer.rb
 - app/serializers/spree/v2/storefront/option_type_serializer.rb
@@ -364,9 +367,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.rc1
   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.rc1
 post_install_message:
 rdoc_options: []
 require_paths: