spree_api 5.2.6 → 5.3.0.rc1

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

@@ -1,33 +0,0 @@
-require 'base64'
-require 'openssl'
-
-module Spree
-  module Webhooks
-    class EventSignature
-      def initialize(event, payload)
-        @event = event
-        @payload = payload
-      end
-
-      # Generates a base64-encoded HMAC SHA256 signature for the payload of the event.
-      #
-      # By using the stringified payload, the signature is made tamper-proof as any
-      # alterations of the data during transit will lead to an incorrect signature
-      # comparison by the client.
-      #
-      # @return [String] The computed signature
-      def computed_signature
-        @computed_signature ||=
-          Base64.strict_encode64(
-            OpenSSL::HMAC.digest('sha256', @event.subscriber.secret_key, payload)
-          )
-      end
-
-      private
-
-      def payload
-        @payload.is_a?(String) ? @payload : @payload.to_json
-      end
-    end
-  end
-end

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

@@ -1,88 +0,0 @@
-module Spree
-  module Webhooks
-    class Subscriber < Spree::Webhooks::Base
-      if defined?(Spree::VendorConcern)
-        include Spree::VendorConcern
-      end
-
-      if Rails::VERSION::STRING >= '7.1.0'
-        has_secure_token :secret_key, on: :save
-      else
-        has_secure_token :secret_key
-      end
-
-      has_many :events, inverse_of: :subscriber
-
-      validates :url, 'spree/url': true, presence: true
-      validate :check_uri_path
-
-      self.whitelisted_ransackable_attributes = %w[active subscriptions url]
-      self.whitelisted_ransackable_associations = %w[event]
-
-      scope :active, -> { where(active: true) }
-      scope :inactive, -> { where(active: false) }
-
-      before_save :parse_subscriptions
-
-      def latest_event_at
-        events.order(:created_at).last&.created_at
-      end
-
-      # Returns true if the subscriber supports the given event
-      #
-      # @param event [String] The event to check, e.g. 'product.create'
-      # @return [Boolean]
-      def supports_event?(event)
-        subscriptions.include?(event) || subscriptions.include?('*')
-      end
-
-      def self.with_urls_for(event)
-        where(
-          case ActiveRecord::Base.connection.adapter_name
-          when 'Mysql2'
-            ["('*' MEMBER OF(subscriptions) OR ? MEMBER OF(subscriptions))", event]
-          when 'PostgreSQL'
-            ["subscriptions @> '[\"*\"]' OR subscriptions @> ?", [event].to_json]
-          when 'SQLite'
-            ["subscriptions LIKE '%\"*\"%' OR subscriptions LIKE ?", "%#{event}%"]
-          end
-        )
-      end
-
-      def self.supported_events
-        @supported_events ||= begin
-          Rails.application.eager_load! if Rails.env.development?
-          Spree::Base.descendants.
-            select { |model| model.included_modules.include? Spree::Webhooks::HasWebhooks }.
-            sort_by { |model| model.name.demodulize.underscore }.
-            to_h do |model|
-              model_name = model.name.demodulize.underscore.to_sym
-              [model_name, model.supported_webhook_events]
-            end
-        end
-      end
-
-      def name
-        url
-      end
-
-      private
-
-      def check_uri_path
-        uri = begin
-          URI.parse(url)
-        rescue URI::InvalidURIError
-          return false
-        end
-
-        errors.add(:url, 'the URL must have a path') if uri.blank? || uri.path.blank?
-      end
-
-      def parse_subscriptions
-        return if subscriptions.blank? || subscriptions.is_a?(Array)
-
-        self.subscriptions = JSON.parse(subscriptions)
-      end
-    end
-  end
-end

data/app/serializers/spree/api/v2/platform/webhooks/event_serializer.rb

@@ -1,15 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        module Webhooks
-          class EventSerializer < BaseSerializer
-            include ResourceSerializerConcern
-
-            belongs_to :subscriber
-          end
-        end
-      end
-    end
-  end
-end

data/app/serializers/spree/api/v2/platform/webhooks/subscriber_serializer.rb

