mail-mad_mimi 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mail-mad_mimi.gemspec
+gemspec

data/README.md

@@ -0,0 +1,70 @@
+# Mail::MadMimi
+
+`Mail::MadMimi` is a delivery method for `Mail`.
+It uses the `MadMimi` library to send mail via [Mad Mimi][1].
+
+## Installation
+
+Add to your `Gemfile`:
+
+    gem "mail-mad_mimi", :require => "mail/mad_mimi"
+
+## Usage
+
+    require "mail"
+    require "mail/mad_mimi"
+
+    mail = Mail.new do
+      to              "user@example.com"
+      from            "sender@example.com"
+      subject         "test"
+      delivery_method Mail::MadMimi, :email => "sender@example.com", :api_key => "1234"
+    end
+
+    mail.deliver
+
+## Headers and options
+
+The `:to`, `:from`, `:bcc`, and `:subject`
+headers are taken from the `Mail` object passed to
+`deliver!`
+
+In addition, any hash values given as a `:mad_mimi` header are
+passed on to Mad Mimi. That means if you use the `Mail` object with
+a different delivery method, you'll get an ugly `mad_mimi` header.
+
+You can see other available options on the [Mad Mimi developer site][2].
+
+HTML (`:raw_html`) and plain text (`:raw_plain_text`) bodies are extracted
+from the `Mail` object.
+
+Use `:list_name => "beta users"` to send to a list or `:to_all => true`
+to send to all subscribers.
+
+## Mad Mimi macros
+
+If you are sending to an individual email address, the body must
+include `[[tracking_beacon]]` or `[[peek_image]]`.
+
+If you are sending to a list or everyone, the body must include
+`[[opt_out]]` or `unsubscribe`.
+
+An exception will be raised if you don't include a macro. When debugging,
+you may want to make sure that you set `raise_delivery_errors = true`
+on your `Mail` object.
+
+## Rails 3 support
+
+If `ActionMailer` is loaded, `Mail::MadMimi` registers itself as a
+delivery method.
+
+You can then configure it in an environment file:
+
+    config.action_mailer.delivery_method = :mad_mimi
+    config.action_mailer.mad_mimi_settings = {
+      :email   => "user@example.com",
+      :api_key => "a1b9892611956aa13a5ab9ccf01f4966",
+    }
+
+[1]: http://madmimi.com
+[2]: http://madmimi.com/developer/mailer/transactional

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+Bundler::GemHelper.install_tasks
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new {|task| task.pattern = "spec" }

data/lib/mail/mad_mimi/version.rb

@@ -0,0 +1,5 @@
+module Mail
+  class MadMimi
+    VERSION = "1.0.0"
+  end
+end

data/lib/mail/mad_mimi.rb

@@ -0,0 +1,60 @@
+require "madmimi"
+
+module Mail #:nodoc:
+  # Mail::MadMimi is a delivery method for <tt>Mail</tt>.
+  # It uses the <tt>MadMimi</tt> library to send mail via Mad Mimi.
+
+  class MadMimi
+    class Error < StandardError; end
+    attr_accessor :settings, :mimi
+
+    # Any settings given here will be passed to Mad Mimi.
+    #
+    # <tt>:email</tt> and <tt>:api_key</tt> are required.
+    def initialize(settings = {})
+      unless settings[:email] && settings[:api_key]
+        raise Error, "Missing :email and :api_key settings"
+      end
+
+      self.settings = settings
+      self.mimi = ::MadMimi.new settings[:email], settings[:api_key]
+    end
+
+    def options_from_mail(mail)
+      settings.merge(
+        :recipients => mail[:to].to_s,
+        :from       => mail[:from].to_s,
+        :bcc        => mail[:bcc].to_s,
+        :subject    => mail.subject
+      ).tap do |options|
+        options[:raw_html]       = mail.html_part.body.to_s if mail.html_part
+        options[:raw_plain_text] = mail.text_part.body.to_s if mail.text_part
+
+        if mail.respond_to? :mailer_action
+          options[:promotion_name] = mail.mailer_action 
+        end
+
+        options.merge!(mail[:mad_mimi].value) if mail[:mad_mimi]
+      end
+    end
+
+    def deliver!(mail)
+      mimi.send_mail(options_from_mail(mail), {}).tap do |response|
+        raise Error, response if response.to_i.zero?  # no transaction id
+      end
+    end
+
+    if defined? ActionMailer::Base
+      ActionMailer::Base.add_delivery_method :mad_mimi, Mail::MadMimi
+
+      module SetMailerAction
+        def wrap_delivery_behavior!(*args)
+          super
+          message.class_eval { attr_accessor :mailer_action }
+          message.mailer_action = "#{self.class}.#{action_name}"
+        end
+      end
+      ActionMailer::Base.send :include, SetMailerAction
+    end
+  end
+end

data/mail-mad_mimi.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mail/mad_mimi/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mail-mad_mimi"
+  s.version     = Mail::MadMimi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Grant Hollingworth"]
+  s.email       = ["grant@antiflux.org"]
+  s.homepage    = "https://github.com/granth/mail-mad_mimi"
+  s.summary     = "A Mad Mimi delivery method for the Ruby Mail library, with Rails 3 support."
+  s.description = s.summary
+
+  s.rubyforge_project = "mail-mad_mimi"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "madmimi", "~> 1.0.15"
+  s.add_runtime_dependency "mail", "~> 2.2"
+  s.add_development_dependency "rspec", "~> 2.6"
+  s.add_development_dependency "actionmailer", "~> 3.0"
+end

