redmine-mattermost 0.3 → 0.4.beta1

data/lib/redmine_mattermost/message_builder.rb

@@ -0,0 +1,61 @@
+module RedmineMattermost
+  class MessageBuilder
+    DEFAULTS = {
+      link_names: 1
+    }
+
+    def initialize(message)
+      @data = DEFAULTS.merge(text: message)
+      @attachments = []
+    end
+
+    def to_hash
+      @data.dup.tap do |hash|
+        unless @attachments.empty?
+          hash[:attachments] = @attachments.map(&:to_hash)
+        end
+      end
+    end
+
+    def username(name)
+      @data[:username] = name
+    end
+
+    def channel(id)
+      @data[:channel] = id
+    end
+
+    def icon(url)
+      @data[:icon_url] = url unless url.nil? || url.empty?
+    end
+
+    def attachment
+      Attachment.new.tap do |am|
+        @attachments << am
+      end
+    end
+
+    class Attachment
+      def initialize()
+        @data = { }
+      end
+
+      def text(message)
+        @data[:text] = message
+        self
+      end
+
+      def field(title, value, short = false)
+        {title: title, value: value}.tap do |hash|
+          hash[:short] = true if short
+          (@data[:fields] ||= []) << hash
+        end
+        self
+      end
+
+      def to_hash
+        @data.to_hash
+      end
+    end
+  end
+end

data/lib/redmine_mattermost/redmine_plugin.rb

@@ -6,9 +6,9 @@ module RedmineMattermost
     DEFAULT_SETTINGS = {
       "callback_url" => "http://example.com/callback/",
       "channel" => nil,
-      "icon" => "https://raw.githubusercontent.com/altsol/redmine_mattermost/assets/icon.png",
-      "username" => "redmine",
-      "display_watchers" => "no"
+      "icon" => "https://raw.githubusercontent.com/neopoly/redmine-mattermost/assets/icon.png",
+      "username" => "Redmine",
+      "display_watchers" => "0"
     }.freeze
 
     SETTING_PARTIAL = "settings/mattermost_settings"
@@ -27,7 +27,6 @@ module RedmineMattermost
         description DESCRIPTION
         version VERSION
         url URL
-        author_url AUTHOR_URL
         directory Engine.root
 
         requires_redmine version_or_higher: "2.0.0"

data/lib/redmine_mattermost/utils.rb

@@ -0,0 +1,3 @@
+require "redmine_mattermost/utils/text"
+require "redmine_mattermost/utils/urls"
+require "redmine_mattermost/utils/journal_mapper"

data/lib/redmine_mattermost/utils/journal_mapper.rb

@@ -0,0 +1,75 @@
+module RedmineMattermost
+  module Utils
+    class JournalMapper
+      include Text
+      include Urls
+
+      attr_reader :bridge
+
+      def initialize(bridge)
+        @bridge = bridge
+      end
+
+      def to_fields(journal)
+        journal.details.map do |detail|
+          detail_to_field(detail)
+        end
+      end
+
+      private
+
+      def detail_to_field(detail)
+        short = true
+        value = h(detail.value)
+
+        if detail.property == "cf"
+          key   = bridge.find_custom_field(detail.prop_key).name rescue nil
+          title = key
+        elsif detail.property == "attachment"
+          key   = "attachment"
+          title = t("label_attachment")
+        else
+          key   = detail.prop_key.to_s.sub("_id", "")
+          title = t("field_#{key}")
+        end
+
+        case key
+        when "title", "subject", "description"
+          short = false
+        when "tracker"
+          tracker = bridge.find_tracker(detail.value)
+          value   = h tracker.to_s
+        when "project"
+          project = bridge.find_project(detail.value)
+          value   = h project.to_s
+        when "status"
+          status = bridge.find_issue_status(detail.value)
+          value  = h status.to_s
+        when "priority"
+          priority = bridge.find_issue_priority(detail.value)
+          value    = h priority.to_s
+        when "category"
+          category = bridge.find_issue_category(detail.value)
+          value    = h category.to_s
+        when "assigned_to"
+          user  = bridge.find_user(detail.value)
+          value = h user.to_s
+        when "fixed_version"
+          version = bridge.find_version(detail.value)
+          value   = h version.to_s
+        when "attachment"
+          if attachment = bridge.find_attachement(detail.prop_key)
+            value    = "<#{event_url attachment}|#{h attachment.filename}>"
+          end
+        when "parent"
+          issue = bridge.find_issue(detail.value)
+          value = "<#{event_url issue}|#{h issue}>" if issue
+        end
+
+        value = "-" if value.nil? || value.empty?
+
+        [title, value, short]
+      end
+    end
+  end
+end

