gh-events 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1cff1386c5673a98772cf99e50149162e0f010f65c8e59a6bb40779fbc10233
-  data.tar.gz: fede3370b5bd12f80c75a6cc4b239e324df11bbc0d970419ef4a44eab3f4a7bc
+  metadata.gz: d72e0e3c68c3ae74cb92b5cdb3f88a62bdc580ae17c218dc7a95f826384919fa
+  data.tar.gz: 7243fd7c7e131e0b92aca3007437cabe2cfa748ff97f64fca48d7571526a4fcf
 SHA512:
-  metadata.gz: 70e2bd1df73c6641d6645d40804e7526de092512fd068d02924f7d8a5966d1cb2a120a6d3e38894f77ee4cb390992dfc63b3db81c6f10c401cc620fed61b9944
-  data.tar.gz: 8dd77aaaed11e14dccb267a86f9ce211998cd91bb45de3c8db8f53dec76d8fbc837e45d9a4a0551489ac79a14f6e50f9f9f64ebc7e9984c789b037ceed9fd489
+  metadata.gz: 6d9ef168472148d3c411a7b2f94b03f671784afc5dacfde8cf92bb0384a0a619cd12dd5367e7552510ce2fa710300d626da23cbe6337a08e7fe2f5acd5ab17b2
+  data.tar.gz: a1ab78c4b59b1cb67c78a9436a212f91043d98dc330f75742cc66c163cc844c9d942361e1217bb575c33779d674cb66a6b62326216a02acbafca432b2cbaebf4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gh-events (0.8.0)
+    gh-events (0.8.1)
 
 GEM
   remote: https://rubygems.org/
@@ -35,4 +35,4 @@ DEPENDENCIES
   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,14 +1,50 @@
 # Github Events
 
-Via Webhooks Github can send a plethora of events, which can be used to facilitate all kinds of automation.
+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.)
+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 into a human readable textutal representation. This functionality is wrapped in a command line utility, for your convenience.
+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.
 
-## Example Usage
 
-You can use the command `gh-events` to list the types of events stortef in JSON files.
+## 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
+gem 'gh-events'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+### 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
@@ -21,28 +57,37 @@ events/006.json: fork
 ...
 ```
 
-Let's say you have a github _commit_comment_ event stored in a file `event.json`
+#### 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:\""
 ```
 
-## Installation
+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.
 
-Add this line to your application's Gemfile:
+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.
 
-```ruby
-gem 'gh-events'
-```
+If you write your own dictionary for other target systems, please
+consider to contribute.
 
-And then execute:
+TODO: elaborate on how the lookup of types works
 
-    $ bundle
 
-Or install it yourself as:
+### Library
+
+TODO: add an example
 
-    $ gem install gh-events
 
 ## References
 

data/lib/gh/events/text.rb

@@ -47,7 +47,7 @@ module GH::Events::Text
     # if there is no template use a default
     template ||= templates['no_template']
 
-    render(template, event)
+    render(template, event).gsub("\n", "\\n")
   end
 
   def templates_file(dict)

data/lib/gh/events/version.rb

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

data/res/slack.yml

@@ -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:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gh-events
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Phil Hofmann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-02 00:00:00.000000000 Z
+date: 2020-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,6 +81,7 @@ files:
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/console