aws-actionmailbox-ses 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e479e69925ae410b04c11a78682c20190c820df0eab90a95b7044affad760d2b
+  data.tar.gz: 482a6e144f2def8dcbcca8312afc334488d12aaafea95ea22b3c4daf19db15ec
+SHA512:
+  metadata.gz: f050f92ca327417764e4c8cd5819578662c148659180883680996c5fc2c63837f210e4742bb44f99a69f237a5995b58ce10debc7843a857b0f8c1dfd0c646fc3
+  data.tar.gz: 1e4598eabdd771eb50b2e5da42282fb7df9861ea88a685be8237c4625c9ebead1cd1025dbdf1769e8e09c76e8d2a4d972c529c45210fa9e8dab4829a22908627

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+0.1.0 (2024-11-16)
+------------------
+
+* Feature - Initial version of this gem.

data/LICENSE

@@ -0,0 +1,175 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

data/VERSION

@@ -0,0 +1 @@
+0.1.0

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module ActionMailbox
+  module Ingresses
+    module Ses
+      # Ingests inbound emails from Amazon SES/SNS and confirms subscriptions.
+      #
+      # Subscription requests must provide the following parameters in a JSON body:
+      #
+      # - +Message+: Notification content
+      # - +MessageId+: 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
+      # - +MessageId+: 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
+      class InboundEmailsController < ActionMailbox::BaseController
+        before_action :verify_authenticity, :validate_topic, :confirm_subscription
+
+        def create
+          head :bad_request unless notification.message_content.present?
+
+          ActionMailbox::InboundEmail.create_and_extract_message_id!(notification.message_content)
+          head :no_content
+        end
+
+        private
+
+        def verify_authenticity
+          head :bad_request unless notification.present?
+          head :unauthorized unless notification.verified?
+        end
+
+        def confirm_subscription
+          return unless notification.type == 'SubscriptionConfirmation'
+          return head :ok if notification.subscription_confirmed?
+
+          Rails.logger.error('SNS subscription confirmation request rejected.')
+          head :unprocessable_entity
+        end
+
+        def validate_topic
+          return if valid_topic == notification.topic
+
+          Rails.logger.warn("Ignoring unknown topic: #{topic}")
+          head :unauthorized
+        end
+
+        def notification
+          @notification ||= Aws::ActionMailbox::SES::SNSNotification.new(request.raw_post)
+        end
+
+        def topic
+          @topic ||= notification.topic
+        end
+
+        def valid_topic
+          ::Rails.configuration.action_mailbox.ses.subscribed_topic
+        end
+      end
+    end
+  end
+end

data/config/routes.rb

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

