Added comment notification events to HipChat and Slack services.

Supports four different event types all bundled under the "note" event type:

- comments on a commit
- comments on an issue
- comments on a merge request
- comments on a code snippet

CHANGELOG

 Please view this file on the master branch, on stable branches it's out of date.
 v 7.9.0 (unreleased)
-  - Added issue and merge request events to HipChat and Slack service (Stan Hu)
+  - Added comment notification events to HipChat and Slack services (Stan Hu)
+  - Added issue and merge request events to HipChat and Slack services (Stan Hu)
   - Fix merge request URL passed to Webhooks. (Stan Hu)
   - Fix bug that caused a server error when editing a comment to "+1" or "-1" (Stan Hu)
   - Move labels/milestones tabs to sidebar

app/controllers/projects/services_controller.rb

@@ -52,7 +52,8 @@ class Projects::ServicesController < Projects::ApplicationController
       :build_key, :server, :teamcity_url, :build_type,
       :description, :issues_url, :new_issue_url, :restrict_to_branch, :channel,
       :colorize_messages, :channels,
-      :push_events, :issues_events, :merge_requests_events, :tag_push_events
+      :push_events, :issues_events, :merge_requests_events, :tag_push_events,
+      :note_events
     )
   end
 end

app/helpers/gitlab_routing_helper.rb

@@ -44,4 +44,8 @@ module GitlabRoutingHelper
   def merge_request_url(entity, *args)
     namespace_project_merge_request_url(entity.project.namespace, entity.project, entity, *args)
   end
+
+  def snippet_url(entity, *args)
+    namespace_project_snippet_url(entity.project.namespace, entity.project, entity, *args)
+  end
 end

app/models/concerns/mentionable.rb

@@ -99,5 +99,4 @@ module Mentionable
     preexisting = references(p, original)
     create_cross_references!(p, a, preexisting)
   end
-
 end

app/models/note.rb

@@ -308,6 +308,10 @@ class Note < ActiveRecord::Base
     end
   end
+  def hook_attrs
+    attributes
+  end
+
   def set_diff
     # First lets find notes with same diff
     # before iterating over all mr diffs
@@ -466,6 +470,10 @@ class Note < ActiveRecord::Base
     for_merge_request? && for_diff_line?
   end
+  def for_project_snippet?
+    noteable_type == "Snippet"
+  end
+
   # override to return commits, which are not active record
   def noteable
     if for_commit?

app/models/project_services/asana_service.rb

@@ -15,8 +15,8 @@
 #  issues_events         :boolean          default(TRUE)
 #  merge_requests_events :boolean          default(TRUE)
 #  tag_push_events       :boolean          default(TRUE)
+#  note_events           :boolean          default(TRUE), not null
 #
-
 require 'asana'
 class AsanaService < Service

app/models/project_services/assembla_service.rb

@@ -15,6 +15,7 @@
 #  issues_events         :boolean          default(TRUE)
 #  merge_requests_events :boolean          default(TRUE)
 #  tag_push_events       :boolean          default(TRUE)
+#  note_events           :boolean          default(TRUE), not null
 #
 class AssemblaService < Service

app/models/project_services/bamboo_service.rb

@@ -15,6 +15,7 @@
 #  issues_events         :boolean          default(TRUE)
 #  merge_requests_events :boolean          default(TRUE)
 #  tag_push_events       :boolean          default(TRUE)
+#  note_events           :boolean          default(TRUE), not null
 #
 class BambooService < CiService

app/models/project_services/buildbox_service.rb

@@ -15,6 +15,7 @@
 #  issues_events         :boolean          default(TRUE)
 #  merge_requests_events :boolean          default(TRUE)
 #  tag_push_events       :boolean          default(TRUE)
+#  note_events           :boolean          default(TRUE), not null
 #
 require "addressable/uri"

app/models/project_services/campfire_service.rb

@@ -15,6 +15,7 @@
 #  issues_events         :boolean          default(TRUE)
 #  merge_requests_events :boolean          default(TRUE)
 #  tag_push_events       :boolean          default(TRUE)
+#  note_events           :boolean          default(TRUE), not null
 #
 class CampfireService < Service

app/models/project_services/gitlab_issue_tracker_service.rb

@@ -15,6 +15,7 @@
 #  issues_events         :boolean          default(TRUE)
 #  merge_requests_events :boolean          default(TRUE)
 #  tag_push_events       :boolean          default(TRUE)
+#  note_events           :boolean          default(TRUE), not null
 #
 class GitlabIssueTrackerService < IssueTrackerService

app/models/project_services/hipchat_service.rb

@@ -45,7 +45,7 @@ class HipchatService < Service
   end
   def supported_events
-    %w(push issue merge_request)
+    %w(push issue merge_request note)
   end
   def execute(data)
@@ -73,6 +73,8 @@ class HipchatService < Service
         create_issue_message(data) unless is_update?(data)
       when "merge_request"
         create_merge_request_message(data) unless is_update?(data)
+      when "note"
+        create_note_message(data)
       end
   end
@@ -108,6 +110,14 @@ class HipchatService < Service
     message
   end
+  def format_body(body)
+    if body
+      body = body.truncate(200, separator: ' ', omission: '...')
+    end
+
+    "<pre>#{body}</pre>"
+  end
+
   def create_issue_message(data)
     username = data[:user][:username]
@@ -123,8 +133,8 @@ class HipchatService < Service
     message = "#{username} #{state} issue #{issue_link} in #{project_link}: <b>#{title}</b>"
     if description
-      description = description.truncate(200, separator: ' ', omission: '...')
-      message << "<pre>#{description}</pre>"
+      description = format_body(description)
+      message << description
     end
     message
@@ -148,8 +158,62 @@ class HipchatService < Service
       "#{project_link}: <b>#{title}</b>"
     if description
-      description = description.truncate(200, separator: ' ', omission: '...')
-      message << "<pre>#{description}</pre>"
+      description = format_body(description)
+      message << description
+    end
+
+    message
+  end
+
+  def format_title(title)
+    "<b>" + title.lines.first.chomp + "</b>"
+  end
+
+  def create_note_message(data)
+    data = HashWithIndifferentAccess.new(data)
+    username = data[:user][:username]
+
+    repo_attr = HashWithIndifferentAccess.new(data[:repository])
+
+    obj_attr = HashWithIndifferentAccess.new(data[:object_attributes])
+    note = obj_attr[:note]
+    note_url = obj_attr[:url]
+    noteable_type = obj_attr[:noteable_type]
+
+    case noteable_type
+    when "Commit"
+      commit_attr = HashWithIndifferentAccess.new(data[:commit])
+      subject_desc = commit_attr[:id]
+      subject_desc = Commit.truncate_sha(subject_desc)
+      subject_type = "commit"
+      title = format_title(commit_attr[:message])
+    when "Issue"
+      subj_attr = HashWithIndifferentAccess.new(data[:issue])
+      subject_id = subj_attr[:iid]
+      subject_desc = "##{subject_id}"
+      subject_type = "issue"
+      title = format_title(subj_attr[:title])
+    when "MergeRequest"
+      subj_attr = HashWithIndifferentAccess.new(data[:merge_request])
+      subject_id = subj_attr[:iid]
+      subject_desc = "##{subject_id}"
+      subject_type = "merge request"
+      title = format_title(subj_attr[:title])
+    when "Snippet"
+      subj_attr = HashWithIndifferentAccess.new(data[:snippet])
+      subject_id = subj_attr[:id]
+      subject_desc = "##{subject_id}"
+      subject_type = "snippet"
+      title = format_title(subj_attr[:title])
+    end
+
+    subject_html = "<a href=\"#{note_url}\">#{subject_type} #{subject_desc}</a>"
+    message = "#{username} commented on #{subject_html} in #{project_link}: "
+    message << title
+
+    if note
+      note = format_body(note)
+      message << note
     end
     message

app/models/project_services/issue_tracker_service.rb

@@ -15,6 +15,7 @@
 #  issues_events         :boolean          default(TRUE)
 #  merge_requests_events :boolean          default(TRUE)
 #  tag_push_events       :boolean          default(TRUE)
+#  note_events           :boolean          default(TRUE), not null
 #
 class IssueTrackerService < Service

app/models/project_services/jira_service.rb

@@ -15,6 +15,7 @@
 #  issues_events         :boolean          default(TRUE)
 #  merge_requests_events :boolean          default(TRUE)
 #  tag_push_events       :boolean          default(TRUE)
+#  note_events           :boolean          default(TRUE), not null
 #
 class JiraService < IssueTrackerService

app/models/project_services/pivotaltracker_service.rb

@@ -15,6 +15,7 @@
 #  issues_events         :boolean          default(TRUE)
 #  merge_requests_events :boolean          default(TRUE)
 #  tag_push_events       :boolean          default(TRUE)
+#  note_events           :boolean          default(TRUE), not null
 #
 class PivotaltrackerService < Service

app/models/project_services/pushover_service.rb

@@ -15,6 +15,7 @@
 #  issues_events         :boolean          default(TRUE)
 #  merge_requests_events :boolean          default(TRUE)
 #  tag_push_events       :boolean          default(TRUE)
