redmine_github_hook 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0a6ff195525b5c076cf4462b8b8e8086cf6951fc
-  data.tar.gz: 488774f618ee936d027a1f1a3717b2269c4f9e5c
+SHA256:
+  metadata.gz: e557b9c48ee315b46a409c913a296b78ad7667832b77e2f377c3f2f969f4b4e0
+  data.tar.gz: 1906894bae718bd12f182ffc30410a84839be42b150a706f21c312d4b98c4ec5
 SHA512:
-  metadata.gz: 3b6e88ba8fedd6a4e33151b8d11f6d93b2f824ae71ce6203c8eca5933fd8fdba22096d8a902ff68bcd9c5ffb6c343b02974d836ea7abcb90cdc885a9b65c9101
-  data.tar.gz: b72341171add46e10e8503cd2ebd6ffb0cef3231ba45580924689c1427c69df9552c4fa19419adf265dd02fb8c0391d6c79f129cde317cfe6f08c580399de85f
+  metadata.gz: b876106487d0e71584dd3f430e859b77ad9bfcc1155b8eb67612fb8865f1b0f9c411d45300d1772a6db337b2b98362b77a60f416ec4ecd8af38fa86a3304938e
+  data.tar.gz: 516cf70b6d902b863b3f7646ed69613250bd3c1d9736ddcc4afe7b947ad1ebb05dc0601e10d62b10ec4916a04d34626f48491b0c9d947f6b35600f3ab69213b1

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Use the gems defined in the plugins gemspec
 gemspec(:path => File.dirname(__FILE__))

data/Rakefile

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

data/app/controllers/github_hook_controller.rb

@@ -1,4 +1,4 @@
-require 'json'
+require "json"
 
 class GithubHookController < ApplicationController
   skip_before_filter :verify_authenticity_token, :check_if_login_required

data/app/services/github_hook/null_logger.rb

@@ -1,8 +1,11 @@
 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

@@ -1,6 +1,6 @@
 module GithubHook
   class Updater
-    GIT_BIN = Redmine::Configuration['scm_git_command'] || "git"
+    GIT_BIN = Redmine::Configuration["scm_git_command"] || "git"
 
     attr_writer :logger
 
@@ -23,7 +23,7 @@ module GithubHook
         repository.fetch_changesets
         tr2 = Time.now
 
-        logger.info { "  GithubHook: Redmine repository updated: #{repository.identifier} (Git: #{time_diff_milli(tg1,tg2)}ms, Redmine: #{time_diff_milli(tr1,tr2)}ms)" }
+        logger.info { "  GithubHook: Redmine repository updated: #{repository.identifier} (Git: #{time_diff_milli(tg1, tg2)}ms, Redmine: #{time_diff_milli(tr1, tr2)}ms)" }
       end
     end
 
@@ -40,7 +40,7 @@ module GithubHook
       logger.debug { "  GithubHook: Executing command: '#{command}'" }
 
       # Get a path to a temp file
-      logfile = Tempfile.new('github_hook_exec')
+      logfile = Tempfile.new("github_hook_exec")
       logfile.close
 
       full_command = "#{command} > #{logfile.path} 2>&1"
@@ -54,9 +54,9 @@ module GithubHook
 
       output_from_command = File.readlines(logfile.path)
       if success
-        logger.debug { "  GithubHook: Command output: #{output_from_command.inspect}"}
+        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}"}
+        logger.error { "  GithubHook: Command '#{command}' didn't exit properly. Full output: #{output_from_command.inspect}" }
       end
 
       return success
@@ -64,62 +64,82 @@ module GithubHook
       logfile.unlink if logfile && logfile.respond_to?(:unlink)
     end
 
-    # Finds the Redmine project in the database based on the given project identifier
+    # 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
+      fail(
+        ActiveRecord::RecordNotFound,
+        "No project found with identifier '#{identifier}'"
+      ) if project.nil?
+      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
+      repositories = git_repositories(project)
 
