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/views/webhooks/events/_event.html.erb ADDED Viewed

@@ -0,0 +1,11 @@
+<tr>
+  <td class="px-6 py-4 whitespace-nowrap text-sm font-medium text-gray-900">
+    <%= event %>
+  </td>
+  <td class="px-6 py-4 whitespace-nowrap text-sm text-gray-500">
+    <%= event.event %>
+  </td>
+  <td class="px-6 py-4 whitespace-nowrap text-sm text-gray-500 text-right">
+    <%= link_to event.created_at, event %>
+  </td>
+</tr>

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

@@ -0,0 +1,38 @@
+<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">Events</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 Event', new_event_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">
+                      Event Type
+                    </th>
+                    <th scope="col" class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">
+                      Event
+                    </th>
+                    <th scope="col" class="px-6 py-3 text-right text-xs font-medium text-gray-500 uppercase tracking-wider">
+                      Timestamp
+                    </th>
+                  </tr>
+                </thead>
+                <tbody class="bg-white divide-y divide-gray-200">
+                  <%= render @events %>
+                </tbody>
+              </table>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,35 @@
+<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 Event</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">
+            <%= form_with model: @event do |form| %>
+              <div class="space-y-6">
+                <div>
+                  <%= form.label :event_type, class: 'block text-sm font-medium text-gray-700' %>
+                  <%= form.collection_select :event_type, Rails.application.config.webhooks.events.types, :to_s, :to_s, prompt: true, class: "select" %>
+                </div>
+                <div>
+                  <%= form.label :event, class: 'block text-sm font-medium text-gray-700' %>
+                  <div class="mt-1">
+                    <%= form.text_area :event, value: '{"action":"user.created"}', rows: 25, 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 font-mono', placeholder: 'https://example.com/webhook' %>
+                  </div>
+                </div>
+                <div class="flex justify-end">
+                  <%= link_to 'Cancel', events_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 'Create Event', 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 %>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,49 @@
+<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"><%= @event %></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">
+            <pre><%= @event.event %></pre>
+            <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">
+                      Status
+                    </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="relative px-6 py-3">
+                      <span class="sr-only">Edit</span>
+                    </th>
+                  </tr>
+                </thead>
+                <tbody class="bg-white divide-y divide-gray-200">
+                  <%= render @event.attempts.order(created_at: :desc) %>
+                </tbody>
+              </table>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/webhooks/requests/_request.html.erb ADDED Viewed

@@ -0,0 +1,47 @@
+<div class="space-y-6">
+  <div>
+    <h3 class="text-lg leading-6 font-medium text-gray-900">
+      Request
+    </h3>
+    <p class="mt-2 max-w-4xl text-sm text-gray-500">
+      The request delivered to <%= @attempt.endpoint %>
+    </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">
+            Header
+          </th>
+          <th scope="col" class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">
+            Value
+          </th>
+        </tr>
+      </thead>
+      <tbody class="bg-white divide-y divide-gray-200">
+        <% request.headers.each do |key, value| %>
+          <tr>
+            <td class="px-6 py-4 whitespace-nowrap text-sm font-medium text-gray-900">
+              <%= key %>
+            </td>
+            <td class="px-6 py-4 whitespace-nowrap text-sm text-gray-500">
+              <%= value %>
+            </td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+  <div>
+    <h3 class="text-lg leading-6 font-medium text-gray-900">
+      Request Body
+    </h3>
+    <p class="mt-2 max-w-4xl text-sm text-gray-500">
+      The request delivered to <%= @attempt.endpoint %>
+    </p>
+  </div>
+  <div class="bg-white shadow overflow-hidden border-b border-gray-200 sm:rounded-lg px-6 py-3"><pre><%= request.body %></pre></div>
+</div>

data/app/views/webhooks/responses/_response.html.erb ADDED Viewed

@@ -0,0 +1,55 @@
+<div class="space-y-6">
+  <div>
+    <h3 class="text-lg leading-6 font-medium text-gray-900">
+      Response
+    </h3>
+    <p class="mt-2 max-w-4xl text-sm text-gray-500">
+      The response headers received from <%= response.endpoint %>
+    </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">
+            Header
+          </th>
+          <th scope="col" class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">
+            Value
+          </th>
+        </tr>
+      </thead>
+      <tbody class="bg-white divide-y divide-gray-200">
+        <tr>
+          <td class="px-6 py-4 whitespace-nowrap text-sm font-medium text-gray-900">
+            Status
+          </td>
+          <td class="px-6 py-4 whitespace-nowrap text-sm text-gray-500">
+            <%= response.status_code %>
+          </td>
+        </tr>
+        <% response.headers.each do |key, value| %>
+          <tr>
+            <td class="px-6 py-4 whitespace-nowrap text-sm font-medium text-gray-900">
+              <%= key %>
+            </td>
+            <td class="px-6 py-4 whitespace-nowrap text-sm text-gray-500">
+              <%= value %>
+            </td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+  <div>
+    <h3 class="text-lg leading-6 font-medium text-gray-900">
+      Response Body
+    </h3>
+    <p class="mt-2 max-w-4xl text-sm text-gray-500">
+      The response body received from <%= response.endpoint %>
+    </p>
+  </div>
+  <div class="bg-white shadow overflow-hidden border-b border-gray-200 sm:rounded-lg px-6 py-3"><pre><%= response.body %></pre></div>
+</div>

