redmine-mattermost 0.3 → 0.4.beta1

data/lib/redmine_mattermost/extractors/applied_changeset.rb

@@ -0,0 +1,55 @@
+module RedmineMattermost
+  module Extractors
+    class AppliedChangeset < Base
+      MESSAGE = "[%{project_link}] %{editor} updated %{object_link}"
+      REVISION_LINK = "<%{url}|%{title}>"
+
+      def from_context(context)
+        issue     = context.fetch(:issue)
+        changeset = context.fetch(:changeset)
+        journal   = issue.current_journal
+
+        return if issue.is_private?
+        return unless issue.valid?
+        return unless channel = determine_channel(issue.project)
+        return unless url = determine_url(issue.project)
+
+        args = {
+          project_link: link(issue.project, event_url(issue.project)),
+          editor: h(journal.user),
+          object_link: link(issue, event_url(issue))
+        }
+
+        msg = MessageBuilder.new(MESSAGE % args)
+        msg.channel(channel)
+        msg.icon(determine_icon(issue.project))
+        msg.username(determine_username(issue.project))
+        attachment = msg.attachment
+        attachment.text(t("text_status_changed_by_changeset", value: revision_link(changeset)))
+        mapper = Utils::JournalMapper.new(bridge)
+        mapper.to_fields(journal).map do |field|
+          attachment.field(*field)
+        end
+
+        { url: url, message: msg.to_hash }
+      end
+
+      private
+
+      def revision_link(changeset)
+        repository = changeset.repository
+        options = default_url_options.merge(
+          controller: "repositories",
+          action: "revision",
+          id: repository.project,
+          repository_id: repository.identifier_param,
+          rev: changeset.revision
+        )
+        REVISION_LINK % {
+          url: bridge.url_for(options),
+          title: h(changeset.comments)
+        }
+      end
+    end
+  end
+end

data/lib/redmine_mattermost/extractors/changed_wiki_page.rb

@@ -0,0 +1,39 @@
+module RedmineMattermost
+  module Extractors
+    class ChangedWikiPage < Base
+      MESSAGE = "[%{project_link}] %{editor} updated %{object_link}"
+
+      def from_context(context)
+        page    = context.fetch(:page)
+        project = context.fetch(:project)
+
+        return unless notify?
+        return unless channel = determine_channel(project)
+        return unless url = determine_url(project)
+
+        args = {
+          project_link: link(project, event_url(project)),
+          editor: h(page.content.author),
+          object_link: link(page.title, event_url(page)),
+        }
+
+        msg = MessageBuilder.new(MESSAGE % args)
+        msg.channel(channel)
+        msg.icon(determine_icon(project))
+        msg.username(determine_username(project))
+        unless page.content.comments.empty?
+          attachment = msg.attachment
+          attachment.text(h page.content.comments)
+        end
+
+        { url: url, message: msg.to_hash }
+      end
+
+      private
+
+      def notify?
+        settings.plugin_redmine_mattermost[:post_wiki_updates] == "1"
+      end
+    end
+  end
+end

data/lib/redmine_mattermost/extractors/new_issue.rb

@@ -0,0 +1,44 @@
+module RedmineMattermost
+  module Extractors
+    class NewIssue < Base
+      MESSAGE = "[%{project_link}] %{author} created %{object_link}%{mentions}"
+
+      def from_context(context)
+        issue = context.fetch(:issue)
+        return if issue.is_private?
+        return unless channel = determine_channel(issue.project)
+        return unless url = determine_url(issue.project)
+
+        args = {
+          project_link: link(issue.project, event_url(issue.project)),
+          author: h(issue.author),
+          object_link: link(issue, event_url(issue)),
+          mentions: extract_mentions(issue.description)
+        }
+
+        msg = MessageBuilder.new(MESSAGE % args)
+        msg.channel(channel)
+        msg.icon(determine_icon(issue.project))
+        msg.username(determine_username(issue.project))
+        attachment = msg.attachment
+        attachment.text(to_markdown issue.description) if issue.description
+        add_field(attachment, "field_status", issue.status)
+        add_field(attachment, "field_priority", issue.priority)
+        add_field(attachment, "field_assigned_to", issue.assigned_to)
+
+        if show_watchers? && !issue.watcher_users.empty?
+          add_field(attachment, "field_watcher", issue.watcher_users.join(", "))
+        end
+
+        { url: url, message: msg.to_hash }
+      end
+
+      private
+
+      def add_field(attachment, key, value)
+        value = "-" if value.nil? || value.to_s.empty?
+        attachment.field(t(key), h(value), true)
+      end
+    end
+  end
+end

