spree_api 4.8.2 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 437cd4040d68c215b0d7b4bbacf8d644194612ecb48dbfff28025a2b23a4964d
-  data.tar.gz: 38bf56eb5b017b3609af38c2a693cec04e565efd3f7b578024b733f2e816f0dd
+  metadata.gz: 012d9b5279e5919cc152eba9678ca8682c1baca7b9256ff22c491db95d74de5a
+  data.tar.gz: 56e0fdb4db5ea020e7086b91fa3c401ea76527ea0b5408ca734e9a0abf72502b
 SHA512:
-  metadata.gz: bed0142de5d7f3223ffd61cbe35ceaa7ca723a41cc95316a4e66842b001cb51ee4f5b781efd036d7184088707bb7d48450cb8d24f9557a6826f0432ae695cfde
-  data.tar.gz: faa02fd9dead640e48efdd98ab23a1c823c7d54d6ee285ba438476aef055a0646f2cade959741b53b46d371ddd374ee5857bcfa99522d6c2f4132592d81de686
+  metadata.gz: 8f9d2e9805651277ad363af26e8a97a10e89899336083e5b8f511d63bd99be127ab41b11c0c699fb42492c4d1f490a540273aaa6ec33ee9abcb221a36149b2e8
+  data.tar.gz: 8050de3c76e4d358a4d0198d87ea27e91ca2bc373ce8dfa61795207334b25e19751a7a1414bb17a3421c38037ae2ad51424e7a98506107c299f53acba8723ffa

data/app/controllers/concerns/spree/api/v2/caching.rb

@@ -5,22 +5,22 @@ module Spree
         extend ActiveSupport::Concern
 
         def collection_cache_key(collection)
-          ids_and_timestamps = collection.unscope(:includes).unscope(:order).pluck(:id, :updated_at)
+          # Calling reselect('*') is a workaround for the joined translations table
+          collection_cache_key = collection.unscope(:includes).unscope(:order).unscope(:group).reselect('*').cache_key_with_version
 
-          ids = ids_and_timestamps.map(&:first)
-          max_updated_at = ids_and_timestamps.map(&:last).max
+          params.delete(:page) if params[:page] == 1
 
           cache_key_parts = [
-            self.class.to_s,
-            max_updated_at,
-            ids,
+            collection_cache_key,
             resource_includes,
             sparse_fields,
-            serializer_params,
+            serializer_params_cache_key,
             params[:sort]&.strip,
             params[:page]&.to_s&.strip,
             params[:per_page]&.to_s&.strip,
-          ].flatten.join('-')
+          ]
+          cache_key_parts += additional_cache_key_parts if defined?(additional_cache_key_parts)
+          cache_key_parts = cache_key_parts.flatten.join('-')
 
           Digest::MD5.hexdigest(cache_key_parts)
         end
@@ -31,6 +31,12 @@ module Spree
             expires_in: Spree::Api::Config[:api_v2_collection_cache_ttl],
           }
         end
+
+        def serializer_params_cache_key
+          serializer_params.values.map do |param|
+            param.try(:cache_key) || param.try(:flatten).try(:join, '-') || param.try(:to_s)
+          end.compact.join('-')
+        end
       end
     end
   end

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

@@ -9,7 +9,7 @@ module Spree
             if result.success?
               render_serialized_payload { serialized_current_order }
             else
-              render_error_payload(result.error)
+              render_error_payload(result.error&.value || result.value)
             end
           end
 
@@ -18,7 +18,7 @@ module Spree
           end
 
           def order_token
-            request.headers['X-Spree-Order-Token'] || params[:order_token]
+            request.headers['X-Vendo-Order-Token'] || request.headers['X-Spree-Order-Token'] || params[:order_token]
           end
 
           def spree_current_order

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

@@ -142,11 +142,15 @@ module Spree
           }
         end
 
-        def record_not_found
+        def record_not_found(exception)
+          result = error_handler.call(exception: exception, opts: { user: spree_current_user })
+
           render_error_payload(I18n.t(:resource_not_found, scope: 'spree.api'), 404)
         end
 
         def access_denied(exception)
+          result = error_handler.call(exception: exception, opts: { user: spree_current_user })
+
           render_error_payload(exception.message, 403)
         end
 
@@ -155,6 +159,8 @@ module Spree
         end
 
         def gateway_error(exception)
+          result = error_handler.call(exception: exception, opts: { user: spree_current_user })
+
           render_error_payload(exception.message)
         end
 

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

@@ -16,7 +16,14 @@ module Spree
           end
 
           def resource
-            @resource ||= find_with_fallback_default_locale { scope.find_by(slug: params[:id]) } || scope.find(params[:id])
+            # fixed N+1 queries issue
+            variant_includes = [
+              :prices,
+              { option_values: [:option_type] }
+            ]
+
+            # using FriendlyId so old slugs still work
+            @resource ||= find_with_fallback_default_locale { scope.includes(variants: variant_includes, master: variant_includes).friendly.find(params[:id]) } || scope.includes(variants: variant_includes, master: variant_includes).friendly.find(params[:id])
           end
 
           def collection_sorter

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

