pony-express 0.6.1 → 0.6.5

data/README.rdoc

@@ -0,0 +1,54 @@
+= Pony Express
+
+A fast and lightweight ruby mailer based on http://github.com/benprew/pony. For a more
+historical perspective read  http://en.wikipedia.org/wiki/Pony_Express.
+
+== Installation
+
+  sudo apt-get install libmimetic-dev
+  sudo apt-get install libpcre++-dev
+  sudo gem install pony-express
+
+=== Dependencies
+
+* Ruby >= 1.9.1
+* rubygems >= 1.3.5
+* ruby development libraries             (debian: ruby1.9.1-dev)
+* mimetic >= 0.9.6 development libraries (debian: libmimetic-dev)
+* pcre++ development libraries           (debian: libpcre++-dev)
+
+== Usage
+
+  require "pony-express"
+  mail = PonyExpress::Mail.new to: "burns@plant.local", from: "homer@home.local", via: "sendmail"
+  mail.add subject: "Hello Mr.Burns", text: "Can I have more donuts ?", html: "<strong>More Dooooonuuuuts!</strong>"
+  mail.add attachments: [ "/home/homer/donuts.png" ]
+  mail.dispatch
+
+Don't want to create new mail objects ? Just pass in all options to PonyExpress.mail
+
+  PonyExpress.mail to: "burns@plant.local", from: "homer@home.local", ...
+
+== Testing
+
+  require "pony-express"
+  require "pony-express/test"
+  mail = PonyExpress::Mail.new to: "burns@plant.local", from: "homer@home.local", via: "sendmail"
+  mail.add subject: "Hello Mr.Burns", text: "Can I have more donuts ?"
+  mail.dispatch
+  assert_equal 1, PonyExpress::Test.mailbox.length
+
+== TODO
+
+* Build a rainbow machine and rope in some unicorns.
+
+== Won't Do
+
+* Support for Ruby 1.8 or Rubinius or JRuby
+* MIME parsing. If you need a full blown mail library have a look at the mail gem.
+
+== License
+
+GNU GPLv3, so its free and comes with no guarantees. If it brings down your website or burns down your house, I will
+not be held responsible. Use it at your own risk. You can read all about GNU here: http://www.gnu.org and
+GNU GPLv3 here: http://www.gnu.org/licenses/gpl.txt.

data/VERSION

@@ -1 +1 @@
-0.6.1
+0.6.5

data/ext/mimetic.cxx

@@ -1,5 +1,7 @@
 #include <ruby.h>
-#include <ruby/encoding.h>
+extern "C" {
+    #include <ruby/encoding.h>
+}
 #include <iostream>
 #include <unistd.h>
 #include <sstream>
@@ -10,36 +12,57 @@
 
 #define ID_CONST_GET rb_intern("const_get")
 #define CONST_GET(scope, constant) (rb_funcall(scope, ID_CONST_GET, 1, rb_str_new2(constant)))
+#define RUBY_ENCODING(str) string(rb_enc_get(str)->name)
+#define VALUEFUNC(f) ((VALUE (*)(ANYARGS)) f)
+#define FORCE_ENCODING(str,enc) rb_enc_associate(str, rb_to_encoding(enc)); ENC_CODERANGE_CLEAR(str);
 
 static VALUE rb_mMimetic;
 static VALUE eRuntimeError;
 static VALUE eArgumentError;
+static VALUE rb_UTF8, rb_ASCII;
 
 using namespace std;
 using namespace mimetic;
 using namespace pcrepp;
 
-#define VALUEFUNC(f) ((VALUE (*)(ANYARGS)) f)
-
 map<string, string> MimeTypes;
 
 /* RFC References
 
 http://www.ietf.org/rfc/rfc2822.txt  Internet Message Format.
-http://www.ietf.org/rfc/rfc1341.txt  MIME Extensions - Multipart related.
+http://www.ietf.org/rfc/rfc2045.txt  MIME Extensions - Multipart related (Part One).
+http://www.ietf.org/rfc/rfc2046.txt  MIME Extensions - Multipart related (Part Deux).
 http://www.ietf.org/rfc/rfc2392.txt  Content-ID and Message-ID.
 
 */
 
-// TODO: CHECK FOR MEMORY LEAKS - not sure if mimetic releases mime parts.
+// TODO
+// angle brackets enclosing content and message ids should be part of libmimetic.
+string content_id() {
+    string cid = ContentId().str();
+    return cid[0] == '<' ? cid : "<" + cid + ">";
+}
+
+string message_id(int n) {
+    string mid = MessageId(n).str();
+    return mid[0] == '<' ? mid : "<" + mid + ">";
+}
+
+string file_mime_type(string file) {
+    Pcre regex("\\.");
+    string extn = regex.split(file).back();
+    transform(extn.begin(), extn.end(), extn.begin(), ::tolower);
+    string mime = MimeTypes[extn];
+    return mime.length() > 0 ? mime : "application/octet-stream";
+}
 
