RubyGems - webhooks-rails - Versions diffs - 0.1.0 - Mend

webhooks-rails 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (49) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +28 -0
data/Rakefile +20 -0
data/app/assets/config/webhooks_manifest.js +1 -0
data/app/assets/stylesheets/webhooks/application.css +15 -0
data/app/controllers/webhooks/application_controller.rb +6 -0
data/app/controllers/webhooks/attempts_controller.rb +25 -0
data/app/controllers/webhooks/endpoints_controller.rb +65 -0
data/app/controllers/webhooks/events_controller.rb +37 -0
data/app/helpers/webhooks/application_helper.rb +6 -0
data/app/jobs/webhooks/application_job.rb +6 -0
data/app/jobs/webhooks/deliver_job.rb +11 -0
data/app/mailers/webhooks/application_mailer.rb +8 -0
data/app/models/webhooks/application_record.rb +7 -0
data/app/models/webhooks/attempt.rb +71 -0
data/app/models/webhooks/endpoint.rb +74 -0
data/app/models/webhooks/event.rb +50 -0
data/app/models/webhooks/event_serializer.rb +30 -0
data/app/models/webhooks/request.rb +37 -0
data/app/models/webhooks/response.rb +29 -0
data/app/views/layouts/webhooks/application.html.erb +29 -0
data/app/views/webhooks/attempts/_attempt.html.erb +32 -0
data/app/views/webhooks/attempts/show.html.erb +33 -0
data/app/views/webhooks/endpoints/_endpoint.html.erb +31 -0
data/app/views/webhooks/endpoints/_form.html.erb +42 -0
data/app/views/webhooks/endpoints/edit.html.erb +16 -0
data/app/views/webhooks/endpoints/index.html.erb +41 -0
data/app/views/webhooks/endpoints/new.html.erb +16 -0
data/app/views/webhooks/endpoints/show.html.erb +102 -0
data/app/views/webhooks/events/_event.html.erb +11 -0
data/app/views/webhooks/events/index.html.erb +38 -0
data/app/views/webhooks/events/new.html.erb +35 -0
data/app/views/webhooks/events/show.html.erb +49 -0
data/app/views/webhooks/requests/_request.html.erb +47 -0
data/app/views/webhooks/responses/_response.html.erb +55 -0
data/app/views/webhooks/shared/_navigation.html.erb +100 -0
data/config/routes.rb +13 -0
data/db/migrate/20210518022959_create_webhooks_endpoints.rb +17 -0
data/db/migrate/20210518043350_create_webhooks_events.rb +12 -0
data/db/migrate/20210518050123_create_webhooks_attempts.rb +36 -0
data/db/migrate/20210518054916_create_webhooks_requests.rb +14 -0
data/db/migrate/20210518060614_create_webhooks_responses.rb +15 -0
data/lib/tasks/webhooks_tasks.rake +5 -0
data/lib/webhooks-rails.rb +3 -0
data/lib/webhooks.rb +21 -0
data/lib/webhooks/engine.rb +31 -0
data/lib/webhooks/version.rb +5 -0
metadata +183 -0

data/app/models/webhooks/event_serializer.rb ADDED Viewed

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+module Webhooks
+  class EventSerializer
+    include ActiveModel::Serializers::JSON
+    attr_reader :id
+    attr_reader :type
+    attr_reader :event
+    attr_reader :created_at
+    def initialize(request)
+      event = request.event
+      @id = event.id
+      @type = event.event_type
+      @event = ActiveSupport::JSON.decode(event.event)
+      @created_at = event.created_at.iso8601(6)
+    end
+    def attributes
+      {
+        'id' => id,
+        'type' => type,
+        'event' => event,
+        'created_at' => created_at,
+      }
+    end
+  end
+end

data/app/models/webhooks/request.rb ADDED Viewed

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module Webhooks
+  class Request < ApplicationRecord
+    belongs_to :attempt, class_name: 'Webhooks::Attempt', foreign_key: :webhooks_attempt_id, inverse_of: :request
+    has_one :response, class_name: 'Webhooks::Response', foreign_key: :webhooks_request_id, inverse_of: :request, dependent: :destroy
+    # Delegated associations
+    has_one :endpoint, through: :attempt
+    has_one :event, through: :attempt
+    before_create :perform_request
+    after_create :record_response
+    private
+    def perform_request
+      self.body ||= EventSerializer.new(self).to_json
+      @response = Webhooks.client.post(endpoint.url) do |req|
+        timestamp = Time.zone.now
+        timestamped_payload = "#{timestamp.to_i}.#{body}"
+        signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), endpoint.secret, timestamped_payload)
+        req.headers[Rails.application.config.webhooks.requests.header] = "t=#{timestamp.to_i},v1=#{signature}"
+        req.body = body
+      end
+      self.headers = @response.env.request_headers
+    end
+    def record_response
+      create_response!(response: @response)
+    end
+  end
+end

