active_webhook 1.0.0

data/lib/generators/templates/20210618023338_create_active_webhook_tables.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class CreateActiveWebhookTables < ActiveRecord::Migration[4.2]
+  def change
+    create_table :active_webhook_subscriptions do |t|
+      t.references :topic, class: :active_webhook_topic
+      t.text :callback_url
+      t.text :shared_secret
+      t.datetime :disabled_at
+      t.string :disabled_reason
+
+      t.timestamps
+    end
+
+    create_table :active_webhook_topics do |t|
+      t.string :key
+      t.string :version
+      t.datetime :disabled_at
+      t.string :disabled_reason
+
+      t.timestamps
+    end
+
+    create_table :active_webhook_error_logs do |t|
+      t.references :subscription, class: :active_webhook_subscription
+      t.string :job_id
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/templates/active_webhook_config.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "active_webhook"
+
+ApplicationRecord.include ActiveWebhook::Callbacks
+
+ActiveWebhook.configure do |c|
+  # Inject your Rails Application name into all custom headers for outgoing webhooks
+  # c.custom_header_prefix = Rails.application.class.to_s.split("::").first
+
+  # Specify a custom origin name to use for x-Domain header in outgoing webhooks
+  # c.origin = 'http://'
+
+  # Format the payload BEFORE queuing for delivery.
+  # Helpful when queuing delay is problematic, but comes with the trade of poor performance profile.
+  # c.formatting.format_first = true                  # << one of: [true, false]
+
+  # Base class for Active Webhook Models (Subscription & Topic)
+  # c.model_base_class = ApplicationRecord
+
+  # --------------------------------------------------------------------------------------------------------------
+
+  # !!! IMPORTANT !!!
+  #
+  # YOU WILL NEED INSTALL AND CONFIGURE ALL DEPENDENCIES OF THE ADAPTERS THAT YOU USE.
+  #
+  # Active Webhook does not register official dependencies for any of the
+  # gems required by the various adapters (so as to not bloat your application with
+  # unused/incompatible gems). This means that you will have to manually install and
+  # configure all gems required by the adapters that you use (via command line or
+  # Bundler).
+  #
+  # For example, to activate the [sidekiq](https://github.com/mperham/sidekiq)
+  # queuing adapter:
+  #
+  # ```ruby
+  # # in config/active_webhook.rb
+  #
+  # require "active_webhook"
+  #
+  # ActiveWebhook.configure do |config|
+  #   config.queue_adapter = :sidekiq
+  # end
+  # ```
+  #
+  # ```ruby
+  # # in Gemfile
+  #
+  # gem "sidekiq"
+  # ```
+  # --------------------------------------------------------------------------------------------------------------
+
+  # Queue asynchronous delivery with active_job.
+  # c.adapters.queueing = :active_job                # << one of: [:sidekiq, :active_job, :syncronous]
+
+  # Deliver the payload with Faraday.
+  # c.adapters.delivery = :faraday                   # << one of: [:net_http, :faraday]
+
+  # Sign the payload with HMAC_SHA256.
+  # c.adapters.verification = :hmac_sha256           # << one of: [:hmac_sha256]
+
+  # Serialize the payload as json.
+  # c.adapters.formatting = :json                    # << one of: [:json]
+
+  # --------------------------------------------------------------------------------------------------------------
+
+  # Note: For extensibility, all adaptors also accept an object (or Proc) that implements `call(**kwargs)`.
+  #
+  # Queue asynchronous delivery with custom adapter.
+  # c.adapters.queueing = Class.new do
+  #   def self.call(subscription_id:, **context) do
+  #   # ... cause `ActiveWebhook.fulfill_delivery(subscription_id:, payload:, **context)` to be called at a later date
+  # end
+  #
+  # - or -
+  #
+  # c.adapters.queueing = ->(subscription_id:, **context) do
+  #   # ... cause `ActiveWebhook.fulfill_delivery(subscription_id:, payload:, **context)` to be called at a later date
+  # end
+  #
+  # For more information, see the files located at:
+  #
+  # - (lib/active_webhook/queueing)[https://github.com/amazing-jay/active_webhook/tree/master/lib/active_webhook/queueing]
+  # - (lib/active_webhook/delivery)[https://github.com/amazing-jay/active_webhook/tree/master/lib/active_webhook/delivery]
+  # - (lib/active_webhook/verification)[https://github.com/amazing-jay/active_webhook/tree/master/lib/active_webhook/verification]
+  # - (lib/active_webhook/formatting)[https://github.com/amazing-jay/active_webhook/tree/master/lib/active_webhook/formatting]
+end

metadata

@@ -0,0 +1,447 @@
+--- !ruby/object:Gem::Specification
+name: active_webhook
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jay Crouch
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: memoist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: delayed_job_active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.0
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec-sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: 'Simple, efficient, and extensible webhooks for Ruby, including: Rate
+  Limits, Cryptographic Signatures, Asynchronous Delivery, Buffered Delivery, Versioning.'
+email:
+- i.jaycrouch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".todo"
+- ".travis.yml"
+- CHANGELOG.md
+- DEV_README.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_webhook.gemspec
+- config/environment.rb
+- lib/active_webhook.rb
+- lib/active_webhook/adapter.rb
+- lib/active_webhook/callbacks.rb
+- lib/active_webhook/configuration.rb
+- lib/active_webhook/delivery/base_adapter.rb
+- lib/active_webhook/delivery/configuration.rb
+- lib/active_webhook/delivery/faraday_adapter.rb
+- lib/active_webhook/delivery/net_http_adapter.rb
+- lib/active_webhook/error_log.rb
+- lib/active_webhook/formatting/base_adapter.rb
+- lib/active_webhook/formatting/configuration.rb
+- lib/active_webhook/formatting/json_adapter.rb
+- lib/active_webhook/formatting/url_encoded_adapter.rb
+- lib/active_webhook/hook.rb
+- lib/active_webhook/logger.rb
+- lib/active_webhook/models/configuration.rb
+- lib/active_webhook/models/error_log_additions.rb
+- lib/active_webhook/models/subscription_additions.rb
+- lib/active_webhook/models/topic_additions.rb
+- lib/active_webhook/queueing/active_job_adapter.rb
+- lib/active_webhook/queueing/base_adapter.rb
+- lib/active_webhook/queueing/configuration.rb
+- lib/active_webhook/queueing/delayed_job_adapter.rb
+- lib/active_webhook/queueing/sidekiq_adapter.rb
+- lib/active_webhook/queueing/syncronous_adapter.rb
+- lib/active_webhook/subscription.rb
+- lib/active_webhook/topic.rb
+- lib/active_webhook/verification/base_adapter.rb
+- lib/active_webhook/verification/configuration.rb
+- lib/active_webhook/verification/hmac_sha256_adapter.rb
+- lib/active_webhook/verification/unsigned_adapter.rb
+- lib/active_webhook/version.rb
+- lib/generators/install_generator.rb
+- lib/generators/migrations_generator.rb
+- lib/generators/templates/20210618023338_create_active_webhook_tables.rb
+- lib/generators/templates/active_webhook_config.rb
+homepage: https://github.com/amazing-jay/active_webhook
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/amazing-jay/active_webhook
+  source_code_uri: https://github.com/amazing-jay/active_webhook
+  changelog_uri: https://github.com/amazing-jay/active_webhook/master/tree/CHANGELOG.md.
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Simple, efficient, and extensible webhooks for Ruby.
+test_files: []