mine-shipper 0.0.1

data/lib/mine-shipper/version.rb

@@ -0,0 +1,19 @@
+#
+# Copyright (C) 2020 Takuro Ashie <ashie@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/>.
+
+module MineShipper
+  VERSION = '0.0.1'
+end

data/mine-shipper.gemspec

@@ -0,0 +1,24 @@
+require File.expand_path('../lib/mine-shipper/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "mine-shipper"
+  spec.version        = MineShipper::VERSION
+  spec.authors       = ["Takuro Ashie"]
+  spec.email         = ["ashie@clear-code.com"]
+  spec.summary       = "Connect GitHub issues with Redmine"
+  spec.description   = "Duplicate comments in GitHub issues to Redmine"
+  spec.homepage      = "https://gitlab.com/clear-code/mine-shipper"
+  spec.license       = "GPL-3.0-or-later"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency("octokit", "~> 4.0")
+  spec.add_runtime_dependency("dotenv", "~> 2.7")
+  spec.add_development_dependency("rake", "~> 13.0")
+  spec.add_development_dependency("test-unit", "~> 3.3")
+  spec.add_development_dependency("test-unit-rr", "~> 1.0")
+end

data/sample.env

@@ -0,0 +1,5 @@
+#MINE_SHIPPER_LOG_LEVEL=WARN
+GITHUB_ACCESS_TOKEN=
+REDMINE_BASE_URL="https://redmine.example.com"
+REDMINE_API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+REDMINE_CUSTOM_FIELD_ID=4

data/test/test_issue_comment.rb

@@ -0,0 +1,64 @@
+require "test/unit"
+require "json"
+require "time"
+require_relative "../lib/mine-shipper/issue_comment"
+
+class TestIssueComment < Test::Unit::TestCase
+  include MineShipper
+
+  CREATED_TIME = Time.parse("2020-08-06 10:41:42 +0000")
+  UPDATED_TIME = Time.parse("2020-08-06 10:52:12 +0000")
+  EXPECTED_FIRST_LINE = "### [foobar commented on #{CREATED_TIME.getlocal}](http://example.com/issue/1234)\n"
+  EXPECTED_BODY =
+    EXPECTED_FIRST_LINE +
+    "{{collapse(More...)\n" +
+    "* created_at: \"#{CREATED_TIME.getlocal}\"\n" +
+    "* updated_at: \"#{UPDATED_TIME.getlocal}\"\n"+
+    "}}\n" +
+    "\n" +
+    "hoge"
+
+  class TestComment < IssueComment
+    attr_reader :created_at, :user, :url, :body
+    attr_accessor :body, :updated_at
+
+    def initialize
+      @created_at = CREATED_TIME
+      @updated_at = UPDATED_TIME
+      @user = "foobar"
+      @url = "http://example.com/issue/1234"
+      @body = "hoge"
+    end
+  end
+
+  test "render" do
+    comment = TestComment.new
+    assert_equal(EXPECTED_BODY, comment.render)
+  end
+
+  data('corresponding' => [EXPECTED_FIRST_LINE, true],
+       'with heading space' => [" " + EXPECTED_FIRST_LINE, false],
+       'missing line break' => [EXPECTED_FIRST_LINE.delete("\n"), false],
+       'different user' => [EXPECTED_FIRST_LINE.gsub("foobar", "hoge"), false],
+       'different date' => [EXPECTED_FIRST_LINE.gsub("2020", "2018"), false],
+       'different url' => [EXPECTED_FIRST_LINE.gsub("example.com", "example.org"), false])
+  test "corresponding?" do |data|
+    body, expected = data
+    comment1 = TestComment.new
+    comment2 = TestComment.new
+    comment1.body = body
+    assert_equal(expected, comment1.corresponding?(comment2))
+  end
+
+  data('same date'           => ["2020-08-06 10:52:12 +0000", true],
+       'updated at upstream' => ["2020-08-06 10:52:13 +0000", false],
+       'past date'           => ["2020-08-06 10:52:11 +0000", true])
+  test "updated?" do
+    date, expected = data
+    comment1 = TestComment.new
+    comment2 = TestComment.new
+    comment1.body = EXPECTED_BODY
+    comment2.updated_at = Time.parse(date)
+    assert_equal(expected, comment1.updated?(comment2))
+  end
+end

data/test/test_redmine.rb

@@ -0,0 +1,139 @@
+require "test/unit"
+require "test/unit/rr"
+require "json"
+require "time"
+require_relative "../lib/mine-shipper/redmine"
+
+class TestRedmineIssue < Test::Unit::TestCase
+  include MineShipper
+
+  TEST_ISSUE = {
+    id: 13,
+    subject: "test subject",
+    journals: [
+      {
+        created_on: Time.parse("2020-08-06 09:41:42 +0000"),
+        updated_on: Time.parse("2020-08-06 09:52:12 +0000"),
+        notes: "hoge"
+      },
+      {
+        created_on: Time.parse("2020-08-06 10:41:42 +0000"),
+        updated_on: Time.parse("2020-08-06 10:52:12 +0000"),
+        notes: ""
+      },
+      {
+        created_on: Time.parse("2020-08-06 11:41:42 +0000"),
+        updated_on: Time.parse("2020-08-06 11:52:12 +0000"),
+        notes: "hage"
+      }
+    ]
+  }
+
+  setup do
+    obj = JSON.parse(TEST_ISSUE.to_json)
+    @issue = Redmine::Issue.new(nil, obj)
+  end
+
+  test "tracker" do
+    assert_equal("Redmine", @issue.tracker)
+  end
+
+  test "id" do
+    assert_equal(13, @issue.id)
+  end
+
+  test "identifier" do
+    assert_equal("#13", @issue.identifier)
+  end
+
+  test "title" do
+    assert_equal("test subject", @issue.title)
+  end
+
+  test "comments" do
+    assert_equal(2, @issue.comments.length)
+  end
+
+  sub_test_case "post comments" do
+    class TestComment < IssueComment
+      attr_accessor :created_at, :updated_at, :user, :url, :body
+
+      def initialize
+        @created_at = Time.parse("2020-08-06 12:41:42 +0000")
+        @updated_at = Time.parse("2020-08-06 12:52:12 +0000")
+        @user = "foobar"
+        @url = "https://example.com/issue/13#comment1"
+        @body = "hoge"
+      end
+    end
+
+    setup do
+      @redmine = Redmine.new("https://redmine.example.com")
+      obj = JSON.parse(TEST_ISSUE.to_json)
+      @issue = Redmine::Issue.new(@redmine, obj)
+      @comment = TestComment.new
+      @comment_params = {
+        issue: {
+          notes: @comment.render
+        }
+      }
+    end
+
+    test "post_comment" do
+      mock(@redmine).api_request("issues/13.json", @comment_params, :put) { "200" }
+      assert_equal("200", @issue.post_comment(@comment))
+    end
+
+    test "sync_comment" do
+      mock(@redmine).api_request("issues/13.json", @comment_params, :put) { "200" }
+      assert_equal("200", @issue.sync_comment(@comment))
+    end
+
+    test "don't sync_comment" do
+      stub(@issue.comments[0]).corresponding? {true}
+      stub(@redmine).api_request do
+        raise "Updating an issue isn't implemented yet since Redmine doesn't have API to do it"
+      end
+      assert_nil(@issue.sync_comment(@comment))
+    end
+  end
+end
+
+class TestRedmineComment < Test::Unit::TestCase
+  include MineShipper
+
+  TEST_COMMENT = {
+    created_on: Time.parse("2020-08-06 10:41:42 +0000"),
+    updated_on: Time.parse("2020-08-06 10:52:12 +0000"),
+    notes: "hoge"
+  }
+
+  setup do
+    obj = JSON.parse(TEST_COMMENT.to_json)
+    @comment = Redmine::Comment.new(obj)
+  end
+
+  test "tracker" do
+    assert_equal("Redmine", @comment.tracker)
+  end
+
+  test "body" do
+    assert_equal("hoge", @comment.body)
+  end
+
+  test "created_at" do
+    assert_equal(TEST_COMMENT[:created_on], @comment.created_at)
+  end
+
+  test "updated_at" do
+    assert_raise(NotImplemented) do
+      assert_equal(TEST_COMMENT[:updated_on], @comment.updated_at)
+    end
+  end
+
+  test "user" do
+    assert_raise(NotImplemented) do
+      assert_equal(TEST_COMMENT[:updated_on], @comment.user)
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: mine-shipper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Takuro Ashie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Duplicate comments in GitHub issues to Redmine
+email:
+- ashie@clear-code.com
+executables:
+- mine-shipper
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- COPYING
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/mine-shipper
+- lib/mine-shipper/app.rb
+- lib/mine-shipper/config.rb
+- lib/mine-shipper/github.rb
+- lib/mine-shipper/issue_comment.rb
+- lib/mine-shipper/redmine.rb
+- lib/mine-shipper/version.rb
+- mine-shipper.gemspec
+- sample.env
+- test/test_issue_comment.rb
+- test/test_redmine.rb
+homepage: https://gitlab.com/clear-code/mine-shipper
+licenses:
+- GPL-3.0-or-later
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Connect GitHub issues with Redmine
+test_files:
+- test/test_issue_comment.rb
+- test/test_redmine.rb