@@ -0,0 +1,41 @@
+module Spree
+  module Api
+    module V2
+      module Storefront
+        class VariantsController < ::Spree::Api::V2::ResourceController
+          private
+
+          def model_class
+            Spree::Variant
+          end
+
+          def scope
+            product_scope = Spree::Product.for_store(current_store)
+            product_scope = product_scope.accessible_by(current_ability, :show)
+            product_scope = product_scope.i18n if model_class.include?(TranslatableResource)
+
+            product = product_scope.friendly.find(params[:id])
+            product.variants_including_master
+          end
+
+          def collection_finder
+            Spree::Api::Dependencies.storefront_variant_finder.constantize
+          end
+
+          def collection_serializer
+            Spree::Api::Dependencies.storefront_variant_serializer.constantize
+          end
+
+          def scope_includes
+            variant_includes = {
+              prices: [],
+              option_values: :option_type,
+            }
+            variant_includes[:images] = [] if params[:include]&.match(/images/)
+            variant_includes
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -100,6 +100,41 @@ module Spree
             end
           end
 
+          def add_items
+            spree_authorize! :create, Spree::WishedItem
+
+            @wished_items = resource.wished_items
+            ApplicationRecord.transaction do
+              wished_items_attributes.each do |wished_item_attributes|
+                wished_item = @wished_items.find_by(variant_id: wished_item_attributes[:variant_id])
+
+                if wished_item
+                  wished_item.update!(quantity: wished_item_attributes[:quantity] || 1)
+                else
+                  Spree::WishedItem.create!(wished_item_attributes.merge(wishlist: resource))
+                end
+              end
+            end
+
+            resource.reload
+            render_serialized_payload { serialize_resource(resource) }
+          rescue ActiveRecord::RecordInvalid => e
+            render json: { error: e.record.errors.full_messages.to_sentence }, status: 422
+          end
+
+          def remove_items
+            spree_authorize! :destroy, Spree::WishedItem
+
+            ApplicationRecord.transaction do
+              resource.wished_items.where(id: wished_items_ids).each(&:destroy!)
+            end
+
+            resource.reload
+            render_serialized_payload { serialize_resource(resource) }
+          rescue ActiveRecord::RecordNotDestroyed => e
+            render json: { error: e.record.errors.full_messages.to_sentence }, status: 422
+          end
+
           private
 
           def scope(skip_cancancan: true)
@@ -164,6 +199,14 @@ module Spree
                                   1
                                 end
           end
+
+          def wished_items_attributes
+            params.permit(wished_items: permitted_wished_item_attributes).require(:wished_items)
+          end
+
+          def wished_items_ids
+            params.require(:wished_items_ids)
+          end
         end
       end
     end

data/app/models/concerns/spree/webhooks/has_webhooks.rb

@@ -10,13 +10,15 @@ module Spree
 
         def queue_webhooks_requests!(event_name)
           return if disable_spree_webhooks?
-          return if Spree::Webhooks::Subscriber.none?
-          return if Spree::Webhooks::Subscriber.active.with_urls_for(event_name).none?
+          return if no_webhooks_subscribers?(event_name)
           return if update_event?(event_name) && updating_only_ignored_attributes?
           return if webhook_payload_body.blank?
 
           Spree::Webhooks::Subscribers::QueueRequests.call(
-            event_name: event_name, webhook_payload_body: webhook_payload_body, **webhooks_request_options
+            record: self,
+            event_name: event_name,
+            webhook_payload_body: webhook_payload_body,
+            **webhooks_request_options
           )
         end
 
@@ -43,7 +45,9 @@ module Spree
       end
 
       def included_relationships
-        if resource_serializer.relationships_to_serialize
+        if self.class.respond_to?(:webhook_included_relationships)
+          self.class.webhook_included_relationships
+        elsif resource_serializer.relationships_to_serialize
           resource_serializer.relationships_to_serialize.keys
         else
           []
@@ -74,7 +78,11 @@ module Spree
       end
 
       def disable_spree_webhooks?
-        ENV['DISABLE_SPREE_WEBHOOKS'] == 'true'
+        Spree::Webhooks.disabled?
+      end
+
+      def no_webhooks_subscribers?(event_name)
+        !Spree::Webhooks::Subscriber.active.with_urls_for(event_name).exists?
       end
 
       def webhooks_request_options

data/app/models/spree/oauth_application.rb

@@ -6,6 +6,13 @@ module Spree
 
     before_validation :set_blank_for_redirect_uri
 
+    # returns the last someone used this application
+    #
+    # @return [DateTime]
+    def last_used_at
+      access_tokens.order(:created_at).last&.created_at
+    end
+
     private
 
     def set_blank_for_redirect_uri

data/app/models/spree/order/webhooks.rb

