action_mailbox_amazon_ingress 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f08bddaffb7a4483d75df3c8bf6daebdd58cbb6673f9d8edb02b0fa3f881edc1
+  data.tar.gz: a32fc9ffaa109603235667fa7169625d149db1aafbc6b8179625edca204f69e2
+SHA512:
+  metadata.gz: 24e5461c1e6c24b192f312d1384a4d5f863da866a769575361c380150129c05a0d28d7b7d6c7624fa7f01a2fa4ee8db70cbe080e26e13b3cb6469fb6aeb47777
+  data.tar.gz: 22d1eff8e7cc534adbf9b2333189797546cde4f177dc172cb66a45f6cf37da01751deb082e1e21f2dfebbbc3a352f2c8c1fbdaaccfe46273104dbe82fd653311

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+spec/support/dummy/tmp/*
+spec/support/dummy/log/*
+spec/support/dummy/db/*
+
+Gemfile.lock
+
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,32 @@
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Exclude:
+    - 'db/migrate/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'db/migrate/**/*.rb'
+    - 'vendor/**/*'
+    - 'spec/support/dummy/**/*'
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Bob Farrell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,4 @@
+all:
+	bundle exec rspec
+	bundle exec rubocop
+	bundle exec strong_versions

data/README.md

@@ -0,0 +1,62 @@
+# ActionMailboxAmazonIngress
+
+Provides _Amazon SES/SNS_ integration with [_Rails ActionMailbox_](https://guides.rubyonrails.org/action_mailbox_basics.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action_mailbox_amazon_ingress', '~> 0.1.0'
+```
+
+## Configuration
+
+### Amazon SES/SNS
+
+Configure _SES_ to [route emails through SNS](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-sns-notifications.html).
+
+If your website is hosted at https://www.example.com then configure _SNS_ to publish the _SES_ notification topic to this _HTTP_ endpoint:
+
+https://example.com/rails/action_mailbox/amazon/inbound_emails
+
+### Rails
+
+Configure _ActionMailbox_ to accept emails from Amazon SES:
+
+```
+# config/environments/production.rb
+config.action_mailbox.ingress = :amazon
+```
+
+Configure which _SNS_ topics will be accepted:
+
+```
+# config/environments/production.rb
+config.action_mailbox.amazon.subscribed_topics = %w(
+  arn:aws:sns:eu-west-1:123456789001:example-topic-1
+  arn:aws:sns:us-east-1:123456789002:example-topic-2
+)
+```
+
+Subscriptions will now be auto-confirmed and messages will be delivered via _ActionMailbox_.
+
+Note that even if you manually confirm subscriptions you will still need to provide a list of subscribed topics; messages from unrecognized topics will be ignored.
+
+See [ActionMailbox documentation](https://guides.rubyonrails.org/action_mailbox_basics.html) for full usage information.
+
+## Development
+
+Ensure _Rubocop_, _RSpec_, and _StrongVersions_ compliance by running `make`:
+
+```
+make
+```
+
+## Contributing
+
+Pull requests are welcome.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/action_mailbox_amazon_ingress.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_mailbox_amazon_ingress/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'action_mailbox_amazon_ingress'
+  spec.version       = ActionMailboxAmazonIngress::VERSION
+  spec.authors       = ['Bob Farrell']
+  spec.email         = ['git@bob.frl']
+
+  spec.summary       = 'Amazon SES ingress for Rails ActionMailbox'
+  spec.description   = 'Integrate Amazon SES with ActionMailbox'
+  spec.homepage      = 'https://github.com/bobf/action_mailbox_amazon_ingress'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = []
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'aws-sdk-sns', '~> 1.23'
+  spec.add_dependency 'rails', '~> 6.0'
+
+  spec.add_development_dependency 'betterp', '~> 0.1.3'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec-rails', '~> 4.0'
+  spec.add_development_dependency 'rubocop', '~> 0.82.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.4'
+  spec.add_development_dependency 'strong_versions', '~> 0.4.3'
+  spec.add_development_dependency 'webmock', '~> 3.8'
+end

data/app/controllers/action_mailbox/ingresses/amazon/inbound_emails_controller.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+# rubocop:disable Layout/LineLength
+module ActionMailbox
+  # Ingests inbound emails from Amazon SES/SNS and confirms subscriptions.
+  #
+  # Subscription requests must provide the following parameters in a JSON body:
+  # - +Message+: Notification content
+  # - +MessagId+: Notification unique identifier
+  # - +Timestamp+: iso8601 timestamp
+  # - +TopicArn+: Topic identifier
+  # - +Type+: Type of event ("Subscription")
+  #
+  # Inbound email events must provide the following parameters in a JSON body:
+  # - +Message+: Notification content
+  # - +MessagId+: Notification unique identifier
+  # - +Timestamp+: iso8601 timestamp
+  # - +SubscribeURL+: Topic identifier
+  # - +TopicArn+: Topic identifier
+  # - +Type+: Type of event ("SubscriptionConfirmation")
+  #
+  # All requests are authenticated by validating the provided AWS signature.
+  #
+  # Returns:
+  #
+  # - <tt>204 No Content</tt> if a request is successfully processed
+  # - <tt>401 Unauthorized</tt> if a request does not contain a valid signature
+  # - <tt>404 Not Found</tt> if the Amazon ingress has not been configured
+  # - <tt>422 Unprocessable Entity</tt> if a request provides invalid parameters
+  #
+  # == Usage
+  #
+  # 1. Tell Action Mailbox to accept emails from Amazon SES:
+  #
+  #        # config/environments/production.rb
+  #        config.action_mailbox.ingress = :amazon
+  #
+  # 2. Configure which SNS topics will be accepted:
+  #
+  #        config.action_mailbox.amazon.subscribed_topics = %w(
+  #          arn:aws:sns:eu-west-1:123456789001:example-topic-1
+  #          arn:aws:sns:us-east-1:123456789002:example-topic-2
+  #        )
+  #
+  # 3. {Configure SES}[https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-notifications.html]
+  #    to route emails through SNS.
+  #
+  #    Configure SNS to send emails to +/rails/action_mailbox/amazon/inbound_emails+.
+  #
+  #    If your application is found at <tt>https://example.com</tt> you would
+  #    specify the fully-qualified URL <tt>https://example.com/rails/action_mailbox/amazon/inbound_emails</tt>.
+  #
+  # rubocop:enable Layout/LineLength
+  module Ingresses
+    module Amazon
+      class InboundEmailsController < ActionMailbox::BaseController
+        before_action :verify_authenticity
+        before_action :validate_topic
+        before_action :confirm_subscription
+
+        def create
+          head :bad_request unless mail.present?
+
+          ActionMailbox::InboundEmail.create_and_extract_message_id!(mail)
+          head :no_content
+        end
+
+        private
+
+        def verify_authenticity
+          head :bad_request unless notification.present?
+          head :unauthorized unless verified?
+        end
+
+        def confirm_subscription
+          return unless notification['Type'] == 'SubscriptionConfirmation'
+          return head :ok if confirmation_response_code&.start_with?('2')
+
+          Rails.logger.error('SNS subscription confirmation request rejected.')
+          head :unprocessable_entity
+        end
+
+        def validate_topic
+          return if valid_topics.include?(topic)
+
+          Rails.logger.warn("Ignoring unknown topic: #{topic}")
+          head :unauthorized
+        end
+
+        def confirmation_response_code
+          @confirmation_response_code ||= begin
+            Net::HTTP.get_response(URI(notification['SubscribeURL'])).code
+          end
+        end
+
+        def notification
+          @notification ||= JSON.parse(request.body.read)
+        rescue JSON::ParserError => e
+          Rails.logger.warn("Unable to parse SNS notification: #{e}")
+          nil
+        end
+
+        def verified?
+          verifier.authentic?(@notification.to_json)
+        end
+
+        def verifier
+          Aws::SNS::MessageVerifier.new
+        end
+
+        def message
+          @message ||= JSON.parse(notification['Message'])
+        end
+
+        def mail
+          return nil unless notification['Type'] == 'Notification'
+          return nil unless message['notificationType'] == 'Received'
+
+          message['content']
+        end
+
+        def topic
+          return nil unless notification.present?
+
+          notification['TopicArn']
+        end
+
+        def valid_topics
+          ::Rails.configuration.action_mailbox.amazon.subscribed_topics
+        end
+      end
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "action_mailbox_amazon_ingress"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  scope '/rails/action_mailbox', module: 'action_mailbox/ingresses' do
+    post '/amazon/inbound_emails' => 'amazon/inbound_emails#create',
+         as: :rails_amazon_inbound_emails
+  end
+end

data/db/migrate/20200508151055_create_active_storage_tables.active_storage.rb

@@ -0,0 +1,27 @@
+# This migration comes from active_storage (originally 20170806125915)
+class CreateActiveStorageTables < ActiveRecord::Migration[5.2]
+  def change
+    create_table :active_storage_blobs do |t|
+      t.string   :key,        null: false
+      t.string   :filename,   null: false
+      t.string   :content_type
+      t.text     :metadata
+      t.bigint   :byte_size,  null: false
+      t.string   :checksum,   null: false
+      t.datetime :created_at, null: false
+
+      t.index [ :key ], unique: true
+    end
+
+    create_table :active_storage_attachments do |t|
+      t.string     :name,     null: false
+      t.references :record,   null: false, polymorphic: true, index: false
+      t.references :blob,     null: false
+
+      t.datetime :created_at, null: false
+
+      t.index [ :record_type, :record_id, :name, :blob_id ], name: "index_active_storage_attachments_uniqueness", unique: true
+      t.foreign_key :active_storage_blobs, column: :blob_id
+    end
+  end
+end

data/db/migrate/20200508151056_create_action_mailbox_tables.action_mailbox.rb

@@ -0,0 +1,14 @@
+# This migration comes from action_mailbox (originally 20180917164000)
+class CreateActionMailboxTables < ActiveRecord::Migration[6.0]
+  def change
+    create_table :action_mailbox_inbound_emails do |t|
+      t.integer :status, default: 0, null: false
+      t.string  :message_id, null: false
+      t.string  :message_checksum, null: false
+
+      t.timestamps
+
+      t.index [ :message_id, :message_checksum ], name: "index_action_mailbox_inbound_emails_uniqueness", unique: true
+    end
+  end
+end

data/lib/action_mailbox_amazon_ingress.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'net/http'
+require 'rails'
+require 'action_mailbox/engine'
+require 'aws-sdk-sns'
+
+require 'action_mailbox_amazon_ingress/engine'
+require 'action_mailbox_amazon_ingress/version'
+
+module ActionMailboxAmazonIngress
+  class Error < StandardError; end
+
+  def self.root
+    Pathname.new(File.expand_path(File.join(__dir__, '..')))
+  end
+end

data/lib/action_mailbox_amazon_ingress/engine.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ActionMailboxAmazonIngress
+  class Engine < ::Rails::Engine
+    config.action_mailbox.amazon = ActiveSupport::OrderedOptions.new
+    initializer 'action_mailbox_amazon_ingress.mount_engine' do |app|
+      app.routes.append do
+        mount Engine => '/'
+      end
+    end
+  end
+end

data/lib/action_mailbox_amazon_ingress/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActionMailboxAmazonIngress
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: action_mailbox_amazon_ingress
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bob Farrell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sns
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: betterp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: strong_versions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: Integrate Amazon SES with ActionMailbox
+email:
+- git@bob.frl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- action_mailbox_amazon_ingress.gemspec
+- app/controllers/action_mailbox/ingresses/amazon/inbound_emails_controller.rb
+- bin/console
+- bin/setup
+- config/routes.rb
+- db/migrate/20200508151055_create_active_storage_tables.active_storage.rb
+- db/migrate/20200508151056_create_action_mailbox_tables.action_mailbox.rb
+- lib/action_mailbox_amazon_ingress.rb
+- lib/action_mailbox_amazon_ingress/engine.rb
+- lib/action_mailbox_amazon_ingress/version.rb
+homepage: https://github.com/bobf/action_mailbox_amazon_ingress
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Amazon SES ingress for Rails ActionMailbox
+test_files: []