data/lib/redmine_mattermost/utils/text.rb

@@ -0,0 +1,37 @@
+require "reverse_markdown"
+
+module RedmineMattermost
+  module Utils
+    module Text
+      MARKDOWN_OPTIONS = {
+        unknown_tags: :bypass,
+        github_flavored: true
+      }.freeze
+
+      def h(text)
+        text.to_s.gsub("&", "&amp;").gsub("<", "&lt;").gsub(">", "&gt;") if text
+      end
+
+      def t(key, options = {})
+        opts = {locale: bridge.settings.default_language}.merge(options)
+        bridge.translate(key, opts)
+      end
+
+      def link(label, target)
+        "<#{target}|#{h label}>"
+      end
+
+      def to_markdown(text)
+        case formatting = bridge.settings.text_formatting
+        when "markdown"
+          text
+        else
+          html = bridge.to_html(formatting, text)
+          ReverseMarkdown.convert(html, MARKDOWN_OPTIONS).strip
+        end
+      rescue
+        h text
+      end
+    end
+  end
+end

data/lib/redmine_mattermost/utils/urls.rb

@@ -0,0 +1,20 @@
+module RedmineMattermost
+  module Utils
+    module Urls
+      def default_url_options
+        settings = bridge.settings
+        protocol = settings.protocol
+        if settings.host_name.to_s =~ /\A(https?\:\/\/)?(.+?)(\:(\d+))?(\/.+)?\z/i
+          host, port, prefix = $2, $4, $5
+          { host: host, protocol: protocol, port: port, script_name: prefix }
+        else
+          { host: settings.host_name, protocol: settings.protocol }
+        end
+      end
+
+      def event_url(obj)
+        bridge.url_for(obj.event_url(default_url_options))
+      end
+    end
+  end
+end

data/lib/redmine_mattermost/version.rb

@@ -1,3 +1,3 @@
 module RedmineMattermost
-  VERSION = "0.3"
+  VERSION = "0.4.beta1"
 end

data/redmine-mattermost.gemspec

@@ -19,8 +19,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails", "~> 4.2.0"
-  spec.add_dependency "httpclient", "~> 2.8.2"
+  spec.add_dependency "reverse_markdown", "~> 1.0.3"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.9.0"
+  spec.add_development_dependency "webmock", "~> 2.1.0"
+  spec.add_development_dependency "RedCloth", "~> 4.3.2"
 end

data/spec/client_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe RedmineMattermost::Client do
+  subject   { RedmineMattermost::Client.new(url) }
+  let(:url) { "http://test.host/api/v3" }
+
+  it "use the given url as endpoint" do
+    subject.uri.must_equal URI(url)
+  end
+
+  it "speak the message as payload" do
+    message = {
+      text: "Some message",
+      username: "TestUser"
+    }
+
+    stub_endpoint
+      .with(body: { payload: message.to_json })
+      .to_return(body: "{}")
+
+    subject.speak(message).join
+  end
+
+  private
+
+  def stub_endpoint
+    stub_request(:post, url)
+  end
+end

data/spec/extractors/applied_changeset_spec.rb

