griddler-mailgun 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b056d51cbc72ddb86286d5bc79ef3173ac5d266
+  data.tar.gz: 7d9753839331a38a462d32a19aff575853aea364
+SHA512:
+  metadata.gz: 30e9313154d7578aa97d99db8c24e34e88dffa7284b5da31901b9197da5a126c95ae1cd294d8a9be758fe8b253bd12217203dd9a51672cf382b9d9778d96a8ed
+  data.tar.gz: 2ea37a65cacdea9c34d47e2589e2580ef1992305e49874f0acc476bb158e1e2d55f620f5b1a5d8263114208c7975aa0c406bdabe33fdb38ed68302e33f26d785

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'griddler', '1.0.0'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brad Pauly
+
+MIT License
+
+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,62 @@
+# Griddler::Mailgun
+
+[![Code Climate](https://codeclimate.com/github/bradpauly/griddler-mailgun.png)](https://codeclimate.com/github/bradpauly/griddler-mailgun)
+
+This was extracted from the [griddler gem](https://github.com/thoughtbot/griddler) and is used to
+parse emails forwarded to your application from [mailgun](http://mailgun.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'griddler'
+gem 'griddler-mailgun'
+```
+
+Then execute:
+
+```
+bundle install
+```
+
+## Usage
+
+[Griddler](http://griddler.io/) comes with a route that, when used, handles the params passed to your application and then sends a Griddler::Email to EmailProcessor#process. Read [a blog post about it](http://robots.thoughtbot.com/handle-incoming-email-with-griddler) on the Thoughtbot blog.
+
+#### Getting mailgun to POST to your application
+
+Mailgun uses [routes](http://documentation.mailgun.com/user_manual.html#routes) to filter incoming emails and forward them to your app. A route is made up of a filter and an action. [The filter](http://documentation.mailgun.com/api-routes.html#filters) matches emails based on its properties and [the action](http://documentation.mailgun.com/api-routes.html#actions) determines what happens to the matched email.
+
+For example, to forward any email sent to an example.net address to http://example.com/email_processor 
+the following route would be used:
+
+Filter Expression:
+
+```
+match_recipient(".*@example.net")
+```
+
+Action:
+
+```
+forward("http://example.com/email_processor")
+```
+
+## More Information
+
+* [mailgun](http://www.mailgun.com)
+* [mailgun API - Routes](http://documentation.mailgun.com/api-routes.html)
+* [mailgun User Maunual - Routes](http://documentation.mailgun.com/user_manual.html#routes)
+
+## Credits
+
+Griddler::Mailgun was extracted from Griddler by Brad Pauly.
+
+Griddler was written by Caleb Thompson and Joel Oliveira.
+
+## License
+
+Griddler::Mailgun is Copyright © 2014 Brad Pauly. It is free
+software, and may be redistributed under the terms specified
+in the LICENSE file.

data/Rakefile

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

data/griddler-mailgun.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'griddler/mailgun/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "griddler-mailgun"
+  spec.version       = Griddler::Mailgun::VERSION
+  spec.authors       = ["Brad Pauly"]
+  spec.email         = ["hi@bradpauly.com"]
+  spec.summary       = %q{Mailgun adapter for Griddler}
+  spec.description   = %q{Adapter to allow the use of mailgun forwarded routes with Griddler.}
+  spec.homepage      = "https://github.com/bradpauly/griddler-mailgun"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+
+  spec.add_dependency 'griddler'
+end

data/lib/griddler/mailgun.rb

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

data/lib/griddler/mailgun/adapter.rb

@@ -0,0 +1,76 @@
+module Griddler
+  module Mailgun
+    class Adapter
+      def initialize(params)
+        @params = params
+      end
+
+      def self.normalize_params(params)
+        adapter = new(params)
+        adapter.normalize_params
+      end
+
+      def normalize_params
+        {
+          to: to_recipients,
+          cc: cc_recipients,
+          from: determine_sender,
+          subject: params[:subject],
+          text: params['body-plain'],
+          html: params['body-html'],
+          attachments: attachment_files,
+          headers: headers
+        }
+      end
+
+      private
+
+      attr_reader :params
+
+      def determine_sender
+        sender = param_or_header(:From)
+        sender ||= params[:sender]
+      end
+
+      def to_recipients
+        to_emails = param_or_header(:To)
+        to_emails ||= params[:recipient]
+        to_emails.split(',').map(&:strip)
+      end
+
+      def cc_recipients
+        cc = param_or_header(:Cc)
+        cc.split(',').map(&:strip)
+      end
+
+      def headers
+        @headers ||= extract_headers
+      end
+
+      def extract_headers
+        return nil unless params['message-headers']
+
+        extracted_headers = {}
+        parsed_headers = JSON.parse(params['message-headers'])
+        parsed_headers.each{ |h| extracted_headers[h[0]] = h[1] }
+        ActiveSupport::HashWithIndifferentAccess.new(extracted_headers)
+      end
+
+      def param_or_header(key)
+        if params[key].present?
+          params[key]
+        else
+          headers[key]
+        end
+      end
+
+      def attachment_files
+        attachment_count = params['attachment-count'].to_i
+
+        attachment_count.times.map do |index|
+          params.delete("attachment-#{index+1}")
+        end
+      end
+    end
+  end
+end

data/lib/griddler/mailgun/version.rb

@@ -0,0 +1,5 @@
+module Griddler
+  module Mailgun
+    VERSION = "1.0.0"
+  end
+end

data/spec/griddler/mailgun/adapter_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+describe Griddler::Mailgun::Adapter do
+  it 'registers itself with griddler' do
+    Griddler.adapter_registry[:mailgun].should eq Griddler::Mailgun::Adapter
+  end
+end
+
+describe Griddler::Mailgun::Adapter, '.normalize_params' do
+  it 'falls back to headers for cc' do
+    params = default_params.merge(Cc: '')
+    normalized_params = Griddler::Mailgun::Adapter.normalize_params(params)
+    expect(normalized_params[:cc]).to eq ["Brandon Stark <brandon@example.com>", "Arya Stark <arya@example.com>"]
+  end
+
+  it 'passes the received array of files' do
+    params = default_params.merge(
+      'attachment-count' => 2,
+      'attachment-1' => upload_1,
+      'attachment-2' => upload_2
+    )
+
+    normalized_params = Griddler::Mailgun::Adapter.normalize_params(params)
+    normalized_params[:attachments].should eq [upload_1, upload_2]
+  end
+
+  it 'has no attachments' do
+    normalized_params = Griddler::Mailgun::Adapter.normalize_params(default_params)
+    normalized_params[:attachments].should be_empty
+  end
+
+  it 'gets sender from headers' do
+    params = default_params.merge(From: '')
+    normalized_params = Griddler::Mailgun::Adapter.normalize_params(params)
+    expect(normalized_params[:from]).to eq "Jon Snow <jon@example.com>"
+  end
+
+  it 'falls back to sender without headers or From' do
+    params = default_params.merge(From: '', 'message-headers' => '{}')
+    normalized_params = Griddler::Mailgun::Adapter.normalize_params(params)
+    expect(normalized_params[:from]).to eq "jon@example.com"
+  end
+
+  it 'gets full address from headers' do
+    params = default_params.merge(To: '')
+    normalized_params = Griddler::Mailgun::Adapter.normalize_params(params)
+    expect(normalized_params[:to]).to eq ["John Doe <johndoe@example.com>", "Jane Doe <janedoe@example.com>"]
+  end
+
+  it 'handles multiple To addresses' do
+    params = default_params.merge(
+      To: 'Alice Cooper <alice@example.org>, John Doe <john@example.com>'
+    )
+    normalized_params = Griddler::Mailgun::Adapter.normalize_params(params)
+    expect(normalized_params[:to]).to eq [
+      'Alice Cooper <alice@example.org>',
+      'John Doe <john@example.com>'
+    ]
+  end
+
+  it 'handles missing params' do
+    normalized_params = Griddler::Mailgun::Adapter.normalize_params(short_params)
+  end
+
+  def upload_1
+    @upload_1 ||= ActionDispatch::Http::UploadedFile.new(
+      filename: 'photo1.jpg',
+      type: 'image/jpeg',
+      tempfile: fixture_file('photo1.jpg')
+    )
+  end
+
+  def upload_2
+    @upload_2 ||= ActionDispatch::Http::UploadedFile.new(
+      filename: 'photo2.jpg',
+      type: 'image/jpeg',
+      tempfile: fixture_file('photo2.jpg')
+    )
+  end
+
+  def fixture_file(file_name)
+    cwd = File.expand_path File.dirname(__FILE__)
+    File.new(File.join(cwd, '../../', 'fixtures', file_name))
+  end
+
+  def json_headers
+    "[
+      [\"Subject\", \"multiple recipients and CCs\"],
+      [\"From\", \"Jon Snow <jon@example.com>\"],
+      [\"To\", \"John Doe <johndoe@example.com>, Jane Doe <janedoe@example.com>\"],
+      [\"Cc\", \"Brandon Stark <brandon@example.com>, Arya Stark <arya@example.com>\"]
+    ]"
+  end
+
+  def short_params
+    params = {
+      To: 'Hello World <hi@example.com>',
+      From: 'There <there@example.com>',
+      Cc: 'emily@example.com',
+      'body-plain' => 'hi',
+    }
+  end
+
+  def default_params
+    params = ActiveSupport::HashWithIndifferentAccess.new(
+      {
+        "Cc"=>"Brandon Stark <brandon@example.com>, Arya Stark <arya@example.com>",
+        "From"=>"Jon Snow <jon@example.com>",
+        "Subject"=>"multiple recipients and CCs",
+        "To"=>"John Doe <johndoe@example.com>, Jane Doe <janedoe@example.com>",
+        "body-html"=>"<div dir=\"ltr\">And attachments. Two of them. An image and a text file.</div>\r\n",
+        "body-plain"=>"And attachments. Two of them. An image and a text file.\r\n",
+        "from"=>"Jon Snow <jon@example.com>",
+        "recipient"=>"johndoe@example.com",
+        "sender"=>"jon@example.com",
+        "stripped-html"=>"<div dir=\"ltr\">And attachments. Two of them. An image and a text file.</div>\r\n",
+        "stripped-signature"=>"",
+        "stripped-text"=>"And attachments. Two of them. An image and a text file.",
+        "subject"=>"multiple recipients and CCs",
+        "timestamp"=>"1402113646",
+        "message-headers"=>json_headers
+      }
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'griddler/testing'
+require 'griddler/mailgun'
+require 'action_dispatch'
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/hash'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.order = 'random'
+  config.include Griddler::Testing
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: griddler-mailgun
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brad Pauly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: Adapter to allow the use of mailgun forwarded routes with Griddler.
+email:
+- hi@bradpauly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- griddler-mailgun.gemspec
+- lib/griddler/mailgun.rb
+- lib/griddler/mailgun/adapter.rb
+- lib/griddler/mailgun/version.rb
+- spec/fixtures/photo1.jpg
+- spec/fixtures/photo2.jpg
+- spec/griddler/mailgun/adapter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bradpauly/griddler-mailgun
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Mailgun adapter for Griddler
+test_files:
+- spec/fixtures/photo1.jpg
+- spec/fixtures/photo2.jpg
+- spec/griddler/mailgun/adapter_spec.rb
+- spec/spec_helper.rb