minimail 0.0.5 → 0.0.6

data/lib/minimail/mail.rb

@@ -21,12 +21,13 @@ module Minimail
       @recipients = recipients
     end
   
-    def body(body = nil)
+    def body(body = '')
       @body = body
     end
   
     def deliver
-      return unless valid?
+      return "Invalid mail contents" unless valid?
+      return "Invalid mail command" unless mail_command
       if @attachments
         IO.popen("(#{@attachments}) | #{mail_command} -s '#{@subject}' #{@recipients}", "w") do |io|
           io.write @body
@@ -75,4 +76,4 @@ module Minimail
       end
 
   end
-end
+end

data/lib/minimail/version.rb

@@ -1,3 +1,3 @@
 module Minimail
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/readme.md

@@ -1,12 +1,11 @@
-Minimail sends emails. I use it to send notification emails to myself from scripts. `/usr/bin/mail -s 'hi there' bob@example.com` can be called from a shell script as well, Minimail just wraps that. Minimail wraps command-line code with descriptive method and variable names and test code, to make maintenance easier. Minimail makes it easier to share this functionality between projects thanks to Rubygems and bundler.
+Minimail sends emails (using `mail` with attachments using `uuencode`).
 
 Installation
 =========
 
 With bundler
 ------------
-    
-    # gem install bundler
+
     gem 'minimail'
     bundle
     
@@ -18,10 +17,10 @@ Without bundler
 Usage
 =====
 
-    # Send an email (one-liner)
-    Minimail::Mail.new(:subject => "check it!", :recipients => "bob@example.com").deliver
+    # Send an email in one line
+    Minimail::Mail.new(:subject => "[app] Background job is complete", :recipients => "engineer@example.com").deliver
     
-    # Or do the same with a DSL style
+    # Or use a DSL style
     m = Minimail::Mail.new
     m.draft do
       subject "check it!"
@@ -29,24 +28,21 @@ Usage
     end
     m.deliver
     
-    # Include an attachment
-    Minimail::Mail.new(:subject => "check this attachment", :recipients => "bob@example.com", :attachments => File.join(Dir.pwd, 'test', 'fake_attachment.txt')).deliver
+    # Add an attachment
+    Minimail::Mail.new(:subject => "[app] Success", :recipients => "engineer@example.com", :attachments => File.join(Dir.pwd, 'test', 'fake_attachment.txt')).deliver
 
 Run tests
 =========
   
-    # clone source, setup ruby and gemset (I use RVM). rvm use 1.8.7; rvm gemset create minimail; rvm gemset use minimail
-    # gem install bundler && bundle (make sure bundler "test" group gems are installed)
-    rake # as of this writing: 6 tests, 11 assertions, 0 failures, 0 errors, 0 skips
+    # With RVM, `rvm use 1.8.7 && rvm gemset create minimail && rvm gemset use minimail`
+    rake
 
 Debugging
 =========
-Some ISPs will block the SMTP port or black-list IP addresses. I was not able to send on a Verizon ISP connection for home,
-but was able to send using my cellular 3G connection (also Verizon) while tethered.
+Some ISPs will block the SMTP port or black-list IP addresses. I was not able to send on a Verizon connection at home, but was able to send using cellular connections (AT&T and Verizon) while tethered.
 
-The mail will also likely show up in the spam folder.
+With gmail, the test mails show up in the spam folder. To check your mail log file on OS X:
 
-    # on OS X tail the mail log file
     tail -f /var/log/mail.log
 
 Credits

data/test/minimail_test.rb

@@ -41,8 +41,8 @@ class Minimail::MailTest < MiniTest::Unit::TestCase
   
   def test_ensure_mail_is_not_valid_unless_recipient_is_specified
     mail = Minimail::Mail.new()
-    assert_nil mail.deliver
     assert !mail.valid?
+    assert_equal "Invalid mail contents", mail.deliver
   end
   
   def test_can_create_a_minimail_with_dsl_style
@@ -56,4 +56,10 @@ class Minimail::MailTest < MiniTest::Unit::TestCase
     assert_equal "bob@example.com", m.instance_variable_get(:@recipients)
     assert_equal "cool stuff", m.instance_variable_get(:@body)
   end
+  
+  def test_mail_has_empty_string_body_if_none_provided
+    recipients = "jane@example.com"
+    mail = Minimail::Mail.new(:recipients => recipients)
+    assert_equal '', mail.body
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: minimail
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Andy Atkinson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-06 00:00:00 -04:00
+date: 2012-07-23 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency