pony-express 0.7.0 → 0.8.0

data/README.rdoc

@@ -21,8 +21,9 @@ historical perspective read  http://en.wikipedia.org/wiki/Pony_Express.
 
   require "pony-express"
   mail = PonyExpress::Mail.new to: "burns@plant.local", from: "homer@home.local", via: "sendmail"
+  mail.add cc: "smithers@plant.local", bcc: "carl@plant.local", replyto: "homer+work@home.local"
   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.add attachments: [ "/home/homer/donuts.png" ], headers: [{name: "X-FooBar", value: "test"}]
   mail.dispatch
 
 Don't want to create new mail objects ? Just pass in all options to PonyExpress.mail

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.8.0

data/ext/mimetic.cxx

@@ -18,6 +18,8 @@ extern "C" {
 #define FORCE_ENCODING(str,enc) rb_enc_associate(str, rb_to_encoding(enc)); ENC_CODERANGE_CLEAR(str);
 #define TO_S(v)                 rb_funcall(v, rb_intern("to_s"), 0)
 #define CSTRING(v)              RSTRING_PTR(TYPE(v) != T_STRING ? TO_S(v) : v)
+#define RBSTRING(v)             rb_str_new2(v.c_str())
+#define SYM(v)                  ID2SYM(rb_intern(v))
 
 static VALUE rb_mMimetic;
 static VALUE rb_UTF8, rb_ASCII;
@@ -74,7 +76,7 @@ bool mimetic_attach_file(MimeEntity *m, char* filename) {
         return true;
     }
     else {
-        rb_raise(rb_eRuntimeError, "Mimetic: Unable to read attachment file %s", filename);
+        rb_raise(rb_eRuntimeError, "Unable to read attachment file %s", filename);
     }
     return false;
 }
@@ -124,17 +126,17 @@ void rb_load_mime_types(VALUE self, VALUE filename) {
         file.close();
     }
     else {
-        rb_raise(rb_eRuntimeError, "Mimetic: Unable to load mime.types");
+        rb_raise(rb_eRuntimeError, "Unable to load mime.types");
     }
 }
 
 VALUE rb_mimetic_build(VALUE self, VALUE options) {
     ostringstream output;
     VALUE attachment;
-    VALUE text    = rb_hash_aref(options, ID2SYM(rb_intern("text")));
-    VALUE to      = rb_hash_aref(options, ID2SYM(rb_intern("to")));
-    VALUE from    = rb_hash_aref(options, ID2SYM(rb_intern("from")));
-    VALUE subject = rb_hash_aref(options, ID2SYM(rb_intern("subject")));
+    VALUE text    = rb_hash_aref(options, SYM("text"));
+    VALUE to      = rb_hash_aref(options, SYM("to"));
+    VALUE from    = rb_hash_aref(options, SYM("from"));
+    VALUE subject = rb_hash_aref(options, SYM("subject"));
 
     if (text    == Qnil) rb_raise(rb_eArgError, "Mimetic.build called without :text");
     if (from    == Qnil) rb_raise(rb_eArgError, "Mimetic.build called without :from");
@@ -142,15 +144,15 @@ VALUE rb_mimetic_build(VALUE self, VALUE options) {
     if (subject == Qnil) rb_raise(rb_eArgError, "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")));
-    VALUE replyto = rb_hash_aref(options, ID2SYM(rb_intern("replyto")));
-    VALUE cc      = rb_hash_aref(options, ID2SYM(rb_intern("cc")));
-    VALUE bcc     = rb_hash_aref(options, ID2SYM(rb_intern("bcc")));
-    VALUE files   = rb_hash_aref(options, ID2SYM(rb_intern("attachments")));
-    VALUE headers = rb_hash_aref(options, ID2SYM(rb_intern("headers")));
+    VALUE mid     = rb_hash_aref(options, SYM("message_id"));
+    VALUE html    = rb_hash_aref(options, SYM("html"));
+    VALUE tcid    = rb_hash_aref(options, SYM("text_content_id"));
+    VALUE hcid    = rb_hash_aref(options, SYM("html_content_id"));
+    VALUE replyto = rb_hash_aref(options, SYM("replyto"));
+    VALUE cc      = rb_hash_aref(options, SYM("cc"));
+    VALUE bcc     = rb_hash_aref(options, SYM("bcc"));
+    VALUE files   = rb_hash_aref(options, SYM("attachments"));
+    VALUE headers = rb_hash_aref(options, SYM("headers"));
 
     if (mid != Qnil && TYPE(mid) != T_STRING)
         rb_raise(rb_eArgError, "Mimetic.build expects :message_id to be a string");
