ez-email 0.1.0

data/CHANGES

@@ -0,0 +1,2 @@
+== 0.1.0 - 23-Jan-2009
+* Initial release

data/MANIFEST

@@ -0,0 +1,6 @@
+* CHANGES
+* MANIFEST
+* Rakefile
+* ez-email.gemspec
+* lib/ez/email.rb
+* test/test_ez_email.rb

data/README

@@ -0,0 +1,37 @@
+= Description
+   A very easy interface for sending simple text based emails.
+
+= Synopsis
+   require 'ez/email'
+   
+   EZ::Email.deliver(
+      :to      => 'your_friend@hotstuff.com',
+      :from    => 'you@blah.com',
+      :subject => 'Hello',
+      :body    => 'How are you?'
+   )
+
+= Installation
+   gem install ez-email (rubygems)
+   rake install (manual installation)
+   
+= Rationale
+   The present batch of email handling libraries are either not designed
+   for sending email, or are extremely cumbersome, have lousy interfaces,
+   or are no longer maintained.
+   
+   I just want to sent a flippin' email! This library scratched that itch.
+   Hopefully you will find its simplicity useful, too.
+
+= Bugs
+   None that I'm aware of. Please log any bug reports on the project page at
+   http://www.rubyforge.org/projects/shards.
+
+= License
+   Ruby's
+
+= Copyright
+  (C) 2009, Daniel J. Berger, All Rights Reserved
+   
+= Author
+   Daniel Berger

data/lib/ez/email.rb

@@ -0,0 +1,135 @@
+require 'resolv'
+require 'etc'
+require 'socket'
+require 'net/smtp'
+
+# The EZ module serves as a namespace only.
+module EZ
+   
+   # The Email class encapsulates certain SMTP attributes, which are then
+   # used to send simple emails.
+   class Email
+      # The version of this library
+      VERSION = '0.1.0'
+      
+      @@mail_host = Resolv.getaddress('mailhost')
+      @@mail_port = 25
+      
+      # The name of the mail host to use when sending email. The default
+      # is whatever the address of your system's 'mailhost' resolves to.
+      def self.mail_host
+         @@mail_host
+      end
+      
+      # Sets the mail host.
+      def self.mail_host=(host)
+         @@mail_host = host         
+      end
+         
+      # The port to use when sending email. The default is 25.
+      def self.mail_port
+         @@mail_port         
+      end
+      
+      # Sets the mail port.
+      def self.mail_port=(port)
+         @@mail_port = 25
+      end
+      
+      # A single email address or an array of email addresses to whom
+      # the email should be sent. Mandatory.
+      attr_accessor :to
+      
+      # A single email address from whom the email is being delivered. The
+      # default is your login + '@' + your host name, though it is recommended
+      # that you specify it explicitly.
+      attr_accessor :from
+      
+      # The subject of the email. Mandatory.
+      attr_accessor :subject
+      
+      # The body of the email. Mandatory.
+      attr_accessor :body
+      
+      # Creates a new EZ::Email object. As a general rule you won't use
+      # this method, but should use EZ::Email.deliver instead.
+      #
+      def initialize(options={})
+         raise TypeError unless options.is_a?(Hash)
+         validate_options(options)
+         @options = options
+      end
+       
+      # Sends the email based on the options passed to the constructor.
+      # As a general rule you won't use this method directly, but should
+      # use EZ::Email.deliver instead.
+      #
+      def deliver
+         host = EZ::Email.mail_host
+         port = EZ::Email.mail_port
+
+         Net::SMTP.start(host, port, host){ |smtp|
+            smtp.open_message_stream(self.from, self.to){ |stream|
+               stream.puts "From: #{self.from}"
+               stream.puts "To: " + self.to.to_a.join(', ')
+               stream.puts "Subject: #{self.subject}"
+               stream.puts
+               stream.puts self.body
+            }
+         }
+      end
+
+      # Delivers a simple text email message using four options:
+      #
+      # * to
+      # * from
+      # * subject
+      # * body
+      #
+      # Examples:
+      #
+      #    # Send an email to a single user
+      #    EZ::Email.deliver(
+      #       :to      => 'some_user@hotmail.com',
+      #       :from    => 'me@hotmail.com',
+      #       :subject => 'Hi',
+      #       :body    => 'How are you?'
+      #    )
+      #
+      #    # Send an email to a multiple users
+      #    EZ::Email.deliver(
+      #       :to      => ['jon@hotmail.com', 'mary@hotmail.com'],
+      #       :from    => 'me@hotmail.com',
+      #       :subject => 'Hi',
+      #       :body    => 'How are you?'
+      #    )
+      #
+      # This is a shortcut for EZ::Email.new + EZ::Email.deliver.
+      #
+      def self.deliver(options)
+         new(options).deliver
+      end
+      
+      private
+      
+      # Private method that both validates the hash options, and sets
+      # the attribute values.
+      #
+      def validate_options(hash)
+         valid = %w/to from subject body/
+         hash.each{ |key, value|
+            key = key.to_s.downcase
+            raise ArgumentError unless valid.include?(key)
+            send("#{key}=", value)  
+         }
+         
+         if to.nil? || subject.nil? || body.nil?
+            raise ArgumentError, "Missing :to, :subject or :body"            
+         end
+         
+         if from.nil?
+            from = Etc.getlogin + '@' + Socket.gethostname
+         end
+      end
+   end   
+end

