bullet_train-incoming_webhooks 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cca44c64cd5bbdf7bd18f914d3e24a7b4d2429ceb1c6afc1f10cc2378dfd267
-  data.tar.gz: 0a446ad675c1e044c6b7d886a40f240cf2b04b11659ea168e18add4200e1bc30
+  metadata.gz: 9d266a24c49abec06dc6ed74ec895ae76db652e2aa840ccd96b7729fe6a3b874
+  data.tar.gz: c179bc769b668e5ae59413bb8f22d8abd81a670ec8fc8b8689d70300a5cf99c3
 SHA512:
-  metadata.gz: 922ee62630cda4224cd8cb4a3794a4e801d0fd4802898f72595add7c5b935297ddcb04d07c1887c777c0184a45d8b655792fd6b7712dce3a5ce0447ef5083bb7
-  data.tar.gz: 27cc13bcf8efb5f531aab7fc71c775af3a8278b83bea15f69049e4a24900a79c8d6d99be586305e5c42f06599fc3de77c8015c294b1d0606bbba9fc1f23613c2
+  metadata.gz: ddc431b0bebcdba456c6de8c090918b8af1651c48cfd1e2dba0091b87b850621ddffaf28effc170ff6202b4ffaa5ca31fc938d27cacceb9ce3caa7b9bd107dfe
+  data.tar.gz: a357da04e00aa607a9270f160f98bf69524276e074f73ddb6922b4b4d491e6969bccecaac1fa441b189b9484c95d5218e5111573056587060957905a0648fca4

data/app/models/webhooks/incoming/bullet_train_webhook.rb

@@ -5,6 +5,7 @@ class Webhooks::Incoming::BulletTrainWebhook < ApplicationRecord
   # there are many ways a service might ask you to verify the validity of a webhook.
   # whatever that method is, you would implement it here.
   def verify_authenticity
+    # 🚅 skip this section when scaffolding.
     # trying to fix integration tests. if this fixes it, i don't know why puma won't accept another connection here.
     return true if Rails.env.test?
 
@@ -19,6 +20,7 @@ class Webhooks::Incoming::BulletTrainWebhook < ApplicationRecord
 
     # ensure that the payload on the server is the same as the payload we received.
     JSON.parse(response.body) == data
+    # 🚅 stop any skipping we're doing now.
   end
 
   def process

data/lib/bullet_train/incoming_webhooks/engine.rb

@@ -1,6 +1,16 @@
+require "bullet_train/incoming_webhooks/scaffolders/incoming_webhooks_scaffolder"
+require "bullet_train/super_scaffolding"
+
 module BulletTrain
   module IncomingWebhooks
     class Engine < ::Rails::Engine
+      initializer "bullet_train.super_scaffolding.incoming_webhooks.templates.register_template_path" do |app|
+        # Register the base of this package with the Super Scaffolding engine.
+        BulletTrain::SuperScaffolding.template_paths << File.expand_path("../../../..", __FILE__)
+        BulletTrain::SuperScaffolding.scaffolders.merge!({
+          "incoming-webhooks" => "BulletTrain::IncomingWebhooks::Scaffolders::IncomingWebhooksScaffolder"
+        })
+      end
     end
   end
 end

data/lib/bullet_train/incoming_webhooks/scaffolders/incoming_webhooks_scaffolder.rb

@@ -0,0 +1,41 @@
+require "scaffolding/incoming_webhooks_transformer"
+require "bullet_train/super_scaffolding/scaffolder"
+
+module BulletTrain
+  module IncomingWebhooks
+    module Scaffolders
+      class IncomingWebhooksScaffolder < SuperScaffolding::Scaffolder
+        def run
+          unless argv.count >= 1
+            puts ""
+            puts "🚅 usage: bin/super-scaffold incoming-webhooks SomeProvider"
+            puts ""
+            puts "E.g. prepare to receive system-level webhooks from ClickFunnels"
+            puts "  bin/super-scaffold incoming-webhooks ClickFunnels"
+            puts ""
+            standard_protip
+            puts ""
+            return
+          end
+
+          provider_name = argv.shift
+          transformer = Scaffolding::IncomingWebhooksTransformer.new(provider_name)
+
+          `yes n | bin/rails g model webhooks_incoming_#{provider_name.tableize.singularize}_webhook data:jsonb processed_at:datetime verified_at:datetime`
+
+          transformer.scaffold_incoming_webhook
+
+          puts ""
+          puts "1. To receive webhooks in your development environment, you'll need to configure a tunnel.".yellow
+          puts "     See http://bullettrain.co/docs/tunneling for more information.".yellow
+          puts ""
+          puts "2. Once you have a tunnel running, you can configure the provider to deliver webhooks to:".yellow
+          puts "     https://your-tunnel.ngrok.io/webhooks/incoming/#{provider_name.tableize}_webhooks".yellow
+          puts ""
+
+          transformer.restart_server
+        end
+      end
+    end
+  end
+end

data/lib/bullet_train/incoming_webhooks/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module IncomingWebhooks
-    VERSION = "1.0.1"
+    VERSION = "1.2.0"
   end
 end

