multi_mail 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcb39c73b30d0f52705ccc4d3f24bcb1142a974d
-  data.tar.gz: c1a3e5183e6755f559475f3a4dcda2f8103d89fb
+  metadata.gz: a14ecc758499e8df176c767f62299f37df33cb18
+  data.tar.gz: 32b938fec60cb8e6ae4b458bc5e88ccdcfd5237f
 SHA512:
-  metadata.gz: b93ac384cfad8aa761a4cf21073a1c5ac4379493be11e8823f82006b8b8f2500e0868a5a1f545c09f22ecde04e107ec54d3cba42aaedfbb6f27a03e6f7f84196
-  data.tar.gz: f850d3ba49bc77ba05a54d0851920495bfa8ae4030d5a6f574d436009b6a115032b3e1ac5bccf0e59251ce379425ca6161713b6a6c12733598069628662dfffd
+  metadata.gz: 00473360787d54704565c3c4be5c25af31e27254fc64495ea229e59d934a64f8a645bd43b0687a39ebba94f5b488a0aa76192aee6c6b24b5384a79c4d501fa10
+  data.tar.gz: 7b43f573c40d70d6eab2f2a5f5fc2456f3b3cff2941701f2ec748ee1a8b509806a8828f230ae2dfaddc93da0f9e777487bad7da586084c685c0e3078d419ee6e

data/.gitignore

@@ -4,5 +4,4 @@
 Gemfile.lock
 doc/*
 pkg/*
-spec/cassettes
 api_keys.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -1,10 +1,9 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
   - 2.0.0
-  - ree
+  - 2.1.0
+  - 2.2.0
 env:
   global:
     # MAILGUN_API_KEY

data/.yardopts

@@ -1,4 +1,3 @@
---no-private
 --hide-void-return
 --embed-mixin ClassMethods
 --markup=markdown

data/Gemfile

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

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Open North Inc.
+Copyright (c) 2012 James McKinney
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,9 +1,10 @@
-# MultiMail: easily switch email APIs
+# MultiMail: Easily switch email APIs
 
-[![Build Status](https://secure.travis-ci.org/opennorth/multi_mail.png)](http://travis-ci.org/opennorth/multi_mail)
-[![Dependency Status](https://gemnasium.com/opennorth/multi_mail.png)](https://gemnasium.com/opennorth/multi_mail)
-[![Coverage Status](https://coveralls.io/repos/opennorth/multi_mail/badge.png?branch=master)](https://coveralls.io/r/opennorth/multi_mail)
-[![Code Climate](https://codeclimate.com/github/opennorth/multi_mail.png)](https://codeclimate.com/github/opennorth/multi_mail)
+[![Gem Version](https://badge.fury.io/rb/multi_mail.svg)](https://badge.fury.io/rb/multi_mail)
+[![Build Status](https://secure.travis-ci.org/jpmckinney/multi_mail.png)](https://travis-ci.org/jpmckinney/multi_mail)
+[![Dependency Status](https://gemnasium.com/jpmckinney/multi_mail.png)](https://gemnasium.com/jpmckinney/multi_mail)
+[![Coverage Status](https://coveralls.io/repos/jpmckinney/multi_mail/badge.png)](https://coveralls.io/r/jpmckinney/multi_mail)
+[![Code Climate](https://codeclimate.com/github/jpmckinney/multi_mail.png)](https://codeclimate.com/github/jpmckinney/multi_mail)
 
 Many providers offer APIs to send, receive, and parse email. MultiMail lets you easily switch between these APIs, and integrates tightly with the [Mail](https://github.com/mikel/mail) gem.
 
@@ -12,7 +13,7 @@ Many providers offer APIs to send, receive, and parse email. MultiMail lets you
 * [Mandrill](http://mandrill.com/): [Example](#mandrill)
 * [Postmark](http://postmarkapp.com/): [Example](#postmark)
 * [SendGrid](http://sendgrid.com/): [Example](#sendgrid)
-* MTA like [Postfix](http://en.wikipedia.org/wiki/Postfix_\(software\)) or [qmail](http://en.wikipedia.org/wiki/Qmail): [Example](#mta)
+* MTA like [Postfix](https://en.wikipedia.org/wiki/Postfix_\(software\)) or [qmail](https://en.wikipedia.org/wiki/Qmail): [Example](#mta)
 
 ## Usage
 
@@ -30,7 +31,7 @@ messages = service.process(data)
 
 `messages` will be an array of [Mail::Message](https://github.com/mikel/mail) instances.
 
-Any non-standard parameters provided by an API are added to each message as a header. For example, Mailgun provides `stripped-text`, which is the message body without quoted parts or signature block. You can access it as `message['stripped-text'].value`.
+Any non-standard parameters provided by an API are added to each message as an instance variable. For example, Mailgun provides `stripped-text`, which is the message body without quoted parts or signature block. You can access it as `message.stripped_text`. The instance variable is the non-standard parameter in lowercase with underscores instead of hyphens.
 
 ### Outgoing
 
@@ -41,7 +42,19 @@ require 'multi_mail'
 
 message = Mail.new do
   delivery_method MultiMail::Sender::Postmark, :api_key => 'your-api-key'
-  ...
+
+  to 'user@wookiecookies.com'
+  from 'Chewbacca <chewy@wookiecookies.com>'
+  subject 'How About Some Cookies?'
+
+  text_part do
+    body 'I am just some plain text!'
+  end
+
+  html_part do
+    content_type 'text/html; charset=UTF-8'
+    body '<html><body><h1>I am a header</h1><p>And I am a paragraph</p></body></html>'
+  end
 end
 
 message.deliver
@@ -51,7 +64,18 @@ Alternatively, instead of setting `delivery_method` during initialization, you c
 
 ```ruby
 message = Mail.new do
-  ...
+  to 'user@wookiecookies.com'
+  from 'Chewbacca <chewy@wookiecookies.com>'
+  subject 'How About Some Cookies?'
+
+  text_part do
+    body 'I am just some plain text!'
+  end
+
+  html_part do
+    content_type 'text/html; charset=UTF-8'
+    body '<html><body><h1>I am a header</h1><p>And I am a paragraph</p></body></html>'
+  end
 end
 
 message.delivery_method MultiMail::Sender::Postmark, :api_key => 'your-api-key'
@@ -67,6 +91,78 @@ Mail.defaults do
 end
 ```
 
+#### ActionMailer
+
+First, add the delivery method to ActionMailer:
+
+```
+ActionMailer::Base.add_delivery_method :postmark, MultiMail::Sender::Postmark, :api_key => 'your-api-key'
+```
+
+Set the default delivery method for all ActionMailer classes in `config/environments/<ENV>.rb`:
+
+```
+config.action_mailer.delivery_method = :postmark
+```
+
+Or, set the delivery method in an ActionMailer class:
+
+```
+class UserMailer < ActionMailer::Base
+  default :delivery_method => :postmark
+end
+```
+
+Or, set the delivery method in an ActionMailer method:
+
+```
+class UserMailer < ActionMailer::Base
+  def welcome_email(user)
+    mail({
+      :to => user.email,
+      :subject => 'Welcome to My Awesome Site',
+      :delivery_method => :postmark,
+    })
+  end
+end
+```
+
+Set the delivery method's default options for all ActionMailer classes in `config/environments/<ENV>.rb`:
+
+```
+config.action_mailer.postmark_settings = {:api_key => 'your-api-key'}
+```
+
+Or, set the delivery method's options in an ActionMailer method:
+
+```
+class UserMailer < ActionMailer::Base
+  def welcome_email(mail)
+    mail({
+      :to => user.email,
+      :subject => 'Welcome to My Awesome Site',
+      :delivery_method_options => {:api_key => 'your-api-key'},
+    })
+  end
+end
+```
+
+Or, set the delivery method's options in an ActionMailer action:
+
+```
+class UserMailer < ActionMailer::Base
+  after_action :set_delivery_method_options
+
+  ...
+
+  private
+
+    def set_delivery_method_options
+      mail.delivery_method.settings.merge!({:api_key => 'your-api-key'})
+    end
+end
+```
+
 #### Tagging
 
 Mailgun, Mandrill and Postmark allow you to tag messages in order to accumulate statistics by tag, which will be accessible through their user interface:
@@ -90,19 +186,19 @@ Mailgun accepts at most [3 tags](http://documentation.mailgun.com/user_manual.ht
 
 #### Track opens and clicks
 
-Mailgun and Mandrill allow you to set open tracking and click tracking on a per-message basis:
+Mailgun, Mandrill and Postmark allow you to set open tracking, and Mailgun and Mandrill allow you to set click tracking on a per-message basis:
 
 ```ruby
 require 'multi_mail'
 
 message = Mail.new do
   delivery_method MultiMail::Sender::Mailgun,
-    :api_key => 'your-api-key',
-    :domain => 'your-domain.mailgun.org',
-    :track => {
-      :opens => true,
-      :clicks => false,
-    }
+                  :api_key => 'your-api-key',
+                  :domain => 'your-domain.mailgun.org',
+                  :track => {
+                    :opens => true,
+                    :clicks => false,
+                  }
   ...
 end
 
@@ -200,7 +296,19 @@ See [Mailgun's documentation](http://documentation.mailgun.net/user_manual.html#
 ```ruby
 Mail.deliver do
   delivery_method MultiMail::Sender::Mailgun, :api_key => 'your-api-key', :domain => 'your-domain.mailgun.org'
-  ...
+  
+  to _to_
+  from _from_
+  subject _subject_
+
+  text_part do
+    body _text_
+  end
+
+  html_part do
+    content_type 'text/html; charset=UTF-8'
+    body _html_
+  end
 end
 ```
 
@@ -213,6 +321,14 @@ You may pass additional arguments to `delivery_method` to use Mailgun-specific f
 * `o:tracking`
 * `v:`
 
+```ruby
+Mail.deliver do
+  delivery_method MultiMail::Sender::Mailgun, :api_key => 'your-api-key', :domain => 'your-domain.mailgun.org',
+                  :o:campaign => 'campaign', :o:dkim => 'yes (or no)',...
+  ...
+end
+```
+
 ## Mandrill
 
 ### Incoming
@@ -256,7 +372,19 @@ See [Mandrill's documentation](http://help.mandrill.com/entries/22092308-What-is
 ```ruby
 Mail.deliver do
   delivery_method MultiMail::Sender::Mandrill, :api_key => 'your-api-key'
-  ...
+  
+  to _to_
+  from _from_email_ + _from_name_
+  subject _subject_
+
+  text_part do
+    body _text_
+  end
+
+  html_part do
+    content_type 'text/html; charset=UTF-8'
+    body _html_
+  end
 end
 ```
 
@@ -275,6 +403,16 @@ You may pass additional arguments to `delivery_method` to use Mandrill-specific
 * `async`
 * `ip_pool`
 * `send_at`
+* `template_name`
+* `template_content`
+
+```ruby
+Mail.deliver do
+  delivery_method MultiMail::Sender::Mandrill, :api_key => 'your-api-key',
+                  :async => true, :ip_pool => 'main_pool', ...
+  ...
+end
+```
 
 ## Postmark
 
@@ -296,7 +434,19 @@ See [Postmark's documentation](http://developer.postmarkapp.com/developer-inboun
 ```ruby
 Mail.deliver do
   delivery_method MultiMail::Sender::Postmark, :api_key => 'your-api-key'
-  ...
+  
+  to _To_
+  from _From_
+  subject _Subject_
+
+  text_part do
+    body _TextBody_
+  end
+
+  html_part do
+    content_type 'text/html; charset=UTF-8'
+    body _HtmlBody_
+  end
 end
 ```
 
@@ -331,12 +481,33 @@ See [SendGrid's documentation](http://sendgrid.com/docs/API_Reference/Webhooks/p
 ```ruby
 Mail.deliver do
   delivery_method MultiMail::Sender::SendGrid, :api_user => 'username', :api_key => 'password'
-  ...
+  
+  to _to_
+  from _from_ + _fromname_
+  subject _subject_
+
+  text_part do
+    body _text_
+  end
+
+  html_part do
+    content_type 'text/html; charset=UTF-8'
+    body _html_
+  end
 end
 ```
 
 You may also pass a `x-smtpapi` option to `delivery_method` ([see SendGrid's documentation](http://sendgrid.com/docs/API_Reference/Web_API/mail.html)).
 
+```ruby
+Mail.deliver do
+  delivery_method MultiMail::Sender::SendGrid, :api_user => 'username', :api_key => 'password',
+                  :x-smtpapi => '{ "some_json" : "with_some_data" }'
+  ...
+end
+```
+
+
 ## MTA
 
 ### Incoming
@@ -367,16 +538,6 @@ service = MultiMail::Receiver.new({
 
 It's recommended to use a secret key, to ensure that the requests are sent by Postfix and qmail and not by other sources on the internet.
 
-## Bugs? Questions?
-
-This gem's main repository is on GitHub: [http://github.com/opennorth/multi_mail](http://github.com/opennorth/multi_mail), where your contributions, forks, bug reports, feature requests, and feedback are greatly welcomed.
-
-## Acknowledgements
-
-This gem is developed by [Open North](http://www.opennorth.ca/) through a partnership with the [Participatory Politics Foundation](http://www.participatorypolitics.org/).
-
-## Copyright
-
 This gem re-uses code from [fog](https://github.com/fog/fog), released under the MIT license.
 
-Copyright (c) 2012 Open North Inc., released under the MIT license
+Copyright (c) 2012 James McKinney, released under the MIT license

data/lib/multi_mail.rb

@@ -2,7 +2,6 @@ require 'base64'
 require 'cgi'
 require 'json'
 require 'openssl'
-require 'iconv' unless RUBY_VERSION >= '1.9'
 
 require 'faraday'
 require 'mail'
@@ -23,6 +22,8 @@ module MultiMail
   class InvalidAPIKey < InvalidRequest; end
   # Raise if a message is invalid.
   class InvalidMessage < InvalidRequest; end
+  # Raise if a message template is invalid.
+  class InvalidTemplate < InvalidRequest; end
 
   # Raise if a message header is invalid
   class InvalidHeader < InvalidMessage; end
@@ -60,7 +61,7 @@ module MultiMail
     #
     # @param [Mail::Message] message a message
     # @return [Boolean] whether a message is an autoresponse
-    # @see https://github.com/opennorth/multi_mail/wiki/Detecting-autoresponders
+    # @see https://github.com/jpmckinney/multi_mail/wiki/Detecting-autoresponders
     def autoresponse?(message)
       !!(
         # If any of the following headers are present and have the given value.
@@ -106,6 +107,7 @@ require 'multi_mail/receiver'
 require 'multi_mail/message/base'
 require 'multi_mail/receiver/base'
 require 'multi_mail/sender/base'
+require 'multi_mail/cloudmailin/message'
 require 'multi_mail/mailgun/message'
 require 'multi_mail/mailgun/sender'
 require 'multi_mail/mandrill/message'

data/lib/multi_mail/cloudmailin/message.rb

@@ -0,0 +1,7 @@
+module MultiMail
+  module Message
+    class Cloudmailin < MultiMail::Message::Base
+      attr_accessor :reply_plain, :spf_result
+    end
+  end
+end

data/lib/multi_mail/cloudmailin/receiver.rb

@@ -24,17 +24,17 @@ module MultiMail
       end
 
       # @param [Hash] params the content of Cloudmailin's webhook
-      # @return [Array<Mail::Message>] messages
+      # @return [Array<MultiMail::Message::Cloudmailin>] messages
       # @see http://docs.cloudmailin.com/http_post_formats/multipart/
       # @see http://docs.cloudmailin.com/http_post_formats/json/
       # @see http://docs.cloudmailin.com/http_post_formats/raw/
       def transform(params)
         case @http_post_format
         when 'raw', '', nil
-          message = self.class.condense(Mail.new(params['message']))
+          message = self.class.condense(MultiMail::Message::Cloudmailin.new(Mail.new(params['message'])))
 
           # Extra Cloudmailin parameters.
-          message['spf-result'] = params['envelope']['spf']['result']
+          message.spf_result = params['envelope']['spf']['result']
 
           if @attachment_store
             params['attachments'].each do |_,attachment|
@@ -52,7 +52,7 @@ module MultiMail
           attachment_store = @attachment_store
           this = self
 
-          message = Mail.new do
+          message = MultiMail::Message::Cloudmailin.new do
             headers headers
 
             text_part do
@@ -92,8 +92,8 @@ module MultiMail
 
           # Extra Cloudmailin parameters. The multipart format uses CRLF whereas
           # the JSON format uses LF. Normalize to LF.
-          message['reply_plain'] = params['reply_plain'].gsub("\r\n", "\n")
-          message['spf-result']  = params['envelope']['spf']['result']
+          message.reply_plain = params['reply_plain'].gsub("\r\n", "\n")
+          message.spf_result  = params['envelope']['spf']['result']
 
           [message]
         else
@@ -104,7 +104,7 @@ module MultiMail
       # @param [Mail::Message] message a message
       # @return [Boolean] whether the message is spam
       def spam?(message)
-        message['spf-result'] && message['spf-result'].value == 'fail'
+        message.spf_result == 'fail'
       end
     end
   end