actionmailbox 0.1.0

data/test/jobs/incineration_job_test.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class ActionMailbox::IncinerationJobTest < ActiveJob::TestCase
+  setup { @inbound_email = receive_inbound_email_from_fixture("welcome.eml") }
+
+  test "ignoring a missing inbound email" do
+    @inbound_email.destroy!
+
+    perform_enqueued_jobs do
+      assert_nothing_raised do
+        ActionMailbox::IncinerationJob.perform_later @inbound_email
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,54 @@
+ENV["RAILS_ENV"] = "test"
+ENV["RAILS_INBOUND_EMAIL_PASSWORD"] = "tbsy84uSV1Kt3ZJZELY2TmShPRs91E3yL4tzf96297vBCkDWgL"
+
+require_relative "../test/dummy/config/environment"
+ActiveRecord::Migrator.migrations_paths = [File.expand_path("../test/dummy/db/migrate", __dir__)]
+require "rails/test_help"
+
+require "byebug"
+require "webmock/minitest"
+
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new
+
+require "rails/test_unit/reporter"
+Rails::TestUnitReporter.executable = 'bin/test'
+
+if ActiveSupport::TestCase.respond_to?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("fixtures", __dir__)
+  ActionDispatch::IntegrationTest.fixture_path = ActiveSupport::TestCase.fixture_path
+  ActiveSupport::TestCase.file_fixture_path = ActiveSupport::TestCase.fixture_path + "/files"
+  ActiveSupport::TestCase.fixtures :all
+end
+
+require "action_mailbox/test_helper"
+
+class ActiveSupport::TestCase
+  include ActionMailbox::TestHelper, ActiveJob::TestHelper
+end
+
+class ActionDispatch::IntegrationTest
+  private
+    def credentials
+      ActionController::HttpAuthentication::Basic.encode_credentials "actionmailbox", ENV["RAILS_INBOUND_EMAIL_PASSWORD"]
+    end
+
+    def switch_password_to(new_password)
+      previous_password, ENV["RAILS_INBOUND_EMAIL_PASSWORD"] = ENV["RAILS_INBOUND_EMAIL_PASSWORD"], new_password
+      yield
+    ensure
+      ENV["RAILS_INBOUND_EMAIL_PASSWORD"] = previous_password
+    end
+end
+
+if ARGV.include?("-v")
+  ActiveRecord::Base.logger = Logger.new(STDOUT)
+  ActiveJob::Base.logger    = Logger.new(STDOUT)
+end
+
+class BounceMailer < ActionMailer::Base
+  def bounce(to:)
+    mail from: "receiver@example.com", to: to, subject: "Your email was not delivered" do |format|
+      format.html { render plain: "Sorry!" }
+    end
+  end
+end

data/test/unit/inbound_email/incineration_test.rb

@@ -0,0 +1,45 @@
+require_relative '../../test_helper'
+
+class ActionMailbox::InboundEmail::IncinerationTest < ActiveSupport::TestCase
+  test "incinerating 30 days after delivery" do
+    freeze_time
+
+    assert_enqueued_with job: ActionMailbox::IncinerationJob, at: 30.days.from_now do
+      create_inbound_email_from_fixture("welcome.eml").delivered!
+    end
+
+    travel 30.days
+
+    assert_difference -> { ActionMailbox::InboundEmail.count }, -1 do
+      perform_enqueued_jobs only: ActionMailbox::IncinerationJob
+    end
+  end
+
+  test "incinerating 30 days after bounce" do
+    freeze_time
+
+    assert_enqueued_with job: ActionMailbox::IncinerationJob, at: 30.days.from_now do
+      create_inbound_email_from_fixture("welcome.eml").bounced!
+    end
+
+    travel 30.days
+
+    assert_difference -> { ActionMailbox::InboundEmail.count }, -1 do
+      perform_enqueued_jobs only: ActionMailbox::IncinerationJob
+    end
+  end
+
+  test "incinerating 30 days after failure" do
+    freeze_time
+
+    assert_enqueued_with job: ActionMailbox::IncinerationJob, at: 30.days.from_now do
+      create_inbound_email_from_fixture("welcome.eml").failed!
+    end
+
+    travel 30.days
+
+    assert_difference -> { ActionMailbox::InboundEmail.count }, -1 do
+      perform_enqueued_jobs only: ActionMailbox::IncinerationJob
+    end
+  end
+end

data/test/unit/inbound_email/message_id_test.rb