data/app/views/webhooks/shared/_navigation.html.erb ADDED Viewed

@@ -0,0 +1,100 @@
+<!-- Off-canvas menu for mobile, show/hide based on off-canvas menu state. -->
+<div class="fixed inset-0 flex z-40 md:hidden" role="dialog" aria-modal="true">
+  <!--
+    Off-canvas menu overlay, show/hide based on off-canvas menu state.
+    Entering: "transition-opacity ease-linear duration-300"
+      From: "opacity-0"
+      To: "opacity-100"
+    Leaving: "transition-opacity ease-linear duration-300"
+      From: "opacity-100"
+      To: "opacity-0"
+  -->
+  <div class="fixed inset-0 bg-gray-600 bg-opacity-75" aria-hidden="true"></div>
+  <!--
+    Off-canvas menu, show/hide based on off-canvas menu state.
+    Entering: "transition ease-in-out duration-300 transform"
+      From: "-translate-x-full"
+      To: "translate-x-0"
+    Leaving: "transition ease-in-out duration-300 transform"
+      From: "translate-x-0"
+      To: "-translate-x-full"
+  -->
+  <div class="relative flex-1 flex flex-col max-w-xs w-full bg-white">
+    <!--
+      Close button, show/hide based on off-canvas menu state.
+      Entering: "ease-in-out duration-300"
+        From: "opacity-0"
+        To: "opacity-100"
+      Leaving: "ease-in-out duration-300"
+        From: "opacity-100"
+        To: "opacity-0"
+    -->
+    <div class="absolute top-0 right-0 -mr-12 pt-2">
+      <button class="ml-1 flex items-center justify-center h-10 w-10 rounded-full focus:outline-none focus:ring-2 focus:ring-inset focus:ring-white">
+        <span class="sr-only">Close sidebar</span>
+        <!-- Heroicon name: outline/x -->
+        <svg class="h-6 w-6 text-white" 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="M6 18L18 6M6 6l12 12" />
+        </svg>
+      </button>
+    </div>
+    <div class="flex-1 h-0 pt-5 pb-4 overflow-y-auto">
+      <div class="flex-shrink-0 flex items-center px-4">
+        Webhooks
+      </div>
+      <nav class="mt-5 px-2 space-y-1">
+        <%= link_to endpoints_path, class: 'text-gray-600 hover:bg-gray-50 hover:text-gray-900 group flex items-center px-2 py-2 text-base font-medium rounded-md' do %>
+          <svg class="text-gray-500 mr-4 flex-shrink-0 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="M3 12l2-2m0 0l7-7 7 7M5 10v10a1 1 0 001 1h3m10-11l2 2m-2-2v10a1 1 0 01-1 1h-3m-6 0a1 1 0 001-1v-4a1 1 0 011-1h2a1 1 0 011 1v4a1 1 0 001 1m-6 0h6" />
+          </svg>
+          Endpoints
+        <% end %>
+        <%= link_to events_path, class: 'text-gray-600 hover:bg-gray-50 hover:text-gray-900 group flex items-center px-2 py-2 text-base font-medium rounded-md' do %>
+          <svg class="text-gray-500 mr-4 flex-shrink-0 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="M3 12l2-2m0 0l7-7 7 7M5 10v10a1 1 0 001 1h3m10-11l2 2m-2-2v10a1 1 0 01-1 1h-3m-6 0a1 1 0 001-1v-4a1 1 0 011-1h2a1 1 0 011 1v4a1 1 0 001 1m-6 0h6" />
+          </svg>
+          Events
+        <% end %>
+      </nav>
+    </div>
+  </div>
+  <div class="flex-shrink-0 w-14">
+    <!-- Force sidebar to shrink to fit close icon -->
+  </div>
+</div>
+<!-- Static sidebar for desktop -->
+<div class="hidden md:flex md:flex-shrink-0">
+  <div class="flex flex-col w-64">
+    <!-- Sidebar component, swap this element with another sidebar if you like -->
+    <div class="flex flex-col h-0 flex-1 border-r border-gray-200 bg-white">
+      <div class="flex-1 flex flex-col pt-5 pb-4 overflow-y-auto">
+        <div class="flex items-center flex-shrink-0 px-4">
+          Webhooks
+        </div>
+        <nav class="mt-5 flex-1 px-2 bg-white space-y-1">
+          <%= link_to endpoints_path, class: 'text-gray-600 hover:bg-gray-50 hover:text-gray-900 group flex items-center px-2 py-2 text-sm font-medium rounded-md' do %>
+            <svg class="text-gray-500 mr-3 flex-shrink-0 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="M3 12l2-2m0 0l7-7 7 7M5 10v10a1 1 0 001 1h3m10-11l2 2m-2-2v10a1 1 0 01-1 1h-3m-6 0a1 1 0 001-1v-4a1 1 0 011-1h2a1 1 0 011 1v4a1 1 0 001 1m-6 0h6" />
+            </svg>
+            Endpoints
+          <% end %>
+          <%= link_to events_path, class: 'text-gray-600 hover:bg-gray-50 hover:text-gray-900 group flex items-center px-2 py-2 text-sm font-medium rounded-md' do %>
+            <svg class="text-gray-500 mr-3 flex-shrink-0 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="M3 12l2-2m0 0l7-7 7 7M5 10v10a1 1 0 001 1h3m10-11l2 2m-2-2v10a1 1 0 01-1 1h-3m-6 0a1 1 0 001-1v-4a1 1 0 011-1h2a1 1 0 011 1v4a1 1 0 001 1m-6 0h6" />
+            </svg>
+            Events
+          <% end %>
+        </nav>
+      </div>
+    </div>
+  </div>
+</div>

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+Webhooks::Engine.routes.draw do
+  resources :endpoints
+  resources :events, only: %i[index new show create]
+  resources :attempts, only: :show do
+    member do
+      post :reattempt
+    end
+  end
+  get '/' => redirect('/endpoints')
+end

