Make GitLab and GitHub plugins customizable

Author: svoop

CHANGELOG.md

@@ -1,6 +1,7 @@
 ## Main
 
-Nothing so far
+#### Changes
+* Make GitLab and GitHub plugins customizable
 
 ## 0.4.5
 

lib/rodbot/plugins/github_webhook/README.github_webhook.md

@@ -18,9 +18,7 @@ To authenticate the webhook calls from GitHub, create a new random secret token:
 ruby -r securerandom -e "puts SecureRandom.alphanumeric(20)"
 ```
 
-## Activation
-
-Activate and configure this plugin in `config/rodbot.rb`:
+Configure this plugin in `config/rodbot.rb`:
 
 ```ruby
 plugin :github_webhook do
@@ -30,7 +28,7 @@ end
 
 You can set any number of secure tokens here separated with colons.
 
-## Add Repositories
+## Activation
 
 Add a webhook to every GitHub repository you'd like to see pipeline event announcements for. Go to `https://github.com/<USER>/<REPO>/settings/hooks` and create a new webhook with the following properties:
 
@@ -40,3 +38,29 @@ Add a webhook to every GitHub repository you'd like to see pipeline event announ
 * SSL verification: (o) Enable SSL verification
 * Which events? (o) Let me select individual events: [x] Workflow runs
 * And... [x] Active
+
+Use the test tool to verify your setup and to see what the JSON payloads look like in case you'd like to customize the handler.
+
+## Customization
+
+You can change how the plugin reacts to which webhook requests by configuring a custom handler proc. Here's the default one:
+
+```ruby
+plugin :github_webhook do
+  handler: ->(request) do
+    if request.env['HTTP_X_GITHUB_EVENT'] == 'workflow_run'
+      json = JSON.parse(request.body.read)
+      project = json.dig('repository', 'full_name')
+      status = json.dig('workflow_run', 'status')
+      status = json.dig('workflow_run', 'conclusion') if status == 'completed'
+      emoji = case status
+        when 'requested' then '🟡'
+        when 'success' then '🟢'
+        when 'failure' then '🔴'
+        else '⚪️'
+      end
+      [emoji, project, status.gsub('_', ' ')].join(' ')
+    end
+  end
+end
+```

lib/rodbot/plugins/github_webhook/app.rb

@@ -6,18 +6,37 @@ class GithubWebhook
       module App
 
         class Routes < ::App
-          route do |r|
-            r.post '' do
-              r.halt 200 if request.env['HTTP_X_GITHUB_EVENT'] == 'ping'
-              r.halt 400 unless request.env['HTTP_X_GITHUB_EVENT'] == 'workflow_run'
-              r.halt 401 unless authorized?
+          DEFAULT_HANDLER = ->(request) do
+            if request.env['HTTP_X_GITHUB_EVENT'] == 'workflow_run'
               json = JSON.parse(request.body.read)
               project = json.dig('repository', 'full_name')
               status = json.dig('workflow_run', 'status')
               status = json.dig('workflow_run', 'conclusion') if status == 'completed'
-              Rodbot.say [emoji_for(status), project, status.gsub('_', ' ')].join(' ')
-              r.halt 200
+              emoji = case status
+                when 'requested' then '🟡'
+                when 'success' then '🟢'
+                when 'failure' then '🔴'
+                else '⚪️'
+              end
+              [emoji, project, status.gsub('_', ' ')].join(' ')
+            end
+          end
+
+          route do |r|
+            r.post '' do
+              r.halt 200 if request.env['HTTP_X_GITHUB_EVENT'] == 'ping'
+              r.halt 401 unless authorized?
+              handler = Rodbot.config(:plugin, :github_webhook, :handler) || DEFAULT_HANDLER
+              message = handler.call(r)
+              if message&.empty?
+                r.halt 204
+              else
+                Rodbot.say message
+                r.halt 200
+              end
             end
+          rescue => error
+            r.halt 500, error.message
           end
 
           private
@@ -30,15 +49,6 @@ def authorized?
             end
           end
 
-          def emoji_for(status)
-            case status
-              when 'requested' then '🟡'
-              when 'success' then '🟢'
-              when 'failure' then '🔴'
-              else '⚪️'
-            end
-          end
-
         end
       end
     end

lib/rodbot/plugins/gitlab_webhook/README.gitlab_webhook.md

@@ -18,9 +18,7 @@ To authenticate the webhook calls from GitLab, create a new random secret token:
 ruby -r securerandom -e "puts SecureRandom.alphanumeric(20)"
 ```
 
-## Activation
-
-Activate and configure this plugin in `config/rodbot.rb`:
+Configure this plugin in `config/rodbot.rb`:
 
 ```ruby
 plugin :gitlab_webhook do
@@ -30,11 +28,36 @@ end
 
 You can set any number of secure tokens here separated with colons.
 
-## Add Repositories
+## Activation
 
-Add a webhook to every GitLab repository you'd like to see pipeline event announcements for. Go to `https://gitlab.com/<USER>/<REPO>/-/hooks` and create a new webhook with the following properties:
+Set up a webhook to every GitLab repository you'd like to see pipeline event announcements for. Go to `https://gitlab.com/<USER>/<REPO>/-/hooks` and create a new webhook with the following properties:
 
 * URL: `https://<RODBOT-APP>/gitlab_webhook`
 * Secret token: `<TOKEN>`
 * Trigger: [x] Pipeline events
 * SSL verification: [x] Enable SSL verification
+
+Use the test tool to verify your setup and to see what the JSON payloads look like in case you'd like to customize the handler.
+
+## Customization
+
+You can change how the plugin reacts to which webhook requests by configuring a custom handler proc. Here's the default one:
+
+```ruby
+plugin :gitlab_webhook do
+  handler: ->(request) do
+    json = JSON.parse(request.body.read)
+    if json['object_kind'] == 'pipeline'
+      project = json.dig('project', 'path_with_namespace')
+      status = json.dig('object_attributes', 'detailed_status')
+      emoji = case status
+        when 'running' then '🟡'
+        when 'passed' then '🟢'
+        when 'failed' then '🔴'
+        else '⚪️'
+      end
+      [emoji, project, status.gsub('_', ' ')].join(' ')
+    end
+  end
+end
+```

lib/rodbot/plugins/gitlab_webhook/app.rb

@@ -6,16 +6,35 @@ class GitlabWebhook
       module App
 
         class Routes < ::App
+          DEFAULT_HANDLER = ->(request) do
+            json = JSON.parse(request.body.read)
+            if json['object_kind'] == 'pipeline'
+              project = json.dig('project', 'path_with_namespace')
+              status = json.dig('object_attributes', 'detailed_status')
+              emoji = case status
+                when 'running' then '🟡'
+                when 'passed' then '🟢'
+                when 'failed' then '🔴'
+                else '⚪️'
+              end
+              [emoji, project, status.gsub('_', ' ')].join(' ')
+            end
+          end
+
           route do |r|
             r.post '' do
               r.halt 401 unless authorized?
-              json = JSON.parse(request.body.read)
-              r.halt 400 unless json['object_kind'] == 'pipeline'
-              project = json.dig('project', 'path_with_namespace')
-              status = json.dig('object_attributes', 'detailed_status')
-              Rodbot.say [emoji_for(status), project, status.gsub('_', ' ')].join(' ')
-              r.halt 200
+              handler = Rodbot.config(:plugin, :gitlab_webhook, :handler) || DEFAULT_HANDLER
+              message = handler.call(r)
+              if message&.empty?
+                r.halt 204
+              else
+                Rodbot.say message
+                r.halt 200
+              end
             end
+          rescue => error
+            r.halt 500, error.message
           end
 
           private
@@ -24,15 +43,6 @@ def authorized?
             Rodbot.config(:plugin, :gitlab_webhook, :secret_tokens).to_s.split(':').include?(request.env['HTTP_X_GITLAB_TOKEN'])
           end
 
-          def emoji_for(status)
-            case status
-              when 'running' then '🟡'
-              when 'passed' then '🟢'
-              when 'failed' then '🔴'
-              else '⚪️'
-            end
-          end
-
         end
       end
     end