griddler-amazon_ses 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5477ab34b51905078ad94e973d364db93f67e33b
+  data.tar.gz: f5b18a45a5c65013916e88cd1ef460ff19b838e9
+SHA512:
+  metadata.gz: 4703977f6155fc5a066eaf11c08f5378127089c86d38267bcf022f07874df751792955c9adcc7b6b9bb9d92519ddbaf43ca57963f6c8808086ac5ef7e858d910
+  data.tar.gz: c3fbab952d3090166379e0c28ed97976ce0fec0c988a6f8534ee5445d8ac6591b01b2bf8aa84482d10d7c7f7f66f2ec1ecf9fa398b5aa230e650885e7b04cda4

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Coupa Software Inc
+
+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/README.md

@@ -0,0 +1,38 @@
+# Griddler::AmazonSES
+
+This is a [Griddler](https://github.com/thoughtbot/griddler) adapter that allows you to parse email replies when used with Amazon SES.
+
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+gem 'griddler'
+gem 'griddler-amazon_ses'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+1. Setup Amazon SES to receive emails -- see http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-setting-up.html
+
+2. From AWS SES -> Rule Sets, choose to "Create Receipt Rule" and choose to use SNS.  Add an action with a new SNS topic that *ends in `_griddler`*, with a Base64 encoding.
+
+3. Go to AWS SNS (Simple Notification Service) -> Topics.  Click on your `_griddler` topic.  Add a subscription that points to your configured griddler endpoint (the default route is `/email_processor`).  You're server must be already running to confirm the subscription request!
+
+4. In your griddler handler, be sure to handle/ignore empty reply emails (ie. check for `email.headers.empty?`) to account for the fact that some hooks are just SNS's subscription handling.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ccallebs/griddler-amazon_ses.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/circle.yml

@@ -0,0 +1,4 @@
+machine:
+  ruby:
+    version:
+      2.2.4

data/griddler-amazon_ses.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'griddler/amazon_ses/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "griddler-amazon_ses"
+  spec.version       = Griddler::AmazonSES::VERSION
+  spec.authors       = ["Chuck Callebs", "Kent Mewhort @ Coupa"]
+  spec.email         = ["chuck@callebs.io", "kent.mewhort@coupa.com"]
+
+  spec.summary       = %q{Griddler adapter for AWS SES (handle incoming email replies through SES)}
+  spec.homepage      = "https://github.com/ccallebs/griddler-amazon_ses"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'griddler'
+  spec.add_runtime_dependency 'mail'
+  spec.add_runtime_dependency 'httparty'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/aws/sns_message.rb

@@ -0,0 +1,156 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+
+# Forked from https://github.com/elibri/sns_endpoint
+
+require 'base64'
+require 'json'
+require 'openssl'
+require 'httparty'
+
+module AWS
+  class MessageWasNotAuthenticError < StandardError
+  end
+
+  class SnsMessage
+    attr_accessor :origin, :raw
+
+    def initialize sns
+      if sns.is_a? String
+        @raw = parse_from sns
+      else
+        @raw = sns
+      end
+      @origin = :sns
+    end
+
+    def [] key
+      @raw[key]
+    end
+
+    def authentic?
+      begin
+        decoded_from_base64 = decode signature
+        public_key = get_public_key_from signing_cert_url
+        public_key.verify OpenSSL::Digest::SHA1.new, decoded_from_base64, canonical_string
+      rescue MessageWasNotAuthenticError
+        false
+      end
+    end
+
+    def type
+      case when @raw['Type'] =~ /SubscriptionConfirmation/i
+        then :SubscriptionConfirmation
+      when @raw['Type'] =~ /Notification/i
+        then :Notification
+      when @raw['Type'] =~ /UnsubscribeConfirmation/i
+        then :UnsubscribeConfirmation
+      else
+        :unknown
+      end
+    end
+
+    def message_id
+      @raw['MessageId']
+    end
+
+    def topic_arn
+      @raw['TopicArn']
+    end
+
+    def subject
+      @raw['Subject']
+    end
+
+    def message
+      @raw['Message']
+    end
+
+    def timestamp
+      @raw['Timestamp']
+    end
+
+    def signature
+      @raw['Signature']
+    end
+
+    def signature_version
+      @raw['SignatureVersion']
+    end
+
+    def signing_cert_url
+      @raw['SigningCertURL']
+    end
+
+    def unsubscribe_url
+      @raw['UnsubscribeURL']
+    end
+
+    def subscribe_url
+      @raw['SubscribeURL']
+    end
+
+    def token
+      @raw['Token']
+    end
+
+    def parse_from json
+      JSON.parse json
+    end
+
+    protected
+    def decode raw
+      Base64.decode64 raw
+    end
+
+    def get_public_key_from(x509_pem_url)
+      cert_pem = download x509_pem_url
+      x509 = OpenSSL::X509::Certificate.new(cert_pem)
+      OpenSSL::PKey::RSA.new(x509.public_key)
+    end
+
+    def canonical_string
+      if type == :SubscriptionConfirmation
+        text = "Message\n#{message}\n"
+        text += "MessageId\n#{message_id}\n"
+        text += "SubscribeURL\n#{subscribe_url}\n"
+        text += "Timestamp\n#{timestamp}\n"
+        text += "Token\n#{token}\n"
+        text += "TopicArn\n#{topic_arn}\n"
+        text += "Type\n#{type}\n"         
+      else
+        text = "Message\n#{message}\n"
+        text += "MessageId\n#{message_id}\n"
+        text += "Subject\n#{subject}\n" unless subject.nil? or subject.empty?
+        text += "Timestamp\n#{timestamp}\n"
+        text += "TopicArn\n#{topic_arn}\n"
+        text += "Type\n#{type}\n"
+      end
+      text
+    end
+
+    def download url
+      raise MessageWasNotAuthenticError, "cert is not hosted at AWS URL (https): #{url}" unless url =~ /^https.*amazonaws\.com\/.*$/i
+      tries = 0
+      begin
+        response = HTTParty.get url
+        response.body
+      rescue => msg
+        tries += 1
+        retry if tries <= 3
+        raise StandardError, "SNS signing cert could not be retrieved after #{tries} tries.\n#{msg}"
+      end
+    end
+  end
+end

data/lib/griddler/amazon_ses.rb

@@ -0,0 +1,13 @@
+require 'aws/sns_message'
+require 'griddler'
+require 'griddler/amazon_ses/version'
+require 'griddler/amazon_ses/adapter'
+require 'griddler/amazon_ses/middleware'
+require 'griddler/amazon_ses/railtie'
+
+module Griddler
+  module AmazonSES
+  end
+end
+
+Griddler.adapter_registry.register(:amazon_ses, Griddler::AmazonSES::Adapter)

data/lib/griddler/amazon_ses/adapter.rb

@@ -0,0 +1,134 @@
+require 'mail'
+require 'net/http'
+
+module Griddler
+  module AmazonSES
+    class Adapter
+      attr_reader :sns_json
+
+      def initialize(params)
+        @sns_json = params
+      end
+
+      def self.normalize_params(params)
+        adapter = new(params)
+        adapter.normalize_params
+      end
+
+      def normalize_params
+        sns_msg = AWS::SnsMessage.new sns_json
+        raise "Invalid SNS message" unless sns_msg.authentic? && sns_msg.topic_arn.end_with?('griddler')
+
+        case sns_msg.type
+        when :SubscriptionConfirmation
+          confirm_sns_subscription_request
+          # this is not an actual email reply (and griddler has no way to bail at this point), so return empty parameters
+          {}
+        when :Notification
+          ensure_valid_notification_type!
+          sns_json.merge(
+            to: recipients,
+            from: sender,
+            cc: cc,
+            bcc: bcc,
+            subject: subject,
+            text: text_part,
+            html: html_part,
+            headers: raw_headers,
+            attachments: attachment_files
+          )
+        else
+          raise "Invalid SNS message type"
+        end
+      end
+
+      private
+      def email_json
+        @email_json ||= JSON.parse(sns_json['Message'])
+      end
+
+      def notification_type
+        email_json['notificationType']
+      end
+
+      def recipients
+        email_json['mail']['commonHeaders']['to']
+      end
+
+      def sender
+        email_json['mail']['commonHeaders']['from'].first
+      end
+
+      def cc
+        email_json['mail']['commonHeaders']['cc'] || []
+      end
+
+      def bcc
+        email_json['mail']['commonHeaders']['bcc'] || []
+      end
+
+      def subject
+        email_json['mail']['commonHeaders']['subject']
+      end
+
+      def header_array
+        email_json['mail']['headers']
+      end
+
+      def message
+        @message ||= Mail.read_from_string(Base64.decode64(email_json['content']))
+      end
+
+      def multipart?
+        message.parts.count > 0
+      end
+
+      def text_part
+        multipart? ? message.text_part.body.to_s : message.body.to_s
+      end
+
+      def html_part
+        multipart? ? message.html_part.body.to_s : nil
+      end
+
+      def raw_headers
+        # SNS gives us an array of hashes with name value, which we need to convert back to raw headers;
+        # based on griddler-sparkpost (https://github.com/PrestoDoctor/griddler-sparkpost, MIT license)
+        header_array.inject([]) { |raw_headers, sns_hash|
+          raw_headers.push("#{sns_hash['name']}: #{sns_hash['value']}")
+        }.join("\r\n")
+      end
+
+      def attachment_files
+        # also based on griddler-sparkpost (https://github.com/PrestoDoctor/griddler-sparkpost, MIT license);
+        # AWS doesn't presently support sending the attachments from the message through SNS, but ready if they do!
+        message.attachments.map do |attachment|
+          ActionDispatch::Http::UploadedFile.new({
+            type: attachment.mime_type,
+            filename: attachment.filename,
+            tempfile: tempfile_for_attachment(attachment)
+          })
+        end
+      end
+
+      def tempfile_for_attachment(attachment)
+        filename = attachment.filename.gsub(/\/|\\/, '_')
+        tempfile = Tempfile.new(filename, Dir::tmpdir, encoding: 'ascii-8bit')
+        content = attachment.body.decoded
+        tempfile.write(content)
+        tempfile.rewind
+        tempfile
+      end
+
+      def ensure_valid_notification_type!
+        raise "Invalid SNS notification type (\"#{notification_type}\", expecting Received" unless notification_type == 'Received'
+      end
+
+      def confirm_sns_subscription_request
+        confirmation_endpoint = URI.parse(sns_json['SubscribeURL'])
+        Net::HTTP.get confirmation_endpoint
+      end
+    end
+  end
+end
+

data/lib/griddler/amazon_ses/middleware.rb

@@ -0,0 +1,34 @@
+module Griddler
+  module AmazonSES
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        # a bug on the AWS side doesn't set the content type to application/json type properly,
+        # so we have to intercept and do this in order for Griddler's controller to correctly
+        # parse the parameters (see https://forums.aws.amazon.com/thread.jspa?messageID=418160)
+        if is_griddler_request?(env) && is_aws_sns_request?(env)
+          env['CONTENT_TYPE'] = 'application/json; charset=UTF-8'
+        end
+
+        @app.call(env)
+      end
+
+      private
+      def griddler_path
+        @griddler_path ||= Rails.application.routes.url_helpers.url_for(controller: 'griddler/emails', action: 'create', only_path: true)
+      end
+
+      def is_griddler_request?(request)
+        # Fix for servers that do not include 'request_path' in headers
+        request['REQUEST_PATH'] == griddler_path || request['REQUEST_URI'] == griddler_path
+      end
+
+      def is_aws_sns_request?(request)
+        request['HTTP_X_AMZ_SNS_MESSAGE_TYPE'].present?
+      end
+    end
+  end
+end

data/lib/griddler/amazon_ses/railtie.rb

@@ -0,0 +1,17 @@
+require 'rails/version'
+
+module Griddler
+  module AmazonSES
+    class Railtie < Rails::Railtie
+      if Rails::VERSION::MAJOR < 5
+        middleware = ActionDispatch::ParamsParser
+      else
+        middleware = Rack::Head
+      end
+
+      initializer "griddler_ses.configure_rails_initialization" do |app|
+        Rails.application.middleware.insert_before middleware, Griddler::Ses::Middleware
+      end
+    end
+  end
+end

data/lib/griddler/amazon_ses/version.rb

@@ -0,0 +1,5 @@
+module Griddler
+  module AmazonSES
+    VERSION = "2.0.0"
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: griddler-amazon_ses
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Chuck Callebs
+- Kent Mewhort @ Coupa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: griddler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- chuck@callebs.io
+- kent.mewhort@coupa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- circle.yml
+- griddler-amazon_ses.gemspec
+- lib/aws/sns_message.rb
+- lib/griddler/amazon_ses.rb
+- lib/griddler/amazon_ses/adapter.rb
+- lib/griddler/amazon_ses/middleware.rb
+- lib/griddler/amazon_ses/railtie.rb
+- lib/griddler/amazon_ses/version.rb
+homepage: https://github.com/ccallebs/griddler-amazon_ses
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Griddler adapter for AWS SES (handle incoming email replies through SES)
+test_files: []