data/lib/aws/action_mailbox/ses/engine.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'action_mailbox/engine'
+
+module Aws
+  module ActionMailbox
+    module SES
+      # @api private
+      class Engine < ::Rails::Engine
+        config.action_mailbox.ses = ActiveSupport::OrderedOptions.new
+        config.action_mailbox.ses.s3_client_options ||= {}
+
+        initializer 'aws-sdk-rails.mount_engine' do |app|
+          app.routes.append do
+            mount Engine => '/'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/action_mailbox/ses/rspec/email.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Aws
+  module ActionMailbox
+    module SES
+      module RSpec
+        # @api private
+        class Email
+          def initialize(authentic: true, topic: 'topic:arn:default', mail: default_mail, message_params: {})
+            @authentic = authentic
+            @topic = topic
+            @mail = mail
+            @message_params = message_params
+          end
+
+          def headers
+            { 'content-type' => 'application/json' }
+          end
+
+          def url
+            '/rails/action_mailbox/ses/inbound_emails'
+          end
+
+          def params
+            {
+              'Type' => 'Notification',
+              'TopicArn' => @topic,
+              'Message' => message_json
+            }
+          end
+
+          def message_json
+            {
+              'notificationType' => 'Received',
+              'content' => @mail.encoded
+            }.merge(@message_params).to_json
+          end
+
+          def authentic?
+            @authentic
+          end
+
+          def default_mail
+            Mail.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/action_mailbox/ses/rspec/subscription_confirmation.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Aws
+  module ActionMailbox
+    module SES
+      module RSpec
+        # @api private
+        class SubscriptionConfirmation
+          def initialize(authentic: true, topic: 'topic:arn:default')
+            @authentic = authentic
+            @topic = topic
+          end
+
+          def url
+            '/rails/action_mailbox/ses/inbound_emails'
+          end
+
+          def headers
+            { 'content-type' => 'application/json' }
+          end
+
+          def params
+            {
+              'Type' => 'SubscriptionConfirmation',
+              'TopicArn' => @topic,
+              'SubscribeURL' => 'http://example.com/subscribe'
+            }
+          end
+
+          def authentic?
+            @authentic
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/action_mailbox/ses/rspec.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative 'rspec/email'
+require_relative 'rspec/subscription_confirmation'
+
+module Aws
+  module ActionMailbox
+    module SES
+      # RSpec extension for testing Amazon SES notifications. Include the
+      # `Aws::ActionMailbox::SES::RSpec` extension in your tests, like so:
+      #
+      #     require 'aws/rails/action_mailbox/rspec'
+      #     RSpec.configure do |config|
+      #       config.include Aws::ActionMailbox::SES::RSpec
+      #     end
+      #
+      module RSpec
+        # Stubs the AWS SNS message verifier and delivers a subscription confirmation.
+        # @example
+        #   it 'delivers a subscription notification' do
+        #     action_mailbox_ses_deliver_subscription_confirmation
+        #     expect(response).to have_http_status :ok
+        #   end
+        def action_mailbox_ses_deliver_subscription_confirmation(options = {})
+          subscription_confirmation = SubscriptionConfirmation.new(**options)
+          stub_aws_sns_message_verifier(subscription_confirmation)
+          stub_aws_sns_subscription_request
+
+          post subscription_confirmation.url,
+               params: subscription_confirmation.params,
+               headers: subscription_confirmation.headers,
+               as: :json
+        end
+
+        # Stubs the AWS SNS message verifier and delivers an email.
+        # @example
+        #   it 'delivers an email notification' do
+        #     action_mailbox_ses_deliver_email(mail: Mail.new(to: 'user@example.com'))
+        #     expect(ActionMailbox::InboundEmail.last.mail.recipients).to eql ['user@example.com']
+        #   end
+        def action_mailbox_ses_deliver_email(options = {})
+          email = Email.new(**options)
+          stub_aws_sns_message_verifier(email)
+
+          post email.url,
+               params: email.params,
+               headers: email.headers,
+               as: :json
+        end
+
+        private
+
+        def message_verifier(subscription_confirmation)
+          instance_double(Aws::SNS::MessageVerifier, authentic?: subscription_confirmation.authentic?)
+        end
+
+        def stub_aws_sns_message_verifier(notification)
+          allow(Aws::ActionMailbox::SES::SNSMessageVerifier).to receive(:verifier) { message_verifier(notification) }
+        end
+
+        def stub_aws_sns_subscription_request
+          allow(Net::HTTP).to receive(:get_response).and_call_original
+          allow(Net::HTTP)
+            .to receive(:get_response)
+              .with(URI('http://example.com/subscribe')) { double(code: '200') }
+        end
+      end
+    end
+  end
+end

