mailman 0.2.0 → 0.3.0

data/README.md

@@ -10,7 +10,7 @@ support), that works with Rails "out of the box".
       end
     end
 
-See the {file:USER_GUIDE.md} for more information.
+See the [USER_GUIDE.md](http://rubydoc.info/github/titanous/mailman/master/file/USER_GUIDE.md) for more information.
 
 ## Installation
 
@@ -21,6 +21,11 @@ See the {file:USER_GUIDE.md} for more information.
 This project is sponsored by the [Ruby Summer of Code](http://rubysoc.org),
 and my mentor is [Steven Soroka](http://github.com/ssoroka).
 
+### Contributors
+
+    Tim Carey-Smith
+    Nicolas Aguttes
+
 ## Copyright
 
 Copyright (c) 2010 Jonathan Rudenberg. See LICENSE for details.

data/USER_GUIDE.md

@@ -96,6 +96,23 @@ All captures from matchers are available as block arguments:
       puts "Got message from #{username} about Ticket #{ticket_id}"
     end
 
+#### Class Routing
+
+Messages can also be routed to methods. For instance, to route to an
+ActionMailer mailer with a `receive` method defined, this will work:
+
+    from '%user%@example.org', SampleMailer
+
+Messages can also be routed to arbitrary instance methods:
+
+    from '%user%@example.org', 'ExampleClass#new_message'
+
+The method should accept two arguments, the message object, and the params:
+
+    def receive(message, params)
+      # process message here
+    end
+
 #### Route Helpers
 
 There are two helpers available inside of route blocks:
@@ -116,7 +133,7 @@ the properties available.
 
 ### Conditions
 
-Currently there are four conditions available: `to`, `from`, `subject`, `body`
+Currently there are five conditions available: `to`, `from`, `cc`, `subject`, `body`
 
 More can be added easily (see `lib/mailman/route/conditions.rb`).
 
@@ -145,7 +162,8 @@ will poll every minute by default (this can be changed with
 `Mailman.config.poll_interval`). After new messages are processed, they will
 be deleted from the server. *No copy of messages will be saved anywhere
 after processing*. If you want to keep a copy of messages, it is recommended
-that you use a mail retriever with the Maildir receiver.
+that you use a mail retriever with the Maildir receiver. You could also use
+Gmail and set it to keep messages after they have been retrieved with POP3.
 
 
 ### Maildir
@@ -183,10 +201,11 @@ set, Mailman will use POP3 polling as the receiver.
 **Example**:
 
     Mailman.config.pop3 = {
-      :username => 'chunky',
-      :password => 'bacon',
-      :server   => 'example.org',
-      :port     => 110 # defaults to 110
+      :username => 'chunkybacon@gmail.com',
+      :password => 'foobar',
+      :server   => 'pop.gmail.com',
+      :port     => 995, # defaults to 110
+      :ssl      => true # defaults to false
     }
 
 

data/lib/mailman/application.rb

@@ -43,23 +43,24 @@ module Mailman
       elsif Mailman.config.pop3
         options = {:processor => @processor}.merge(Mailman.config.pop3)
         Mailman.logger.info "POP3 receiver enabled (#{options[:username]}@#{options[:server]})."
+        if Mailman.config.poll_interval > 0 # we should poll
+          polling = true
+          Mailman.logger.info "Polling enabled. Checking every #{Mailman.config.poll_interval} seconds."
+        else 
+          polling = false
+          Mailman.logger.info 'Polling disabled. Checking for messages once.'
+        end
+
         connection = Receiver::POP3.new(options)
-        begin
+        loop do
+          Mailman.logger.debug "Checking POP3 server for messages..."
           connection.connect
-          if Mailman.config.poll_interval > 0 # we should poll
-            Mailman.logger.info "Polling enabled. Checking every #{Mailman.config.poll_interval} seconds."
-            loop do
-              Mailman.logger.debug "Polling POP3 server for messages..."
-              connection.get_messages
-              sleep Mailman.config.poll_interval
-            end
-          else # one-time retrieval
-            Mailman.logger.info "Polling disabled. Checking for messages..."
-            connection.get_messages
-          end
-        ensure
+          connection.get_messages
           connection.disconnect
+          break if !polling
+          sleep Mailman.config.poll_interval
         end
+
       elsif Mailman.config.maildir
         Mailman.logger.info "Maildir receiver enabled (#{Mailman.config.maildir})."
         maildir = Maildir.new(Mailman.config.maildir)

data/lib/mailman/receiver/pop3.rb

@@ -15,11 +15,13 @@ module Mailman
       # @option options [Integer] :port the port to connect to
       # @option options [String] :username the username to authenticate with
       # @option options [String] :password the password to authenticate with
+      # @option options [true,false] :ssl enable SSL
       def initialize(options)
         @processor = options[:processor]
         @username = options[:username]
         @password = options[:password]
         @connection = Net::POP3.new(options[:server], options[:port])
+        @connection.enable_ssl(OpenSSL::SSL::VERIFY_NONE) if options[:ssl]
       end
 
       # Connects to the POP3 server.

data/lib/mailman/route/condition.rb

@@ -30,8 +30,9 @@ module Mailman
       def self.inherited(condition)
         condition_name = condition.to_s.split('::')[-1][0...-9].downcase
         Route.class_eval <<-EOM
-          def #{condition_name}(pattern, &block)
+          def #{condition_name}(pattern, klass = nil, &block)
             @conditions << #{condition}.new(pattern)
+            @klass = klass
             if block_given?
               @block = block
             end
@@ -40,8 +41,8 @@ module Mailman
         EOM
 
         Application.class_eval <<-EOM
-          def #{condition_name}(pattern, &block)
-            @router.add_route Route.new.#{condition_name}(pattern, &block)
+          def #{condition_name}(pattern, klass = nil, &block)
+            @router.add_route Route.new.#{condition_name}(pattern, klass, &block)
           end
         EOM
       end

data/lib/mailman/route/conditions.rb

@@ -4,9 +4,11 @@ module Mailman
     # Matches against the To addresses of a message.
     class ToCondition < Condition
       def match(message)
-        message.to.each do |address|
-          if result = @matcher.match(address)
-            return result
+        if !message.to.nil?
+          message.to.each do |address|
+            if result = @matcher.match(address)
+              return result
+            end
           end
         end
         nil
@@ -39,5 +41,20 @@ module Mailman
       end
     end
 
+    # Matches against the CC header of a message.
+    class CcCondition < Condition
+      def match(message)
+        if !message.cc.nil?
+          message.cc.each do |address|
+            if result = @matcher.match(address)
+              return result
+            end
+          end
+        end
+        nil
+      end
+    end
+
+
   end
 end

data/lib/mailman/route.rb

@@ -7,6 +7,10 @@ module Mailman
     # @return [Proc] the block that should be run if the conditions match
     attr_reader :block
 
+    # @return [Class,String] the class (and optional instance method) to run
+    #   instead of a block
+    attr_reader :klass
+
     # @return [Array] the list of condition instances associated with the route
     attr_reader :conditions
 
@@ -16,7 +20,7 @@ module Mailman
 
     # Checks whether a message matches the route.
     # @param [Mail::Message] message the message to match against
-    # @return [Hash] the +:block+ associated with the route, the
+    # @return [Hash] the +:block+ and +:klass+ associated with the route, the
     #   +:params+ hash, and the block +:args+ array.
     def match!(message)
       params = {}
@@ -29,7 +33,7 @@ module Mailman
           return nil
         end
       end
-      { :block => @block, :params => params, :args => args }
+      { :block => @block, :klass => @klass, :params => params, :args => args }
     end
 
   end

data/lib/mailman/router.rb

@@ -49,7 +49,14 @@ module Mailman
 
       if result
         @params.merge!(result[:params])
-        if result[:block].arity > 0
+        if !result[:klass].nil?
+          if result[:klass].is_a?(Class) # no instance method specified
+            result[:klass].new.send(:receive, @message, @params)
+          elsif result[:klass].kind_of?(String) # instance method specified
+            klass, method = result[:klass].split('#')
+            klass.camelize.constantize.new.send(method.to_sym, @message, @params)
+          end
+        elsif result[:block].arity > 0
           instance_exec(*result[:args], &result[:block])
         else
           instance_exec(&result[:block])

data/lib/mailman/version.rb

@@ -1,3 +1,3 @@
 module Mailman
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jonathan Rudenberg
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-28 00:00:00 -04:00
+date: 2010-09-02 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency