github-web-hooks-receiver 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de99b9c01f899326fd8b4cf3422244ab1afbe6bc
+  data.tar.gz: 0638ab1bc10af285fce9e117074df11959e02975
+SHA512:
+  metadata.gz: 9e1ef74e2f4d9d411c7d69e4e9cb87b56c5396db505534b7cd3f51b85e31778255deaea5a6a6dadd90d0d4437b84c6214980b6557371067ffa7b5cea8938d94b
+  data.tar.gz: fd4b1e4779938c54b116d4d7a1ccddbf77699c0f4ec97bf61747578dced26904a7622394fa12be39d2373010e8dddb3d27f23451409d362c0d52b9bfc9f08147

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle/
+/Gemfile.lock
+/vendor/
+/test/.test-result/
+

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2
+notifications:
+  email:
+    recipients:
+      - commit@clear-code.com

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,212 @@
+[![Build Status](https://travis-ci.org/clear-code/github-web-hooks-receiver.svg?branch=master)](https://travis-ci.org/clear-code/github-web-hooks-receiver)
+
+# GitHub Web hooks receiver
+
+This is a Rack based web application that can process POST request from GitHub, GitLab and GHE.
+
+## Set up
+
+Prepare following files.
+
+/home/github-web-hooks-receiver/github-web-hooks-receiver/Gemfile:
+```
+source "https://rubygems.org"
+gem "github-web-hooks-receiver"
+# gem "unicorn"   # Enable this line if you use Unicorn.
+# gem "passenger" # Enable this line if you use latest Passenger.
+```
+
+/home/github-web-hooks-receiver/github-web-hooks-receiver/config.ru:
+```ruby
+require "yaml"
+require "pathname"
+require "github-web-hooks-receiver"
+
+use Rack::CommonLogger
+use Rack::Runtime
+use Rack::ContentLength
+
+base_dir = Pathname(__FILE__).dirname
+config_file = base_dir + "config.yaml"
+
+options = YAML.load_file(config_file.to_s)
+
+map "/post-receiver/" do
+  run GitHubWebHooksReceiver::App.new(options)
+end
+```
+
+/home/github-web-hooks-receiver/github-web-hooks-receiver/config.yaml:
+```
+to: receiver@example.com
+sender: sender@example.com
+add_html: true
+owners:
+  groonga:
+    to: groonga-commit@lists.sourceforge.jp
+```
+
+### Apache + Passenger
+
+On Debian GNU/Linux wheezy.
+
+See also [Phusion Passenger users guide, Apache version](https://www.phusionpassenger.com/documentation/Users%20guide%20Apache.html).
+
+Install Passenger or write `gem "passenger"` in your Gemfile.
+
+```
+$ sudo apt-get install -y ruby-passenger
+```
+
+Install gems.
+
+```
+$ sudo -u github-web-hooks-receiver -H bundle install --path vendor/bundle
+```
+
+Prepare following files.
+
+/etc/apache2/mods-available.conf:
+```
+PassengerRoot /path/to/passenger-x.x.x
+PassengerRuby /path/to/ruby
+
+PassengerMaxRequests 100
+```
+
+/etc/apache2/mods-available.load:
+```
+LoadModule passenger_module /path/to/mod_passenger.so
+```
+
+/etc/apache2/sites-available/github-web-hooks-receiver:
+```
+<VirtualHost *:80>
+  ServerName github-web-hooks-receiver.example.com
+  DocumentRoot /home/github-web-hooks-receiver/github-web-hooks-receiver/public
+  <Directory /home/github-web-hooks-receiver/github-web-hooks-receiver/public>
+     AllowOverride all
+     Options -MultiViews
+  </Directory>
+
+  ErrorLog ${APACHE_LOG_DIR}/github-web-hooks-receiver_error.log
+  CustomLog ${APACHE_LOG_DIR}/github-web-hooks-receiver_access.log combined
+
+  AllowEncodedSlashes On
+  AcceptPathInfo On
+</VirtualHost>
+```
+
+Enable the module.
+
+```
+$ sudo a2enmod passenger
+```
+
+Enable the virtual host.
+
+```
+$ sudo a2ensite github-web-hooks-receiver
+```
+
+Restart web server.
+
+```
+$ sudo service apache2 restart
+```
+
+### Nginx + Unicorn
+
+Prepare following files.
+
+/etc/nginx/sites-enabled/github-web-hooks-receiver:
+```
+upstream github-web-hooks-receiver {
+    server unix:/tmp/unicorn-github-web-hooks-receiver.sock;
+}
+
+server {
+    listen 80;
+    server_name github-web-hooks-receiver.example.com;
+    access_log /var/log/nginx/github-web-hooks-receiver.example.com-access.log combined;
+
+    root /srv/www/github-web-hooks-receiver;
+    index index.html;
+
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header Host $http_host;
+    #proxy_redirect off;
+
+    location / {
+        root /home/github-web-hooks-receiver/github-web-hooks-receiver/public;
+        include maintenance;
+        if (-f $request_filename){
+            break;
+        }
+        if (!-f $request_filename){
+            proxy_pass http://github-web-hooks-receiver;
+            break;
+        }
+    }
+}
+```
+
+/home/github-web-hooks-receiver/github-web-hooks-receiver/unicorn.conf:
+```
+# -*- ruby -*-
+worker_processes 2
+working_directory "/home/github-web-hooks-receiver/github-web-hooks-receiver"
+listen '/tmp/unicorn-github-post-receiver.sock', :backlog => 1
+timeout 120
+pid 'tmp/pids/unicorn.pid'
+preload_app true
+stderr_path 'log/unicorn.log'
+stdout_path "log/stdout.log"
+user "github-web-hooks-receiver", "github-web-hooks-receiver"
+```
+
+/home/github-web-hooks-receiver/bin/github-web-hooks-receiver:
+```
+#! /bin/zsh
+BASE_DIR=/home/github-web-hooks-receiver/github-web-hooks-receiver
+export RACK_ENV=production
+cd  $BASE_DIR
+rbenv version
+
+command=$1
+
+function start() {
+  mkdir -p $BASE_DIR/tmp/pids
+  mkdir -p $BASE_DIR/log
+  bundle exec unicorn -D -c unicorn.conf config.ru
+}
+
+function stop() {
+  kill $(cat $BASE_DIR/tmp/pids/unicorn.pid)
+}
+
+function restart() {
+  kill -USR2 $(cat $BASE_DIR/tmp/pids/unicorn.pid)
+}
+
+$command
+```
+
+Install gems.
+
+```
+$ sudo -u github-web-hooks-receiver -H bundle install --path vendor/bundle
+```
+
+Run the application.
+
+```
+$ sudo -u github-web-hooks-receiver -H ~github-web-hooks-receiver/bin/github-web-hooks-receiver start
+```
+
+## Configuration
+
+You need to edit config.yaml to configure this web application.
+See config.yaml.example and test codes.
+

data/Rakefile

@@ -0,0 +1,23 @@
+# Copyright (C) 2012-2013  Kouhei Sutou <kou@clear-code.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "bundler/gem_tasks"
+
+task :default => :test
+
+desc "Run test"
+task :test do
+  ruby("test/run-test.rb")
+end

data/config.ru

@@ -0,0 +1,52 @@
+# -*- mode: ruby; coding: utf-8 -*-
+#
+# Copyright (C) 2010-2013  Kouhei Sutou <kou@clear-code.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "yaml"
+
+require "pathname"
+
+base_dir = Pathname(__FILE__).dirname
+lib_dir = base_dir + "lib"
+
+racknga_base_dir = base_dir.parent.parent + "racknga"
+racknga_lib_dir = racknga_base_dir + "lib"
+
+$LOAD_PATH.unshift(racknga_lib_dir.to_s)
+$LOAD_PATH.unshift(lib_dir.to_s)
+
+require "github-web-hooks-receiver"
+
+require "racknga/middleware/exception_notifier"
+
+use Rack::CommonLogger
+use Rack::Runtime
+use Rack::ContentLength
+
+config_file = base_dir + "config.yaml"
+options = YAML.load_file(config_file.to_s)
+notifier_options = options.dup
+if options[:error_to]
+  notifier_options[:to] = options[:error_to]
+end
+notifier_options.merge!(options["exception_notifier"] || {})
+notifiers = [Racknga::ExceptionMailNotifier.new(notifier_options)]
+use Racknga::Middleware::ExceptionNotifier, :notifiers => notifiers
+
+map "/post-receiver/" do
+  run GitHubWebHooksReceiver::App.new(options)
+end
+

data/config.yaml.example

@@ -0,0 +1,20 @@
+private_token: VERYSECRETTOKEN
+gitlab_api_end_point: https://gitlab.example.com/api/v3
+web_hooks:
+  - http://gh.example.com/post-receiver1
+  - http://gh.example.com/post-receiver2
+  - http://gh.example.com/post-receiver3
+to: receiver@example.com
+error_to: admin@example.com
+exception_notifier:
+  subject_label: "[git-utils]"
+sender: sender@example.com
+add_html: true
+owners:
+  ranguba:
+    to: groonga-commit@rubyforge.org
+    repositories:
+      examples:
+        to: null@example.com
+  groonga:
+    to: groonga-commit@lists.sourceforge.jp

data/github-web-hooks-receiver.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github-web-hooks-receiver/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "github-web-hooks-receiver"
+  spec.version       = GitHubWebHooksReceiver::VERSION
+  spec.authors       = ["Kouhei Sutou", "Kenji Okimoto"]
+  spec.email         = ["kou@clear-code.com", "okimoto@clear-code.com"]
+  spec.summary       = %q{GitHub web hook receiver}
+  spec.description   = %q{GitHub web hook receiver}
+  spec.homepage      = ""
+  spec.license       = "GPL-3.0+"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rack"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "test-unit-rr"
+  spec.add_development_dependency "test-unit-capybara"
+end

data/lib/github-web-hooks-receiver.rb

@@ -0,0 +1,29 @@
+# Copyright (C) 2010-2013  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2015  Kenji Okimoto <okimoto@clear-code.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "fileutils"
+require "webrick/httpstatus"
+require "shellwords"
+require "uri"
+
+require "rubygems"
+require "json"
+
+module GitHubWebHooksReceiver
+end
+
+require "github-web-hooks-receiver/app"
+require "github-web-hooks-receiver/version"

data/lib/github-web-hooks-receiver/app.rb

@@ -0,0 +1,239 @@
+# Copyright (C) 2010-2013  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2015  Kenji Okimoto <okimoto@clear-code.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "github-web-hooks-receiver/base"
+require "github-web-hooks-receiver/path-resolver"
+require "github-web-hooks-receiver/payload"
+require "github-web-hooks-receiver/repository"
+
+module GitHubWebHooksReceiver
+  class App < Base
+    include PathResolver
+
+    private
+
+    def process_payload(request, response, raw_payload)
+      metadata = {
+        "x-github-event" => github_event(request),
+      }
+      payload = Payload.new(raw_payload, metadata)
+      case payload.event_name
+      when "ping"
+        # Do nothing
+      when "push", nil # nil is for GitLab
+        process_push_payload(request, response, payload)
+      when "gollum"
+        process_gollum_payload(request, response, payload)
+      else
+        set_error_response(response,
+                           :bad_request,
+                           "Unsupported event: <#{payload.event_name}>")
+      end
+    end
+
+    def github_event(request)
+      request.env["HTTP_X_GITHUB_EVENT"]
+    end
+
+    def process_push_payload(request, response, payload)
+      repository = process_payload_repository(request, response, payload)
+      return if repository.nil?
+      change = process_push_parameters(request, response, payload)
+      return if change.nil?
+      repository.process(*change)
+    end
+
+    def process_gollum_payload(request, response, payload)
+      repository = process_payload_repository(request, response, payload)
+      return if repository.nil?
+      change = process_gollum_parameters(request, response, payload)
+      return if change.nil?
+      repository.process(*change)
+    end
+
+    def process_payload_repository(request, response, payload)
+      repository = payload["repository"]
+      if repository.nil?
+        set_error_response(response, :bad_request,
+                           "repository information is missing")
+        return
+      end
+
+      unless repository.is_a?(Hash)
+        set_error_response(response, :bad_request,
+                           "invalid repository information format: " +
+                           "<#{repository.inspect}>")
+        return
+      end
+
+      repository_uri = repository["url"]
+      domain = extract_domain(repository_uri)
+      if domain.nil?
+        set_error_response(response, :bad_request,
+                           "invalid repository URI: <#{repository.inspect}>")
+        return
+      end
+
+      repository_name = repository["name"]
+      if repository_name.nil?
+        set_error_response(response, :bad_request,
+                           "repository name is missing: <#{repository.inspect}>")
+        return
+      end
+
+      owner_name = extract_owner_name(repository_uri, payload)
+      if owner_name.nil?
+        set_error_response(response, :bad_request,
+                           "repository owner or owner name is missing: " +
+                           "<#{repository.inspect}>")
+        return
+      end
+
+      options = repository_options(domain, owner_name, repository_name)
+      repository = repository_class.new(domain, owner_name, repository_name,
+                                        payload, options)
+      unless repository.target?
+        set_error_response(response, :forbidden,
+                           "unacceptable repository: " +
+                           "<#{owner_name.inspect}>:<#{repository_name.inspect}>")
+        return
+      end
+
+      repository
+    end
+
+    def extract_domain(repository_uri)
+      domain = nil
+      case repository_uri
+      when /\Agit@/
+        domain = repository_uri[/@(.+):/, 1]
+      when /\Ahttps:\/\//
+        domain = URI.parse(repository_uri).hostname
+      else
+        return
+      end
+      domain
+    end
+
+    def extract_owner_name(repository_uri, payload)
+      owner_name = nil
+      repository = payload["repository"]
+      if payload.gitlab?
+        case repository_uri
+        when /\Agit@/
+          owner_name = repository_uri[%r!git@.+:(.+)/.+(?:.git)?!, 1]
+        when /\Ahttps:\/\//
+          owner_name = URI.parse(repository_uri).path.sub(/\A\//, "")
+        else
+          return
+        end
+      else
+        owner = repository["owner"]
+        return if owner.nil?
+
+        owner_name = owner["name"] || owner["login"]
+        return if owner_name.nil?
+      end
+      owner_name
+    end
+
+    def process_push_parameters(request, response, payload)
+      before = payload["before"]
+      if before.nil?
+        set_error_response(response, :bad_request,
+                           "before commit ID is missing")
+        return
+      end
+
+      after = payload["after"]
+      if after.nil?
+        set_error_response(response, :bad_request,
+                           "after commit ID is missing")
+        return
+      end
+
+      reference = payload["ref"]
+      if reference.nil?
+        set_error_response(response, :bad_request,
+                           "reference is missing")
+        return
+      end
+
+      [before, after, reference]
+    end
+
+    def process_gollum_parameters(request, response, payload)
+      pages = payload["pages"]
+      if pages.nil?
+        set_error_response(response, :bad_request,
+                           "pages are missing")
+        return
+      end
+      if pages.empty?
+        set_error_response(response, :bad_request,
+                           "no pages")
+      end
+
+      revisions = pages.collect do |page|
+        page["sha"]
+      end
+
+      if revisions.size == 1
+        after = revisions.first
+        before = "#{after}^"
+      else
+        before = revisions.first
+        after = revisions.last
+      end
+
+      reference = "refs/heads/master"
+      [before, after, reference]
+    end
+
+    def set_error_response(response, status_keyword, message)
+      response.status = status(status_keyword)
+      response["Content-Type"] = "text/plain"
+      response.write(message)
+    end
+
+    def repository_class
+      @options[:repository_class] || Repository
+    end
+
+    def repository_options(domain, owner_name, repository_name)
+      domain_options = (@options[:domains] || {})[domain] || {}
+      domain_options = symbolize_options(domain_options)
+      domain_owner_options = (domain_options[:owners] || {})[owner_name] || {}
+      domain_owner_options = symbolize_options(domain_owner_options)
+      domain_repository_options = (domain_owner_options[:repositories] || {})[repository_name] || {}
+      domain_repository_options = symbolize_options(domain_repository_options)
+
+      owner_options = (@options[:owners] || {})[owner_name] || {}
+      owner_options = symbolize_options(owner_options)
+      _repository_options = (owner_options[:repositories] || {})[repository_name] || {}
+      _repository_options = symbolize_options(_repository_options)
+
+      options = @options.merge(owner_options)
+      options = options.merge(owner_options)
+      options = options.merge(_repository_options)
+
+      options = options.merge(domain_options)
+      options = options.merge(domain_owner_options)
+      options = options.merge(domain_repository_options)
+      options
+    end
+  end
+end