Merge branch 'cleaner-email-headers' into 'master'

Cleaner headers in Notification Emails Make the informations available in the notification email headers (sender, recipient, subject, etc.) more readable and meaningful. * Remove the email subject prefix * Don't write the project namespace in email subjects * Write the issue/merge request title in the notification email subject * Make the email appear as sent from the action author (the actual email address is still `gitlab@gitlab.com`) For instance, this is the notification email for a new issue comment before: > From: gitlab@gitlab.com > To: myemailaddress@gmail.com > Subject: GitLab | GitLab HQ / GitLab-Shell | New note for issue #1234 And after : > From: Nick Brown <gitlab@gitlab.com> > To: myemailaddress@gmail.com > Subject: GitLab-Shell | Add local update hook (#1234) The recipient of the notification can easily get the gist of the message without even opening it — just by looking at how it appears in her inbox. None of the actual email addresses (From, To, Reply-to) changes, just the display name. Having a consistent subject for all notification emails sent about some resource also allow good email clients to group the discussion by thread (although grouping in Mail.app still needs some work).

Merge branch 'cleaner-email-headers' into 'master'
Cleaner headers in Notification Emails Make the informations available in the notification email headers (sender, recipient, subject, etc.) more readable and meaningful. * Remove the email subject prefix * Don't write the project namespace in email subjects * Write the issue/merge request title in the notification email subject * Make the email appear as sent from the action author (the actual email address is still `gitlab@gitlab.com`) For instance, this is the notification email for a new issue comment before: > From: gitlab@gitlab.com > To: myemailaddress@gmail.com > Subject: GitLab | GitLab HQ / GitLab-Shell | New note for issue #1234 And after : > From: Nick Brown <gitlab@gitlab.com> > To: myemailaddress@gmail.com > Subject: GitLab-Shell | Add local update hook (#1234) The recipient of the notification can easily get the gist of the message without even opening it — just by looking at how it appears in her inbox. None of the actual email addresses (From, To, Reply-to) changes, just the display name. Having a consistent subject for all notification emails sent about some resource also allow good email clients to group the discussion by thread (although grouping in Mail.app still needs some work).
Dmitriy Zaporozhets
2 parents 75eed4eb 96dded3e
Showing 9 changed files with 149 additions and 52 deletions Show diff stats
app/mailers/emails/issues.rb
app/mailers/emails/merge_requests.rb
app/mailers/emails/notes.rb
app/mailers/emails/projects.rb
app/mailers/notify.rb
app/services/notification_service.rb
config/initializers/devise.rb
spec/mailers/notify_spec.rb
spec/services/notification_service_spec.rb
@@ -3,22 +3,27 @@ module Emails
     def new_issue_email(recipient_id, issue_id)
       @issue = Issue.find(issue_id)
       @project = @issue.project
-      mail(to: recipient(recipient_id), subject: subject("New issue ##{@issue.iid}", @issue.title))
+      mail(from: sender(@issue.author_id),
+           to: recipient(recipient_id),
+           subject: subject("#{@issue.title} (##{@issue.iid})"))
     end
  
-    def reassigned_issue_email(recipient_id, issue_id, previous_assignee_id)
+    def reassigned_issue_email(recipient_id, issue_id, previous_assignee_id, updated_by_user_id)
       @issue = Issue.find(issue_id)
       @previous_assignee = User.find_by(id: previous_assignee_id) if previous_assignee_id
       @project = @issue.project
-      mail(to: recipient(recipient_id), subject: subject("Changed issue ##{@issue.iid}", @issue.title))
+      mail(from: sender(updated_by_user_id),
+           to: recipient(recipient_id),
+           subject: subject("#{@issue.title} (##{@issue.iid})"))
     end
  
     def closed_issue_email(recipient_id, issue_id, updated_by_user_id)
       @issue = Issue.find issue_id
       @project = @issue.project
       @updated_by = User.find updated_by_user_id
-      mail(to: recipient(recipient_id),
-           subject: subject("Closed issue ##{@issue.iid}", @issue.title))
+      mail(from: sender(updated_by_user_id),
+           to: recipient(recipient_id),
+           subject: subject("#{@issue.title} (##{@issue.iid})"))
     end
  
     def issue_status_changed_email(recipient_id, issue_id, status, updated_by_user_id)
@@ -26,8 +31,9 @@ module Emails
       @issue_status = status
       @project = @issue.project
       @updated_by = User.find updated_by_user_id
-      mail(to: recipient(recipient_id),
-           subject: subject("Changed issue ##{@issue.iid}", @issue.title))
+      mail(from: sender(updated_by_user_id),
+           to: recipient(recipient_id),
+           subject: subject("#{@issue.title} (##{@issue.iid})"))
     end
   end
 end
@@ -3,27 +3,35 @@ module Emails
     def new_merge_request_email(recipient_id, merge_request_id)
       @merge_request = MergeRequest.find(merge_request_id)
       @project = @merge_request.project
