github_webhook 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 285de73545052ef08df5f6196afbc7f8518c0623
-  data.tar.gz: 5cb6d51070167f9b52273bfef55bbd4f2a669240
+  metadata.gz: ebcf435b142dbc33048434ccece05593df374855
+  data.tar.gz: 685a3cc522b13a99f1e21867ce0aa7c2b5777770
 SHA512:
-  metadata.gz: 8fb9d9ab34f1938decb04a19e37229a1a0e614cea6857b419f9fabb0db2d4d979945276b7873165158433533a65510a729f18fed0311123e7a0c231c263e9de5
-  data.tar.gz: 7e64a43a655c9773cf524dd28783a0cb3967a0518d7439a8dbdd4a75e0e59c84b79aff9eeaaa5ce2d43fca0fac95f8f0725c3084e00c73bc9a1d9c398409c25c
+  metadata.gz: 63c28c385cee31dd18b91f3c0e3e418d8af53ddf43eae9abf6df923934df01aea7c9e60731ff9bb8b1609dc04c449c4100943b94d34203350be9e28c50c62ef4
+  data.tar.gz: 980d7ca90fb8028c1ed5670cce359f25a9b846a18078b6f5129603ff378e7a41ea157626e3480adb6b0374482f67c1b9f3811215ed005a8190a424f1cd8cbcd9

data/Gemfile.lock

@@ -15,7 +15,7 @@ GEM
       tzinfo (~> 1.1)
     diff-lcs (1.2.5)
     i18n (0.6.9)
-    json (1.8.1)
+    json (1.8.3)
     minitest (5.3.5)
     rake (10.3.1)
     rspec (2.14.1)
@@ -38,3 +38,6 @@ DEPENDENCIES
   github_webhook!
   rake (~> 10.1)
   rspec (~> 2.14)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -12,7 +12,7 @@ to a [GitHub webhook](https://developer.github.com/webhooks/)
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'github_webhook'
+gem 'github_webhook', '~> 0.3.0'
 ```
 
 And then execute:
@@ -35,11 +35,15 @@ Then create a new controller:
 class GithubWebhooksController < ActionController::Base
   include GithubWebhook::Processor
 
-  def push(payload)
+  # Handle push event
+  def github_push(payload)
     # TODO: handle push webhook
   end
 
-  private
+  # Handle create event
+  def github_create(payload)
+    # TODO: handle create webhook
+  end
 
   def webhook_secret(payload)
     ENV['GITHUB_WEBHOOK_SECRET']
@@ -48,7 +52,11 @@ end
 ```
 
 Add as many instance methods as events you want to handle in
-your controller. You can read the [full list of events](https://developer.github.com/v3/activity/events/types/) GitHub can notify you about.
+your controller.
+
+All events are prefixed with `github_`. So, a `push` event can be handled by `github_push(payload)`, or a `create` event can be handled by `github_create(payload)`, etc.
+
+You can read the [full list of events](https://developer.github.com/v3/activity/events/types/) GitHub can notify you about.
 
 ## Adding the Webhook to your git repository:
 

data/lib/github_webhook/processor.rb

@@ -2,18 +2,22 @@ module GithubWebhook::Processor
   extend ActiveSupport::Concern
 
   included do
-    before_filter :authenticate_github_request!, :only => :create
+    before_filter :authenticate_github_request!, only: :create
+    before_filter :check_github_event!, only: :create
   end
 
   class SignatureError < StandardError; end
   class UnspecifiedWebhookSecretError < StandardError; end
+  class UnsupportedGithubEventError < StandardError; end
+
+  GITHUB_EVENTS_WHITELIST = %w(commit_comment create delete deployment deployment_status download follow fork fork_apply gist gollum issue_comment issues member membership page_build public pull_request pull_request_review_comment push release repository status team_add watch)
 
   def create
-    if self.respond_to? event
-      self.send event, json_body
+    if self.respond_to? event_method
+      self.send event_method, json_body
       head(:ok)
     else
-      raise NoMethodError.new("GithubWebhooksController##{event} not implemented")
+      raise NoMethodError.new("GithubWebhooksController##{event_method} not implemented")
     end
   end
 
@@ -35,6 +39,12 @@ module GithubWebhook::Processor
     end
   end
 
+  def check_github_event!
+    unless GITHUB_EVENTS_WHITELIST.include?(request.headers['X-GitHub-Event'])
+      raise UnsupportedGithubEventError.new("#{request.headers['X-GitHub-Event']} is not a whiltelisted GitHub event. See https://developer.github.com/v3/activity/events/types/")
+    end
+  end
+
   def request_body
     @request_body ||= (
       request.body.rewind
@@ -50,7 +60,7 @@ module GithubWebhook::Processor
     @signature_header ||= request.headers['X-Hub-Signature']
   end
 
-  def event
-    @event ||= request.headers['X-GitHub-Event'].to_sym
+  def event_method
+    @event_method ||= "github_#{request.headers['X-GitHub-Event']}".to_sym
   end
 end

data/lib/github_webhook/version.rb

@@ -1,3 +1,3 @@
 module GithubWebhook
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/github_webhook/processor_spec.rb

@@ -23,7 +23,7 @@ module GithubWebhook
 
       include GithubWebhook::Processor
 
-      def push(payload)
+      def github_push(payload)
         @pushed = payload[:foo]
       end
     end
@@ -46,7 +46,7 @@ module GithubWebhook
 
     describe "#create" do
       it "raises an error when secret is not defined" do
-        expect { controller_without_secret.send :authenticate_github_request! }.to raise_error
+        expect { controller_without_secret.send :authenticate_github_request! }.to raise_error(Processor::UnspecifiedWebhookSecretError)
       end
 
       it "calls the #push method in controller" do
@@ -55,20 +55,25 @@ module GithubWebhook
         controller.request.headers['X-GitHub-Event'] = 'push'
         controller.send :authenticate_github_request!  # Manually as we don't have the before_filter logic in our Mock object
         controller.create
-        controller.pushed.should eq "bar"
+        expect(controller.pushed).to eq "bar"
       end
 
       it "raises an error when signature does not match" do
         controller.request.body = StringIO.new({ :foo => "bar" }.to_json.to_s)
         controller.request.headers['X-Hub-Signature'] = "sha1=FOOBAR"
         controller.request.headers['X-GitHub-Event'] = 'push'
-        expect { controller_without_secret.send :authenticate_github_request! }.to raise_error
+        expect { controller.send :authenticate_github_request! }.to raise_error(Processor::SignatureError)
       end
 
       it "raises an error when the github event method is not implemented" do
-        controller.request.headers['X-GitHub-Event'] = 'unimplemented_event'
-        expect { controller_without_secret.create }.to raise_error
+        controller.request.headers['X-GitHub-Event'] = 'deployment'
+        expect { controller.create }.to raise_error(NoMethodError)
+      end
+
+      it "raises an error when the github event is not in the whitelist" do
+        controller.request.headers['X-GitHub-Event'] = 'fake_event'
+        expect { controller.send :check_github_event! }.to raise_error(Processor::UnsupportedGithubEventError)
       end
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_webhook
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sebastien Saunier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-20 00:00:00.000000000 Z
+date: 2016-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Process GitHub Webhooks in your Rails app (Controller mixin)