@@ -0,0 +1,39 @@
+module Spree
+  class Order < Spree::Base
+    module Webhooks
+      extend ActiveSupport::Concern
+      include Spree::Webhooks::HasWebhooks
+
+      included do
+        after_update_commit :queue_webhooks_requests_for_order_resumed!
+      end
+
+      class_methods do
+        def custom_webhook_events
+          %w[order.canceled order.placed order.resumed order.shipped]
+        end
+      end
+
+      def send_order_canceled_webhook
+        queue_webhooks_requests!('order.canceled')
+      end
+
+      def send_order_placed_webhook
+        queue_webhooks_requests!('order.placed')
+      end
+
+      def send_order_resumed_webhook
+        queue_webhooks_requests!('order.resumed')
+        self.state_machine_resumed = false # to not fire the same webhook twice
+      end
+
+      def queue_webhooks_requests_for_order_resumed!
+        return if state_machine_resumed?
+        return unless state_previously_changed?
+        return unless state_previous_change&.last == 'resumed'
+
+        send_order_resumed_webhook
+      end
+    end
+  end
+end

data/app/models/spree/payment/webhooks.rb

@@ -0,0 +1,23 @@
+module Spree
+  class Payment < Spree::Base
+    module Webhooks
+      extend ActiveSupport::Concern
+      include Spree::Webhooks::HasWebhooks
+
+      class_methods do
+        def custom_webhook_events
+          %w[payment.paid payment.voided]
+        end
+      end
+
+      def send_payment_voided_webhook
+        queue_webhooks_requests!('payment.voided')
+      end
+
+      def send_payment_completed_webhook
+        queue_webhooks_requests!('payment.paid')
+        order.queue_webhooks_requests!('order.paid') if order.paid?
+      end
+    end
+  end
+end

data/app/models/spree/product/webhooks.rb

@@ -0,0 +1,42 @@
+module Spree
+  class Product < Spree::Base
+    module Webhooks
+      extend ActiveSupport::Concern
+      include Spree::Webhooks::HasWebhooks
+
+      included do
+        after_update_commit :queue_webhooks_requests_for_product_discontinued!
+      end
+
+      class_methods do
+        def custom_webhook_events
+          %w[product.back_in_stock product.backorderable product.discontinued
+             product.out_of_stock product.activated product.archived product.drafted]
+        end
+
+        def ignored_attributes_for_update_webhook_event
+          %w[status]
+        end
+      end
+
+      def send_product_activated_webhook
+        queue_webhooks_requests!('product.activated')
+      end
+
+      def send_product_archived_webhook
+        queue_webhooks_requests!('product.archived')
+      end
+
+      def send_product_drafted_webhook
+        queue_webhooks_requests!('product.drafted')
+      end
+
+      def queue_webhooks_requests_for_product_discontinued!
+        return unless discontinue_on_previously_changed?
+        return if (change = discontinue_on_previous_change).blank? || change.last.blank?
+
+        queue_webhooks_requests!('product.discontinued')
+      end
+    end
+  end
+end

data/app/models/spree/shipment/webhooks.rb

@@ -0,0 +1,19 @@
+module Spree
+  class Shipment < Spree::Base
+    module Webhooks
+      extend ActiveSupport::Concern
+      include Spree::Webhooks::HasWebhooks
+
+      class_methods do
+        def custom_webhook_events
+          %w[shipment.shipped]
+        end
+      end
+
+      def send_shipment_shipped_webhook
+        queue_webhooks_requests!('shipment.shipped')
+        order.queue_webhooks_requests!('order.shipped') if order.fully_shipped?
+      end
+    end
+  end
+end

data/app/models/spree/stock_item/webhooks.rb

@@ -0,0 +1,40 @@
+module Spree
+  class StockItem < Spree::Base
+    module Webhooks
+      extend ActiveSupport::Concern
+      include Spree::Webhooks::HasWebhooks
+
+      included do
+        around_save :queue_webhooks_requests_for_variant_backorderable!
+        around_save :queue_webhooks_requests_for_product_backorderable!
+      end
+
+      def queue_webhooks_requests_for_variant_backorderable!
+        was_out_of_stock = !variant.in_stock_or_backorderable?
+        was_not_backorderable = !variant_backorderable?
+        yield
+        if was_out_of_stock && was_not_backorderable && variant_backorderable?
+          reload
+          variant.queue_webhooks_requests!('variant.backorderable')
+        end
+      end
+
+      def queue_webhooks_requests_for_product_backorderable!
+        product_was_out_of_stock = !product.any_variant_in_stock_or_backorderable?
+        product_was_not_backorderable = !product_backorderable?
+        yield
+        if product_was_out_of_stock && product_was_not_backorderable && product_backorderable?
+          variant.product.queue_webhooks_requests!('product.backorderable')
+        end
+      end
+
+      def product_backorderable?
+        Spree::StockItem.exists?(backorderable: true, variant_id: variant.product.variants.ids)
+      end
+
+      def variant_backorderable?
+        variant.stock_items.exists?(backorderable: true)
+      end
+    end
+  end
+end

data/app/models/spree/stock_movement/webhooks.rb

