actionmailbox 6.0.1

data/lib/action_mailbox/callbacks.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "active_support/callbacks"
+
+module ActionMailbox
+  # Defines the callbacks related to processing.
+  module Callbacks
+    extend  ActiveSupport::Concern
+    include ActiveSupport::Callbacks
+
+    TERMINATOR = ->(mailbox, chain) do
+      chain.call
+      mailbox.finished_processing?
+    end
+
+    included do
+      define_callbacks :process, terminator: TERMINATOR, skip_after_callbacks_if_terminated: true
+    end
+
+    class_methods do
+      def before_processing(*methods, &block)
+        set_callback(:process, :before, *methods, &block)
+      end
+
+      def after_processing(*methods, &block)
+        set_callback(:process, :after, *methods, &block)
+      end
+
+      def around_processing(*methods, &block)
+        set_callback(:process, :around, *methods, &block)
+      end
+    end
+  end
+end

data/lib/action_mailbox/engine.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "rails"
+require "action_controller/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+require "active_storage/engine"
+
+require "action_mailbox"
+
+module ActionMailbox
+  class Engine < Rails::Engine
+    isolate_namespace ActionMailbox
+    config.eager_load_namespaces << ActionMailbox
+
+    config.action_mailbox = ActiveSupport::OrderedOptions.new
+    config.action_mailbox.incinerate = true
+    config.action_mailbox.incinerate_after = 30.days
+
+    config.action_mailbox.queues = ActiveSupport::InheritableOptions.new \
+      incineration: :action_mailbox_incineration, routing: :action_mailbox_routing
+
+    initializer "action_mailbox.config" do
+      config.after_initialize do |app|
+        ActionMailbox.logger = app.config.action_mailbox.logger || Rails.logger
+        ActionMailbox.incinerate = app.config.action_mailbox.incinerate.nil? ? true : app.config.action_mailbox.incinerate
+        ActionMailbox.incinerate_after = app.config.action_mailbox.incinerate_after || 30.days
+        ActionMailbox.queues = app.config.action_mailbox.queues || {}
+        ActionMailbox.ingress = app.config.action_mailbox.ingress
+      end
+    end
+  end
+end

data/lib/action_mailbox/gem_version.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActionMailbox
+  # Returns the currently-loaded version of Action Mailbox as a <tt>Gem::Version</tt>.
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 6
+    MINOR = 0
+    TINY  = 1
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
+end

data/lib/action_mailbox/mail_ext.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "mail"
+
+# The hope is to upstream most of these basic additions to the Mail gem's Mail object. But until then, here they lay!
+Dir["#{File.expand_path(File.dirname(__FILE__))}/mail_ext/*"].each { |path| require "action_mailbox/mail_ext/#{File.basename(path)}" }

data/lib/action_mailbox/mail_ext/address_equality.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Mail
+  class Address
+    def ==(other_address)
+      other_address.is_a?(Mail::Address) && to_s == other_address.to_s
+    end
+  end
+end

data/lib/action_mailbox/mail_ext/address_wrapping.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Mail
+  class Address
+    def self.wrap(address)
+      address.is_a?(Mail::Address) ? address : Mail::Address.new(address)
+    end
+  end
+end

data/lib/action_mailbox/mail_ext/addresses.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Mail
+  class Message
+    def from_address
+      header[:from]&.address_list&.addresses&.first
+    end
+
+    def recipients_addresses
+      to_addresses + cc_addresses + bcc_addresses + x_original_to_addresses
+    end
+
+    def to_addresses
+      Array(header[:to]&.address_list&.addresses)
+    end
+
+    def cc_addresses
+      Array(header[:cc]&.address_list&.addresses)
+    end
+
+    def bcc_addresses
+      Array(header[:bcc]&.address_list&.addresses)
+    end
+
+    def x_original_to_addresses
+      Array(header[:x_original_to]).collect { |header| Mail::Address.new header.to_s }
+    end
+  end
+end

data/lib/action_mailbox/mail_ext/from_source.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Mail
+  def self.from_source(source)
+    Mail.new Mail::Utilities.binary_unsafe_to_crlf(source.to_s)
+  end
+end

data/lib/action_mailbox/mail_ext/recipients.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Mail
+  class Message
+    def recipients
+      Array(to) + Array(cc) + Array(bcc) + Array(header[:x_original_to]).map(&:to_s)
+    end
+  end
+end

data/lib/action_mailbox/relayer.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "action_mailbox/version"
+require "net/http"
+require "uri"
+
+module ActionMailbox
+  class Relayer
+    class Result < Struct.new(:status_code, :message)
+      def success?
+        !failure?
+      end
+
+      def failure?
+        transient_failure? || permanent_failure?
+      end
+
+      def transient_failure?
+        status_code.start_with?("4.")
+      end
+
+      def permanent_failure?
+        status_code.start_with?("5.")
+      end
+    end
+
+    CONTENT_TYPE = "message/rfc822"
+    USER_AGENT   = "Action Mailbox relayer v#{ActionMailbox.version}"
+
+    attr_reader :uri, :username, :password
+
+    def initialize(url:, username: "actionmailbox", password:)
+      @uri, @username, @password = URI(url), username, password
+    end
+
+    def relay(source)
+      case response = post(source)
+      when Net::HTTPSuccess
+        Result.new "2.0.0", "Successfully relayed message to ingress"
+      when Net::HTTPUnauthorized
+        Result.new "4.7.0", "Invalid credentials for ingress"
+      else
+        Result.new "4.0.0", "HTTP #{response.code}"
+      end
+    rescue IOError, SocketError, SystemCallError => error
+      Result.new "4.4.2", "Network error relaying to ingress: #{error.message}"
+    rescue Timeout::Error
+      Result.new "4.4.2", "Timed out relaying to ingress"
+    rescue => error
+      Result.new "4.0.0", "Error relaying to ingress: #{error.message}"
+    end
+
+    private
+      def post(source)
+        client.post uri, source,
+          "Content-Type"  => CONTENT_TYPE,
+          "User-Agent"    => USER_AGENT,
+          "Authorization" => "Basic #{Base64.strict_encode64(username + ":" + password)}"
+      end
+
+      def client
+        @client ||= Net::HTTP.new(uri.host, uri.port).tap do |connection|
+          if uri.scheme == "https"
+            require "openssl"
+
+            connection.use_ssl     = true
+            connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
+          end
+
+          connection.open_timeout = 1
+          connection.read_timeout = 10
+        end
+      end
+  end
+end

data/lib/action_mailbox/router.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ActionMailbox
+  # Encapsulates the routes that live on the ApplicationMailbox and performs the actual routing when
+  # an inbound_email is received.
+  class Router
+    class RoutingError < StandardError; end
+
+    def initialize
+      @routes = []
+    end
+
+    def add_routes(routes)
+      routes.each do |(address, mailbox_name)|
+        add_route address, to: mailbox_name
+      end
+    end
+
+    def add_route(address, to:)
+      routes.append Route.new(address, to: to)
+    end
+
+    def route(inbound_email)
+      if mailbox = match_to_mailbox(inbound_email)
+        mailbox.receive(inbound_email)
+      else
+        inbound_email.bounced!
+
+        raise RoutingError
+      end
+    end
+
+    private
+      attr_reader :routes
+
+      def match_to_mailbox(inbound_email)
+        routes.detect { |route| route.match?(inbound_email) }.try(:mailbox_class)
+      end
+  end
+end
+
+require "action_mailbox/router/route"

data/lib/action_mailbox/router/route.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ActionMailbox
+  # Encapsulates a route, which can then be matched against an inbound_email and provide a lookup of the matching
+  # mailbox class. See examples for the different route addresses and how to use them in the +ActionMailbox::Base+
+  # documentation.
+  class Router::Route
+    attr_reader :address, :mailbox_name
+
+    def initialize(address, to:)
+      @address, @mailbox_name = address, to
+
+      ensure_valid_address
+    end
+
+    def match?(inbound_email)
+      case address
+      when :all
+        true
+      when String
+        inbound_email.mail.recipients.any? { |recipient| address.casecmp?(recipient) }
+      when Regexp
+        inbound_email.mail.recipients.any? { |recipient| address.match?(recipient) }
+      when Proc
+        address.call(inbound_email)
+      else
+        address.match?(inbound_email)
+      end
+    end
+
+    def mailbox_class
+      "#{mailbox_name.to_s.camelize}Mailbox".constantize
+    end
+
+    private
+      def ensure_valid_address
+        unless [ Symbol, String, Regexp, Proc ].any? { |klass| address.is_a?(klass) } || address.respond_to?(:match?)
+          raise ArgumentError, "Expected a Symbol, String, Regexp, Proc, or matchable, got #{address.inspect}"
+        end
+      end
+  end
+end

