fast-mailer 0.0.1 → 0.1.0

data/README.md

@@ -3,7 +3,7 @@ FastMailer
 
 FastMailer is a collection of helpers that aims to help with sending email.
 Specifically, it allows for convenient configuration and better throughput
-when sending multiple mails.
+when sending multiple mails using SMTP.
 
 
 Configuration
@@ -55,6 +55,17 @@ email, we can send multiple emails using a single connection.
     end
 
 
+Testing
+-------
+
+To enable testing, first run
+
+    FastMailer.test_mode = true
+
+This will cause FastMailer::SMTP to use FastMailer::MockSMTP rather than Net::SMTP. 
+You can then find your sent emails in FastMailer::MockSMTP.deliveries.
+
+
 Coming features
 ---------------
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/bin/autotest

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autotest' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('autotest', 'autotest')

data/bin/htmldiff

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/bin/ldiff

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/bin/rake

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/tt

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'tt' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('treetop', 'tt')

data/bin/unit_diff

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'unit_diff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('autotest', 'unit_diff')

data/lib/fast-mailer/configuration.rb

@@ -3,27 +3,13 @@
 module FastMailer
   class Configuration
     
-    TEST_CONFIGURATION = {
-      :something => :useful
-    }
-    
-    def self.enable_testing!
-      def self.smtp_configuration(options = nil)
-        TEST_CONFIGURATION
+    def self.smtp_configuration(options = nil)
+      if options.is_a? Hash
+        options
+      else
+        eval(File.read(options || File.expand_path("~/.config/smtp.rb")))
       end
     end
     
-    def self.disable_testing!
-      def self.smtp_configuration(options = nil)
-        if options.is_a? Hash
-          options
-        else
-          eval(File.read(options || File.expand_path("~/.config/smtp.rb")))
-        end
-      end
-    end
-    
-    disable_testing!
-    
   end
 end

data/lib/fast-mailer/mailer.rb

@@ -0,0 +1,62 @@
+module FastMailer
+  class Mailer
+    
+    def initialize(options = nil)
+      @options = options
+    end
+    
+    def send_all(mail_generator)
+      @mail_generator = mail_generator
+      @mutex = Mutex.new
+
+      tcount = (@options && @options[:max_connections]) || 1
+      threads = []
+      
+      if tcount > 1
+        tcount.times do |n|
+          threads << Thread.new(n) do |tid|
+            send_until_done
+          end
+        end
+      
+        threads.each { |thr| thr.join }
+      else
+        send_until_done
+      end
+    end
+    
+
+    private
+    def send_until_done
+      smtp = FastMailer::SMTP.new @options
+      while (true)
+        begin
+          peek_mail
+          smtp.open do
+            while true
+              smtp.deliver next_mail
+            end
+          end
+        rescue StandardError => e
+          raise e if StopIteration === e
+          sleep 2 unless FastMailer.test_mode
+        end
+      end
+    rescue StopIteration
+      # Expected.
+    end
+    
+    def next_mail
+      @mutex.synchronize do
+        @mail_generator.next
+      end
+    end
+    
+    def peek_mail
+      @mutex.synchronize do
+        @mail_generator.peek
+      end
+    end
+    
+  end
+end

data/lib/fast-mailer/mock_smtp.rb

@@ -0,0 +1,44 @@
+
+module FastMailer
+  # Original mockup from ActionMailer
+  class MockSMTP
+  
+    def self.deliveries
+      @@deliveries
+    end
+
+    def initialize(*args)
+      @@deliveries ||= []
+    end
+
+    def sendmail(mail, from, to)
+      @@deliveries << [mail, from, to]
+    end
+
+    def start(*args)
+      yield self
+    end
+  
+    def self.clear_deliveries
+      @@deliveries = []
+    end
+  
+    # in the standard lib: net/smtp.rb line 577
+    #   a TypeError is thrown unless this arg is a
+    #   kind of OpenSSL::SSL::SSLContext
+    def enable_tls(context = nil)
+      if context && context.kind_of?(OpenSSL::SSL::SSLContext)
+        true
+      elsif context
+        raise TypeError,
+          "wrong argument (#{context.class})! "+
+          "(Expected kind of OpenSSL::SSL::SSLContext)"
+      end
+    end
+
+    def enable_starttls_auto
+      true
+    end
+  
+  end
+end

data/lib/fast-mailer/smtp.rb

@@ -13,6 +13,11 @@ module FastMailer
   # sending mail on the same connection.
   class SMTP
     