data/lib/redmine_mattermost/extractors/updated_issue.rb

@@ -0,0 +1,42 @@
+module RedmineMattermost
+  module Extractors
+    class UpdatedIssue < Base
+      MESSAGE = "[%{project_link}] %{editor} updated %{object_link}%{mentions}"
+
+      def from_context(context)
+        issue   = context.fetch(:issue)
+        journal = context.fetch(:journal)
+        return unless notify?
+        return if issue.is_private?
+        return unless channel = determine_channel(issue.project)
+        return unless url = determine_url(issue.project)
+
+        args = {
+          project_link: link(issue.project, event_url(issue.project)),
+          editor: h(journal.user),
+          object_link: link(issue, event_url(issue)),
+          mentions: extract_mentions(journal.notes)
+        }
+
+        msg = MessageBuilder.new(MESSAGE % args)
+        msg.channel(channel)
+        msg.icon(determine_icon(issue.project))
+        msg.username(determine_username(issue.project))
+        attachment = msg.attachment
+        attachment.text(to_markdown journal.notes) if journal.notes
+        mapper = Utils::JournalMapper.new(bridge)
+        mapper.to_fields(journal).map do |field|
+          attachment.field(*field)
+        end
+
+        { url: url, message: msg.to_hash }
+      end
+
+      private
+
+      def notify?
+        settings.plugin_redmine_mattermost[:post_updates] == "1"
+      end
+    end
+  end
+end

data/lib/redmine_mattermost/infos.rb

@@ -4,7 +4,6 @@ module RedmineMattermost
     DESCRIPTION = "Mattermost chat integration"
     LICENSE     = "MIT"
     URL         = "https://github.com/neopoly/redmine-mattermost"
-    AUTHORS     = ["AltSol"]
-    AUTHOR_URL  = "http://altsol.gr"
+    AUTHORS     = ["AltSol", "Jonas Thiel"]
   end
 end

data/lib/redmine_mattermost/issue_patch.rb

@@ -1,33 +1,33 @@
 module RedmineMattermost
   module IssuePatch
-    def self.included(base) # :nodoc:
-      base.extend(ClassMethods)
+    def self.included(base)
       base.send(:include, InstanceMethods)
 
       base.class_eval do
-        unloadable # Send unloadable so it will not be unloaded in development
+        unloadable
         after_create :create_from_issue
         after_save :save_from_issue
       end
     end
-    
-    module ClassMethods
-    end
-    
+
     module InstanceMethods
       def create_from_issue
         @create_already_fired = true
-        Redmine::Hook.call_hook(:redmine_mattermost_issues_new_after_save, { :issue => self})
-        return true
+        Redmine::Hook.call_hook(:redmine_mattermost_issues_new_after_save, {
+          issue: self
+        })
+        true
       end
 
       def save_from_issue
-        if not @create_already_fired
-          Redmine::Hook.call_hook(:redmine_mattermost_issues_edit_after_save, { :issue => self, :journal => self.current_journal}) unless self.current_journal.nil?
+        unless @create_already_fired || current_journal.nil?
+          Redmine::Hook.call_hook(:redmine_mattermost_issues_edit_after_save, {
+            issue: self,
+            journal: self.current_journal
+          })
         end
-        return true
+        true
       end
-
-    end    
+    end
   end
 end

data/lib/redmine_mattermost/listener.rb

