spree_api 5.2.5 → 5.3.0.rc1

data/app/subscribers/spree/webhook_event_subscriber.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Spree
+  # Listens to Spree events and queues webhook deliveries for enabled endpoints.
+  #
+  # This subscriber listens to all Spree events and for each event, finds
+  # all enabled webhook endpoints that are subscribed to that event and queues
+  # a delivery job for each one.
+  #
+  # The event payload is passed through directly without transformation.
+  # Events should already be serialized by the EventSerializer.
+  #
+  # @example
+  #   # Webhooks are automatically delivered when events are published
+  #   Spree::Events.publish('order.completed', order: order)
+  #
+  class WebhookEventSubscriber < Spree::Subscriber
+    subscribes_to '*'
+
+    def handle(event)
+      return unless Spree::Api::Config.webhooks_enabled
+      return if event.store_id.blank?
+
+      # Find all active endpoints for this store subscribed to this event
+      endpoints = Spree::WebhookEndpoint.active.where(store_id: event.store_id).select { |endpoint| endpoint.subscribed_to?(event.name) }
+
+      return if endpoints.empty?
+
+      # Queue delivery for each endpoint
+      endpoints.each do |endpoint|
+        queue_delivery(endpoint, event)
+      end
+    rescue StandardError => e
+      Rails.logger.error "[Spree Webhooks] Error processing event: #{e.message}"
+      Rails.error.report(e)
+    end
+
+    private
+
+    def queue_delivery(endpoint, event)
+      # Build base payload (without delivery ID)
+      payload = build_payload(event)
+
+      # Create delivery record
+      delivery = endpoint.webhook_deliveries.create!(
+        event_name: event.name,
+        payload: payload
+      )
+
+      # Queue the delivery job
+      Spree::WebhookDeliveryJob.perform_later(delivery.id, endpoint.secret_key)
+    rescue StandardError => e
+      Rails.logger.error "[Spree Webhooks] Error queuing delivery for endpoint #{endpoint.id}: #{e.message}"
+      Rails.error.report(e)
+    end
+
+    def build_payload(event)
+      {
+        id: event.id,
+        name: event.name,
+        created_at: event.created_at.iso8601,
+        data: event.payload,
+        metadata: event.metadata
+      }
+    end
+  end
+end

data/config/routes.rb

@@ -206,8 +206,6 @@ Spree::Core::Engine.add_routes do
 
         # Webhooks API
         namespace :webhooks do
-          resources :events, only: :index
-          resources :subscribers
         end
 
         # Gift Cards API

data/lib/generators/spree/api/install/install_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        class_option :migrate, type: :boolean, default: true
+
+        def add_migrations
+          run 'bundle exec rake railties:install:migrations FROM=spree_api'
+        end
+
+        def run_migrations
+          run_migrations = options[:migrate] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+          if run_migrations
+            run 'bin/rails db:migrate'
+          else
+            puts 'Skipping rails db:migrate, don\'t forget to run it!'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spree/api/configuration.rb

@@ -8,6 +8,9 @@ module Spree
       preference :api_v2_collection_cache_namespace, :string, default: 'api_v2_collection_cache'
       preference :api_v2_content_type, :string, default: 'application/vnd.api+json'
       preference :api_v2_per_page_limit, :integer, default: 500
+
+      preference :webhooks_enabled, :boolean, default: true
+      preference :webhooks_verify_ssl, :boolean, default: !Rails.env.development?
     end
   end
 end

data/lib/spree/api/dependencies.rb

@@ -101,7 +101,7 @@ module Spree
         storefront_posts_sorter: -> { Spree::Dependencies.posts_sorter },
 
         # paginators
-        storefront_collection_paginator: -> { Spree::Dependencies.collection_paginator },
+        storefront_collection_paginator: 'Spree::Api::Paginate',
 
         # finders
         storefront_address_finder: -> { Spree::Dependencies.address_finder },

data/lib/spree/api/engine.rb

@@ -1,4 +1,5 @@
 require 'rails/engine'
+require 'pagy'
 
 require_relative 'dependencies'
 require_relative 'configuration'
@@ -18,6 +19,11 @@ module Spree
         Migrations.new(config, engine_name).check unless Rails.env.test?
       end
 