@@ -0,0 +1,49 @@
+module Spree
+  class StockMovement < Spree::Base
+    module Webhooks
+      extend ActiveSupport::Concern
+      include Spree::Webhooks::HasWebhooks
+
+      included do
+        around_save :queue_webhooks_requests_for_variant_out_of_stock!
+        around_save :queue_webhooks_requests_for_variant_back_in_stock!
+        around_save :queue_webhooks_requests_for_product_out_of_stock!
+        around_save :queue_webhooks_requests_for_product_back_in_stock!
+      end
+
+      def queue_webhooks_requests_for_variant_out_of_stock!
+        variant_in_stock_before_update = variant.in_stock_or_backorderable?
+        yield
+        if variant_in_stock_before_update && !variant.in_stock_or_backorderable?
+          reload
+          stock_item.variant.queue_webhooks_requests!('variant.out_of_stock')
+        end
+      end
+
+      def queue_webhooks_requests_for_variant_back_in_stock!
+        variant_was_out_of_stock = !variant.in_stock_or_backorderable?
+        yield
+        if variant_was_out_of_stock && variant.in_stock_or_backorderable?
+          reload
+          variant.queue_webhooks_requests!('variant.back_in_stock')
+        end
+      end
+
+      def queue_webhooks_requests_for_product_back_in_stock!
+        product_was_out_of_stock = !product.any_variant_in_stock_or_backorderable?
+        yield
+        if product_was_out_of_stock && product.any_variant_in_stock_or_backorderable?
+          product.queue_webhooks_requests!('product.back_in_stock')
+        end
+      end
+
+      def queue_webhooks_requests_for_product_out_of_stock!
+        product_was_in_stock = product.any_variant_in_stock_or_backorderable?
+        yield
+        if product_was_in_stock && !product.any_variant_in_stock_or_backorderable?
+          product.queue_webhooks_requests!('product.out_of_stock')
+        end
+      end
+    end
+  end
+end

data/app/models/spree/variant/webhooks.rb

@@ -0,0 +1,25 @@
+module Spree
+  class Variant < Spree::Base
+    module Webhooks
+      extend ActiveSupport::Concern
+      include Spree::Webhooks::HasWebhooks
+
+      included do
+        after_update_commit :queue_webhooks_requests_for_variant_discontinued!
+      end
+
+      class_methods do
+        def custom_webhook_events
+          %w[variant.back_in_stock variant.backorderable variant.discontinued variant.out_of_stock]
+        end
+      end
+
+      def queue_webhooks_requests_for_variant_discontinued!
+        return unless discontinue_on_previously_changed?
+        return if (change = discontinue_on_previous_change).blank? || change.last.blank?
+
+        queue_webhooks_requests!('variant.discontinued')
+      end
+    end
+  end
+end

data/app/models/spree/webhooks/subscriber.rb

@@ -25,6 +25,10 @@ module Spree
 
       before_save :parse_subscriptions
 
+      def latest_event_at
+        events.order(:created_at).last&.created_at
+      end
+      
       def self.with_urls_for(event)
         where(
           case ActiveRecord::Base.connection.adapter_name

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

@@ -0,0 +1,11 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class AdminUserSerializer < UserSerializer
+          set_type :admin_user
+        end
+      end
+    end
+  end
+end

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

@@ -5,6 +5,7 @@ module Spree
         class RefundSerializer < BaseSerializer
           include ResourceSerializerConcern
 
+          belongs_to :refunder, serializer: Dependencies.platform_admin_user_serializer.constantize
           belongs_to :payment
           belongs_to :reimbursement
           belongs_to :refund_reason, object_method_name: :reason

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

@@ -6,7 +6,7 @@ module Spree
           include ResourceSerializerConcern
 
           belongs_to :user
-          belongs_to :created_by, serializer: :user, type: :user
+          belongs_to :created_by, serializer: Dependencies.platform_admin_user_serializer.constantize
           belongs_to :store_credit_category, object_method_name: :category, id_method_name: :category_id
           belongs_to :store_credit_type, object_method_name: :credit_type, id_method_name: :type_id
 

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

@@ -0,0 +1,10 @@
+module Spree
+  module V2
+    module Storefront
+      class ShippingCategorySerializer < BaseSerializer
+        set_type  :shipping_category
+        attribute :name
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Spree
+  module V2
+    module Storefront
+      class ShippingMethodSerializer < BaseSerializer
+        set_type   :shipping_method
+        attributes :name, :public_metadata
+      end
+    end
+  end
+end

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

@@ -32,6 +32,7 @@ module Spree
       def report_error(exception:, message:, opts:)
         # overwrite this method in your application to support different error handlers
         # eg. Sentry, Rollbar, etc
+        Sentry.capture_exception(exception) if defined?(Sentry)
 
         success(exception: exception, message: message)
       end

data/app/services/spree/webhooks/subscribers/handle_request.rb

@@ -19,7 +19,7 @@ module Spree
           end
           return process(:warn, msg("failed for '#{url}'")) if request.failed_request?
 
-          process(:debug, msg("success for URL '#{url}'"))
+          process
         end
 
         private
@@ -30,8 +30,8 @@ module Spree
         delegate :id, :url, to: :subscriber
         delegate :created_at, :id, to: :event, prefix: true
 
-        def process(log_level, msg)
-          Rails.logger.public_send(log_level, msg)
+        def process(log_level = nil, msg = nil)
+          Rails.logger.public_send(log_level, msg) if msg.present? && log_level.present?
           make_request
           update_event(msg)
           nil
@@ -59,7 +59,7 @@ module Spree
           )
         end
 
