active_webhook 1.0.0

data/lib/active_webhook/models/topic_additions.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module ActiveWebhook
+  module Models
+    module TopicAdditions
+      extend ActiveSupport::Concern
+
+      included do
+        self.table_name = "active_webhook_topics"
+
+        scope :enabled, -> { where(disabled_at: nil) }
+        scope :with_key, lambda { |key:, version: nil|
+          scope = where(key: key)
+          scope = scope.where(version: version) if version.present?
+          scope
+        }
+
+        def self.last_with_key(key)
+          where(key: key).order(id: :desc).first
+        end
+
+        before_validation :set_valid_version
+        validates :key, presence: true
+        validates :version, presence: true, uniqueness: { scope: :key }
+      end
+
+      def disable(reason = nil)
+        self.disabled_at = Time.current
+        self.disabled_reason = reason
+      end
+
+      def disable!(reason = nil)
+        disable reason
+        save!
+      end
+
+      def enable
+        self.disabled_at = nil
+        self.disabled_reason = nil
+      end
+
+      def enable!
+        enable
+        save!
+      end
+
+      def disabled?
+        !enabled?
+      end
+
+      def enabled?
+        disabled_at.nil?
+      end
+
+      protected
+
+      def set_valid_version
+        return if version.present?
+
+        last_with_key = self.class.last_with_key key
+        versions = last_with_key&.version.to_s.split(".")
+        versions = [0] if versions.empty?
+        version = versions.pop
+        versions << version.to_i + 1
+
+        self.version = versions.join(".")
+      end
+    end
+  end
+end

data/lib/active_webhook/queueing/active_job_adapter.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ActiveWebhook
+  module Queueing
+    class ActiveJobAdapter < BaseAdapter
+      class SubscriptionJob < ApplicationJob
+        queue_as :low_priority
+
+        def perform(subscription, hook, context)
+          context.symbolize_keys!
+          hook = Hook.from_h(hook.symbolize_keys) unless hook.nil?
+
+          ActiveWebhook.queueing_adapter.fulfill_subscription(
+            subscription: subscription,
+            hook: hook,
+            job_id: job_id,
+            **context
+          )
+        end
+      end
+
+      class TopicJob < ApplicationJob
+        queue_as :low_priority
+
+        def perform(key, version, context)
+          context.symbolize_keys!
+
+          ActiveWebhook.queueing_adapter.new(key: key, version: version, **context).fulfill_topic
+        end
+      end
+
+      protected
+
+      def promise_subscription(subscription:, hook:)
+        SubscriptionJob.perform_later subscription, hook&.to_h, context
+      end
+
+      def promise_topic
+        TopicJob.perform_later key, version, context
+      end
+    end
+  end
+end

data/lib/active_webhook/queueing/base_adapter.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module ActiveWebhook
+  module Queueing
+    class BaseAdapter < Adapter
+      attribute :key, :version, :format_first
+
+      def format_first
+        @format_first.nil? ? component_configuration.format_first : @format_first
+      end
+
+      # returns count of jobs enqueued
+      def call
+        return fulfill_topic if format_first
+
+        promise_topic
+        1
+      end
+
+      def self.build_hook(subscription, **context)
+        ActiveWebhook.formatting_adapter.call(subscription: subscription, **context)
+      end
+
+      def self.fulfill_subscription(subscription:, hook: nil, **context)
+        ActiveWebhook.delivery_adapter.call(
+          subscription: subscription,
+          hook: hook || build_hook(subscription, **context),
+          **context
+        ) if ActiveWebhook.enabled?
+        true
+      end
+
+      def fulfill_topic
+        subscriptions.each do |subscription|
+          hook = format_first ? self.class.build_hook(subscription, **context) : nil
+          byebug if context.key?("key")
+          promise_subscription subscription: subscription, hook: hook
+        end
+        subscriptions.count
+      end
+
+      protected
+
+      def self.component_name
+        "queueing"
+      end
+
+      def promise_subscription(_subscription:, _hook:)
+        raise NotImplementedError, "#promise_subscription must be implemented."
+      end
+
+      def promise_topic
+        raise NotImplementedError, "#promise_topic must be implemented."
+      end
+
+      def subscriptions
+        subscriptions_scope.all
+      end
+
+      def subscriptions_scope
+        ActiveWebhook.subscription_model.enabled.joins(:topic).includes(:topic).merge(
+          ActiveWebhook.topic_model.enabled.with_key(key: key, version: version)
+        )
+      end
+    end
+  end
+end

data/lib/active_webhook/queueing/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ActiveWebhook
+  module Queueing
+    class Configuration
+      include ActiveWebhook::Configuration::Base
+
+      define_option :adapter,
+                    values: %i[syncronous sidekiq delayed_job active_job],
+                    allow_proc: true
+
+      define_option :format_first, values: [true, false], default: false
+    end
+  end
+end