data/app/models/webhooks/response.rb ADDED Viewed

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Webhooks
+  class Response < ApplicationRecord
+    belongs_to :request, class_name: 'Webhooks::Request', foreign_key: :webhooks_request_id, inverse_of: :response
+    has_one :attempt, through: :request
+    has_one :endpoint, through: :attempt
+    validates :status_code, presence: true
+    validates :headers, presence: true
+    after_create :update_attempt_state
+    def update_attempt_state
+      case status_code
+      when 200..299
+        attempt.update!(state: :success)
+      else
+        attempt.update!(state: :error)
+      end
+    end
+    def response=(response)
+      self.status_code = response.status
+      self.headers = response.headers
+      self.body = response.body
+    end
+  end
+end

data/app/views/layouts/webhooks/application.html.erb ADDED Viewed

@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Webhooks</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <link href="https://unpkg.com/tailwindcss@^2/dist/tailwind.min.css" rel="stylesheet">
+  </head>
+  <body>
+    <!-- This example requires Tailwind CSS v2.0+ -->
+    <div class="h-screen flex overflow-hidden bg-gray-100">
+      <%= render 'webhooks/shared/navigation' %>
+      <div class="flex flex-col w-0 flex-1 overflow-hidden">
+        <div class="md:hidden pl-1 pt-1 sm:pl-3 sm:pt-3">
+          <button class="-ml-0.5 -mt-0.5 h-12 w-12 inline-flex items-center justify-center rounded-md text-gray-500 hover:text-gray-900 focus:outline-none focus:ring-2 focus:ring-inset focus:ring-indigo-500">
+            <span class="sr-only">Open sidebar</span>
+            <!-- Heroicon name: outline/menu -->
+            <svg class="h-6 w-6" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" aria-hidden="true">
+              <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M4 6h16M4 12h16M4 18h16" />
+            </svg>
+          </button>
+        </div>
+        <main class="flex-1 relative z-0 overflow-y-auto focus:outline-none">
+          <%= yield %>
+        </main>
+      </div>
+    </div>
+  </body>
+</html>

data/app/views/webhooks/attempts/_attempt.html.erb ADDED Viewed

@@ -0,0 +1,32 @@
+<tr>
+  <td class="px-6 py-4 whitespace-nowrap text-sm font-medium text-gray-900">
+    <% if attempt.success? %>
+      <span class="inline-flex items-center px-2 py-0.5 rounded text-xs font-medium bg-green-100 text-green-800">
+        Success
+      </span>
+    <% elsif attempt.error? %>
+      <span class="inline-flex items-center px-2 py-0.5 rounded text-xs font-medium bg-red-100 text-red-800">
+        Error <%= '(Limit)' if attempt.max_attempts? %>
+      </span>
+    <% else %>
+      <span class="inline-flex items-center px-2 py-0.5 rounded text-xs font-medium bg-gray-100 text-gray-800">
+        Queued
+      </span>
+    <% end %>
+  </td>
+  <td class="px-6 py-4 whitespace-nowrap text-sm text-gray-500">
+    <%= attempt.event.event_type %>
+  </td>
+  <td class="px-6 py-4 whitespace-nowrap text-sm text-gray-500">
+    <%= link_to attempt.endpoint, attempt.endpoint %>
+  </td>
+  <td class="px-6 py-4 whitespace-nowrap text-sm text-gray-500">
+    <%= link_to attempt.created_at, attempt %>
+  </td>
+  <td class="px-6 py-4 whitespace-nowrap text-sm text-gray-500 text-right">
+    <% if attempt.error? %>
+      <%= attempt.retry_at %>
+      <%= button_to 'Resend', reattempt_attempt_path(attempt), class: 'text-blue-600 hover:text-blue-900 bg-transparent cursor-pointer' %>
+    <% end %>
+  </td>
+</tr>