@@ -0,0 +1,82 @@
+require "spec_helper"
+
+describe RedmineMattermost::Extractors::AppliedChangeset do
+  subject { RedmineMattermost::Extractors::AppliedChangeset.new(bridge) }
+  let(:result) { subject.from_context(context) }
+  let(:msg)    { result[:message] }
+  let(:context) do
+    { issue: issue, changeset: changeset }
+  end
+  let(:bridge)    { MockBridge.new(settings) }
+  let(:issue)     { MockIssue.new(issue_data) }
+  let(:journal)   { mock(journal_data) }
+  let(:changeset) { mock(changeset_data)}
+  let(:settings) { Defaults.settings }
+
+  let(:issue_data) do
+    {
+      title: "Some title",
+      project: EventMock.new(title: "Project A"),
+      current_journal: journal,
+      valid: true
+    }
+  end
+  let(:journal_data) do
+    {
+      user: "User A",
+      details: [mock(prop_key: "title", value: "Some title")]
+    }
+  end
+  let(:changeset_data) do
+    {
+      repository: mock({
+        project: EventMock.new(title: "Project A"),
+        identifier_param: "repo_1",
+      }),
+      revision: "revision_1"
+    }
+  end
+
+  describe "empty context" do
+    let(:context) { Hash.new }
+
+    it "raises" do
+      proc { result }.must_raise KeyError
+    end
+  end
+
+  describe "no project" do
+    let(:issue_data) do
+      { title: "Some title" }
+    end
+
+    it "returns nil" do
+      result.must_be_nil
+    end
+  end
+
+  describe "invalid issue" do
+    let(:issue_data) do
+      { valid: false }
+    end
+  end
+
+  describe "with changeset" do
+    it "should return a message" do
+      msg[:text].must_equal(
+        "[#{link_for("Project A")}] User A updated #{link_for("Some title")}"
+      )
+      attachments = msg[:attachments]
+      attachments.size.must_equal 1
+      attachment  = attachments.shift
+      text        = attachment[:text]
+      text.must_equal("text_status_changed_by_changeset")
+      fields      = attachment[:fields]
+      fields.size.must_equal 1
+      fields.shift.must_equal({
+        title: "field_title",
+        value: "Some title"
+      })
+    end
+  end
+end

data/spec/extractors/changed_wiki_page_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+describe RedmineMattermost::Extractors::ChangedWikiPage do
+  subject { RedmineMattermost::Extractors::ChangedWikiPage.new(bridge) }
+  let(:result) { subject.from_context(context) }
+  let(:msg)    { result[:message] }
+  let(:context) do
+    { project: project, page: page }
+  end
+  let(:bridge)  { MockBridge.new(settings) }
+  let(:project) { EventMock.new(title: "Project A")}
+  let(:page)    { EventMock.new(page_data)}
+
+  let(:settings) { Defaults.settings }
+  let(:page_data) do
+    {
+      title: "Some title",
+      content: mock({
+        author: mock(title: "User A"),
+        comments: ""
+      })
+    }
+  end
+
+  describe "empty context" do
+    let(:context) { Hash.new }
+
+    it "raises" do
+      proc { result }.must_raise KeyError
+    end
+  end
+
+  describe "minimal page" do
+    it "should return a message" do
+      msg[:text].must_equal(
+        "[#{link_for("Project A")}] User A updated #{link_for("Some title")}"
+      )
+    end
+  end
+
+  describe "full page" do
+    let(:page_data) do
+      {
+        title: "Some title",
+        content: mock({
+          author: mock(title: "User A"),
+          comments: "The comments"
+        })
+      }
+    end
+
+    it "should return a message" do
+      msg[:text].must_equal(
+        "[#{link_for("Project A")}] User A updated #{link_for("Some title")}"
+      )
+      attachments = msg[:attachments]
+      attachments.size.must_equal 1
+      attachment  = attachments.shift
+      text        = attachment[:text]
+      text.must_equal "The comments"
+    end
+  end
+end

data/spec/extractors/new_issue_spec.rb

@@ -0,0 +1,209 @@
+require "spec_helper"
+
+describe RedmineMattermost::Extractors::NewIssue do
+  subject { RedmineMattermost::Extractors::NewIssue.new(bridge) }
+  let(:result) { subject.from_context(context) }
+  let(:msg)    { result[:message] }
+  let(:context) do
+    { issue: issue }
+  end
+  let(:bridge) { MockBridge.new(settings) }
+  let(:settings) { Defaults.settings }
+  let(:issue)  { MockIssue.new(issue_data) }
+  let(:issue_data) { Hash.new }
+
+  describe "empty context" do
+    let(:context) { Hash.new }
+
+    it "raises" do
+      proc { result }.must_raise KeyError
+    end
+  end
+
+  describe "no project" do
+    let(:issue_data) do
+      {
+        title: "Some title"
+      }
+    end
+
+    it "returns nil" do
+      result.must_be_nil
+    end
+  end
+
+  describe "minimal issue" do
+    let(:issue_data) do
+      {
+        title: "Some title",
+        project: EventMock.new(title: "Project A"),
+        author: mock(title: "User A"),
+        watcher_users: [],
+        status: "",
+        priority: "",
+        assigned_to: nil
+      }
+    end
+
+    it "should return a message" do
+      msg[:text].must_equal(
+        "[#{link_for("Project A")}] User A created #{link_for("Some title")}"
+      )
+      attachments = msg[:attachments]
+      attachments.size.must_equal 1
+      attachment  = attachments.shift
+      fields      = attachment[:fields]
+      fields.size.must_equal 3
+      fields.shift.must_equal({
+        title: "field_status",
+        value: "-",
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "field_priority",
+        value: "-",
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "field_assigned_to",
+        value: "-",
+        short: true
+      })
+    end
+  end
+
+  describe "default issue" do
+    let(:issue_data) do
+      {
+        title: "Some title",
+        project: EventMock.new(title: "Project A"),
+        author: mock(title: "User A"),
+        watcher_users: [],
+        status: "New",
+        priority: "Normal",
+        assigned_to: mock(title: "User B")
+      }
+    end
+
+    it "should return a message" do
+      msg[:text].must_equal(
+        "[#{link_for("Project A")}] User A created #{link_for("Some title")}"
+      )
+      attachments = msg[:attachments]
+      attachments.size.must_equal 1
+      attachment  = attachments.shift
+      fields      = attachment[:fields]
+      fields.size.must_equal 3
+      fields.shift.must_equal({
+        title: "field_status",
+        value: "New",
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "field_priority",
+        value: "Normal",
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "field_assigned_to",
+        value: "User B",
+        short: true
+      })
+    end
+  end
+
+  describe "full issue" do
+    let(:issue_data) do
+      {
+        title: "Some title",
+        project: EventMock.new(title: "Project A"),
+        author: mock(title: "User A"),
+        watcher_users: [mock(title: "User C")],
+        status: "New",
+        priority: "Normal",
+        assigned_to: mock(title: "User B"),
+        description: <<TEXTILE
+Some description with @inline@ and
+
+<pre>pre-text
+over multiple lines
+</pre>
+
+<code>
+and code
+</code>
+TEXTILE
+      }
+    end
+
+    it "should return a message" do
+      msg[:text].must_equal(
+        "[#{link_for("Project A")}] User A created #{link_for("Some title")}"
+      )
+      attachments = msg[:attachments]
+      attachments.size.must_equal 1
+      attachment  = attachments.shift
+
+      text = attachment[:text]
+      text.must_equal <<MARKDOWN.strip
+Some description with `inline` and
+
+```
+pre-text
+over multiple lines
+```
+
+`
+and code
+`
+MARKDOWN
+      fields      = attachment[:fields]
+      fields.size.must_equal 4
+      fields.shift.must_equal({
+        title: "field_status",
+        value: "New",
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "field_priority",
+        value: "Normal",
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "field_assigned_to",
+        value: "User B",
+        short: true
+      })
+      fields.shift.must_equal({
+        title: "field_watcher",
+        value: "User C",
+        short: true
+      })
+    end
+  end
+
+  describe "extracts mentions" do
+    let(:issue_data) do
+      {
+        title: "Some title",
+        project: EventMock.new(title: "Project A"),
+        author: mock(title: "User A"),
+        watcher_users: [mock(title: "User C")],
+        status: "New",
+        priority: "Normal",
+        assigned_to: mock(title: "User B"),
+        description: "Some description @foo @NOT @bar"
+      }
+    end
+
+    it "should extract mentions for markdown" do
+      settings.text_formatting = "markdown"
+      msg[:text].must_include("To: @foo, @bar")
+    end
+
+    it "should NOT extract mentions for textile" do
+      settings.text_formatting = "textile"
+      msg[:text].wont_include("To: @foo, @bar")
+    end
+  end
+end