-        def update_event(msg)
+        def update_event(msg = nil)
           event.update(
             execution_time: execution_time,
             request_errors: msg,

data/app/services/spree/webhooks/subscribers/make_request.rb

@@ -45,7 +45,7 @@ module Spree
         def http
           http = Net::HTTP.new(uri_host, uri_port)
           http.read_timeout = webhooks_timeout.to_i if custom_read_timeout?
-          http.use_ssl = true if use_ssl?
+          http.use_ssl = use_ssl?
           http
         end
 
@@ -71,7 +71,7 @@ module Spree
         end
 
         def use_ssl?
-          !(Rails.env.development? || Rails.env.test?)
+          uri.scheme == 'https'
         end
 
         def uri

data/app/services/spree/webhooks/subscribers/queue_requests.rb

@@ -4,8 +4,8 @@ module Spree
       class QueueRequests
         prepend Spree::ServiceModule::Base
 
-        def call(event_name:, webhook_payload_body:, **options)
-          filtered_subscribers(event_name, webhook_payload_body, options).each do |subscriber|
+        def call(event_name:, webhook_payload_body:, record: nil, **options)
+          filtered_subscribers(event_name, webhook_payload_body, record, options).each do |subscriber|
             Spree::Webhooks::Subscribers::MakeRequestJob.perform_later(
               webhook_payload_body, event_name, subscriber
             )
@@ -14,7 +14,7 @@ module Spree
 
         private
 
-        def filtered_subscribers(event_name, _, _)
+        def filtered_subscribers(event_name, webhook_payload_body, record, options)
           Spree::Webhooks::Subscriber.active.with_urls_for(event_name)
         end
       end

data/config/initializers/doorkeeper.rb

@@ -45,4 +45,6 @@ Doorkeeper.configure do
   # using Bcrupt for token secrets is currently not supported by Doorkeeper
   hash_token_secrets fallback: :plain
   hash_application_secrets fallback: :plain, using: '::Doorkeeper::SecretStoring::BCrypt'
+
+  access_token_expires_in 1.month
 end

data/config/routes.rb

@@ -14,7 +14,7 @@ Spree::Core::Engine.add_routes do
           delete 'remove_line_item/:line_item_id', to: 'cart#remove_line_item', as: :cart_remove_line_item
           patch  :set_quantity
           patch  :apply_coupon_code
-          delete 'remove_coupon_code/:coupon_code', to: 'cart#remove_coupon_code', as: :cart_remove_coupon_code
+          delete 'remove_coupon_code/:coupon_code', to: 'cart#remove_coupon_code', as: :cart_remove_coupon_code, constraints: { coupon_code: /[^\/]+/ }
           delete 'remove_coupon_code', to: 'cart#remove_coupon_code', as: :cart_remove_coupon_code_without_code
           get :estimate_shipping_rates
           patch :associate
@@ -45,6 +45,7 @@ Spree::Core::Engine.add_routes do
         get '/countries/:iso', to: 'countries#show', as: :country
         get '/order_status/:number', to: 'order_status#show', as: :order_status
         resources :products, only: %i[index show]
+        get '/products/:id/variants', to: 'variants#index', as: :product_variants
         resources :taxons,   only: %i[index show], id: /.+/
         get '/stores/:code', to: 'stores#show', as: :store
         get '/store', to: 'stores#current', as: :current_store
@@ -59,6 +60,8 @@ Spree::Core::Engine.add_routes do
             post :add_item
             patch 'set_item_quantity/:item_id', to: 'wishlists#set_item_quantity', as: :set_item_quantity
             delete 'remove_item/:item_id', to: 'wishlists#remove_item', as: :remove_item
+            post :add_items
+            delete :remove_items
           end
         end
 

data/lib/spree/api/configuration.rb

@@ -1,6 +1,8 @@
+require 'spree/core/preferences/runtime_configuration'
+
 module Spree
   module Api
-    class Configuration < Preferences::Configuration
+    class Configuration < Spree::Preferences::RuntimeConfiguration
       preference :api_v2_serializers_cache_ttl, :integer, default: 3600 # 1 hour in seconds
       preference :api_v2_collection_cache_ttl, :integer, default: 3600 # 1 hour in seconds
       preference :api_v2_collection_cache_namespace, :string, default: 'api_v2_collection_cache'

data/lib/spree/api/dependencies.rb

@@ -1,3 +1,5 @@
+require 'spree/core/dependencies_helper'
+
 module Spree
   module Api
     class ApiDependencies
@@ -60,6 +62,7 @@ module Spree
         storefront_estimated_shipment_serializer: 'Spree::V2::Storefront::EstimatedShippingRateSerializer',
         storefront_store_serializer: 'Spree::V2::Storefront::StoreSerializer',
         storefront_order_serializer: 'Spree::V2::Storefront::OrderSerializer',
+        storefront_variant_serializer: 'Spree::V2::Storefront::VariantSerializer',
 
         # sorters
         storefront_collection_sorter: -> { Spree::Dependencies.collection_sorter },
@@ -81,11 +84,12 @@ 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 },
+        storefront_variant_finder: -> { Spree::Dependencies.variant_finder },
 
         error_handler: 'Spree::Api::ErrorHandler',
 
         # serializers