data/app/views/webhooks/attempts/show.html.erb ADDED Viewed

@@ -0,0 +1,33 @@
+<div class="py-6">
+  <div class="max-w-7xl mx-auto px-4 sm:px-6 md:px-8 md:flex md:justify-between md:space-x-5">
+    <h1 class="text-2xl font-semibold text-gray-900">Attempt</h1>
+  </div>
+  <div class="max-w-7xl mx-auto px-4 sm:px-6 md:px-8">
+    <div class="py-4">
+      <div class="flex flex-col">
+        <div class="-my-2 overflow-x-auto sm:-mx-6 lg:-mx-8">
+          <div class="py-2 align-middle inline-block min-w-full sm:px-6 lg:px-8 space-y-6">
+            <div>
+              <%= @attempt.endpoint %>
+              Attempt: <%= @attempt.attempt %>
+              <%= @attempt.state %>
+              <%= @attempt.retry_at %>
+            </div>
+            <% if @attempt.request.present? %>
+              <%= render @attempt.request %>
+            <% else %>
+              No request.
+            <% end %>
+            <% if @attempt.response.present? %>
+              <%= render @attempt.response %>
+            <% else %>
+              No response.
+            <% end %>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/webhooks/endpoints/_endpoint.html.erb ADDED Viewed

@@ -0,0 +1,31 @@
+<tr>
+  <td class="px-6 py-4 whitespace-nowrap text-sm font-medium text-gray-900">
+    <%= link_to endpoint, endpoint %>
+  </td>
+  <td class="px-6 py-4 whitespace-nowrap text-sm text-gray-500">
+    <% if endpoint.enabled? %>
+      <span class="inline-flex items-center px-2 py-0.5 rounded text-xs font-medium bg-green-100 text-green-800">
+        Enabled
+      </span>
+    <% elsif endpoint.disabled? %>
+      <span class="inline-flex items-center px-2 py-0.5 rounded text-xs font-medium bg-red-100 text-red-800">
+        Disabled
+      </span>
+    <% else %>
+      <span class="inline-flex items-center px-2 py-0.5 rounded text-xs font-medium bg-gray-100 text-gray-800">
+        Error
+      </span>
+    <% end %>
+  </td>
+  <td class="px-6 py-4 whitespace-nowrap text-sm text-gray-500">
+    <% if endpoint.event_types.blank? %>
+      All events.
+    <% else %>
+      <%= pluralize endpoint.event_types.length, 'event' %>
+    <% end %>
+  </td>
+  <td class="px-6 py-4 whitespace-nowrap text-right text-sm font-medium sm:flex sm:items-center sm:justify-end space-x-3">
+    <%= link_to 'Edit', edit_endpoint_path(endpoint), class: 'text-indigo-600 hover:text-indigo-900' %>
+    <%= button_to 'Delete', endpoint_path(endpoint), method: 'delete', class: 'text-red-600 hover:text-red-900 bg-transparent cursor-pointer' %>
+  </td>
+</tr>

data/app/views/webhooks/endpoints/_form.html.erb ADDED Viewed

@@ -0,0 +1,42 @@
+<%= form_with model: @endpoint do |form| %>
+  <div class="space-y-6">
+    <div>
+      <%= form.label :url, 'URL', class: 'block text-sm font-medium text-gray-700' %>
+      <div class="mt-1">
+        <%= form.url_field :url, class: 'block w-full shadow-sm focus:ring-light-blue-500 focus:border-light-blue-500 sm:text-sm border-gray-300 rounded-md py-2 px-4', placeholder: 'https://example.com/webhook' %>
+      </div>
+    </div>
+    <div class="space-y-4">
+      <div>
+        <h2 class="text-lg leading-6 font-medium text-gray-900">Event Types</h2>
+        <p class="mt-1 text-sm text-gray-500">
+          Select the events you'd like to subscribe to for this endpoint. If no events are subscribed to, you will receive all events.
+        </p>
+      </div>
+      <div class="max-w-lg space-y-4">
+        <%= form.collection_check_boxes :event_types, Rails.application.config.webhooks.events.types, :to_s, :to_s, include_hidden: false do |b| %>
+        <div>
+          <div class="relative flex items-start">
+            <div class="flex items-center h-5">
+              <%= b.check_box class: 'focus:ring-indigo-500 h-4 w-4 text-indigo-600 border-gray-300 rounded' %>
+            </div>
+            <div class="ml-3 text-sm">
+              <%= b.label class: 'font-medium text-gray-700' %>
+              <p class="text-gray-500">
+                <%= t b.text, scope: %i[webhooks events types] %>
+              </p>
+            </div>
+          </div>
+        </div>
+        <% end %>
+        <%= form.hidden_field :event_types, multiple: true, value: '' %>
+      </div>
+    </div>
+    <div class="flex justify-end">
+      <%= link_to 'Cancel', endpoints_path, class: 'bg-white py-2 px-4 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 hover:bg-gray-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500' %>
+      <%= form.submit class: 'cursor-pointer ml-3 inline-flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-blue-500 hover:bg-blue-600 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500' %>
+    </div>
+  </div>
+<% end %>