data/lib/action_mailbox/routing.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ActionMailbox
+  # See +ActionMailbox::Base+ for how to specify routing.
+  module Routing
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :router, default: ActionMailbox::Router.new
+    end
+
+    class_methods do
+      def routing(routes)
+        router.add_routes(routes)
+      end
+
+      def route(inbound_email)
+        router.route(inbound_email)
+      end
+    end
+  end
+end

data/lib/action_mailbox/test_case.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "action_mailbox/test_helper"
+require "active_support/test_case"
+
+module ActionMailbox
+  class TestCase < ActiveSupport::TestCase
+    include ActionMailbox::TestHelper
+  end
+end
+
+ActiveSupport.run_load_hooks :action_mailbox_test_case, ActionMailbox::TestCase

data/lib/action_mailbox/test_helper.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "mail"
+
+module ActionMailbox
+  module TestHelper
+    # Create an +InboundEmail+ record using an eml fixture in the format of message/rfc822
+    # referenced with +fixture_name+ located in +test/fixtures/files/fixture_name+.
+    def create_inbound_email_from_fixture(fixture_name, status: :processing)
+      create_inbound_email_from_source file_fixture(fixture_name).read, status: status
+    end
+
+    # Create an +InboundEmail+ by specifying it using +Mail.new+ options. Example:
+    #
+    #   create_inbound_email_from_mail(from: "david@loudthinking.com", subject: "Hello!")
+    def create_inbound_email_from_mail(status: :processing, **mail_options)
+      mail = Mail.new(mail_options)
+      # Bcc header is not encoded by default
+      mail[:bcc].include_in_headers = true if mail[:bcc]
+
+      create_inbound_email_from_source mail.to_s, status: status
+    end
+
+    # Create an +InboundEmail+ using the raw rfc822 +source+ as text.
+    def create_inbound_email_from_source(source, status: :processing)
+      ActionMailbox::InboundEmail.create_and_extract_message_id! source, status: status
+    end
+
+
+    # Create an +InboundEmail+ from fixture using the same arguments as +create_inbound_email_from_fixture+
+    # and immediately route it to processing.
+    def receive_inbound_email_from_fixture(*args)
+      create_inbound_email_from_fixture(*args).tap(&:route)
+    end
+
+    # Create an +InboundEmail+ using the same arguments as +create_inbound_email_from_mail+ and immediately route it to
+    # processing.
+    def receive_inbound_email_from_mail(**kwargs)
+      create_inbound_email_from_mail(**kwargs).tap(&:route)
+    end
+
+    # Create an +InboundEmail+ using the same arguments as +create_inbound_email_from_source+ and immediately route it
+    # to processing.
+    def receive_inbound_email_from_source(*args)
+      create_inbound_email_from_source(*args).tap(&:route)
+    end
+  end
+end

data/lib/action_mailbox/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "gem_version"
+
+module ActionMailbox
+  # Returns the currently-loaded version of Action Mailbox as a <tt>Gem::Version</tt>.
+  def self.version
+    gem_version
+  end
+end

data/lib/rails/generators/installer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+say "Copying application_mailbox.rb to app/mailboxes"
+copy_file "#{__dir__}/mailbox/templates/application_mailbox.rb", "app/mailboxes/application_mailbox.rb"
+
+environment <<~end_of_config, env: "production"
+  # Prepare the ingress controller used to receive mail
+  # config.action_mailbox.ingress = :relay
+
+end_of_config

data/lib/rails/generators/mailbox/USAGE

@@ -0,0 +1,12 @@
+Description:
+============
+    Stubs out a new mailbox class in app/mailboxes and invokes your template
+    engine and test framework generators.
+
+Example:
+========
+    rails generate mailbox inbox
+
+    creates a InboxMailbox class and test:
+        Mailbox:  app/mailboxes/inbox_mailbox.rb
+        Test:     test/mailboxes/inbox_mailbox_test.rb