@@ -0,0 +1,13 @@
+require_relative '../../test_helper'
+
+class ActionMailbox::InboundEmail::MessageIdTest < ActiveSupport::TestCase
+  test "message id is extracted from raw email" do
+    inbound_email = create_inbound_email_from_fixture("welcome.eml")
+    assert_equal "0CB459E0-0336-41DA-BC88-E6E28C697DDB@37signals.com", inbound_email.message_id
+  end
+
+  test "message id is generated if its missing" do
+    inbound_email = create_inbound_email_from_source "Date: Fri, 28 Sep 2018 11:08:55 -0700\r\nTo: a@example.com\r\nMime-Version: 1.0\r\nContent-Type: text/plain\r\nContent-Transfer-Encoding: 7bit\r\n\r\nHello!"
+    assert_not_nil inbound_email.message_id
+  end
+end

data/test/unit/inbound_email_test.rb

@@ -0,0 +1,13 @@
+require_relative '../test_helper'
+
+module ActionMailbox
+  class InboundEmailTest < ActiveSupport::TestCase
+    test "mail provides the parsed source" do
+      assert_equal "Discussion: Let's debate these attachments", create_inbound_email_from_fixture("welcome.eml").mail.subject
+    end
+
+    test "source returns the contents of the raw email" do
+      assert_equal file_fixture("welcome.eml").read, create_inbound_email_from_fixture("welcome.eml").source
+    end
+  end
+end

data/test/unit/mail_ext/address_equality_test.rb

@@ -0,0 +1,9 @@
+require_relative '../../test_helper'
+
+module MailExt
+  class AddressEqualityTest < ActiveSupport::TestCase
+    test "two addresses with the same address are equal" do
+      assert_equal Mail::Address.new("david@basecamp.com"), Mail::Address.new("david@basecamp.com")
+    end
+  end
+end

data/test/unit/mail_ext/address_wrapping_test.rb

@@ -0,0 +1,11 @@
+require_relative '../../test_helper'
+
+module MailExt
+  class AddressWrappingTest < ActiveSupport::TestCase
+    test "wrap" do
+      needing_wrapping    = Mail::Address.wrap("david@basecamp.com")
+      wrapping_not_needed = Mail::Address.wrap(Mail::Address.new("david@basecamp.com"))
+      assert_equal needing_wrapping.address, wrapping_not_needed.address
+    end
+  end
+end

data/test/unit/mail_ext/recipients_test.rb

@@ -0,0 +1,33 @@
+require_relative '../../test_helper'
+
+module MailExt
+  class RecipientsTest < ActiveSupport::TestCase
+    setup do
+      @mail = Mail.new \
+        to: "david@basecamp.com",
+        cc: "jason@basecamp.com",
+        bcc: "andrea@basecamp.com",
+        x_original_to: "ryan@basecamp.com"
+    end
+
+    test "recipients include everyone from to, cc, bcc, and x-original-to" do
+      assert_equal %w[ david@basecamp.com jason@basecamp.com andrea@basecamp.com ryan@basecamp.com ], @mail.recipients
+    end
+
+    test "recipients addresses use address objects" do
+      assert_equal "basecamp.com", @mail.recipients_addresses.first.domain
+    end
+
+    test "to addresses use address objects" do
+      assert_equal "basecamp.com", @mail.to_addresses.first.domain
+    end
+
+    test "cc addresses use address objects" do
+      assert_equal "basecamp.com", @mail.cc_addresses.first.domain
+    end
+
+    test "bcc addresses use address objects" do
+      assert_equal "basecamp.com", @mail.bcc_addresses.first.domain
+    end
+  end
+end

data/test/unit/mailbox/bouncing_test.rb

@@ -0,0 +1,29 @@
+require_relative '../../test_helper'
+
+class BouncingWithReplyMailbox < ActionMailbox::Base
+  def process
+    bounce_with BounceMailer.bounce(to: mail.from)
+  end
+end
+
+class ActionMailbox::Base::BouncingTest < ActiveSupport::TestCase
+  include ActionMailer::TestHelper
+
+  setup do
+    @inbound_email = create_inbound_email_from_mail \
+      from: "sender@example.com", to: "replies@example.com", subject: "Bounce me"
+  end
+
+  test "bouncing with a reply" do
+    perform_enqueued_jobs only: ActionMailer::DeliveryJob do
+      BouncingWithReplyMailbox.receive @inbound_email
+    end
+
+    assert @inbound_email.bounced?
+    assert_emails 1
+
+    mail = ActionMailer::Base.deliveries.last
+    assert_equal %w[ sender@example.com ], mail.to
+    assert_equal "Your email was not delivered", mail.subject
+  end
+end