data/app/views/webhooks/endpoints/edit.html.erb ADDED Viewed

@@ -0,0 +1,16 @@
+<div class="py-6">
+  <div class="max-w-7xl mx-auto px-4 sm:px-6 md:px-8">
+    <h1 class="text-2xl font-semibold text-gray-900">Edit Endpoint</h1>
+  </div>
+  <div class="max-w-7xl mx-auto px-4 sm:px-6 md:px-8">
+    <div class="py-4">
+      <div class="flex flex-col">
+        <div class="-my-2 overflow-x-auto sm:-mx-6 lg:-mx-8">
+          <div class="py-2 align-middle inline-block min-w-full sm:px-6 lg:px-8">
+            <%= render 'form' %>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/webhooks/endpoints/index.html.erb ADDED Viewed

@@ -0,0 +1,41 @@
+<div class="py-6">
+  <div class="max-w-7xl mx-auto px-4 sm:px-6 md:px-8 md:flex md:justify-between md:space-x-5">
+    <h1 class="text-2xl font-semibold text-gray-900">Endpoints</h1>
+    <div class="mt-6 flex flex-col-reverse justify-stretch space-y-4 space-y-reverse sm:flex-row-reverse sm:justify-end sm:space-x-reverse sm:space-y-0 sm:space-x-3 md:mt-0 md:flex-row md:space-x-3">
+      <%= link_to 'New Endpoint', new_endpoint_path, class: 'inline-flex items-center justify-center px-4 py-2 border border-transparent text-sm font-medium rounded-md shadow-sm text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-offset-gray-100 focus:ring-blue-500' %>
+    </div>
+  </div>
+  <div class="max-w-7xl mx-auto px-4 sm:px-6 md:px-8">
+    <div class="py-4">
+      <div class="flex flex-col">
+        <div class="-my-2 overflow-x-auto sm:-mx-6 lg:-mx-8">
+          <div class="py-2 align-middle inline-block min-w-full sm:px-6 lg:px-8">
+            <div class="shadow overflow-hidden border-b border-gray-200 sm:rounded-lg">
+              <table class="min-w-full divide-y divide-gray-200">
+                <thead class="bg-gray-50">
+                  <tr>
+                    <th scope="col" class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">
+                      URL
+                    </th>
+                    <th scope="col" class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">
+                      State
+                    </th>
+                    <th scope="col" class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">
+                      Event Types
+                    </th>
+                    <th scope="col" class="relative px-6 py-3">
+                      <span class="sr-only">Edit</span>
+                    </th>
+                  </tr>
+                </thead>
+                <tbody class="bg-white divide-y divide-gray-200">
+                  <%= render @endpoints %>
+                </tbody>
+              </table>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/webhooks/endpoints/new.html.erb ADDED Viewed

@@ -0,0 +1,16 @@
+<div class="py-6">
+  <div class="max-w-7xl mx-auto px-4 sm:px-6 md:px-8">
+    <h1 class="text-2xl font-semibold text-gray-900">New Endpoint</h1>
+  </div>
+  <div class="max-w-7xl mx-auto px-4 sm:px-6 md:px-8">
+    <div class="py-4">
+      <div class="flex flex-col">
+        <div class="-my-2 overflow-x-auto sm:-mx-6 lg:-mx-8">
+          <div class="py-2 align-middle inline-block min-w-full sm:px-6 lg:px-8">
+            <%= render 'form' %>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/webhooks/endpoints/show.html.erb ADDED Viewed