@@ -1,13 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        module Webhooks
-          class SubscriberSerializer < BaseSerializer
-            include ResourceSerializerConcern
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module Spree
-  module Webhooks
-    module Subscribers
-      class HandleRequest
-        def initialize(event_name:, subscriber:, webhook_payload_body:)
-          @event_name = event_name
-          @subscriber = subscriber
-          @webhook_payload_body = JSON.parse(webhook_payload_body)
-        end
-
-        def call
-          Rails.logger.debug(msg("sending to '#{url}'"))
-          Rails.logger.debug(msg("webhook_payload_body: #{body_with_event_metadata}"))
-
-          if request.unprocessable_uri?
-            return process(:warn, msg("can not make a request to '#{url}'"))
-          end
-          return process(:warn, msg("failed for '#{url}'")) if request.failed_request?
-
-          process
-        end
-
-        private
-
-        attr_reader :webhook_payload_body, :event_name, :subscriber
-
-        delegate :execution_time, :failed_request?, :response_code, :success?, :unprocessable_uri?, to: :request
-        delegate :id, :url, to: :subscriber
-        delegate :created_at, :id, to: :event, prefix: true
-
-        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
-        end
-
-        def request
-          @request ||=
-            Spree::Webhooks::Subscribers::MakeRequest.new(
-              signature: event.signature_for(body_with_event_metadata),
-              url: url,
-              webhook_payload_body: body_with_event_metadata
-            )
-        end
-        alias make_request request
-
-        def body_with_event_metadata
-          webhook_payload_body.
-            merge(event_created_at: event_created_at, event_id: event_id, event_type: event.name).
-            to_json
-        end
-
-        def event
-          @event ||= Spree::Webhooks::Event.create!(
-            name: event_name, subscriber_id: subscriber.id, url: url
-          )
-        end
-
-        def update_event(msg = nil)
-          event.update(
-            execution_time: execution_time,
-            request_errors: msg,
-            response_code: response_code,
-            success: success?
-          )
-        end
-
-        def msg(msg)
-          "[SPREE WEBHOOKS] '#{event_name}' #{msg}"
-        end
-      end
-    end
-  end
-end

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

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-module Spree
-  module Webhooks
-    module Subscribers
-      class MakeRequest
-        def initialize(signature:, url:, webhook_payload_body:)
-          @execution_time_in_milliseconds = 0
-          @signature = signature
-          @url = url
-          @webhook_payload_body = webhook_payload_body
-          @webhooks_timeout = ENV['SPREE_WEBHOOKS_TIMEOUT']
-        end
-
-        def execution_time
-          request
-          @execution_time_in_milliseconds
-        end
-
-        def failed_request?
-          (200...300).exclude?(response_code)
-        end
-
-        def response_code
-          request.code.to_i
-        end
-
-        def success?
-          !unprocessable_uri? && !failed_request?
-        end
-
-        def unprocessable_uri?
-          uri_path == '' && uri_host.nil? && uri_port.nil?
-        end
-
-        private
-
-        attr_reader :execution_time_in_milliseconds, :url, :webhook_payload_body, :webhooks_timeout
-
-        HEADERS = { 'Content-Type' => 'application/json' }.freeze
-        private_constant :HEADERS
-
-        delegate :host, :path, :port, to: :uri, prefix: true
-
-        def http
-          http = Net::HTTP.new(uri_host, uri_port)
-          http.read_timeout = webhooks_timeout.to_i if custom_read_timeout?
-          http.use_ssl = use_ssl?
-          http
-        end
-
-        def request
-          req = Net::HTTP::Post.new(uri_path, HEADERS.merge('X-Spree-Hmac-SHA256' => @signature))
-          req.body = webhook_payload_body
-          @request ||= begin
-            start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-            request_result = http.request(req)
-            @execution_time_in_milliseconds = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time).in_milliseconds
-            request_result
-          end
-        rescue Errno::ECONNREFUSED, Net::ReadTimeout, SocketError
-          Class.new do
-            def self.code
-              '0'
-            end
-          end
-        end
-
-        def custom_read_timeout?
-          webhooks_timeout.present?
-        end
-
-        def use_ssl?
-          uri.scheme == 'https'
-        end
-
-        def uri
-          URI(url)
-        end
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-module Spree
-  module Webhooks
-    module Subscribers
-      class QueueRequests
-        prepend Spree::ServiceModule::Base
-
-        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
-            )
-          end
-        end
-
-        private
-
-        def filtered_subscribers(event_name, webhook_payload_body, record, options)
-          Spree::Current.webhooks_subscribers.map do |subscriber|
-            if subscriber.supports_event?(event_name)
-              subscriber
-            end
-          end.compact
-        end
-      end
-    end
-  end
-end

