griddler-mandrill-acd 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c112ade322f6f6a3b4ac4a9c906a9bc7030b0435
+  data.tar.gz: d2affb4fd46b507434d537a03cccbd35fa534bbf
+SHA512:
+  metadata.gz: 5ed3d770cd64c3cc7efce7e64b828e1d8c50d670b493627794a5436b6e4d99f556c4e1041e2da375559d2e96f869959a27202e1633d9b2ac002bcf0eb7029636
+  data.tar.gz: 9caafc8bfb5442979470ce01f2aedff13c2558815fb72b33c38afa2a542380a00e91b08302297842b98df5c41eb17a282a62f3dd2e6fa00a3ea39e6294891c5d

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,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 1.0.1
+* Respect Mandrill's base64 flag to determine whether text attachments should be
+  base64 decoded. #4 via [bdmac](https://github.com/bdmac)
+
+## 1.0.0
+* Initial extraction of the Mandrill adapter from griddler

data/CONTRIBUTING.md

@@ -0,0 +1,8 @@
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/griddler-mandrill/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Make your changes (with tests!)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Stafford Brunk
+
+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,41 @@
+# Griddler::Mandrill
+[![Build Status](http://img.shields.io/travis/wingrunr21/griddler-mandrill.svg?style=flat)](https://travis-ci.org/wingrunr21/griddler-mandrill)
+[![Dependency Status](http://img.shields.io/gemnasium/wingrunr21/griddler-mandrill.svg?style=flat)](https://gemnasium.com/wingrunr21/griddler-mandrill)
+[![Gem Version](http://img.shields.io/gem/v/griddler-mandrill.svg?style=flat)](https://rubygems.org/gems/griddler-mandrill)
+
+This is an adapter that allows [Griddler](https://github.com/thoughtbot/griddler) to be used with [Mandrill's Inbound Email Processing](http://help.mandrill.com/entries/21699367-Inbound-Email-Processing-Overview).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'griddler'
+    gem 'griddler-mandrill'
+
+
+## Usage
+
+[thoughtbot](http://thoughtbot.com) has a blog post on how to use Griddler over on their blog: [Giant
+Robots](http://robots.thoughtbot.com/handle-incoming-email-with-griddler).
+
+### Additional Setup
+
+When adding a webhook in their administration panel, Mandrill will issue a HEAD
+request to check if the webhook is valid (see [Adding Routes]).  If the HEAD
+request fails, Mandrill will not allow you to add the webhook.  Since Griddler
+is only configured to handle POST requests, you will not be able to add the
+webhook as-is. To solve this, add a temporary route to your application that can
+handle the HEAD request:
+
+    # config/routes.rb
+    get "/email_processor", to: proc { [200, {}, ["OK"]] }, as: "mandrill_head_test_request"
+
+Once you have correctly configured Mandrill, you can go ahead and delete this code.
+
+[Adding Routes]: http://help.mandrill.com/entries/21699367-Inbound-Email-Processing-Overview
+
+## Credits
+
+Griddler::Mandrill was extracted from Griddler by [Stafford Brunk](https://github.com/wingrunr21).
+
+Griddler was written by [Caleb Thompson](https://github.com/calebthompson) and [Joel Oliveira](https://github.com/jayroh).

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-mandrill.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'griddler/mandrill/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'griddler-mandrill-acd'
+  spec.version       = Griddler::Mandrill::VERSION
+  spec.authors       = ['Stafford Brunk']
+  spec.email         = ['stafford.brunk@gmail.com']
+  spec.summary       = %q{Mandrill adapter for Griddler}
+  spec.description   = %q{Adapter to allow the use of Mandrill's Inboud Email Processing with Griddler}
+  spec.homepage      = 'https://github.com/wingrunr21/griddler-mandrill'
+  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{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'griddler-acd'
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'activesupport'
+end

data/lib/griddler/mandrill/adapter.rb

@@ -0,0 +1,73 @@
+module Griddler
+  module Mandrill
+    class Adapter
+      def initialize(params)
+        @params = params
+      end
+
+      def self.normalize_params(params)
+        adapter = new(params)
+        adapter.normalize_params
+      end
+
+      def normalize_params
+        events.map do |event|
+          {
+            to: recipients(:to, event),
+            cc: recipients(:cc, event),
+            from: full_email([ event[:from_email], event[:from_name] ]),
+            subject: event[:subject],
+            text: event.fetch(:text, ''),
+            html: event.fetch(:html, ''),
+            raw_body: event[:raw_msg],
+            attachments: attachment_files(event)
+          }
+        end
+      end
+
+      private
+
+      attr_reader :params
+
+      def events
+        @events ||= ActiveSupport::JSON.decode(params[:mandrill_events]).map do |event|
+          event['msg'].with_indifferent_access
+        end
+      end
+
+      def recipients(field, event)
+        Array.wrap(event[field]).map { |recipient| full_email(recipient) }
+      end
+
+      def full_email(contact_info)
+        email = contact_info[0]
+        if contact_info[1]
+          "#{contact_info[1]} <#{email}>"
+        else
+          email
+        end
+      end
+
+      def attachment_files(event)
+        attachments = event[:attachments] || Array.new
+        attachments.map do |key, attachment|
+          ActionDispatch::Http::UploadedFile.new({
+            filename: attachment[:name],
+            type: attachment[:type],
+            tempfile: create_tempfile(attachment)
+          })
+        end
+      end
+
+      def create_tempfile(attachment)
+        filename = attachment[:name]
+        tempfile = Tempfile.new(filename, Dir::tmpdir, encoding: 'ascii-8bit')
+        content = attachment[:content]
+        content = Base64.decode64(content) if attachment[:base64]
+        tempfile.write(content)
+        tempfile.rewind
+        tempfile
+      end
+    end
+  end
+end

data/lib/griddler/mandrill/version.rb

@@ -0,0 +1,5 @@
+module Griddler
+  module Mandrill
+    VERSION = '1.0.1'
+  end
+end

data/lib/griddler/mandrill.rb

@@ -0,0 +1,5 @@
+require 'griddler'
+require 'griddler/mandrill/version'
+require 'griddler/mandrill/adapter'
+
+Griddler.adapter_registry.register(:mandrill, Griddler::Mandrill::Adapter)

data/spec/griddler/mandrill/adapter_spec.rb

@@ -0,0 +1,217 @@
+require 'spec_helper'
+
+describe Griddler::Mandrill::Adapter do
+  it 'registers itself with griddler' do
+    expect(Griddler.adapter_registry[:mandrill]).to eq Griddler::Mandrill::Adapter
+  end
+end
+
+describe Griddler::Mandrill::Adapter, '.normalize_params' do
+  it 'normalizes parameters' do
+    Griddler::Mandrill::Adapter.normalize_params(default_params).each do |params|
+      expect(params).to be_normalized_to({
+        to: ['The Token <token@reply.example.com>'],
+        cc: ['Emily <emily@example.mandrillapp.com>',
+             'Joey <joey@example.mandrillapp.com>'],
+        from: 'Hernan Example <hernan@example.com>',
+        subject: 'hello',
+        text: %r{Dear bob},
+        html: %r{<p>Dear bob</p>},
+        raw_body: %r{raw}
+      })
+    end
+  end
+
+  it 'passes the received array of files' do
+    params = params_with_attachments
+
+    normalized_params = Griddler::Mandrill::Adapter.normalize_params(params)
+
+    first, second = *normalized_params[0][:attachments]
+
+    expect(first.original_filename).to eq('photo1.jpg')
+    expect(first.size).to eq(upload_1_params[:length])
+
+    expect(second.original_filename).to eq('photo2.jpg')
+    expect(second.size).to eq(upload_2_params[:length])
+  end
+
+  it 'has no attachments' do
+    params = default_params
+
+    normalized_params = Griddler::Mandrill::Adapter.normalize_params(params)
+
+    expect(normalized_params[0][:attachments]).to be_empty
+  end
+
+  it 'works with non-base64 encoded files' do
+    params = params_with_csv_attachment
+
+    normalized_params = Griddler::Mandrill::Adapter.normalize_params(params)
+
+    file, = *normalized_params[0][:attachments]
+
+    expect(file.original_filename).to eq('file.csv')
+    expect(file.size).to eq(upload_3_params[:length])
+  end
+
+  describe 'when the email has no text part' do
+    before do
+      @params = params_hash
+      @params.first[:msg].delete(:text)
+    end
+
+    it 'sets :text to an empty string' do
+      params = default_params(@params)
+      normalized_params = Griddler::Mandrill::Adapter.normalize_params(params)
+      normalized_params.each do |p|
+        expect(p[:text]).to eq ''
+      end
+    end
+  end
+
+  describe 'when the email has no html part' do
+    before do
+      @params = params_hash
+      @params.first[:msg].delete(:html)
+    end
+
+    it 'sets :html to an empty string' do
+      params = default_params(@params)
+      normalized_params = Griddler::Mandrill::Adapter.normalize_params(params)
+      normalized_params.each do |p|
+        expect(p[:html]).to eq ''
+      end
+    end
+  end
+
+  describe 'when the email has no CC recipients' do
+    before do
+      @params = params_hash
+      @params.first[:msg][:cc] = nil
+    end
+
+    it 'should return an empty cc array' do
+      params = default_params(@params)
+      normalized_params = Griddler::Mandrill::Adapter.normalize_params(params)
+      normalized_params.each do |p|
+        expect(p[:cc]).to eq []
+      end
+    end
+  end
+
+  def default_params(params = params_hash)
+    mandrill_events (params * 2).to_json
+  end
+
+  def mandrill_events(json)
+    { mandrill_events: json }
+  end
+
+  def params_hash
+    [{
+      event: 'inbound',
+      ts: 1364601140,
+      msg:
+        {
+          raw_msg: 'raw',
+          headers: {},
+          text: text_body,
+          html: text_html,
+          from_email: 'hernan@example.com',
+          from_name: 'Hernan Example',
+          to: [['token@reply.example.com', 'The Token']],
+          cc: [['emily@example.mandrillapp.com', 'Emily'],
+               ['joey@example.mandrillapp.com', 'Joey']],
+          subject: "hello",
+          spam_report: {
+            score: -0.8,
+            matched_rules: '...'
+            },
+          dkim: { signed: true, valid: true },
+          spf: { result: 'pass', detail: 'sender SPF authorized' },
+          email: 'token@reply.example.com',
+          tags: [],
+          sender: nil
+        }
+    }]
+  end
+
+  def params_with_attachments
+    params = params_hash
+    params[0][:msg][:attachments] = {
+      'photo1.jpg' => upload_1_params,
+      'photo2.jpg' => upload_2_params
+    }
+    mandrill_events params.to_json
+  end
+
+  def params_with_csv_attachment
+    params = params_hash
+    params[0][:msg][:attachments] = {
+      'file.csv' => upload_3_params
+    }
+    mandrill_events params.to_json
+  end
+
+  def text_body
+    <<-EOS.strip_heredoc.strip
+      Dear bob
+
+      Reply ABOVE THIS LINE
+
+      hey sup
+    EOS
+  end
+
+  def text_html
+    <<-EOS.strip_heredoc.strip
+      <p>Dear bob</p>
+
+      Reply ABOVE THIS LINE
+
+      hey sup
+    EOS
+  end
+
+  def upload_1_params
+    @upload_1_params ||= begin
+      file = upload_1
+      size = file.size
+      {
+        name: 'photo1.jpg',
+        content: Base64.encode64(file.read),
+        type: 'image/jpeg',
+        length: size,
+        base64: true
+      }
+    end
+  end
+
+  def upload_2_params
+    @upload_2_params ||= begin
+      file = upload_2
+      size = file.size
+      {
+        name: 'photo2.jpg',
+        content: Base64.encode64(file.read),
+        type: 'image/jpeg',
+        length: size,
+        base64: true
+      }
+    end
+  end
+
+  def upload_3_params
+    @upload_2_params ||= begin
+      content = 'Some | csv | file | here'
+      {
+        name: 'file.csv',
+        content: content,
+        type: 'text/plain',
+        length: content.length,
+        base64: false
+      }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'griddler/testing'
+require 'griddler/mandrill'
+require 'action_dispatch'
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/hash'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.order = 'random'
+  config.include Griddler::Testing
+end
+
+RSpec::Matchers.define :be_normalized_to do |expected|
+  failure_message do |actual|
+    message = ""
+    expected.each do |k, v|
+      message << "expected :#{k} to be normalized to #{expected[k].inspect}, "\
+      "but received #{actual[k].inspect}\n" unless actual[k] == expected[k]
+    end
+    message
+  end
+
+  description do
+    "be normalized to #{expected}"
+  end
+
+  match do |actual|
+    expected.each do |k, v|
+      case v
+      when Regexp then expect(actual[k]).to match v
+      else expect(actual[k]).to eq v
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: griddler-mandrill-acd
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Stafford Brunk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: griddler-acd
+  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: 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: 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: activesupport
+  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'
+description: Adapter to allow the use of Mandrill's Inboud Email Processing with Griddler
+email:
+- stafford.brunk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- griddler-mandrill.gemspec
+- lib/griddler/mandrill.rb
+- lib/griddler/mandrill/adapter.rb
+- lib/griddler/mandrill/version.rb
+- spec/griddler/mandrill/adapter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/wingrunr21/griddler-mandrill
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Mandrill adapter for Griddler
+test_files:
+- spec/griddler/mandrill/adapter_spec.rb
+- spec/spec_helper.rb
+has_rdoc: