gh-events 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 816a9b68c1d37a66b90de0a48614bd57b94715faa53a5edd8245a2fe5e5a2d5b
-  data.tar.gz: 752dc0d3e42566b280b75fc39cacf4c456b4c16e7132366516fe5dd77166b138
+  metadata.gz: e1cff1386c5673a98772cf99e50149162e0f010f65c8e59a6bb40779fbc10233
+  data.tar.gz: fede3370b5bd12f80c75a6cc4b239e324df11bbc0d970419ef4a44eab3f4a7bc
 SHA512:
-  metadata.gz: 3ee613e1900e42bfe45554e8d4cf36800bcb6fb14524d24faf89b2d8a20213603960f5f1c7c0ad47149bf51bd3bd48f5b0da5473e9dbb75e26a88ad31efc95d3
-  data.tar.gz: f273b92f4fe2124555e42c5c60391e75a6c7d941825047ea6ea1613b2324036f44c536763f7c9da36a93c7d3f2cea83687f4cd0ba09f16020b24801a8d41791c
+  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/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gh-events (0.7.0)
+    gh-events (0.8.0)
 
 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

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

@@ -6,6 +6,10 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gh/events'
 
 ARGV.each do |file|
-  type = GH::Events.typeof(File.read(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/{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,7 +42,7 @@ 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']
@@ -46,12 +50,14 @@ module GH::Events::Slack
     render(template, event)
   end
 
-  def templates_file
-    File.expand_path(File.join(%w(.. .. .. .. res slack.yml)), __FILE__)
-  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)
 
-  def templates
-    @templates ||= YAML.load_file(templates_file)
+    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.7.0"
+    VERSION = "0.8.0"
   end
 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'
@@ -16,7 +17,8 @@ module GH
     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/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 %>`)"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gh-events
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Phil Hofmann
@@ -52,15 +52,30 @@ 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"
@@ -70,14 +85,16 @@ files:
 - 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: []