gmail-mailer 0.4.2 → 0.4.4

data/Changelog.md

@@ -1,5 +1,10 @@
 # gmail-mailer Changelog
 
+### 0.4.3
+* Added attachment limits and recipient limits for messages
+* Added retry functionality on sending mail
+* Rejigged validation a little
+
 ### 0.4.2
 * Made error messages for credentials more detailed
 

data/Rakefile

@@ -31,6 +31,12 @@ Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
   test.pattern = 'test/**/test_*.rb'
   test.verbose = true
+ end
+
+Rake::TestTask.new(:test_mail) do |test|
+  test.libs << 'lib' << 'test'
+  test.verbose = true
+  test.test_files = ['test/mail_test_send.rb']
 
   #tests sending a mail using user credentials (if provided)
   root = File.expand_path(File.dirname(__FILE__))
@@ -41,7 +47,6 @@ Rake::TestTask.new(:test) do |test|
     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: - "

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.4.4

data/gmail-mailer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gmail-mailer}
-  s.version = "0.4.2"
+  s.version = "0.4.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Harper"]
-  s.date = %q{2011-01-14}
+  s.date = %q{2011-01-16}
   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 = [

data/lib/gmail-mailer.rb

@@ -6,10 +6,16 @@ module GmailMailer
   SMTP_HOST = "gmail.com"
   SMTP_CONSUMER_KEY = "anonymous"
   SMTP_CONSUMER_SECRET = "anonymous"
+  ATTACHMENTS_SIZE_LIMIT = (1024*1024)*25 #25mb attachment limit
+  RECIPIENT_LIMIT = 500
+  MAX_RETRY = 2
   class Mailer
     def initialize(credentials)
-      result = validate_credentials(credentials)
-      raise ArgumentError, "ERROR: Email credentials are invalid: -\n\n - #{result}" if result.nil? == false     
+      begin
+        validate_credentials(credentials)
+      rescue
+        raise
+      end
       @email_credentials = credentials
     end
 
@@ -24,11 +30,23 @@ module GmailMailer
           mail.add_file(attachment)
         end
       end
-      sendSMTP(mail)
+
+      retry_attempts = 0
+
+      begin
+        send_smtp(mail)
+      rescue => message
+        puts "Error occured attempting to send mail => #{message}"
+
+        raise message if(retry_attempts > MAX_RETRY)
+        puts "Retry: #{retry_attempts+1}/#{MAX_RETRY+1}"
+        retry_attempts = retry_attempts.succ
+        retry
+      end
     end
 
     # Use gmail_xoauth to send email
-    def sendSMTP(mail)
+    def send_smtp(mail)
       smtp = Net::SMTP.new(SMTP_SERVER, SMTP_PORT)
       smtp.enable_starttls_auto
       secret = {
@@ -45,10 +63,11 @@ module GmailMailer
     end
 
     def validate_credentials(creds)
-      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?
+      msg = "ERROR: Email credentials are invalid:"
+      raise ArgumentError, "#{msg} The credentials you have posted are nil" if creds.nil?
+      raise ArgumentError, "#{msg} 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?
+      raise ArgumentError, "#{msg} 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?
+      raise ArgumentError, "#{msg} You must provide an email value" if !creds.key?:email or creds[:email].nil? or creds[:email].empty?
       return nil 
     end
   end
@@ -67,13 +86,28 @@ module GmailMailer
       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)
+
+      size = File.size(filepath)
+      print "Adding attachment: #{filepath} " 
+      printf("(%5.4f kb)",size.to_f/1024.0)
+      puts
+      raise ArgumentError, "There is a #{ATTACHMENTS_SIZE_LIMIT/1024/1024}mb limit on attachments}" if (get_attachments_size + size) > ATTACHMENTS_SIZE_LIMIT
       @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
+      raise ArgumentError, "You cannot send a message to more than #{RECIPIENT_LIMIT} recipients" if to.is_a?Array and to.count > RECIPIENT_LIMIT
+      @to = to.join(";") if to.is_a?Array 
       @to = to if to.is_a?String 
     end
+
+    def get_attachments_size
+      attachments_size = 0
+      @attachments.each do |attachment|
+        attachments_size += File.size(attachment)
+      end
+      return attachments_size
+    end
   end
 end

data/test/mail_test_send.rb

@@ -13,11 +13,11 @@ class TestMailSender < Test::Unit::TestCase
   end
 
   def test_send_message
-    assert_nothing_raised {
+   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_message.rb

@@ -2,6 +2,12 @@ require "gmail-mailer.rb"
 require 'fileutils'
 require 'test/unit'
 class TestMessage < Test::Unit::TestCase
+  def create_file(filename, size)
+    File.open(filename,'w') do |f|
+      f.puts "-"*size
+    end
+  end
+
   def setup
     @files = ['file1','file2','file3']
     @dir = File.expand_path("./tmpdir")
@@ -20,11 +26,10 @@ class TestMessage < Test::Unit::TestCase
   
   def createTmpFiles
     @files.each do |file|
-      FileUtils.touch(file)
+      create_file(file, rand(1024))
     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")
@@ -67,6 +72,13 @@ class TestMessage < Test::Unit::TestCase
     expected = to.join(";")
     assert_equal(expected, @msg.to, "Multiple receivers not detected")
   end
+
+  def test_to_with_array_of_more_than_acceptable_recipients
+    to = ("a@b.c,"*501).split(',')
+    assert_raise(ArgumentError) {
+      @msg.to= to
+    }
+  end
   
 
   def test_add_attachment
@@ -98,5 +110,52 @@ class TestMessage < Test::Unit::TestCase
     assert_raise(ArgumentError) { @msg.add_attachment(@dir) }
   end
 
+  def test_get_attachment_size
+    begin
+      file = "file5"
+      create_file(file, 1024*1024)
+      size = File.size(file)
+      @msg.add_attachment(file)
+      assert_equal(size, @msg.get_attachments_size)
+    ensure
+      FileUtils.rm(file)
+    end
+  end
+
+  def test_get_attachment_size_with_multiple_attachments
+    begin
+      file = "file5"
+      file2 = "file6"
+      create_file(file, 1024*1024)
+      create_file(file2,(1024*1024)*5)
+      size = File.size(file)
+      size2 = File.size(file2)
+      @msg.add_attachment(file)
+      @msg.add_attachment(file2)
+      assert_equal(size+size2, @msg.get_attachments_size)
+    ensure
+      FileUtils.rm(file)
+      FileUtils.rm(file2)
+    end
+  end
+
+  def test_add_attachment_with_over_limit
+      begin
+
+        file = "file5"
+        file2 = "file6"
+        create_file(file, 1024*1024)
+        create_file(file2,(1024*1024)*25)
+        size = File.size(file)
+        size2 = File.size(file2)
+        assert_raise(ArgumentError) {
+          @msg.add_attachment(file)
+          @msg.add_attachment(file2)
+        }
+      ensure
+        FileUtils.rm(file)
+        FileUtils.rm(file2)
+      end
+  end
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 2
-  version: 0.4.2
+  - 4
+  version: 0.4.4
 platform: ruby
 authors: 
 - Daniel Harper
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-14 00:00:00 +00:00
+date: 2011-01-16 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency