gh-events 0.6.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f9a4fc61ec5714b1d49249d449496180f7a7e378b327a9c2e8d7e467c06b9a5
-  data.tar.gz: 83d0c56649117b8a3f091215223467f327e326b28e81874e9dce4cb5e2ac61b7
+  metadata.gz: 23309b6819c759bd4ae39468e40dc374409484ae1ec4568c42713ba82dbf305e
+  data.tar.gz: f9decf307c3770b981bbca41bb149f008a59aa8279a2b01ef59e4adb8d55a44b
 SHA512:
-  metadata.gz: 1e688bda0e36e9dee4b97b3a166bf2b1e2a574767a19099d666ec5ed1fa07c7d6e0193226b92b4d67d652f3228f990308dc700cfbb37f80bfce1abc7821e2189
-  data.tar.gz: dd7072f3c14de36c0f63c33430f129f790db2c0908f7ce900c84ee0c049427b1f442bdbf77360058d5670cf909141bbaa100bcf3204712c2dc220af602854bc8
+  metadata.gz: e24a1288484269407ae8761f2db4b49e6f6f0413e7ab4bdbd43e2405f87c8ce71ac117feb42cb82bfe756a2acbf9122180b1169901380acc82db3698001adefa
+  data.tar.gz: 37c811378a88220d83d070ac5bb02ae8466e6e1be977a40307a32610b11f071a56d319832b50671c931d2d738a336fa5b9d9b21236cc32a7ef861da5295bd570

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/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gh-events (0.6.2)
+    gh-events (0.8.3)
 
 GEM
   remote: https://rubygems.org/
@@ -21,6 +21,8 @@ GEM
       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
@@ -30,6 +32,7 @@ DEPENDENCIES
   gh-events!
   rake (~> 10.0)
   rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.4)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2020 Phil Hofmann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,11 +1,31 @@
-# Github::Events
+# Github Events
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/github/events`. To experiment with that code, run `bin/console` for an interactive prompt.
+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 different 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 (a deeply nested data structure serialized to JSON) into a human
+readable textutal representation. Some functionality is wrapped in a
+command line utilites, for your convenience.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
+### To use the command line utilities
+
+Or install it yourself as:
+
+    $ gem install gh-events
+
+### To use as a library in your own project
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -16,13 +36,58 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install gh-events
 
 ## Usage
 
-TODO: Write usage instructions here
+### CLI Util
+
+#### Typing
+
+You can use the command `gh-events` to list the types of events
+stored 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
+...
+```
+
+#### Translating
+
+The `gh-event2text` util will receive one event via stdin. Let's say
+you have a github _commit_comment_ event stored in a file named
+`event.json`. With you can to this:
+
+```
+% cat event.json | gh-event2text
+"[Codertocat/Hello-World] Codertocat commented on commit `6113728f27ae82c7b1a177c8d03f9e96e0adf246`>: \"This is a really good change! :+1:\""
+```
+
+For translating the event into its textual representation
+`gh-event2text` uses a dictionary. The dictionary can be given as an
+argument to `gh-event2text`, which can either be a name of a packaged
+dict (currently `plain` (default) or `slack`) or a path to a
+dictionary file.
+
+Dictionary files are YAML files with ERB for templating. The playload
+is fed to the templates as nested Ruby OpenStructs. For an elaborate
+example have a look at the dictionary for Slack.
+
+If you write your own dictionary for other target systems, please
+consider to contribute.
+
+TODO: elaborate on how the lookup of types works
+
+
+### Library
+
+TODO: add an example
+
 
 ## References
 

data/exe/{gh-event2slack → gh-event2text}

@@ -5,4 +5,4 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'gh/events'
 
-puts GH::Events::Slack.translate(ARGF.read)
+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

@@ -38,4 +38,5 @@ Gem::Specification.new do |spec|
   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

@@ -1,5 +1,6 @@
 require "gh/events/version"
-require "gh/events/slack"
+require "gh/events/text"
+require 'hash'
 
 require 'yaml'
 require 'ostruct'
@@ -14,8 +15,10 @@ module GH
     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)
-      keys = payload.keys.map(&:to_s)
+      payload = payload.deep_stringify_keys
+      keys = payload.keys
       HEURISTICS.each do |type, characteristics|
         # puts ("-" * 30) + " #{type}"
 

data/lib/gh/events/{slack.rb → text.rb}

@@ -3,7 +3,7 @@ require 'erb'
 require 'ostruct'
 require 'json'
 
-module GH::Events::Slack
+module GH::Events::Text
 
   extend self
 
@@ -11,7 +11,11 @@ module GH::Events::Slack
   # be helpful when filtering events
   ASPECTS = %i[type action state]
 
-  def translate(payload)
+  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
 
@@ -38,20 +42,37 @@ module GH::Events::Slack
     template = _result[:ts].compact.last
 
     # if the event was set to `false` abort
-    exit(1) if template === false
+    return nil if template === false
 
     # if there is no template use a default
     template ||= templates['no_template']
 
-    render(template, event)
+    res = render(template, event).gsub(/[\n\r]+/, '\n')
+    validate(res, dict)
+    res
   end
 
-  def templates_file
-    File.expand_path(File.join(%w(.. .. .. .. res slack.yml)), __FILE__)
+  # Validate the format of the response in case it's JSON
+  def validate(response, channel)
+    return unless channel == "slack"
+    begin
+      JSON.parse(response)
+    rescue Exception => e
+      warn "Rendered template is not valid JSON"
+      warn e
+      exit 1
+    end
+    response
   end
 
-  def templates
-    @templates ||= YAML.load_file(templates_file)
+  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

data/lib/gh/events/version.rb

@@ -1,5 +1,5 @@
 module GH
   module Events
-    VERSION = "0.6.2"
+    VERSION = "0.8.3"
   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

@@ -8,7 +8,7 @@ watch: # 49
     - action
     - repository
   exactly:
-    :action: started
+    action: started
 
 # check_run # 1
 

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

@@ -17,7 +17,7 @@ commit_comment:
     commit <<%= comment.html_url %>|`<%= comment.commit_id %>`>
     on <<%= repository.html_url %>|<%= repository.full_name %>>
   attachments:
-    - fallback: <%= comment.body %>
+    - fallback: <%= comment.body.gsub(/"/,'\"') %>
       color: '#36a64f'
       # pretext: Optional text that appears above the attachment block
       author_name: <%= sender.login %>
@@ -25,7 +25,7 @@ commit_comment:
       author_icon: <%= sender.avatar_url %>
       # title: Slack API Documentation
       # title_link: https://api.slack.com/
-      text: <%= comment.body %>
+      text: <%= comment.body.gsub(/"/,'\"') %>
       # fields:
       #   - title: Priority
       #     value: High
@@ -57,14 +57,14 @@ issue_comment:
     :left_speech_bubble:
     <<%= sender.html_url %>|<%= sender.login %>>
     commented
-    on <<%= comment.html_url %>|<%= issue.title %>>
+    on <<%= comment.html_url %>|<%= issue.title.gsub(/"/,'\"') %>>
   attachments:
-    - fallback: <%= comment.body %>
+    - fallback: <%= comment.body.gsub(/"/,'\"') %>
       color: '#36a64f'
       author_name: <%= sender.login %>
       author_link: <%= sender.html_url %>
       author_icon: <%= sender.avatar_url %>
-      text: <%= comment.body %>
+      text: <%= comment.body.gsub(/"/,'\"') %>
 
 issues:
   text: >-
@@ -74,6 +74,15 @@ issues:
     issue <<%= issue.html_url %>|<%= issue.title %>>
     on <<%= repository.html_url %>|<%= repository.full_name %>>
 
+issues.assigned:
+  text: >-
+    :inbox_tray:
+    <<%= sender.html_url %>|<%= sender.login %>>
+    <%= action %>
+    issue <<%= issue.html_url %>|<%= issue.title %>>
+    on <<%= repository.html_url %>|<%= repository.full_name %>>
+    to [TODO whom]
+
 issues.opened:
   text: >-
     :inbox_tray:
@@ -134,12 +143,12 @@ pull_request_review_comment:
     new review comment
     on <<%= comment.html_url %>|<%= pull_request.title %>>
   attachments:
-    - fallback: <%= comment.body %>
+    - fallback: <%= comment.body.gsub(/"/,'\"') %>
       color: red
       author_name: <%= sender.login %>
       author_link: <%= sender.html_url %>
       author_icon: <%= sender.avatar_url %>
-      text: <%= comment.body %>
+      text: <%= comment.body.gsub(/"/,'\"') %>
 
 star:
   text: >-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gh-events
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Phil Hofmann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-27 00:00:00.000000000 Z
+date: 2020-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,30 +52,50 @@ dependencies:
     - - "~>"
       - !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-event2slack
+- gh-event2text
+- gh-events
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- exe/gh-event2slack
+- exe/gh-event2text
+- exe/gh-events
 - gh-events.gemspec
 - lib/gh-events.rb
 - lib/gh/events.rb
-- lib/gh/events/slack.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: []