redmine-mattermost 0.3 → 0.4.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b17e4d44f9c953dabfdd955d7970ab1630ea37f2
-  data.tar.gz: 861ca5d7a696c50dc9c01a1690ae7599ceee0e8e
+  metadata.gz: ccd8592a22be9dae331562b803f93b1515ed9022
+  data.tar.gz: 0243de9f725c2751744d4106dcc7f4446a30b44b
 SHA512:
-  metadata.gz: 2e95d3b82ecc49c62cdff20a3ca87a13d61464860e2fe98fd854cb027f8e1743628a2523cdfd73962bb92f5a62ac6552abca76ede3d76cbba3bcfae2af262837
-  data.tar.gz: 0a389640ad699753e24731d29768f24dc2df5dac2825c3a7db9c4fa1222ffb1b00336316a3ab70214bac93271dd0ef14d840243cf6d1537bae374bb3d1bfa980
+  metadata.gz: ec2dcbbbde62fa4e40070f7ac1691487a029463bdcae62bc3c050e904ee752b8f12e162d6f2f05808685f0f86808a36298853ede6e684e10b33552f8488da0e9
+  data.tar.gz: 68e1c9640f500e3fc491d6c90deeec7a196e9f46aa18cbfb5a8fc4ee2a46127b18f9a4955f448cadd496ddd9c4eae14b5cd69590df90a3480481e85c844a19e1

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - ruby-head
+  - 2.3.1
+  - 2.2
+  - 2.1
+  - 2.0
+before_install:
+  - gem install bundler
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true

data/LICENSE