data/spec/mail/action_mailer_spec.rb

@@ -0,0 +1,18 @@
+require "action_mailer"
+require "spec_helper"
+
+class TestMailer < ActionMailer::Base
+  def testo
+    mail :to => "testo@example.com"
+  end
+end
+
+describe Mail::MadMimi, "when ActionMailer is loaded" do
+  it "should register itself as a delivery_method" do
+    ActionMailer::Base.delivery_methods[:mad_mimi].should == Mail::MadMimi
+  end
+
+  it "should add a mailer_action method to messages for the promotion name" do
+    TestMailer.testo.mailer_action.should == "TestMailer.testo"
+  end
+end

data/spec/mail/mad_mimi_spec.rb

@@ -0,0 +1,135 @@
+require "spec_helper"
+
+describe Mail::MadMimi do
+  let(:required_settings) { {:email => "joe@example.com", :api_key => "123"} }
+
+  context "when created without an email address or API key" do
+    it "should raise an error" do
+      expect { Mail::MadMimi.new }.to raise_error Mail::MadMimi::Error
+    end
+  end
+
+  context "when created with an email address and API key" do
+    subject { Mail::MadMimi.new required_settings }
+
+    it "should pass the email address and API key to MadMimi" do
+      subject.mimi.should be_a ::MadMimi
+      subject.mimi.username.should == "joe@example.com"
+      subject.mimi.api_key.should  == "123"
+    end
+
+    it "should have a settings accessor" do
+      subject.settings.should == required_settings
+    end
+  end
+
+  context "getting options from a Mail::Message" do
+    subject { Mail::MadMimi.new required_settings }
+
+    let(:mail) do
+      Mail.new do
+        to      "Andrew <andrew@example.com>"
+        from    "Bob <bob@example.com>"
+        bcc     "charlie@example.com"
+        subject "test mail"
+      end
+    end
+
+    let(:options) { subject.options_from_mail(mail) }
+
+    it "should create a hash of options" do
+      options[:recipients].should == "Andrew <andrew@example.com>"
+      options[:from].should       == "Bob <bob@example.com>"
+      options[:bcc].should        == "charlie@example.com"
+      options[:subject].should    == "test mail"
+    end
+
+    it "should merge in the class settings" do
+      subject.settings[:hidden] = true  # hide in Mad Mimi interface
+      options[:hidden].should be_true
+    end
+
+    it "should merge in :mad_mimi settings in mail object" do
+      mail[:mad_mimi] = {:promotion_name => "custom"}
+      options[:promotion_name].should == "custom"
+    end
+
+    context "with a text part" do
+      before(:each) do
+        mail.text_part do
+          body "text body"
+        end
+      end
+
+      it "should set :raw_plain_text" do
+        options[:raw_plain_text].should == "text body"
+      end
+
+      it "should not set :raw_html to ensure plain text from Mad Mimi" do
+        options.should_not have_key :raw_html
+      end
+    end
+
+    context "with an HTML part" do
+      before(:each) do
+        mail.html_part do
+          content_type "text/html"
+          body         "html body"
+        end
+      end
+
+      it "should set :raw_html" do
+        options[:raw_html].should == "html body"
+      end
+    end
+
+    context "with a mailer_action method" do
+      before(:each) do
+        mail.stub :mailer_action => "Mailer.method"
+      end
+
+      it "should set the promotion name" do
+        options[:promotion_name].should == "Mailer.method"
+      end
+    end
+  end
+
+  context "delivering" do
+    subject { Mail::MadMimi.new required_settings }
+
+    let(:mail) do
+      Mail.new do
+        to      "Andrew <andrew@example.com>"
+        from    "bob@example.com"
+        bcc     "charlie@example.com"
+        subject "test mail"
+      end
+    end
+
+    let(:options) { subject.options_from_mail mail }
+
+    before(:each) do
+      subject.mimi.stub :send_mail => "1234"  # returns transaction id
+    end
+
+    it "should call MadMimi#send_mail" do
+      subject.mimi.should_receive(:send_mail).with(options, {})
+      subject.deliver! mail
+    end
+
+    it "should return the transaction id" do
+      subject.deliver!(mail).should == "1234"
+    end
+
+    context "with an error response" do
+      before(:each) do
+        subject.mimi.stub :send_mail => "oh no"
+      end
+
+      it "should raise the error" do
+        expect { subject.deliver! mail }.
+          to raise_error Mail::MadMimi::Error, "oh no"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "mail/mad_mimi"
+require "mail"

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: mail-mad_mimi
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Grant Hollingworth
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: madmimi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 0
+        - 15
+        version: 1.0.15
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mail
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 2
+        version: "2.2"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: actionmailer
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :development
+  version_requirements: *id004
+description: A Mad Mimi delivery method for the Ruby Mail library, with Rails 3 support.
+email: 
+- grant@antiflux.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- lib/mail/mad_mimi.rb
+- lib/mail/mad_mimi/version.rb
+- mail-mad_mimi.gemspec
+- spec/mail/action_mailer_spec.rb
+- spec/mail/mad_mimi_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/granth/mail-mad_mimi
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: mail-mad_mimi
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: A Mad Mimi delivery method for the Ruby Mail library, with Rails 3 support.
+test_files: 
+- spec/mail/action_mailer_spec.rb
+- spec/mail/mad_mimi_spec.rb
+- spec/spec_helper.rb
+has_rdoc: