redmine_github_hook 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80d3b1fb7dfd0ba831f64fa058e41c143c2a3d85
-  data.tar.gz: c1437776bd70f444d30d5c26c4928aa3fef21908
+  metadata.gz: 0a6ff195525b5c076cf4462b8b8e8086cf6951fc
+  data.tar.gz: 488774f618ee936d027a1f1a3717b2269c4f9e5c
 SHA512:
-  metadata.gz: d44d1a781d5a714324fe7ec938d8df9f6607783efe6004ebb418a13cad9d56cd1df6f178ad342f276c01bdab51cd8e9928654447d298f657e90780b8f21daf9b
-  data.tar.gz: 81d3e3cf4e3aaa09e0837196158d4aa32aec72e620b65b5bf6f909b8aad3a6314631e15d4eff42c927ab564f80b34a8107576e299da1f31a17ba1107f9b46fd9
+  metadata.gz: 3b6e88ba8fedd6a4e33151b8d11f6d93b2f824ae71ce6203c8eca5933fd8fdba22096d8a902ff68bcd9c5ffb6c343b02974d836ea7abcb90cdc885a9b65c9101
+  data.tar.gz: b72341171add46e10e8503cd2ebd6ffb0cef3231ba45580924689c1427c69df9552c4fa19419adf265dd02fb8c0391d6c79f129cde317cfe6f08c580399de85f

data/README.md

@@ -15,22 +15,11 @@ That approach works perfectly fine, but is a bit heavy-handed and cumbersome. Th
 
 ### 1. Install the plugin
 
-You have two options for installing the plugin:
-
-#### A: As a RubyGem
-
 1. Add the gem to your Gemfile.local:
    `gem "redmine_github_hook"`
 2. `bundle`
 3. Restart your Redmine
 
-#### B: As a plugin
-
-1. 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`
-  * Easiest way: change in your plugins directory and pull with git: `git clone git://github.com/koppen/redmine_github_hook.git`
-2. Restart your Redmine.
-
 ### 2. Add the repository to Redmine
 
 Adding a Git repository to a project (note, this should work whether you want to use Redmine GitHub Hook or not).
