action_mailbox_amazon_ingress 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f08bddaffb7a4483d75df3c8bf6daebdd58cbb6673f9d8edb02b0fa3f881edc1
-  data.tar.gz: a32fc9ffaa109603235667fa7169625d149db1aafbc6b8179625edca204f69e2
+  metadata.gz: 7a83ae0efbb2c0f3027ef29b0aa7586d46993c25a4f2c12c06fb7174fb3d1271
+  data.tar.gz: f90c9da49e0b53f4c8b6687adb6d76c08cef34f9e0f7f4f1896f37e33d718825
 SHA512:
-  metadata.gz: 24e5461c1e6c24b192f312d1384a4d5f863da866a769575361c380150129c05a0d28d7b7d6c7624fa7f01a2fa4ee8db70cbe080e26e13b3cb6469fb6aeb47777
-  data.tar.gz: 22d1eff8e7cc534adbf9b2333189797546cde4f177dc172cb66a45f6cf37da01751deb082e1e21f2dfebbbc3a352f2c8c1fbdaaccfe46273104dbe82fd653311
+  metadata.gz: e4d6813c196bdc0ce6da6a639cf8c7ccbcda8131587eb1ad49540a76141bc8993c596949b865084b956d38b6c8637e6ae4e7a52ee421f98d429dc2e21e90b924
+  data.tar.gz: 35dfa9d498ad50f2b4f102d370d5305b506c0971d48ee56c07f7ef1e07b494d31c009c65522e59bd555104849c3aa77a74d6ecc4b1efce61e44bdf539f81f734

data/.gitignore

@@ -17,3 +17,4 @@ spec/support/dummy/db/*
 Gemfile.lock
 
 .byebug_history
+*.gem

data/.rubocop.yml

@@ -8,8 +8,10 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
+    - 'action_mailbox_amazon_ingress.gemspec'
 
 AllCops:
+  NewCops: enable
   Exclude:
     - 'bin/**/*'
     - 'db/migrate/**/*.rb'

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+2.5.3

data/Makefile

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

data/README.md

@@ -7,7 +7,7 @@ Provides _Amazon SES/SNS_ integration with [_Rails ActionMailbox_](https://guide
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'action_mailbox_amazon_ingress', '~> 0.1.0'
+gem 'action_mailbox_amazon_ingress', '~> 0.1.1'
 ```
 
 ## Configuration
@@ -45,6 +45,58 @@ Note that even if you manually confirm subscriptions you will still need to prov
 
 See [ActionMailbox documentation](https://guides.rubyonrails.org/action_mailbox_basics.html) for full usage information.
 
+## Testing
+
+### RSpec
+
+Two _RSpec_ _request spec_ helpers are provided to facilitate testing _Amazon SNS/SES_ notifications in your application:
+
+* `amazon_ingress_deliver_subscription_confirmation`
+* `amazon_ingress_deliver_email`
+
+Include the `ActionMailboxAmazonIngress::RSpec` extension in your tests:
+
+```ruby
+# spec/rails_helper.rb
+
+require 'action_mailbox_amazon_ingress/rspec'
+
+RSpec.configure do |config|
+  config.include ActionMailboxAmazonIngress::RSpec
+end
+```
+
+Configure your _test_ environment to accept the default topic used by the provided helpers:
+
+```ruby
+# config/environments/test.rb
+
+config.action_mailbox.amazon.subscribed_topics = ['topic:arn:default']
+```
+
+#### Example Usage
+
+```ruby
+# spec/requests/amazon_emails_spec.rb
+
+RSpec.describe 'amazon emails', type: :request do
+  it 'delivers a subscription notification' do
+    amazon_ingress_deliver_subscription_confirmation
+    expect(response).to have_http_status :ok
+  end
+
+  it 'delivers an email notification' do
+    amazon_ingress_deliver_email(mail: Mail.new(to: 'user@example.com'))
+    expect(ActionMailbox::InboundEmail.last.mail.recipients).to eql ['user@example.com']
+  end
+end
+```
+
+You may also pass the following keyword arguments to both helpers:
+
+* `topic`: The _SNS_ topic used for each notification (default: `topic:arn:default`).
+* `authentic`: The `Aws::SNS::MessageVerifier` class is stubbed by these helpers; set `authentic` to `true` or `false` to define how it will verify incoming notifications (default: `true`).
+
 ## Development
 
 Ensure _Rubocop_, _RSpec_, and _StrongVersions_ compliance by running `make`:

data/action_mailbox_amazon_ingress.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |spec|
   spec.version       = ActionMailboxAmazonIngress::VERSION
   spec.authors       = ['Bob Farrell']
   spec.email         = ['git@bob.frl']
+  spec.required_ruby_version = '>= 2.5'
 
   spec.summary       = 'Amazon SES ingress for Rails ActionMailbox'
   spec.description   = 'Integrate Amazon SES with ActionMailbox'
@@ -28,10 +29,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rails', '~> 6.0'
 
   spec.add_development_dependency 'betterp', '~> 0.1.3'
+  spec.add_development_dependency 'devpack', '~> 0.2.1'
   spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec-its', '~> 1.3'
   spec.add_development_dependency 'rspec-rails', '~> 4.0'
-  spec.add_development_dependency 'rubocop', '~> 0.82.0'
+  spec.add_development_dependency 'rubocop', '~> 0.90.0'
   spec.add_development_dependency 'sqlite3', '~> 1.4'
-  spec.add_development_dependency 'strong_versions', '~> 0.4.3'
+  spec.add_development_dependency 'strong_versions', '~> 0.4.5'
   spec.add_development_dependency 'webmock', '~> 3.8'
 end

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Layout/LineLength
 module ActionMailbox
   # Ingests inbound emails from Amazon SES/SNS and confirms subscriptions.
   #
@@ -50,7 +49,7 @@ module ActionMailbox
   #    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

data/lib/action_mailbox_amazon_ingress/rspec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'action_mailbox_amazon_ingress/rspec/email'
+require 'action_mailbox_amazon_ingress/rspec/subscription_confirmation'
+
+module ActionMailboxAmazonIngress
+  module RSpec
+    def amazon_ingress_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.to_json,
+                                          headers: subscription_confirmation.headers
+    end
+
+    def amazon_ingress_deliver_email(options = {})
+      email = Email.new(**options)
+      stub_aws_sns_message_verifier(email)
+      post email.url, params: email.params.to_json,
+                      headers: email.headers
+    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::SNS::MessageVerifier).to receive(:new) { 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

data/lib/action_mailbox_amazon_ingress/rspec/email.rb

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

data/lib/action_mailbox_amazon_ingress/rspec/subscription_confirmation.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ActionMailboxAmazonIngress
+  module RSpec
+    class SubscriptionConfirmation
+      def initialize(authentic: true, topic: 'topic:arn:default')
+        @authentic = authentic
+        @topic = topic
+      end
+
+      def url
+        '/rails/action_mailbox/amazon/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

data/lib/action_mailbox_amazon_ingress/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_mailbox_amazon_ingress
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Bob Farrell
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-09 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sns
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: devpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: 0.90.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: 0.90.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.4.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.4.5
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -161,12 +189,15 @@ files:
 - 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/rspec.rb
+- lib/action_mailbox_amazon_ingress/rspec/email.rb
+- lib/action_mailbox_amazon_ingress/rspec/subscription_confirmation.rb
 - lib/action_mailbox_amazon_ingress/version.rb
 homepage: https://github.com/bobf/action_mailbox_amazon_ingress
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -174,15 +205,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
 specification_version: 4
 summary: Amazon SES ingress for Rails ActionMailbox
 test_files: []