actionmailbox 6.0.0.beta1

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,44 @@
+# 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)
+      create_inbound_email_from_source Mail.new(mail_options).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+ from fixture 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+ from fixture using the same arguments as +create_inbound_email_from_source+
+    # and immediately route it to processing.
+    def receive_inbound_email_from_source(**kwargs)
+      create_inbound_email_from_source(**kwargs).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 = :amazon
+
+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

data/lib/rails/generators/mailbox/mailbox_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Rails
+  module Generators
+    class MailboxGenerator < NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      check_class_collision suffix: "Mailbox"
+
+      def create_mailbox_file
+        template "mailbox.rb", File.join("app/mailboxes", class_path, "#{file_name}_mailbox.rb")
+
+        in_root do
+          if behavior == :invoke && !File.exist?(application_mailbox_file_name)
+            template "application_mailbox.rb", application_mailbox_file_name
+          end
+        end
+      end
+
+      hook_for :test_framework
+
+      private
+        def file_name # :doc:
+          @_file_name ||= super.sub(/_mailbox\z/i, "")
+        end
+
+        def application_mailbox_file_name
+          "app/mailboxes/application_mailbox.rb"
+        end
+    end
+  end
+end

data/lib/rails/generators/mailbox/templates/application_mailbox.rb.tt

@@ -0,0 +1,3 @@
+class ApplicationMailbox < ActionMailbox::Base
+  # routing /something/i => :somewhere
+end

data/lib/rails/generators/mailbox/templates/mailbox.rb.tt

@@ -0,0 +1,4 @@
+class <%= class_name %>Mailbox < ApplicationMailbox
+  def process
+  end
+end

data/lib/rails/generators/test_unit/mailbox_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module TestUnit
+  module Generators
+    class MailboxGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      check_class_collision suffix: "MailboxTest"
+
+      def create_test_files
+        template "mailbox_test.rb", File.join("test/mailboxes", class_path, "#{file_name}_mailbox_test.rb")
+      end
+
+      private
+        def file_name # :doc:
+          @_file_name ||= super.sub(/_mailbox\z/i, "")
+        end
+    end
+  end
+end

data/lib/rails/generators/test_unit/templates/mailbox_test.rb.tt

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class <%= class_name %>MailboxTest < ActionMailbox::TestCase
+  # test "receive mail" do
+  #   receive_inbound_email_from_mail \
+  #     to: '"someone" <someone@example.com>',
+  #     from: '"else" <else@example.com>',
+  #     subject: "Hello world!",
+  #     body: "Hello?"
+  # end
+end

data/lib/tasks/ingress.rake

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+namespace :action_mailbox do
+  namespace :ingress do
+    task :environment do
+      require "active_support"
+      require "active_support/core_ext/object/blank"
+      require "action_mailbox/relayer"
+    end
+
+    desc "Relay an inbound email from Exim to Action Mailbox (URL and INGRESS_PASSWORD required)"
+    task exim: "action_mailbox:ingress:environment" do
+      url, password = ENV.values_at("URL", "INGRESS_PASSWORD")
+
+      if url.blank? || password.blank?
+        print "URL and INGRESS_PASSWORD are required"
+        exit 64 # EX_USAGE
+      end
+
+      ActionMailbox::Relayer.new(url: url, password: password).relay(STDIN.read).tap do |result|
+        print result.message
+
+        case
+        when result.success?
+          exit 0
+        when result.transient_failure?
+          exit 75 # EX_TEMPFAIL
+        else
+          exit 69 # EX_UNAVAILABLE
+        end
+      end
+    end
+
+    desc "Relay an inbound email from Postfix to Action Mailbox (URL and INGRESS_PASSWORD required)"
+    task postfix: "action_mailbox:ingress:environment" do
+      url, password = ENV.values_at("URL", "INGRESS_PASSWORD")
+
+      if url.blank? || password.blank?
+        print "4.3.5 URL and INGRESS_PASSWORD are required"
+        exit 1
+      end
+
+      ActionMailbox::Relayer.new(url: url, password: password).relay(STDIN.read).tap do |result|
+        print "#{result.status_code} #{result.message}"
+        exit result.success?
+      end
+    end
+
+    desc "Relay an inbound email from Qmail to Action Mailbox (URL and INGRESS_PASSWORD required)"
+    task qmail: "action_mailbox:ingress:environment" do
+      url, password = ENV.values_at("URL", "INGRESS_PASSWORD")
+
+      if url.blank? || password.blank?
+        print "URL and INGRESS_PASSWORD are required"
+        exit 111
+      end
+
+      ActionMailbox::Relayer.new(url: url, password: password).relay(STDIN.read).tap do |result|
+        print result.message
+
+        case
+        when result.success?
+          exit 0
+        when result.transient_failure?
+          exit 111
+        else
+          exit 100
+        end
+      end
+    end
+  end
+end

data/lib/tasks/install.rake

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+namespace :action_mailbox do
+  # Prevent migration installation task from showing up twice.
+  Rake::Task["install:migrations"].clear_comments
+
+  desc "Copy over the migration"
+  task install: %w[ environment run_installer copy_migrations ]
+
+  task :run_installer do
+    installer_template = File.expand_path("../rails/generators/installer.rb", __dir__)
+    system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{installer_template}"
+  end
+
+  task :copy_migrations do
+    Rake::Task["active_storage:install:migrations"].invoke
+    Rake::Task["railties:install:migrations"].reenable # Otherwise you can't run 2 migration copy tasks in one invocation
+    Rake::Task["action_mailbox:install:migrations"].invoke
+  end
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: actionmailbox
+version: !ruby/object:Gem::Version
+  version: 6.0.0.beta1
+platform: ruby
+authors:
+- David Heinemeier Hansson
+- George Claghorn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.0.beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.0.beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: activestorage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.0.beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.0.beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.0.beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+description: Receive and process incoming emails in Rails applications.
+email:
+- david@loudthinking.com
+- george@basecamp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- app/controllers/action_mailbox/base_controller.rb
+- app/controllers/action_mailbox/ingresses/amazon/inbound_emails_controller.rb
+- app/controllers/action_mailbox/ingresses/mailgun/inbound_emails_controller.rb
+- app/controllers/action_mailbox/ingresses/mandrill/inbound_emails_controller.rb
+- app/controllers/action_mailbox/ingresses/postmark/inbound_emails_controller.rb
+- app/controllers/action_mailbox/ingresses/relay/inbound_emails_controller.rb
+- app/controllers/action_mailbox/ingresses/sendgrid/inbound_emails_controller.rb
+- app/controllers/rails/conductor/action_mailbox/inbound_emails_controller.rb
+- app/controllers/rails/conductor/action_mailbox/reroutes_controller.rb
+- app/controllers/rails/conductor/base_controller.rb
+- app/jobs/action_mailbox/incineration_job.rb
+- app/jobs/action_mailbox/routing_job.rb
+- app/models/action_mailbox/inbound_email.rb
+- app/models/action_mailbox/inbound_email/incineratable.rb
+- app/models/action_mailbox/inbound_email/incineratable/incineration.rb
+- app/models/action_mailbox/inbound_email/message_id.rb
+- app/models/action_mailbox/inbound_email/routable.rb
+- app/views/layouts/rails/conductor.html.erb
+- app/views/rails/conductor/action_mailbox/inbound_emails/index.html.erb
+- app/views/rails/conductor/action_mailbox/inbound_emails/new.html.erb
+- app/views/rails/conductor/action_mailbox/inbound_emails/show.html.erb
+- config/routes.rb
+- db/migrate/20180917164000_create_action_mailbox_tables.rb
+- lib/action_mailbox.rb
+- lib/action_mailbox/base.rb
+- lib/action_mailbox/callbacks.rb
+- lib/action_mailbox/engine.rb
+- lib/action_mailbox/gem_version.rb
+- lib/action_mailbox/mail_ext.rb
+- lib/action_mailbox/mail_ext/address_equality.rb
+- lib/action_mailbox/mail_ext/address_wrapping.rb
+- lib/action_mailbox/mail_ext/addresses.rb
+- lib/action_mailbox/mail_ext/from_source.rb
+- lib/action_mailbox/mail_ext/recipients.rb
+- lib/action_mailbox/relayer.rb
+- lib/action_mailbox/router.rb
+- lib/action_mailbox/router/route.rb
+- lib/action_mailbox/routing.rb
+- lib/action_mailbox/test_case.rb
+- lib/action_mailbox/test_helper.rb
+- lib/action_mailbox/version.rb
+- lib/rails/generators/installer.rb
+- lib/rails/generators/mailbox/USAGE
+- lib/rails/generators/mailbox/mailbox_generator.rb
+- lib/rails/generators/mailbox/templates/application_mailbox.rb.tt
+- lib/rails/generators/mailbox/templates/mailbox.rb.tt
+- lib/rails/generators/test_unit/mailbox_generator.rb
+- lib/rails/generators/test_unit/templates/mailbox_test.rb.tt
+- lib/tasks/ingress.rake
+- lib/tasks/install.rake
+homepage: https://rubyonrails.org
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/rails/rails/tree/v6.0.0.beta1/actionmailbox
+  changelog_uri: https://github.com/rails/rails/blob/v6.0.0.beta1/actionmailbox/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Inbound email handling framework.
+test_files: []