fuik 0.11.0 → 0.13.0

data/lib/fuik.rb

@@ -1,7 +1,16 @@
+# frozen_string_literal: true
+
 require "fuik/version"
+require "fuik/errors"
+require "fuik/configuration"
 require "fuik/dot_access"
+require "fuik/notifications"
 require "fuik/engine"
 
 module Fuik
   class InvalidSignature < StandardError; end
+
+  def self.deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new("1.0", "Fuik")
+  end
 end

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

@@ -1,8 +1,17 @@
 module <%= provider_module_name %>
   class Base < Fuik::Event
     # def self.verify!(request)
-      # TODO: Implement signature verification
-      # raise Fuik::InvalidSignature # only raise when signature is invalid
+    #   # TODO: Implement signature verification
+    #   # raise Fuik::InvalidSignature # only raise when signature is invalid
     # end
+
+    # Override if Fuik can't find the event type or id on its own:
+    #
+    # event_type header: "X-Custom-Event"
+    # event_type payload: "event_type"
+    # event_type "always_this_value"
+    #
+    # event_id header: "X-Custom-Id"
+    # event_id payload: "id"
   end
 end

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

@@ -1,5 +1,8 @@
 module <%= provider_module_name %>
   class Base < Fuik::Event
+    event_type header: "X-Github-Event"
+    event_id   header: "X-GitHub-Delivery"
+
     def self.verify!(request)
       secret = Rails.application.credentials.dig(:github, :secret)
       signature = request.headers["X-Hub-Signature-256"]

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

@@ -0,0 +1,32 @@
+module <%= provider_module_name %>
+  class Base < Fuik::Event
+    def self.verify!(request)
+      secret = Rails.application.credentials.dig(:lettermint, :signing_secret)
+      signature_header = request.headers["X-Lettermint-Signature"] || ""
+
+      elements = {}
+      signature_header.split(",").each do |element|
+        key, value = element.split("=", 2)
+
+        elements[key] = value if key && value
+      end
+
+      timestamp = elements["t"]
+      signature = elements["v1"]
+
+      raise Fuik::InvalidSignature if timestamp.blank? || signature.blank?
+
+      now = Time.current.to_i
+      raise Fuik::InvalidSignature if (now - timestamp.to_i).abs > TOLERANCE
+
+      signed_payload = "#{timestamp}.#{request.raw_post}"
+      expected = OpenSSL::HMAC.hexdigest("SHA256", secret, signed_payload)
+
+      raise Fuik::InvalidSignature unless ActiveSupport::SecurityUtils.secure_compare(expected, signature)
+    end
+
+    private
+
+    TOLERANCE = 5.minutes
+  end
+end

data/lib/generators/fuik/provider/templates/lettermint/message_failed.rb.tt

@@ -0,0 +1,16 @@
+module <%= provider_module_name %>
+  class MessageFailed < Base
+    def process!
+      # payload.data.recipient  # email address that failed
+      # payload.data.reason  # failure reason (e.g., "A network error occurred.")
+      # payload.data.response.status_code  # SMTP status code
+      # payload.data.subject  # email subject
+      # payload.data.message_id  # message UUID
+      # payload.data.tag  # message tag (or nil)
+
+      # TODO: Add business logic
+
+      @webhook_event.processed!
+    end
+  end
+end

data/lib/generators/fuik/provider/templates/lettermint/message_hard_bounced.rb.tt

@@ -0,0 +1,16 @@
+module <%= provider_module_name %>
+  class MessageHardBounced < Base
+    def process!
+      # payload.data.recipient  # email address that hard bounced
+      # payload.data.response.enhanced_status_code  # SMTP enhanced status code (e.g., "5.1.1")
+      # payload.data.response.content  # SMTP response text (e.g., "User unknown")
+      # payload.data.subject  # email subject
+      # payload.data.message_id  # message UUID
+      # payload.data.tag  # message tag (or nil)
+
+      # TODO: Add business logic
+
+      @webhook_event.processed!
+    end
+  end
+end

data/lib/generators/fuik/provider/templates/lettermint/message_soft_bounced.rb.tt

