gh-events 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aa33330e1cf347818446e7309be67a9a23c8111b830189d29047c017363cee5
-  data.tar.gz: d0928eed123ec7a5c5fd69122f6502f9158ada6bf3fce30af23c7026a1ac4fc4
+  metadata.gz: 2008b1c5311735ce045e5007f3fb77a30df7881c2a2e3eae4b01ee11b93feda4
+  data.tar.gz: 8df066ce105675449515e12fe44c404d5683d55bc74fee7454d90dde9168f372
 SHA512:
-  metadata.gz: 0bba3c1239377764f4cca8756a3fb2865f583a9b879722dcfb2f089c7f9c26ed8d9a46df9b69cf8cb52c5119f9cb9ad60e1f5add610a12bf9d3325bfd7fc4893
-  data.tar.gz: 4af3c4728fd84e62c89ee4fdd18bd683df65d8fd71d99657816f7da811b529c86746fc2bb60720bf3062b3a33cde7c718adadec323610b0dc88f15671b2203eb
+  metadata.gz: f303f779bbdd664d88e5225c3eb73176d4b4b8784c1c7463423be4a4a9c0103df6632ef4c68032bcb8cea6dfb0d2fb3ba95f94c2fc19dadceefef1e9c234762f
+  data.tar.gz: 01a062898625a3195113d8d79d19c2c0c4a3edfd7e673bcf68ef5fec2349e6bfe3af94120a843a9677fe9025d1c1f11a3b41654dc64dfc34da2fabbd76f1805d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gh-events (0.5.0)
+    gh-events (0.6.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/gh/events/slack.rb

@@ -7,6 +7,10 @@ module GH::Events::Slack
 
   extend self
 
+  # this is a carefully curated list of fields in gh events that might
+  # be helpful when filtering events
+  ASPECTS = %i[type action state context]
+
   def translate(payload)
     event = JSON.parse(payload, object_class: OpenStruct)
     type = GH::Events.typeof(event).to_s
@@ -16,8 +20,29 @@ module GH::Events::Slack
     event.ref_type = 'tag' if event.ref&.match(/^refs\/tags\//)
     event.ref = event.ref&.split('/')&.last
 
-    template = templates[[type, event.action]*'.']
-    template ||= (templates[type] || "No template for type: #{type}.")
+    # add type to the event
+    event.type = type
+
+    # collect the aspects
+    aspects = ASPECTS.map { |a| event.send(a) }.compact
+
+    # add the specific type (stype) to the event
+    event.stype = aspects * '.'
+
+    # lookup the template by type and all the specific types
+    _result = aspects.reduce({as: [], ts: []}) do |r, aspect|
+      r[:as] << aspect
+      r[:ts] << templates[r[:as] * '.']
+      r
+    end
+    template = _result[:ts].compact.last
+
+    # if the event was set to `false` abort
+    exit(1) if template === false
+
+    # if there is no template use a default
+    template ||= templates['no_template']
+
     render(template, event)
   end
 

data/lib/gh/events/version.rb

@@ -1,5 +1,5 @@
 module GH
   module Events
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

data/res/slack.yml

@@ -1,9 +1,5 @@
 # refs are unified. So all events have `ref` and `ref_type`.
 
-unknown:
-  text: >-
-    An unknown event occurred.
-
 push:
   text: >-
     :arrow_up:
@@ -50,7 +46,7 @@ create:
 
 delete:
   text: >-
-    :collision:
+    :wastebasket:
     <<%= sender.html_url %>|<%= sender.login %>>
     deleted
     <%= ref_type %> `<%= ref %>`
@@ -77,7 +73,20 @@ issues:
     <%= action %>
     issue <<%= issue.html_url %>|<%= issue.title %>>
     on <<%= repository.html_url %>|<%= repository.full_name %>>
-    <% if action == 'opened' %>: <%= issue.body %><% end %>
+
+issues.opened:
+  text: >-
+    :inbox_tray:
+    new issue
+    <<%= issue.html_url %>|<%= issue.title %>>
+    on <<%= repository.html_url %>|<%= repository.full_name %>>
+  attachments:
+    - fallback: <%= issue.body %>
+      color: red
+      author_name: <%= sender.login %>
+      author_link: <%= sender.html_url %>
+      author_icon: <%= sender.avatar_url %>
+      text: <%= issue.body %>
 
 issues.labeled:
   text: >-
@@ -96,6 +105,21 @@ pull_request:
     PR <<%= pull_request.html_url %>|<%= pull_request.title %>>
     on <<%= repository.html_url %>|<%= repository.full_name %>>
 
+pull_request.opened:
+  text: >-
+    :gift:
+    <<%= sender.html_url %>|<%= sender.login %>>
+    opened
+    PR <<%= pull_request.html_url %>|<%= pull_request.title %>>
+    on <<%= repository.html_url %>|<%= repository.full_name %>>
+  attachments:
+    - fallback: <%= pull_request.body %>
+      color: red
+      author_name: <%= sender.login %>
+      author_link: <%= sender.html_url %>
+      author_icon: <%= sender.avatar_url %>
+      text: <%= pull_request.body %>
+
 pull_request.labeled:
   text: >-
     <<%= sender.html_url %>|<%= sender.login %>>
@@ -107,9 +131,15 @@ pull_request.labeled:
 pull_request_review_comment:
   text: >-
     :left_speech_bubble:
-    <<%= sender.html_url %>|<%= sender.login %>>
-    commented
-    on <<%= comment.html_url %>|<%= .pull_request.title %>>: <%= comment.body %>
+    new review comment
+    on <<%= comment.html_url %>|<%= pull_request.title %>>
+  attachments:
+    - fallback: <%= comment.body %>
+      color: red
+      author_name: <%= sender.login %>
+      author_link: <%= sender.html_url %>
+      author_icon: <%= sender.avatar_url %>
+      text: <%= comment.body %>
 
 star:
   text: >-
@@ -119,18 +149,11 @@ star:
     <<%= repository.html_url %>|<%= repository.full_name %>>
     :star: <%= repository.stargazers_count %>
 
-watch:
-  text: >-
-    :eye:
-    <<%= sender.html_url %>|<%= sender.login %>>
-    <%= action == 'created' ? 'started' : 'stopped' %> watching
-    <<%= repository.html_url %>|<%= repository.full_name %>>
-    :eye: <%= repository.watchers_count %>
-
 # Ignore other status udpates than CircleCI failures for the moment
 status:
   text: >-
     <% if context.match(/circleci/) and state == 'failure' %>
+    [`<%= stype %>`]
     <<%= target_url %> | CircleCI build >
     fails for commit
     <<%= commit.html_url %> | <%= commit.commit.message %>>
@@ -138,12 +161,17 @@ status:
     <<%= sender.html_url %>|<%= sender.login %>>
     <% end %>
 
+fork:
+  text: >-
+    :fork_and_knife:
+    [`<%= stype >`]
+    <<%= sender.html_url %>|<%= sender.login %>>
+    forked <<%= repository.html_url %>|<%= repository.full_name %>>
+
 deployment:
   text: An event of type `deployment` occurred.
 deployment_status:
   text: An event of type `deployment_status` occurred.
-fork:
-  text: An event of type `fork` occurred.
 gollum:
   text: An event of type `gollum` occurred.
 member:
@@ -160,3 +188,29 @@ repository:
   text: An event of type `repository` occurred.
 team_add:
   text: An event of type `team_add` occurred.
+
+# `false` will make it end with exit code 1
+watch: false
+
+# `no_template` will be used for recognized events which have no
+# template assigned.
+no_template:
+  text: No template for event of type `<%= stype %>`.
+  attachments:
+    - fallback: Event details as json.
+      color: gray
+      text: |
+        ```
+        <%= JSON.unparse(self.marshal_dump) %>
+        ```
+
+# `unknown` will be used for events that could not be recognized.
+unknown:
+  text: An unknown event occurred (stype: `<%=stype%>`)
+  attachments:
+    - fallback: Event details as json.
+      color: gray
+      text: |
+        ```
+        <%= JSON.unparse(self.marshal_dump) %>
+        ```

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gh-events
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Phil Hofmann