fuik 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b6a7e1fbd1184f851bc0d1cd17013aaf4d84575e8e33ad6db6c16b7a428b3c2
-  data.tar.gz: 41ffd19e734216ca8b5503b461ffb600e9749de0610e27899c7b672922a25ae0
+  metadata.gz: 5c68174e847f42afee9dab0fd8777877a9b53d6166942e493b069006eddd44af
+  data.tar.gz: 68bb2bec0d47a7f347150ecca7330b63dd304fda52d14fca1250d7279fd56978
 SHA512:
-  metadata.gz: 2f232b48c331815d4aa07fe0796ba7cecddeab26a835950ac1e874c5a602de8a76ad73eedd0c58dfdd0f7f7d6850205989666434ef1e76f3f709cb7297e3c710
-  data.tar.gz: 229f5f61ec154a18e2213f3131150c3013430f1025457db1a91d84cfe4bab680c13cdb815152544b84ae32483bf6a3293c3d00a591b5f08da95258d42e330209
+  metadata.gz: 128b403d2748c3bf8fb268d980a946335ad98043a70c38022b717f4d367ac09c88a93984a12802400443ba2634c2f3a6a869da3f00741d61b930f25343d84f2a
+  data.tar.gz: '0809ff55133946fcc8c0e80849a9ad77c0e36c3c9ee951cd1b58a6e7be5b90ed67c5d3c7819c127f8be977b26c2e4c926e3b5a053cddd1c1638cbe063d3b6423'

data/README.md

@@ -4,6 +4,8 @@
 
 Fuik (Dutch for fish trap) is a Rails engine that catches and stores webhooks from any provider. View all events in the admin interface, then create event classes to add your business logic.
 
+<img alt="Fuik admin interface" src="https://raw.githubusercontent.com/Rails-Designer/fuik/HEAD/.github/docs/webhooks-index.jpg" style="max-width: 100%;">
+
 
 **Sponsored By [Rails Designer](https://railsdesigner.com/)**
 
@@ -54,7 +56,9 @@ The engine mounts at `/webhooks` automatically.
 
 Visit `/webhooks` to see all received webhooks. Click any event to see the full payload, headers and status.
 
-<img alt="Fuik admin interface" src="https://raw.githubusercontent.com/Rails-Designer/fuik/HEAD/.github/docs/webhooks-index.jpg" style="max-width: 100%;">
+<img alt="Fuik event detail interface" src="https://raw.githubusercontent.com/Rails-Designer/fuik/HEAD/.github/docs/event-detail.jpg" style="max-width: 100%;">
+
+⚠️ The `/webhooks` path is by default not protected. Easiest is to set `Fuik::Engine.config.events_controller_parent` to a controller that requires authentication.
 
 
 ### Add business logic
@@ -112,7 +116,7 @@ If `Provider::Base.verify!` exists, Fuik calls it automatically. Invalid signatu
 
 ### Pre-packaged providers
 
-Fuik includes ready-to-use [templates for common providers](https://github.com/Rails-Desinger/fuik/tree/main/lib/generators/fuik/provider/templates).
+Fuik includes ready-to-use [templates for common providers](https://github.com/Rails-Designer/fuik/tree/main/lib/generators/fuik/provider/templates).
 
 
 ### Event type & ID lookup
@@ -148,7 +152,7 @@ event_id:
 
 ## Add your custom provider
 
-Have a provider template others could use? Add it to [lib/generators/fuik/provider/templates/your_provider/](https://github.com/Rails-Desinger/fuik/tree/main/lib/generators/fuik/provider/templates) and submit a PR!
+Have a provider template others could use? Add it to [lib/generators/fuik/provider/templates/your_provider/](https://github.com/Rails-Designer/fuik/tree/main/lib/generators/fuik/provider/templates) and submit a PR!
 
 Include:
 - `base.rb.tt` with signature verification (if applicable);

data/app/assets/stylesheets/fuik/application.css

@@ -8,18 +8,20 @@
     --color-bg-hover: oklch(97% 0.01 250);
   }
 
-  * { box-sizing: border-box; }
+  * { box-sizing: border-box; margin: 0; padding: 0; }
 
   body {
-    margin: 0;
-    padding: 2rem;
-    max-inline-size: 80rem;
-    margin-inline: auto;
     font-family: system-ui, -apple-system, sans-serif;
     line-height: 1.5;
     color: var(--color-text);
   }
 
+  main {
+    padding: 2rem;
+    max-inline-size: 80rem;
+    margin-inline: auto;
+  }
+
   h1 {
     margin-block-end: 1rem;
     font-size: 1.875rem;
@@ -49,19 +51,49 @@
     background: var(--color-bg-hover);
     border-radius: .5rem;
     overflow-x: auto;
+    }
   }
 
   dl {
     display: grid;
     grid-template-columns: auto 1fr;
     gap: 1rem 2rem;
+    overflow: hidden;
 
     dt {
       font-weight: 600;
       color: var(--color-text);
     }
 
-    dd { margin: 0; }
+    dd {
+      position: relative;
+      overflow-x: auto;
+    }
+  }
+
+  .copy-button {
+    padding: .125rem;
+    color: oklch(from var(--color-text) l c h / 80%);
+    background: var(--color-bg);
+    border: 0;
+    border-radius: .25rem;
+    cursor: pointer;
+
+    &:hover {
+      color: oklch(from var(--color-text) l c h);
+      transition: transform ease-in-out 300ms;
+      transform: scale(1.10);
+    }
+
+    &[position="fixed"] {
+      position: absolute;
+      top: .5rem; right: .5rem;
+    }
+
+    svg {
+      width: 1rem;
+      aspect-ratio: 1 / 1;
+    }
   }
 }
 

data/app/controllers/fuik/webhooks_controller.rb

@@ -59,7 +59,7 @@ module Fuik
     end
 
     def event_class_for(provider, event_type)
-      "#{provider.camelize}::#{event_type.tr("./:-", "_").camelize}".safe_constantize
+      "#{provider.camelize}::#{event_type.tr("./:-[]", "_").camelize}".safe_constantize
     end
 
     def should_verify? = base_class&.respond_to?(:verify!)

data/app/views/fuik/events/_copy_button.html.erb

@@ -0,0 +1,6 @@
+<%# locals: (target:, delay: 5000, position: :relative) %>
+<button data-action="copy" data-target="<%= target %>" data-copy-delay="<%= delay %>" position="<%= position %>" class="copy-button">
+  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor" aria-hidden="true" data-slot="icon" stroke-width="">
+    <path fill-rule="evenodd" d="M13.887 3.182c.396.037.79.08 1.183.128C16.194 3.45 17 4.414 17 5.517V16.75A2.25 2.25 0 0 1 14.75 19h-9.5A2.25 2.25 0 0 1 3 16.75V5.517c0-1.103.806-2.068 1.93-2.207.393-.048.787-.09 1.183-.128A3.001 3.001 0 0 1 9 1h2c1.373 0 2.531.923 2.887 2.182ZM7.5 4A1.5 1.5 0 0 1 9 2.5h2A1.5 1.5 0 0 1 12.5 4v.5h-5V4Z" clip-rule="evenodd" ></path>
+  </svg>
+</button>

data/app/views/fuik/events/show.html.erb

@@ -7,7 +7,7 @@
   <dd><%= @webhook_event.provider %></dd>
 
   <dt>Event ID</dt>
-  <dd><%= @webhook_event.event_id %></dd>
+  <dd><%= tag.code @webhook_event.event_id, id: "event_id" %> <%= render "copy_button", target: "#event_id" %></dd>
 
   <dt>Type</dt>
   <dd><%= @webhook_event.event_type %></dd>
@@ -19,10 +19,10 @@
   <dd><%= @webhook_event.created_at.strftime("%Y-%m-%d %H:%M:%S") %></dd>
 
   <dt>Payload</dt>
-  <dd><pre><%= JSON.pretty_generate(@webhook_event.payload) %></pre></dd>
+  <dd><pre id="payload"><%= JSON.pretty_generate(@webhook_event.payload) %></pre> <%= render "copy_button", target: "#payload", position: :fixed %></dd>
 
   <dt>Headers</dt>
-  <dd><pre><%= JSON.pretty_generate(@webhook_event.headers) %></pre></dd>
+  <dd><pre id="headers"><%= JSON.pretty_generate(@webhook_event.headers) %></pre> <%= render "copy_button", target: "#headers", position: :fixed %></dd>
 
   <% if @webhook_event.error.present? %>
     <dt>Error</dt>

data/app/views/layouts/fuik/application.html.erb

@@ -8,10 +8,11 @@
   <%= yield :head %>
 
   <%= stylesheet_link_tag "fuik/application", media: "all" %>
+  <script defer src="https://cdn.jsdelivr.net/npm/attractivejs@0.11.0"></script>
 </head>
 <body>
-
-<%= yield %>
-
+  <main>
+    <%= yield %>
+  </main>
 </body>
 </html>

data/lib/fuik/version.rb

@@ -1,3 +1,3 @@
 module Fuik
-  VERSION = "0.5.0"
+  VERSION = "0.7.0"
 end

data/lib/generators/fuik/install/install_generator.rb

@@ -12,10 +12,6 @@ module Fuik
       def add_route
         route 'mount Fuik::Engine => "/webhooks"'
       end
-
-      def show_readme
-        readme "README" if behavior == :invoke
-      end
     end
   end
 end

data/lib/generators/fuik/provider/provider_generator.rb

@@ -9,7 +9,11 @@ module Fuik
       argument :event_names, type: :array, default: []
 
       def create_base_class
-        template "base.rb.tt", "app/webhooks/#{file_name}/base.rb"
+        if packaged_base_exists?
+          template packaged_base_template_path, "app/webhooks/#{file_name}/base.rb"
+        else
+          template "base.rb.tt", "app/webhooks/#{file_name}/base.rb"
+        end
       end
 
       def create_event_classes
@@ -26,6 +30,14 @@ module Fuik
 
       private
 
+      def packaged_base_exists?
+        File.exist?(packaged_base_template_path)
+      end
+
+      def packaged_base_template_path
+        File.join(self.class.source_root, file_name, "base.rb.tt")
+      end
+
       def packaged_event_exists? = File.exist?(packaged_event_template_path)
 
       def copy_packaged_event
@@ -38,7 +50,7 @@ module Fuik
 
       def packaged_event_template_path = File.join(self.class.source_root, "providers", file_name, "#{event_file_name}.rb.tt")
 
-      def event_file_path = Rails.join("app", "webhooks", file_name, "#{event_file_name}.rb")
+      def event_file_path = Rails.root.join("app", "webhooks", file_name, "#{event_file_name}.rb")
 
       def event_file_name = @event_name.underscore
 

data/lib/generators/fuik/provider/templates/github/base.rb.tt

@@ -1,7 +1,7 @@
 module <%= provider_module_name %>
   class Base < Fuik::Event
     def self.verify!(request)
-      secret = Rails.application.credentials.dig(:webhooks, :github, :secret)
+      secret = Rails.application.credentials.dig(:github, :secret)
       signature = request.headers["X-Hub-Signature-256"]
       expected_signature = "sha256=" + OpenSSL::HMAC.hexdigest("SHA256", secret, request.raw_post)
 

data/lib/generators/fuik/provider/templates/mailpace/base.rb.tt

@@ -1,7 +1,7 @@
 module <%= provider_module_name %>
   class Base < Fuik::Event
     def self.verify!(request)
-      public_key_base64 = Rails.application.credentials.dig(:webhooks, :mailpace, :public_key)
+      public_key_base64 = Rails.application.credentials.dig(:mailpace, :public_key)
       signature_base64 = request.headers["X-MailPace-Signature"]
 
       verify_key = Ed25519::VerifyKey.new(Base64.strict_decode64(public_key_base64))

data/lib/generators/fuik/provider/templates/stripe/base.rb.tt

@@ -1,7 +1,7 @@
 module <%= provider_module_name %>
   class Base < Fuik::Event
     def self.verify!(request)
-      secret = Rails.application.credentials.dig(:webhooks, :stripe, :secret)
+      secret = Rails.application.credentials.dig(:stripe, :signing_secret)
       signature = request.headers["Stripe-Signature"]
 
       Stripe::Webhook.construct_event(

data/lib/generators/fuik/provider/templates/stripe/checkout_session_completed.rb.tt

@@ -1,12 +1,14 @@
-module <%= provider_module_name %>
-  class <%= event_class_name %> < Base
+module Stripe
+  class CheckoutSessionCompleted < Base
     def process!
-      session_id = payload.dig("data", "object", "id")
-
       # TODO: Add business logic
       # session = Stripe::Checkout::Session.retrieve(session_id) # this assumes the Stripe gem is available
 
       @webhook_event.processed!
     end
+
+    private
+
+    def session_id = payload.dig("data", "object", "id")
   end
 end

data/lib/generators/fuik/provider/templates/stripe/customer_subscription_deleted.rb.tt

@@ -1,5 +1,5 @@
-module <%= provider_module_name %>
-  class <%= event_class_name %> < Base
+module Stripe
+  class CustomerSubscriptionDeleted < Base
     def process!
       subscription_id = payload.dig("data", "object", "id")
 

data/lib/generators/fuik/provider/templates/stripe/customer_subscription_updated.rb.tt

@@ -1,11 +1,13 @@
-module <%= provider_module_name %>
-  class <%= event_class_name %> < Base
+module Stripe
+  class CustomerSubscriptionUpdated < Base
     def process!
-      subscription_id = payload.dig("data", "object", "id")
-
       # TODO: Add business logic
 
       @webhook_event.processed!
     end
+
+    private
+
+    def subscription_id = payload.dig("data", "object", "id")
   end
 end

data/lib/generators/fuik/provider/templates/stripe/payment_intent_succeeded.rb.tt

@@ -0,0 +1,13 @@
+module Stripe
+  class PaymentIntentSucceeded < Base
+    def process!
+      # TODO: Add business logic
+
+      @webhook_event.processed!
+    end
+
+    private
+
+    def payment_intent_id = payload["data"]["object"]["id"]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fuik
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Rails Designer
@@ -23,7 +23,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.0
-description: TBD
+description: Fuik (Dutch for fish trap) is a Rails engine that catches and stores
+  webhooks from any provider. View all events in the admin interface, then create
+  event classes to add your business logic.
 email:
 - devs@railsdesigner.com
 executables: []
@@ -42,6 +44,7 @@ files:
 - app/models/fuik/application_record.rb
 - app/models/fuik/event.rb
 - app/models/fuik/webhook_event.rb
+- app/views/fuik/events/_copy_button.html.erb
 - app/views/fuik/events/index.html.erb
 - app/views/fuik/events/show.html.erb
 - app/views/layouts/fuik/application.html.erb
@@ -51,7 +54,6 @@ files:
 - lib/fuik/engine.rb
 - lib/fuik/version.rb
 - lib/generators/fuik/install/install_generator.rb
-- lib/generators/fuik/install/templates/README
 - lib/generators/fuik/provider/provider_generator.rb
 - lib/generators/fuik/provider/templates/README
 - lib/generators/fuik/provider/templates/base.rb.tt
@@ -67,6 +69,7 @@ files:
 - lib/generators/fuik/provider/templates/stripe/checkout_session_completed.rb.tt
 - lib/generators/fuik/provider/templates/stripe/customer_subscription_deleted.rb.tt
 - lib/generators/fuik/provider/templates/stripe/customer_subscription_updated.rb.tt
+- lib/generators/fuik/provider/templates/stripe/payment_intent_succeeded.rb.tt
 homepage: https://railsdesigner.com/fuik/
 licenses:
 - MIT
@@ -87,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.0
+rubygems_version: 4.0.4
 specification_version: 4
-summary: TBD
+summary: A fish trap for webhooks
 test_files: []

data/lib/generators/fuik/install/templates/README

@@ -1,24 +0,0 @@
-===============================================================================
-
-Fuik has been installed! 🎣
-
-Next steps:
-
-  1. Run migrations:
-     rails db:migrate
-
-  2. Webhooks can be sent to:
-     POST /webhooks/:provider
-
-     Example: POST /webhooks/stripe
-
-  3. (Optional) Generate webhook class for a provider:
-     rails generate fuik:provider stripe checkout_session_completed
-
-     Or start from scratch:
-     rails generate fuik:provider custom_provider my_event
-
-  4. View received webhooks at:
-     GET /webhooks
-
-===============================================================================