-      if repositories.nil? or repositories.length == 0
-        raise TypeError, "Project '#{project.to_s}' ('#{project.identifier}') has no repository"
-      end
-
-      # if a specific repository id is passed in url parameter "repository_id", then try to find it in
-      # the list of current project repositories and use only this and not all to pull changes from
-      # (issue #54)
-      if params.has_key?(:repository_id)
+      # if a specific repository id is passed in url parameter "repository_id",
+      # then try to find it in the list of current project repositories and use
+      # only this and not all to pull changes from (issue #54)
+      if params.key?(:repository_id)
         param_repo = repositories.select do |repo|
           repo.identifier == params[:repository_id]
         end
 
-        if param_repo.nil? or param_repo.length == 0
-          logger.info { "  GithubHook: The repository '#{params[:repository_id]}' isn't in the list of projects repos. Updating all repos instead." }
+        if param_repo.nil? || param_repo.length == 0
+          logger.info {
+            "GithubHook: The repository '#{params[:repository_id]}' isn't " \
+            "in the list of projects repos. Updating all repos instead."
+          }
 
         else
           repositories = param_repo
         end
       end
 
-      return repositories
+      repositories
     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.
+    # 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
+      fail(
+        ActiveRecord::RecordNotFound,
+        "Project identifier not specified"
+      ) if identifier.nil?
+      identifier.to_s
     end
 
-    # Attempts to find the project name. It first looks in the params, then in the
-    # payload if params[:project_id] isn't given.
+    # 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
-      params[:project_id] || (payload['repository'] ? payload['repository']['name'] : nil)
+      project_id = params[:project_id]
+      name_from_repository = payload.fetch("repository", {}).fetch("name", nil)
+      project_id || name_from_repository
     end
 
     def git_command(command)
       GIT_BIN + " #{command}"
     end
 
+    def git_repositories(project)
+      repositories = project.repositories.select do |repo|
+        repo.is_a?(Repository::Git)
+      end
+      if repositories.empty?
+        fail(
+          TypeError,
+          "Project '#{project}' ('#{project.identifier}') has no repository"
+        )
+      end
+      repositories || []
+    end
+
     def logger
       @logger || NullLogger.new
     end
@@ -134,12 +154,14 @@ module GithubHook
 
     # 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
+      command = git_command("fetch origin")
+      fetch = exec(command, repository.url)
+      return nil unless fetch
+
+      command = git_command(
+        "fetch --prune origin \"+refs/heads/*:refs/heads/*\""
+      )
+      exec(command, repository.url)
     end
-
   end
 end

data/config/routes.rb

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

data/init.rb

@@ -1,10 +1,10 @@
-require 'redmine'
+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'
-  url 'https://github.com/koppen/redmine_github_hook'
-  author_url 'http://mentalized.net'
+  name "Redmine Github Hook plugin"
+  author "Jakob Skjerning"
+  description "This plugin allows your Redmine installation to receive Github post-receive notifications"
+  url "https://github.com/koppen/redmine_github_hook"
+  author_url "http://mentalized.net"
   version RedmineGithubHook::VERSION
 end

data/lib/redmine_github_hook/version.rb

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

data/redmine_github_hook.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'redmine_github_hook/version'
+require "redmine_github_hook/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "redmine_github_hook"

data/test/functional/github_hook_controller_test.rb

@@ -1,7 +1,7 @@
-require 'test_helper'
+require "test_helper"
 
-require 'test/unit'
-require 'mocha'
+require "minitest"
+require "mocha"
 
 class GithubHookControllerTest < ActionController::TestCase
   def json
@@ -65,7 +65,7 @@ class GithubHookControllerTest < ActionController::TestCase
   end
 
   def setup
-    Project.stubs(:find_by_identifier).with('github').returns(project)
+    Project.stubs(:find_by_identifier).with("github").returns(project)
 
     # Make sure we don't run actual commands in test
     GithubHook::Updater.any_instance.expects(:system).never
@@ -76,21 +76,24 @@ class GithubHookControllerTest < ActionController::TestCase
     post :index, :payload => json
   end
 
