griddler-ses 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96e0b0f54f1b00a46b12ae82cadb29dd52986091
+  data.tar.gz: d6c672a6b79f102995957f643421be3061e1de55
+SHA512:
+  metadata.gz: 82b591b291899aac81572b1b2773e7f692baac826041a45e78f3cf1637fa7b91fcdb1bdae51c0f65120f0fa4f697c9252ce27b09e1095c03dda2bc886130ea74
+  data.tar.gz: f2e613ae216668b85d139b291090fafc26d513d18092dd80474ab8974ee87c2eaacc5611e361372d4158e7ae05a8450b91996795f507bb30cf2e3455511bb2c3

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in griddler-ses.gemspec
+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::Ses
+
+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-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/85x14/griddler-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/griddler-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/ses/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "griddler-ses"
+  spec.version       = Griddler::Ses::VERSION
+  spec.authors       = ["Kent Mewhort @ Coupa"]
+  spec.email         = ["kent.mewhort@coupa.com"]
+
+  spec.summary       = %q{Griddler adapter for AWS SES (handle incoming email replies through SES)}
+  spec.homepage      = "https://github.com/85x14/griddler-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 'sns_endpoint'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/griddler/ses/adapter.rb

@@ -0,0 +1,142 @@
+require 'mail'
+require 'sns_endpoint'
+require 'net/http'
+
+module Griddler
+  module Ses
+    class Adapter
+      attr_reader :params, :raw_request
+
+      def initialize(params, raw_request)
+        @params = params
+        @raw_request = raw_request
+      end
+
+      def self.normalize_params(params)
+        adapter = new(params, self.raw_request)
+        adapter.normalize_params
+      end
+
+      def normalize_params
+        # use sns_endpoint to parse and validate the sns message
+        sns_msg = SnsEndpoint::AWS::SNS::Message.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!
+          params.merge(
+            to: recipients,
+            from: sender,
+            cc: cc,
+            subject: subject,
+            text: text_part,
+            html: html_part,
+            headers: raw_headers,
+            attachments: attachment_files
+          )
+        else
+          raise "Invalid SNS message type"
+        end
+      end
+
+      private
+      def sns_json
+        @sns_json ||= JSON.parse(raw_request.raw_post)
+      end
+
+      def email_json
+        @email_json ||= JSON.parse(sns_json['Message'])
+      end
+
+      def notification_type
+        email_json['notificationType']
+      end
+
+      def recipients
+        email_json['receipt']['recipients']
+      end
+
+      def sender
+        email_json['mail']['commonHeaders']['from'].first
+      end
+
+      def cc
+        email_json['mail']['commonHeaders']['cc']
+      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
+
+      def self.raw_request
+        # TODO: this is an ugly hack using introspection to get the request from the calling controller; should update Griddler
+        # to provide the full request context
+        raw_request = binding.of_caller(2).eval('request')
+      end
+    end
+  end
+end
+

data/lib/griddler/ses/version.rb

@@ -0,0 +1,5 @@
+module Griddler
+  module Ses
+    VERSION = "1.0"
+  end
+end

data/lib/griddler/ses.rb

@@ -0,0 +1,10 @@
+require 'griddler'
+require 'griddler/ses/version'
+require 'griddler/ses/adapter'
+
+module Griddler
+  module Ses
+  end
+end
+
+Griddler.adapter_registry.register(:ses, Griddler::Ses::Adapter)

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: griddler-ses
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Kent Mewhort @ Coupa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-12 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: sns_endpoint
+  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:
+- kent.mewhort@coupa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- griddler-ses.gemspec
+- lib/griddler/ses.rb
+- lib/griddler/ses/adapter.rb
+- lib/griddler/ses/version.rb
+homepage: https://github.com/85x14/griddler-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.4.6
+signing_key: 
+specification_version: 4
+summary: Griddler adapter for AWS SES (handle incoming email replies through SES)
+test_files: []