data/lib/aws/action_mailbox/ses/s3_client.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-s3'
+
+module Aws
+  module ActionMailbox
+    module SES
+      # @api private
+      class S3Client
+        class << self
+          def client
+            @client ||= build_client
+          end
+
+          private
+
+          def build_client
+            client = Aws::S3::Client.new(
+              **::Rails.configuration.action_mailbox.ses.s3_client_options
+            )
+            client.config.user_agent_frameworks << 'aws-actionmailbox-ses'
+            client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/action_mailbox/ses/sns_message_verifier.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-sns'
+
+module Aws
+  module ActionMailbox
+    module SES
+      # @api private
+      class SNSMessageVerifier
+        class << self
+          def verifier
+            @verifier ||= Aws::SNS::MessageVerifier.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/action_mailbox/ses/sns_notification.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Aws
+  module ActionMailbox
+    module SES
+      # @api private
+      class SNSNotification
+        class MessageContentError < StandardError; end
+
+        def initialize(request_body)
+          @request_body = request_body
+        end
+
+        def subscription_confirmed?
+          (200..299).cover?(confirmation_response.code.to_i)
+        end
+
+        def verified?
+          SNSMessageVerifier.verifier.authentic?(@request_body)
+        end
+
+        def topic
+          notification.fetch(:TopicArn)
+        end
+
+        def type
+          notification.fetch(:Type)
+        end
+
+        def message_content
+          raise MessageContentError, 'Incoming emails must have notificationType `Received`' unless receipt?
+
+          if content_in_s3?
+            s3_content
+          else
+            return message[:content] unless destination
+
+            "X-Original-To: #{destination}\n#{message[:content]}"
+          end
+        end
+
+        private
+
+        def notification
+          @notification ||= JSON.parse(@request_body, symbolize_names: true)
+        rescue JSON::ParserError => e
+          Rails.logger.warn("Unable to parse SNS notification: #{e}")
+          nil
+        end
+
+        def s3_content
+          S3Client
+            .client
+            .get_object(key: key, bucket: bucket)
+            .body
+            .string
+        end
+
+        def message
+          @message ||= JSON.parse(notification[:Message], symbolize_names: true)
+        end
+
+        def destination
+          message.dig(:mail, :destination)&.first
+        end
+
+        def action
+          return unless message[:receipt]
+
+          message.fetch(:receipt).fetch(:action)
+        end
+
+        def bucket
+          action.fetch(:bucketName)
+        end
+
+        def key
+          action.fetch(:objectKey)
+        end
+
+        def content_in_s3?
+          action&.fetch(:type) == 'S3'
+        end
+
+        def receipt?
+          message.fetch(:notificationType) == 'Received'
+        end
+
+        def confirmation_response
+          @confirmation_response ||= Net::HTTP.get_response(URI(notification[:SubscribeURL]))
+        end
+      end
+    end
+  end
+end

data/lib/aws-actionmailbox-ses.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'aws/action_mailbox/ses/engine'
+require_relative 'aws/action_mailbox/ses/s3_client'
+require_relative 'aws/action_mailbox/ses/sns_message_verifier'
+require_relative 'aws/action_mailbox/ses/sns_notification'
+
+module Aws
+  module ActionMailbox
+    module SES
+      VERSION = File.read(File.expand_path('../VERSION', __dir__)).strip
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: aws-actionmailbox-ses
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Amazon Web Services
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.123.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.123.0
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sns
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.61.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.61.0
+- !ruby/object:Gem::Dependency
+  name: actionmailbox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+description: Amazon Simple Email Service as an ActionMailbox router
+email:
+- aws-dr-rubygems@amazon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- VERSION
+- app/controllers/action_mailbox/ingresses/ses/inbound_emails_controller.rb
+- config/routes.rb
+- lib/aws-actionmailbox-ses.rb
+- lib/aws/action_mailbox/ses/engine.rb
+- lib/aws/action_mailbox/ses/rspec.rb
+- lib/aws/action_mailbox/ses/rspec/email.rb
+- lib/aws/action_mailbox/ses/rspec/subscription_confirmation.rb
+- lib/aws/action_mailbox/ses/s3_client.rb
+- lib/aws/action_mailbox/ses/sns_message_verifier.rb
+- lib/aws/action_mailbox/ses/sns_notification.rb
+homepage: https://github.com/aws/aws-actionmailbox-ses-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: ActionMailbox integration with SES
+test_files: []