-      mail(to: recipient(recipient_id), subject: subject("New merge request ##{@merge_request.iid}", @merge_request.title))
+      mail(from: sender(@merge_request.author_id),
+           to: recipient(recipient_id),
+           subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
     end
  
-    def reassigned_merge_request_email(recipient_id, merge_request_id, previous_assignee_id)
+    def reassigned_merge_request_email(recipient_id, merge_request_id, previous_assignee_id, updated_by_user_id)
       @merge_request = MergeRequest.find(merge_request_id)
       @previous_assignee = User.find_by(id: previous_assignee_id) if previous_assignee_id
       @project = @merge_request.project
-      mail(to: recipient(recipient_id), subject: subject("Changed merge request ##{@merge_request.iid}", @merge_request.title))
+      mail(from: sender(updated_by_user_id),
+           to: recipient(recipient_id),
+           subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
     end
  
     def closed_merge_request_email(recipient_id, merge_request_id, updated_by_user_id)
       @merge_request = MergeRequest.find(merge_request_id)
       @updated_by = User.find updated_by_user_id
       @project = @merge_request.project
-      mail(to: recipient(recipient_id), subject: subject("Closed merge request ##{@merge_request.iid}", @merge_request.title))
+      mail(from: sender(updated_by_user_id),
+           to: recipient(recipient_id),
+           subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
     end
  
     def merged_merge_request_email(recipient_id, merge_request_id)
       @merge_request = MergeRequest.find(merge_request_id)
       @project = @merge_request.project
-      mail(to: recipient(recipient_id), subject: subject("Accepted merge request ##{@merge_request.iid}", @merge_request.title))
+      mail(from: sender(@merge_request.author_id_of_changes),
+           to: recipient(recipient_id),
+           subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
     end
   end
  
@@ -57,7 +65,7 @@ module Emails
   #   >> subject('Lorem ipsum', 'Dolor sit amet')
   #   => "GitLab Merge Request | Lorem ipsum | Dolor sit amet"
   def subject(*extra)
-    subject = "GitLab Merge Request |"
+    subject = "Merge Request | "
     if @merge_request.for_fork?
       subject << "#{@merge_request.source_project.name_with_namespace}:#{merge_request.source_branch} >> #{@merge_request.target_project.name_with_namespace}:#{merge_request.target_branch}"
     else
@@ -4,27 +4,35 @@ module Emails
       @note = Note.find(note_id)
       @commit = @note.noteable
       @project = @note.project
-      mail(to: recipient(recipient_id), subject: subject("Note for commit #{@commit.short_id}", @commit.title))
+      mail(from: sender(@note.author_id),
+           to: recipient(recipient_id),
+           subject: subject("#{@commit.title} (#{@commit.short_id})"))
     end
  
     def note_issue_email(recipient_id, note_id)
       @note = Note.find(note_id)
       @issue = @note.noteable
       @project = @note.project
-      mail(to: recipient(recipient_id), subject: subject("Note for issue ##{@issue.iid}"))
+      mail(from: sender(@note.author_id),
+           to: recipient(recipient_id),
+           subject: subject("#{@issue.title} (##{@issue.iid})"))
     end
  
     def note_merge_request_email(recipient_id, note_id)
       @note = Note.find(note_id)
       @merge_request = @note.noteable
       @project = @note.project
-      mail(to: recipient(recipient_id), subject: subject("Note for merge request ##{@merge_request.iid}"))
+      mail(from: sender(@note.author_id),
+           to: recipient(recipient_id),
+           subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
     end
  
     def note_wall_email(recipient_id, note_id)
       @note = Note.find(note_id)
       @project = @note.project
-      mail(to: recipient(recipient_id), subject: subject("Note on wall"))
+      mail(from: sender(@note.author_id),
+           to: recipient(recipient_id),
+           subject: subject("Note on wall"))
     end
   end
 end
@@ -22,7 +22,9 @@ module Emails
       @diffs   = compare.diffs
       @branch  = branch
  
-      mail(to: recipient, subject: subject("New push to repository"))
+      mail(from: sender(author_id),
+           to: recipient,
+           subject: subject("New push to repository"))
     end
   end
 end
@@ -15,16 +15,33 @@ class Notify &lt; ActionMailer::Base
   default_url_options[:port]     = Gitlab.config.gitlab.port unless Gitlab.config.gitlab_on_standard_port?
   default_url_options[:script_name] = Gitlab.config.gitlab.relative_url_root
  
-  default from: Gitlab.config.gitlab.email_from
+  default from: Proc.new { default_sender_address.format }
   default reply_to: "noreply@#{Gitlab.config.gitlab.host}"
  
-  # Just send email with 3 seconds delay
+  # Just send email with 2 seconds delay
   def self.delay
     delay_for(2.seconds)
   end
  
   private
  
+  # The default email address to send emails from
+  def default_sender_address
+    address = Mail::Address.new(Gitlab.config.gitlab.email_from)
+    address.display_name = "GitLab"
+    address
+  end
+
+  # Return an email address that displays the name of the sender.
+  # Only the displayed name changes; the actual email address is always the same.
+  def sender(sender_id)
+    if sender = User.find(sender_id)
+      address = default_sender_address
+      address.display_name = sender.name
+      address.format
+    end
+  end
+
   # Look up a User by their ID and return their email address
   #
   # recipient_id - User ID
@@ -43,21 +60,21 @@ class Notify &lt; ActionMailer::Base
   # Examples
   #
   #   >> subject('Lorem ipsum')
-  #   => "GitLab | Lorem ipsum"
+  #   => "Lorem ipsum"
   #
   #   # Automatically inserts Project name when @project is set
   #   >> @project = Project.last
   #   => #<Project id: 1, name: "Ruby on Rails", path: "ruby_on_rails", ...>
   #   >> subject('Lorem ipsum')
-  #   => "GitLab | Ruby on Rails | Lorem ipsum "
+  #   => "Ruby on Rails | Lorem ipsum "
   #
   #   # Accepts multiple arguments
   #   >> subject('Lorem ipsum', 'Dolor sit amet')
-  #   => "GitLab | Lorem ipsum | Dolor sit amet"
+  #   => "Lorem ipsum | Dolor sit amet"
   def subject(*extra)
-    subject = "GitLab"
-    subject << (@project ? " | #{@project.name_with_namespace}" : "")
-    subject << " | " + extra.join(' | ') if extra.present?
+    subject = ""
+    subject << "#{@project.name} | " if @project
+    subject << extra.join(' | ') if extra.present?
     subject
   end
 end
@@ -257,7 +257,7 @@ class NotificationService
     recipients.delete(current_user)
  
     recipients.each do |recipient|
-      mailer.send(method, recipient.id, target.id, target.assignee_id_was)
+      mailer.send(method, recipient.id, target.id, target.assignee_id_was, current_user.id)
     end
   end
  
@@ -4,7 +4,7 @@ Devise.setup do |config|
   # ==> Mailer Configuration
   # Configure the e-mail address which will be shown in Devise::Mailer,
   # note that it will be overwritten if you use your own mailer class with default "from" parameter.
-  config.mailer_sender = Gitlab.config.gitlab.email_from
+  config.mailer_sender = "GitLab <#{Gitlab.config.gitlab.email_from}>"
  
  
   # Configure the class responsible to send e-mails.
@@ -4,6 +4,7 @@ describe Notify do
   include EmailSpec::Helpers
   include EmailSpec::Matchers
  
+  let(:gitlab_sender) { Gitlab.config.gitlab.email_from }
   let(:recipient) { create(:user, email: 'recipient@example.com') }
   let(:project) { create(:project) }
  
@@ -13,18 +14,28 @@ describe Notify do
     end
   end
  
+  shared_examples 'an email sent from GitLab' do
+    it 'is sent from GitLab' do
+      sender = subject.header[:from].addrs[0]
+      sender.display_name.should eq('GitLab')
+      sender.address.should eq(gitlab_sender)
+    end
+  end
+
   describe 'for new users, the email' do
     let(:example_site_path) { root_path }
     let(:new_user) { create(:user, email: 'newguy@example.com', created_by_id: 1) }
  
     subject { Notify.new_user_email(new_user.id, new_user.password) }
  
+    it_behaves_like 'an email sent from GitLab'
+
     it 'is sent to the new user' do
       should deliver_to new_user.email
     end
  
     it 'has the correct subject' do
-      should have_subject /^gitlab \| Account was created for you$/i
+      should have_subject /^Account was created for you$/i
     end
  
     it 'contains the new user\'s login name' do
@@ -47,12 +58,14 @@ describe Notify do
  
     subject { Notify.new_user_email(new_user.id, new_user.password) }
  
+    it_behaves_like 'an email sent from GitLab'
+
     it 'is sent to the new user' do
       should deliver_to new_user.email
     end
  
     it 'has the correct subject' do
-      should have_subject /^gitlab \| Account was created for you$/i
+      should have_subject /^Account was created for you$/i
     end
  
     it 'contains the new user\'s login name' do
@@ -73,12 +86,14 @@ describe Notify do
  
     subject { Notify.new_ssh_key_email(key.id) }
  
+    it_behaves_like 'an email sent from GitLab'
+
     it 'is sent to the new user' do
       should deliver_to key.user.email
     end
  
     it 'has the correct subject' do
-      should have_subject /^gitlab \| SSH key was added to your account$/i
+      should have_subject /^SSH key was added to your account$/i
     end
  
     it 'contains the new ssh key title' do
@@ -114,17 +129,24 @@ describe Notify do
  
   context 'for a project' do
     describe 'items that are assignable, the email' do
+      let(:current_user) { create(:user, email: "current@email.com") }
       let(:assignee) { create(:user, email: 'assignee@example.com') }
       let(:previous_assignee) { create(:user, name: 'Previous Assignee') }
  
       shared_examples 'an assignee email' do
+        it 'is sent as the author' do
+          sender = subject.header[:from].addrs[0]
+          sender.display_name.should eq(current_user.name)
+          sender.address.should eq(gitlab_sender)
+        end
+
         it 'is sent to the assignee' do
           should deliver_to assignee.email
         end
       end
  
       context 'for issues' do
-        let(:issue) { create(:issue, assignee: assignee, project: project ) }
+        let(:issue) { create(:issue, author: current_user, assignee: assignee, project: project ) }
  
         describe 'that are new' do
           subject { Notify.new_issue_email(issue.assignee_id, issue.id) }
@@ -132,7 +154,7 @@ describe Notify do
           it_behaves_like 'an assignee email'
  
           it 'has the correct subject' do
-            should have_subject /#{project.name} \| New issue ##{issue.iid} \| #{issue.title}/
+            should have_subject /#{project.name} \| #{issue.title} \(##{issue.iid}\)/
           end
  
           it 'contains a link to the new issue' do
@@ -141,14 +163,18 @@ describe Notify do
         end
  
         describe 'that have been reassigned' do
-          before(:each) { issue.stub(:assignee_id_was).and_return(previous_assignee.id) }
-
-          subject { Notify.reassigned_issue_email(recipient.id, issue.id, previous_assignee.id) }
+          subject { Notify.reassigned_issue_email(recipient.id, issue.id, previous_assignee.id, current_user) }
  
           it_behaves_like 'a multiple recipients email'
  
+          it 'is sent as the author' do
+            sender = subject.header[:from].addrs[0]
+            sender.display_name.should eq(current_user.name)
+            sender.address.should eq(gitlab_sender)
+          end
+
           it 'has the correct subject' do
-            should have_subject /Changed issue ##{issue.iid} \| #{issue.title}/
+            should have_subject /#{issue.title} \(##{issue.iid}\)/
           end
  
           it 'contains the name of the previous assignee' do
@@ -165,12 +191,17 @@ describe Notify do
         end
  
         describe 'status changed' do
-          let(:current_user) { create(:user, email: "current@email.com") }
           let(:status) { 'closed' }
           subject { Notify.issue_status_changed_email(recipient.id, issue.id, status, current_user) }
  
+          it 'is sent as the author' do
+            sender = subject.header[:from].addrs[0]
+            sender.display_name.should eq(current_user.name)
+            sender.address.should eq(gitlab_sender)
+          end
+
           it 'has the correct subject' do
-            should have_subject /Changed issue ##{issue.iid} \| #{issue.title}/i
+            should have_subject /#{issue.title} \(##{issue.iid}\)/i
           end
  
           it 'contains the new status' do
@@ -189,7 +220,7 @@ describe Notify do
       end
  
       context 'for merge requests' do
-        let(:merge_request) { create(:merge_request, assignee: assignee, source_project: project, target_project: project) }
+        let(:merge_request) { create(:merge_request, author: current_user, assignee: assignee, source_project: project, target_project: project) }
  
         describe 'that are new' do
           subject { Notify.new_merge_request_email(merge_request.assignee_id, merge_request.id) }
@@ -197,7 +228,7 @@ describe Notify do
           it_behaves_like 'an assignee email'
  
           it 'has the correct subject' do
-            should have_subject /New merge request ##{merge_request.iid}/
+            should have_subject /#{merge_request.title} \(!#{merge_request.iid}\)/
           end
  
           it 'contains a link to the new merge request' do
@@ -214,14 +245,18 @@ describe Notify do
         end
  
         describe 'that are reassigned' do
-          before(:each) { merge_request.stub(:assignee_id_was).and_return(previous_assignee.id) }
-
-          subject { Notify.reassigned_merge_request_email(recipient.id, merge_request.id, previous_assignee.id) }
+          subject { Notify.reassigned_merge_request_email(recipient.id, merge_request.id, previous_assignee.id, current_user.id) }
  
           it_behaves_like 'a multiple recipients email'
  
+          it 'is sent as the author' do
+            sender = subject.header[:from].addrs[0]
+            sender.display_name.should eq(current_user.name)
+            sender.address.should eq(gitlab_sender)
+          end
+
           it 'has the correct subject' do
-            should have_subject /Changed merge request ##{merge_request.iid}/
+            should have_subject /#{merge_request.title} \(!#{merge_request.iid}\)/
           end
  
           it 'contains the name of the previous assignee' do
@@ -245,6 +280,8 @@ describe Notify do
       let(:user) { create(:user) }
       subject { Notify.project_was_moved_email(project.id, user.id) }
  
+      it_behaves_like 'an email sent from GitLab'
+
       it 'has the correct subject' do
         should have_subject /Project was moved/
       end
@@ -265,6 +302,9 @@ describe Notify do
                                    project: project,
                                    user: user) }
       subject { Notify.project_access_granted_email(users_project.id) }
+
+      it_behaves_like 'an email sent from GitLab'
+
       it 'has the correct subject' do
         should have_subject /Access to project was granted/
       end
@@ -285,6 +325,12 @@ describe Notify do
       end
  
       shared_examples 'a note email' do
+        it 'is sent as the author' do
+          sender = subject.header[:from].addrs[0]
+          sender.display_name.should eq(note_author.name)
+          sender.address.should eq(gitlab_sender)
+        end
+
         it 'is sent to the given recipient' do
           should deliver_to recipient.email
         end
@@ -324,7 +370,7 @@ describe Notify do
         it_behaves_like 'a note email'
  
         it 'has the correct subject' do
-          should have_subject /Note for commit #{commit.short_id}/
+          should have_subject /#{commit.title} \(#{commit.short_id}\)/
         end
  
         it 'contains a link to the commit' do
@@ -342,7 +388,7 @@ describe Notify do
         it_behaves_like 'a note email'
  
         it 'has the correct subject' do
-          should have_subject /Note for merge request ##{merge_request.iid}/
+          should have_subject /#{merge_request.title} \(!#{merge_request.iid}\)/
         end
  
         it 'contains a link to the merge request note' do
@@ -360,7 +406,7 @@ describe Notify do
         it_behaves_like 'a note email'
  
         it 'has the correct subject' do
-          should have_subject /Note for issue ##{issue.iid}/
+          should have_subject /#{issue.title} \(##{issue.iid}\)/
         end
  
         it 'contains a link to the issue note' do
@@ -377,6 +423,8 @@ describe Notify do
  
     subject { Notify.group_access_granted_email(membership.id) }
  
+    it_behaves_like 'an email sent from GitLab'
+
     it 'has the correct subject' do
       should have_subject /Access to group was granted/
     end
@@ -401,6 +449,8 @@ describe Notify do
  
     subject { ActionMailer::Base.deliveries.last }
  
+    it_behaves_like 'an email sent from GitLab'
+
     it 'is sent to the new user' do
       should deliver_to 'new-email@mail.com'
     end
@@ -421,6 +471,12 @@ describe Notify do
  
     subject { Notify.repository_push_email(project.id, 'devs@company.name', user.id, 'master', compare) }
  
+    it 'is sent as the author' do
+      sender = subject.header[:from].addrs[0]
+      sender.display_name.should eq(user.name)
+      sender.address.should eq(gitlab_sender)
+    end
+
     it 'is sent to recipient' do
       should deliver_to 'devs@company.name'
     end
@@ -137,11 +137,11 @@ describe NotificationService do
       end
  
       def should_email(user_id)
-        Notify.should_receive(:reassigned_issue_email).with(user_id, issue.id, issue.assignee_id)
+        Notify.should_receive(:reassigned_issue_email).with(user_id, issue.id, issue.assignee_id, @u_disabled.id)
       end
  
       def should_not_email(user_id)
-        Notify.should_not_receive(:reassigned_issue_email).with(user_id, issue.id, issue.assignee_id)
+        Notify.should_not_receive(:reassigned_issue_email).with(user_id, issue.id, issue.assignee_id, @u_disabled.id)
       end
     end
  
@@ -201,11 +201,11 @@ describe NotificationService do
       end
  
       def should_email(user_id)
-        Notify.should_receive(:reassigned_merge_request_email).with(user_id, merge_request.id, merge_request.assignee_id)
+        Notify.should_receive(:reassigned_merge_request_email).with(user_id, merge_request.id, merge_request.assignee_id, merge_request.author_id)
       end
  
       def should_not_email(user_id)
-        Notify.should_not_receive(:reassigned_merge_request_email).with(user_id, merge_request.id, merge_request.assignee_id)
+        Notify.should_not_receive(:reassigned_merge_request_email).with(user_id, merge_request.id, merge_request.assignee_id, merge_request.author_id)
       end
     end
...	...	@@ -3,22 +3,27 @@ module Emails
3	3	def new_issue_email(recipient_id, issue_id)
4	4	@issue = Issue.find(issue_id)
5	5	@project = @issue.project
6		- mail(to: recipient(recipient_id), subject: subject("New issue ##{@issue.iid}", @issue.title))
	6	+ mail(from: sender(@issue.author_id),
	7	+ to: recipient(recipient_id),
	8	+ subject: subject("#{@issue.title} (##{@issue.iid})"))
7	9	end
8	10
9		- def reassigned_issue_email(recipient_id, issue_id, previous_assignee_id)
	11	+ def reassigned_issue_email(recipient_id, issue_id, previous_assignee_id, updated_by_user_id)
10	12	@issue = Issue.find(issue_id)
11	13	@previous_assignee = User.find_by(id: previous_assignee_id) if previous_assignee_id
12	14	@project = @issue.project
13		- mail(to: recipient(recipient_id), subject: subject("Changed issue ##{@issue.iid}", @issue.title))
	15	+ mail(from: sender(updated_by_user_id),
	16	+ to: recipient(recipient_id),
	17	+ subject: subject("#{@issue.title} (##{@issue.iid})"))
14	18	end
15	19
16	20	def closed_issue_email(recipient_id, issue_id, updated_by_user_id)
17	21	@issue = Issue.find issue_id
18	22	@project = @issue.project
19	23	@updated_by = User.find updated_by_user_id
20		- mail(to: recipient(recipient_id),
21		- subject: subject("Closed issue ##{@issue.iid}", @issue.title))
	24	+ mail(from: sender(updated_by_user_id),
	25	+ to: recipient(recipient_id),
	26	+ subject: subject("#{@issue.title} (##{@issue.iid})"))
22	27	end
23	28
24	29	def issue_status_changed_email(recipient_id, issue_id, status, updated_by_user_id)
...	...	@@ -26,8 +31,9 @@ module Emails
26	31	@issue_status = status
27	32	@project = @issue.project
28	33	@updated_by = User.find updated_by_user_id
29		- mail(to: recipient(recipient_id),
30		- subject: subject("Changed issue ##{@issue.iid}", @issue.title))
	34	+ mail(from: sender(updated_by_user_id),
	35	+ to: recipient(recipient_id),
	36	+ subject: subject("#{@issue.title} (##{@issue.iid})"))
31	37	end
32	38	end
33	39	end
...	...
...	...	@@ -3,27 +3,35 @@ module Emails
3	3	def new_merge_request_email(recipient_id, merge_request_id)
4	4	@merge_request = MergeRequest.find(merge_request_id)
5	5	@project = @merge_request.project
6		- mail(to: recipient(recipient_id), subject: subject("New merge request ##{@merge_request.iid}", @merge_request.title))
	6	+ mail(from: sender(@merge_request.author_id),
	7	+ to: recipient(recipient_id),
	8	+ subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
7	9	end
8	10
9		- def reassigned_merge_request_email(recipient_id, merge_request_id, previous_assignee_id)
	11	+ def reassigned_merge_request_email(recipient_id, merge_request_id, previous_assignee_id, updated_by_user_id)
10	12	@merge_request = MergeRequest.find(merge_request_id)
11	13	@previous_assignee = User.find_by(id: previous_assignee_id) if previous_assignee_id
12	14	@project = @merge_request.project
13		- mail(to: recipient(recipient_id), subject: subject("Changed merge request ##{@merge_request.iid}", @merge_request.title))
	15	+ mail(from: sender(updated_by_user_id),
	16	+ to: recipient(recipient_id),
	17	+ subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
14	18	end
15	19
16	20	def closed_merge_request_email(recipient_id, merge_request_id, updated_by_user_id)
17	21	@merge_request = MergeRequest.find(merge_request_id)
18	22	@updated_by = User.find updated_by_user_id
19	23	@project = @merge_request.project
20		- mail(to: recipient(recipient_id), subject: subject("Closed merge request ##{@merge_request.iid}", @merge_request.title))
	24	+ mail(from: sender(updated_by_user_id),
	25	+ to: recipient(recipient_id),
	26	+ subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
21	27	end
22	28
23	29	def merged_merge_request_email(recipient_id, merge_request_id)
24	30	@merge_request = MergeRequest.find(merge_request_id)
25	31	@project = @merge_request.project
26		- mail(to: recipient(recipient_id), subject: subject("Accepted merge request ##{@merge_request.iid}", @merge_request.title))
	32	+ mail(from: sender(@merge_request.author_id_of_changes),
	33	+ to: recipient(recipient_id),
	34	+ subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
27	35	end
28	36	end
29	37
...	...	@@ -57,7 +65,7 @@ module Emails
57	65	# >> subject('Lorem ipsum', 'Dolor sit amet')
58	66	# => "GitLab Merge Request \| Lorem ipsum \| Dolor sit amet"
59	67	def subject(*extra)
60		- subject = "GitLab Merge Request \|"
	68	+ subject = "Merge Request \| "
61	69	if @merge_request.for_fork?
62	70	subject << "#{@merge_request.source_project.name_with_namespace}:#{merge_request.source_branch} >> #{@merge_request.target_project.name_with_namespace}:#{merge_request.target_branch}"
63	71	else
...	...
...	...	@@ -4,27 +4,35 @@ module Emails
4	4	@note = Note.find(note_id)
5	5	@commit = @note.noteable
6	6	@project = @note.project
7		- mail(to: recipient(recipient_id), subject: subject("Note for commit #{@commit.short_id}", @commit.title))
	7	+ mail(from: sender(@note.author_id),
	8	+ to: recipient(recipient_id),
	9	+ subject: subject("#{@commit.title} (#{@commit.short_id})"))
8	10	end
9	11
10	12	def note_issue_email(recipient_id, note_id)
11	13	@note = Note.find(note_id)
12	14	@issue = @note.noteable
13	15	@project = @note.project
14		- mail(to: recipient(recipient_id), subject: subject("Note for issue ##{@issue.iid}"))
	16	+ mail(from: sender(@note.author_id),
	17	+ to: recipient(recipient_id),
	18	+ subject: subject("#{@issue.title} (##{@issue.iid})"))
15	19	end
16	20
17	21	def note_merge_request_email(recipient_id, note_id)
18	22	@note = Note.find(note_id)
19	23	@merge_request = @note.noteable
20	24	@project = @note.project
21		- mail(to: recipient(recipient_id), subject: subject("Note for merge request ##{@merge_request.iid}"))
	25	+ mail(from: sender(@note.author_id),
	26	+ to: recipient(recipient_id),
	27	+ subject: subject("#{@merge_request.title} (!#{@merge_request.iid})"))
22	28	end
23	29
24	30	def note_wall_email(recipient_id, note_id)
25	31	@note = Note.find(note_id)
26	32	@project = @note.project
27		- mail(to: recipient(recipient_id), subject: subject("Note on wall"))
	33	+ mail(from: sender(@note.author_id),
	34	+ to: recipient(recipient_id),
	35	+ subject: subject("Note on wall"))
28	36	end
29	37	end
30	38	end
...	...
...	...	@@ -22,7 +22,9 @@ module Emails
22	22	@diffs = compare.diffs
23	23	@branch = branch
24	24
25		- mail(to: recipient, subject: subject("New push to repository"))
	25	+ mail(from: sender(author_id),
	26	+ to: recipient,
	27	+ subject: subject("New push to repository"))
26	28	end
27	29	end
28	30	end
...	...
...	...	@@ -15,16 +15,33 @@ class Notify < ActionMailer::Base
15	15	default_url_options[:port] = Gitlab.config.gitlab.port unless Gitlab.config.gitlab_on_standard_port?
16	16	default_url_options[:script_name] = Gitlab.config.gitlab.relative_url_root
17	17
18		- default from: Gitlab.config.gitlab.email_from
	18	+ default from: Proc.new { default_sender_address.format }
19	19	default reply_to: "noreply@#{Gitlab.config.gitlab.host}"
20	20
21		- # Just send email with 3 seconds delay
	21	+ # Just send email with 2 seconds delay
22	22	def self.delay
23	23	delay_for(2.seconds)
24	24	end
25	25
26	26	private
27	27
	28	+ # The default email address to send emails from
	29	+ def default_sender_address
	30	+ address = Mail::Address.new(Gitlab.config.gitlab.email_from)
	31	+ address.display_name = "GitLab"
	32	+ address
	33	+ end
	34	+
	35	+ # Return an email address that displays the name of the sender.
	36	+ # Only the displayed name changes; the actual email address is always the same.
	37	+ def sender(sender_id)
	38	+ if sender = User.find(sender_id)
	39	+ address = default_sender_address
	40	+ address.display_name = sender.name
	41	+ address.format
	42	+ end
	43	+ end
	44	+
28	45	# Look up a User by their ID and return their email address
29	46	#
30	47	# recipient_id - User ID
...	...	@@ -43,21 +60,21 @@ class Notify < ActionMailer::Base
43	60	# Examples
44	61	#
45	62	# >> subject('Lorem ipsum')
46		- # => "GitLab \| Lorem ipsum"
	63	+ # => "Lorem ipsum"
47	64	#
48	65	# # Automatically inserts Project name when @project is set
49	66	# >> @project = Project.last
50	67	# => #<Project id: 1, name: "Ruby on Rails", path: "ruby_on_rails", ...>
51	68	# >> subject('Lorem ipsum')
52		- # => "GitLab \| Ruby on Rails \| Lorem ipsum "
	69	+ # => "Ruby on Rails \| Lorem ipsum "
53	70	#
54	71	# # Accepts multiple arguments
55	72	# >> subject('Lorem ipsum', 'Dolor sit amet')
56		- # => "GitLab \| Lorem ipsum \| Dolor sit amet"
	73	+ # => "Lorem ipsum \| Dolor sit amet"
57	74	def subject(*extra)
58		- subject = "GitLab"
59		- subject << (@project ? " \| #{@project.name_with_namespace}" : "")
60		- subject << " \| " + extra.join(' \| ') if extra.present?
	75	+ subject = ""
	76	+ subject << "#{@project.name} \| " if @project
	77	+ subject << extra.join(' \| ') if extra.present?
61	78	subject
62	79	end
63	80	end
...	...
...	...	@@ -257,7 +257,7 @@ class NotificationService
257	257	recipients.delete(current_user)
258	258
259	259	recipients.each do \|recipient\|
260		- mailer.send(method, recipient.id, target.id, target.assignee_id_was)
	260	+ mailer.send(method, recipient.id, target.id, target.assignee_id_was, current_user.id)
261	261	end
262	262	end
263	263
...	...
...	...	@@ -4,7 +4,7 @@ Devise.setup do \|config\|
4	4	# ==> Mailer Configuration
5	5	# Configure the e-mail address which will be shown in Devise::Mailer,
6	6	# note that it will be overwritten if you use your own mailer class with default "from" parameter.
7		- config.mailer_sender = Gitlab.config.gitlab.email_from
	7	+ config.mailer_sender = "GitLab <#{Gitlab.config.gitlab.email_from}>"
8	8
9	9
10	10	# Configure the class responsible to send e-mails.
...	...
...	...	@@ -4,6 +4,7 @@ describe Notify do
4	4	include EmailSpec::Helpers
5	5	include EmailSpec::Matchers
6	6
	7	+ let(:gitlab_sender) { Gitlab.config.gitlab.email_from }
7	8	let(:recipient) { create(:user, email: 'recipient@example.com') }
8	9	let(:project) { create(:project) }
9	10
...	...	@@ -13,18 +14,28 @@ describe Notify do
13	14	end
14	15	end
15	16
	17	+ shared_examples 'an email sent from GitLab' do
	18	+ it 'is sent from GitLab' do
	19	+ sender = subject.header[:from].addrs[0]
	20	+ sender.display_name.should eq('GitLab')
	21	+ sender.address.should eq(gitlab_sender)
	22	+ end
	23	+ end
	24	+
16	25	describe 'for new users, the email' do
17	26	let(:example_site_path) { root_path }
18	27	let(:new_user) { create(:user, email: 'newguy@example.com', created_by_id: 1) }
19	28
20	29	subject { Notify.new_user_email(new_user.id, new_user.password) }
21	30
	31	+ it_behaves_like 'an email sent from GitLab'
	32	+
22	33	it 'is sent to the new user' do
23	34	should deliver_to new_user.email
24	35	end
25	36
26	37	it 'has the correct subject' do
27		- should have_subject /^gitlab \\| Account was created for you$/i
	38	+ should have_subject /^Account was created for you$/i
28	39	end
29	40
30	41	it 'contains the new user\'s login name' do
...	...	@@ -47,12 +58,14 @@ describe Notify do
47	58
48	59	subject { Notify.new_user_email(new_user.id, new_user.password) }
49	60
	61	+ it_behaves_like 'an email sent from GitLab'
	62	+
50	63	it 'is sent to the new user' do
51	64	should deliver_to new_user.email
52	65	end
53	66
54	67	it 'has the correct subject' do
55		- should have_subject /^gitlab \\| Account was created for you$/i
	68	+ should have_subject /^Account was created for you$/i
56	69	end
57	70
58	71	it 'contains the new user\'s login name' do
...	...	@@ -73,12 +86,14 @@ describe Notify do
73	86
74	87	subject { Notify.new_ssh_key_email(key.id) }
75	88
	89	+ it_behaves_like 'an email sent from GitLab'
	90	+
76	91	it 'is sent to the new user' do
77	92	should deliver_to key.user.email
78	93	end
79	94
80	95	it 'has the correct subject' do
81		- should have_subject /^gitlab \\| SSH key was added to your account$/i
	96	+ should have_subject /^SSH key was added to your account$/i
82	97	end
83	98
84	99	it 'contains the new ssh key title' do
...	...	@@ -114,17 +129,24 @@ describe Notify do
114	129
115	130	context 'for a project' do
116	131	describe 'items that are assignable, the email' do
	132	+ let(:current_user) { create(:user, email: "current@email.com") }
117	133	let(:assignee) { create(:user, email: 'assignee@example.com') }
118	134	let(:previous_assignee) { create(:user, name: 'Previous Assignee') }
119	135
120	136	shared_examples 'an assignee email' do
	137	+ it 'is sent as the author' do
	138	+ sender = subject.header[:from].addrs[0]
	139	+ sender.display_name.should eq(current_user.name)
	140	+ sender.address.should eq(gitlab_sender)
	141	+ end
	142	+
121	143	it 'is sent to the assignee' do
122	144	should deliver_to assignee.email
123	145	end
124	146	end
125	147
126	148	context 'for issues' do
127		- let(:issue) { create(:issue, assignee: assignee, project: project ) }
	149	+ let(:issue) { create(:issue, author: current_user, assignee: assignee, project: project ) }
128	150
129	151	describe 'that are new' do
130	152	subject { Notify.new_issue_email(issue.assignee_id, issue.id) }
...	...	@@ -132,7 +154,7 @@ describe Notify do
132	154	it_behaves_like 'an assignee email'
133	155
134	156	it 'has the correct subject' do
135		- should have_subject /#{project.name} \\| New issue ##{issue.iid} \\| #{issue.title}/
	157	+ should have_subject /#{project.name} \\| #{issue.title} \(##{issue.iid}\)/
136	158	end
137	159
138	160	it 'contains a link to the new issue' do
...	...	@@ -141,14 +163,18 @@ describe Notify do
141	163	end
142	164
143	165	describe 'that have been reassigned' do
144		- before(:each) { issue.stub(:assignee_id_was).and_return(previous_assignee.id) }
145		-
146		- subject { Notify.reassigned_issue_email(recipient.id, issue.id, previous_assignee.id) }
	166	+ subject { Notify.reassigned_issue_email(recipient.id, issue.id, previous_assignee.id, current_user) }
147	167
148	168	it_behaves_like 'a multiple recipients email'
149	169
	170	+ it 'is sent as the author' do
	171	+ sender = subject.header[:from].addrs[0]
	172	+ sender.display_name.should eq(current_user.name)
	173	+ sender.address.should eq(gitlab_sender)
	174	+ end
	175	+
150	176	it 'has the correct subject' do
151		- should have_subject /Changed issue ##{issue.iid} \\| #{issue.title}/
	177	+ should have_subject /#{issue.title} \(##{issue.iid}\)/
152	178	end
153	179
154	180	it 'contains the name of the previous assignee' do
...	...	@@ -165,12 +191,17 @@ describe Notify do
165	191	end
166	192
167	193	describe 'status changed' do
168		- let(:current_user) { create(:user, email: "current@email.com") }
169	194	let(:status) { 'closed' }
170	195	subject { Notify.issue_status_changed_email(recipient.id, issue.id, status, current_user) }
171	196
	197	+ it 'is sent as the author' do
	198	+ sender = subject.header[:from].addrs[0]
	199	+ sender.display_name.should eq(current_user.name)
	200	+ sender.address.should eq(gitlab_sender)
	201	+ end
	202	+
172	203	it 'has the correct subject' do
173		- should have_subject /Changed issue ##{issue.iid} \\| #{issue.title}/i
	204	+ should have_subject /#{issue.title} \(##{issue.iid}\)/i
174	205	end
175	206
176	207	it 'contains the new status' do
...	...	@@ -189,7 +220,7 @@ describe Notify do
189	220	end
190	221
191	222	context 'for merge requests' do
192		- let(:merge_request) { create(:merge_request, assignee: assignee, source_project: project, target_project: project) }
	223	+ let(:merge_request) { create(:merge_request, author: current_user, assignee: assignee, source_project: project, target_project: project) }
193	224
194	225	describe 'that are new' do
195	226	subject { Notify.new_merge_request_email(merge_request.assignee_id, merge_request.id) }
...	...	@@ -197,7 +228,7 @@ describe Notify do
197	228	it_behaves_like 'an assignee email'
198	229
199	230	it 'has the correct subject' do
200		- should have_subject /New merge request ##{merge_request.iid}/
	231	+ should have_subject /#{merge_request.title} \(!#{merge_request.iid}\)/
201	232	end
202	233
203	234	it 'contains a link to the new merge request' do
...	...	@@ -214,14 +245,18 @@ describe Notify do
214	245	end
215	246
216	247	describe 'that are reassigned' do
217		- before(:each) { merge_request.stub(:assignee_id_was).and_return(previous_assignee.id) }
218		-
219		- subject { Notify.reassigned_merge_request_email(recipient.id, merge_request.id, previous_assignee.id) }
	248	+ subject { Notify.reassigned_merge_request_email(recipient.id, merge_request.id, previous_assignee.id, current_user.id) }
220	249
221	250	it_behaves_like 'a multiple recipients email'
222	251
	252	+ it 'is sent as the author' do
	253	+ sender = subject.header[:from].addrs[0]
	254	+ sender.display_name.should eq(current_user.name)
	255	+ sender.address.should eq(gitlab_sender)
	256	+ end
	257	+
223	258	it 'has the correct subject' do
224		- should have_subject /Changed merge request ##{merge_request.iid}/
	259	+ should have_subject /#{merge_request.title} \(!#{merge_request.iid}\)/
225	260	end
226	261
227	262	it 'contains the name of the previous assignee' do
...	...	@@ -245,6 +280,8 @@ describe Notify do
245	280	let(:user) { create(:user) }
246	281	subject { Notify.project_was_moved_email(project.id, user.id) }
247	282
	283	+ it_behaves_like 'an email sent from GitLab'
	284	+
248	285	it 'has the correct subject' do
249	286	should have_subject /Project was moved/
250	287	end
...	...	@@ -265,6 +302,9 @@ describe Notify do
265	302	project: project,
266	303	user: user) }
267	304	subject { Notify.project_access_granted_email(users_project.id) }
	305	+
	306	+ it_behaves_like 'an email sent from GitLab'
	307	+
268	308	it 'has the correct subject' do
269	309	should have_subject /Access to project was granted/
270	310	end
...	...	@@ -285,6 +325,12 @@ describe Notify do
285	325	end
286	326
287	327	shared_examples 'a note email' do
	328	+ it 'is sent as the author' do
	329	+ sender = subject.header[:from].addrs[0]
	330	+ sender.display_name.should eq(note_author.name)
	331	+ sender.address.should eq(gitlab_sender)
	332	+ end
	333	+
288	334	it 'is sent to the given recipient' do
289	335	should deliver_to recipient.email
290	336	end
...	...	@@ -324,7 +370,7 @@ describe Notify do
324	370	it_behaves_like 'a note email'
325	371
326	372	it 'has the correct subject' do
327		- should have_subject /Note for commit #{commit.short_id}/
	373	+ should have_subject /#{commit.title} \(#{commit.short_id}\)/
328	374	end
329	375
330	376	it 'contains a link to the commit' do
...	...	@@ -342,7 +388,7 @@ describe Notify do
342	388	it_behaves_like 'a note email'
343	389
344	390	it 'has the correct subject' do
345		- should have_subject /Note for merge request ##{merge_request.iid}/
	391	+ should have_subject /#{merge_request.title} \(!#{merge_request.iid}\)/
346	392	end
347	393
348	394	it 'contains a link to the merge request note' do
...	...	@@ -360,7 +406,7 @@ describe Notify do
360	406	it_behaves_like 'a note email'
361	407
362	408	it 'has the correct subject' do
363		- should have_subject /Note for issue ##{issue.iid}/
	409	+ should have_subject /#{issue.title} \(##{issue.iid}\)/
364	410	end
365	411
366	412	it 'contains a link to the issue note' do
...	...	@@ -377,6 +423,8 @@ describe Notify do
377	423
378	424	subject { Notify.group_access_granted_email(membership.id) }
379	425
	426	+ it_behaves_like 'an email sent from GitLab'
	427	+
380	428	it 'has the correct subject' do
381	429	should have_subject /Access to group was granted/
382	430	end
...	...	@@ -401,6 +449,8 @@ describe Notify do
401	449
402	450	subject { ActionMailer::Base.deliveries.last }
403	451
	452	+ it_behaves_like 'an email sent from GitLab'
	453	+
404	454	it 'is sent to the new user' do
405	455	should deliver_to 'new-email@mail.com'
406	456	end
...	...	@@ -421,6 +471,12 @@ describe Notify do
421	471
422	472	subject { Notify.repository_push_email(project.id, 'devs@company.name', user.id, 'master', compare) }
423	473
	474	+ it 'is sent as the author' do
	475	+ sender = subject.header[:from].addrs[0]
	476	+ sender.display_name.should eq(user.name)
	477	+ sender.address.should eq(gitlab_sender)
	478	+ end
	479	+
424	480	it 'is sent to recipient' do
425	481	should deliver_to 'devs@company.name'
426	482	end
...	...
...	...	@@ -137,11 +137,11 @@ describe NotificationService do
137	137	end
138	138
139	139	def should_email(user_id)
140		- Notify.should_receive(:reassigned_issue_email).with(user_id, issue.id, issue.assignee_id)
	140	+ Notify.should_receive(:reassigned_issue_email).with(user_id, issue.id, issue.assignee_id, @u_disabled.id)
141	141	end
142	142
143	143	def should_not_email(user_id)
144		- Notify.should_not_receive(:reassigned_issue_email).with(user_id, issue.id, issue.assignee_id)
	144	+ Notify.should_not_receive(:reassigned_issue_email).with(user_id, issue.id, issue.assignee_id, @u_disabled.id)
145	145	end
146	146	end
147	147
...	...	@@ -201,11 +201,11 @@ describe NotificationService do
201	201	end
202	202
203	203	def should_email(user_id)
204		- Notify.should_receive(:reassigned_merge_request_email).with(user_id, merge_request.id, merge_request.assignee_id)
	204	+ Notify.should_receive(:reassigned_merge_request_email).with(user_id, merge_request.id, merge_request.assignee_id, merge_request.author_id)
205	205	end
206	206
207	207	def should_not_email(user_id)
208		- Notify.should_not_receive(:reassigned_merge_request_email).with(user_id, merge_request.id, merge_request.assignee_id)
	208	+ Notify.should_not_receive(:reassigned_merge_request_email).with(user_id, merge_request.id, merge_request.assignee_id, merge_request.author_id)
209	209	end
210	210	end
211	211
...	...