monkey-mailer 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGY5ZDE2MGNhZDNlYzcyYzcxNzFjNjk4MTQxMTliNmQ5MGIyZWViMQ==
+    YjViOWIzNTk3ZGEyMWFhMTFhNTE5NTA2NTI4ZWE4MDNiMmQ4MDU5Yw==
   data.tar.gz: !binary |-
-    MDUzZmUxMGY3YzZjZGFkYjMwNmZjNWMxNGVjODdiODcyMjdhMzYxNw==
+    YTViODJjZjExZWRmMjM0YzljMjQwZThjYjZhZGNmOGEzMTRhZGNiYQ==
 SHA512:
   metadata.gz: !binary |-
-    ZGJlNjY4ZmQ5ODA1Y2UxNGU2NGU4ZDQ4ZDExYzYxNzA3NDY4MTIyMjVhNGYy
-    ZWYwYTAyYmE2ZTQ4YTY1OTMyMjk0NGJkYzk0YWFjZDdmMmE0ZWI1ZWY2NDc3
-    ODgxNGMyNjA3NGJmOWNjNmZhMzFjMTIzN2EyYTc0ZTRkYWU1NDQ=
+    NjkwNzJlODAzZDVhZWNlYjMxMzI2OWQ0OGE0MjA5NmRkNmVjYmVlMzgxMDk1
+    OTJhZWM0ZTk4MTNjZjRmMWE0MzM5Y2M1MDk2MTQxNTkwOTg1Y2VhNTk1MTMw
+    NjU3YjdiYmUzY2QzOWViMTNkYWYzMWY3NTU2YmY2OGRkMjVlYjk=
   data.tar.gz: !binary |-
-    MTg1NzAxZTUwOTRiZjllM2NmNzU0ODMzYTg2MTkzMmVkZjYxMDFhMzJiOWFk
-    MzJlYWZiYjEzYzQxYzdkMDg1ODA4YzEyZDQzZWNkYTYxNDdmNjg1MzIxOWQ2
-    OWY2MDNmNDRmNzFiOGE1ODc1Mjk1ZmM2OWVmMDVlNWVlMmY1N2Q=
+    YmUxYTg4MDRjZjM2MmUzMjIzZTZmYWE2NzY1MTg4OGM0OWMzZGMxYjM2ZmMy
+    YWM1NjFjNjU1NWZkY2FhODljZTY5NDg4MDBjMWNjMWU0YjI1MWQzYjA4OGM2
+    OWM3MTM2YjQyNTlmOTliNTNhMzAyODAxYzNjMjdmZWU3ZWMwMjE=

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+
+script: "bundle exec rspec"
+before_install:
+  - gem install bundler

data/README.md

@@ -1,11 +1,18 @@
+[![Build Status](https://travis-ci.org/fsaravia/monkey-mailer.png)](https://travis-ci.org/fsaravia/monkey-mailer)
+[![Code Climate](https://codeclimate.com/github/fsaravia/monkey-mailer.png)](https://codeclimate.com/github/fsaravia/monkey-mailer)
+
 Monkey Mailer
 ======
 
 ## Description
-Monkey Mailer is a gem that allows handling a mailing queue, it supports email priority (urgent, normal and low priorities) and is higly customizable.  
-Emails can be loaded from different data sources using Loader gems (See below), feel free to contribute a loader with your preferred datastore!  
-Once loaded, emails can be sent using either SMTP or [Mailchimp's Mandril API](http://mandrill.com/)  
-After setup, Monkey Mailer can be configured to run and process your emails in a infinite loop until you stop it, it uses the [fallen](https://github.com/inkel/fallen/) gem, to run as a daemon in your server
+Monkey Mailer is a gem that allows building a service for handling an email queue, it supports priority (urgent, normal and low priorities) and is higly customizable.  
+Emails can be loaded from different data sources using `loader` plugins (See below), it uses priority to determine which mails will be sent as soon as they are queued and which mails can wait  
+Once loaded, emails can be sent using either SMTP or [Mailchimp's Mandril API](http://mandrill.com/), they are `adapters` and, as with `loaders`, MonkeyMailer can be easily extended to work with the email provider of your choice  
+After setup, Monkey Mailer can be configured to run and process your emails in a infinite loop until you stop it, it uses the [fallen](https://github.com/inkel/fallen/) gem, to run as a daemon in your server  
+The principle behind MonkeyMailer's functionality is simple, it runs an infinite loop, within that loop it asks the `adapter` for emails to send. And this is where priority becomes important:
+* `Urgent` mails are loaded and sent on every iteration
+* `Normal` and `Low` priority emails are loaded and sent after a certain number of iterations have passed  
+Also, in order to avoid problems with your email provider, all priorities have a quota, so if there are many urgent emails to send, MonkeyMailer will only load and send a certain number on each iteration  
 
 ## Instalation
     gem install monkey-mailer
@@ -28,10 +35,10 @@ Adapters are classes that send your emails using different providers. MonkeyMail
 * `MonkeyMailer::Adapters::MandrilAPI`
 * `MonkeyMailer::Adapters::Smtp`
 
-Any adapter receives its settings by setting up MonkeyMailer.configuration.adapter_options, check out each loader for specific options
+Any adapter receives its settings by setting up MonkeyMailer.configuration.adapter_options, check out each one for specific options
 
 ##Dummy loader and adapter
-Test adapter and loader are provided within MonkeyMailer so you can play with them for testing purposes:  
+Test adapter and loader are provided within MonkeyMailer so you can play with them:  
 
 * Dummy loader: `MonkeyMailer::Loaders::Dummy` # It generates random emails for adapters to consume  
 * Dummy adapter: `MonkeyMailer::Adapters::Dummy` # It just displays the email content on stdout  
@@ -45,7 +52,7 @@ Test adapter and loader are provided within MonkeyMailer so you can play with th
     extend MonkeyMailer
 
     MonkeyMailer.configure do |config|
-      config.adapter = MonkeyMailer::Adapters::MandrilAPI, # Method used to send emails
+      config.adapter = MonkeyMailer::Adapters::MandrilAPI # Method used to send emails
       config.adapter_options = {:mandril_api_key => 'YOUR_API_KEY'}
       config.loader = MonkeyMailer::Loaders::DataMapper #Uses the loader on mm-data_mapper gem to load emails from a database
       config.loader_options = {
@@ -95,6 +102,27 @@ You can also build your own loader gem, we have thought of some ideas about load
 * mm-redis  
 * mm-your-storage-of-choice  
 
+## Building your own loader
+It is painfully easy to write your own loader, just create a class inside `MonkeyMailer::Loaders` module and define this three methods:
+```ruby
+  def initialize(opts)
+    # The content of MonkeyMailer.loader_options will be available on opts
+  end
+
+  def find_emails(priority, quota)
+    # Return an array of emails with the given priority with a limit of quota
+  end
+
+  def delete_email(end)
+    # Delete the email from your data storage, this method will only be called if email sent
+    # was successful
+  end
+```
+
+## List of known loaders:
+
+* [mm-data_mapper](https://github.com/fsaravia/mm-data_mapper): Uses the DataMapper gem to load emails from a database
+
 ## License
 See the `UNLICENSE` file included with this gem distribution.
 

data/lib/monkey-mailer/adapters/mandrilapi.rb

@@ -44,7 +44,7 @@ module MonkeyMailer
         @request[:message][:from_name] = email.from_name
         @request[:message][:from_email] = email.from_email
         @request[:message][:html] = email.body
-        @request[:message][:text] = email.body.gsub(/<\/?[^>]*>/, "")
+        @request[:message][:text] = email.body.gsub(/<\/?[^>]*>/, "") unless email.body.nil?
         @request[:message][:subject] = email.subject
 
         req = Net::HTTP::Post.new('/api/1.0/messages/send.json', initheader = {'Content-Type' =>'application/json'})

data/lib/monkey-mailer/adapters/smtp.rb

@@ -30,7 +30,7 @@ module MonkeyMailer
           end
 
           text_part do
-            body email.body.gsub(/<\/?[^>]*>/, "")
+            body email.body.nil? ? '' : email.body.gsub(/<\/?[^>]*>/, "")
           end
         end
       end

data/lib/monkey-mailer/version.rb

@@ -1,3 +1,3 @@
 module MonkeyMailer
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: monkey-mailer
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Lautaro Orazi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-12 00:00:00.000000000 Z
+date: 2013-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clap
@@ -75,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - README.md
 - UNLICENSE