-bool mimetic_attach_file(MimeEntity *m, char* filename, const char *mimetype) {
+bool mimetic_attach_file(MimeEntity *m, char* filename) {
     filebuf ifile;
     ostringstream encoded;
     ifile.open(filename, ios::in);
     if (ifile.is_open()) {
         istream is(&ifile);
-        Attachment *at = new Attachment(filename, ContentType(mimetype));
+        Attachment *at = new Attachment(filename, ContentType(file_mime_type(filename)));
         Base64::Encoder b64;
         ostreambuf_iterator<char> oi(encoded);
         istreambuf_iterator<char> ibegin(is), iend;
@@ -55,14 +78,36 @@ bool mimetic_attach_file(MimeEntity *m, char* filename, const char *mimetype) {
     return false;
 }
 
-string get_mime_type(string file) {
-    Pcre regex("\\.");
-    string extn = regex.split(file).back();
-    transform(extn.begin(), extn.end(), extn.begin(), ::tolower);
-    string mime = MimeTypes[extn];
-    return mime.length() > 0 ? mime : MimeTypes["bin"];
+string safe_rfc2047(string v) {
+    Pcre re1("\\?");
+    Pcre re2("_");
+    Pcre re3(" ");
+    v = re1.replace(v, "=3F");
+    v = re2.replace(v, "=5F");
+    v = re3.replace(v, "_");
+    return v;
 }
 
+string quoted_printable(VALUE str) {
+    VALUE ascii = rb_str_new2(RSTRING_PTR(str));
+    FORCE_ENCODING(ascii, rb_ASCII);
+    if (rb_str_cmp(ascii, str) != 0) {
+        string raw = RSTRING_PTR(str);
+        QP::Encoder qp;
+        istringstream is(raw);
+        ostringstream encoded;
+        istreambuf_iterator<char> ibeg(is), iend;
+        ostreambuf_iterator<char> oi(encoded);
+        encode(ibeg, iend, qp, oi);
+        return "=?" + RUBY_ENCODING(str) + "?Q?" + safe_rfc2047(encoded.str()) + "?=";
+    }
+    else {
+        return string(RSTRING_PTR(str));
+    }
+}
+
+// Exposed API
+
 void rb_load_mime_types(VALUE self, VALUE filename) {
     char buffer[4096];
     vector<string> data;
@@ -96,6 +141,7 @@ VALUE rb_mimetic_build(VALUE self, VALUE options) {
     if (subject == Qnil) rb_raise(eArgumentError, "Mimetic.build called without :subject");
 
     // optional fields
+    VALUE mid     = rb_hash_aref(options, ID2SYM(rb_intern("message_id")));
     VALUE html    = rb_hash_aref(options, ID2SYM(rb_intern("html")));
     VALUE tcid    = rb_hash_aref(options, ID2SYM(rb_intern("text_content_id")));
     VALUE hcid    = rb_hash_aref(options, ID2SYM(rb_intern("html_content_id")));
@@ -104,6 +150,15 @@ VALUE rb_mimetic_build(VALUE self, VALUE options) {
     VALUE bcc     = rb_hash_aref(options, ID2SYM(rb_intern("bcc")));
     VALUE files   = rb_hash_aref(options, ID2SYM(rb_intern("attachments")));
 
+    if (mid != Qnil && TYPE(mid) != T_STRING)
+        rb_raise(eArgumentError, "Mimetic.build expects :message_id to be a string");
+
+    if (tcid != Qnil && TYPE(tcid) != T_STRING)
+        rb_raise(eArgumentError, "Mimetic.build expects :text_content_id to be a string");
+
+    if (hcid != Qnil && TYPE(hcid) != T_STRING)
+        rb_raise(eArgumentError, "Mimetic.build expects :html_content_id to be a string");
+
     if (files != Qnil && TYPE(files) != T_ARRAY)
         rb_raise(eArgumentError, "Mimetic.build expects :attachments to be an array");
 
@@ -122,20 +177,20 @@ VALUE rb_mimetic_build(VALUE self, VALUE options) {
             text_part = new MimeEntity;
             message->body().parts().push_back(text_part);
             message->body().parts().push_back(html_part);
-            text_part->header().contentType("text/plain; charset=UTF-8");
+            text_part->header().contentType("text/plain; charset=" + RUBY_ENCODING(text));
             text_part->header().contentTransferEncoding("8bit");
-            text_part->header().contentId(tcid == Qnil ? ContentId() : ContentId(RSTRING_PTR(tcid)));
+            text_part->header().contentId(tcid == Qnil ? content_id() + ">" : ContentId(RSTRING_PTR(tcid)));
             text_part->header().mimeVersion(v1);
             text_part->body().assign(RSTRING_PTR(text));
-            html_part->header().contentType("text/html; charset=UTF-8");
+            html_part->header().contentType("text/html; charset=" + RUBY_ENCODING(html));
             html_part->header().contentTransferEncoding("7bit");
-            html_part->header().contentId(hcid == Qnil ? ContentId() : ContentId(RSTRING_PTR(hcid)));
+            html_part->header().contentId(hcid == Qnil ? content_id() + ">" : ContentId(RSTRING_PTR(hcid)));
             html_part->header().mimeVersion(v1);
             html_part->body().assign(RSTRING_PTR(html));
         }
         else {
             message->body().assign(RSTRING_PTR(text));
-            message->header().contentType("text/plain; charset=UTF-8");
+            message->header().contentType("text/plain; charset=" + RUBY_ENCODING(text));
             message->header().contentTransferEncoding("8bit");
             message->header().mimeVersion(v1);
         }
@@ -148,14 +203,14 @@ VALUE rb_mimetic_build(VALUE self, VALUE options) {
             for (long i = 0; i < RARRAY_LEN(files); i++) {
                 attachment = rb_ary_entry(files, i);
                 if (attachment != Qnil && TYPE(attachment) == T_STRING)
-                    mimetic_attach_file(message, RSTRING_PTR(attachment), get_mime_type(RSTRING_PTR(attachment)).c_str());
+                    mimetic_attach_file(message, RSTRING_PTR(attachment));
             }
         }
 
         message->header().from(RSTRING_PTR(from));
         message->header().to(RSTRING_PTR(to));
-        message->header().subject(RSTRING_PTR(subject));
-        message->header().messageid(1);
+        message->header().subject(quoted_printable(subject));
+        message->header().messageid(mid != Qnil ? RSTRING_PTR(mid) : message_id(1));
 
         if (replyto != Qnil) message->header().replyto(RSTRING_PTR(replyto));
         if (cc      != Qnil) message->header().cc(RSTRING_PTR(cc));
@@ -184,5 +239,7 @@ extern "C"  {
         rb_mMimetic = rb_define_module("Mimetic");
         rb_define_module_function(rb_mMimetic, "build", VALUEFUNC(rb_mimetic_build), 1);
         rb_define_module_function(rb_mMimetic, "load_mime_types", VALUEFUNC(rb_load_mime_types), 1);
+        rb_UTF8  = rb_str_new2("UTF-8");
+        rb_ASCII = rb_str_new2("US-ASCII");
     }
 }

data/lib/pony-express/test.rb

@@ -0,0 +1,19 @@
+module PonyExpress
+  module Test
+    def mailbox
+      PonyExpress::Test.mailbox
+    end
+
+    def self.mailbox
+      @@mailbox ||= []
+    end
+  end
+
+  def self.transport_via_sendmail content, *rest
+    PonyExpress::Test.mailbox << content
+  end
+
+  def self.transport_via_smtp content, *rest
+    PonyExpress::Test.mailbox << content
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pony-express
 version: !ruby/object:Gem::Version 
-  version: 0.6.1
+  version: 0.6.5
 platform: ruby
 authors: 
 - Bharanee Rathna
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-03 00:00:00 +10:00
+date: 2010-06-08 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -21,14 +21,15 @@ extensions:
 - ext/extconf.rb
 extra_rdoc_files: 
 - LICENSE
-- README
+- README.rdoc
 files: 
 - LICENSE
-- README
 - VERSION
 - ext/mimetic.cxx
 - lib/pony-express.rb
+- lib/pony-express/test.rb
 - mime.types
+- README.rdoc
 has_rdoc: true
 homepage: http://github.com/deepfryed/pony-express
 licenses: []

data/README

@@ -1,43 +0,0 @@
-A fast and lightweight ruby mailer based on http://github.com/benprew/pony. For a more
-historical perspective read  http://en.wikipedia.org/wiki/Pony_Express.
-
-INSTALL:
-
-  sudo apt-get install libmimetic-dev
-  sudo gem install pony-express
-
-REQUIREMENT:
-
-  * Ruby >= 1.9.1
-  * rubygems >= 1.3.5
-  * ruby development libraries             (debian: ruby1.9.1-dev)
-  * mimetic >= 0.9.6 development libraries (debian: libmimetic-dev)
-  * pcre++ development libraries           (debian: libpcre++-dev)
-
-USAGE:
-
-  >> require "pony-express"
-  >> mail = PonyExpress::Mail.new to: "burns@plant.local", from: "homer@home.local", via: "sendmail"
-  >> mail.add subject: "Hello Mr.Burns", text: "Can I have more donuts", html: "<strong>More Dooooonuuuuts!</strong>"
-  >> mail.add attachments: [ "/home/homer/donuts.png" ]
-  >> mail.dispatch
-
-  Don't want to create new mail objects ? Just pass in all options to PonyExpress.mail
-
-  >> PonyExpress.mail to: "burns@plant.local", from: "homer@home.local", ...
-
-TODO:
-
-  * Check for Memory Leaks, build a Rainbow machine and rope in some Unicorns.
-
-DON'T ASK:
-
-  * Support for Ruby 1.8 or Rubinius or JRuby
-  * MIME parsing. If you need a full blown mail library have a look at the mail gem.
-
-
-LICENSE:
-
-GNU GPLv3, so its free and comes with no guarantees. If it brings down your website or burns down your house, I will
-not be held responsible. Use it at your own risk. You can read all about GNU here: http://www.gnu.org and
-GNU GPLv3 here: http://www.gnu.org/licenses/gpl.txt.