githook 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a2e2d13b18491f2527d99f809e9437936d61390
-  data.tar.gz: 68f87cbf610aca114c7af8077947f43939deb9ad
+  metadata.gz: 343adffd4b44ce17f0a0986d0288d448e1d2aa42
+  data.tar.gz: 656d009224e57a9f31a02266e4f0bc77a0d579ac
 SHA512:
-  metadata.gz: 3a291f330588cf5fdd0b53a281d8570244c011c907c4dbcb61e1af1853ca7e22985ff13a47a43a4b9fae9a7d01cd2d8e8a226c9def90209067d639e926a29954
-  data.tar.gz: 80c43f28f19ccf6327fbbf254b3e51c53f8b4bd4cbce582b7d65a07c354e850a6312721ca3eb8da8d16fb45e26241e9b869bc645ce024a75bc47ef1d88f707f3
+  metadata.gz: 9f061b511a75ce10cded9b983ba46f62e787722cba89a45cffeb65a50b49912d72954f48382219591a79e8e547144e1bed99c42a42ae565619de14e65d9961b0
+  data.tar.gz: aff4ca2ded4914aacf8ce9c719cb018ad0441746511bc76b2dbaa3a9da9072986504989b1ac95b03937e0728b294791481a4f17952c554b9b828773d85fc6fea

data/lib/githook/bot.rb

@@ -4,16 +4,16 @@ module Githook
   class Bot
     attr_accessor :github_client
 
+    # TODO: Grow list will grow in future changes.
+    SUPPORTED_ACTIONS = %w(issue_comment issues pull_request pull_request_review_comment)
+
     def initialize(configs = {})
       access_token = configs[:access_token]
       @logger = configs[:logger] || Logger.new(STDOUT)
 
       raise "No Github access token was provided. Your bot will be unable to perform Github actions on your behalf." unless access_token
 
-      @github_client = Octokit::Client.new({access_token:
-        access_token
-      })
-
+      @github_client = Octokit::Client.new(access_token: access_token)
       @registry = {}
     end
 
@@ -33,6 +33,7 @@ module Githook
 
     @actions = []
     def when(event_action)
+
       @actions << event_action
 
       self
@@ -40,16 +41,24 @@ module Githook
 
     @event_type = nil
     def on(event_type)
+      raise "Github event '#{event}' is not supported by Githook" unless SUPPORTED_ACTIONS.include?(event_type)
+
       @event_type = event_type
       @actions = []
 
       self
     end
 
-    def process(body)
-      event_info = github_event(body)
+    def process(body, event)
+      unless SUPPORTED_ACTIONS.include?(event)
+        @logger.info("Github event '#{event}' is not supported by Githook")
+        return
+      end
+
+      action = body['action']
+      @logger.info("Detected the following GitHub event: action: #{action} event: #{event}")
 
-      handler = (@registry["#{event_info['event']}-#{event_info['action']}"] || @registry[event_info['event']])
+      handler = (@registry["#{event}-#{action}"] || @registry[event])
 
       if handler
         pr_info = body['pull_request'] || body['issue']
@@ -58,17 +67,5 @@ module Githook
         handler.call(pr)
       end
     end
-
-  private
-    def github_event(body)
-      # Normally the GitHub event is present in the X-GitHub-Event headers but sometimes
-      # that header is absent in which case we need to brute force it.
-      events = %w(commit_comment create delete deployment deployment_status fork gollum issue_comment issue pull_request)
-
-      event = (body.keys & events).first # should only ever be one
-
-      @logger.info("Detected the following GitHub event: action: #{body['action']} event: #{event}")
-      {'action' => body['action'], 'event' => event}
-    end
   end
 end

data/lib/githook/server.rb

