gmail-mailer 0.3.0 → 0.4.0

data/Changelog.md

@@ -1,10 +1,21 @@
-= gmail-mailer Changelog
+# gmail-mailer Changelog
 
-=== 0.3.0
+### 0.4.0
+* Added further validation on the `to` field
+* Added ability to pass an array into the `to` field which will convert the `to` to a semi-colon delimited string
+* Added getther and setter to `to` field for validation purposes
+* Added support for multiple attachments 
+* Added support for multiple receivers 
+* Added further validation for email credentials/reduced number of credentials needed by making some values default
+* Added some primitive unit tests for sending email
+
+### 0.3.0
 * Removed the `from` field from `GmailMailer::Message`
 * Added accessors for `to`, `subject`, `body` fields
 * put validation on `to` field. 
-=== 0.2.0
+
+### 0.2.0
 * Removed attachments from the constructor and added `add_attachment` method
-=== 0.1.0
+
+### 0.1.0
 * Initial version

data/Rakefile

@@ -19,8 +19,40 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{Programatically send emails using a given gmail account. No username/passwords needed, just use your OAUTH credentials}
   gem.email = "djharperuk@gmail.com"
   gem.authors = ["Daniel Harper"]
+  gem.required_ruby_version = ">= 1.9.2"
   gem.add_dependency "mail","~> 2.2.14"
   gem.add_dependency "gmail_xoauth", "~> 0.3.0"
 end
 Jeweler::RubygemsDotOrgTasks.new
 
+require 'rake/testtask'
+PRIVATE_CREDENTIALS = "files/private_key_conf_file"
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+
+  #tests sending a mail using user credentials (if provided)
+  root = File.expand_path(File.dirname(__FILE__))
+  root = File.expand_path("./test", root)
+  file = File.join(root, "/#{PRIVATE_CREDENTIALS}")
+
+  if File.exist?(file)
+    puts
+    puts "Will test sending a mail using your user credentials found in #{file}"
+    puts
+    test.test_files = ['test/mail_test_send.rb']
+  else
+    puts
+    puts "WILL NOT BE TESTING MAIL SEND FUNCTIONALITY. IF YOU WISH TO TEST THIS, CREATE A FILE WITH THE FOLLOWING: - "
+    puts
+    puts "  smtp_oauth_token: <your outh token>"
+    puts "  smtp_oauth_token_secret: <your oauth token secret>"
+    puts "  email: <your email>"
+    puts 
+    puts "place this information in test/files/private_key_conf_file"
+    puts
+  end
+end
+
+task :default => :test

data/TODO.md

