mine-shipper 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    mine-shipper (0.0.1)
+      dotenv (~> 2.7)
+      octokit (~> 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    dotenv (2.7.6)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    multipart-post (2.1.1)
+    octokit (4.18.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    power_assert (1.2.0)
+    public_suffix (4.0.5)
+    rake (13.0.1)
+    rr (1.2.1)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    test-unit (3.3.6)
+      power_assert
+    test-unit-rr (1.0.5)
+      rr (>= 1.1.1)
+      test-unit (>= 2.5.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mine-shipper!
+  rake (~> 13.0)
+  test-unit (~> 3.3)
+  test-unit-rr (~> 1.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,49 @@
+# mine-shipper
+
+A command to duplicate comments on a GitHub issue to an associated Redmine issue.
+
+## Prepare on Redmine
+
+1. Create API access key of your Redmine account
+  * My account -> API access key
+2. Create a custom field with the following properties (Administration -> Custom fields)
+  * Format: `Link`
+  * Name: `GitHub`
+  * Regular expression: `\A([\w-]+)/([\w-]+)#(\d+)\z`
+  * Used as a filter: checked
+3. Enable the custom field at your Redmine project
+4. Create an issue on the project
+  * Fill "GitHub" custom fileld to associate a GitHub issue to the Redmine issue.
+    e.g.) groonga/groonga#1062
+
+## Installation
+
+```
+$ bundle install
+$ cp sample.env .env
+```
+
+Then edit .env to adopt to your environment.
+`GITHUB_ACCESS_TOKEN` is optional but recommended to set to exceed [API rate limit](https://developer.github.com/v3/rate_limit/).
+See https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token to know how to get it.
+
+## Usage
+
+Run ./bin/mine-shipper command with `--github-issue` option to specify the issue.
+
+e.g.)
+
+```
+$ bundle exec ./bin/mine-shipper --github-issue groonga/groonga#1062
+```
+
+The comments on the GitHub issue will be copied to the associated Redmine issue.
+If no associated issue on Redmine is found or the comments are already copied, it does nothing.
+
+## Plans
+
+* Create a new issue when no associated issue is found
+* Close a Redmine issue automatically if an associated GitHub issue is closed
+* Synchronize updated comments ([need to add new API to Redmine](https://www.redmine.org/issues/10171))
+* Work as Webhook
+* ...

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/test_*.rb"
+  t.verbose = true
+  t.warning = true
+end
+
+task :default => :test

data/bin/mine-shipper

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+#
+# 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/>.
+
+require_relative '../lib/mine-shipper/app'
+
+app = MineShipper::App.new
+app.run

data/lib/mine-shipper/app.rb

@@ -0,0 +1,81 @@
+#
+# 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/>.
+
+require 'logger'
+require_relative './config'
+require_relative './github'
+require_relative './redmine'
+
+module MineShipper
+  class App
+    def initialize
+      @config = Config::new
+      @issue_key = @config[:github][:issue]
+      @logger = Logger.new(STDOUT)
+      @logger.level = @config[:log_level]
+    end
+
+    def run
+      begin
+        do_run
+      rescue Exception => e
+        @logger.error(e)
+      end
+    end
+
+    private
+
+    def do_run
+      @logger.info("Fetching #{@issue_key} comments on Redmine...")
+      redmine_issue = get_redmine_issue
+      if redmine_issue
+        @logger.info("Fetching #{@issue_key} comments on GitHub...")
+        github_issue = get_github_issue
+        dump_issue(github_issue)
+        dump_issue(redmine_issue)
+        redmine_issue.sync_comments(github_issue.comments)
+        @logger.info("Done synchronizing issue comments of #{@issue_key}")
+      else
+        @logger.info("Cannot find Redmine issue for #{@issue_key}")
+      end
+    end
+
+    def get_github_issue
+      project_name, issue_id = @issue_key.split('#', 2)
+      github = GitHub::new(@config[:github][:access_token])
+      github.issue(project_name, issue_id)
+    end
+
+    def get_redmine_issue
+      redmine = Redmine.new(@config[:redmine][:base_url],
+                            @config[:redmine][:api_key])
+      redmine.issue_by_custom_field(@config[:redmine][:custom_field_id],
+                                    @issue_key)
+    end
+
+    def dump_issue(issue)
+      @logger.debug("#{issue.tracker} Issue \##{issue.identifier}: #{issue.title}")
+      issue.comments.each do |comment|
+        dump_comment(comment)
+      end
+    end
+
+    def dump_comment(comment)
+      time = comment.created_at.getlocal
+      @logger.debug("#{comment.tracker} Comment #{time}\n#{comment.body}")
+    end
+  end
+end

data/lib/mine-shipper/config.rb

@@ -0,0 +1,45 @@
+#
+# 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/>.
+
+require 'optparse'
+require 'dotenv/load'
+
+module MineShipper
+  class Config < Hash
+    DEFAULT_CONFIG = {
+      log_level: ENV["MINE_SHIPPER_LOG_LEVEL"] || 'WARN',
+      github: {
+        access_token: ENV["GITHUB_ACCESS_TOKEN"],
+        issue: nil
+      },
+      redmine: {
+        base_url: ENV["REDMINE_BASE_URL"],
+        custom_field_id: ENV["REDMINE_CUSTOM_FIELD_ID"],
+        api_key: ENV["REDMINE_API_KEY"],
+      }
+    }
+
+    def initialize(argv = ARGV)
+      self.merge!(DEFAULT_CONFIG)
+      OptionParser.new do |opts|
+        opts.on("--github-issue ISSUE") do |github_issue|
+          self[:github][:issue] = github_issue
+        end
+        opts.parse!(argv)
+      end
+    end
+  end
+end

data/lib/mine-shipper/github.rb

@@ -0,0 +1,71 @@
+#
+# 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/>.
+
+require 'octokit'
+require_relative './issue_comment.rb'
+
+module MineShipper
+  class GitHub
+    def initialize(access_token = nil)
+      @client = Octokit::Client.new(:access_token => access_token)
+    end
+
+    def issue(project_name, issue_id)
+      @issue = @client.issue(project_name, issue_id)
+      Issue.new(@client, project_name, issue_id)
+    end
+
+    class Issue
+      attr_reader :comments
+
+      def initialize(client, project_name, issue_id)
+        @project_name = project_name
+        @issue_id = issue_id
+        @issue = client.issue(@project_name, @issue_id)
+        @comments = [Comment.new(@issue)]
+        comments = client.issue_comments(@project_name, @issue_id)
+        comments.each do |comment|
+          @comments << Comment.new(comment)
+        end
+      end
+
+      def tracker
+        "GitHub"
+      end
+
+      def identifier
+        "#{@project_name}#{@issue_id}"
+      end
+
+      def title
+        @issue.title
+      end
+    end
+
+    class Comment < IssueComment
+      attr_reader :tracker, :created_at, :updated_at, :url, :user, :body
+      def initialize(comment)
+        @comment = comment
+        @tracker = "GitHub"
+        @created_at = @comment.created_at
+        @updated_at = @comment.updated_at
+        @url = @comment.html_url
+        @usr = @comment.user.login
+        @body = @comment.body.gsub(/\R/, "\n")
+      end
+    end
+  end
+end

data/lib/mine-shipper/issue_comment.rb

@@ -0,0 +1,78 @@
+#
+# 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
+  class NotImplemented < StandardError
+  end
+
+  class IssueComment
+    def tracker
+      "Unknown"
+    end
+
+    def created_at
+      raise NotImplemented
+    end
+
+    def updated_at
+      raise NotImplemented
+    end
+
+    def url
+      raise NotImplemented
+    end
+
+    def user
+      raise NotImplemented
+    end
+
+    def body
+      raise NotImplemented
+    end
+
+    def render
+      title = "#{user} commented on #{created_at.getlocal}"
+      result  = "### [#{title}](#{url})\n"
+      result += "{{collapse(More...)\n"
+      result += "* created_at: \"#{created_at.getlocal}\"\n"
+      result += "* updated_at: \"#{updated_at.getlocal}\"\n"
+      result += "}}\n"
+      result += "\n"
+      result += body
+      result
+    end
+
+    def corresponding?(comment)
+      escaped_url = Regexp.escape(comment.url)
+      escaped_time = Regexp.escape("#{comment.created_at.getlocal}")
+      if body.match(/^### \[#{comment.user} commented on #{escaped_time}\]\(#{escaped_url}\)\n/)
+        true
+      else
+        false
+      end
+    end
+
+    def updated?(comment)
+      lines = body.split("\n", 6)
+      return false if lines[1] != "{{collapse(More...)"
+      return false if lines[4] != "}}"
+      timestr = lines[3].match(/^\* updated_at: \"(.*)\"$/).to_a[1]
+      return false if timestr.nil?
+      updated_time = Time.parse(timestr)
+      updated_time >= comment.updated_at
+    end
+  end
+end

data/lib/mine-shipper/redmine.rb

@@ -0,0 +1,170 @@
+#
+# 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/>.
+
+require 'net/https'
+require 'uri'
+require 'json'
+require_relative './issue_comment.rb'
+
+module MineShipper
+  class Redmine
+    class Issue
+      attr_reader :tracker, :id, :identifier, :title, :comments
+
+      def initialize(redmine, json)
+        @redmine = redmine
+        @json = json
+        @tracker = "Redmine"
+        @id = @json["id"]
+        @identifier = "##{@json["id"]}"
+        @title = @json["subject"]
+        @comments = []
+        @json["journals"].each do |journal|
+          next if journal["notes"].empty?
+          @comments << Comment.new(journal)
+        end
+      end
+
+      def sync_comments(comments)
+        path = "issues/#{id}.json"
+        comments.each do |comment|
+          sync_comment(comment)
+        end
+      end
+
+      def sync_comment(comment)
+        my_comment = find_comment(comment)
+        if my_comment
+          my_comment.update(comment)
+        else
+          post_comment(comment)
+        end
+      end
+
+      def find_comment(comment)
+        @comments.each do |my_comment|
+          return my_comment if my_comment.corresponding?(comment)
+        end
+        nil
+      end
+
+      def post_comment(comment)
+        path = "issues/#{id}.json"
+        params = {
+          issue: {
+            notes: comment.render
+          }
+        }
+        @redmine.api_request(path, params, :put)
+      end
+    end
+
+    class Comment < IssueComment
+      attr_reader :tracker, :body, :created_at
+      def initialize(json)
+        @json = json
+        @tracker = "Redmine"
+        @body = @json["notes"]
+        @created_at = Time.parse(@json["created_on"])
+      end
+
+      def update(comment)
+        return if updated?(comment)
+        # TODO: There is no API to update a comment
+        # https://www.redmine.org/issues/10171
+      end
+    end
+
+    def initialize(base_url, api_key = nil)
+      @base_url = base_url
+      @api_key = api_key
+    end
+
+    def api_request(path, params = {}, method = :get)
+      url = "#{@base_url}/#{path}"
+      uri = URI.parse(url)
+
+      case method
+      when :get
+        req = Net::HTTP::Get.new(uri.request_uri)
+      when :post
+        req = Net::HTTP::Post.new(uri.request_uri)
+      when :put
+        req = Net::HTTP::Put.new(uri.request_uri)
+      end
+      req["Content-Type"] = "application/json"
+      req['X-Redmine-API-Key'] = @api_key
+      req.body = params.to_json
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      response = http.request(req)
+      if response.kind_of?(Net::HTTPSuccess)
+        response
+      else
+        raise "#{uri}: #{response.code} #{response.message}"
+      end
+    end
+
+    def custom_fields(params = {})
+     response = api_request("custom_fields.json", params)
+      JSON.parse(response.body)["custom_fields"]
+    end
+
+    def custom_field_id(custom_field_name)
+      fields = custom_fields
+      field = fields.find do |field|
+        field["name"] == custom_field_name
+      end
+      field["id"]
+    end
+
+    def issues(params = {})
+      response = api_request("issues.json", params)
+      issues_json = JSON.parse(response.body)["issues"]
+      issues = []
+      issues_json.each do |issue_json|
+        id = issue_json["id"]
+        issues << issue(id)
+      end
+      issues
+    end
+
+    def issue(id)
+      params = {
+        include: "journals"
+      }
+      response = api_request("issues/#{id}.json", params)
+      issue_json = JSON.parse(response.body)["issue"]
+      Issue.new(self, issue_json)
+    end
+
+    def issues_by_custom_field(field_id, field_value, limit: nil)
+      search_options = {
+        "cf_#{field_id}".to_sym => field_value,
+        :status_id => '*',
+        :sort => 'id',
+        :limit => limit,
+      }
+      issues(search_options)
+    end
+
+    def issue_by_custom_field(field_id, field_value)
+      issues = issues_by_custom_field(field_id, field_value, limit: 1)
+      issues.empty? ? nil : issues.first
+    end
+  end
+end