AO3-6544 Add comment_type and user_role to data sent to spam checker for comments and tickets

Author: sarken

app/models/abuse_report.rb

@@ -26,11 +26,15 @@ def logged_in_with_matching_email?
 
   def akismet_attributes
     name = username ? username : ""
+    # If the user is logged in and we're sending info to Akismet, we can assume
+    # the email does not match.
+    role = User.current_user.present? ? "user-with-nonmatching-email" : "guest"
     {
       comment_type: "contact-form",
       key: ArchiveConfig.AKISMET_KEY,
       blog: ArchiveConfig.AKISMET_NAME,
       user_ip: ip_address,
+      user_role: role,
       comment_author: name,
       comment_author_email: email,
       comment_content: comment

app/models/comment.rb

@@ -98,6 +98,7 @@ def akismet_attributes
       blog: ArchiveConfig.AKISMET_NAME,
       user_ip: ip_address,
       user_agent: user_agent,
+      user_role: "guest",
       comment_author: name,
       comment_author_email: email,
       comment_content: comment_content

app/models/feedback.rb

@@ -23,11 +23,16 @@ def logged_in_with_matching_email?
   end
 
   def akismet_attributes
+    # If the user is logged in and we're sending info to Akismet, we can assume
+    # the email does not match.
+    role = User.current_user.present? ? "user-with-nonmatching-email" : "guest"
     {
+      comment_type: "contact-form",
       key: ArchiveConfig.AKISMET_KEY,
       blog: ArchiveConfig.AKISMET_NAME,
       user_ip: ip_address,
       user_agent: user_agent,
+      user_role: role,
       comment_author_email: email,
       comment_content: comment
     }

app/models/work.rb

@@ -1098,6 +1098,7 @@ def akismet_attributes
       key: ArchiveConfig.AKISMET_KEY,
       blog: ArchiveConfig.AKISMET_NAME,
       user_ip: ip_address,
+      user_role: "user",
       comment_date_gmt: created_at.to_time.iso8601,
       blog_lang: language.short,
       comment_author: user.login,

spec/models/abuse_report_spec.rb

@@ -353,6 +353,23 @@
     end
   end
 
+  context "when report is submitted to Akismet" do
+    let(:report) { build(:abuse_report) }
+
+    it "has comment_type \"contact-form\"" do
+      expect(report.akismet_attributes[:comment_type]).to eq("contact-form")
+    end
+
+    it "has user_role \"user-with-nonmatching-email\" when reporter is logged in" do
+      User.current_user = create(:user)
+      expect(report.akismet_attributes[:user_role]).to eq("user-with-nonmatching-email")
+    end
+
+    it "has user_role \"guest\" when reporter is logged out" do
+      expect(report.akismet_attributes[:user_role]).to eq("guest")
+    end
+  end
+
   describe "#attach_work_download" do
     include ActiveJob::TestHelper
 

spec/models/comment_spec.rb

@@ -28,6 +28,14 @@
           .to raise_error(ActiveRecord::RecordNotFound)
       end
     end
+
+    context "when submitting comment to Akismet" do
+      subject { build(:comment) }
+
+      it "has user_role \"guest\"" do
+        expect(subject.akismet_attributes[:user_role]).to eq("guest")
+      end
+    end
   end
 
   context "with an existing comment from the same user" do

spec/models/feedback_spec.rb

@@ -83,4 +83,21 @@
       expect(safe_report.save).to be_truthy
     end
   end
+
+  context "when report is submitted to Akismet" do
+    let(:report) { build(:feedback) }
+
+    it "has comment_type \"contact-form\"" do
+      expect(report.akismet_attributes[:comment_type]).to eq("contact-form")
+    end
+
+    it "has user_role \"user-with-nonmatching-email\" when reporter is logged in" do
+      User.current_user = create(:user)
+      expect(report.akismet_attributes[:user_role]).to eq("user-with-nonmatching-email")
+    end
+
+    it "has user_role \"guest\" when reporter is logged out" do
+      expect(report.akismet_attributes[:user_role]).to eq("guest")
+    end
+  end
 end