@@ -0,0 +1,35 @@
+require 'rack'
+
+module Githook
+  class Server
+    attr_accessor :bot
+
+    GITHUB_EVENT_HEADER = 'HTTP_X_GITHUB_EVENT'
+
+    def initialize(bot)
+      @bot = bot
+    end
+
+    def listen(route = nil)
+      app = Proc.new do |env|
+        callback_route = route.start_with?('/') ? route : "/#{route}"
+        if env['PATH_INFO'] == callback_route
+          body = JSON.parse(env['rack.input'].gets)
+          @bot.process(body, env[GITHUB_EVENT_HEADER])
+
+          ['200', {'Content-Type' => 'application/json'}, ["{\"message\": \"Success\"}"]]
+        else
+          ['404', {'Content-Type' => 'application/json'}, ["{\"message\": \"Not Found\"}"]]
+        end
+      end
+
+      bot_server = Rack::Server.new(
+        app: app,
+        server: 'webrick',
+        Port: 3002
+      )
+
+      bot_server.start
+    end
+  end
+end

data/lib/githook/version.rb

@@ -1,3 +1,3 @@
 module Githook
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/githook.rb

@@ -1,3 +1,4 @@
 require 'octokit'
 require 'githook/bot'
 require 'githook/event_objects/pull_request'
+require 'githook/server'

data/spec/bot_server_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Githook::Server do
+  context '#listen' do
+    let(:mybot) { Githook::Bot.new(access_token: 'xxxxxxfakexxxx') }
+    let(:myserver) { Githook::Server.new(mybot) }
+
+    it 'calls listen' do
+#      expect{ myserver.listen('/payload') }.to_not raise_error
+    end
+  end
+end
+

data/spec/githook_spec.rb

@@ -14,7 +14,7 @@ describe Githook do
     it 'invokes the handler that matches the event type and action' do
       mybot.on('pull_request').when('opened').perform(&handler)
       expect(handler).to receive(:call)
-      mybot.process(WEBHOOK_REQUESTS['spec/webhooks/opened_pr.json'])
+      mybot.process(WEBHOOK_REQUESTS['spec/webhooks/opened_pr.json'], 'pull_request')
     end
 
     it 'passes an appropriate object to the invoked block' do
@@ -25,7 +25,7 @@ describe Githook do
       end
 
       mybot.on('pull_request').when('opened').perform(&complex_handler)
-      expect{ mybot.process(WEBHOOK_REQUESTS['spec/webhooks/opened_pr.json']) }.to_not raise_error
+      expect{ mybot.process(WEBHOOK_REQUESTS['spec/webhooks/opened_pr.json'], 'pull_request') }.to_not raise_error
     end
   end
 
@@ -40,6 +40,11 @@ describe Githook do
       expect(mybot.registry['pull_request']).to eq(nil)
     end
 
+    it 'raises an error if registering an invalid Github event' do
+      handler = Proc.new {|pr| true}
+      expect{ mybot.on('crayons').when('opened').perform(&handler) }.to raise_error
+    end
+
     it "registers handler only for the event if no action is specified" do
       handler = Proc.new {|pr| true}
       mybot.on('pull_request').perform(&handler)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: githook
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Michael West
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-28 00:00:00.000000000 Z
+date: 2015-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: 
 executables: []
@@ -32,9 +46,10 @@ extra_rdoc_files: []
 files:
 - lib/githook.rb
 - lib/githook/bot.rb
-- lib/githook/bot_server.rb
 - lib/githook/event_objects/pull_request.rb
+- lib/githook/server.rb
 - lib/githook/version.rb
+- spec/bot_server_spec.rb
 - spec/githook_spec.rb
 - spec/spec_helper.rb
 - spec/webhooks/README.md
@@ -67,6 +82,7 @@ specification_version: 4
 summary: A Ruby DSL for defining your very own Github bot. The lingua franca for the
   DSL is Github webhook requests
 test_files:
+- spec/bot_server_spec.rb
 - spec/githook_spec.rb
 - spec/spec_helper.rb
 - spec/webhooks/README.md

data/lib/githook/bot_server.rb

@@ -1,15 +0,0 @@
-=begin
-require 'rack'
-
-module Githook
-  def self.listen(route = nil)
-    app = Proc.new do |env|
-      ['200', {'Content-Type' => 'application/json'}, ["{\"message\": \"Success\"}"]]
-    end
-
-    Rack::Server.new(
-      server: 'webrick',
-      Port: 3002
-  end
-end
-=end