github-web-hooks-receiver 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de99b9c01f899326fd8b4cf3422244ab1afbe6bc
-  data.tar.gz: 0638ab1bc10af285fce9e117074df11959e02975
+  metadata.gz: 9ee5be645f09fb213a17ddab34dbae213360c97b
+  data.tar.gz: 59b19d6a18d006ab60ebccb5b690b094c20e97a4
 SHA512:
-  metadata.gz: 9e1ef74e2f4d9d411c7d69e4e9cb87b56c5396db505534b7cd3f51b85e31778255deaea5a6a6dadd90d0d4437b84c6214980b6557371067ffa7b5cea8938d94b
-  data.tar.gz: fd4b1e4779938c54b116d4d7a1ccddbf77699c0f4ec97bf61747578dced26904a7622394fa12be39d2373010e8dddb3d27f23451409d362c0d52b9bfc9f08147
+  metadata.gz: 25b01bbbd7ea6940bf1cb0865532eb9551030591b41b52e1c78d43bdf76a3148f898d4d388c2da80f710b741a3bacd2bd7534320021b0f2c089f422a67bbc4c9
+  data.tar.gz: 1c69e82f98aeba475370abd2513f44b76d6accb8059404904594282ec53ed066251c26ff32be806d76f8471aaa1ddb77fd8ae1c00ac247ee9e6d0160926b9826

data/.gitignore

@@ -2,4 +2,5 @@
 /Gemfile.lock
 /vendor/
 /test/.test-result/
-
+/mirrors/
+/pkg/

data/README.md

@@ -38,6 +38,8 @@ end
 
 /home/github-web-hooks-receiver/github-web-hooks-receiver/config.yaml:
 ```
+mirrors_directory: /path/to/mirrors
+git_commit_mailer: /path/to/git-commit-mailer
 to: receiver@example.com
 sender: sender@example.com
 add_html: true
@@ -209,4 +211,3 @@ $ sudo -u github-web-hooks-receiver -H ~github-web-hooks-receiver/bin/github-web
 
 You need to edit config.yaml to configure this web application.
 See config.yaml.example and test codes.
-

data/config.ru

@@ -1,6 +1,6 @@
 # -*- mode: ruby; coding: utf-8 -*-
 #
-# Copyright (C) 2010-2013  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2010-2015  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
@@ -39,8 +39,8 @@ 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]
+if options["error_to"]
+  notifier_options["to"] = options["error_to"]
 end
 notifier_options.merge!(options["exception_notifier"] || {})
 notifiers = [Racknga::ExceptionMailNotifier.new(notifier_options)]

data/config.yaml.example

@@ -1,9 +1,3 @@
-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:
@@ -11,10 +5,36 @@ exception_notifier:
 sender: sender@example.com
 add_html: true
 owners:
-  ranguba:
-    to: groonga-commit@rubyforge.org
+  mroonga:
+    to: groonga-mysql-commit@lists.sourceforge.jp
     repositories:
       examples:
         to: null@example.com
   groonga:
     to: groonga-commit@lists.sourceforge.jp
+
+# For multiple domains
+#
+# domains:
+#   github.com: &github
+#     owners:
+#       clear-code:
+#         to: commit+clear-code@example.com
+#       kou:
+#         enabled: false # Disabled by default
+#         repositories:
+#           mruby-pp:
+#             enabled: true # Enabled only the specified repository
+#   # GitHub uses api.github.com for gollum event (Wiki change event)
+#   # "api.github.com: *github" means that api.github.com configuaration
+#   # is the same as github.com.
+#   api.github.com: *github
+#   gitlab.example.com:
+#     to: commit+gitlab@example.com
+#     from: null+gitlab@example.com
+#     owners:
+#       owner1:
+#         repositories:
+#           repository1:
+#             to:
+#               - commit+repository1@example.com

data/doc/text/news.md

@@ -0,0 +1,27 @@
+# News
+
+## 1.0.1 - 2016-10-07 {#version-1-0-1}
+
+### Improvements
+
+  * Added `git_commit_mailer` top level option in configure YAML. It's
+    for changing mailer command.
+
+  * Serialized Git repository update.
+
+  * Showed standard output content on git-commit-mailer error.
+
+  * Returned success response ("202 Accepted") for disabled repository.
+
+  * Supported `enabled` option to each repository for
+    enabling/disabling the repository.
+
+  * Removed branches no longer exist.
+
+  * [GitLab] Supported Wiki event.
+
+  * Supported logging on error response.
+
+## 1.0.0 - 2015-05-19 {#version-1-0-0}
+
+The initial release!

data/github-web-hooks-receiver.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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.homepage      = "https://github.com/clear-code/github-web-hooks-receiver"
   spec.license       = "GPL-3.0+"
 
   spec.files         = `git ls-files -z`.split("\x0")

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

@@ -28,19 +28,22 @@ module GitHubWebHooksReceiver
     def process_payload(request, response, raw_payload)
       metadata = {
         "x-github-event" => github_event(request),
+        "x-gitlab-event" => gitlab_event(request),
       }
       payload = Payload.new(raw_payload, metadata)
       case payload.event_name
       when "ping"
         # Do nothing
-      when "push", nil # nil is for GitLab
+      when "push"
         process_push_payload(request, response, payload)
       when "gollum"
         process_gollum_payload(request, response, payload)
+      when "wiki_page"
+        process_gitlab_wiki_payload(request, response, payload)
       else
-        set_error_response(response,
-                           :bad_request,
-                           "Unsupported event: <#{payload.event_name}>")
+        set_response(response,
+                     :bad_request,
+                     "Unsupported event: <#{payload.event_name}>")
       end
     end
 
@@ -48,6 +51,10 @@ module GitHubWebHooksReceiver
       request.env["HTTP_X_GITHUB_EVENT"]
     end
 
+    def gitlab_event(request)
+      request.env["HTTP_X_GITLAB_EVENT"]
+    end
+
     def process_push_payload(request, response, payload)
       repository = process_payload_repository(request, response, payload)
       return if repository.nil?
@@ -64,51 +71,117 @@ module GitHubWebHooksReceiver
       repository.process(*change)
     end
 
+    def process_gitlab_wiki_payload(request, response, payload)
+      repository = process_gitlab_wiki_repository(request, response, payload)
+      return if repository.nil?
+      change = process_gitlab_wiki_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")
+        set_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}>")
+        set_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}>")
+        set_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}>")
+        set_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_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.enabled?
+        set_response(response, :accepted,
+                     "ignore disabled repository: " +
+                     "<#{owner_name.inspect}>:<#{repository_name.inspect}>")
+        return
+      end
+
+      repository
+    end
+
+    def process_gitlab_wiki_repository(request, response, payload)
+      wiki = payload["wiki"]
+      if wiki.nil?
+        set_response(response, :bad_request,
+                     "Wiki information is missing")
+        return
+      end
+
+      unless wiki.is_a?(Hash)
+        set_response(response, :bad_request,
+                     "invalid Wiki information format: " +
+                     "<#{wiki.inspect}>")
+        return
+      end
+
+      repository_uri = wiki["git_ssh_url"]
+      domain = extract_domain(repository_uri)
+      if domain.nil?
+        set_response(response, :bad_request,
+                     "invalid repository URI: <#{wiki.inspect}>")
+        return
+      end
+
+      project = payload["project"]
+      if wiki.nil?
+        set_response(response, :bad_request,
+                     "Project information is missing")
+        return
+      end
+
+      repository_name = project["name"]
+      if repository_name.nil?
+        set_response(response, :bad_request,
+                     "repository name is missing: <#{project.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}>")
+        set_response(response, :bad_request,
+                     "repository owner or owner name is missing: " +
+                     "<#{project.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}>")
+      unless repository.enabled?
+        set_response(response, :accepted,
+                     "ignore disabled repository: " +
+                     "<#{owner_name.inspect}>:<#{repository_name.inspect}>")
         return
       end
 
@@ -116,21 +189,18 @@ module GitHubWebHooksReceiver
     end
 
     def extract_domain(repository_uri)
-      domain = nil
       case repository_uri
       when /\Agit@/
-        domain = repository_uri[/@(.+):/, 1]
+        repository_uri[/@(.+):/, 1]
       when /\Ahttps:\/\//
-        domain = URI.parse(repository_uri).hostname
+        URI.parse(repository_uri).hostname
       else
-        return
+        nil
       end
-      domain
     end
 
     def extract_owner_name(repository_uri, payload)
       owner_name = nil
-      repository = payload["repository"]
       if payload.gitlab?
         case repository_uri
         when /\Agit@/
@@ -141,7 +211,7 @@ module GitHubWebHooksReceiver
           return
         end
       else
-        owner = repository["owner"]
+        owner = payload["repository.owner"]
         return if owner.nil?
 
         owner_name = owner["name"] || owner["login"]
@@ -153,22 +223,22 @@ module GitHubWebHooksReceiver
     def process_push_parameters(request, response, payload)
       before = payload["before"]
       if before.nil?
-        set_error_response(response, :bad_request,
-                           "before commit ID is missing")
+        set_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")
+        set_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")
+        set_response(response, :bad_request,
+                     "reference is missing")
         return
       end
 
@@ -178,13 +248,14 @@ module GitHubWebHooksReceiver
     def process_gollum_parameters(request, response, payload)
       pages = payload["pages"]
       if pages.nil?
-        set_error_response(response, :bad_request,
-                           "pages are missing")
+        set_response(response, :bad_request,
+                     "pages are missing")
         return
       end
       if pages.empty?
-        set_error_response(response, :bad_request,
-                           "no pages")
+        set_response(response, :bad_request,
+                     "no pages")
+        return
       end
 
       revisions = pages.collect do |page|
@@ -203,7 +274,23 @@ module GitHubWebHooksReceiver
       [before, after, reference]
     end
 
-    def set_error_response(response, status_keyword, message)
+    def process_gitlab_wiki_parameters(request, response, payload)
+      before = "HEAD~"
+      after = "HEAD"
+      reference = "refs/heads/master"
+      [before, after, reference]
+    end
+
+    def set_response(response, status_keyword, message)
+      if File.directory?("log")
+        begin
+          require "pp"
+          File.open("log/response.log", "w") do |log|
+            PP.pp([status_keyword, message], log)
+          end
+        rescue SystemCallError
+        end
+      end
       response.status = status(status_keyword)
       response["Content-Type"] = "text/plain"
       response.write(message)

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

@@ -21,7 +21,7 @@ module GitHubWebHooksReceiver
     def base_dir
       @base_dir ||=
         @options[:base_dir] ||
-        File.expand_path(File.join(File.dirname(__FILE__), ".."))
+        File.expand_path(File.join(File.dirname(__FILE__), "..", ".."))
     end
 
     def path(*paths)

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2010-2013  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2010-2016  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
@@ -32,7 +32,9 @@ module GitHubWebHooksReceiver
     end
 
     def repository_url
-      if gitlab?
+      if gitlab_wiki?
+        self["wiki.git_ssh_url"]
+      elsif gitlab?
         self["repository.url"]
       elsif github_gollum?
         self["repository.clone_url"].gsub(/(\.git)\z/, ".wiki\\1")
@@ -42,7 +44,11 @@ module GitHubWebHooksReceiver
     end
 
     def gitlab?
-      not self["user_name"].nil?
+      not self["object_kind"].nil?
+    end
+
+    def gitlab_wiki?
+      event_name == "wiki_page"
     end
 
     def github_gollum?
@@ -50,7 +56,11 @@ module GitHubWebHooksReceiver
     end
 
     def event_name
-      @metadata["x-github-event"]
+      if gitlab?
+        self["object_kind"]
+      else
+        @metadata["x-github-event"]
+      end
     end
   end
 end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2010-2013  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2010-2016  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
@@ -14,6 +14,8 @@
 # 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 "stringio"
+
 module GitHubWebHooksReceiver
   class Repository
     include PathResolver
@@ -32,39 +34,53 @@ module GitHubWebHooksReceiver
       raise Error.new("mail receive address is missing: <#{@name}>") if @to.nil?
     end
 
-    def target?
-      (@options[:targets] || [/\A[a-z\d_.\-]+\z/i]).any? do |target|
-        target === @name
-      end
+    def enabled?
+      enabled = @options[:enabled]
+      enabled = true if enabled.nil?
+      enabled
     end
 
     def process(before, after, reference)
-      FileUtils.mkdir_p(mirrors_directory)
+      FileUtils.mkdir_p(File.dirname(mirror_path))
       n_retries = 0
-      begin
-        if File.exist?(mirror_path)
-          git("--git-dir", mirror_path, "fetch", "--quiet")
-        else
-          git("clone", "--quiet",
-              "--mirror", @payload.repository_url,
-              mirror_path)
+      lock("#{mirror_path}.lock") do
+        begin
+          if File.exist?(mirror_path)
+            git("--git-dir", mirror_path, "fetch", "--quiet", "--prune")
+          else
+            git("clone", "--quiet",
+                "--mirror", @payload.repository_url,
+                mirror_path)
+          end
+        rescue Error
+          n_retries += 1
+          retry if n_retries <= @max_n_retries
+          raise
         end
-      rescue Error
-        n_retries += 1
-        retry if n_retries <= @max_n_retries
-        raise
       end
       send_commit_email(before, after, reference)
     end
 
+    def lock(path)
+      File.open(path, "w") do |file|
+        file.flock(File::LOCK_EX)
+        yield
+      end
+    end
+
     def send_commit_email(before, after, reference)
       options = [
         "--repository", mirror_path,
         "--max-size", "1M"
       ]
       if @payload.gitlab?
-        add_option(options, "--repository-browser", "gitlab")
-        gitlab_project_uri = @payload["repository"]["homepage"]
+        if @payload.gitlab_wiki?
+          add_option(options, "--repository-browser", "gitlab-wiki")
+          gitlab_project_uri = @payload["project"]["homepage"]
+        else
+          add_option(options, "--repository-browser", "gitlab")
+          gitlab_project_uri = @payload["repository"]["homepage"]
+        end
         add_option(options, "--gitlab-project-uri", gitlab_project_uri)
       else
         if @payload.github_gollum?
@@ -92,16 +108,20 @@ module GitHubWebHooksReceiver
       else
         options << @to
       end
-      command_line = [ruby, commit_email, *options].collect do |component|
+      command_line = [ruby, git_commit_mailer, *options].collect do |component|
         Shellwords.escape(component)
       end.join(" ")
       change = "#{before} #{after} #{reference}"
-      IO.popen(command_line, "w") do |io|
-        io.puts(change)
+      status = nil
+      output = capture_output do
+        IO.popen(command_line, "w") do |io|
+          io.puts(change)
+        end
+        status = $?
       end
-      unless $?.success?
-        raise Error.new("failed to run commit-email.rb: " +
-                        "<#{command_line}>:<#{change}>")
+      unless status.success?
+        raise Error.new("failed to run git-commit-mailer: " +
+                        "<#{command_line}>:<#{change}>:<#{output}>")
       end
     end
 
@@ -126,7 +146,7 @@ module GitHubWebHooksReceiver
 
     def mirror_path
       components = [mirrors_directory, @domain, @owner_name]
-      if @payload.github_gollum?
+      if @payload.github_gollum? or @payload.gitlab_wiki?
         components << "#{@name}.wiki"
       else
         components << @name
@@ -144,6 +164,10 @@ module GitHubWebHooksReceiver
         path("..", "commit-email.rb")
     end
 
+    def git_commit_mailer
+      @git_commit_mailer ||= @options[:git_commit_mailer] || commit_email
+    end
+
     def from
       @from ||= @options[:from]
     end
@@ -188,5 +212,20 @@ module GitHubWebHooksReceiver
       return if value.empty?
       options.concat([name, value])
     end
+
+    def capture_output
+      output = StringIO.new
+      stdout = $stdout
+      stderr = $stderr
+      begin
+        $stdout = output
+        $stderr = output
+        yield
+      ensure
+        $stdout = stdout
+        $stderr = stderr
+      end
+      output.string
+    end
   end
 end

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

@@ -14,5 +14,5 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 module GitHubWebHooksReceiver
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/test/receiver-test.rb

@@ -102,8 +102,8 @@ class ReceiverTest < Test::Unit::TestCase
                        :name => owner_name,
                      },
                    })
-      assert_response("Forbidden")
-      assert_equal("unacceptable repository: " +
+      assert_response("Accepted")
+      assert_equal("ignore disabled repository: " +
                    "<#{owner_name.inspect}>:<#{repository_name.inspect}>",
                    body)
     end
@@ -225,6 +225,7 @@ class ReceiverTest < Test::Unit::TestCase
       assert_false(File.exist?(repository_mirror_path))
       options[:owners] = {
         "ranguba" => {
+          :enabled => true,
           :to => "ranguba-commit@example.org",
           :from => "ranguba+commit@example.org",
           :sender => "null@example.org",
@@ -272,6 +273,7 @@ class ReceiverTest < Test::Unit::TestCase
           :sender => "null@example.org",
           "repositories" => {
             "rroonga" => {
+              :enabled => true,
               :to => "ranguba-commit@example.net",
               :from => "ranguba+commit@example.net",
               :sender => "null@example.net",
@@ -371,12 +373,17 @@ class ReceiverTest < Test::Unit::TestCase
 
   def options
     @options ||= {
-      :targets => ["rroonga"],
+      :enabled => false,
       :base_dir => @tmp_dir,
       :fixtures_dir => @fixtures_dir,
       :repository_class => LocalRepository,
       :commit_email => File.join(@fixtures_dir, "mock-commit-email.rb"),
       :to => "null@example.com",
+      :owners => {
+        "ranguba" => {
+          :enabled => true,
+        },
+      },
     }
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-web-hooks-receiver
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kouhei Sutou
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-25 00:00:00.000000000 Z
+date: 2016-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -110,6 +110,7 @@ files:
 - Rakefile
 - config.ru
 - config.yaml.example
+- doc/text/news.md
 - github-web-hooks-receiver.gemspec
 - lib/github-web-hooks-receiver.rb
 - lib/github-web-hooks-receiver/app.rb
@@ -128,7 +129,7 @@ files:
 - test/receiver-test.rb
 - test/run-test.rb
 - test/test-unit.yml
-homepage: ''
+homepage: https://github.com/clear-code/github-web-hooks-receiver
 licenses:
 - GPL-3.0+
 metadata: {}
@@ -148,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: GitHub web hook receiver