data/db/migrate/20210518022959_create_webhooks_endpoints.rb ADDED Viewed

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+class CreateWebhooksEndpoints < ActiveRecord::Migration[6.1]
+  def change
+    create_table :webhooks_endpoints do |t|
+      t.string :url, null: false, limit: 256
+      t.string :event_types, array: true, null: true
+      t.integer :state, null: false, default: 0
+      t.string :secret, null: false
+      t.timestamps null: false, precision: 6
+      t.index :url, unique: true
+      t.index :secret, unique: true
+    end
+  end
+end

data/db/migrate/20210518043350_create_webhooks_events.rb ADDED Viewed

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+class CreateWebhooksEvents < ActiveRecord::Migration[6.1]
+  def change
+    create_table :webhooks_events do |t|
+      t.string :event_type, null: false
+      t.json :event, null: false, default: {}
+      t.timestamps null: false, precision: 6
+    end
+  end
+end

data/db/migrate/20210518050123_create_webhooks_attempts.rb ADDED Viewed

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+class CreateWebhooksAttempts < ActiveRecord::Migration[6.1]
+  def change
+    reversible do |direction|
+      direction.up do
+        execute <<-SQL.squish
+          DROP INDEX IF EXISTS index_webhooks_attempts_on_endpoint_id_and_event_id_and_attempt;
+        SQL
+      end
+    end
+    create_table :webhooks_attempts do |t|
+      t.belongs_to :webhooks_endpoint, null: false, foreign_key: true
+      t.belongs_to :webhooks_event, null: false, foreign_key: true
+      # Was this attempt triggered manually?
+      t.boolean :manual, null: false, default: false
+      t.integer :state, null: false, default: 0
+      t.integer :attempt, null: false, default: 1
+      t.datetime :retry_at, null: true, precision: 6
+      t.timestamps null: false, precision: 6
+      t.index %i[webhooks_endpoint_id webhooks_event_id attempt], unique: true, name: 'index_webhooks_attempts_on_endpoint_id_and_event_id_and_attempt'
+    end
+    reversible do |direction|
+      direction.up do
+        execute <<-SQL.squish
+          CREATE UNIQUE INDEX index_webhooks_attempts_on_endpoint_id_and_event_id_and_attempt ON webhooks_attempts ("webhooks_endpoint_id", "webhooks_event_id", "attempt") WHERE "manual" = 'f';
+        SQL
+      end
+    end
+  end
+end

data/db/migrate/20210518054916_create_webhooks_requests.rb ADDED Viewed

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+class CreateWebhooksRequests < ActiveRecord::Migration[6.1]
+  def change
+    create_table :webhooks_requests do |t|
+      t.belongs_to :webhooks_attempt, null: false, foreign_key: true, index: { unique: true }
+      t.json :headers, null: false
+      t.json :body, null: false
+      t.datetime :created_at, null: false, precision: 6
+    end
+  end
+end