redmine_github_hook 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c30863fa492b92934b5a26ac38859b3c914a7521
+  data.tar.gz: 9f87ea3e8368290abcc8ffe8d6a0e2620189292e
+SHA512:
+  metadata.gz: aeb53b9b14fcf449a6d27fc3e7b6f747b0b735605a35f67321687f5f7acdf699dff8e6fb29f39740225a50bd6f21c7ef6bc8ea869c06d2f404547107ea4fe8a0
+  data.tar.gz: ae96c35e10d754a00acbd373ec0e89eb3875b1c7764b0c25a7f9602b39d92d24e59bbd3ddf66a002615ec945406e856522d1ca652edec8fba8dbc539df32da78

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redmine_github_hook.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Jakob Skjerning
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# Redmine GitHub Hook
+
+This plugin allows you to update your local Git repositories in Redmine when changes have been pushed to GitHub.
+
+## Description
+
+[Redmine](http://redmine.org) has supported Git repositories for a long time, allowing you to browse your code and view your changesets directly in Redmine. For this purpose, Redmine relies on local clones of the Git repositories.
+
+If your shared repository is on a remote machine - for example on GitHub - this unfortunately means a bit of legwork to keep the local, Redmine-accessible repository up-to-date. The common approach is to set up a cronjob that pulls in any changes with regular intervals and updates Redmine with them.
+
+That approach works perfectly fine, but is a bit heavy-handed and cumbersome. The Redmine GitHub Hook plugin allows GitHub to notify your Redmine installation when changes have been pushed to a repository, triggering an update of your local repository and Redmine data only when it is actually necessary.
+
+
+## Installation
+
+1. Installing the plugin
+   1. Install the [json gem](http://json.rubyforge.org/) on the machine where Redmine is running.
+   2. Follow the plugin installation procedure outlined in the [Redmine wiki](http://www.redmine.org/wiki/redmine/Plugins).
+      * Make sure that Redmine GitHub Hook is installed in a directory named `redmine_github_hook`
+   3. Restart your Redmine.
+   4. If you already have a local Git repository set up and working from Redmine go to step 3, otherwise continue at step 2.
+
+2. Adding a Git repository to a project (note, this should work whether you want to use Redmine GitHub Hook or not). Simply follow the instructions for [keeping your git repository in sync](http://www.redmine.org/wiki/redmine/HowTo_keep_in_sync_your_git_repository_for_redmine).
+
+3. Connecting GitHub to Redmine
+   1. Go to the repository Settings interface on GitHub.
+   2. Under "Webhooks & Services" add a new "WebHook". The "Payload URL" needs to be of the format: `[redmine_url]/github_hook` (for example `http://redmine.example.com/github_hook`).
+      1. By default, GitHub Hook assumes your GitHub repository name is the same as the project identifier in your Redmine installation. If this is not the case, you can specify the actual Redmine project identifier in the Post-Receive URL by using the format `[redmine_url]/github_hook?project_id=[identifier]` (for example `http://redmine.example.com/github_hook?project_id=my_project`).
+      2. In most cases, just having the "push" event trigger the webhook should suffice, but you are free to customize the events as you desire.
+
+That's it. GitHub will now send a HTTP POST to the Redmine GitHub Hook plugin whenever changes are pushed to GitHub. The plugin then takes care of pulling the changes to the local repository and updating the Redmine database with them.
+
+
+## Assumptions
+
+* Redmine 2 running on a *nix-like system. Redmine versions before 2.0 should use the redmine_1.x branch.
+* Git 1.5 or higher available on the commandline.
+
+
+## Troubleshooting
+
+### Check your logfile
+
+If you run into issues, your Redmine logfile might have some valuable information. Two things to check for:
+
+1. Do POST requests to `/github_hook` show up in the logfile at all? If so, what's the resulting status code?
+2. If the git command used to pull in changes fails for whatever reason, there should also be some details about the failure in the logfile.
+
+The logfile is usually found in your Redmine directory in `log/production.log` although your webserver logs may contain some additional clues.
+
+### Permissions problems
+
+As for permissions, whatever user Redmine is running as needs permissions to do the following things:
+
+* Read from the remote repository on GitHub
+* Read and write to the local repository on the Redmine server
+
+What user you are running Redmine as depends on your system and how you've setup your Redmine installation.
+
+#### GitHub
+
+This means you need to add its SSH keys on GitHub. If the user doesn't already have an SSH key, generate one and add the public SSH key as a Deploy Key for the repository on GitHub (or as one of your own keys, if you prefer that).
+
+#### Local repository
+
+The user running Redmine needs permissions to read and write to the local repository on the server.
+
+
+## License
+
+Copyright (c) 2009-2013 Jakob Skjerning
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  files = FileList['test/**/*test.rb']
+  t.test_files = files
+  t.verbose = true
+end
+
+task :default => :test

data/app/controllers/github_hook_controller.rb

@@ -0,0 +1,117 @@
+require 'json'
+
+class GithubHookController < ApplicationController
+
+  GIT_BIN = Redmine::Configuration['scm_git_command'] || "git"
+  skip_before_filter :verify_authenticity_token, :check_if_login_required
+
+  def index
+    if request.post?
+      repositories = find_repositories
+
+      repositories.each do |repository|
+        # Fetch the changes from Github
+        update_repository(repository)
+
+        # Fetch the new changesets into Redmine
+        repository.fetch_changesets
+      end
+    end
+
+    render(:text => 'OK')
+  end
+
+  def welcome
+    # Render the default layout
+  end
+
+  private
+
+  def system(command)
+    Kernel.system(command)
+  end
+
+  # Executes shell command. Returns true if the shell command exits with a
+  # success status code.
+  #
+  # If directory is given the current directory will be changed to that
+  # directory before executing command.
+  def exec(command, directory)
+    logger.debug { "GithubHook: Executing command: '#{command}'" }
+
+    # Get a path to a temp file
+    logfile = Tempfile.new('github_hook_exec')
+    logfile.close
+
+    full_command = "#{command} > #{logfile.path} 2>&1"
+    success = if directory.present?
+      Dir.chdir(directory) do
+        system(full_command)
+      end
+    else
+      system(full_command)
+    end
+
+    output_from_command = File.readlines(logfile.path)
+    if success
+      logger.debug { "GithubHook: Command output: #{output_from_command.inspect}"}
+    else
+      logger.error { "GithubHook: Command '#{command}' didn't exit properly. Full output: #{output_from_command.inspect}"}
+    end
+
+    return success
+  ensure
+    logfile.unlink
+  end
+
+  def git_command(command)
+    GIT_BIN + " #{command}"
+  end
+
+  # Fetches updates from the remote repository
+  def update_repository(repository)
+    command = git_command('fetch origin')
+    if exec(command, repository.url)
+      command = git_command("fetch origin \"+refs/heads/*:refs/heads/*\"")
+      exec(command, repository.url)
+    end
+  end
+
+  # Gets the project identifier from the querystring parameters and if that's not supplied, assume
+  # the Github repository name is the same as the project identifier.
+  def get_identifier
+    identifier = get_project_name
+    raise ActiveRecord::RecordNotFound, "Project identifier not specified" if identifier.nil?
+    return identifier
+  end
+
+  # Attempts to find the project name. It first looks in the params, then in the
+  # payload if params[:project_id] isn't given.
+  def get_project_name
+    payload = JSON.parse(params[:payload] || '{}')
+    params[:project_id] || (payload['repository'] ? payload['repository']['name'] : nil)
+  end
+
+  # Finds the Redmine project in the database based on the given project identifier
+  def find_project
+    identifier = get_identifier
+    project = Project.find_by_identifier(identifier.downcase)
+    raise ActiveRecord::RecordNotFound, "No project found with identifier '#{identifier}'" if project.nil?
+    return project
+  end
+
+  # Returns the Redmine Repository object we are trying to update
+  def find_repositories
+    project = find_project
+    repositories = project.repositories.select do |repo|
+      repo.is_a?(Repository::Git)
+    end
+
+    if repositories.nil? or repositories.length == 0
+      raise TypeError, "Project '#{project.to_s}' ('#{project.identifier}') has no repository"
+    end
+
+    return repositories
+  end
+
+end

data/app/helpers/git_hook_helper.rb

@@ -0,0 +1,2 @@
+module GitHookHelper
+end

data/app/views/github_hook/welcome.html.erb

@@ -0,0 +1,13 @@
+<div class="wiki">
+
+  <h2>You have successfully installed the Redmine GitHub Hook Plugin.</h2>
+
+  <p>
+    This page is just a confirmation that you have successfully installed the plugin.
+    Follow the rest of the installation:
+    <a href="https://github.com/koppen/redmine_github_hook" class="external">
+      Redmine GitHub Hook Plugin on GitHub
+    </a>
+  </p>
+
+</div>

data/config/routes.rb

@@ -0,0 +1,4 @@
+RedmineApp::Application.routes.draw do
+  match 'github_hook' => 'github_hook#index', :via => [:post]
+  match 'github_hook' => 'github_hook#welcome', :via => [:get]
+end

data/init.rb

@@ -0,0 +1,8 @@
+require 'redmine'
+
+Redmine::Plugin.register :redmine_github_hook do
+  name 'Redmine Github Hook plugin'
+  author 'Jakob Skjerning'
+  description 'This plugin allows your Redmine installation to receive Github post-receive notifications'
+  version RedmineGithubHook::VERSION
+end

data/lang/en.yml

@@ -0,0 +1,2 @@
+# English strings go here
+my_label: "My label"

data/lib/redmine_github_hook/version.rb

@@ -0,0 +1,3 @@
+module RedmineGithubHook
+  VERSION = "2.0.0"
+end

data/lib/redmine_github_hook.rb

@@ -0,0 +1,10 @@
+require "redmine_github_hook/version"
+
+module RedmineGithubHook
+  # Run the classic redmine plugin initializer after rails boot
+  class Plugin < ::Rails::Engine
+    config.after_initialize do
+      require File.expand_path("../../init", __FILE__)
+    end
+  end
+end

data/redmine_github_hook.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redmine_github_hook/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redmine_github_hook"
+  spec.version       = RedmineGithubHook::VERSION
+  spec.authors       = ["Jakob Skjerning"]
+  spec.email         = ["jakob@mentalized.net"]
+  spec.summary       = "Allow your Redmine installation to be notified when changes have been pushed to a Github repository."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/test/functional/github_hook_controller_test.rb

@@ -0,0 +1,203 @@
+require 'test_helper'
+
+require 'test/unit'
+require 'mocha'
+
+class GithubHookControllerTest < ActionController::TestCase
+  def json
+    # Sample JSON post from http://github.com/guides/post-receive-hooks
+    '{
+      "before": "5aef35982fb2d34e9d9d4502f6ede1072793222d",
+      "repository": {
+        "url": "http://github.com/defunkt/github",
+        "name": "github",
+        "description": "You\'re lookin\' at it.",
+        "watchers": 5,
+        "forks": 2,
+        "private": 1,
+        "owner": {
+          "email": "chris@ozmm.org",
+          "name": "defunkt"
+        }
+      },
+      "commits": [
+        {
+          "id": "41a212ee83ca127e3c8cf465891ab7216a705f59",
+          "url": "http://github.com/defunkt/github/commit/41a212ee83ca127e3c8cf465891ab7216a705f59",
+          "author": {
+            "email": "chris@ozmm.org",
+            "name": "Chris Wanstrath"
+          },
+          "message": "okay i give in",
+          "timestamp": "2008-02-15T14:57:17-08:00",
+          "added": ["filepath.rb"]
+        },
+        {
+          "id": "de8251ff97ee194a289832576287d6f8ad74e3d0",
+          "url": "http://github.com/defunkt/github/commit/de8251ff97ee194a289832576287d6f8ad74e3d0",
+          "author": {
+            "email": "chris@ozmm.org",
+            "name": "Chris Wanstrath"
+          },
+          "message": "update pricing a tad",
+          "timestamp": "2008-02-15T14:36:34-08:00"
+        }
+      ],
+      "after": "de8251ff97ee194a289832576287d6f8ad74e3d0",
+      "ref": "refs/heads/master"
+    }'
+  end
+
+  def repository
+    return @repository if @repository
+
+    @repository ||= Repository::Git.new
+    @repository.stubs(:fetch_changesets).returns(true)
+    @repository
+  end
+
+  def project
+    return @project if @project
+
+    @project ||= Project.new
+    @project.repositories << repository
+    @project
+  end
+
+  def setup
+    Project.stubs(:find_by_identifier).with('github').returns(project)
+
+    # Make sure we don't run actual commands in test
+    @controller.expects(:system).never
+    Repository.expects(:fetch_changesets).never
+  end
+
+  def mock_descriptor(kind, contents = [])
+    descriptor = mock(kind)
+    descriptor.expects(:readlines).returns(contents)
+    descriptor
+  end
+
+  def do_post(payload = nil)
+    payload = json if payload.nil?
+    payload = payload.to_json if payload.is_a?(Hash)
+    post :index, :payload => payload
+  end
+
+  def test_should_use_the_repository_name_as_project_identifier
+    Project.expects(:find_by_identifier).with('github').returns(project)
+    @controller.stubs(:exec).returns(true)
+    do_post
+  end
+
+  def test_should_fetch_changes_from_origin
+    Project.expects(:find_by_identifier).with('github').returns(project)
+    @controller.expects(:exec).with("git fetch origin", repository.url)
+    do_post
+  end
+
+  def test_should_reset_repository_when_fetch_origin_succeeds
+    Project.expects(:find_by_identifier).with('github').returns(project)
+    @controller.expects(:exec).with("git fetch origin", repository.url).returns(true)
+    @controller.expects(:exec).with("git fetch origin \"+refs/heads/*:refs/heads/*\"", repository.url)
+    do_post
+  end
+
+  def test_should_not_reset_repository_when_fetch_origin_fails
+    Project.expects(:find_by_identifier).with('github').returns(project)
+    @controller.expects(:exec).with("git fetch origin", repository.url).returns(false)
+    @controller.expects(:exec).with("git reset --soft refs\/remotes\/origin\/master", repository.url).never
+    do_post
+  end
+
+  def test_should_use_project_identifier_from_request
+    Project.expects(:find_by_identifier).with('redmine').returns(project)
+    @controller.stubs(:exec).returns(true)
+    post :index, :project_id => 'redmine', :payload => json
+  end
+
+  def test_should_return_404_if_project_identifier_not_found
+    assert_raises ActiveRecord::RecordNotFound do
+      post :index
+    end
+  end
+
+  def test_should_downcase_identifier
+    # Redmine project identifiers are always downcase
+    Project.expects(:find_by_identifier).with('redmine').returns(project)
+    @controller.stubs(:exec).returns(true)
+    post :index, :project_id => 'ReDmInE', :payload => json
+  end
+
+  def test_should_render_ok_when_done
+    @controller.expects(:update_repository).returns(true)
+    do_post
+    assert_response :success
+    assert_equal 'OK', @response.body
+  end
+
+  def test_should_fetch_changesets_into_the_repository
+    @controller.expects(:update_repository).returns(true)
+    repository.expects(:fetch_changesets).returns(true)
+
+    do_post
+    assert_response :success
+    assert_equal 'OK', @response.body
+  end
+
+  def test_should_return_404_if_project_identifier_not_given
+    assert_raises ActiveRecord::RecordNotFound do
+      do_post :repository => {}
+    end
+  end
+
+  def test_should_return_404_if_project_not_found
+    assert_raises ActiveRecord::RecordNotFound do
+      Project.expects(:find_by_identifier).with('foobar').returns(nil)
+      do_post :repository => {:name => 'foobar'}
+    end
+  end
+
+  def test_should_return_500_if_project_has_no_repository
+    assert_raises TypeError do
+      project = mock('project', :to_s => 'My Project', :identifier => 'github')
+      project.expects(:repositories).returns([])
+      Project.expects(:find_by_identifier).with('github').returns(project)
+      do_post :repository => {:name => 'github'}
+    end
+  end
+
+  def test_should_return_500_if_repository_is_not_git
+    assert_raises TypeError do
+      project = mock('project', :to_s => 'My Project', :identifier => 'github')
+      repository = Repository::Subversion.new
+      project.expects(:repositories).at_least(1).returns([repository])
+      Project.expects(:find_by_identifier).with('github').returns(project)
+      do_post :repository => {:name => 'github'}
+    end
+  end
+
+  def test_should_not_require_login
+    @controller.expects(:update_repository).returns(true)
+    @controller.expects(:check_if_login_required).never
+    do_post
+  end
+
+  def test_exec_should_log_output_from_git_as_debug_when_things_go_well
+    @controller.expects(:system).at_least(1).returns(true)
+    @controller.logger.expects(:debug).at_least(1)
+    do_post
+  end
+
+  def test_exec_should_log_output_from_git_as_error_when_things_go_sour
+    @controller.expects(:system).at_least(1).returns(false)
+    @controller.logger.expects(:error).at_least(1)
+    do_post
+  end
+
+  def test_should_respond_to_get
+    get :index
+    assert_response :success
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+# Load the normal Rails helper from the Redmine host app
+require File.expand_path(File.dirname(__FILE__) + '/../../../test/test_helper')

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: redmine_github_hook
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Jakob Skjerning
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jakob@mentalized.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/github_hook_controller.rb
+- app/helpers/git_hook_helper.rb
+- app/views/github_hook/welcome.html.erb
+- config/routes.rb
+- init.rb
+- lang/en.yml
+- lib/redmine_github_hook.rb
+- lib/redmine_github_hook/version.rb
+- redmine_github_hook.gemspec
+- test/functional/github_hook_controller_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Allow your Redmine installation to be notified when changes have been pushed
+  to a Github repository.
+test_files:
+- test/functional/github_hook_controller_test.rb
+- test/test_helper.rb
+has_rdoc: