kafka_mailer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3295f7b9bec090e10f821b20369619dd697ad861
+  data.tar.gz: cfc2e4da1a2e377b0b55965095c4b058729640a0
+SHA512:
+  metadata.gz: 5231ebe7df6e96e3389bfc315ed84b113237128eaf2a31d9801452790f1cbde885de64a7ee20cb3d5919afa3e14d4c792066f22b8731146d2a8ec48d110decfc
+  data.tar.gz: 87dd4fce1c44543f412ed1b7ea9c6dc244b8c343e5c254bfe473367261c088ae1550fea03c6d991bd32614d87381311f0b9a3618083cd86dd529d9b0093df50d

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1 ##
+
+  * Initial relase

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem "codeclimate-test-reporter", group: :test, require: nil
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Eric Hayes
+
+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,37 @@
+# kafka_mailer [![Build Status](https://travis-ci.org/ejhayes/kafka_mailer.svg?branch=master)](https://travis-ci.org/ejhayes/kafka_mailer) [![Gem Version](https://badge.fury.io/rb/kafka_mailer.svg)](http://badge.fury.io/rb/kafka_mailer) [![Code Climate](https://codeclimate.com/github/ejhayes/kafka_mailer/badges/gpa.svg)](https://codeclimate.com/github/ejhayes/kafka_mailer) [![Test Coverage](https://codeclimate.com/github/ejhayes/kafka_mailer/badges/coverage.svg)](https://codeclimate.com/github/ejhayes/kafka_mailer) [![Dependency Status](https://gemnasium.com/ejhayes/kafka_mailer.svg)](https://gemnasium.com/ejhayes/kafka_mailer) 
+
+Use [Apache Kafka](http://kafka.apache.org/) as a delivery_method in rails.
+
+## Rails Setup
+
+**IMPORTANT**: This is under development right now and is not yet ready for use in a production environment.
+
+First add the gem to your development environment and run the +bundle+ command to install it.
+
+    gem "kafka_mailer"
+
+Then set the delivery method in `config/environments/development.rb`
+
+    config.action_mailer.delivery_method = :kafka
+
+Now your emails will be sent to a kafka message queue.
+
+## Hacking on this gem
+
+Once you have the source, you must run the following:
+
+    bundle
+    bundle exec rake spec
+
+## TODO
+
+Some items that will eventually need to be done:
+
+- provide a config block that can specify the structure of the message being sent to kafka
+
+
+## Thanks to
+
+- Ryan Bates and his [letter_opener](https://github.com/ryanb/letter_opener) which was used as the base for this gem
+- [poseidon](https://github.com/bpot/poseidon) gem for interacting with Apache Kafka
+- [Apache kafka](http://kafka.apache.org/)

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc 'Interactive console with gem pre-loaded'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'ruby-debug'
+  $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+  
+  # load the gem
+  require 'kafka_mailer'
+
+  ARGV.clear
+  puts "Console Ready!"
+  IRB.start
+end

data/lib/kafka_mailer.rb

@@ -0,0 +1,8 @@
+require "fileutils"
+require "digest/sha1"
+require "cgi"
+require "uri"
+
+require "kafka_mailer/message"
+require "kafka_mailer/delivery_method"
+require "kafka_mailer/railtie" if defined? Rails

data/lib/kafka_mailer/delivery_method.rb

@@ -0,0 +1,18 @@
+module KafkaMailer
+  class DeliveryMethod
+    class InvalidOption < StandardError; end
+
+    attr_accessor :settings
+
+    def initialize(options = {})
+      raise InvalidOption, "A location option is required when using the kafka delivery method" if options[:location].nil?
+      self.settings = options
+    end
+
+    def deliver!(mail)
+      byebug
+      location = File.join(settings[:location], "#{Time.now.to_i}_#{Digest::SHA1.hexdigest(mail.encoded)[0..6]}")
+      messages = Message.rendered_messages(location, mail)
+    end
+  end
+end

data/lib/kafka_mailer/message.html.erb

@@ -0,0 +1,125 @@
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=<%= encoding %>">
+    <% if mail.subject %>
+      <title><%= h mail.subject %></title>
+    <% end %>
+
+    <style type="text/css">
+      #container {
+        margin: 10px auto;
+      }
+      #message_headers {
+        background: #fff;
+        font-size: 12px;
+        font-family: "Segoe UI", "Helvetica Neue", Arial, sans-serif;
+        border-bottom: 1px solid #dedede;
+        margin-bottom: 10px;
+        overflow: auto;
+      }
+
+      #message_headers dl {
+        float: left;
+        line-height: 1.3em;
+        padding: 0;
+      }
+
+      #message_headers dt {
+        width: 92px;
+        margin: 0;
+        float: left;
+        text-align: right;
+        font-weight: bold;
+        color: #7f7f7f;
+      }
+
+      #message_headers dd {
+        margin: 0 0 0 102px;
+      }
+
+      #message_headers p.alternate {
+        float: right;
+        margin: 0;
+      }
+
+      #message_headers p.alternate a {
+        color: #09c;
+      }
+
+      pre#message_body {
+        padding: 4px;
+        white-space: pre-wrap;
+        border: 1px solid #eee;
+        background-color: #fcfcfc;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="container">
+      <div id="message_headers">
+        <dl>
+          <dt>From:</dt>
+          <dd><%= h from %></dd>
+
+          <% unless sender.empty? %>
+            <dt>Sender:</dt>
+            <dd><%= h sender %></dd>
+          <% end %>
+
+          <% unless reply_to.empty? %>
+            <dt>Reply-To:</dt>
+            <dd><%= h reply_to %></dd>
+          <% end %>
+
+          <% if mail.subject %>
+            <dt>Subject:</dt>
+            <dd><strong><%= h mail.subject %></strong></dd>
+          <% end %>
+
+          <dt>Date:</dt>
+          <dd><%= Time.now.strftime("%b %e, %Y %I:%M:%S %p %Z") %></dd>
+
+          <% unless to.empty? %>
+            <dt>To:</dt>
+            <dd><%= h to %></dd>
+          <% end %>
+
+          <% unless cc.empty? %>
+            <dt>CC:</dt>
+            <dd><%= h cc %></dd>
+          <% end %>
+
+          <% unless bcc.empty? %>
+            <dt>BCC:</dt>
+            <dd><%= h bcc %></dd>
+          <% end %>
+
+          <% if @attachments.any? %>
+            <dt>Attachments:</dt>
+            <dd>
+            <% @attachments.each do |filename, path| %>
+              <a href="<%= path %>"><%= filename %></a>&nbsp;
+            <% end %>
+            </dd>
+          <% end %>
+        </dl>
+
+        <% if mail.multipart? %>
+          <p class="alternate">
+            <% if type == "plain" && mail.html_part %>
+              <a href="rich.html">View HTML version</a>
+            <% elsif type == "rich" && mail.text_part %>
+              <a href="plain.html">View plain text version</a>
+            <% end %>
+          </p>
+        <% end %>
+      </div>
+
+      <% if type == "plain" %>
+        <pre id="message_body"><%= auto_link(h(body)) %></pre>
+      <% else %>
+        <%= body %>
+      <% end %>
+    </div>
+  </body>
+</html>

data/lib/kafka_mailer/message.rb

@@ -0,0 +1,117 @@
+require "erb"
+
+module KafkaMailer
+  class Message
+    attr_reader :mail
+
+    def self.rendered_messages(location, mail)
+      messages = []
+      messages << new(location, mail, mail.html_part) if mail.html_part
+      messages << new(location, mail, mail.text_part) if mail.text_part
+      messages << new(location, mail) if messages.empty?
+      messages.each(&:render)
+      messages.sort
+    end
+
+    def initialize(location, mail, part = nil)
+      @location = location
+      @mail = mail
+      @part = part
+      @attachments = []
+    end
+
+    def render
+      FileUtils.mkdir_p(@location)
+
+      if mail.attachments.any?
+        attachments_dir = File.join(@location, 'attachments')
+        FileUtils.mkdir_p(attachments_dir)
+        mail.attachments.each do |attachment|
+          filename = attachment.filename.gsub(/[^\w.]/, '_')
+          path = File.join(attachments_dir, filename)
+
+          unless File.exists?(path) # true if other parts have already been rendered
+            File.open(path, 'wb') { |f| f.write(attachment.body.raw_source) }
+          end
+
+          @attachments << [attachment.filename, "attachments/#{URI.escape(filename)}"]
+        end
+      end
+
+      File.open(filepath, 'w') do |f|
+        f.write ERB.new(template).result(binding)
+      end
+    end
+
+    def template
+      File.read(File.expand_path("../message.html.erb", __FILE__))
+    end
+
+    def filepath
+      File.join(@location, "#{type}.html")
+    end
+
+    def content_type
+      @part && @part.content_type || @mail.content_type
+    end
+
+    def body
+      @body ||= begin
+        body = (@part || @mail).decoded
+
+        mail.attachments.each do |attachment|
+          body.gsub!(attachment.url, "attachments/#{attachment.filename}")
+        end
+
+        body
+      end
+    end
+
+    def from
+      @from ||= Array(@mail['from']).join(", ")
+    end
+
+    def sender
+      @sender ||= Array(@mail['sender']).join(", ")
+    end
+
+    def to
+      @to ||= Array(@mail['to']).join(", ")
+    end
+
+    def cc
+      @cc ||= Array(@mail['cc']).join(", ")
+    end
+
+    def bcc
+      @bcc ||= Array(@mail['bcc']).join(", ")
+    end
+
+    def reply_to
+      @reply_to ||= Array(@mail['reply-to']).join(", ")
+    end
+
+    def type
+      content_type =~ /html/ ? "rich" : "plain"
+    end
+
+    def encoding
+      body.respond_to?(:encoding) ? body.encoding : "utf-8"
+    end
+
+    def auto_link(text)
+      text.gsub(URI.regexp(%W[https http])) do |link|
+        "<a href=\"#{ link }\">#{ link }</a>"
+      end
+    end
+
+    def h(content)
+      CGI.escapeHTML(content)
+    end
+
+    def <=>(other)
+      order = %w[rich plain]
+      order.index(type) <=> order.index(other.type)
+    end
+  end
+end

data/lib/kafka_mailer/railtie.rb

@@ -0,0 +1,9 @@
+module KafkaMailer
+  class Railtie < Rails::Railtie
+    initializer "letter_opener.add_delivery_method" do
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.add_delivery_method :kafka, KafkaMailer::DeliveryMethod, :location => Rails.root.join("tmp", "kafka_mailer")
+      end
+    end
+  end
+end

data/spec/letter_opener/delivery_method_spec.rb

@@ -0,0 +1,277 @@
+require "spec_helper"
+
+describe KafkaMailer::DeliveryMethod do
+  let(:location)   { File.expand_path('../../../tmp/kafka_mailer', __FILE__) }
+
+  let(:plain_file) { Dir["#{location}/*/plain.html"].first }
+  let(:plain)      { CGI.unescape_html(File.read(plain_file)) }
+
+  before do
+    # TODO: STUB kafka connection
+    context = self
+
+    Mail.defaults do
+      delivery_method KafkaMailer::DeliveryMethod, :location => context.location
+    end
+  end
+
+  it 'raises an exception if no location passed' do
+    # expect { KafkaMailer::DeliveryMethod.new }.to raise_exception(KafkaMailer::DeliveryMethod::InvalidOption)
+    # expect { KafkaMailer::DeliveryMethod.new(location: "foo") }.to_not raise_exception
+  end
+
+  context 'integration' do
+
+    #context 'normal location path' do
+    #  it 'opens email' do
+    #    expect($stdout).to receive(:puts)
+    #    expect {
+    #      Mail.deliver do
+    #        from 'Foo foo@example.com'
+    #        body 'World! http://example.com'
+    #      end
+    #    }.not_to raise_error
+    #  end
+    #end
+
+    #context 'with spaces in location path' do
+    #  let(:location) { File.expand_path('../../../tmp/kafka_mailer with space', __FILE__) }
+    #
+    #  it 'opens email' do
+    #    expect($stdout).to receive(:puts)
+    #    expect {
+    #      Mail.deliver do
+    #        from 'Foo foo@example.com'
+    #        body 'World! http://example.com'
+    #      end
+    #    }.not_to raise_error
+    #  end
+    #end
+  end
+
+  context 'content' do
+    context 'plain' do
+      before do
+        #expect(Launchy).to receive(:open)
+
+        Mail.deliver do
+          from     'Foo <foo@example.com>'
+          sender   'Baz <baz@example.com>'
+          reply_to 'No Reply <no-reply@example.com>'
+          to       'Bar <bar@example.com>'
+          cc       'Qux <qux@example.com>'
+          bcc      'Qux <qux@example.com>'
+          subject  'Hello'
+          body     'World! http://example.com'
+        end
+      end
+
+      # TODO: check message queue getting correct params
+      #it 'creates plain html document' do
+      #  expect(File.exist?(plain_file)).to be_true
+      #end
+      #
+      #it 'saves From field' do
+      #  expect(plain).to include("Foo <foo@example.com>")
+      #end
+      #
+      #it 'saves Sender field' do
+      #  expect(plain).to include("Baz <baz@example.com>")
+      #end
+      #
+      #it 'saves Reply-to field' do
+      #  expect(plain).to include("No Reply <no-reply@example.com>")
+      #end
+      #
+      #it 'saves To field' do
+      #  expect(plain).to include("Bar <bar@example.com>")
+      #end
+      #
+      #it 'saves Subject field' do
+      #  expect(plain).to include("Hello")
+      #end
+      #
+      #it 'saves Body with autolink' do
+      #  expect(plain).to include('World! <a href="http://example.com">http://example.com</a>')
+      #end
+    end
+
+    context 'multipart' do
+      let(:rich_file) { Dir["#{location}/*/rich.html"].first }
+      let(:rich) { CGI.unescape_html(File.read(rich_file)) }
+
+      before do
+        #expect(Launchy).to receive(:open)
+
+        Mail.deliver do
+          from    'foo@example.com'
+          to      'bar@example.com'
+          subject 'Many parts with <html>'
+          text_part do
+            body 'This is <plain> text'
+          end
+          html_part do
+            content_type 'text/html; charset=UTF-8'
+            body '<h1>This is HTML</h1>'
+          end
+        end
+      end
+
+      #it 'creates plain html document' do
+      #  expect(File.exist?(plain_file)).to be_true
+      #end
+      #
+      #it 'creates rich html document' do
+      #  expect(File.exist?(rich_file)).to be_true
+      #end
+      #
+      #it 'shows link to rich html version' do
+      #  expect(plain).to include("View HTML version")
+      #end
+      #
+      #it 'saves text part' do
+      #  expect(plain).to include("This is <plain> text")
+      #end
+      #
+      #it 'saves html part' do
+      #  expect(rich).to include("<h1>This is HTML</h1>")
+      #end
+      #
+      #it 'saves escaped Subject field' do
+      #  expect(plain).to include("Many parts with <html>")
+      #end
+      #
+      #it 'shows subject as title' do
+      #  expect(rich).to include("<title>Many parts with <html></title>")
+      #end
+    end
+  end
+
+  context 'using deliver! method' do
+    before do
+      #expect(Launchy).to receive(:open)
+      Mail.new do
+        from    'foo@example.com'
+        to      'bar@example.com'
+        subject 'Hello'
+        body    'World!'
+      end.deliver!
+    end
+
+    #it 'creates plain html document' do
+    #  expect(File.exist?(plain_file)).to be_true
+    #end
+    #
+    #it 'saves From field' do
+    #  expect(plain).to include("foo@example.com")
+    #end
+    #
+    #it 'saves To field' do
+    #  expect(plain).to include("bar@example.com")
+    #end
+    #
+    #it 'saves Subject field' do
+    #  expect(plain).to include("Hello")
+    #end
+    #
+    #it 'saves Body field' do
+    #  expect(plain).to include("World!")
+    #end
+  end
+
+  context 'attachments in plain text mail' do
+    before do
+      Mail.deliver do
+        from      'foo@example.com'
+        to        'bar@example.com'
+        subject   'With attachments'
+        text_part do
+          body 'This is <plain> text'
+        end
+        attachments[File.basename(__FILE__)] = File.read(__FILE__)
+      end
+    end
+
+    #it 'creates attachments dir with attachment' do
+    #  attachment = Dir["#{location}/*/attachments/#{File.basename(__FILE__)}"].first
+    #  expect(File.exists?(attachment)).to be_true
+    #end
+    #
+    #it 'saves attachment name' do
+    #  plain = File.read(Dir["#{location}/*/plain.html"].first)
+    #  expect(plain).to include(File.basename(__FILE__))
+    #end
+  end
+
+  context 'attachments in rich mail' do
+    let(:url) { mail.attachments[0].url }
+
+    let!(:mail) do
+      Mail.deliver do
+        from      'foo@example.com'
+        to        'bar@example.com'
+        subject   'With attachments'
+        attachments[File.basename(__FILE__)] = File.read(__FILE__)
+        url = attachments[0].url
+        html_part do
+          content_type 'text/html; charset=UTF-8'
+          body "Here's an image: <img src='#{url}' />"
+        end
+      end
+    end
+
+    #it 'creates attachments dir with attachment' do
+    #  attachment = Dir["#{location}/*/attachments/#{File.basename(__FILE__)}"].first
+    #  expect(File.exists?(attachment)).to be_true
+    #end
+    #
+    #it 'replaces inline attachment urls' do
+    #  text = File.read(Dir["#{location}/*/rich.html"].first)
+    #  expect(mail.parts[0].body).to include(url)
+    #  expect(text).to_not include(url)
+    #  expect(text).to include("attachments/#{File.basename(__FILE__)}")
+    #end
+  end
+
+  context 'attachments with non-word characters in the filename' do
+    before do
+      Mail.deliver do
+        from      'foo@example.com'
+        to        'bar@example.com'
+        subject   'With attachments'
+        text_part do
+          body 'This is <plain> text'
+        end
+        attachments['non word:chars/used,01.txt'] = File.read(__FILE__)
+      end
+    end
+
+    #it 'creates attachments dir with attachment' do
+    #  attachment = Dir["#{location}/*/attachments/non_word_chars_used_01.txt"].first
+    #  expect(File.exists?(attachment)).to be_true
+    #end
+    #
+    #it 'saves attachment name' do
+    #  plain = File.read(Dir["#{location}/*/plain.html"].first)
+    #  expect(plain).to include('non_word_chars_used_01.txt')
+    #end
+  end
+
+
+  context 'subjectless mail' do
+    before do
+      #expect(Launchy).to receive(:open)
+
+      Mail.deliver do
+        from     'Foo foo@example.com'
+        reply_to 'No Reply no-reply@example.com'
+        to       'Bar bar@example.com'
+        body     'World! http://example.com'
+      end
+    end
+
+    #it 'creates plain html document' do
+    #  expect(File.exist?(plain_file)).to be_true
+    #end
+  end
+end

data/spec/letter_opener/message_spec.rb

@@ -0,0 +1,204 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe KafkaMailer::Message do
+  let(:location) { File.expand_path('../../../tmp/letter_opener', __FILE__) }
+
+  def mail(options={}, &blk)
+    Mail.new(options, &blk)
+  end
+
+  describe '#reply_to' do
+    it 'handles one email as a string' do
+      mail    = mail(:reply_to => 'test@example.com')
+      message = described_class.new(location, mail)
+      expect(message.reply_to).to eq('test@example.com')
+    end
+
+    it 'handles one email with display names' do
+      mail    = mail(:reply_to => 'test <test@example.com>')
+      message = described_class.new(location, mail)
+      expect(message.reply_to).to eq('test <test@example.com>')
+    end
+
+    it 'handles array of emails' do
+      mail    = mail(:reply_to => ['test1@example.com', 'test2@example.com'])
+      message = described_class.new(location, mail)
+      expect(message.reply_to).to eq('test1@example.com, test2@example.com')
+    end
+
+    it 'handles array of emails with display names' do
+      mail    = mail(:reply_to => ['test1 <test1@example.com>', 'test2 <test2@example.com>'])
+      message = described_class.new(location, mail)
+      expect(message.reply_to).to eq('test1 <test1@example.com>, test2 <test2@example.com>')
+    end
+
+  end
+
+  describe '#to' do
+    it 'handles one email as a string' do
+      mail   = mail(:to => 'test@example.com')
+      message = described_class.new(location, mail)
+      expect(message.to).to eq('test@example.com')
+    end
+
+    it 'handles one email with display names' do
+      mail    = mail(:to => 'test <test@example.com>')
+      message = described_class.new(location, mail)
+      expect(message.to).to eq('test <test@example.com>')
+    end
+
+    it 'handles array of emails' do
+      mail    = mail(:to => ['test1@example.com', 'test2@example.com'])
+      message = described_class.new(location, mail)
+      expect(message.to).to eq('test1@example.com, test2@example.com')
+    end
+
+    it 'handles array of emails with display names' do
+      mail    = mail(:to => ['test1 <test1@example.com>', 'test2 <test2@example.com>'])
+      message = described_class.new(location, mail)
+      expect(message.to).to eq('test1 <test1@example.com>, test2 <test2@example.com>')
+    end
+
+  end
+
+  describe '#cc' do
+    it 'handles one cc email as a string' do
+      mail    = mail(:cc => 'test@example.com')
+      message = described_class.new(location, mail)
+      expect(message.cc).to eq('test@example.com')
+    end
+
+    it 'handles one cc email with display name' do
+      mail    = mail(:cc => ['test <test1@example.com>', 'test2 <test2@example.com>'])
+      message = described_class.new(location, mail)
+      expect(message.cc).to eq('test <test1@example.com>, test2 <test2@example.com>')
+    end
+
+    it 'handles array of cc emails' do
+      mail    = mail(:cc => ['test1@example.com', 'test2@example.com'])
+      message = described_class.new(location, mail)
+      expect(message.cc).to eq('test1@example.com, test2@example.com')
+    end
+
+    it 'handles array of cc emails with display names' do
+      mail    = mail(:cc => ['test <test1@example.com>', 'test2 <test2@example.com>'])
+      message = described_class.new(location, mail)
+      expect(message.cc).to eq('test <test1@example.com>, test2 <test2@example.com>')
+    end
+
+  end
+
+  describe '#bcc' do
+    it 'handles one bcc email as a string' do
+      mail    = mail(:bcc => 'test@example.com')
+      message = described_class.new(location, mail)
+      expect(message.bcc).to eq('test@example.com')
+    end
+
+    it 'handles one bcc email with display name' do
+      mail    = mail(:bcc => ['test <test1@example.com>', 'test2 <test2@example.com>'])
+      message = described_class.new(location, mail)
+      expect(message.bcc).to eq('test <test1@example.com>, test2 <test2@example.com>')
+    end
+
+    it 'handles array of bcc emails' do
+      mail    = mail(:bcc => ['test1@example.com', 'test2@example.com'])
+      message = described_class.new(location, mail)
+      expect(message.bcc).to eq('test1@example.com, test2@example.com')
+    end
+
+    it 'handles array of bcc emails with display names' do
+      mail    = mail(:bcc => ['test <test1@example.com>', 'test2 <test2@example.com>'])
+      message = described_class.new(location, mail)
+      expect(message.bcc).to eq('test <test1@example.com>, test2 <test2@example.com>')
+    end
+
+  end
+
+  describe '#sender' do
+    it 'handles one email as a string' do
+      mail    = mail(:sender => 'sender@example.com')
+      message = described_class.new(location, mail)
+      expect(message.sender).to eq('sender@example.com')
+    end
+
+    it 'handles one email as a string with display name' do
+      mail    = mail(:sender => 'test <test@example.com>')
+      message = described_class.new(location, mail)
+      expect(message.sender).to eq('test <test@example.com>')
+    end
+
+    it 'handles array of emails' do
+      mail    = mail(:sender => ['sender1@example.com', 'sender2@example.com'])
+      message = described_class.new(location, mail)
+      expect(message.sender).to eq('sender1@example.com, sender2@example.com')
+    end
+
+    it 'handles array of emails with display names' do
+      mail    = mail(:sender => ['test <test1@example.com>', 'test2 <test2@example.com>'])
+      message = described_class.new(location, mail)
+      expect(message.sender).to eq('test <test1@example.com>, test2 <test2@example.com>')
+    end
+
+  end
+
+  describe '#<=>' do
+    it 'sorts rich type before plain type' do
+      plain = described_class.new(location, double(content_type: 'text/plain'))
+      rich  = described_class.new(location, double(content_type: 'text/html'))
+      expect([plain, rich].sort).to eq([rich, plain])
+    end
+  end
+
+  describe '#auto_link' do
+    let(:message){ described_class.new(location, mail) }
+
+    it 'does not modify unlinkable text' do
+      text = 'the quick brown fox jumped over the lazy dog'
+      expect(message.auto_link(text)).to eq(text)
+    end
+
+    it 'adds links for http' do
+      raw = "Link to http://localhost:3000/example/path path"
+      linked = "Link to <a href=\"http://localhost:3000/example/path\">http://localhost:3000/example/path</a> path"
+      expect(message.auto_link(raw)).to eq(linked)
+    end
+  end
+
+  describe '#body' do
+    it 'handles UTF-8 charset body correctly, with QP CTE, for a non-multipart message' do
+      mail = mail(:sender => 'sender@example.com') do
+        content_type "text/html; charset=UTF-8"
+        content_transfer_encoding 'quoted-printable'
+        body "☃"
+      end
+      message = described_class.new(location, mail)
+      expect(message.body.encoding.name).to eq('UTF-8')
+    end
+
+    it 'handles UTF-8 charset HTML part body correctly, with QP CTE, for a multipart message' do
+      mail = mail(:sender => 'sender@example.com') do
+        html_part do
+          content_type "text/html; charset=UTF-8"
+          content_transfer_encoding 'quoted-printable'
+          body "☃"
+        end
+      end
+      message = described_class.new(location, mail, mail.html_part)
+      expect(message.body.encoding.name).to eq('UTF-8')
+    end
+
+    it 'handles UTF-8 charset text part body correctly, with QP CTE, for a multipart message' do
+      mail = mail(:sender => 'sender@example.com') do
+        text_part do
+          content_type "text/plain; charset=UTF-8"
+          content_transfer_encoding 'quoted-printable'
+          body "☃"
+        end
+      end
+      message = described_class.new(location, mail, mail.text_part)
+      expect(message.body.encoding.name).to eq('UTF-8')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# Code coverage
+# Travis: use code climate
+# Everything else: simplecov
+if ENV['RAILS_ENV'] == 'travis'
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+else
+  require 'simplecov'
+  SimpleCov.start
+end
+
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:default)
+
+require "mail"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: kafka_mailer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric Hayes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: poseidon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+description: When mail is sent from your application, kafka_mailer will put the message
+  contents in a kafka queue.
+email: eric@deployfx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/kafka_mailer.rb
+- lib/kafka_mailer/delivery_method.rb
+- lib/kafka_mailer/message.html.erb
+- lib/kafka_mailer/message.rb
+- lib/kafka_mailer/railtie.rb
+- spec/letter_opener/delivery_method_spec.rb
+- spec/letter_opener/message_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ejhayes/kafka_mailer
+licenses: []
+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: Send email to apache kafka message queue.
+test_files: []