+      # Add API event subscribers
+      config.after_initialize do
+        Spree.subscribers << Spree::WebhookEventSubscriber
+      end
+
       def self.root
         @root ||= Pathname.new(File.expand_path('../../..', __dir__))
       end

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

@@ -1,67 +1 @@
-# Passes if executing the code in the block there is a
-# `Spree::Webhooks::Subscribers::QueueRequests.call` method
-# call with the given `event` and `webhook_payload_body` arguments just once.
-#
-# @example
-#   expect { order.complete }.to emit_webhook_event('order.paid')
-#   expect do
-#     order.start_processing
-#     order.complete
-#   end.to emit_webhook_event('order.paid')
-#
-# It can also be negated, resulting in the expectation
-# waiting to not receive a `call` method call with the
-# given `event` and `webhook_payload_body` (`once` isn't taken into consideration).
-#
-# @example
-#   expect { order.complete }.not_to emit_webhook_event('order.paid')
-#   expect do
-#     order.start_processing
-#     order.complete
-#   end.not_to emit_webhook_event('order.paid')
-#
-# == Notes
-#
-# The matcher relies on a `webhook_payload_body` method previously defined which
-# 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, record = nil|
-  match do |block|
-    queue_requests = instance_double(Spree::Webhooks::Subscribers::QueueRequests)
-
-    allow(Spree::Webhooks::Subscribers::QueueRequests).to receive(:new).and_return(queue_requests)
-    allow(queue_requests).to receive(:call).with(any_args)
-
-    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, record: record).once
-    )
-  end
-
-  def block_definition(obj_method)
-    # positive look-behinds must have a fixed length, using a straightforward match instead
-    obj_method.source.squish[/(expect *({|do) *)(.*?)( *(}|end).(not_)*to)/, 3]
-  end
-
-  failure_message do |obj_method|
-    block_def = block_definition(obj_method)
-    "Expected that executing `#{block_def}` emits the `#{event_to_emit}` Webhook event.\n" \
-      "Check that `#{block_def}` does implement `queue_webhooks_requests!` for " \
-      "`#{event_to_emit}` with the following webhook_payload_body: \n\n#{webhook_payload_body}."
-  end
-
-  failure_message_when_negated do |obj_method|
-    "Expected that executing `#{block_definition(obj_method)}` does not " \
-      "emit the `#{event_to_emit}` Webhook event with the following webhook_payload_body: #{webhook_payload_body}."
-  end
-
-  supports_block_expectations
-end
-
-def with_webhooks_enabled
-  Spree::Webhooks.disabled = false
-  yield
-  Spree::Webhooks.disabled = true
-end
+# dummy file for compatibility with legacy webhooks

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

@@ -1,9 +1 @@
-RSpec.configure do |config|
-  config.before(:each, :spree_webhooks) do
-    Spree::Webhooks.disabled = false
-  end
-
-  config.after(:each, :spree_webhooks) do
-    Spree::Webhooks.disabled = true
-  end
-end
+# this is a dummy file for backwards compatibility

data/lib/spree/api/testing_support/v2/current_order.rb

@@ -1,6 +1,5 @@
 def ensure_order_totals
-  order.update_totals
-  order.persist_totals
+  order.update_with_updater!
 end
 
 shared_context 'creates order with line item' do

data/lib/spree/api.rb

@@ -1,4 +1,7 @@
 require 'spree/core'
+require 'jsonapi/serializer'
+require 'doorkeeper'
+require 'pagy'
 
 module Spree
   module Api

data/lib/spree_api.rb

@@ -1,3 +1 @@
 require 'spree/api'
-require 'jsonapi/serializer'
-require 'doorkeeper'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 5.2.5
+  version: 5.3.0.rc1
 platform: ruby
 authors:
 - Ryan Bigg
@@ -95,20 +95,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '43.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '43.0'
 - !ruby/object:Gem::Dependency
   name: spree_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.5
+        version: 5.3.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.5
+        version: 5.3.0.rc1
 description: Spree's API
 email:
 - hello@spreecommerce.org
@@ -165,8 +179,6 @@ files:
 - app/controllers/spree/api/v2/platform/taxons_controller.rb
 - app/controllers/spree/api/v2/platform/users_controller.rb
 - app/controllers/spree/api/v2/platform/variants_controller.rb
