webhooks-rails 0.1.0

data/db/migrate/20210518060614_create_webhooks_responses.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class CreateWebhooksResponses < ActiveRecord::Migration[6.1]
+  def change
+    create_table :webhooks_responses do |t|
+      t.belongs_to :webhooks_request, null: false, foreign_key: true, index: { unique: true }
+
+      t.integer :status_code, null: false
+      t.json :headers, null: false
+      t.text :body, null: true
+
+      t.datetime :created_at, null: false, precision: 6
+    end
+  end
+end

data/lib/tasks/webhooks_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :webhooks do
+#   # Task goes here
+# end

data/lib/webhooks-rails.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative './webhooks'

data/lib/webhooks.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'webhooks/version'
+require 'webhooks/engine'
+require 'faraday'
+require 'faraday_middleware'
+
+module Webhooks
+  def self.client
+    @client ||= Faraday.new do |conn|
+      conn.headers[:user_agent] = Rails.application.config.webhooks.user_agent
+      conn.headers[:content_type] = 'application/json'
+      conn.headers[:accept] = 'application/json'
+
+      conn.request :json
+
+      conn.options.timeout = Rails.application.config.webhooks.requests.read_timeout
+      conn.options.open_timeout = Rails.application.config.webhooks.requests.open_timeout
+    end
+  end
+end

data/lib/webhooks/engine.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Webhooks
+  class Engine < ::Rails::Engine
+    isolate_namespace Webhooks
+
+    engine_name 'webhooks'
+
+    config.webhooks = ActiveSupport::OrderedOptions.new
+    config.webhooks.events = ActiveSupport::OrderedOptions.new
+
+    # If there are no webhook endpoints subscribing to an event that was just
+    # published, decide if we want to store the event or not. Storing the event
+    # will not trigger any webhook attempts at that time or in the future.
+    config.webhooks.events.create_without_subscribed_endpoint = false
+    config.webhooks.events.types = []
+    config.webhooks.user_agent = "webhooks-rails/v#{Webhooks::VERSION}"
+    config.webhooks.endpoints = ActiveSupport::OrderedOptions.new
+    config.webhooks.endpoints.valid_schemas = %w[https]
+
+    # Configuration for the webhook attempts
+    config.webhooks.attempts = ActiveSupport::OrderedOptions.new
+    config.webhooks.attempts.limit = 3
+
+    # Configuration for the actual webhook requests
+    config.webhooks.requests = ActiveSupport::OrderedOptions.new
+    config.webhooks.requests.read_timeout = 30
+    config.webhooks.requests.open_timeout = 10
+    config.webhooks.requests.header = 'X-Webhooks-Signature'
+  end
+end

data/lib/webhooks/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Webhooks
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: webhooks-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garrett Bjerkhoel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.3.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.10.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.10.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.1
+description: A Rails engine to configure and deliver webhooks.
+email:
+- garrett@cased.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/webhooks_manifest.js
+- app/assets/stylesheets/webhooks/application.css
+- app/controllers/webhooks/application_controller.rb
+- app/controllers/webhooks/attempts_controller.rb
+- app/controllers/webhooks/endpoints_controller.rb
+- app/controllers/webhooks/events_controller.rb
+- app/helpers/webhooks/application_helper.rb
+- app/jobs/webhooks/application_job.rb
+- app/jobs/webhooks/deliver_job.rb
+- app/mailers/webhooks/application_mailer.rb
+- app/models/webhooks/application_record.rb
+- app/models/webhooks/attempt.rb
+- app/models/webhooks/endpoint.rb
+- app/models/webhooks/event.rb
+- app/models/webhooks/event_serializer.rb
+- app/models/webhooks/request.rb
+- app/models/webhooks/response.rb
+- app/views/layouts/webhooks/application.html.erb
+- app/views/webhooks/attempts/_attempt.html.erb
+- app/views/webhooks/attempts/show.html.erb
+- app/views/webhooks/endpoints/_endpoint.html.erb
+- app/views/webhooks/endpoints/_form.html.erb
+- app/views/webhooks/endpoints/edit.html.erb
+- app/views/webhooks/endpoints/index.html.erb
+- app/views/webhooks/endpoints/new.html.erb
+- app/views/webhooks/endpoints/show.html.erb
+- app/views/webhooks/events/_event.html.erb
+- app/views/webhooks/events/index.html.erb
+- app/views/webhooks/events/new.html.erb
+- app/views/webhooks/events/show.html.erb
+- app/views/webhooks/requests/_request.html.erb
+- app/views/webhooks/responses/_response.html.erb
+- app/views/webhooks/shared/_navigation.html.erb
+- config/routes.rb
+- db/migrate/20210518022959_create_webhooks_endpoints.rb
+- db/migrate/20210518043350_create_webhooks_events.rb
+- db/migrate/20210518050123_create_webhooks_attempts.rb
+- db/migrate/20210518054916_create_webhooks_requests.rb
+- db/migrate/20210518060614_create_webhooks_responses.rb
+- lib/tasks/webhooks_tasks.rake
+- lib/webhooks-rails.rb
+- lib/webhooks.rb
+- lib/webhooks/engine.rb
+- lib/webhooks/version.rb
+homepage: https://github.com/cased/webhooks-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/cased/webhooks-rails
+  source_code_uri: https://github.com/cased/webhooks-rails
+  changelog_uri: https://github.com/cased/webhooks-rails/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A Rails engine to configure and deliver webhooks.
+test_files: []