data/test/test_ez_email.rb

@@ -0,0 +1,76 @@
+########################################################################
+# test_ez_email.rb
+#
+# Test suite for the EZ::Email library.
+########################################################################
+require 'test/unit'
+require 'ez/email'
+
+class TC_EZ_Email < Test::Unit::TestCase
+   def setup
+      @to   = 'foo@some_mail_service.com'
+      @from = 'bar@some_mail_service.com'
+      @subj = 'This is a test'
+      @body = 'How are you?'
+
+      @opts = {:to => @to, :from => @from, :subject => @subj, :body => @body }
+      @email = EZ::Email.new(@opts)
+   end
+   
+   def test_version
+      assert_equal('0.1.0', EZ::Email::VERSION)      
+   end
+
+   def test_to
+      assert_respond_to(@email, :to)
+      assert_respond_to(@email, :to=)
+      assert_equal(@to, @email.to)
+   end
+
+   def test_from
+      assert_respond_to(@email, :from)
+      assert_respond_to(@email, :from=)
+      assert_equal(@from, @email.from)
+   end
+
+   def test_subject
+      assert_respond_to(@email, :subject)
+      assert_respond_to(@email, :subject=)
+      assert_equal(@subj, @email.subject)
+   end
+
+   def test_body
+      assert_respond_to(@email, :body)
+      assert_respond_to(@email, :body=)
+      assert_equal(@body, @email.body)
+   end
+
+   def test_mail_host
+      assert_respond_to(EZ::Email, :mail_host)
+      assert_respond_to(EZ::Email, :mail_host=)
+      assert_kind_of(String, EZ::Email.mail_host)
+   end
+
+   def test_mail_port
+      assert_respond_to(EZ::Email, :mail_port)
+      assert_respond_to(EZ::Email, :mail_port=)
+      assert_equal(25, EZ::Email.mail_port)
+   end
+
+   def test_deliver
+      assert_respond_to(EZ::Email, :deliver)
+   end
+
+   def test_invalid_option_raises_error
+      assert_raise(ArgumentError){ EZ::Email.send(:new, {:bogus => 77}) }
+   end
+
+   def teardown
+      @to    = nil
+      @from  = nil
+      @subj  = nil
+      @body  = nil
+      @opts  = nil
+      @email = nil
+   end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: ez-email
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel Berger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-23 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A very simple interface for sending email
+email: djberg96@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGES
+- MANIFEST
+files: 
+- lib/ez
+- lib/ez/email.rb
+- test/test_ez_email.rb
+- README
+- CHANGES
+- MANIFEST
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/shards
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: shards
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 3
+summary: Really easy emails
+test_files: 
+- test/test_ez_email.rb