docbrown/spec/mailers/notify_mailer_spec.rb

require "rails_helper"

RSpec.describe NotifyMailer, type: :mailer do
  let(:user)      { create(:user) }
  let(:user2)     { create(:user) }
  let(:article)   { create(:article, user_id: user.id) }
  let(:comment)   { create(:comment, user_id: user.id, commentable: article) }

  describe "#new_reply_email" do
    let(:email) { described_class.with(comment: comment).new_reply_email }

    it "renders proper subject" do
      expected_subject = "#{comment.user.name} replied to your #{comment.parent_type}"
      expect(email.subject).to eq(expected_subject)
    end

    it "renders proper sender" do
      expect(email.from).to eq([SiteConfig.email_addresses[:default]])
      expected_from = "#{SiteConfig.community_name} Community <#{SiteConfig.email_addresses[:default]}>"
      expect(email["from"].value).to eq(expected_from)
    end

    it "renders proper receiver" do
      expect(email.to).to eq([comment.user.email])
    end

    it "includes the tracking pixel" do
      expect(email.html_part.body).to include("open.gif")
    end

    it "includes UTM params" do
      expect(email.html_part.body).to include(CGI.escape("utm_medium=email"))
      expect(email.html_part.body).to include(CGI.escape("utm_source=notify_mailer"))
      expect(email.html_part.body).to include(CGI.escape("utm_campaign=new_reply_email"))
    end
  end

  describe "#new_follower_email" do
    let(:email) { described_class.with(follow: user2.follows.last).new_follower_email }

    before { user2.follow(user) }

    it "renders proper subject" do
      expect(email.subject).to eq("#{user2.name} just followed you on #{SiteConfig.community_name}")
    end

    it "renders proper sender" do
      expect(email.from).to eq([SiteConfig.email_addresses[:default]])
      expected_from = "#{SiteConfig.community_name} Community <#{SiteConfig.email_addresses[:default]}>"
      expect(email["from"].value).to eq(expected_from)
    end

    it "renders proper receiver" do
      expect(email.to).to eq([user.email])
    end

    it "includes the tracking pixel" do
      expect(email.html_part.body).to include("open.gif")
    end

    it "includes UTM params" do
      expect(email.html_part.body).to include(CGI.escape("utm_medium=email"))
      expect(email.html_part.body).to include(CGI.escape("utm_source=notify_mailer"))
      expect(email.html_part.body).to include(CGI.escape("utm_campaign=new_follower_email"))
    end
  end

  describe "#new_mention_email" do
    let(:mention) { create(:mention, user: user2, mentionable: comment) }
    let(:email) { described_class.with(mention: mention).new_mention_email }

    it "renders proper subject" do
      expect(email.subject).to eq("#{comment.user.name} just mentioned you!")
    end

    it "renders proper sender" do
      expect(email.from).to eq([SiteConfig.email_addresses[:default]])
      expected_from = "#{SiteConfig.community_name} Community <#{SiteConfig.email_addresses[:default]}>"
      expect(email["from"].value).to eq(expected_from)
    end

    it "renders proper receiver" do
      expect(email.to).to eq([user2.email])
    end

    it "includes the tracking pixel" do
      expect(email.html_part.body).to include("open.gif")
    end

    it "includes UTM params" do
      expect(email.html_part.body).to include(CGI.escape("utm_medium=email"))
      expect(email.html_part.body).to include(CGI.escape("utm_source=notify_mailer"))
      expect(email.html_part.body).to include(CGI.escape("utm_campaign=new_mention_email"))
    end
  end

  describe "#unread_notifications_email" do
    let(:email) { described_class.with(user: user).unread_notifications_email }

    it "renders proper subject" do
      expect(email.subject).to eq("🔥 You have 0 unread notifications on #{SiteConfig.community_name}")
    end

    it "renders proper sender" do
      expect(email.from).to eq([SiteConfig.email_addresses[:default]])
      expected_from = "#{SiteConfig.community_name} Community <#{SiteConfig.email_addresses[:default]}>"
      expect(email["from"].value).to eq(expected_from)
    end

    it "renders proper receiver" do
      expect(email.to).to eq([user.email])
    end

    it "includes the tracking pixel" do
      expect(email.html_part.body).to include("open.gif")
    end

    it "includes UTM params" do
      expect(email.html_part.body).to include(CGI.escape("utm_medium=email"))
      expect(email.html_part.body).to include(CGI.escape("utm_source=notify_mailer"))
      expect(email.html_part.body).to include(CGI.escape("utm_campaign=unread_notifications_email"))
    end
  end

  describe "#video_upload_complete_email" do
    let(:email) { described_class.with(article: article).video_upload_complete_email }

    it "renders proper subject" do
      expect(email.subject).to eq("Your video upload is complete")
    end

    it "renders proper sender" do
      expect(email.from).to eq([SiteConfig.email_addresses[:default]])
      expected_from = "#{SiteConfig.community_name} Community <#{SiteConfig.email_addresses[:default]}>"
      expect(email["from"].value).to eq(expected_from)
    end

    it "renders proper receiver" do
      expect(email.to).to eq([article.user.email])
    end

    it "includes the tracking pixel" do
      expect(email.html_part.body).to include("open.gif")
    end

    it "includes UTM params" do
      expect(email.html_part.body).to include(CGI.escape("utm_medium=email"))
      expect(email.html_part.body).to include(CGI.escape("utm_source=notify_mailer"))
      expect(email.html_part.body).to include(CGI.escape("utm_campaign=video_upload_complete_email"))
    end
  end

  describe "#new_badge_email" do
    let(:badge) { create(:badge) }
    let(:badge_achievement) { create_badge_achievement(user, badge, user2) }
    let(:email) { described_class.with(badge_achievement: badge_achievement).new_badge_email }

    def create_badge_achievement(user, badge, rewarder)
      BadgeAchievement.create(
        user: user,
        badge: badge,
        rewarder: rewarder,
        rewarding_context_message_markdown: "Hello [Yoho](/hey)",
      )
    end

    it "renders proper subject" do
      expect(email.subject).to eq("You just got a badge")
    end

    it "renders proper sender" do
      expect(email.from).to eq([SiteConfig.email_addresses[:default]])
      expected_from = "#{SiteConfig.community_name} Community <#{SiteConfig.email_addresses[:default]}>"
      expect(email["from"].value).to eq(expected_from)
    end

    it "renders proper receiver" do
      expect(email.to).to eq([user.email])
    end

    context "when rendering the HTML email" do
      it "includes the tracking pixel" do
        expect(email.html_part.body).to include("open.gif")
      end

      it "includes UTM params" do
        expect(email.html_part.body).to include(CGI.escape("utm_medium=email"))
        expect(email.html_part.body).to include(CGI.escape("utm_source=notify_mailer"))
        expect(email.html_part.body).to include(CGI.escape("utm_campaign=new_badge_email"))
      end

      it "includes the user URL" do
        expect(email.html_part.body).to include(CGI.escape(URL.user(user)))
      end

      it "includes the listings URL" do
        expect(email.html_part.body).to include(
          CGI.escape(
            Rails.application.routes.url_helpers.listings_url(host: SiteConfig.app_domain),
          ),
        )
      end

      it "includes the about listings URL" do
        expect(email.html_part.body).to include(
          CGI.escape(Rails.application.routes.url_helpers.about_listings_url(host: SiteConfig.app_domain)),
        )
      end

      it "includes the rewarding_context_message in the email" do
        expect(email.html_part.body).to include("Hello <a")
        expect(email.html_part.body).to include(CGI.escape(URL.url("/hey")))
      end

      it "does not include the nil rewarding_context_message in the email" do
        allow(badge_achievement).to receive(:rewarding_context_message).and_return(nil)

        expect(email.html_part.body).not_to include("Hello <a")
        expect(email.html_part.body).not_to include(CGI.escape(URL.url("/hey")))
      end

      it "does not include the empty rewarding_context_message in the email" do
        allow(badge_achievement).to receive(:rewarding_context_message).and_return("")

        expect(email.html_part.body).not_to include("Hello <a")
        expect(email.html_part.body).not_to include(CGI.escape(URL.url("/hey")))
      end
    end

    context "when rendering the text email" do
      it "includes the user URL" do
        expect(email.text_part.body).to include(URL.user(user))
      end

      it "includes the listings URL" do
        expect(email.text_part.body).to include(
          Rails.application.routes.url_helpers.listings_url(host: SiteConfig.app_domain),
        )
      end

      it "includes the about listings URL" do
        expect(email.text_part.body).to include(
          Rails.application.routes.url_helpers.about_listings_url(host: SiteConfig.app_domain),
        )
      end

      it "includes the rewarding_context_message in the email" do
        expect(email.text_part.body).to include("Hello Yoho")
        expect(email.text_part.body).not_to include(URL.url("/hey"))
      end

      it "does not include the nil rewarding_context_message in the email" do
        allow(badge_achievement).to receive(:rewarding_context_message).and_return(nil)

        expect(email.text_part.body).not_to include("Hello Yoho")
        expect(email.text_part.body).not_to include(URL.url("/hey"))
      end

      it "does not include the empty rewarding_context_message in the email" do
        allow(badge_achievement).to receive(:rewarding_context_message).and_return("")

        expect(email.text_part.body).not_to include("Hello Yoho")
        expect(email.text_part.body).not_to include(URL.url("/hey"))
      end
    end
  end

  describe "#feedback_message_resolution_email" do
    let(:feedback_message) { create(:feedback_message, :abuse_report, reporter_id: user.id) }
    let(:email_params) do
      {
        email_to: user.email,
        email_subject: "#{SiteConfig.community_name} Report Status Update",
        email_body: "You've violated our code of conduct",
        email_type: "Reporter",
        feedback_message_id: feedback_message.id
      }
    end
    let(:email) { described_class.with(email_params).feedback_message_resolution_email }

    it "renders proper subject" do
      expect(email.subject).to eq("#{SiteConfig.community_name} Report Status Update")
    end

    it "renders proper sender" do
      expect(email.from).to eq([SiteConfig.email_addresses[:default]])
      expected_from = "#{SiteConfig.community_name} Community <#{SiteConfig.email_addresses[:default]}>"
      expect(email["from"].value).to eq(expected_from)
    end

    it "renders proper receiver" do
      expect(email.to).to eq([user.email])
    end

    it "includes the tracking pixel" do
      expect(email.html_part.body).to include("open.gif")
    end

    it "includes UTM params" do
      expect(email.html_part.body).to include(CGI.escape("utm_medium=email"))
      expect(email.html_part.body).to include(CGI.escape("utm_source=notify_mailer"))
      expect(email.html_part.body).to include(CGI.escape("utm_campaign=#{email_params[:email_type]}"))
    end

    it "tracks the feedback message ID after delivery" do
      assert_emails 1 do
        email.deliver_now
      end

      expect(user.email_messages.last.feedback_message_id).to eq(feedback_message.id)
    end
  end

  describe "#user_contact_email" do
    let(:email_params) do
      {
        user_id: user.id,
        email_subject: "Buddy",
        email_body: "Laugh with me, buddy"
      }
    end
    let(:email) { described_class.with(email_params).user_contact_email }

    it "renders proper subject" do
      expect(email.subject).to eq("Buddy")
    end

    it "renders proper sender" do
      expect(email.from).to eq([SiteConfig.email_addresses[:default]])
      expected_from = "#{SiteConfig.community_name} Community <#{SiteConfig.email_addresses[:default]}>"
      expect(email["from"].value).to eq(expected_from)
    end

    it "renders proper receiver" do
      expect(email.to).to eq([user.email])
    end

    it "includes the tracking pixel" do
      expect(email.html_part.body).to include("open.gif")
    end

    it "includes UTM params" do
      expect(email.html_part.body).to include(CGI.escape("utm_campaign=user_contact"))
    end
  end

  describe "#new_message_email" do
    let(:direct_channel) { ChatChannels::CreateWithUsers.call(users: [user, user2], channel_type: "direct") }
    let(:direct_message) { create(:message, user: user, chat_channel: direct_channel) }
    let(:email) { described_class.with(message: direct_message).new_message_email }

    it "renders proper subject" do
      expect(email.subject).to eq("#{user.name} just messaged you")
    end

    it "renders proper sender" do
      expect(email.from).to eq([SiteConfig.email_addresses[:default]])
      expected_from = "#{SiteConfig.community_name} Community <#{SiteConfig.email_addresses[:default]}>"
      expect(email["from"].value).to eq(expected_from)
    end

    it "renders proper receiver" do
      expect(email.to).to eq([direct_message.direct_receiver.email])
    end

    it "includes the tracking pixel" do
      expect(email.html_part.body).to include("open.gif")
    end

    it "includes UTM params" do
      expect(email.html_part.body).to include(CGI.escape("utm_medium=email"))
      expect(email.html_part.body).to include(CGI.escape("utm_source=notify_mailer"))
      expect(email.html_part.body).to include(CGI.escape("utm_campaign=new_message_email"))
    end
  end

  describe "#account_deleted_email" do
    let(:email) { described_class.with(name: user.name, email: user.email).account_deleted_email }

    it "renders proper subject" do
      expect(email.subject).to eq("#{SiteConfig.community_name} - Account Deletion Confirmation")
    end

    it "renders proper sender" do
      expect(email.from).to eq([SiteConfig.email_addresses[:default]])
      expected_from = "#{SiteConfig.community_name} Community <#{SiteConfig.email_addresses[:default]}>"
      expect(email["from"].value).to eq(expected_from)
    end

    it "renders proper receiver" do
      expect(email.to).to eq([user.email])
    end

    it "includes the tracking pixel" do
      expect(email.html_part.body).to include("open.gif")
    end

    it "does not include UTM params" do
      expect(email.html_part.body).not_to include(CGI.escape("utm_medium=email"))
      expect(email.html_part.body).not_to include(CGI.escape("utm_source=notify_mailer"))
      expect(email.html_part.body).not_to include(CGI.escape("utm_campaign=account_deleted_email"))
    end
  end

  describe "#export_email" do
    let(:email) { described_class.with(email: user.email, attachment: "attachment").export_email }

    it "renders proper subject" do
      expect(email.subject).to include("export of your content is ready")
    end

    it "renders proper sender" do
      expect(email.from).to eq([SiteConfig.email_addresses[:default]])
      expected_from = "#{SiteConfig.community_name} Community <#{SiteConfig.email_addresses[:default]}>"
      expect(email["from"].value).to eq(expected_from)
    end

    it "renders proper receiver" do
      expect(email.to).to eq([user.email])
    end

    it "attaches a zip file" do
      expect(email.attachments[0].content_type).to include("application/zip")
    end

    it "adds the correct filename" do
      expected_filename = "devto-export-#{Date.current.iso8601}.zip"
      expect(email.attachments[0].filename).to eq(expected_filename)
    end

    it "includes the tracking pixel" do
      expect(email.html_part.body).to include("open.gif")
    end
  end

  describe "#tag_moderator_confirmation_email" do
    let(:tag) { create(:tag) }
    let(:email) do
      described_class.with(user: user, tag: tag, channel_slug: "javascript-4l67").tag_moderator_confirmation_email
    end

    it "renders proper subject" do
      expect(email.subject).to eq("Congrats! You're the moderator for ##{tag.name}")
    end

    it "renders proper sender" do
      expect(email.from).to eq([SiteConfig.email_addresses[:default]])
      expected_from = "#{SiteConfig.community_name} Community <#{SiteConfig.email_addresses[:default]}>"
      expect(email["from"].value).to eq(expected_from)
    end

    it "renders proper receiver" do
      expect(email.to).to eq([user.email])
    end

    it "includes the tracking pixel" do
      expect(email.html_part.body).to include("open.gif")
    end

    it "includes UTM params" do
      expect(email.html_part.body).to include(CGI.escape("utm_medium=email"))
      expect(email.html_part.body).to include(CGI.escape("utm_source=notify_mailer"))
      expect(email.html_part.body).to include(CGI.escape("utm_campaign=tag_moderator_confirmation_email"))
    end
  end

  describe "#trusted_role_email" do
    let(:tag) { create(:tag) }
    let(:email) { described_class.with(user: user).trusted_role_email }

    it "renders proper subject" do
      expected_subject = "You've been upgraded to #{SiteConfig.community_name} Community mod status!"
      expect(email.subject).to eq(expected_subject)
    end

    it "renders proper sender" do
      expect(email.from).to eq([SiteConfig.email_addresses[:default]])
      expected_from = "#{SiteConfig.community_name} Community <#{SiteConfig.email_addresses[:default]}>"
      expect(email["from"].value).to eq(expected_from)
    end

    it "renders proper receiver" do
      expect(email.to).to eq([user.email])
    end

    it "includes the tracking pixel" do
      expect(email.html_part.body).to include("open.gif")
    end

    it "includes UTM params" do
      expect(email.html_part.body).to include(CGI.escape("utm_medium=email"))
      expect(email.html_part.body).to include(CGI.escape("utm_source=notify_mailer"))
      expect(email.html_part.body).to include(CGI.escape("utm_campaign=trusted_role_email"))
    end
  end

  describe "#channel_invite_email" do
    let(:moderator_membership) { create(:chat_channel_membership, user_id: user2.id, role: "mod") }
    let(:regular_membership) { create(:chat_channel_membership, user_id: user2.id, role: "member") }
    let(:moderator_email) { described_class.with(membership: moderator_membership, inviter: nil).channel_invite_email }
    let(:member_email) { described_class.with(membership: regular_membership, inviter: user).channel_invite_email }

    it "renders proper subject" do
      mod_subject = "You are invited to the #{moderator_membership.chat_channel.channel_name} channel as moderator."
      expect(moderator_email.subject).to eq(mod_subject)

      member_subject = "You are invited to the #{regular_membership.chat_channel.channel_name} channel."
      expect(member_email.subject).to eq(member_subject)
    end

    it "renders proper sender" do
      expected_from = "#{SiteConfig.community_name} Community <#{SiteConfig.email_addresses[:default]}>"

      expect(moderator_email.from).to eq([SiteConfig.email_addresses[:default]])
      expect(moderator_email["from"].value).to eq(expected_from)

      expect(member_email.from).to eq([SiteConfig.email_addresses[:default]])
      expect(member_email["from"].value).to eq(expected_from)
    end

    it "renders proper receiver" do
      expect(moderator_email.to).to eq([user2.email])
      expect(member_email.to).to eq([user2.email])
    end
  end
end