@@ -0,0 +1,102 @@
+<div class="py-6">
+  <div class="max-w-7xl mx-auto px-4 sm:px-6 md:px-8">
+    <div class="py-4">
+      <div class="flex flex-col">
+        <div class="-my-2 overflow-x-auto sm:-mx-6 lg:-mx-8">
+          <div class="py-2 align-middle inline-block min-w-full sm:px-6 lg:px-8 space-y-6">
+            <div class="bg-white shadow overflow-hidden sm:rounded-lg">
+              <div class="px-4 py-5 sm:px-6 sm:flex sm:items-center sm:justify-between">
+                <h3 class="text-lg leading-6 font-medium text-gray-900">
+                  <%= @endpoint %>
+                </h3>
+                <div class="mt-3 sm:mt-0 sm:ml-4">
+                  <%= link_to 'Edit', edit_endpoint_path(@endpoint), class: 'inline-flex items-center px-4 py-2 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-indigo-600 hover:bg-indigo-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-indigo-500' %>
+                </div>
+              </div>
+              <div class="border-t border-gray-200 px-4 py-5 sm:p-0">
+                <dl class="sm:divide-y sm:divide-gray-200">
+                  <div class="py-4 sm:py-5 sm:grid sm:grid-cols-3 sm:gap-4 sm:px-6">
+                    <dt class="text-sm font-medium text-gray-500">
+                      State
+                    </dt>
+                    <dd class="mt-1 text-sm text-gray-900 sm:mt-0 sm:col-span-2">
+                      <% if @endpoint.enabled? %>
+                        <span class="inline-flex items-center px-2 py-0.5 rounded text-xs font-medium bg-green-100 text-green-800">
+                          Enabled
+                        </span>
+                      <% elsif @endpoint.disabled? %>
+                        <span class="inline-flex items-center px-2 py-0.5 rounded text-xs font-medium bg-red-100 text-red-800">
+                          Disabled
+                        </span>
+                      <% else %>
+                        <span class="inline-flex items-center px-2 py-0.5 rounded text-xs font-medium bg-gray-100 text-gray-800">
+                          Error
+                        </span>
+                      <% end %>
+                    </dd>
+                  </div>
+                  <div class="py-4 sm:py-5 sm:grid sm:grid-cols-3 sm:gap-4 sm:px-6">
+                    <dt class="text-sm font-medium text-gray-500">
+                      Event types
+                    </dt>
+                    <dd class="mt-1 text-sm text-gray-900 sm:mt-0 sm:col-span-2">
+                      <% if @endpoint.event_types.blank? %>
+                        All events.
+                      <% else %>
+                        <%= @endpoint.event_types.to_sentence %>
+                      <% end %>
+                    </dd>
+                  </div>
+                  <div class="py-4 sm:py-5 sm:grid sm:grid-cols-3 sm:gap-4 sm:px-6">
+                    <dt class="text-sm font-medium text-gray-500">
+                      Secret
+                    </dt>
+                    <dd class="mt-1 text-sm text-gray-900 sm:mt-0 sm:col-span-2">
+                      <%= @endpoint.secret %>
+                    </dd>
+                  </div>
+                </dl>
+              </div>
+            </div>
+            <div>
+              <h3 class="text-lg leading-6 font-medium text-gray-900">
+                Attempts
+              </h3>
+              <p class="mt-2 max-w-4xl text-sm text-gray-500">
+                All webhook delivery attempts and their status.
+              </p>
+            </div>
+            <div class="shadow overflow-hidden border-b border-gray-200 sm:rounded-lg">
+              <table class="min-w-full divide-y divide-gray-200">
+                <thead class="bg-gray-50">
+                  <tr>
+                    <th scope="col" class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">
+                      State
+                    </th>
+                    <th scope="col" class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">
+                      Event Type
+                    </th>
+                    <th scope="col" class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">
+                      Endpoint
+                    </th>
+                    <th scope="col" class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">
+                      Created
+                    </th>
+                    <th scope="col" class="relative px-6 py-3">
+                      <span class="sr-only">Edit</span>
+                    </th>
+                  </tr>
+                </thead>
+                <tbody class="bg-white divide-y divide-gray-200">
+                  <%= render @endpoint.attempts.order(created_at: :desc) %>
+                </tbody>
+              </table>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>