+#  note_events           :boolean          default(TRUE), not null
 #
 class PushoverService < Service

app/models/project_services/redmine_service.rb

@@ -15,6 +15,7 @@
 #  issues_events         :boolean          default(TRUE)
 #  merge_requests_events :boolean          default(TRUE)
 #  tag_push_events       :boolean          default(TRUE)
+#  note_events           :boolean          default(TRUE), not null
 #
 class RedmineService < IssueTrackerService

app/models/project_services/slack_service.rb

@@ -15,6 +15,7 @@
 #  issues_events         :boolean          default(TRUE)
 #  merge_requests_events :boolean          default(TRUE)
 #  tag_push_events       :boolean          default(TRUE)
+#  note_events           :boolean          default(TRUE), not null
 #
 class SlackService < Service
@@ -43,7 +44,7 @@ class SlackService < Service
   end
   def supported_events
-    %w(push issue merge_request)
+    %w(push issue merge_request note)
   end
   def execute(data)
@@ -69,6 +70,8 @@ class SlackService < Service
         IssueMessage.new(data) unless is_update?(data)
       when "merge_request"
         MergeMessage.new(data) unless is_update?(data)
+      when "note"
+        NoteMessage.new(data)
       end
     opt = {}
@@ -99,3 +102,4 @@ end
 require "slack_service/issue_message"
 require "slack_service/push_message"
 require "slack_service/merge_message"
+require "slack_service/note_message"

app/models/project_services/slack_service/note_message.rb

+class SlackService
+  class NoteMessage < BaseMessage
+    attr_reader :message
+    attr_reader :username
+    attr_reader :project_name
+    attr_reader :project_link
+    attr_reader :note
+    attr_reader :note_url
+    attr_reader :title
+
+    def initialize(params)
+      params = HashWithIndifferentAccess.new(params)
+      @username = params[:user][:username]
+      @project_name = params[:project_name]
+      @project_url = params[:project_url]
+
+      obj_attr = params[:object_attributes]
+      obj_attr = HashWithIndifferentAccess.new(obj_attr)
+      @note = obj_attr[:note]
+      @note_url = obj_attr[:url]
+      noteable_type = obj_attr[:noteable_type]
+
+      case noteable_type
+      when "Commit"
+        create_commit_note(HashWithIndifferentAccess.new(params[:commit]))
+      when "Issue"
+        create_issue_note(HashWithIndifferentAccess.new(params[:issue]))
+      when "MergeRequest"
+        create_merge_note(HashWithIndifferentAccess.new(params[:merge_request]))
+      when "Snippet"
+        create_snippet_note(HashWithIndifferentAccess.new(params[:snippet]))
+      end
+    end
+
+    def attachments
+      description_message
+    end
+
+    private
+
+    def format_title(title)
+      title.lines.first.chomp
+    end
+
+    def create_commit_note(commit)
+      commit_sha = commit[:id]
+      commit_sha = Commit.truncate_sha(commit_sha)
+      commit_link = "[commit #{commit_sha}](#{@note_url})"
+      title = format_title(commit[:message])
+      @message = "#{@username} commented on #{commit_link} in #{project_link}: *#{title}*"
+    end
+
+    def create_issue_note(issue)
+      issue_iid = issue[:iid]
+      note_link = "[issue ##{issue_iid}](#{@note_url})"
+      title = format_title(issue[:title])
+      @message = "#{@username} commented on #{note_link} in #{project_link}: *#{title}*"
+    end
+
+    def create_merge_note(merge_request)
+      merge_request_id = merge_request[:iid]
+      merge_request_link = "[merge request ##{merge_request_id}](#{@note_url})"
+      title = format_title(merge_request[:title])
+      @message = "#{@username} commented on #{merge_request_link} in #{project_link}: *#{title}*"
+    end
+
+    def create_snippet_note(snippet)
+      snippet_id = snippet[:id]
+      snippet_link = "[snippet ##{snippet_id}](#{@note_url})"
+      title = format_title(snippet[:title])
+      @message = "#{@username} commented on #{snippet_link} in #{project_link}: *#{title}*"
+    end
+
+    def description_message
+      [{ text: format(@note), color: attachment_color }]
+    end
+
+    def project_link
+      "[#{@project_name}](#{@project_url})"
+    end
+  end
+end

app/models/project_services/teamcity_service.rb

@@ -15,6 +15,7 @@
 #  issues_events         :boolean          default(TRUE)
 #  merge_requests_events :boolean          default(TRUE)
 #  tag_push_events       :boolean          default(TRUE)
+#  note_events           :boolean          default(TRUE), not null
 #
 class TeamcityService < CiService