data/lib/active_webhook/queueing/delayed_job_adapter.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "delayed_job"
+
+module ActiveWebhook
+  module Queueing
+    class DelayedJobAdapter < BaseAdapter
+      protected
+
+      def promise_subscription(subscription:, hook:)
+        ActiveWebhook.queueing_adapter.fulfill_subscription(
+          subscription: subscription,
+          hook: hook,
+          # NOTE: not implemented yet;
+          # SEE: https://stackoverflow.com/questions/21590798/referencing-delayed-job-job-id-from-within-the-job-task
+          # job_id: ???
+          **context
+        )
+      end
+      handle_asynchronously :promise_subscription
+
+      def promise_topic
+        fulfill_topic
+      end
+      handle_asynchronously :promise_topic
+    end
+  end
+end

data/lib/active_webhook/queueing/sidekiq_adapter.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+
+module ActiveWebhook
+  module Queueing
+    class SidekiqAdapter < BaseAdapter
+      class SubscriptionWorker
+        include Sidekiq::Worker
+
+        def perform(subscription, hook, context)
+          subscription = ActiveWebhook.subscription_model.find_by(id: subscription)
+          hook = Hook.from_h(hook.symbolize_keys) unless hook.nil?
+
+          ActiveWebhook.queueing_adapter.fulfill_subscription(
+            subscription: subscription,
+            hook: hook,
+            job_id: jid,
+            **context.symbolize_keys
+          )
+        end
+      end
+
+      class TopicWorker
+        include Sidekiq::Worker
+
+        def perform(key, version, context)
+          ActiveWebhook.queueing_adapter.new(key: key, version: version, **context.symbolize_keys).fulfill_topic
+        end
+      end
+
+      protected
+
+      def promise_subscription(subscription:, hook:)
+        SubscriptionWorker.perform_async subscription.id, hook&.to_h, context
+      end
+
+      def promise_topic
+        TopicWorker.perform_async key, version, context
+      end
+    end
+  end
+end

data/lib/active_webhook/queueing/syncronous_adapter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ActiveWebhook
+  module Queueing
+    class SyncronousAdapter < BaseAdapter
+      def call
+        subscriptions.each do |subscription|
+          self.class.fulfill_subscription subscription: subscription, **context
+        end
+        subscriptions.count
+      end
+    end
+  end
+end

data/lib/active_webhook/subscription.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveWebhook
+  class Subscription < ActiveRecord::Base
+    include ActiveWebhook::Models::SubscriptionAdditions
+  end
+end

data/lib/active_webhook/topic.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveWebhook
+  class Topic < ActiveRecord::Base
+    include ActiveWebhook::Models::TopicAdditions
+  end
+end

data/lib/active_webhook/verification/base_adapter.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ActiveWebhook
+  module Verification
+    class BaseAdapter < Adapter
+      attribute :secret, :data
+
+      def call
+        return {} unless secret.present?
+
+        {
+          strategy => signature
+        }
+      end
+
+      protected
+
+      def self.component_name
+        "verification"
+      end
+
+      def signature
+        raise NotImplementedError, "#signature must be implemented."
+      end
+
+      def strategy
+        self.class.name.delete_suffix("Adapter")
+      end
+    end
+  end
+end

data/lib/active_webhook/verification/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ActiveWebhook
+  module Verification
+    class Configuration
+      include ActiveWebhook::Configuration::Base
+
+      define_option :adapter,
+                    values: %i[unsigned hmac_sha256],
+                    allow_proc: true
+    end
+  end
+end

data/lib/active_webhook/verification/hmac_sha256_adapter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "base64"
+require "openssl"
+require "active_support/security_utils"
+
+module ActiveWebhook
+  module Verification
+    class HMACSHA256Adapter < BaseAdapter
+      def signature
+        Base64.strict_encode64(OpenSSL::HMAC.digest("sha256", secret, data))
+      end
+
+      def strategy
+        "Hmac-SHA256"
+      end
+    end
+  end
+end

data/lib/active_webhook/verification/unsigned_adapter.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActiveWebhook
+  module Verification
+    class UnsignedAdapter < BaseAdapter
+      def call
+        {}
+      end
+    end
+  end
+end

data/lib/active_webhook/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveWebhook
+  VERSION = "1.0.0"
+end

data/lib/generators/install_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module ActiveWebhook
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      desc "Creates all the files needed to use Active Webhook"
+
+      def copy_config
+        template "active_webhook_config.rb", Rails.root.join('config','active_webhook.rb')
+      end
+
+      def run_other_generators
+        invoke "active_webhook:migrations"
+      end
+    end
+  end
+end

data/lib/generators/migrations_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module ActiveWebhook
+  module Generators
+    class MigrationsGenerator < ::Rails::Generators::Base
+      include ::Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+      desc "Creates the migrations needed to use Active Webhook"
+
+      def self.next_migration_number(path)
+        next_migration_number = current_migration_number(path) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def copy_migrations
+        migration_template "20210618023338_create_active_webhook_tables.rb",
+                           Rails.root.join('db','migrate','create_active_webhook_tables.rb')
+      end
+    end
+  end
+end