@@ -1,269 +1,39 @@
-require 'httpclient'
-
-class MattermostListener < Redmine::Hook::Listener
-	def redmine_mattermost_issues_new_after_save(context={})
-		issue = context[:issue]
-
-		channel = channel_for_project issue.project
-		url = url_for_project issue.project
-
-		return unless channel and url
-		return if issue.is_private?
-
-		msg = "[#{escape issue.project}] #{escape issue.author} created <#{object_url issue}|#{escape issue}>#{mentions issue.description}"
-
-		attachment = {}
-		attachment[:text] = escape issue.description if issue.description
-		attachment[:fields] = [{
-			:title => I18n.t("field_status"),
-			:value => escape(issue.status.to_s),
-			:short => true
-		}, {
-			:title => I18n.t("field_priority"),
-			:value => escape(issue.priority.to_s),
-			:short => true
-		}, {
-			:title => I18n.t("field_assigned_to"),
-			:value => escape(issue.assigned_to.to_s),
-			:short => true
-		}]
-
-		attachment[:fields] << {
-			:title => I18n.t("field_watcher"),
-			:value => escape(issue.watcher_users.join(', ')),
-			:short => true
-		} if Setting.plugin_redmine_mattermost[:display_watchers] == 'yes'
-
-		speak msg, channel, attachment, url
-	end
-
-	def redmine_mattermost_issues_edit_after_save(context={})
-		issue = context[:issue]
-		journal = context[:journal]
-
-		channel = channel_for_project issue.project
-		url = url_for_project issue.project
-
-		return unless channel and url and Setting.plugin_redmine_mattermost[:post_updates] == '1'
-		return if issue.is_private?
-
-		msg = "[#{escape issue.project}] #{escape journal.user.to_s} updated <#{object_url issue}|#{escape issue}>#{mentions journal.notes}"
-
-		attachment = {}
-		attachment[:text] = escape journal.notes if journal.notes
-		attachment[:fields] = journal.details.map { |d| detail_to_field d }
-
-		speak msg, channel, attachment, url
-	end
-
-	def model_changeset_scan_commit_for_issue_ids_pre_issue_update(context={})
-		issue = context[:issue]
-		journal = issue.current_journal
-		changeset = context[:changeset]
-
-		channel = channel_for_project issue.project
-		url = url_for_project issue.project
-
-		return unless channel and url and issue.save
-		return if issue.is_private?
-
-		msg = "[#{escape issue.project}] #{escape journal.user.to_s} updated <#{object_url issue}|#{escape issue}>"
-
-		repository = changeset.repository
-
-		if Setting.host_name.to_s =~ /\A(https?\:\/\/)?(.+?)(\:(\d+))?(\/.+)?\z/i
-			host, port, prefix = $2, $4, $5
-			revision_url = Rails.application.routes.url_for(
-				:controller => 'repositories',
-				:action => 'revision',
-				:id => repository.project,
-				:repository_id => repository.identifier_param,
-				:rev => changeset.revision,
-				:host => host,
-				:protocol => Setting.protocol,
-				:port => port,
-				:script_name => prefix
-			)
-		else
-			revision_url = Rails.application.routes.url_for(
-				:controller => 'repositories',
-				:action => 'revision',
-				:id => repository.project,
-				:repository_id => repository.identifier_param,
-				:rev => changeset.revision,
-				:host => Setting.host_name,
-				:protocol => Setting.protocol
-			)
-		end
-
-		attachment = {}
-		attachment[:text] = ll(Setting.default_language, :text_status_changed_by_changeset, "<#{revision_url}|#{escape changeset.comments}>")
-		attachment[:fields] = journal.details.map { |d| detail_to_field d }
-
-		speak msg, channel, attachment, url
-	end
-
-	def controller_wiki_edit_after_save(context = { })
-		return unless Setting.plugin_redmine_mattermost[:post_wiki_updates] == '1'
-
-		project = context[:project]
-		page = context[:page]
-
-		user = page.content.author
-		project_url = "<#{object_url project}|#{escape project}>"
-		page_url = "<#{object_url page}|#{page.title}>"
-		comment = "[#{project_url}] #{page_url} updated by *#{user}*"
-
-		channel = channel_for_project project
-		url = url_for_project project
-
-		attachment = nil
-		if not page.content.comments.empty?
-			attachment = {}
-			attachment[:text] = "#{escape page.content.comments}"
-		end
-
-		speak comment, channel, attachment, url
-	end
-
-	def speak(msg, channel, attachment=nil, url=nil)
-		url = Setting.plugin_redmine_mattermost[:mattermost_url] if not url
-		username = Setting.plugin_redmine_mattermost[:username]
-		icon = Setting.plugin_redmine_mattermost[:icon]
-
-		params = {
-			:text => msg,
-			:link_names => 1,
-		}
-
-		params[:username] = username if username
-		params[:channel] = channel if channel
-
-		params[:attachments] = [attachment] if attachment
-
-		if icon and not icon.empty?
-			if icon.start_with? ':'
-				params[:icon_emoji] = icon
-			else
-				params[:icon_url] = icon
-			end
-		end
-
-		begin
-			client = HTTPClient.new
-			client.ssl_config.cert_store.set_default_paths
-			client.ssl_config.ssl_version = "SSLv23"
-			client.post_async url, {:payload => params.to_json}
-		rescue
-			# Bury exception if connection error
-		end
-	end
-
-private
-	def escape(msg)
-		msg.to_s.gsub("&", "&amp;").gsub("<", "&lt;").gsub(">", "&gt;")
-	end
-
-	def object_url(obj)
-		if Setting.host_name.to_s =~ /\A(https?\:\/\/)?(.+?)(\:(\d+))?(\/.+)?\z/i
-			host, port, prefix = $2, $4, $5
-			Rails.application.routes.url_for(obj.event_url({:host => host, :protocol => Setting.protocol, :port => port, :script_name => prefix}))
-		else
-			Rails.application.routes.url_for(obj.event_url({:host => Setting.host_name, :protocol => Setting.protocol}))
-		end
-	end
-
-	def url_for_project(proj)
-		return nil if proj.blank?
-
-		cf = ProjectCustomField.find_by_name("Mattermost URL")
-
-		return [
-			(proj.custom_value_for(cf).value rescue nil),
-			(url_for_project proj.parent),
-			Setting.plugin_redmine_mattermost[:mattermost_url],
-		].find{|v| v.present?}
-	end
-
-	def channel_for_project(proj)
-		return nil if proj.blank?
-
-		cf = ProjectCustomField.find_by_name("Mattermost Channel")
-
-		val = [
-			(proj.custom_value_for(cf).value rescue nil),
-			(channel_for_project proj.parent),
-			Setting.plugin_redmine_mattermost[:channel],
-		].find{|v| v.present?}
-
-		# Channel name '-' is reserved for NOT notifying
-		return nil if val.to_s == '-'
-		val
-	end
-
-	def detail_to_field(detail)
-		if detail.property == "cf"
-			key = CustomField.find(detail.prop_key).name rescue nil
-			title = key
-		elsif detail.property == "attachment"
-			key = "attachment"
-			title = I18n.t :label_attachment
-		else
-			key = detail.prop_key.to_s.sub("_id", "")
-			title = I18n.t "field_#{key}"
-		end
-
-		short = true
-		value = escape detail.value.to_s
-
-		case key
-		when "title", "subject", "description"
-			short = false
-		when "tracker"
-			tracker = Tracker.find(detail.value) rescue nil
-			value = escape tracker.to_s
-		when "project"
-			project = Project.find(detail.value) rescue nil
-			value = escape project.to_s
-		when "status"
-			status = IssueStatus.find(detail.value) rescue nil
-			value = escape status.to_s
-		when "priority"
-			priority = IssuePriority.find(detail.value) rescue nil
-			value = escape priority.to_s
-		when "category"
-			category = IssueCategory.find(detail.value) rescue nil
-			value = escape category.to_s
-		when "assigned_to"
-			user = User.find(detail.value) rescue nil
-			value = escape user.to_s
-		when "fixed_version"
-			version = Version.find(detail.value) rescue nil
-			value = escape version.to_s
-		when "attachment"
-			attachment = Attachment.find(detail.prop_key) rescue nil
-			value = "<#{object_url attachment}|#{escape attachment.filename}>" if attachment
-		when "parent"
-			issue = Issue.find(detail.value) rescue nil
-			value = "<#{object_url issue}|#{escape issue}>" if issue
-		end
-
-		value = "-" if value.empty?
-
-		result = { :title => title, :value => value }
-		result[:short] = true if short
-		result
-	end
-
-	def mentions text
-		return nil if text.nil?
-		names = extract_usernames text
-		names.present? ? "\nTo: " + names.join(', ') : nil
-	end
-
-	def extract_usernames text = ''
-		# mattermost usernames may only contain lowercase letters, numbers,
-		# dashes and underscores and must start with a letter or number.
-		text.scan(/@[a-z0-9][a-z0-9_\-]*/).uniq
-	end
+module RedmineMattermost
+  class MattermostListener < Redmine::Hook::Listener
+    def initialize
+      @bridge = Bridge.new
+    end
+
+    def redmine_mattermost_issues_new_after_save(context)
+      process Extractors::NewIssue, context
+    end
+
+    def redmine_mattermost_issues_edit_after_save(context)
+      process Extractors::UpdatedIssue, context
+    end
+
+    def model_changeset_scan_commit_for_issue_ids_pre_issue_update(context)
+      process Extractors::AppliedChangeset, context
+    end
+
+    def controller_wiki_edit_after_save(context)
+      process Extractors::ChangedWikiPage, context
+    end
+
+    private
+
+    def process(extractor_class, context)
+      notify(extractor_class.new(@bridge).from_context(context))
+    end
+
+    def notify(options)
+      return unless options
+      url     = options.fetch(:url)
+      message = options.fetch(:message)
+
+      Client.new(url).speak(message)
+    rescue
+      # Bury exception for connection errors or other types
+    end
+  end
 end