+    include Hooks
+
+    define_hook :before_deliver
+    define_hook :after_deliver
+
     attr_accessor :configuration
     
     def initialize(options = nil)
@@ -25,7 +30,7 @@ module FastMailer
       configuration[:host] ||= configuration[:address]
       configuration[:username] ||= configuration[:user_name]
       
-      @smtp = Net::SMTP.new(configuration[:host], configuration[:port])
+      @smtp = connection_class.new(configuration[:host], configuration[:port])
       if configuration[:enable_starttls_auto]
         smtp.enable_starttls_auto if smtp.respond_to?(:enable_starttls_auto) 
       end
@@ -49,30 +54,45 @@ module FastMailer
     end
     
     private
+    def connection_class
+      FastMailer.test_mode ? FastMailer::MockSMTP : Net::SMTP
+    end
+    
+    def skip_delivery!
+      @skip_delivery = true
+    end
+    
     def perform_delivery(mail)
+      run_hook :before_deliver, mail
       
-      # Set the envelope from to be either the return-path, the sender or the first from address
-      envelope_from = mail.return_path || mail.sender || mail.from_addrs.first
-      if envelope_from.blank?
-        raise ArgumentError.new('A sender (Return-Path, Sender or From) required to send a message') 
-      end
+      if !@skip_delivery
+        # Set the envelope from to be either the return-path, the sender or the first from address
+        envelope_from = mail.return_path || mail.sender || mail.from_addrs.first
+        if envelope_from.blank?
+          raise ArgumentError.new('A sender (Return-Path, Sender or From) required to send a message') 
+        end
       
-      destinations ||= mail.destinations if mail.respond_to?(:destinations) && mail.destinations
-      if destinations.blank?
-        raise ArgumentError.new('At least one recipient (To, Cc or Bcc) is required to send a message') 
-      end
+        destinations ||= mail.destinations if mail.respond_to?(:destinations) && mail.destinations
+        if destinations.blank?
+          raise ArgumentError.new('At least one recipient (To, Cc or Bcc) is required to send a message') 
+        end
       
-      message ||= mail.encoded if mail.respond_to?(:encoded)
-      if message.blank?
-        raise ArgumentError.new('A encoded content is required to send a message')
-      end
+        message ||= mail.encoded if mail.respond_to?(:encoded)
+        if message.blank?
+          raise ArgumentError.new('A encoded content is required to send a message')
+        end
       
-      begin
-        @smtp.sendmail(message, envelope_from, destinations)
-      rescue e
-        @smtp = nil
-        raise e
+        begin
+          @smtp.sendmail(message, envelope_from, destinations)
+          run_hook :after_deliver, mail
+        rescue Exception => e
+          @smtp = nil
+          run_hook :after_deliver, mail, e
+          raise e
+        end
       end
+    ensure
+      @skip_delivery = false
     end
     
   end

data/lib/fast-mailer.rb

@@ -1,5 +1,22 @@
 
 require 'mail'
+require 'hooks'
 
 require 'fast-mailer/configuration'
 require 'fast-mailer/smtp'
+require 'fast-mailer/mailer'
+
+module FastMailer
+  
+  class <<self
+    def test_mode=(value)
+      require 'fast-mailer/mock_smtp' if value
+      @@test_mode = value
+    end
+  
+    def test_mode
+      @@test_mode ||= false
+    end
+  end
+  
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Erik Hansson
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-29 00:00:00 +02:00
+date: 2010-10-01 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,9 +46,23 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: hooks
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        version: "0.1"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -59,11 +73,11 @@ dependencies:
         - 0
         version: 1.0.0
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -76,11 +90,11 @@ dependencies:
         - 22
         version: 2.0.0.beta.22
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -91,11 +105,11 @@ dependencies:
         - 7
         version: 0.8.7
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: autotest
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -104,7 +118,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
 description: Helps with sending emails fast, and with convenient configuration.
 email: 
 - erik@bits2life.com
@@ -115,7 +129,16 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- bin/autotest
+- bin/htmldiff
+- bin/ldiff
+- bin/rake
+- bin/rspec
+- bin/tt
+- bin/unit_diff
 - lib/fast-mailer/configuration.rb
+- lib/fast-mailer/mailer.rb
+- lib/fast-mailer/mock_smtp.rb
 - lib/fast-mailer/smtp.rb
 - lib/fast-mailer.rb
 - LICENCE