@@ -46,7 +35,6 @@ Adding a Git repository to a project (note, this should work whether you want to
      * 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`).
      * GitHub Hook will then update **all repositories** in the specified project. *Be aware, that this process may take a while if you have many repositories in your project.*
      * If you want GitHub Hook to **only update the current repository** you can specify it with an additional parameter in the Post-Receive URL by using the format `[redmine_url]/github_hook?project_id=[identifier]&repository_id=[repository]` (for example `http://redmine.example.com/github_hook?project_id=my_project&repository_id=my_repo`).
-     * If you want GitHub Hook to **only update the current repository** you can specify it with an additional parameter in the Post-Receive URL by using the format `[redmine_url]/github_hook?project_id=[identifier]&repository_id=[repository]` (for example `http://redmine.example.com/github_hook?project_id=my_project&repository_id=my_repo`).
    * In most cases, just having the "push" event trigger the webhook should suffice, but you are free to customize the events as you desire.
    * *Note: Make sure you're adding a Webhook - which is what Redmine Github Hook expects. GitHub has some builtin Redmine integration; that's not what you're looking for.*
 
@@ -94,7 +82,7 @@ The interactions between the different parts of the process is outlined in the f
 
 ![sequence](https://cloud.githubusercontent.com/assets/6480/3311503/3a789390-f6c5-11e3-804d-d5ca2562799f.png)
 
-(Diagram made with [http://bramp.github.io/js-sequence-diagrams/](js-sequence-diagrams)).
+(Diagram made with [js-sequence-diagrams](http://bramp.github.io/js-sequence-diagrams/)).
 
 
 ## License

data/app/controllers/github_hook_controller.rb

@@ -4,17 +4,41 @@ class GithubHookController < ApplicationController
   skip_before_filter :verify_authenticity_token, :check_if_login_required
 
   def index
-    if request.post?
-      payload = JSON.parse(params[:payload] || '{}')
-      updater = GithubHook::Updater.new(payload, params)
-      updater.logger = logger
-      updater.call
-    end
-
-    render(:text => 'OK')
+    message_logger = GithubHook::MessageLogger.new(logger)
+    update_repository(message_logger) if request.post?
+    messages = message_logger.messages.map { |log| log[:message] }
+    render(:json => messages)
+
+  rescue ActiveRecord::RecordNotFound => error
+    render_error_as_json(error, 404)
+
+  rescue TypeError => error
+    render_error_as_json(error, 412)
   end
 
   def welcome
     # Render the default layout
   end
+
+  private
+
+  def parse_payload
+    JSON.parse(params[:payload] || "{}")
+  end
+
+  def render_error_as_json(error, status)
+    render(
+      :json => {
+        :title => error.class.to_s,
+        :message => error.message
+      },
+      :status => status
+    )
+  end
+
+  def update_repository(logger)
+    updater = GithubHook::Updater.new(parse_payload, params)
+    updater.logger = logger
+    updater.call
+  end
 end

data/app/services/github_hook/message_logger.rb

@@ -0,0 +1,43 @@
+module GithubHook
+  class MessageLogger
+    attr_reader :messages, :wrapped_logger
+
+    def initialize(wrapped_logger = nil)
+      @messages = []
+      @wrapped_logger = wrapped_logger
+    end
+
+    def debug(message = yield)
+      add_message(:debug, message)
+    end
+
+    def error(message = yield)
+      add_message(:error, message)
+    end
+
+    def fatal(message = yield)
+      add_message(:fatal, message)
+    end
+
+    def info(message = yield)
+      add_message(:info, message)
+    end
+
+    def warn(message = yield)
+      add_message(:warn, message)
+    end
+
+    private
+
+    def add_message(level, message)
+      if wrapped_logger
+        wrapped_logger.send(level, message)
+      end
+
+      @messages << {
+        :level => level.to_s,
+        :message => message
+      }
+    end
+  end
+end

data/app/services/github_hook/null_logger.rb

@@ -0,0 +1,8 @@
+module GithubHook
+  class NullLogger
+    def debug(*_); end
+    def info(*_); end
+    def warn(*_); end
+    def error(*_); end
+  end
+end

data/app/services/github_hook/updater.rb

@@ -29,13 +29,6 @@ module GithubHook
 
     private
 
-    class NullLogger
-      def debug(*_); end
-      def info(*_); end
-      def warn(*_); end
-      def error(*_); end
-    end
-
     attr_reader :params, :payload
 
     # Executes shell command. Returns true if the shell command exits with a

data/lib/redmine_github_hook/version.rb

@@ -1,3 +1,3 @@
 module RedmineGithubHook
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/test/functional/github_hook_controller_test.rb

@@ -83,6 +83,16 @@ class GithubHookControllerTest < ActionController::TestCase
     assert_equal 'OK', @response.body
   end
 
+  def test_should_render_error_message
+    GithubHook::Updater.any_instance.expects(:update_repository).raises(ActiveRecord::RecordNotFound.new("Repository not found"))
+    do_post
+    assert_response :not_found
+    assert_equal({
+      "title" => "ActiveRecord::RecordNotFound",
+      "message" => "Repository not found"
+    }, JSON.parse(@response.body))
+  end
+
   def test_should_not_require_login
     GithubHook::Updater.any_instance.expects(:update_repository).returns(true)
     @controller.expects(:check_if_login_required).never

data/test/unit/github_hook/message_logger_test.rb

@@ -0,0 +1,49 @@
+# require 'test_helper'
+require "test/unit"
+require_relative "../../../app/services/github_hook/message_logger"
+
+class MessageLoggerTest < Test::Unit::TestCase
+  setup do
+    @logger = GithubHook::MessageLogger.new
+  end
+
+  def test_adds_messages_to_an_array
+    logger.info "Testing"
+    assert_equal [
+      {:level => "info", :message => "Testing"}
+    ], logger.messages
+  end
+
+  def test_supports_standard_log_levels
+    levels = ["fatal", "error", "warn", "info", "debug"]
+    levels.each do |level|
+      logger.public_send(level, level)
+    end
+    assert_equal levels, logger.messages.map { |m| m[:level] }
+  end
+
+  def test_supports_blocks
+    logger.debug { "This is my message" }
+    assert_equal [
+      {:level => "debug", :message => "This is my message"}
+    ], logger.messages
+  end
+
+  def test_logs_to_a_wrapped_logger_as_well
+    wrapped_logger = GithubHook::MessageLogger.new
+    logger = GithubHook::MessageLogger.new(wrapped_logger)
+    logger.debug "This goes everywhere"
+    assert_equal [
+      :level => "debug", :message => "This goes everywhere"
+    ], logger.messages
+    assert_equal [
+      :level => "debug", :message => "This goes everywhere"
+    ], wrapped_logger.messages
+  end
+
+  private
+
+  def logger
+    @logger ||= GithubHook::MessageLogger.new
+  end
+end

data/test/unit/github_hook/updater_test.rb

@@ -23,7 +23,7 @@ class GithubHookUpdaterTest < Test::Unit::TestCase
 
   def payload
     # Ruby hash with the parsed data from the JSON payload
-    {"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"}
+    {"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 build_updater(payload, options = {})
@@ -171,4 +171,15 @@ class GithubHookUpdaterTest < Test::Unit::TestCase
 
     updater.call
   end
+
+  def test_logs_if_a_message_logger_is_given
+    updater = GithubHook::Updater.new(payload)
+    updater.stubs(:exec).returns(true)
+
+    logger = GithubHook::MessageLogger.new
+    updater.logger = logger
+
+    updater.call
+    assert logger.messages.any?, "Should have received messages"
+  end
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: redmine_github_hook
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Jakob Skjerning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-07 00:00:00.000000000 Z
+date: 2015-05-30 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: 
@@ -45,13 +45,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - app/controllers/github_hook_controller.rb
-- app/helpers/git_hook_helper.rb
+- app/services/github_hook/message_logger.rb
+- app/services/github_hook/null_logger.rb
 - app/services/github_hook/updater.rb
 - app/views/github_hook/welcome.html.erb
 - config/routes.rb
@@ -62,6 +63,7 @@ files:
 - redmine_github_hook.gemspec
 - test/functional/github_hook_controller_test.rb
 - test/test_helper.rb
+- test/unit/github_hook/message_logger_test.rb
 - test/unit/github_hook/updater_test.rb
 homepage: ''
 licenses:
@@ -73,17 +75,17 @@ 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
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Allow your Redmine installation to be notified when changes have been pushed
@@ -91,4 +93,5 @@ summary: Allow your Redmine installation to be notified when changes have been p
 test_files:
 - test/functional/github_hook_controller_test.rb
 - test/test_helper.rb
+- test/unit/github_hook/message_logger_test.rb
 - test/unit/github_hook/updater_test.rb

data/app/helpers/git_hook_helper.rb

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