@@ -0,0 +1,9 @@
+#gmail-mailer TODO LIST
+
+*  Better validation for email configuration
+*  Add better handling for SMTP errors
+*  unit testing- STARTED
+** Need some sort of mock testing framework for SMTP messages
+* add support for adding directories
+* add size limits/checking for attachments
+* reconfigure the way mailer sends message, queue messages up THEN send

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/gmail-mailer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gmail-mailer}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Harper"]
-  s.date = %q{2011-01-09}
+  s.date = %q{2011-01-14}
   s.description = %q{Programatically send emails using a given gmail account. No username/passwords needed, just use your OAUTH credentials}
   s.email = %q{djharperuk@gmail.com}
   s.extra_rdoc_files = [
@@ -24,16 +24,26 @@ Gem::Specification.new do |s|
     "LICENSE.txt",
     "README.md",
     "Rakefile",
-    "TODO.txt",
+    "TODO.md",
     "VERSION",
     "gmail-mailer.gemspec",
-    "lib/gmail-mailer.rb"
+    "lib/gmail-mailer.rb",
+    "test/files/email_conf",
+    "test/mail_test_send.rb",
+    "test/test_mailer.rb",
+    "test/test_message.rb"
   ]
   s.homepage = %q{http://github.com/djhworld/gmail-mailer}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.2")
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Send emails using a your gmail account (via OAUTH)}
+  s.test_files = [
+    "test/mail_test_send.rb",
+    "test/test_mailer.rb",
+    "test/test_message.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/gmail-mailer.rb

@@ -1,9 +1,15 @@
 require 'mail'
 require 'gmail_xoauth'
 module GmailMailer
+  SMTP_SERVER = "smtp.gmail.com"
+  SMTP_PORT = "587"
+  SMTP_HOST = "gmail.com"
+  SMTP_CONSUMER_KEY = "anonymous"
+  SMTP_CONSUMER_SECRET = "anonymous"
   class Mailer
     def initialize(credentials)
-      raise ArgumentError if !validate_credentials(credentials)
+      result = validate_credentials(credentials)
+      raise ArgumentError, result if result.nil? == false     
       @email_credentials = credentials
     end
 
@@ -12,8 +18,10 @@ module GmailMailer
         to message.to
         subject message.subject
         body message.body
-        if(!message.attachments.empty?)
-          add_file message.attachments.first 
+      end
+      if(!message.attachments.empty?)
+        message.attachments.each do |attachment|
+          mail.add_file(attachment)
         end
       end
       sendSMTP(mail)
@@ -21,15 +29,15 @@ module GmailMailer
 
     # Use gmail_xoauth to send email
     def sendSMTP(mail)
-      smtp = Net::SMTP.new(@email_credentials[:smtp_server], @email_credentials[:smtp_port])
+      smtp = Net::SMTP.new(SMTP_SERVER, SMTP_PORT)
       smtp.enable_starttls_auto
       secret = {
-        :consumer_key => @email_credentials[:smtp_consumer_key],
-        :consumer_secret => @email_credentials[:smtp_consumer_secret],
+        :consumer_key => SMTP_CONSUMER_KEY, 
+        :consumer_secret => SMTP_CONSUMER_SECRET,
         :token => @email_credentials[:smtp_oauth_token],
         :token_secret => @email_credentials[:smtp_oauth_token_secret]
       }
-      smtp.start(@email_credentials[:host], @email_credentials[:email], secret, :xoauth) do |session|
+      smtp.start(SMTP_HOST, @email_credentials[:email], secret, :xoauth) do |session|
         print "Sending message..."
         session.send_message(mail.encoded, mail.from_addrs.first, mail.destinations)
         puts ".sent!"
@@ -37,32 +45,35 @@ module GmailMailer
     end
 
     def validate_credentials(creds)
-      false if creds.nil?
-      false if !creds.key?:smtp_server or creds[:smtp_server].nil?
-      false if !creds.key?:smtp_port or creds[:smtp_port].nil?
-      false if !creds.key?:smtp_consumer_key or creds[:smtp_consumer_key].nil?
-      false if !creds.key?:smtp_consumer_secret or creds[:smtp_consumer_secret].nil?
-      false if !creds.key?:smtp_oauth_token or creds[:smtp_oauth_token].nil?
-      false if !creds.key?:smtp_oauth_token_secret or creds[:smtp_oauth_token_secret].nil?
-      false if !creds.key?:host or creds[:host].nil?
-      false if !creds.key?:email or creds[:email].nil?
-      return true
+      return "The credentials you have posted are nil" if creds.nil?
+      return "You must provide a smtp_oauth_token value!" if !creds.key?:smtp_oauth_token or creds[:smtp_oauth_token].nil? or creds[:smtp_oauth_token].empty?
+      return "You must provide a smtp_oauth_token_secret value!" if !creds.key?:smtp_oauth_token_secret or creds[:smtp_oauth_token_secret].nil? or creds[:smtp_oauth_token_secret].empty?
+      return "You must provide an email value" if !creds.key?:email or creds[:email].nil? or creds[:email].empty?
+      return nil 
     end
   end
 
   class Message
-    attr_accessor :to, :subject, :body 
-    attr_reader :attachments
+    attr_accessor :subject, :body 
+    attr_reader :to, :attachments
     def initialize(to, subject="", body="")
-      raise ArgumentError, "You must specify an email address to send the message to!" if(to.nil? or to.empty?)
-      @to = to 
+      self.to=(to)
       @subject = subject
       @body = body
       @attachments = []
     end
 
     def add_attachment(filepath)
-      @attachments << filepath if !filepath.nil? or !filepath.empty?
+      raise ArgumentError, "You must specify a file to send" if filepath.nil? or filepath.empty?
+      raise ArgumentError, "File #{filepath} does not exist" if !File.exist?(filepath)  
+      raise ArgumentError, "#{filepath} file is a directory, this is not supported" if File.directory?(filepath)
+      @attachments << filepath 
+    end
+
+    def to=(to) 
+      raise ArgumentError, "You must specify an email address to send the message to!" if(to.nil? or to.empty?)
+      @to = to.join(";") if to.is_a?Array
+      @to = to if to.is_a?String 
     end
   end
 end

data/test/files/email_conf

@@ -0,0 +1,3 @@
+smtp_oauth_token: 123456789
+smtp_oauth_token_secret: 123456789
+email: d@gmail.com

data/test/mail_test_send.rb

@@ -0,0 +1,24 @@
+require 'gmail-mailer.rb'
+require 'yaml'
+require 'test/unit'
+
+class TestMailSender < Test::Unit::TestCase
+  PRIVATE_CREDENTIALS = "files/private_key_conf_file"
+  def setup
+    root = File.expand_path(File.dirname(__FILE__))
+    root = File.expand_path("../test", root)
+    file = File.join(root, "/#{PRIVATE_CREDENTIALS}")
+    raise Exception, "You have not setup a credentials file for your gmail account to test with" if !File.exists?(file)
+    @config = YAML.load_file(file).inject({}){|memo,(k,v)| memo[k.to_sym] = v.to_s; memo}
+  end
+
+  def test_send_message
+    assert_nothing_raised {
+      mailer = GmailMailer::Mailer.new(@config)
+      message = GmailMailer::Message.new(@config[:email], "Hello Subject", "Hello Body")
+      mailer.send(message)
+    }
+  end
+end
+
+

data/test/test_mailer.rb

@@ -0,0 +1,88 @@
+require "gmail-mailer.rb"
+require 'yaml'
+require 'test/unit'
+class TestMailer < Test::Unit::TestCase
+  CREDS_FILE = "files/email_conf"
+  def setup
+    root = File.expand_path(File.dirname(__FILE__))
+    root = File.expand_path("../test", root)
+    file = File.join(root, "/#{CREDS_FILE}")
+    @credentials = YAML.load_file(file).inject({}){|memo,(k,v)| memo[k.to_sym] = v.to_s; memo}
+    @mailer = GmailMailer::Mailer.new(@credentials)
+  end
+
+  def teardown
+    @credentials = nil
+  end
+
+  def test_constructor
+    assert_nothing_raised { @mailer = GmailMailer::Mailer.new(@credentials) }
+  end
+
+  def test_constructor_with_nil_credentials
+    assert_raise(ArgumentError) { @mailer = GmailMailer::Mailer.new(nil) }
+  end
+
+  def test_constructor_with_no_smtp_oauth_token
+    assert_raise(ArgumentError) {
+      @credentials.delete(:smtp_oauth_token)
+      @mailer = GmailMailer::Mailer.new(@credentials) 
+    }
+  end
+  
+  def test_constructor_with_nil_smtp_outh_token
+    assert_raise(ArgumentError) {
+      @credentials[:smtp_oauth_token] = nil
+      @mailer = GmailMailer::Mailer.new(@credentials) 
+    }
+  end
+
+  def test_constructor_with_empty_smtp_oauth_token
+    assert_raise(ArgumentError) {
+      @credentials[:smtp_oauth_token] = "" 
+      @mailer = GmailMailer::Mailer.new(@credentials) 
+    }
+  end
+  
+  def test_constructor_with_no_smtp_oauth_token_secret
+    assert_raise(ArgumentError) {
+      @credentials.delete(:smtp_oauth_token_secret)
+      @mailer = GmailMailer::Mailer.new(@credentials) 
+    }
+  end
+  
+  def test_constructor_with_nil_smtp_outh_token_secret
+    assert_raise(ArgumentError) {
+      @credentials[:smtp_oauth_token_secret] = nil
+      @mailer = GmailMailer::Mailer.new(@credentials) 
+    }
+  end
+
+  def test_constructor_with_empty_smtp_oauth_token_secret
+    assert_raise(ArgumentError) {
+      @credentials[:smtp_oauth_token_secret] = "" 
+      @mailer = GmailMailer::Mailer.new(@credentials) 
+    }
+  end
+
+  def test_constructor_with_no_email
+    assert_raise(ArgumentError) {
+      @credentials.delete(:email)
+      @mailer = GmailMailer::Mailer.new(@credentials) 
+    }
+  end
+  
+  def test_constructor_with_nil_email
+    assert_raise(ArgumentError) {
+      @credentials[:email] = nil
+      @mailer = GmailMailer::Mailer.new(@credentials) 
+    }
+  end
+
+  def test_constructor_with_empty_email
+    assert_raise(ArgumentError) {
+      @credentials[:email] = "" 
+      @mailer = GmailMailer::Mailer.new(@credentials) 
+    }
+  end
+end

data/test/test_message.rb

@@ -0,0 +1,102 @@
+require "gmail-mailer.rb"
+require 'fileutils'
+require 'test/unit'
+class TestMessage < Test::Unit::TestCase
+  def setup
+    @files = ['file1','file2','file3']
+    @dir = File.expand_path("./tmpdir")
+    Dir.mkdir(@dir)
+    createTmpFiles
+    @msg = GmailMailer::Message.new("to","subject","body")
+  end
+
+  def teardown
+    @files.each do |file|
+      FileUtils.rm(file)
+    end
+    Dir.rmdir(@dir)
+    @msg = nil
+  end
+  
+  def createTmpFiles
+    @files.each do |file|
+      FileUtils.touch(file)
+    end
+  end
+
+
+  def test_constructor
+    @msg = GmailMailer::Message.new("djharperuk@gmail.com","Subject","Body")
+    assert_not_nil(@msg, "Item did not appear to construct correctly")
+  end
+
+  def test_constructor_for_attributes
+    to, subject, body = "a@b.c", "subject", "body"
+    @msg = GmailMailer::Message.new(to, subject, body)
+    assert_equal(to, @msg.to)
+    assert_equal(subject, @msg.subject)
+    assert_equal(body, @msg.body)
+    assert_equal([], @msg.attachments)
+  end
+
+  def test_constructor_throws_exc_on_empty_to_field
+    to, subject, body = "", "subject", "body"
+    assert_raise(ArgumentError) { @msg = GmailMailer::Message.new(to, subject, body) }
+  end
+
+  def test_constructor_multiple_receivers
+    first = "a@b.c"
+    second = "b@c.d"
+    to = [first,second]
+    @msg = GmailMailer::Message.new(to, "", "")
+    expected = to.join(";")
+    assert_equal(expected, @msg.to, "Multiple receivers not detected")
+  end
+
+  def test_to_=
+    to = "a@b.c"
+    @msg.to= to
+    assert_equal(to, @msg.to)
+  end
+
+  def test_to_with_array
+    first = "a@b.c"
+    second = "b@c.d"
+    to = [first,second]
+    @msg.to= to
+    expected = to.join(";")
+    assert_equal(expected, @msg.to, "Multiple receivers not detected")
+  end
+  
+
+  def test_add_attachment
+    @msg.add_attachment(@files.first)
+    assert_equal(1,@msg.attachments.count, "There should be 1 item in the list!")
+  end
+
+  def test_add_attachments
+    @msg.add_attachment(@files.pop)
+    @msg.add_attachment(@files.pop)
+    assert_equal(2,@msg.attachments.count, "There should be 2 items in the list!")
+  end
+
+  def test_add_attachment_with_empty_string
+    assert_raise(ArgumentError) { @msg.add_attachment("") }
+    assert_equal(0, @msg.attachments.count, "There should be no items in the list!")
+  end
+
+  def test_add_attachment_with_nil_string
+    assert_raise(ArgumentError) { @msg.add_attachment("") }
+    assert_equal(0, @msg.attachments.count, "There should be no items in the list!")
+  end
+
+  def test_add_file_that_doesnt_exist
+    assert_raise(ArgumentError) { @msg.add_attachment("asjdasjdhasdjhaksjdh") }
+  end
+
+  def test_add_file_that_is_actually_a_dir
+    assert_raise(ArgumentError) { @msg.add_attachment(@dir) }
+  end
+
+end
+

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Daniel Harper
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-09 00:00:00 +00:00
+date: 2011-01-14 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -124,10 +124,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- TODO.txt
+- TODO.md
 - VERSION
 - gmail-mailer.gemspec
 - lib/gmail-mailer.rb
+- test/files/email_conf
+- test/mail_test_send.rb
+- test/test_mailer.rb
+- test/test_message.rb
 has_rdoc: true
 homepage: http://github.com/djhworld/gmail-mailer
 licenses: 
@@ -142,10 +146,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3791998660236781509
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 9
+      - 2
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
@@ -161,5 +166,7 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Send emails using a your gmail account (via OAUTH)
-test_files: []
-
+test_files: 
+- test/mail_test_send.rb
+- test/test_mailer.rb
+- test/test_message.rb

data/TODO.txt

@@ -1,4 +0,0 @@
-changes needed for next version: -
-- Better validation for email configuration
-- Add better handling for SMTP errors
-- unit testing