data/lib/scaffolding/incoming_webhooks_transformer.rb

@@ -0,0 +1,99 @@
+require "scaffolding"
+require "scaffolding/transformer"
+
+class Scaffolding::IncomingWebhooksTransformer < Scaffolding::Transformer
+  attr_accessor :provider_name
+
+  def initialize(provider_name, cli_options = {})
+    super("", "", cli_options)
+    self.provider_name = provider_name
+  end
+
+  def scaffold_incoming_webhook
+    files = [
+      "./app/models/webhooks/incoming/bullet_train_webhook.rb",
+      "./app/controllers/webhooks/incoming/bullet_train_webhooks_controller.rb"
+    ]
+
+    files.each do |name|
+      if File.directory?(resolve_template_path(name))
+        scaffold_directory(name)
+      else
+        scaffold_file(name)
+      end
+    end
+
+    file_name_hook = "bullet_train_webhook"
+    new_model_file_name, _ = files.map { |file| file.gsub(file_name_hook, replacement_for(file_name_hook)) }
+
+    # Since we eject the model from this repository, we don't need the
+    # extra model generated by `rails g model` (just the migration).
+    File.delete("./app/models/webhooks_incoming_#{replacement_for(file_name_hook)}.rb")
+
+    # Set up the model's `verify_authenticity` method to return `true`.
+    model_file_lines = File.readlines(new_model_file_name)
+    comment_lines = [
+      "# You can implement your authenticity verification logic in either\n",
+      "# the newly scaffolded model or controller for your incoming webhooks.\n"
+    ]
+    lines_to_ignore = [
+      "  # there are many ways a service might ask you to verify the validity of a webhook.\n",
+      "  # whatever that method is, you would implement it here.\n"
+    ]
+
+    model_file_lines = File.readlines(new_model_file_name)
+    new_model_file_lines = File.open(new_model_file_name).map.with_index do |line, idx|
+      if line.match?("def verify_authenticity")
+        indentation = Scaffolding::BlockManipulator.indentation_of(idx, model_file_lines)
+        new_comment_lines = comment_lines.map { |comment_line| "#{indentation}#{comment_line}" }.join
+
+        new_comment_lines +
+          "#{line}" \
+          "#{indentation}  true\n"
+      elsif lines_to_ignore.include?(line)
+        next
+      else
+        line
+      end
+    end
+
+    Scaffolding::FileManipulator.write(new_model_file_name, new_model_file_lines)
+
+    # Apply new routes
+    begin
+      [
+        "config/routes.rb",
+        # "config/routes/api/v1.rb"
+      ].each do |routes_file|
+        # Since the webhooks routes don't live under a parent resource, we can't use the `apply` method to apply routes.
+        routes_manipulator = Scaffolding::RoutesFileManipulator.new(routes_file, "", "")
+        resources_line = "  resources :#{replacement_for("bullet_train_webhooks")}"
+        new_routes_lines = Scaffolding::BlockManipulator.insert(resources_line, lines: routes_manipulator.lines, after: "namespace :incoming")
+        Scaffolding::FileManipulator.write(routes_file, new_routes_lines)
+      end
+    rescue BulletTrain::SuperScaffolding::CannotFindParentResourceException => exception
+      add_additional_step :red, "We were not able to generate the routes for your Incoming Webhook automatically because: \"#{exception.message}\" You'll need to add them manually, which admittedly can be complicated. See https://blog.bullettrain.co/nested-namespaced-rails-routing-examples/ for guidance. 🙇🏻‍♂️"
+    end
+  end
+
+  def transform_string(string)
+    [
+      "bullet_train_webhook",
+      "Webhooks::Incoming::BulletTrainWebhook"
+    ].each do |needle|
+      string = string.gsub(needle, replacement_for(needle))
+    end
+    string
+  end
+
+  def replacement_for(string)
+    case string
+    when "bullet_train_webhook"
+      "#{provider_name.tableize.singularize}_webhook"
+    when "bullet_train_webhooks"
+      "#{provider_name.tableize.singularize}_webhooks"
+    when "Webhooks::Incoming::BulletTrainWebhook"
+      "Webhooks::Incoming::#{provider_name}Webhook"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-incoming_webhooks
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: bullet_train-super_scaffolding
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Bullet Train Incoming Webhooks
 email:
 - andrew.culver@gmail.com
@@ -43,7 +57,9 @@ files:
 - config/routes.rb
 - lib/bullet_train/incoming_webhooks.rb
 - lib/bullet_train/incoming_webhooks/engine.rb
+- lib/bullet_train/incoming_webhooks/scaffolders/incoming_webhooks_scaffolder.rb
 - lib/bullet_train/incoming_webhooks/version.rb
+- lib/scaffolding/incoming_webhooks_transformer.rb
 - lib/tasks/bullet_train/incoming_webhooks_tasks.rake
 homepage: https://github.com/bullet-train-co/bullet_train-incoming_webhooks
 licenses:
@@ -66,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Bullet Train Incoming Webhooks