-  def test_should_render_ok_when_done
+  def test_should_render_response_from_github_hook_when_done
     GithubHook::Updater.any_instance.expects(:update_repository).returns(true)
     do_post
     assert_response :success
-    assert_equal 'OK', @response.body
+    assert_match "GithubHook: Redmine repository updated", @response.body
   end
 
   def test_should_render_error_message
-    GithubHook::Updater.any_instance.expects(:update_repository).raises(ActiveRecord::RecordNotFound.new("Repository not found"))
+    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))
+                   "title" => "ActiveRecord::RecordNotFound",
+                   "message" => "Repository not found"
+                 }, JSON.parse(@response.body))
   end
 
   def test_should_not_require_login
@@ -115,5 +118,4 @@ class GithubHookControllerTest < ActionController::TestCase
     get :index
     assert_response :success
   end
-
 end

data/test/test_helper.rb

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

data/test/unit/github_hook/message_logger_test.rb

@@ -1,9 +1,9 @@
 # require 'test_helper'
-require "test/unit"
+require "minitest/autorun"
 require_relative "../../../app/services/github_hook/message_logger"
 
-class MessageLoggerTest < Test::Unit::TestCase
-  setup do
+class MessageLoggerTest < Minitest::Test
+  def setup
     @logger = GithubHook::MessageLogger.new
   end
 

data/test/unit/github_hook/updater_test.rb

@@ -1,10 +1,9 @@
-require 'test_helper'
+require "test_helper"
 
-require 'test/unit'
-require 'mocha'
-
-class GithubHookUpdaterTest < Test::Unit::TestCase
+require "minitest/autorun"
+require "mocha"
 
+class GithubHookUpdaterTest < Minitest::Test
   def project
     return @project if @project
 
@@ -21,10 +20,21 @@ class GithubHookUpdaterTest < Test::Unit::TestCase
     @repository
   end
 
+  # rubocop:disable Metrics/LineLength
   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"}
