gitlab-system-hooks-receiver 0.0.1

data/README.md

@@ -0,0 +1,96 @@
+# GitLabSystemHooksReceiver
+
+Process GitLab system hooks.
+
+For now, this Rack based web application appends web hooks to a new project on GitLab via system hooks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "gitlab-system-hooks-receiver"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gitlab-system-hooks-receiver
+
+## Usage
+
+### Use part of git-utils/github-post-receiver
+
+You can use this web application with [clear-code/git-utils](https://github.com/clear-code/git-utils "clear-code/git-utils").
+
+Clone [clear-code/git-utils](https://github.com/clear-code/git-utils "clear-code/git-utils").
+
+```
+$ git clone https://github.com/clear-code/git-utils.git
+```
+
+Add Gemfile.
+
+```
+source "https://rubygems.org/"
+
+gem "rack"
+gem "racknga"
+gem "unicorn"
+gem "gitlab-system-hooks-receiver"
+```
+
+NOTE: You can use passenger instead of unicorn.
+
+Do `bundle install`.
+
+Edit config.ru.
+
+```
+...
+require "gitlab-system-hooks-receiver"
+map "/system-hooks-receiver/" do
+  run GitLabSystemHooksReceiver.new(options)
+end
+```
+
+Configure your web server if you need.
+
+### Use standalone
+
+You can use this web application standalone.
+
+Clone this repository.
+
+```
+$ git clone https://github.com/clear-code/gitlab-system-hooks-receiver.git
+$ cd gitlab-system-hooks-receiver
+$ bundle install --path vendor/bundle
+$ bundle exec unicorn
+```
+
+Configure your web server if you need.
+
+### Configuration
+
+Add your config.yaml as followings.
+
+config.yaml
+```
+# private token for the user who has admin privilege
+private_token: VERY_SECRET_TOKEN
+api_end_point: https://gitlab.example.com/api/v3
+web_hooks:
+  - http://hook.example.com/post-receiver1
+  - http://hook.example.com/post-receiver2
+  - http://hook.example.com/post-receiver3
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/clear-code/gitlab-system-hooks-receiver/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,33 @@
+# Copyright (C) 2014 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 "bundler/gem_helper"
+
+module Bundler
+  class GemHelper
+    def version_tag
+      "#{version}"
+    end
+  end
+end
+
+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,51 @@
+# -*- mode: ruby; coding: utf-8 -*-
+#
+# Copyright (C) 2014  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 "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 "gitlab-system-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 "/system-hooks-receiver/" do
+  run GitLabSystemHooksReceiver.new(options)
+end

data/config.yaml.example

@@ -0,0 +1,6 @@
+private_token: VERY_SECRET_TOKEN
+api_end_point: https://gitlab.example.com/api/v3
+web_hooks:
+  - http://git-utils.example.com/post-receiver1
+  - http://git-utils.example.com/post-receiver2
+  - http://git-utils.example.com/post-receiver3

data/gitlab-system-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 "gitlab-system-hooks-receiver/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gitlab-system-hooks-receiver"
+  spec.version       = GitLabSystemHooksReceiver::VERSION
+  spec.authors       = ["Kenji Okimoto"]
+  spec.email         = ["okimoto@clear-code.com"]
+  spec.summary       = %q{Process GitLab System hooks.}
+  spec.description   = %q{Process GitLab System hooks.}
+  spec.homepage      = ""
+  spec.license       = "GPLv3 or later"
+
+  spec.files         = `git ls-files`.split($/)
+  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", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "test-unit-rr"
+  spec.add_development_dependency "test-unit-capybara"
+end

data/lib/gitlab-system-hooks-receiver.rb

@@ -0,0 +1,146 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2014  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 "net/http"
+require "net/https"
+require "webrick/httpstatus"
+require "json"
+
+class GitLabSystemHooksReceiver
+
+  def initialize(options={})
+    @options = symbolize_options(options)
+  end
+
+  def call(env)
+    request = Rack::Request.new(env)
+    response = Rack::Response.new
+    process(request, response)
+    response.to_a
+  end
+
+  private
+
+  def production?
+    ENV["RACK_ENV"] == "production"
+  end
+
+  def symbolize_options(options)
+    symbolized_options = {}
+    options.each do |key, value|
+      symbolized_options[key.to_sym] = value
+    end
+    symbolized_options
+  end
+
+  KEYWORD_TO_HTTP_STATUS_CODE = {}
+  WEBrick::HTTPStatus::StatusMessage.each do |code, message|
+    KEYWORD_TO_HTTP_STATUS_CODE[message.downcase.gsub(/ +/, '_').intern] = code
+  end
+
+  def status(keyword)
+    code = KEYWORD_TO_HTTP_STATUS_CODE[keyword]
+    if code.nil?
+      raise ArgumentError, "invalid status keyword: #{keyword.inspect}"
+    end
+    code
+  end
+
+  def set_error_response(response, status_keyword, message)
+    response.status = status(status_keyword)
+    response["Content-Type"] = "text/plain"
+    response.write(message)
+  end
+
+  def process(request, response)
+    unless request.post?
+      set_error_response(response, :method_not_allowed, "must POST")
+      return
+    end
+
+    payload = parse_payload(request, response)
+    return if payload.nil?
+    process_payload(request, response, payload)
+  end
+
+  def parse_payload(request, response)
+    if request.content_type == "application/json"
+      payload = request.body.read
+    else
+      payload = request["payload"]
+    end
+    if payload.nil?
+      set_error_response(response, :bad_request, "payload is missing")
+      return
+    end
+
+    begin
+      JSON.parse(payload)
+    rescue JSON::ParserError
+      set_error_response(response, :bad_request,
+                         "invalid JSON format: <#{$!.message}>")
+      nil
+    end
+  end
+
+  def process_payload(request, response, payload)
+    event_name = payload["event_name"]
+    __send__("process_#{event_name}_event", request, response, payload)
+  end
+
+  def process_project_create_event(request, response, payload)
+    # TODO notify to owner
+    owner_email = payload["owner_email"]
+    project_id = payload["project_id"]
+    @options[:web_hooks].each do |web_hook|
+      add_project_hook(project_id, web_hook)
+    end
+  end
+
+  def method_missing(name, *args)
+    if name =~ /\Aprocess_.*_event\z/
+      puts name
+    else
+      super
+    end
+  end
+
+  #
+  # POST #{GitLabURI}/projects/:id/hooks
+  #
+  def add_project_hook(project_id, hook_uri)
+    api_end_point_uri = URI.parse(@options[:api_end_point])
+    path = File.join(api_end_point_uri.path, "projects", project_id.to_s, "hooks")
+    post_request = Net::HTTP::Post.new(path)
+    # push_events is enabled by default
+    post_request.set_form_data("url" => hook_uri,
+                               "private_token" => @options[:private_token])
+    http = Net::HTTP.new(api_end_point_uri.host, api_end_point_uri.port)
+    if api_end_point_uri.scheme == "https"
+      http.use_ssl = true
+      http.ca_path = "/etc/ssl/certs"
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      http.verify_depth = 5
+    end
+    response = nil
+    http.start do
+      response = http.request(post_request)
+    end
+
+    response
+  end
+end

data/lib/gitlab-system-hooks-receiver/version.rb

@@ -0,0 +1,4 @@
+# -*- coding: us-ascii -*-
+class GitLabSystemHooksReceiver
+  VERSION = "0.0.1"
+end

data/test/run-test.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2010-2013  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2014       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/>.
+
+$VERBOSE = true
+
+base_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+lib_dir = File.join(base_dir, "lib")
+test_dir = File.join(base_dir, "test")
+
+require "test-unit"
+require "test/unit/capybara"
+require "test/unit/rr"
+
+$LOAD_PATH.unshift(lib_dir)
+
+$LOAD_PATH.unshift(test_dir)
+require "test-utils"
+
+exit Test::Unit::AutoRunner.run(true, test_dir)

data/test/system-hooks-receiver-test.rb

@@ -0,0 +1,86 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2014  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 "yaml"
+require "gitlab-system-hooks-receiver"
+
+class SystemHooksReceiverTest < Test::Unit::TestCase
+  include TestUtils
+
+  def setup
+    test_dir = File.dirname(__FILE__)
+    @fixtures_dir = File.join(test_dir, "fixtures")
+    @tmp_dir = File.join(test_dir, "tmp")
+    FileUtils.mkdir_p(@tmp_dir)
+    Capybara.app = app
+  end
+
+  def teardown
+    FileUtils.rm_rf(@tmp_dir)
+  end
+
+  def app
+    GitLabSystemHooksReceiver.new(options)
+  end
+
+  def test_get
+    visit "/"
+    assert_response("Method Not Allowed")
+  end
+
+  def test_post_without_parameters
+    page.driver.post("/")
+    assert_response("Bad Request")
+    assert_equal("payload is missing", body)
+  end
+
+  def test_create_project
+    @options[:web_hooks].each do |web_hook|
+      mock(Capybara.app).add_project_hook(42, web_hook)
+    end
+    payload = {
+      created_at: "2014-03-13T07:30:54Z",
+      event_name: "project_create",
+      name: "ExampleProject",
+      owner_email: "johnsmith@example.com",
+      owner_name: "John Smith",
+      path: "exampleproject",
+      path_with_namespace: "jsmith/exampleproject",
+      project_id: 42,
+    }
+    post_payload(payload)
+    assert_response("OK")
+  end
+
+  private
+
+  def post_payload(payload)
+    page.driver.post("/", :payload => JSON.generate(payload))
+  end
+
+  def options
+    @options ||= {
+      :private_token => "VERYSECRETTOKEN",
+      :gitlab_api_end_point_uri => "https://gitlab.example.com/api/v3",
+      :web_hooks => [
+        "https://hook.example.com/post-receiver1",
+        "https://hook.example.com/post-receiver2",
+        "https://hook.example.com/post-receiver3"
+      ]
+    }
+  end
+end
+