@@ -2,6 +2,7 @@ Released under the MIT license.
 
 Project redmine-slack is Copyright (c) 2014-2016 by Samuel Cormier-Iijima (https://github.com/sciyoshi/redmine-slack).
 Fork project redmine_mattermost is Copyright (c) 2015-2016 by AltSol (https://github.com/altsol/redmine_mattermost).
+Fork project redmine-mattermost is Copyright (c) 2016 by Jonas Thiel (https://github.com/neopoly/redmine-mattermost).
 
 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:
 

data/README.md

@@ -1,23 +1,38 @@
-### NOTE: This is a fork of [altsol/redmine_mattermost](https://github.com/altsol/redmine_mattermost) to support a Gem-based plugin for Redmine!
+[github]: https://github.com/neopoly/redmine-mattermost
+[doc]: http://rubydoc.info/github/neopoly/redmine-mattermost/master/file/README.md
+[gem]: https://rubygems.org/gems/redmine-mattermost
+[travis]: https://travis-ci.org/neopoly/redmine-mattermost
+[codeclimate]: https://codeclimate.com/github/neopoly/redmine-mattermost
+
 
 # Mattermost chat plugin for Redmine
 
-This plugin posts updates to issues in your Redmine installation to a Mattermost
-channel.
+This plugin posts updates to issues and wiki pages from your Redmine installation to Mattermost.
+
+[![Travis](https://img.shields.io/travis/neopoly/redmine-mattermost.svg?branch=master)][travis]
+[![Gem Version](https://img.shields.io/gem/v/redmine-mattermost.svg)][gem]
+[![Code Climate](https://img.shields.io/codeclimate/github/neopoly/redmine-mattermost.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/neopoly/redmine-mattermost/badges/coverage.svg)][codeclimate]
+
+[Gem][gem] |
+[Source][github] |
+[Documentation][doc]
 
-Redmine Supported versions: 2.0.x - 3.2.x.
+Redmine Supported versions: >= 2.0.0
+
+> **NOTE:** This plugin started as a fork of https://github.com/altsol/redmine_mattermost
 
 ## Screenshot
 
-![screenshot](https://raw.githubusercontent.com/altsol/redmine_mattermost/assets/screenshot.png)
+![screenshot](https://raw.githubusercontent.com/neopoly/redmine-mattermost/assets/screenshot.png)
 
 ## Installation
 
 1. Ensure you have a `Gemfile.local` file in your Redmine directory. You may just create an empty file.
 2. Register `redmine-mattermost` as a dependency as you would do for any other Ruby project:
 
-		gem "redmine-mattermost", "~> 0.3"
-	
+		gem "redmine-mattermost", "~> 0.4"
+
 3. Run bundler:
 
    		bundle install
@@ -26,35 +41,33 @@ Restart Redmine, and you should see the plugin show up in the Plugins page.
 Under the configuration options, set the Mattermost API URL to the URL for an
 Incoming WebHook integration in your Mattermost account (see also the next two sections).
 
-## Customized Routing
+## Customized channels
 
-You can also route messages to different channels on a per-project basis. To
+You can also post messages to different channels on a per-project basis. To
 do this, create a project custom field (Administration > Custom fields > Project)
 named `Mattermost Channel`. If no custom channel is defined for a project, the parent
 project will be checked (or the default will be used). To prevent all notifications
 from being sent for a project, set the custom channel to `-`.
 
-For more information, see http://www.redmine.org/projects/redmine/wiki/Plugins (see also next section for an easy configuration demonstration).
-
 ## Screenshot Guided Configuration
 
 Step 1: Create an Incoming Webhook in Mattermost (Account Settings > Integrations > Incoming Webhooks).
 
-![step1](https://raw.githubusercontent.com/altsol/redmine_mattermost/assets/step1.png)
+![step1](https://raw.githubusercontent.com/neopoly/redmine-mattermost/assets/step1.png)
 
 Step 2: Configure this Redmine plugin for Mattermost. For per-project customized routing, leave the `Mattermost Channel` field empty and follow the next steps, otherwise all Redmine projects will post to the same Mattermost channel. Be careful when filling the channel field, you need to input the channel's handle, not the display name visible to users. You can find each channel's handle by going inside the channel and click the down-arrow and selecting view info.
 
-![step3](https://raw.githubusercontent.com/altsol/redmine_mattermost/assets/step3.png)
+![step3](https://raw.githubusercontent.com/neopoly/redmine-mattermost/assets/step3.png)
 
 Step 3: For per-project customized routing, first create the project custom field (Administration > Custom fields > Project).
 
-![step4a](https://raw.githubusercontent.com/altsol/redmine_mattermost/assets/step4a.png)
-![step4b](https://raw.githubusercontent.com/altsol/redmine_mattermost/assets/step4b.png)
+![step4a](https://raw.githubusercontent.com/neopoly/redmine-mattermost/assets/step4a.png)
+![step4b](https://raw.githubusercontent.com/neopoly/redmine-mattermost/assets/step4b.png)
 
 Step 4: For per-project customized routing, configure the Mattermost channel handle inside your Redmine project.
 
-![step5](https://raw.githubusercontent.com/altsol/redmine_mattermost/assets/step5.png)
+![step5](https://raw.githubusercontent.com/neopoly/redmine-mattermost/assets/step5.png)
 
 ## Credits
 
-The source code is forked from https://github.com/altsol/redmine_mattermost. Special thanks to the original author and contributors for making this awesome hook for Redmine. This fork is just refactored to allow a Gem-based installation.
+The source code is forked from https://github.com/altsol/redmine_mattermost. Special thanks to the original author and contributors for making this awesome hook for Redmine.

data/Rakefile

@@ -1,3 +1,12 @@
 #!/usr/bin/env rake
 
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |test|
+  test.test_files = FileList['spec/**/*_spec.rb']
+  test.libs << 'spec'
+  test.verbose = true
+end
+
+task default: [:spec]

data/app/views/settings/_mattermost_settings.html.erb

@@ -1,46 +1,86 @@
+<div class="box">
+  <i class="icon icon-help"></i> You can find detailed setup instructions in the
+  <a href="https://github.com/neopoly/redmine-mattermost/blob/master/README.md" target="_blank">README</a>.
+</div>
+
+<p>
+  <label for="settings_mattermost_url">Mattermost URL</label>
+  <input type="text" id="settings_mattermost_url" size=80 value="<%= settings['mattermost_url'] %>" name="settings[mattermost_url]" />
+</p>
+
+<p>
+  Generate an "Incoming WebHook" URL from the
+  <a href="http://docs.mattermost.com/developer/webhooks-incoming.html">Integrations configuration page on Mattermost</a>.
+  <br>
+  This URL can be overwritten on a per-project basis by creating a
+  <a href="/custom_fields/new?type=ProjectCustomField">project custom field</a> named "<code>Mattermost URL</code>".
+</p>
+
+<p>
+  <label for="settings_channel">Mattermost Channel</label>
+  <input type="text" id="settings_channel" value="<%= settings['channel'] %>" name="settings[channel]"  size=80/>
+</p>
+
+<p>
+  The channel can be overwritten on a per-project basis by creating a
+  <a href="/custom_fields/new?type=ProjectCustomField">project custom field</a> named "<code>Mattermost Channel</code>".
+  Mattermost will use the configured channel for the used WebHook in case no channel is given.
+  <br>
+  Using "<code>-</code>" as the channel will prevent any messages to Mattermost.
+</p>
+
+<p>
+  <label for="settings_icon">Mattermost Icon</label>
+  <input type="text" id="settings_icon" value="<%= settings['icon'] %>" name="settings[icon]" size=80/>
+</p>
+
 <p>
-	<label for="settings_mattermost_url">Mattermost URL</label>
-	<input type="text" id="settings_mattermost_url" size=80 value="<%= settings['mattermost_url'] %>" name="settings[mattermost_url]" />
+  The icon can be overwritten on a per-project basis by creating a
+  <a href="/custom_fields/new?type=ProjectCustomField">project custom field</a> named "<code>Mattermost Icon</code>".
 </p>
 
 <p>
-	Generate an "Incoming WebHook" URL from the <a href="http://docs.mattermost.com/developer/webhooks-incoming.html">Integrations configuration page on Mattermost</a>. This URL can be changed on a per-project basis by creating a <a href="/custom_fields/new?type=ProjectCustomField">project custom field</a> named "Mattermost URL" (without quotes).
+  <label for="settings_username">Mattermost Username</label>
+  <input type="text" id="settings_username" value="<%= settings['username'] %>" name="settings[username]"  size=80/>
 </p>
 
 <p>
-	<label for="settings_channel">Mattermost Channel</label>
-	<input type="text" id="settings_channel" value="<%= settings['channel'] %>" name="settings[channel]" />
+  The username can be overwritten on a per-project basis by creating a
+  <a href="/custom_fields/new?type=ProjectCustomField">project custom field</a> named "<code>Mattermost Username</code>".
 </p>
 
 <p>
-	The channel can be changed on a per-project basis by creating a
-	<a href="/custom_fields/new?type=ProjectCustomField">project custom field</a> named "Mattermost Channel" (without quotes).
+  <label for="settings_display_watchers">Display Watchers?</label>
+  <%
+    display_watchers_available = Setting.text_formatting != "textile"
+    display_watchers = settings['display_watchers']
+  %>
+  <input type="checkbox" id="settings_display_watchers" value="1" name="settings[display_watchers]" <%= display_watchers ? 'checked="checked"' : '' %> <%= display_watchers_available ? '' : 'disabled="disabled"' %>/>
 </p>
 
 <p>
-	<label for="settings_icon">Mattermost Icon</label>
-	<input type="text" id="settings_icon" value="<%= settings['icon'] %>" name="settings[icon]" />
+  Enabling this option will scan the content for mentions (e.g. <code>@joe</code>) and list them
+  in the message title.
+  <br>
+  <em>This option is not available if you're using "Textile" as the main "Text formatting" engine in Redmine as the <code>@</code>-char has a special usage.</em>
 </p>
 
 <p>
-	<label for="settings_username">Mattermost Username</label>
-	<input type="text" id="settings_username" value="<%= settings['username'] %>" name="settings[username]" />
+  <label for="settings_post_updates">Post Issue Updates?</label>
+  <input type="checkbox" id="settings_post_updates" value="1" name="settings[post_updates]" <%= settings['post_updates'] == '1' ? 'checked="checked"' : '' %> />
 </p>
 
 <p>
-	<label for="settings_display_watchers">Display Watchers?</label>
-	<select id="settings_display_watchers" value="<%= settings['display_watchers'] %>" name="settings[display_watchers]">
-		<option value="yes">Yes</option>
-		<option value="no" <%= settings['display_watchers'] != 'yes' ? %q(selected="selected") : '' %>>No</option>
-	</select>
+  Per default only new issue are reported to Mattermost. Enable this option if you want every issue
+  update to be posted to Mattermost.
 </p>
 
 <p>
-	<label for="settings_post_updates">Post Issue Updates?</label>
-	<input type="checkbox" id="settings_post_updates" value="1" name="settings[post_updates]" <%= settings['post_updates'] == '1' ? 'checked="checked"' : '' %> />
+  <label for="settings_post_wiki_updates">Post Wiki Changes?</label>
+  <input type="checkbox" id="settings_post_wiki_updates" value="1" name="settings[post_wiki_updates]" <%= settings['post_wiki_updates'] == '1' ? 'checked="checked"' : '' %> />
 </p>
 
 <p>
-	<label for="settings_post_wiki_updates">Post Wiki Updates?</label>
-	<input type="checkbox" id="settings_post_wiki_updates" value="1" name="settings[post_wiki_updates]" <%= settings['post_wiki_updates'] == '1' ? 'checked="checked"' : '' %> />
+  Per default changes to Wiki pages (new pages or updates) are not posted to Mattermost. Enable this option
+  if you want every change to a Wiki page posted to Mattermost.
 </p>

data/lib/redmine-mattermost.rb

@@ -1,6 +1,14 @@
 require "redmine_mattermost/version"
 require "redmine_mattermost/infos"
-require "redmine_mattermost/engine"
+require "redmine_mattermost/client"
+require "redmine_mattermost/message_builder"
+require "redmine_mattermost/bridge"
+require "redmine_mattermost/utils"
+require "redmine_mattermost/extractors"
+
+if defined?(Rails)
+  require "redmine_mattermost/engine"
+end
 
 # Mattermost chat integration
 module RedmineMattermost

data/lib/redmine_mattermost/bridge.rb

@@ -0,0 +1,63 @@
+module RedmineMattermost
+  class Bridge
+    def settings
+      ::Setting
+    end
+
+    def custom_field_by_name(name)
+      ::ProjectCustomField.find_by_name(name)
+    end
+
+    def url_for(target)
+      ::Rails.application.routes.url_for(target)
+    end
+
+    def translate(*args)
+      ::I18n.t(*args)
+    end
+
+    def to_html(formatting, text)
+      Redmine::WikiFormatting.to_html(formatting, text)
+    end
+
+    def find_custom_field(id)
+      ::CustomField.find_by_id(id)
+    end
+
+    def find_tracker(id)
+      ::Tracker.find_by_id(id)
+    end
+
+    def find_project(id)
+      ::Project.find_by_id(id)
+    end
+
+    def find_issue_status(id)
+      ::IssueStatus.find_by_id(id)
+    end
+
+    def find_issue_priority(id)
+      ::IssuePriority.find_by_id(id)
+    end
+
+    def find_issue_category(id)
+      ::IssueCategory.find_by_id(id)
+    end
+
+    def find_user(id)
+      ::User.find(id)
+    end
+
+    def find_version(id)
+      ::Version.find_by_id(id)
+    end
+
+    def find_attachement(id)
+      ::Attachment.find_by_id(id)
+    end
+
+    def find_issue(id)
+      ::Issue.find_by_id(id)
+    end
+  end
+end

data/lib/redmine_mattermost/client.rb

@@ -0,0 +1,28 @@
+require "net/http"
+require "json"
+
+module RedmineMattermost
+  class Client
+    SSL_VERSION = "SSLv23".freeze
+
+    attr_reader :uri
+
+    def initialize(url)
+      @uri = URI(url)
+    end
+
+    def speak(message)
+      post_async(payload: message.to_json)
+    end
+
+    private
+
+    def post_async(params)
+      Thread.new { post(params) }
+    end
+
+    def post(params)
+      Net::HTTP.post_form(uri, params)
+    end
+  end
+end

data/lib/redmine_mattermost/extractors.rb

@@ -0,0 +1,88 @@
+module RedmineMattermost
+  module Extractors
+    class Base
+      include Utils::Text
+      include Utils::Urls
+
+      CUSTOM_FIELD_URL = "Mattermost URL"
+      CUSTOM_FIELD_CHANNEL = "Mattermost Channel"
+      CUSTOM_FIELD_ICON = "Mattermost Icon"
+      CUSTOM_FIELD_USERNAME = "Mattermost Username"
+      BLACK_HOLE_CHANNEL = "-"
+      MENTIONS = "\nTo: %{usernames}"
+
+      attr_reader :bridge
+
+      def initialize(bridge)
+        @bridge = bridge
+      end
+
+      protected
+
+      def determine_channel(project)
+        channel = determine_configurable_field(project, :channel, CUSTOM_FIELD_CHANNEL)
+        return channel if channel != BLACK_HOLE_CHANNEL
+      end
+
+      def determine_url(project)
+        determine_configurable_field(project, :mattermost_url, CUSTOM_FIELD_URL)
+      end
+
+      def determine_icon(project)
+        determine_configurable_field(project, :icon, CUSTOM_FIELD_ICON)
+      end
+
+      def determine_username(project)
+        determine_configurable_field(project, :username, CUSTOM_FIELD_USERNAME)
+      end
+
+      def extract_mentions(text)
+        return unless text
+        return if uses_textile?
+        usernames = extract_usernames(text)
+        return if usernames.empty?
+        MENTIONS % { usernames: usernames.join(", ") }
+      end
+
+      def extract_usernames(text)
+        return [] unless text
+        return [] if uses_textile?
+        text.scan(/@[a-z0-9][a-z0-9_\-]*/).uniq
+      end
+
+      def uses_textile?
+        settings.text_formatting == "textile"
+      end
+
+      def show_watchers?
+        settings.plugin_redmine_mattermost[:display_watchers] == "1"
+      end
+
+      def settings
+        bridge.settings
+      end
+
+      private
+
+      def custom_field(name)
+        bridge.custom_field_by_name(name)
+      end
+
+      def determine_configurable_field(project, settings_key, field_key)
+        return if project.nil? || project.blank?
+        cf = custom_field(field_key)
+
+        [
+          (project.custom_value_for(cf).value rescue nil),
+          determine_configurable_field(project.parent, settings_key, field_key),
+          settings.plugin_redmine_mattermost[settings_key],
+        ].find { |v| !v.nil? && !v.empty? }
+      end
+    end
+  end
+end
+
+require "redmine_mattermost/extractors/applied_changeset"
+require "redmine_mattermost/extractors/changed_wiki_page"
+require "redmine_mattermost/extractors/new_issue"
+require "redmine_mattermost/extractors/updated_issue"