Merge branch 'rs-abuse-reports-refactor' into 'master'

Abuse Report refactors

- Redirect back to user profile after report
- "Tell, Don't Ask" for sending report notifications

See merge request !2293

app/controllers/abuse_reports_controller.rb

@@ -9,12 +9,10 @@ class AbuseReportsController < ApplicationController
     @abuse_report.reporter = current_user
 
     if @abuse_report.save
-      if current_application_settings.admin_notification_email.present?
-        AbuseReportMailer.notify(@abuse_report.id).deliver_later
-      end
+      @abuse_report.notify
 
       message = "Thank you for your report. A GitLab administrator will look into it shortly."
-      redirect_to root_path, notice: message
+      redirect_to @abuse_report.user, notice: message
     else
       render :new
     end
@@ -23,6 +21,9 @@ class AbuseReportsController < ApplicationController
   private
 
   def report_params
-    params.require(:abuse_report).permit(:user_id, :message)
+    params.require(:abuse_report).permit(%i(
+      message
+      user_id
+    ))
   end
 end

app/mailers/abuse_report_mailer.rb

@@ -2,11 +2,19 @@ class AbuseReportMailer < BaseMailer
   include Gitlab::CurrentSettings
 
   def notify(abuse_report_id)
+    return unless deliverable?
+
     @abuse_report = AbuseReport.find(abuse_report_id)
 
     mail(
-      to:       current_application_settings.admin_notification_email, 
+      to:       current_application_settings.admin_notification_email,
       subject:  "#{@abuse_report.user.name} (#{@abuse_report.user.username}) was reported for abuse"
     )
   end
+
+  private
+
+  def deliverable?
+    current_application_settings.admin_notification_email.present?
+  end
 end

app/models/abuse_report.rb

@@ -18,4 +18,10 @@ class AbuseReport < ActiveRecord::Base
   validates :user, presence: true
   validates :message, presence: true
   validates :user_id, uniqueness: true
+
+  def notify
+    return unless self.persisted?
+
+    AbuseReportMailer.notify(self.id).deliver_later
+  end
 end

spec/controllers/abuse_reports_controller_spec.rb

 require 'spec_helper'
 
 describe AbuseReportsController do
-  let(:reporter)    { create(:user) }
-  let(:user)        { create(:user) }
-  let(:message)     { "This user is a spammer" }
+  let(:reporter) { create(:user) }
+  let(:user)     { create(:user) }
+  let(:attrs) do
+    attributes_for(:abuse_report) do |hash|
+      hash[:user_id] = user.id
+    end
+  end
 
   before do
     sign_in(reporter)
   end
 
-  describe "POST create" do
-    context "with admin notification email set" do
-      let(:admin_email) { "admin@example.com"}
-
-      before(:each) do
-        stub_application_setting(admin_notification_email: admin_email)
+  describe 'POST create' do
+    context 'with valid attributes' do
+      it 'saves the abuse report' do
+        expect do
+          post :create, abuse_report: attrs
+        end.to change { AbuseReport.count }.by(1)
       end
 
-      it "sends a notification email" do
-        perform_enqueued_jobs do
-          post :create,
-            abuse_report: {
-              user_id: user.id,
-              message: message
-            }
-
-          email = ActionMailer::Base.deliveries.last
+      it 'calls notify' do
+        expect_any_instance_of(AbuseReport).to receive(:notify)
 
-          expect(email.to).to eq([admin_email])
-          expect(email.subject).to include(user.username)
-          expect(email.text_part.body).to include(message)
-        end
+        post :create, abuse_report: attrs
       end
 
-      it "saves the abuse report" do
-        perform_enqueued_jobs do
-          expect do
-            post :create,
-              abuse_report: {
-                user_id: user.id,
-                message: message
-              }
-          end.to change { AbuseReport.count }.by(1)
-        end
-      end
-    end
+      it 'redirects back to the reported user' do
+        post :create, abuse_report: attrs
 
-    context "without admin notification email set" do
-      before(:each) do
-        stub_application_setting(admin_notification_email: nil)
+        expect(response).to redirect_to user
       end
+    end
 
-      it "does not send a notification email" do
-        expect do
-          post :create,
-            abuse_report: {
-              user_id: user.id,
-              message: message
-            }
-        end.not_to change { ActionMailer::Base.deliveries.count }
-      end
+    context 'with invalid attributes' do
+      it 'renders new' do
+        attrs.delete(:user_id)
+        post :create, abuse_report: attrs
 
-      it "saves the abuse report" do
-        expect do
-          post :create,
-            abuse_report: {
-              user_id: user.id,
-              message: message
-            }
-        end.to change { AbuseReport.count }.by(1)
+        expect(response).to render_template(:new)
       end
     end
   end
-
 end

spec/mailers/abuse_report_mailer_spec.rb

+require 'rails_helper'
+
+describe AbuseReportMailer do
+  include EmailSpec::Matchers
+
+  describe '.notify' do
+    context 'with admin_notification_email set' do
+      before do
+        stub_application_setting(admin_notification_email: 'admin@example.com')
+      end
+
+      it 'sends to the admin_notification_email' do
+        report = create(:abuse_report)
+
+        mail = described_class.notify(report.id)
+
+        expect(mail).to deliver_to 'admin@example.com'
+      end
+
+      it 'includes the user in the subject' do
+        report = create(:abuse_report)
+
+        mail = described_class.notify(report.id)
+
+        expect(mail).to have_subject "#{report.user.name} (#{report.user.username}) was reported for abuse"
+      end
+    end
+
+    context 'with no admin_notification_email set' do
+      it 'returns early' do
+        stub_application_setting(admin_notification_email: nil)
+
+        expect { described_class.notify(spy).deliver_now }.
+          not_to change { ActionMailer::Base.deliveries.count }
+      end
+    end
+  end
+end

spec/models/abuse_report_spec.rb

@@ -28,4 +28,21 @@ RSpec.describe AbuseReport, type: :model do
     it { is_expected.to validate_presence_of(:message) }
     it { is_expected.to validate_uniqueness_of(:user_id) }
   end
+
+  describe '#notify' do
+    it 'delivers' do
+      expect(AbuseReportMailer).to receive(:notify).with(subject.id).
+        and_return(spy)
+
+      subject.notify
+    end
+
+    it 'returns early when not persisted' do
+      report = build(:abuse_report)
+
+      expect(AbuseReportMailer).not_to receive(:notify)
+
+      report.notify
+    end
+  end
 end