-  end
+    {
+      "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
+  # rubocop:enable Metrics/LineLength
 
   def build_updater(payload, options = {})
     updater = GithubHook::Updater.new(payload, options)
@@ -38,7 +48,7 @@ class GithubHookUpdaterTest < Test::Unit::TestCase
   end
 
   def setup
-    Project.stubs(:find_by_identifier).with('github').returns(project)
+    Project.stubs(:find_by_identifier).with("github").returns(project)
 
     # Make sure we don't run actual commands in test
     GithubHook::Updater.any_instance.expects(:system).never
@@ -50,7 +60,7 @@ class GithubHookUpdaterTest < Test::Unit::TestCase
   end
 
   def test_uses_repository_name_as_project_identifier
-    Project.expects(:find_by_identifier).with('github').returns(project)
+    Project.expects(:find_by_identifier).with("github").returns(project)
     updater.call
   end
 
@@ -60,20 +70,40 @@ class GithubHookUpdaterTest < Test::Unit::TestCase
   end
 
   def test_resets_repository_when_fetch_origin_succeeds
-    updater.expects(:exec).with("git fetch origin", repository.url).returns(true)
-    updater.expects(:exec).with("git fetch origin \"+refs/heads/*:refs/heads/*\"", repository.url)
+    updater
+      .expects(:exec)
+      .with("git fetch origin", repository.url)
+      .returns(true)
+    updater
+      .expects(:exec)
+      .with(
+        "git fetch --prune origin \"+refs/heads/*:refs/heads/*\"",
+        repository.url
+      )
     updater.call
   end
 
   def test_resets_repository_when_fetch_origin_fails
-    updater.expects(:exec).with("git fetch origin", repository.url).returns(false)
-    updater.expects(:exec).with("git reset --soft refs\/remotes\/origin\/master", repository.url).never
+    updater
+      .expects(:exec)
+      .with("git fetch origin", repository.url)
+      .returns(false)
+    updater
+      .expects(:exec)
+      .with("git reset --soft refs\/remotes\/origin\/master", repository.url)
+      .never
     updater.call
   end
 
   def test_uses_project_identifier_from_request
-    Project.expects(:find_by_identifier).with('redmine').returns(project)
-    updater = build_updater(payload, {:project_id => 'redmine'})
+    Project.expects(:find_by_identifier).with("redmine").returns(project)
+    updater = build_updater(payload, :project_id => "redmine")
+    updater.call
+  end
+
+  def test_uses_project_identifier_from_request_as_numeric
+    Project.expects(:find_by_identifier).with("42").returns(project)
+    updater = build_updater(payload, :project_id => 42)
     updater.call
   end
 
@@ -92,7 +122,7 @@ class GithubHookUpdaterTest < Test::Unit::TestCase
     another_repository.expects(:fetch_changesets).never
     project.repositories << another_repository
 
-    updater = build_updater(payload, {:repository_id => 'redmine'})
+    updater = build_updater(payload, :repository_id => "redmine")
     updater.expects(:exec).with("git fetch origin", repository.url)
     updater.call
   end
@@ -102,7 +132,7 @@ class GithubHookUpdaterTest < Test::Unit::TestCase
     another_repository.expects(:fetch_changesets).returns(true)
     project.repositories << another_repository
 
-    updater = build_updater(payload, {:repository_id => 'redmine or something'})
+    updater = build_updater(payload, :repository_id => "redmine or something")
     updater.expects(:exec).with("git fetch origin", repository.url)
     updater.call
   end
@@ -116,23 +146,23 @@ class GithubHookUpdaterTest < Test::Unit::TestCase
 
   def test_raises_record_not_found_if_project_identifier_not_given
     assert_raises ActiveRecord::RecordNotFound do
-      updater = build_updater(payload.merge({"repository" => {}}))
+      updater = build_updater(payload.merge("repository" => {}))
       updater.call
     end
   end
 
   def test_raises_record_not_found_if_project_not_found
     assert_raises ActiveRecord::RecordNotFound do
-      Project.expects(:find_by_identifier).with('foobar').returns(nil)
-      updater = build_updater(payload, {:project_id => "foobar"})
+      Project.expects(:find_by_identifier).with("foobar").returns(nil)
+      updater = build_updater(payload, :project_id => "foobar")
       updater.call
     end
   end
 
   def test_downcases_identifier
     # Redmine project identifiers are always downcase
-    Project.expects(:find_by_identifier).with('redmine').returns(project)
-    updater = build_updater(payload, {:project_id => 'ReDmInE'})
+    Project.expects(:find_by_identifier).with("redmine").returns(project)
+    updater = build_updater(payload, :project_id => "ReDmInE")
     updater.call
   end
 
@@ -144,19 +174,19 @@ class GithubHookUpdaterTest < Test::Unit::TestCase
 
   def test_raises_type_error_if_project_has_no_repository
     assert_raises TypeError do
-      project = mock('project', :to_s => 'My Project', :identifier => 'github')
+      project = mock("project", :to_s => "My Project", :identifier => "github")
       project.expects(:repositories).returns([])
-      Project.expects(:find_by_identifier).with('github').returns(project)
+      Project.expects(:find_by_identifier).with("github").returns(project)
       updater.call
     end
   end
 
   def test_raises_type_error_if_repository_is_not_git
     assert_raises TypeError do
-      project = mock('project', :to_s => 'My Project', :identifier => 'github')
+      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)
+      Project.expects(:find_by_identifier).with("github").returns(project)
       updater.call
     end
   end
@@ -165,7 +195,7 @@ class GithubHookUpdaterTest < Test::Unit::TestCase
     updater = GithubHook::Updater.new(payload)
     updater.stubs(:exec).returns(true)
 
-    logger = stub('Logger')
+    logger = stub("Logger")
     logger.expects(:info).at_least_once
     updater.logger = logger
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redmine_github_hook
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Jakob Skjerning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-30 00:00:00.000000000 Z
+date: 2018-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Allow your Redmine installation to be notified when changes have been pushed