-- app/controllers/spree/api/v2/platform/webhooks/events_controller.rb
-- app/controllers/spree/api/v2/platform/webhooks/subscribers_controller.rb
 - app/controllers/spree/api/v2/platform/wished_items_controller.rb
 - app/controllers/spree/api/v2/platform/wishlists_controller.rb
 - app/controllers/spree/api/v2/platform/zones_controller.rb
@@ -192,24 +204,13 @@ files:
 - app/helpers/spree/api/v2/display_money_helper.rb
 - app/helpers/spree/api/v2/store_media_serializer_images_concern.rb
 - app/jobs/spree/products/queue_status_changed_webhook_job.rb
-- app/jobs/spree/webhooks/subscribers/make_request_job.rb
+- app/jobs/spree/webhook_delivery_job.rb
 - 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/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
-- app/models/spree/webhooks/subscriber.rb
+- app/paginators/spree/api/paginate.rb
 - app/presenters/spree/api/products/filters_presenter.rb
 - app/serializers/concerns/spree/api/v2/image_transformation_concern.rb
 - app/serializers/concerns/spree/api/v2/public_metafields_concern.rb
@@ -284,8 +285,6 @@ files:
 - app/serializers/spree/api/v2/platform/taxonomy_serializer.rb
 - app/serializers/spree/api/v2/platform/user_serializer.rb
 - app/serializers/spree/api/v2/platform/variant_serializer.rb
-- app/serializers/spree/api/v2/platform/webhooks/event_serializer.rb
-- app/serializers/spree/api/v2/platform/webhooks/subscriber_serializer.rb
 - app/serializers/spree/api/v2/platform/wished_item_serializer.rb
 - app/serializers/spree/api/v2/platform/wishlist_serializer.rb
 - app/serializers/spree/api/v2/platform/zone_member_serializer.rb
@@ -332,9 +331,8 @@ files:
 - app/serializers/spree/v2/storefront/wished_item_serializer.rb
 - app/serializers/spree/v2/storefront/wishlist_serializer.rb
 - app/services/spree/products/queue_status_changed_webhook.rb
-- app/services/spree/webhooks/subscribers/handle_request.rb
-- app/services/spree/webhooks/subscribers/make_request.rb
-- app/services/spree/webhooks/subscribers/queue_requests.rb
+- app/services/spree/webhooks/deliver_webhook.rb
+- app/subscribers/spree/webhook_event_subscriber.rb
 - config/brakeman.ignore
 - config/i18n-tasks.yml
 - config/initializers/doorkeeper.rb
@@ -349,20 +347,14 @@ files:
 - db/migrate/20131017162334_add_index_to_user_spree_api_key.rb
 - db/migrate/20180320110726_create_doorkeeper_tables.rb
 - db/migrate/20210727102516_change_integer_id_columns_type.rb
-- db/migrate/20210902162826_create_spree_webhooks_tables.rb
 - db/migrate/20210919183228_enable_polymorphic_resource_owner.rb
-- db/migrate/20211025162826_create_spree_webhooks_events.rb
-- db/migrate/20221221122100_add_secret_key_to_spree_webhooks_subscribers.rb
-- db/migrate/20230116204600_backfill_secret_key_for_spree_webhooks_subscribers.rb
-- db/migrate/20230116205000_change_secret_key_to_non_null_column.rb
+- lib/generators/spree/api/install/install_generator.rb
 - lib/spree/api.rb
 - lib/spree/api/configuration.rb
 - lib/spree/api/dependencies.rb
 - lib/spree/api/engine.rb
 - lib/spree/api/testing_support/factories.rb
 - lib/spree/api/testing_support/factories/oauth_application_factory.rb
-- lib/spree/api/testing_support/factories/webhook_event_factory.rb
-- lib/spree/api/testing_support/factories/webhook_subscriber_factory.rb
 - lib/spree/api/testing_support/matchers/webhooks.rb
 - lib/spree/api/testing_support/serializers.rb
 - lib/spree/api/testing_support/spree_webhooks.rb
@@ -377,9 +369,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.2.5
+  changelog_uri: https://github.com/spree/spree/releases/tag/v5.3.0.rc1
   documentation_uri: https://docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v5.2.5
+  source_code_uri: https://github.com/spree/spree/tree/v5.3.0.rc1
 rdoc_options: []
 require_paths:
 - lib
@@ -387,7 +379,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/app/controllers/spree/api/v2/platform/webhooks/events_controller.rb

@@ -1,25 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        module Webhooks
-          class EventsController < ResourceController
-            private
-
-            def model_class
-              Spree::Webhooks::Event
-            end
-
-            def scope_includes
-              %i[subscriber]
-            end
-
-            def resource_serializer
-              Spree::Api::Dependencies.platform_webhooks_event_serializer.constantize
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v2/platform/webhooks/subscribers_controller.rb

@@ -1,25 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        module Webhooks
-          class SubscribersController < ResourceController
-            private
-
-            def model_class
-              Spree::Webhooks::Subscriber
-            end
-
-            def spree_permitted_attributes
-              super + [{ subscriptions: [] }]
-            end
-
-            def resource_serializer
-              Spree::Api::Dependencies.platform_webhooks_subscriber_serializer.constantize
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/app/jobs/spree/webhooks/subscribers/make_request_job.rb

@@ -1,17 +0,0 @@
-module Spree
-  module Webhooks
-    module Subscribers
-      class MakeRequestJob < Spree::BaseJob
-        queue_as :spree_webhooks
-
-        def perform(webhook_payload_body, event_name, subscriber)
-          Spree::Webhooks::Subscribers::HandleRequest.new(
-            event_name: event_name,
-            subscriber: subscriber,
-            webhook_payload_body: webhook_payload_body
-          ).call
-        end
-      end
-    end
-  end
-end

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

@@ -1,95 +0,0 @@
-module Spree
-  module Webhooks
-    module HasWebhooks
-      extend ActiveSupport::Concern
-
-      included do
-        after_create_commit(proc { queue_webhooks_requests!(inferred_event_name(:create)) })
-        after_destroy_commit(proc { queue_webhooks_requests!(inferred_event_name(:delete)) })
-        after_update_commit(proc { queue_webhooks_requests!(inferred_event_name(:update)) })
-
-        def queue_webhooks_requests!(event_name)
-          return if disable_spree_webhooks?
-          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(
-            record: self,
-            event_name: event_name,
-            webhook_payload_body: webhook_payload_body,
-            **webhooks_request_options
-          )
-        end
-
-        def self.default_webhook_events
-          model_name = name.demodulize.tableize.singularize
-          %W[#{model_name}.create #{model_name}.delete #{model_name}.update]
-        end
-
-        def self.supported_webhook_events
-          events = default_webhook_events
-          events += custom_webhook_events if respond_to?(:custom_webhook_events)
-          events
-        end
-      end
-
-      private
-
-      def webhook_payload_body
-        resource_serializer.new(self, include: included_relationships).serializable_hash.to_json
-      end
-
-      def inferred_event_name(operation)
-        "#{self.class.name.demodulize.tableize.singularize}.#{operation}"
-      end
-
-      def included_relationships
-        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
-          []
-        end
-      end
-
-      def resource_serializer
-        @resource_serializer ||=
-          begin
-            demodulized_class_name = self.class.to_s.demodulize
-            "Spree::Api::V2::Platform::#{demodulized_class_name}Serializer".constantize
-          end
-      end
-
-      def updating_only_ignored_attributes?
-        (saved_changes.keys - ignored_attributes).empty?
-      end
-
-      def ignored_attributes
-        timestamps = %w[created_at updated_at deleted_at]
-        return timestamps unless self.class.respond_to?(:ignored_attributes_for_update_webhook_event)
-
-        timestamps + self.class.ignored_attributes_for_update_webhook_event
-      end
-
-      def update_event?(event_name)
-        event_name.end_with?('.update')
-      end
-
-      def disable_spree_webhooks?
-        Spree::Webhooks.disabled?
-      end
-
-      def no_webhooks_subscribers?(event_name)
-        Spree::Current.webhooks_subscribers.none? do |subscriber|
-          subscriber.supports_event?(event_name)
-        end
-      end
-
-      def webhooks_request_options
-        {}
-      end
-    end
-  end
-end

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

@@ -1,39 +0,0 @@
-module Spree
-  class Order < Spree.base_class
-    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

@@ -1,23 +0,0 @@
-module Spree
-  class Payment < Spree.base_class
-    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

@@ -1,42 +0,0 @@
-module Spree
-  class Product < Spree.base_class
-    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