data/test/unit/mailbox/callbacks_test.rb

@@ -0,0 +1,75 @@
+require_relative '../../test_helper'
+
+class CallbackMailbox < ActionMailbox::Base
+  before_processing { $before_processing = "Ran that!" }
+  after_processing  { $after_processing = "Ran that too!" }
+  around_processing ->(r, block) { block.call; $around_processing = "Ran that as well!" }
+
+  def process
+    $processed = mail.subject
+  end
+end
+
+class BouncingCallbackMailbox < ActionMailbox::Base
+  before_processing { $before_processing = [ "Pre-bounce" ] }
+
+  before_processing do
+    bounce_with BounceMailer.bounce(to: mail.from)
+    $before_processing << "Bounce"
+  end
+
+  before_processing { $before_processing << "Post-bounce" }
+
+  after_processing { $after_processing = true }
+
+  def process
+    $processed = true
+  end
+end
+
+class DiscardingCallbackMailbox < ActionMailbox::Base
+  before_processing { $before_processing = [ "Pre-discard" ] }
+
+  before_processing do
+    delivered!
+    $before_processing << "Discard"
+  end
+
+  before_processing { $before_processing << "Post-discard" }
+
+  after_processing { $after_processing = true }
+
+  def process
+    $processed = true
+  end
+end
+
+class ActionMailbox::Base::CallbacksTest < ActiveSupport::TestCase
+  setup do
+    $before_processing = $after_processing = $around_processing = $processed = false
+    @inbound_email = create_inbound_email_from_fixture("welcome.eml")
+  end
+
+  test "all callback types" do
+    CallbackMailbox.receive @inbound_email
+    assert_equal "Ran that!", $before_processing
+    assert_equal "Ran that too!", $after_processing
+    assert_equal "Ran that as well!", $around_processing
+  end
+
+  test "bouncing in a callback terminates processing" do
+    BouncingCallbackMailbox.receive @inbound_email
+    assert @inbound_email.bounced?
+    assert_equal [ "Pre-bounce", "Bounce" ], $before_processing
+    assert_not $processed
+    assert_not $after_processing
+  end
+
+  test "marking the inbound email as delivered in a callback terminates processing" do
+    DiscardingCallbackMailbox.receive @inbound_email
+    assert @inbound_email.delivered?
+    assert_equal [ "Pre-discard", "Discard" ], $before_processing
+    assert_not $processed
+    assert_not $after_processing
+  end
+end

data/test/unit/mailbox/routing_test.rb

@@ -0,0 +1,30 @@
+require_relative '../../test_helper'
+
+class ApplicationMailbox < ActionMailbox::Base
+  routing "replies@example.com" => :replies
+end
+
+class RepliesMailbox < ActionMailbox::Base
+  def process
+    $processed = mail.subject
+  end
+end
+
+class ActionMailbox::Base::RoutingTest < ActiveSupport::TestCase
+  setup do
+    $processed = false
+    @inbound_email = create_inbound_email_from_fixture("welcome.eml")
+  end
+
+  test "string routing" do
+    ApplicationMailbox.route @inbound_email
+    assert_equal "Discussion: Let's debate these attachments", $processed
+  end
+
+  test "delayed routing" do
+    perform_enqueued_jobs only: ActionMailbox::RoutingJob do
+      create_inbound_email_from_fixture "welcome.eml", status: :pending
+      assert_equal "Discussion: Let's debate these attachments", $processed
+    end
+  end
+end

data/test/unit/mailbox/state_test.rb

@@ -0,0 +1,49 @@
+require_relative '../../test_helper'
+
+class SuccessfulMailbox < ActionMailbox::Base
+  def process
+    $processed = mail.subject
+  end
+end
+
+class UnsuccessfulMailbox < ActionMailbox::Base
+  rescue_from(RuntimeError) { $processed = :failure }
+
+  def process
+    raise "No way!"
+  end
+end
+
+class BouncingMailbox < ActionMailbox::Base
+  def process
+    $processed = :bounced
+    bounced!    
+  end
+end
+
+
+class ActionMailbox::Base::StateTest < ActiveSupport::TestCase
+  setup do
+    $processed = false
+    @inbound_email = create_inbound_email_from_mail \
+      to: "replies@example.com", subject: "I was processed"
+  end
+
+  test "successful mailbox processing leaves inbound email in delivered state" do
+    SuccessfulMailbox.receive @inbound_email
+    assert @inbound_email.delivered?
+    assert_equal "I was processed", $processed
+  end
+
+  test "unsuccessful mailbox processing leaves inbound email in failed state" do
+    UnsuccessfulMailbox.receive @inbound_email
+    assert @inbound_email.failed?
+    assert_equal :failure, $processed
+  end
+
+  test "bounced inbound emails are not delivered" do
+    BouncingMailbox.receive @inbound_email
+    assert @inbound_email.bounced?
+    assert_equal :bounced, $processed
+  end
+end

data/test/unit/postfix_relayer_test.rb

@@ -0,0 +1,90 @@
+require_relative '../test_helper'
+
+require 'action_mailbox/postfix_relayer'
+
+module ActionMailbox
+  class PostfixRelayerTest < ActiveSupport::TestCase
+    URL = "https://example.com/rails/action_mailbox/postfix/inbound_emails"
+    INGRESS_PASSWORD = "secret"
+
+    setup do
+      @relayer = ActionMailbox::PostfixRelayer.new(url: URL, password: INGRESS_PASSWORD)
+    end
+
+    test "successfully relaying an email" do
+      stub_request(:post, URL).to_return status: 204
+
+      result = @relayer.relay(file_fixture("welcome.eml").read)
+      assert_equal "2.0.0 Successfully relayed message to Postfix ingress", result.output
+      assert result.success?
+      assert_not result.failure?
+
+      assert_requested :post, URL, body: file_fixture("welcome.eml").read,
+        basic_auth: [ "actionmailbox", INGRESS_PASSWORD ],
+        headers: { "Content-Type" => "message/rfc822", "User-Agent" => /\AAction Mailbox Postfix relayer v\d+\./ }
+    end
+
+    test "unsuccessfully relaying with invalid credentials" do
+      stub_request(:post, URL).to_return status: 401
+
+      result = @relayer.relay(file_fixture("welcome.eml").read)
+      assert_equal "4.7.0 Invalid credentials for Postfix ingress", result.output
+      assert_not result.success?
+      assert result.failure?
+    end
+
+    test "unsuccessfully relaying due to an unspecified server error" do
+      stub_request(:post, URL).to_return status: 500
+
+      result = @relayer.relay(file_fixture("welcome.eml").read)
+      assert_equal "4.0.0 HTTP 500", result.output
+      assert_not result.success?
+      assert result.failure?
+    end
+
+    test "unsuccessfully relaying due to a gateway timeout" do
+      stub_request(:post, URL).to_return status: 504
+
+      result = @relayer.relay(file_fixture("welcome.eml").read)
+      assert_equal "4.0.0 HTTP 504", result.output
+      assert_not result.success?
+      assert result.failure?
+    end
+
+    test "unsuccessfully relaying due to ECONNRESET" do
+      stub_request(:post, URL).to_raise Errno::ECONNRESET.new
+
+      result = @relayer.relay(file_fixture("welcome.eml").read)
+      assert_equal "4.4.2 Network error relaying to Postfix ingress: Connection reset by peer", result.output
+      assert_not result.success?
+      assert result.failure?
+    end
+
+    test "unsuccessfully relaying due to connection failure" do
+      stub_request(:post, URL).to_raise SocketError.new("Failed to open TCP connection to example.com:443")
+
+      result = @relayer.relay(file_fixture("welcome.eml").read)
+      assert_equal "4.4.2 Network error relaying to Postfix ingress: Failed to open TCP connection to example.com:443", result.output
+      assert_not result.success?
+      assert result.failure?
+    end
+
+    test "unsuccessfully relaying due to client-side timeout" do
+      stub_request(:post, URL).to_timeout
+
+      result = @relayer.relay(file_fixture("welcome.eml").read)
+      assert_equal "4.4.2 Timed out relaying to Postfix ingress", result.output
+      assert_not result.success?
+      assert result.failure?
+    end
+
+    test "unsuccessfully relaying due to an unhandled exception" do
+      stub_request(:post, URL).to_raise StandardError.new("Something went wrong")
+
+      result = @relayer.relay(file_fixture("welcome.eml").read)
+      assert_equal "4.0.0 Error relaying to Postfix ingress: Something went wrong", result.output
+      assert_not result.success?
+      assert result.failure?
+    end
+  end
+end