@@ -0,0 +1,16 @@
+module <%= provider_module_name %>
+  class MessageSoftBounced < Base
+    def process!
+      # payload.data.recipient  # email address that soft bounced
+      # payload.data.response.enhanced_status_code  # SMTP enhanced status code (e.g., "4.2.2")
+      # payload.data.response.content  # SMTP response text (e.g., "Mailbox full")
+      # payload.data.subject  # email subject
+      # payload.data.message_id  # message UUID
+      # payload.data.tag  # message tag (or nil)
+
+      # TODO: Add business logic
+
+      @webhook_event.processed!
+    end
+  end
+end

data/lib/generators/fuik/provider/templates/lettermint/message_suppressed.rb.tt

@@ -0,0 +1,15 @@
+module <%= provider_module_name %>
+  class MessageSuppressed < Base
+    def process!
+      # payload.data.recipient  # email address that was suppressed
+      # payload.data.reason  # suppression reason (e.g., "hard_bounce", "spam_complaint")
+      # payload.data.subject  # email subject
+      # payload.data.message_id  # message UUID
+      # payload.data.tag  # message tag (or nil)
+
+      # TODO: Add business logic
+
+      @webhook_event.processed!
+    end
+  end
+end

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

@@ -1,5 +1,7 @@
 module <%= provider_module_name %>
   class Base < Fuik::Event
+    event_id header: "webhook-id"
+
     def self.verify!(request)
       secret = Rails.application.credentials.dig(:loops, :signing_secret)
       secret_bytes = Base64.strict_decode64(secret.split("_")[1])

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

@@ -1,4 +1,5 @@
 module <%= provider_module_name %>
   class Base < Fuik::Event
+    event_type header: "X-Postmark-Event"
   end
 end

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

@@ -0,0 +1,4 @@
+module <%= provider_module_name %>
+  class Base < Fuik::Event
+  end
+end

data/lib/generators/fuik/provider/templates/smtp2go/bounce.rb.tt

@@ -0,0 +1,16 @@
+module <%= provider_module_name %>
+  class Bounce < Base
+    def process!
+      # payload.rcpt  # email address that bounced
+      # payload.bounce  # "hard" or "soft"
+      # payload.host  # recipient server
+      # payload.message  # SMTP error message
+      # payload.subject  # email subject
+      # payload.email_id  # email identifier
+
+      # TODO: Add business logic
+
+      @webhook_event.processed!
+    end
+  end
+end

data/lib/generators/fuik/provider/templates/smtp2go/reject.rb.tt

@@ -0,0 +1,14 @@
+module <%= provider_module_name %>
+  class Reject < Base
+    def process!
+      # payload.rcpt  # email address that was rejected
+      # payload.message  # rejection reason
+      # payload.subject  # email subject
+      # payload.email_id  # email identifier
+
+      # TODO: Add business logic
+
+      @webhook_event.processed!
+    end
+  end
+end

data/lib/generators/fuik/provider/templates/smtp2go/spam.rb.tt

@@ -0,0 +1,13 @@
+module <%= provider_module_name %>
+  class Spam < Base
+    def process!
+      # payload.rcpt  # email address that complained
+      # payload.subject  # email subject
+      # payload.email_id  # email identifier
+
+      # TODO: Add business logic
+
+      @webhook_event.processed!
+    end
+  end
+end

data/lib/generators/fuik/provider/templates/smtp2go/unsubscribe.rb.tt

@@ -0,0 +1,13 @@
+module <%= provider_module_name %>
+  class Unsubscribe < Base
+    def process!
+      # payload.rcpt  # email address that unsubscribed
+      # payload.subject  # email subject
+      # payload.email_id  # email identifier
+
+      # TODO: Add business logic
+
+      @webhook_event.processed!
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module <%= provider_module_name %>
+  class Base < Fuik::Event
+    event_type payload: "type"
+    event_id   payload: "data.id"
+
+    # def self.verify!(request)
+    #   secret = Rails.application.credentials.dig(:spinal, :webhook_secret)
+    #   signature = request.headers["webhook-signature"]
+    #   id = request.headers["webhook-id"]
+    #   timestamp = request.headers["webhook-timestamp"]
+
+    #   expected = OpenSSL::HMAC.base64digest("SHA256", secret, "#{id}.#{timestamp}.#{request.raw_post}")
+    #   raise Fuik::InvalidSignature unless Rack::Utils.secure_compare(signature, "v1,#{expected}")
+    # end
+  end
+end

data/lib/generators/fuik/provider/templates/spinal/collection_synced.rb.tt

@@ -0,0 +1,14 @@
+module <%= provider_module_name %>
+  class CollectionSynced < Base
+    def process!
+      # payload["data"]["id"]                # collection id
+      # payload["data"]["stats"]["added"]    # resources added during sync
+      # payload["data"]["stats"]["updated"]  # resources updated during sync
+      # payload["data"]["stats"]["removed"]  # resources removed during sync
+
+      # TODO: Add business logic
+
+      @webhook_event.processed!
+    end
+  end
+end

data/lib/generators/fuik/provider/templates/spinal/resource_created.rb.tt

@@ -0,0 +1,14 @@
+module <%= provider_module_name %>
+  class ResourceCreated < Base
+    def process!
+      # payload["data"]["id"]             # resource id
+      # payload["data"]["filename"]       # e.g., "posts/hello-world.md"
+      # payload["data"]["relative_path"]  # e.g., "posts/hello-world"
+      # payload["data"]["status"]         # "draft" | "published"
+
+      # TODO: Add business logic
+
+      @webhook_event.processed!
+    end
+  end
+end

data/lib/generators/fuik/provider/templates/spinal/resource_pushed.rb.tt

@@ -0,0 +1,13 @@
+module <%= provider_module_name %>
+  class ResourcePushed < Base
+    def process!
+      # payload["data"]["id"]        # resource id
+      # payload["data"]["filename"]  # e.g., "posts/hello-world.md"
+      # payload["data"]["status"]    # "draft" | "published"
+
+      # TODO: Add business logic
+
+      @webhook_event.processed!
+    end
+  end
+end

data/lib/generators/fuik/provider/templates/spinal/resource_scheduled.rb.tt

@@ -0,0 +1,13 @@
+module <%= provider_module_name %>
+  class ResourceScheduled < Base
+    def process!
+      # payload["data"]["id"]            # resource id
+      # payload["data"]["filename"]      # e.g., "posts/hello-world.md"
+      # payload["data"]["published_at"]  # ISO8601 scheduled publish time
+
+      # TODO: Add business logic
+
+      @webhook_event.processed!
+    end
+  end
+end

data/lib/generators/fuik/provider/templates/spinal/resource_unscheduled.rb.tt

@@ -0,0 +1,12 @@
+module <%= provider_module_name %>
+  class ResourceUnscheduled < Base
+    def process!
+      # payload["data"]["id"]        # resource id
+      # payload["data"]["filename"]  # e.g., "posts/hello-world.md"
+
+      # TODO: Add business logic
+
+      @webhook_event.processed!
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fuik
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Rails Designer
@@ -35,6 +35,7 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/assets/images/fuik/icons/46elks.jpg
 - app/assets/images/fuik/icons/adyen.jpg
 - app/assets/images/fuik/icons/anthropic.jpg
 - app/assets/images/fuik/icons/apple.jpg
@@ -47,6 +48,7 @@ files:
 - app/assets/images/fuik/icons/gitlab.jpg
 - app/assets/images/fuik/icons/google.jpg
 - app/assets/images/fuik/icons/gumroad.jpg
+- app/assets/images/fuik/icons/lettermint.jpg
 - app/assets/images/fuik/icons/linkedin.jpg
 - app/assets/images/fuik/icons/loops.jpg
 - app/assets/images/fuik/icons/mailgun.jpg
@@ -58,34 +60,44 @@ files:
 - app/assets/images/fuik/icons/resend.jpg
 - app/assets/images/fuik/icons/shopify.jpg
 - app/assets/images/fuik/icons/slack.jpg
+- app/assets/images/fuik/icons/smtp2go.jpg
 - app/assets/images/fuik/icons/stripe.jpg
 - app/assets/images/fuik/icons/telegram.jpg
 - app/assets/images/fuik/icons/twitter.jpg
 - app/assets/images/fuik/icons/userlist.jpg
 - app/assets/images/fuik/icons/webhook.svg
 - app/assets/images/fuik/icons/zoom.jpg
+- app/assets/javascript/attractivejs-0.12.0.min.js
 - app/assets/stylesheets/fuik/application.css
 - app/controllers/concerns/fuik/event_type.rb
 - app/controllers/fuik/application_controller.rb
 - app/controllers/fuik/downloads_controller.rb
 - app/controllers/fuik/events_controller.rb
+- app/controllers/fuik/retries_controller.rb
 - app/controllers/fuik/webhooks_controller.rb
 - app/helpers/fuik/highlight_helper.rb
 - app/helpers/fuik/icon_helper.rb
 - app/jobs/fuik/application_job.rb
+- app/jobs/fuik/webhook_processing_job.rb
 - app/models/fuik/application_record.rb
 - app/models/fuik/event.rb
 - app/models/fuik/webhook_event.rb
+- app/models/fuik/webhook_event/filterable.rb
 - app/views/fuik/events/_copy_button.html.erb
+- app/views/fuik/events/_filters.html.erb
 - app/views/fuik/events/index.html.erb
 - app/views/fuik/events/show.html.erb
 - app/views/layouts/fuik/application.html.erb
 - config/routes.rb
 - db/migrate/20250101000000_create_webhook_events.rb
 - lib/fuik.rb
+- lib/fuik/configuration.rb
 - lib/fuik/dot_access.rb
 - lib/fuik/engine.rb
+- lib/fuik/errors.rb
+- lib/fuik/notifications.rb
 - lib/fuik/routing/provider_constraint.rb
+- lib/fuik/test_helpers.rb
 - lib/fuik/version.rb
 - lib/generators/fuik/install/install_generator.rb
 - lib/generators/fuik/provider/provider_generator.rb
@@ -96,6 +108,11 @@ files:
 - lib/generators/fuik/provider/templates/github/installation_created.rb.tt
 - lib/generators/fuik/provider/templates/github/push.rb.tt
 - lib/generators/fuik/provider/templates/github/star_created.rb.tt
+- lib/generators/fuik/provider/templates/lettermint/base.rb.tt
+- lib/generators/fuik/provider/templates/lettermint/message_failed.rb.tt
+- lib/generators/fuik/provider/templates/lettermint/message_hard_bounced.rb.tt
+- lib/generators/fuik/provider/templates/lettermint/message_soft_bounced.rb.tt
+- lib/generators/fuik/provider/templates/lettermint/message_suppressed.rb.tt
 - lib/generators/fuik/provider/templates/loops/base.rb.tt
 - lib/generators/fuik/provider/templates/loops/contact_unsubscribed.rb.tt
 - lib/generators/fuik/provider/templates/loops/email_hard_bounced.rb.tt
@@ -110,6 +127,17 @@ files:
 - lib/generators/fuik/provider/templates/resend/base.rb.tt
 - lib/generators/fuik/provider/templates/resend/email_bounced.rb.tt
 - lib/generators/fuik/provider/templates/resend/email_complained.rb.tt
+- lib/generators/fuik/provider/templates/smtp2go/base.rb.tt
+- lib/generators/fuik/provider/templates/smtp2go/bounce.rb.tt
+- lib/generators/fuik/provider/templates/smtp2go/reject.rb.tt
+- lib/generators/fuik/provider/templates/smtp2go/spam.rb.tt
+- lib/generators/fuik/provider/templates/smtp2go/unsubscribe.rb.tt
+- lib/generators/fuik/provider/templates/spinal/base.rb.tt
+- lib/generators/fuik/provider/templates/spinal/collection_synced.rb.tt
+- lib/generators/fuik/provider/templates/spinal/resource_created.rb.tt
+- lib/generators/fuik/provider/templates/spinal/resource_pushed.rb.tt
+- lib/generators/fuik/provider/templates/spinal/resource_scheduled.rb.tt
+- lib/generators/fuik/provider/templates/spinal/resource_unscheduled.rb.tt
 - lib/generators/fuik/provider/templates/stripe/base.rb.tt
 - lib/generators/fuik/provider/templates/stripe/checkout_session_completed.rb.tt
 - lib/generators/fuik/provider/templates/stripe/customer_subscription_deleted.rb.tt
@@ -117,11 +145,11 @@ files:
 - lib/generators/fuik/provider/templates/stripe/payment_intent_succeeded.rb.tt
 - lib/generators/fuik/provider/templates/userlist/base.rb.tt
 - lib/generators/fuik/provider/templates/userlist/user_unsubscribed.rb.tt
-homepage: https://railsdesigner.com/fuik/
+homepage: https://railsdesigner.com/open-source/fuik/
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://railsdesigner.com/fuik/
+  homepage_uri: https://railsdesigner.com/open-source/fuik/
   source_code_uri: https://github.com/Rails-Designer/fuik/
 rdoc_options: []
 require_paths:
@@ -137,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.9
+rubygems_version: 4.0.14
 specification_version: 4
 summary: A fish trap for webhooks
 test_files: []