data/db/migrate/20210902162826_create_spree_webhooks_tables.rb

@@ -1,16 +0,0 @@
-class CreateSpreeWebhooksTables < ActiveRecord::Migration[5.2]
-  def change
-    create_table :spree_webhooks_subscribers do |t|
-      t.string :url, null: false
-      t.boolean :active, default: false, index: true
-
-      if t.respond_to? :jsonb
-        t.jsonb :subscriptions
-      else
-        t.json :subscriptions
-      end
-
-      t.timestamps
-    end
-  end
-end

data/db/migrate/20211025162826_create_spree_webhooks_events.rb

@@ -1,14 +0,0 @@
-class CreateSpreeWebhooksEvents < ActiveRecord::Migration[5.2]
-  def change
-    create_table :spree_webhooks_events do |t|
-      t.integer "execution_time"
-      t.string "name", null: false
-      t.string "request_errors"
-      t.string "response_code", index: true
-      t.belongs_to "subscriber", null: false, index: true
-      t.boolean "success", index: true
-      t.string "url", null: false
-      t.timestamps
-    end
-  end
-end

data/db/migrate/20221221122100_add_secret_key_to_spree_webhooks_subscribers.rb

@@ -1,5 +0,0 @@
-class AddSecretKeyToSpreeWebhooksSubscribers < ActiveRecord::Migration[6.1]
-  def change
-    add_column :spree_webhooks_subscribers, :secret_key, :string, null: true
-  end
-end

data/db/migrate/20230116204600_backfill_secret_key_for_spree_webhooks_subscribers.rb

@@ -1,5 +0,0 @@
-class BackfillSecretKeyForSpreeWebhooksSubscribers < ActiveRecord::Migration[6.1]
-  def change
-    Spree::Webhooks::Subscriber.where(secret_key: nil).find_each(&:regenerate_secret_key)
-  end
-end

data/db/migrate/20230116205000_change_secret_key_to_non_null_column.rb

@@ -1,5 +0,0 @@
-class ChangeSecretKeyToNonNullColumn < ActiveRecord::Migration[6.1]
-  def change
-    change_column_null :spree_webhooks_subscribers, :secret_key, false
-  end
-end

data/lib/spree/api/testing_support/factories/webhook_event_factory.rb

@@ -1,27 +0,0 @@
-FactoryBot.define do
-  factory :webhook_event, aliases: [:event], class: Spree::Webhooks::Event do
-    subscriber
-
-    execution_time { rand(1..99_999) }
-    name { 'order.canceled' }
-    request_errors { '' }
-    sequence(:url) { |n| "https://www.url#{n}.com/" }
-
-    trait :failed do
-      response_code { '500' }
-      success { false }
-    end
-
-    trait :successful do
-      response_code { '200' }
-      success { true }
-    end
-
-    trait :blank do
-      execution_time { nil }
-      request_errors { nil }
-      subscriber_id { nil }
-      url { nil }
-    end
-  end
-end

data/lib/spree/api/testing_support/factories/webhook_subscriber_factory.rb

@@ -1,13 +0,0 @@
-FactoryBot.define do
-  factory :webhook_subscriber, aliases: [:subscriber, :webhooks_subscriber], class: Spree::Webhooks::Subscriber do
-    sequence(:url) { |n| "https://www.url#{n}.com/" }
-
-    trait :active do
-      active { true }
-    end
-
-    trait :inactive do
-      active { false }
-    end
-  end
-end