gh-events 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1cff1386c5673a98772cf99e50149162e0f010f65c8e59a6bb40779fbc10233
+  data.tar.gz: fede3370b5bd12f80c75a6cc4b239e324df11bbc0d970419ef4a44eab3f4a7bc
+SHA512:
+  metadata.gz: 70e2bd1df73c6641d6645d40804e7526de092512fd068d02924f7d8a5966d1cb2a120a6d3e38894f77ee4cb390992dfc63b3db81c6f10c401cc620fed61b9944
+  data.tar.gz: 8dd77aaaed11e14dccb267a86f9ce211998cd91bb45de3c8db8f53dec76d8fbc837e45d9a4a0551489ac79a14f6e50f9f9f64ebc7e9984c789b037ceed9fd489

data/.circleci/config.yml

@@ -0,0 +1,60 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.6.5
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            gem install bundler:2.0.2
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            bundle exec rspec \
+              --format progress \
+              --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec.xml \
+              --format progress \
+              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gh-events.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    gh-events (0.8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  gh-events!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.4)
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,59 @@
+# Github Events
+
+Via Webhooks Github can send a plethora of events, which can be used to facilitate all kinds of automation.
+
+These events are _untyped_, meaning they clearly lack a property `type` to identify the type of event received. (The rationale here might be that one would have differen webhook endpoints for each type of events. But maintaining lots of endpoints is cumbersome. When all the events end up in one endpoint, this library helps by adding a property `type` to the event.)
+
+Additionally this library provides means of translating the plain event into a human readable textutal representation. This functionality is wrapped in a command line utility, for your convenience.
+
+## Example Usage
+
+You can use the command `gh-events` to list the types of events stortef in JSON files.
+
+```
+% gh-events spec/fixtures/*.json
+events/001.json: commit_comment
+events/002.json: create
+events/003.json: delete
+events/004.json: deployment
+events/005.json: deployment_status
+events/006.json: fork
+...
+```
+
+Let's say you have a github _commit_comment_ event stored in a file `event.json`
+
+```
+% cat event.json | gh-event2text
+...
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gh-events'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gh-events
+
+## References
+
+- https://developer.github.com/v3/activity/events/types/
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/200ok-ch/gh-events.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "github/events"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/gh-event2text

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'gh/events'
+
+puts GH::Events::Text.translate(STDIN.read, ARGV.first)

data/exe/gh-events

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'gh/events'
+
+ARGV.each do |file|
+  begin
+    type = GH::Events.typeof(File.read(file))
+  rescue
+    type = 'error'
+  end
+  puts "#{file}: #{type}"
+end

data/gh-events.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gh/events/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gh-events"
+  spec.version       = GH::Events::VERSION
+  spec.authors       = ["Phil Hofmann"]
+  spec.email         = ["phil@200ok.ch"]
+
+  spec.summary       = %q{Determine Github event types by their payload.}
+  spec.description   = %q{Determine Github event types by their payload.}
+  spec.homepage      = "https://github.com/200ok-ch/gh-events"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.4"
+end

data/lib/gh-events.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(%w(.. gh events)), __FILE__)

data/lib/gh/events.rb

@@ -0,0 +1,46 @@
+require "gh/events/version"
+require "gh/events/text"
+require 'hash'
+
+require 'yaml'
+require 'ostruct'
+
+module GH
+  module Events
+    class Error < StandardError; end
+
+    extend self
+
+    PATH = File.expand_path(File.join(%w(.. .. .. res events.yml)), __FILE__)
+    HEURISTICS = YAML.load_file(PATH)
+
+    def typeof(payload)
+      payload = JSON.parse(payload) if payload.is_a?(String)
+      payload = payload.marshal_dump if payload.is_a?(OpenStruct)
+      payload = payload.deep_stringify_keys
+      keys = payload.keys
+      HEURISTICS.each do |type, characteristics|
+        # puts ("-" * 30) + " #{type}"
+
+        # all keys in `present` are there
+        x = ((characteristics['present'] || []) - keys)
+        next unless x.empty?
+
+        # non of the keys in `absent` are there
+        y = ((characteristics['absent'] || []) & keys)
+        next unless y.empty?
+
+        # everything in `exactly` is there including the values
+        z = payload.dup.merge(characteristics['exactly'] || {}) == payload
+        next unless z
+
+        n = characteristics['number_of_keys'] &&
+            keys.count != characteristics['number_of_keys']
+        next if n
+
+        return type.to_sym
+      end
+      return :unknown
+    end
+  end
+end

data/lib/gh/events/text.rb

@@ -0,0 +1,73 @@
+require 'yaml'
+require 'erb'
+require 'ostruct'
+require 'json'
+
+module GH::Events::Text
+
+  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]
+
+  def translate(payload, dict)
+    dict ||= 'plain'
+
+    templates = YAML.load_file(templates_file(dict))
+
+    event = JSON.parse(payload, object_class: OpenStruct)
+    type = GH::Events.typeof(event).to_s
+
+    # unify
+    event.ref_type = 'branch' if event.ref&.match(/^refs\/heads\//)
+    event.ref_type = 'tag' if event.ref&.match(/^refs\/tags\//)
+    event.ref = event.ref&.split('/')&.last
+
+    # 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
+    return nil if template === false
+
+    # if there is no template use a default
+    template ||= templates['no_template']
+
+    render(template, event)
+  end
+
+  def templates_file(dict)
+    preset = File.expand_path(File.join(%w(.. .. .. .. res) << "#{dict}.yml"), __FILE__)
+    return preset if File.exists?(preset)
+
+    return dict if File.exists?(dict.to_s)
+
+    warn "Could not find dict file: #{dict}"
+    exit(1)
+  end
+
+  class ErbBinding < OpenStruct
+    def get_binding
+      return binding()
+    end
+  end
+
+  def render(template, data)
+    ERB.new(JSON.unparse(template)).result(ErbBinding.new(data).get_binding)
+  end
+
+end

data/lib/gh/events/version.rb

@@ -0,0 +1,5 @@
+module GH
+  module Events
+    VERSION = "0.8.0"
+  end
+end

data/lib/hash.rb

@@ -0,0 +1,9 @@
+class Hash
+  def deep_stringify_keys
+    Hash.new.tap do |h|
+      each do |k, v|
+        h[k.to_s] = v.is_a?(Hash) ? v.deep_stringify_keys : v
+      end
+    end
+  end
+end

data/res/events.yml

@@ -0,0 +1,194 @@
+---
+# https://developer.github.com/v3/activity/events/types/
+
+# the order is crucial, first match wins!
+
+watch: # 49
+  present:
+    - action
+    - repository
+  exactly:
+    action: started
+
+# check_run # 1
+
+# check_suite # 2
+
+commit_comment: # 3
+  present:
+    - comment
+    - repository
+  absent:
+    - issue
+    - pull_request
+
+# content_reference # 4
+
+create: # 5
+  present:
+    - ref_type
+    - ref
+    - master_branch
+    - description
+    - repository
+
+delete: # 6
+  present:
+    - ref_type
+    - ref
+    - repository
+  absent:
+    - master_branch
+
+# deploy_key # 7
+
+deployment: # 8
+  present:
+    - deployment
+    - repository
+  absent:
+    - deployment_status
+
+deployment_status: # 9
+  present:
+    - deployment
+    - deployment_status
+    - repository
+
+# download # 10
+
+# follow # 11
+
+fork: # 12
+  present:
+    - forkee
+    - repository
+
+# fork_apply # 13
+
+# git_hub_app_authorization # 14
+
+# gist # 15
+
+gollum: # 16
+  present:
+    - pages
+    - repository
+
+# installation: # 17
+
+# installation_repositories: # 18
+
+issue_comment: # 19
+  present:
+    - issue
+    - comment
+    - repository
+
+issues: # 20
+  present:
+    - issue
+    - repository
+  absent:
+    - comment
+
+# label # 21
+
+# marketplace_purchase # 22
+
+member: # 23
+  present:
+    - member
+    - repository
+
+membership: # 24
+  present:
+    - scope
+    - member
+    - team
+    - organization
+
+# meta # 25
+
+# milestone # 26
+
+# organization # 27
+
+# org_block # 28
+
+page_build: # 29
+  present:
+    - build
+    - repository
+
+# project_card # 30
+
+# project_column # 31
+
+# project # 32
+
+public: # 33
+  present:
+    - repository
+  number_of_keys: 2
+
+pull_request: # 34
+  present:
+    - pull_request
+    - repository
+  absent:
+    - comment
+
+# pull_request_review # 35
+
+pull_request_review_comment: # 36
+  present:
+    - comment
+    - pull_request
+    - repository
+
+push: # 37
+  present:
+    - ref
+    - before
+    - commits
+    - repository
+
+# registry_package # 38
+
+release: # 39
+  present:
+    - release
+    - repository
+
+# repository_dispatch # 40
+
+repository: # 41
+  present:
+    - action
+    - repository
+  number_of_keys: 3
+
+# repository_import # 42
+
+# repository_vulnerability_report # 43
+
+# security_advisory # 44
+
+star: # 45
+  present:
+    - starred_at
+
+status: # 46
+  present:
+    - sha
+    - state
+    - description
+    - branches
+
+# team # 47
+
+team_add: # 48
+  present:
+    - team
+    - repository

data/res/plain.yml

@@ -0,0 +1,118 @@
+# All refs are unified. So all events have `ref` and `ref_type`.
+# Additionally all events have `type` and `stype`.
+
+push: >-
+  [<%= repository.full_name %>]
+  <%= sender.login %> <%= forced ? 'force-' : '' %>pushed
+  <% if ref_type == 'branch' %><%= num = size || commits.count %> commit<%= num > 1 ? 's' : '' %> to<% end %>
+  <%= ref_type %> `<%= ref %>`
+
+commit_comment: >-
+  [<%= repository.full_name %>]
+  <%= sender.login %>
+  commented on
+  commit `<%= comment.commit_id %>`>: "<%= comment.body %>"
+
+create: >-
+  [<%= repository.full_name %>]
+  <%= sender.login %>
+  created
+  <%= ref_type %> `<%= ref %>`
+
+delete: >-
+  [<%= repository.full_name %>]
+  <%= sender.login %>
+  deleted
+  <%= ref_type %> `<%= ref %>`
+
+issue_comment: >-
+  [<%= repository.full_name %>]
+  <%= sender.login %>
+  commented
+  on issue "<%= issue.title %>": <%= comment.body %>
+
+issues: >-
+  [<%= repository.full_name %>]
+  <%= sender.login %>
+  <%= action %>
+  issue "<%= issue.title %>"
+
+issues.opened: >-
+  [<%= repository.full_name %>]
+  <%= sender.login %>
+  create the issue
+  "<%= issue.title %>": <%= repository.html_url %>
+
+issues.labeled: >-
+  [<%= repository.full_name %>]
+  <%= sender.login %>
+  labeled
+  issue "<%= issue.title %>"
+  as `<%= label.name %>`
+
+pull_request: >-
+  [<%= repository.full_name %>]
+  <%= sender.login %>
+  <%= action %>
+  PR "<%= pull_request.title %>"
+
+pull_request.opened: >-
+  [<%= repository.full_name %>]
+  <%= sender.login %>
+  opened
+  PR <%= pull_request.title %>: <%= pull_request.body %>
+
+pull_request.labeled: >-
+  [<%= repository.full_name %>]
+  <%= sender.login %>
+  labeled
+  PR "<%= pull_request.title %>"
+  as `<%= label.name %>`
+
+pull_request_review_comment: >-
+  [<%= repository.full_name %>]
+  <%= sender.login %>
+  reviewed: <%= comment.body %>
+
+star: >-
+  [<%= repository.full_name %>]
+  <%= sender.login %>
+  <%= action == 'created' ? 'starred' : 'unstarred' %>
+  <%= repository.full_name %>
+  (<%= repository.stargazers_count %>)
+
+# Ignore other status udpates than CircleCI failures for the moment
+status: false
+
+status.failure: >-
+  [<%= repository.full_name %>]
+  CircleCI build failed
+  for commit "<%= commit.commit.message %>"
+  by "<%= sender.login %>"
+
+fork: >-
+  [<%= repository.full_name %>]
+  <%= sender.login %>
+  forked <%= repository.full_name %>
+  (<%= repository.forks_count %>)
+
+deployment: An event of type `deployment` occurred.
+deployment_status: An event of type `deployment_status` occurred.
+gollum: An event of type `gollum` occurred.
+member: An event of type `member` occurred.
+membership: An event of type `membership` occurred.
+page_build: An event of type `page_build` occurred.
+public: An event of type `public` occurred.
+release: An event of type `release` occurred.
+repository: An event of type `repository` occurred.
+team_add: 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: No template for event of type `<%= type %>` (`<%= stype %>`).
+
+# `unknown` will be used for events that could not be recognized.
+unknown: "An unknown event occurred (stype: `<%= stype %>`)"

data/res/slack.yml

@@ -0,0 +1,215 @@
+# refs are unified. So all events have `ref` and `ref_type`.
+
+push:
+  text: >-
+    :arrow_up:
+    <<%= sender.html_url %>|<%= sender.login %>>
+    <%= forced ? 'force-' : '' %>pushed
+    <% if ref_type == 'branch' %><%= num = size || commits.count %> commit<%= num > 1 ? 's' : '' %> to<% end %>
+    <%= ref_type %> `<%= ref %>`
+    on <<%= repository.html_url %>|<%= repository.full_name %>>
+    (<<%= compare %>|compare>)
+
+commit_comment:
+  text: >-
+    :left_speech_bubble:
+    new comment for
+    commit <<%= comment.html_url %>|`<%= comment.commit_id %>`>
+    on <<%= repository.html_url %>|<%= repository.full_name %>>
+  attachments:
+    - fallback: <%= comment.body %>
+      color: '#36a64f'
+      # pretext: Optional text that appears above the attachment block
+      author_name: <%= sender.login %>
+      author_link: <%= sender.html_url %>
+      author_icon: <%= sender.avatar_url %>
+      # title: Slack API Documentation
+      # title_link: https://api.slack.com/
+      text: <%= comment.body %>
+      # fields:
+      #   - title: Priority
+      #     value: High
+      #     short: false
+      # image_url: http://my-website.com/path/to/image.jpg
+      # thumb_url: http://example.com/path/to/thumb.png
+      # footer: Slack API
+      # footer_icon: https://platform.slack-edge.com/img/default_application_icon.png
+      # ts: 123456789
+
+create:
+  text: >-
+    :sparkles:
+    <<%= sender.html_url %>|<%= sender.login %>>
+    created
+    <%= ref_type %> `<%= ref %>`
+    on <<%= repository.html_url %>|<%= repository.full_name %>>
+
+delete:
+  text: >-
+    :wastebasket:
+    <<%= sender.html_url %>|<%= sender.login %>>
+    deleted
+    <%= ref_type %> `<%= ref %>`
+    on <<%= repository.html_url %>|<%= repository.full_name %>>
+
+issue_comment:
+  text: >-
+    :left_speech_bubble:
+    <<%= sender.html_url %>|<%= sender.login %>>
+    commented
+    on <<%= comment.html_url %>|<%= issue.title %>>
+  attachments:
+    - fallback: <%= comment.body %>
+      color: '#36a64f'
+      author_name: <%= sender.login %>
+      author_link: <%= sender.html_url %>
+      author_icon: <%= sender.avatar_url %>
+      text: <%= comment.body %>
+
+issues:
+  text: >-
+    :inbox_tray:
+    <<%= sender.html_url %>|<%= sender.login %>>
+    <%= action %>
+    issue <<%= issue.html_url %>|<%= issue.title %>>
+    on <<%= repository.html_url %>|<%= repository.full_name %>>
+
+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: >-
+    :label:
+    <<%= sender.html_url %>|<%= sender.login %>>
+    labeled
+    issue <<%= issue.html_url %>|<%= issue.title %>>
+    on <<%= repository.html_url %>|<%= repository.full_name %>>
+    as `<%= label.name %>`
+
+pull_request:
+  text: >-
+    :gift:
+    <<%= sender.html_url %>|<%= sender.login %>>
+    <%= action %>
+    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 %>>
+    labeled
+    PR <<%= pull_request.html_url %>|<%= pull_request.title %>>
+    on <<%= repository.html_url %>|<%= repository.full_name %>>
+    as `<%= label.name %>`
+
+pull_request_review_comment:
+  text: >-
+    :left_speech_bubble:
+    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: >-
+    :star:
+    <<%= sender.html_url %>|<%= sender.login %>>
+    <%= action == 'created' ? 'starred' : 'unstarred' %>
+    <<%= repository.html_url %>|<%= repository.full_name %>>
+    :star: <%= repository.stargazers_count %>
+
+# Ignore other status udpates than CircleCI failures for the moment
+status: false
+
+status.failure:
+  text: >-
+    <<%= target_url %> | CircleCI build >
+    fails for commit
+    <<%= commit.html_url %> | <%= commit.commit.message %>>
+    from
+    <<%= sender.html_url %>|<%= sender.login %>>
+
+fork:
+  text: >-
+    :fork_and_knife:
+    <<%= sender.html_url %>|<%= sender.login %>>
+    forked <<%= repository.html_url %>|<%= repository.full_name %>>
+    :fork_and_knife: <%= repository.forks_count %>
+
+deployment:
+  text: An event of type `deployment` occurred.
+deployment_status:
+  text: An event of type `deployment_status` occurred.
+gollum:
+  text: An event of type `gollum` occurred.
+member:
+  text: An event of type `member` occurred.
+membership:
+  text: An event of type `membership` occurred.
+page_build:
+  text: An event of type `page_build` occurred.
+public:
+  text: An event of type `public` occurred.
+release:
+  text: An event of type `release` occurred.
+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

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: gh-events
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Phil Hofmann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Determine Github event types by their payload.
+email:
+- phil@200ok.ch
+executables:
+- gh-event2text
+- gh-events
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gh-event2text
+- exe/gh-events
+- gh-events.gemspec
+- lib/gh-events.rb
+- lib/gh/events.rb
+- lib/gh/events/text.rb
+- lib/gh/events/version.rb
+- lib/hash.rb
+- res/events.yml
+- res/plain.yml
+- res/slack.yml
+homepage: https://github.com/200ok-ch/gh-events
+licenses: []
+metadata:
+  homepage_uri: https://github.com/200ok-ch/gh-events
+  source_code_uri: https://github.com/200ok-ch/gh-events
+  changelog_uri: https://github.com/200ok-ch/gh-events
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Determine Github event types by their payload.
+test_files: []