-        platform_admin_user_serializer: 'Spree::Api::V2::Platform::UserSerializer',
+        platform_admin_user_serializer: 'Spree::Api::V2::Platform::AdminUserSerializer',
 
         # coupon code handler
         platform_coupon_handler: -> { Spree::Dependencies.coupon_handler },

data/lib/spree/api/engine.rb

@@ -18,17 +18,9 @@ module Spree
         Migrations.new(config, engine_name).check
       end
 
-      def self.activate
-        Dir.glob(File.join(File.dirname(__FILE__), '../../../app/models/spree/api/webhooks/*_decorator*.rb')) do |c|
-          Rails.application.config.cache_classes ? require(c) : load(c)
-        end
-      end
-
       def self.root
         @root ||= Pathname.new(File.expand_path('../../..', __dir__))
       end
-
-      config.to_prepare &method(:activate).to_proc
     end
   end
 end

data/lib/spree/api/testing_support/matchers/webhooks.rb

@@ -26,7 +26,7 @@
 # isn't added to the matcher definition, because it acts in a different
 # way depending on what's the resource being tested.
 #
-RSpec::Matchers.define :emit_webhook_event do |event_to_emit|
+RSpec::Matchers.define :emit_webhook_event do |event_to_emit, record = nil|
   match do |block|
     queue_requests = instance_double(Spree::Webhooks::Subscribers::QueueRequests)
 
@@ -36,7 +36,7 @@ RSpec::Matchers.define :emit_webhook_event do |event_to_emit|
     with_webhooks_enabled { Timecop.freeze { block.call } }
 
     expect(queue_requests).to(
-      have_received(:call).with(event_name: event_to_emit, webhook_payload_body: webhook_payload_body.to_json).once
+      have_received(:call).with(event_name: event_to_emit, webhook_payload_body: webhook_payload_body.to_json, record: record).once
     )
   end
 
@@ -61,7 +61,7 @@ RSpec::Matchers.define :emit_webhook_event do |event_to_emit|
 end
 
 def with_webhooks_enabled
-  ENV['DISABLE_SPREE_WEBHOOKS'] = nil
+  Spree::Webhooks.disabled = false
   yield
-  ENV['DISABLE_SPREE_WEBHOOKS'] = 'true'
+  Spree::Webhooks.disabled = true
 end

data/lib/spree/api/testing_support/spree_webhooks.rb

@@ -1,9 +1,9 @@
 RSpec.configure do |config|
   config.before(:each, :spree_webhooks) do
-    ENV['DISABLE_SPREE_WEBHOOKS'] = nil
+    Spree::Webhooks.disabled = false
   end
 
   config.after(:each, :spree_webhooks) do
-    ENV['DISABLE_SPREE_WEBHOOKS'] = 'true'
+    Spree::Webhooks.disabled = true
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 4.8.2
+  version: 4.9.0
 platform: ruby
 authors:
 - Ryan Bigg
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
+date: 2024-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n-tasks
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.8.2
+        version: 4.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.8.2
+        version: 4.9.0
 description: Spree's API
 email:
 - ryan@spreecommerce.com
@@ -203,6 +203,7 @@ files:
 - app/controllers/spree/api/v2/storefront/products_controller.rb
 - app/controllers/spree/api/v2/storefront/stores_controller.rb
 - app/controllers/spree/api/v2/storefront/taxons_controller.rb
+- app/controllers/spree/api/v2/storefront/variants_controller.rb
 - app/controllers/spree/api/v2/storefront/wishlists_controller.rb
 - app/helpers/spree/api/v2/collection_options_helpers.rb
 - app/helpers/spree/api/v2/display_money_helper.rb
@@ -211,16 +212,16 @@ files:
 - app/models/concerns/spree/user_api_authentication.rb
 - app/models/concerns/spree/user_api_methods.rb
 - app/models/concerns/spree/webhooks/has_webhooks.rb
-- app/models/spree/api/webhooks/order_decorator.rb
-- app/models/spree/api/webhooks/payment_decorator.rb
-- app/models/spree/api/webhooks/product_decorator.rb
-- app/models/spree/api/webhooks/shipment_decorator.rb
-- app/models/spree/api/webhooks/stock_item_decorator.rb
-- app/models/spree/api/webhooks/stock_movement_decorator.rb
-- app/models/spree/api/webhooks/variant_decorator.rb
 - app/models/spree/oauth_access_grant.rb
 - app/models/spree/oauth_access_token.rb
 - app/models/spree/oauth_application.rb
+- app/models/spree/order/webhooks.rb
+- app/models/spree/payment/webhooks.rb
+- app/models/spree/product/webhooks.rb
+- app/models/spree/shipment/webhooks.rb
+- app/models/spree/stock_item/webhooks.rb
+- app/models/spree/stock_movement/webhooks.rb
+- app/models/spree/variant/webhooks.rb
 - app/models/spree/webhooks/base.rb
 - app/models/spree/webhooks/event.rb
 - app/models/spree/webhooks/event_signature.rb
@@ -232,6 +233,7 @@ files:
 - app/serializers/spree/api/v2/base_serializer.rb
 - app/serializers/spree/api/v2/platform/address_serializer.rb
 - app/serializers/spree/api/v2/platform/adjustment_serializer.rb
+- app/serializers/spree/api/v2/platform/admin_user_serializer.rb
 - app/serializers/spree/api/v2/platform/asset_serializer.rb
 - app/serializers/spree/api/v2/platform/base_serializer.rb
 - app/serializers/spree/api/v2/platform/calculator_serializer.rb
@@ -337,6 +339,8 @@ files:
 - app/serializers/spree/v2/storefront/product_serializer.rb
 - app/serializers/spree/v2/storefront/promotion_serializer.rb
 - app/serializers/spree/v2/storefront/shipment_serializer.rb
+- app/serializers/spree/v2/storefront/shipping_category_serializer.rb
+- app/serializers/spree/v2/storefront/shipping_method_serializer.rb
 - app/serializers/spree/v2/storefront/shipping_rate_serializer.rb
 - app/serializers/spree/v2/storefront/state_serializer.rb
 - app/serializers/spree/v2/storefront/stock_location_serializer.rb
@@ -402,9 +406,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.8.2
+  changelog_uri: https://github.com/spree/spree/releases/tag/v4.9.0
   documentation_uri: https://docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v4.8.2
+  source_code_uri: https://github.com/spree/spree/tree/v4.9.0
 post_install_message:
 rdoc_options: []
 require_paths:

data/app/models/spree/api/webhooks/order_decorator.rb

@@ -1,43 +0,0 @@
-module Spree
-  module Api
-    module Webhooks
-      module OrderDecorator
-        def self.prepended(base)
-          def base.custom_webhook_events
-            %w[order.canceled order.placed order.resumed order.shipped]
-          end
-
-          base.after_update_commit :queue_webhooks_requests_for_order_resumed!
-        end
-
-        def after_cancel
-          super
-          queue_webhooks_requests!('order.canceled')
-        end
-
-        def finalize!
-          super
-          queue_webhooks_requests!('order.placed')
-        end
-
-        def after_resume
-          super
-          queue_webhooks_requests!('order.resumed')
-          self.state_machine_resumed = false
-        end
-
-        private
-
-        def queue_webhooks_requests_for_order_resumed!
-          return if state_machine_resumed?
-          return unless state_previously_changed?
-          return unless state_previous_change&.last == 'resumed'
-
-          queue_webhooks_requests!('order.resumed')
-        end
-      end
-    end
-  end
-end
-
-Spree::Order.prepend(Spree::Api::Webhooks::OrderDecorator)

data/app/models/spree/api/webhooks/payment_decorator.rb

@@ -1,26 +0,0 @@
-module Spree
-  module Api
-    module Webhooks
-      module PaymentDecorator
-        def self.prepended(base)
-          def base.custom_webhook_events
-            %w[payment.paid payment.voided]
-          end
-        end
-
-        def after_void
-          super
-          queue_webhooks_requests!('payment.voided')
-        end
-
-        def after_completed
-          super
-          queue_webhooks_requests!('payment.paid')
-          order.queue_webhooks_requests!('order.paid') if order.paid?
-        end
-      end
-    end
-  end
-end
-
-Spree::Payment.prepend(Spree::Api::Webhooks::PaymentDecorator)

data/app/models/spree/api/webhooks/product_decorator.rb

@@ -1,46 +0,0 @@
-module Spree
-  module Api
-    module Webhooks
-      module ProductDecorator
-        def self.prepended(base)
-          def base.custom_webhook_events
-            %w[product.back_in_stock product.backorderable product.discontinued
-               product.out_of_stock product.activated product.archived product.drafted]
-          end
-
-          def base.ignored_attributes_for_update_webhook_event
-            %w[status]
-          end
-
-          base.after_update_commit :queue_webhooks_requests_for_product_discontinued!
-        end
-
-        def after_activate
-          super
-          queue_webhooks_requests!('product.activated')
-        end
-
-        def after_archive
-          super
-          queue_webhooks_requests!('product.archived')
-        end
-
-        def after_draft
-          super
-          queue_webhooks_requests!('product.drafted')
-        end
-
-        private
-
-        def queue_webhooks_requests_for_product_discontinued!
-          return unless discontinue_on_previously_changed?
-          return if (change = discontinue_on_previous_change).blank? || change.last.blank?
-
-          queue_webhooks_requests!('product.discontinued')
-        end
-      end
-    end
-  end
-end
-
-Spree::Product.prepend(Spree::Api::Webhooks::ProductDecorator)

data/app/models/spree/api/webhooks/shipment_decorator.rb

@@ -1,21 +0,0 @@
-module Spree
-  module Api
-    module Webhooks
-      module ShipmentDecorator
-        def self.prepended(base)
-          def base.custom_webhook_events
-            %w[shipment.shipped]
-          end
-        end
-
-        def after_ship
-          super
-          queue_webhooks_requests!('shipment.shipped')
-          order.queue_webhooks_requests!('order.shipped') if order.fully_shipped?
-        end
-      end
-    end
-  end
-end
-
-Spree::Shipment.prepend(Spree::Api::Webhooks::ShipmentDecorator)

data/app/models/spree/api/webhooks/stock_item_decorator.rb

@@ -1,43 +0,0 @@
-module Spree
-  module Api
-    module Webhooks
-      module StockItemDecorator
-        def self.prepended(base)
-          base.around_save :queue_webhooks_requests_for_variant_backorderable!
-          base.around_save :queue_webhooks_requests_for_product_backorderable!
-        end
-
-        private
-
-        def queue_webhooks_requests_for_variant_backorderable!
-          was_out_of_stock = !variant.in_stock_or_backorderable?
-          was_not_backorderable = !variant_backorderable?
-          yield
-          if was_out_of_stock && was_not_backorderable && variant_backorderable?
-            reload
-            variant.queue_webhooks_requests!('variant.backorderable')
-          end
-        end
-
-        def queue_webhooks_requests_for_product_backorderable!
-          product_was_out_of_stock = !product.any_variant_in_stock_or_backorderable?
-          product_was_not_backorderable = !product_backorderable?
-          yield
-          if product_was_out_of_stock && product_was_not_backorderable && product_backorderable?
-            variant.product.queue_webhooks_requests!('product.backorderable')
-          end
-        end
-
-        def product_backorderable?
-          Spree::StockItem.exists?(backorderable: true, variant_id: variant.product.variants.ids)
-        end
-
-        def variant_backorderable?
-          variant.stock_items.exists?(backorderable: true)
-        end
-      end
-    end
-  end
-end
-
-Spree::StockItem.prepend(Spree::Api::Webhooks::StockItemDecorator)

data/app/models/spree/api/webhooks/stock_movement_decorator.rb

@@ -1,52 +0,0 @@
-module Spree
-  module Api
-    module Webhooks
-      module StockMovementDecorator
-        def self.prepended(base)
-          base.around_save :queue_webhooks_requests_for_variant_out_of_stock!
-          base.around_save :queue_webhooks_requests_for_variant_back_in_stock!
-          base.around_save :queue_webhooks_requests_for_product_out_of_stock!
-          base.around_save :queue_webhooks_requests_for_product_back_in_stock!
-        end
-
-        private
-
-        def queue_webhooks_requests_for_variant_out_of_stock!
-          variant_in_stock_before_update = variant.in_stock_or_backorderable?
-          yield
-          if variant_in_stock_before_update && !variant.in_stock_or_backorderable?
-            reload
-            stock_item.variant.queue_webhooks_requests!('variant.out_of_stock')
-          end
-        end
-
-        def queue_webhooks_requests_for_variant_back_in_stock!
-          variant_was_out_of_stock = !variant.in_stock_or_backorderable?
-          yield
-          if variant_was_out_of_stock && variant.in_stock_or_backorderable?
-            reload
-            variant.queue_webhooks_requests!('variant.back_in_stock')
-          end
-        end
-
-        def queue_webhooks_requests_for_product_back_in_stock!
-          product_was_out_of_stock = !product.any_variant_in_stock_or_backorderable?
-          yield
-          if product_was_out_of_stock && product.any_variant_in_stock_or_backorderable?
-            product.queue_webhooks_requests!('product.back_in_stock')
-          end
-        end
-
-        def queue_webhooks_requests_for_product_out_of_stock!
-          product_was_in_stock = product.any_variant_in_stock_or_backorderable?
-          yield
-          if product_was_in_stock && !product.any_variant_in_stock_or_backorderable?
-            product.queue_webhooks_requests!('product.out_of_stock')
-          end
-        end
-      end
-    end
-  end
-end
-
-Spree::StockMovement.prepend(Spree::Api::Webhooks::StockMovementDecorator)

data/app/models/spree/api/webhooks/variant_decorator.rb

@@ -1,26 +0,0 @@
-module Spree
-  module Api
-    module Webhooks
-      module VariantDecorator
-        def self.prepended(base)
-          def base.custom_webhook_events
-            %w[variant.back_in_stock variant.backorderable variant.discontinued variant.out_of_stock]
-          end
-
-          base.after_update_commit :queue_webhooks_requests_for_variant_discontinued!
-        end
-
-        private
-
-        def queue_webhooks_requests_for_variant_discontinued!
-          return unless discontinue_on_previously_changed?
-          return if (change = discontinue_on_previous_change).blank? || change.last.blank?
-
-          queue_webhooks_requests!('variant.discontinued')
-        end
-      end
-    end
-  end
-end
-
-Spree::Variant.prepend(Spree::Api::Webhooks::VariantDecorator)