gh-events 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f9a4fc61ec5714b1d49249d449496180f7a7e378b327a9c2e8d7e467c06b9a5
-  data.tar.gz: 83d0c56649117b8a3f091215223467f327e326b28e81874e9dce4cb5e2ac61b7
+  metadata.gz: 816a9b68c1d37a66b90de0a48614bd57b94715faa53a5edd8245a2fe5e5a2d5b
+  data.tar.gz: 752dc0d3e42566b280b75fc39cacf4c456b4c16e7132366516fe5dd77166b138
 SHA512:
-  metadata.gz: 1e688bda0e36e9dee4b97b3a166bf2b1e2a574767a19099d666ec5ed1fa07c7d6e0193226b92b4d67d652f3228f990308dc700cfbb37f80bfce1abc7821e2189
-  data.tar.gz: dd7072f3c14de36c0f63c33430f129f790db2c0908f7ce900c84ee0c049427b1f442bdbf77360058d5670cf909141bbaa100bcf3204712c2dc220af602854bc8
+  metadata.gz: 3ee613e1900e42bfe45554e8d4cf36800bcb6fb14524d24faf89b2d8a20213603960f5f1c7c0ad47149bf51bd3bd48f5b0da5473e9dbb75e26a88ad31efc95d3
+  data.tar.gz: f273b92f4fe2124555e42c5c60391e75a6c7d941825047ea6ea1613b2324036f44c536763f7c9da36a93c7d3f2cea83687f4cd0ba09f16020b24801a8d41791c

data/Gemfile.lock

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

data/README.md

@@ -1,8 +1,32 @@
-# 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.
 
-TODO: Delete this and the text above, and describe your gem
+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
 
@@ -20,10 +44,6 @@ Or install it yourself as:
 
     $ gem install gh-events
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## References
 
 - https://developer.github.com/v3/activity/events/types/

data/exe/gh-events

@@ -0,0 +1,11 @@
+#!/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|
+  type = GH::Events.typeof(File.read(file))
+  puts "#{file}: #{type}"
+end

data/lib/gh/events.rb

@@ -14,6 +14,7 @@ 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)
       HEURISTICS.each do |type, characteristics|

data/lib/gh/events/version.rb

@@ -1,5 +1,5 @@
 module GH
   module Events
-    VERSION = "0.6.2"
+    VERSION = "0.7.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gh-events
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Phil Hofmann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-27 00:00:00.000000000 Z
+date: 2019-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,6 +57,7 @@ email:
 - phil@200ok.ch
 executables:
 - gh-event2slack
+- gh-events
 extensions: []
 extra_rdoc_files: []
 files:
@@ -70,6 +71,7 @@ files:
 - bin/console
 - bin/setup
 - exe/gh-event2slack
+- exe/gh-events
 - gh-events.gemspec
 - lib/gh-events.rb
 - lib/gh/events.rb