@@ -168,9 +170,9 @@ VALUE rb_mimetic_build(VALUE self, VALUE options) {
         rb_raise(rb_eArgError, "Mimetic.build expects :headers to be an array");
 
     VALUE errors  = Qnil;
-    MimeEntity *message   = NULL;
-    MimeEntity *html_part = NULL;
-    MimeEntity *text_part = NULL;
+    MimeEntity *message   = 0;
+    MimeEntity *html_part = 0;
+    MimeEntity *text_part = 0;
     MimeVersion v1("1.0");
 
     try {
@@ -178,7 +180,7 @@ VALUE rb_mimetic_build(VALUE self, VALUE options) {
 
         if (html != Qnil && text != Qnil) {
             delete message;
-            message = new MultipartAlternative;
+            message   = new MultipartAlternative;
             html_part = new MimeEntity;
             text_part = new MimeEntity;
             message->body().parts().push_back(text_part);
@@ -253,13 +255,70 @@ VALUE rb_mimetic_build(VALUE self, VALUE options) {
         errors = rb_str_new2("Unknown Error");
     }
 
-    rb_raise(rb_eRuntimeError, "Mimetic boo boo : %s\n", CSTRING(errors));
+    rb_raise(rb_eRuntimeError, "%s\n", CSTRING(errors));
+}
+
+VALUE parse_mime_parts(MimeEntity &me) {
+    VALUE contents = rb_ary_new();
+    MimeEntityList::const_iterator curr = me.body().parts().begin(), end = me.body().parts().end();
+    while (curr != end) {
+        VALUE content = rb_hash_new();
+        MimeEntity *part = *curr;
+
+        rb_hash_aset(content, SYM("type"), RBSTRING(part->header().contentType().str()));
+        if (part->header().contentType().isMultipart()) {
+            rb_hash_aset(content, SYM("content"), parse_mime_parts(*part));
+        }
+        else {
+            rb_hash_aset(content, SYM("content"),      RBSTRING(part->body()));
+            rb_hash_aset(content, SYM("encoding"),     RBSTRING(part->header().contentTransferEncoding().str()));
+            rb_hash_aset(content, SYM("disposition"),  RBSTRING(part->header().contentDisposition().str()));
+        }
+        rb_ary_push(contents, content);
+        curr++;
+    }
+    return contents;
+}
+
+VALUE rb_mimetic_parse(VALUE self, VALUE data) {
+    if (NIL_P(data))
+        return Qnil;
+
+    VALUE errors  = Qnil;
+
+    try {
+        stringstream mime;
+        mime << CSTRING(data);
+        MimeEntity me;
+        me.load(mime);
+
+        VALUE message = rb_hash_new();
+
+        rb_hash_aset(message, SYM("from"),    RBSTRING(me.header().from().str()));
+        rb_hash_aset(message, SYM("to"),      RBSTRING(me.header().to().str()));
+        rb_hash_aset(message, SYM("subject"), RBSTRING(me.header().subject()));
+        rb_hash_aset(message, SYM("cc"),      RBSTRING(me.header().cc().str()));
+        rb_hash_aset(message, SYM("bcc"),     RBSTRING(me.header().bcc().str()));
+        rb_hash_aset(message, SYM("replyto"), RBSTRING(me.header().replyto().str()));
+
+        rb_hash_aset(message, SYM("contents"), parse_mime_parts(me));
+        return message;
+    }
+    catch(exception &e) {
+        errors = rb_str_new2(e.what());
+    }
+    catch (...) {
+        errors = rb_str_new2("Unknown Error");
+    }
+
+    rb_raise(rb_eRuntimeError, "%s\n", CSTRING(errors));
 }
 
 extern "C"  {
     void Init_mimetic(void) {
         rb_mMimetic = rb_define_module("Mimetic");
         rb_define_module_function(rb_mMimetic, "build", VALUEFUNC(rb_mimetic_build), 1);
+        rb_define_module_function(rb_mMimetic, "parse", VALUEFUNC(rb_mimetic_parse), 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.rb

@@ -3,8 +3,9 @@ begin; require 'smtp_tls'; rescue LoadError; end
 require_relative '../ext/mimetic'
 
 module PonyExpress
-  TRANSPORTS = [ :smtp, :sendmail ]
-  DEFAULT_SMTP_OPTIONS = { :host => 'localhost', :port => '25', :domain => 'localhost.localdomain' }
+  TRANSPORTS           = [ :smtp, :sendmail ]
+  DEFAULT_SMTP_OPTIONS = { host: 'localhost', port: '25', domain: 'localhost.localdomain' }
+  @@sendmail_binary    = '/usr/sbin/sendmail'
 
   Mimetic.load_mime_types File.dirname(__FILE__) + "/../mime.types"
 
@@ -13,8 +14,34 @@ module PonyExpress
     Mimetic.build(options)
   end
 
+  # NOTE: parse is very much WIP, YMMV
+  def parse content
+    Mimetic.parse(content)
+  end
+
+  # Build and dispatch email in one go.
+  #
+  # @example mail.
+  #  require "pony-express"
+  #  PonyExpress.mail to: "burns@plant.local", from: "homer@home.local", via: "sendmail",
+  #                   subject: "Hello Mr.Burns", text: "Can I have more donuts ?",
+  #                   html: "<strong>More Dooooonuuuuts!</strong>",
+  #                   attachments: [ "/home/homer/donuts.png" ],
+  #                   headers: [{name: "X-FooBar", value: "test"}]
+  #
+  # @param  [String]  to            Email address.
+  # @param  [String]  from          Email address.
+  # @param  [String]  subject       Subject (will be converted to quoted printable if needed).
+  # @param  [String]  text          Plain text content.
+  # @param  [String]  cc            Email address (optional).
+  # @param  [String]  bcc           Email address (optional).
+  # @param  [String]  replyto       Email address (optional).
+  # @param  [String]  html          HTML content (optional).
+  # @param  [Array]   attachments   List of email attachments (optional).
+  # @param  [Array]   headers       List of email headers (optional).
+  # @return [TrueClass or FalseClass]
   def mail options
-    via = (options.delete(:via) || :smtp).to_sym
+    via         = options.delete(:via)         || :smtp
     via_options = options.delete(:via_options) || {}
 
     if TRANSPORTS.include? via
@@ -27,22 +54,19 @@ module PonyExpress
     end
   end
 
+  def sendmail_binary= binary
+    @@sendmail_binary = binary
+  end
+
   def sendmail_binary
-    sendmail = `which sendmail`.chomp
-    sendmail.empty? ? '/usr/sbin/sendmail' : sendmail
+    @@sendmail_binary
   end
 
-  def transport_via_sendmail content, options={}
-    IO.popen('-', 'w+') do |pipe|
-      if pipe
-        pipe.write(content)
-      else
-        exec(sendmail_binary, "-t")
-      end
-    end
+  def transport_via_sendmail content, options = {}
+    IO.popen([sendmail_binary, '-t'], 'w') {|io| io.write(content)}
   end
 
-  def transport_via_smtp content, from, to, options={}
+  def transport_via_smtp content, from, to, options = {}
     o = DEFAULT_SMTP_OPTIONS.merge(options)
     smtp = Net::SMTP.new(o[:host], o[:port])
     if o[:tls]
@@ -66,19 +90,37 @@ module PonyExpress
       @options = opt
     end
 
+
+    # Add an option.
+    #
+    # @example add.
+    #  require "pony-express"
+    #  mail = PonyExpress::Mail.new
+    #  mail.add to: "burns@plant.local"
     def add opt
       @options.merge! opt
     end
 
+    # Remove an option.
+    #
+    # @example remove.
+    #  require "pony-express"
+    #  mail = PonyExpress::Mail.new
+    #  mail.add to: "burns@plant.local", cc: "smithers@plant.local"
+    #  mail.remove :cc
     def remove opt
       keys = opt.keys
       @options.reject! {|k, v| keys.include?(k) }
     end
 
+    # Send the email via the selected transport.
+    #
     def dispatch
       mail(@options)
     end
 
+    # Return the encoded email content.
+    #
     def content
       build(@options)
     end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: pony-express
 version: !ruby/object:Gem::Version 
-  hash: 3
   prerelease: false
   segments: 
   - 0
-  - 7
+  - 8
   - 0
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Bharanee Rathna
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-15 00:00:00 +11:00
+date: 2011-04-07 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -51,7 +50,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -60,7 +58,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"