mailman 0.6.0 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cdeb5aa44e41f7d2b6d9b4652ab467d26a160699
+  data.tar.gz: 4ee7a90bc537c2f38b300227c50e0f0780dd956b
+SHA512:
+  metadata.gz: 569481ea8e5df1b94f809c93af6071303c4c22093c3fcaf4721c0924b8c6d719320c4853a8dd93ca243877f14f2aa1da843f050080a04155e4708febb64eeeb9
+  data.tar.gz: 78382077fab9d79e6088d85e693f99ff59b8a58b5e9d5d7ec64bd30aa02a7986924f4f2a3535e602fc5735cc0185b0601e596f569b5b6da69d8d16adc9b1bcf1

data/CHANGELOG.md

@@ -0,0 +1,108 @@
+## 0.7.0 (August 11, 2013)
+
+Features
+
+  - Configurable POP3 open_timeout and read_timeout values
+  - Middleware support
+  - CLI runner tool
+  - Multiple configurations
+
+
+## 0.6.0 (January 12, 2013)
+
+Features
+
+  - IMAP: Mark messages as seen instead of deleting them (see [5b6aef0](https://github.com/titanous/mailman/commit/5b6aef0163f0f28c790abf3083cbda7cbc9cc13f) for details on how revert to the previous behaviour)
+
+Bugfixes
+
+  - IMAP: Don't only process recent messages
+
+
+## 0.5.4 (January 3, 2013)
+
+Bufixes
+
+  - Fix multipart message matching
+  - Fix Rails environment require
+  - Speed up maildir processing
+
+
+## 0.5.3 (August 30, 2012)
+
+Features
+
+  - Add `watch_maildir` config flag that allows a single run against a maildir
+  - Add IMAP SSL and non-inbox folder support
+
+
+## 0.5.2 (June 13, 2012)
+
+Bugfixes
+
+  - Clear the params hash after each message
+  - Allow setting config.rails\_root to false
+
+
+## 0.5.1 (May 9, 2012)
+
+Bugfixes
+
+  - Check maildir on startup to catch any pre-existing messages
+  - Rescue errors while processing messages so that the app doesn't die
+
+
+## 0.5.0 (April 24, 2012)
+
+Features
+
+  - IMAP support
+  - Graceful death
+
+Bugfixes
+
+  - Check all new messages in Maildir when a file changes
+  - Don't move message from new to current in Maildir if process failed
+  - Avoid require listen if not use
+  - Avoid failing if POP3::Connection raises an exception
+  - Check multipart bodies properly
+  - Use listen gem instead of fssm
+  - Don't die if the Rails environment is already loaded
+
+
+## 0.4.0 (October 3, 2010)
+
+Features
+
+  - The `ignore_stdin` config option has been added
+
+Bugfixes
+
+  - Fix a Mail/ActiveSupport dependency issue with i18n
+
+
+## 0.3.0 (September 2, 2010)
+
+Features
+
+  - The `CC` condition has been added
+  - The router can route to class instance methods as well as blocks
+  - SSL is now supported by the POP3 receiver
+
+Bugfixes
+
+  - Fix a bug where messages were not being deleted properly by the POP3
+    polling loop
+  - Fix empty `To` fields crashing apps
+
+
+## 0.2.0 (July 28, 2010
+
+Features
+
+ - Add `Application.run` instead of Application.new().run
+
+
+## 0.1.0 (July 27, 2010)
+
+  Initial release.

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2010-2012 Jonathan Rudenberg
+Copyright (c) 2010-2013 Jonathan Rudenberg
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -21,41 +21,13 @@ See the [User Guide](https://github.com/titanous/mailman/blob/master/USER_GUIDE.
 
 ## Compatibility
 
-Tested on Ruby 1.8.7, 1.9.2, 1.9.3, REE, JRuby 1.7, and Rubinius.
-
-### Dependencies
-
- * mail >= 2.0.3
- * activesupport >= 2.3.4
- * listen >= 0.4.1
- * maildir >= 0.5.0
- * i18n >= 0.4.1
+Tested on Ruby 2.0, 1.9.3, JRuby, and Rubinius.
 
 ## Thanks
 
-This project was sponsored by the [Ruby Summer of Code](http://rubysoc.org),
-and my mentor was [Steven Soroka](http://github.com/ssoroka).
-
-### Contributors
-
-- [Nicolas Aguttes](http://github.com/tranquiliste)
-- [Nathan Broadbent](https://github.com/ndbroadbent)
-- [John Cant](https://github.com/johncant)
-- [Tim Carey-Smith](http://github.com/halorgium)
-- [Dan Cheail](https://github.com/DanCheail)
-- [Francis Chong](https://github.com/siuying)
-- [Kevin Glowacz](https://github.com/kjg)
-- [Cyril Mougel](http://github.com/shingara)
-- [Brian Palmer](https://github.com/codekitchen)
-- [Phillip Ridlen](https://github.com/philtr)
-- [Daniel Schierbeck](http://github.com/dasch)
-- [Steven Soroka](http://github.com/ssoroka)
-- [Ryan Stawarz](https://github.com/rstawarz)
-- [Benjamin Waldher](https://github.com/lgbr)
-- [Ian White](http://github.com/ianwhite)
-- [Andreas Wolff](https://github.com/rubyphunk)
-
+This project was originally sponsored by Ruby Summer of Code (2010), and
+mentored by [Steven Soroka](http://github.com/ssoroka).
 
 ## Copyright
 
-Copyright (c) 2010-2012 Jonathan Rudenberg. See LICENSE for details.
+Copyright (c) 2010-2013 Jonathan Rudenberg. See LICENSE for details.

data/USER_GUIDE.md

@@ -269,3 +269,29 @@ interfere with running Mailman with cron or as a daemon.
 (Control-C) and allow the mail receiver to finish its current
 iteration before exiting. Note that this currently only works
 with POP3 receivers.
+
+### Middleware
+
+`Mailman.config.middleware` gives you access to the Mailman middleware stack.
+Middleware allows you to execute code before and after each message is
+processed. Middleware is super useful for things like error handling and any
+other actions you need to do before/after each message is processed.
+
+Here's an example of some simple error logging middleware:
+
+```ruby
+# Define the middleware
+class ErrorLoggingMiddleware
+  def call(mail)
+    begin
+      yield
+    rescue
+      puts "There was an error processing this message! #{mail.subject}"
+      raise
+    end
+  end
+end
+
+# Add it to the Mailman middleware stack
+Mailman.config.middleware.add ErrorLoggingMiddleware
+```

data/bin/mailman

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require 'mailman/cli'
+require 'optparse'
+
+$:.<< '.'
+
+options = {}
+
+ARGV.options do |opts|
+  opts.on('-c', '--config=val', String) { |config_file| options[:config_file] = config_file }
+  opts.on('-p', '--pidfile=val', String) { |pid_file| options[:pid_file] = pid_file }
+  opts.on('-e', '--environment=val', String) { |environment| options[:environment] = environment }
+
+  opts.parse!
+end
+
+begin
+  Mailman::CLI.new(options).run
+rescue => e
+  STDERR.puts e
+  STDERR.puts e.backtrace.join("\n")
+
+  exit 1
+end

data/lib/mailman.rb

@@ -9,7 +9,7 @@ require 'mailman/version'
 
 module Mailman
 
-  [:Application, :Router, :Configuration, :Receiver, :MessageProcessor].each do |constant|
+  [:Application, :Router, :Configuration, :Receiver, :MessageProcessor, :Middleware].each do |constant|
     autoload constant, "mailman/#{constant.to_s.underscore}"
   end
 

data/lib/mailman/application.rb

@@ -2,8 +2,12 @@ module Mailman
   # The main application class. Pass a block to {#new} to create a new app.
   class Application
 
-    def self.run(&block)
-      app = new(&block)
+    def self.run(config=nil, &block)
+      if config
+        app = new(config, &block)
+      else
+        app = new(&block)
+      end
       app.run
       app
     end
@@ -14,25 +18,29 @@ module Mailman
     # @return [MessageProcessor] the app's message processor
     attr_reader :processor
 
+    # @return [Config] the apps's configuration
+    attr_reader :config
+
     # Creates a new router, and sets up any routes passed in the block.
     # @param [Hash] options the application options
     # @option options [true,false] :graceful_death catch interrupt signal and don't die until end of poll
     # @param [Proc] block a block with routes
 
-    def initialize(&block)
+    def initialize(config=:default, &block)
       @router = Mailman::Router.new
-      @processor = MessageProcessor.new(:router => @router)
+      @config = select_config(config)
+      @processor = MessageProcessor.new(:router => @router, :config => @config)
 
-      if Mailman.config.maildir
+      if self.config.maildir
         require 'maildir'
-        @maildir = Maildir.new(Mailman.config.maildir)
+        @maildir = Maildir.new(self.config.maildir)
       end
 
       instance_eval(&block) if block_given?
     end
 
     def polling?
-      Mailman.config.poll_interval > 0 && !@polling_interrupt
+      config.poll_interval > 0 && !@polling_interrupt
     end
 
     # Sets the block to run if no routes match a message.
@@ -44,47 +52,47 @@ module Mailman
     def run
       Mailman.logger.info "Mailman v#{Mailman::VERSION} started"
 
-      if Mailman.config.rails_root
-        rails_env = File.join(Mailman.config.rails_root, 'config', 'environment.rb')
+      if config.rails_root
+        rails_env = File.join(config.rails_root, 'config', 'environment.rb')
         if File.exist?(rails_env) && !(defined?(Rails) && Rails.env)
-          Mailman.logger.info "Rails root found in #{Mailman.config.rails_root}, requiring environment..."
+          Mailman.logger.info "Rails root found in #{config.rails_root}, requiring environment..."
           require rails_env
         end
       end
 
-      if Mailman.config.graceful_death
+      if config.graceful_death
         # When user presses CTRL-C, finish processing current message before exiting
         Signal.trap("INT") { @polling_interrupt = true }
       end
 
       # STDIN
-      if !Mailman.config.ignore_stdin && $stdin.fcntl(Fcntl::F_GETFL, 0) == 0
+      if !config.ignore_stdin && $stdin.fcntl(Fcntl::F_GETFL, 0) == 0
         Mailman.logger.debug "Processing message from STDIN."
         @processor.process($stdin.read)
 
       # IMAP
-      elsif Mailman.config.imap
-        options = {:processor => @processor}.merge(Mailman.config.imap)
+      elsif config.imap
+        options = {:processor => @processor}.merge(config.imap)
         Mailman.logger.info "IMAP receiver enabled (#{options[:username]}@#{options[:server]})."
         polling_loop Receiver::IMAP.new(options)
 
       # POP3
-      elsif Mailman.config.pop3
-        options = {:processor => @processor}.merge(Mailman.config.pop3)
+      elsif config.pop3
+        options = {:processor => @processor}.merge(config.pop3)
         Mailman.logger.info "POP3 receiver enabled (#{options[:username]}@#{options[:server]})."
         polling_loop Receiver::POP3.new(options)
 
       # Maildir
-      elsif Mailman.config.maildir
+      elsif config.maildir
 
-        Mailman.logger.info "Maildir receiver enabled (#{Mailman.config.maildir})."
+        Mailman.logger.info "Maildir receiver enabled (#{config.maildir})."
 
         Mailman.logger.debug "Processing new message queue..."
         @maildir.list(:new).each do |message|
           @processor.process_maildir_message(message)
         end
 
-        if Mailman.config.watch_maildir
+        if config.watch_maildir
           require 'listen'
           Mailman.logger.debug "Monitoring the Maildir for new messages..."
 
@@ -103,10 +111,17 @@ module Mailman
 
     private
 
+    def select_config(new_config)
+      return Mailman.config if new_config == :default
+      return new_config if new_config.is_a?(Configuration)
+      return Configuration.from_hash(new_config) if new_config.is_a?(Hash)
+      return Configuration.new
+    end
+
     # Run the polling loop for the email inbox connection
     def polling_loop(connection)
       if polling?
-        polling_msg = "Polling enabled. Checking every #{Mailman.config.poll_interval} seconds."
+        polling_msg = "Polling enabled. Checking every #{config.poll_interval} seconds."
       else
         polling_msg = "Polling disabled. Checking for messages once."
       end
@@ -122,7 +137,7 @@ module Mailman
         end
 
         break unless polling?
-        sleep Mailman.config.poll_interval
+        sleep config.poll_interval
       end
     end
 

data/lib/mailman/cli.rb

@@ -0,0 +1,39 @@
+require 'mailman'
+
+module Mailman
+  class CLI
+    class ConfigNotDefined < StandardError; end
+
+    def initialize(options = {})
+      @config_file = options[:config_file]
+      @pid_file = options[:pid_file]
+      @environment = options[:environment]
+    end
+
+    def run
+      set_environment
+      record_pid_file
+      load_config
+    end
+
+    def set_environment
+      ENV['RACK_ENV'] = ENV['RAILS_ENV'] = @environment
+    end
+
+    def load_config
+      if @config_file
+        require @config_file
+      else
+        raise ConfigNotDefined.new
+      end
+    end
+
+    def record_pid_file
+      if @pid_file
+        File.open(@pid_file, 'w') do |f|
+          f.puts Process.pid
+        end
+      end
+    end
+  end
+end

data/lib/mailman/configuration.rb

@@ -31,6 +31,10 @@ module Mailman
     # connections.
     attr_accessor :graceful_death
 
+    def middleware
+      @middleware ||= Mailman::Middleware.new
+    end
+
     def logger
       @logger ||= Logger.new(STDOUT)
     end
@@ -47,5 +51,13 @@ module Mailman
       @rails_root.nil? ? '.' : @rails_root
     end
 
+    def self.from_hash(options)
+      config = self.new
+      options.each do |key, value|
+        config.send "#{key}=", value
+      end
+      config
+    end
+
   end
 end

data/lib/mailman/message_processor.rb

@@ -7,6 +7,7 @@ module Mailman
     #   messages to
     def initialize(options)
       @router = options[:router]
+      @config = options[:config]
     end
 
     # Converts a raw email into a +Mail::Message+ instance, and passes it to the
@@ -16,7 +17,11 @@ module Mailman
       mail = Mail.new(message)
       from = mail.from.nil? ? "unknown" : mail.from.first
       Mailman.logger.info "Got new message from '#{from}' with subject '#{mail.subject}'."
-      @router.route(mail)
+
+      # Run any middlewares before routing the message
+      @config.middleware.run(mail) do
+        @router.route(mail)
+      end
     end
 
     # Processes a +Maildir::Message+ instance.

data/lib/mailman/middleware.rb

@@ -0,0 +1,47 @@
+module Mailman
+  class Middleware
+    attr_reader :entries
+
+    def initialize
+      @entries = []
+      yield self if block_given?
+    end
+
+    def add(klass)
+      entries << klass
+    end
+
+    def remove(klass)
+      entries.delete(klass)
+    end
+
+    def insert_before(oldklass, newklass)
+      idx = entries.index(oldklass) || 0
+      entries.insert(idx, newklass)
+    end
+
+    def insert_after(oldklass, newklass)
+      idx = entries.rindex(oldklass) || entries.count - 1
+      entries.insert(idx+1, newklass)
+    end
+
+    def run(*args, &final_action)
+      final_return = nil
+      stack = @entries.map {|m| m.new}
+      traverse_stack = lambda do
+        if stack.empty?
+          final_return = final_action.call
+        else
+          stack.shift.call(*args, &traverse_stack)
+        end
+      end
+      traverse_stack.call
+
+      final_return
+    end
+
+    def each(&block)
+      entries.each(&block)
+    end
+  end
+end

data/lib/mailman/receiver/imap.rb

@@ -36,7 +36,7 @@ module Mailman
       # Connects to the IMAP server.
       def connect
         if @connection.nil? or @connection.disconnected?
-          @connection = Net::IMAP.new(@server, @port, @ssl)
+          @connection = Net::IMAP.new(@server, port: @port, ssl: @ssl)
           @connection.login(@username, @password)
         end
         @connection.select(@folder)

data/lib/mailman/receiver/pop3.rb

@@ -22,6 +22,8 @@ module Mailman
         @password = options[:password]
         @connection = Net::POP3.new(options[:server], options[:port])
         @connection.enable_ssl(OpenSSL::SSL::VERIFY_NONE) if options[:ssl]
+        @connection.open_timeout = options[:open_timeout] if options[:open_timeout]
+        @connection.read_timeout = options[:read_timeout] if options[:read_timeout]
       end
 
       # Connects to the POP3 server.

data/lib/mailman/version.rb

@@ -1,3 +1,3 @@
 module Mailman
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,100 +1,88 @@
 --- !ruby/object:Gem::Specification
 name: mailman
 version: !ruby/object:Gem::Version
-  version: 0.6.0
-  prerelease: 
+  version: 0.7.0
 platform: ruby
 authors:
 - Jonathan Rudenberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-13 00:00:00.000000000 Z
+date: 2013-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.0.3
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.3.4
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: maildir
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -111,13 +98,17 @@ description: Mailman makes it easy to process incoming emails with a simple rout
   DSL
 email:
 - jonathan@titanous.com
-executables: []
+executables:
+- mailman
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/mailman
 - lib/mailman/application.rb
+- lib/mailman/cli.rb
 - lib/mailman/configuration.rb
 - lib/mailman/message_processor.rb
+- lib/mailman/middleware.rb
 - lib/mailman/receiver/imap.rb
 - lib/mailman/receiver/pop3.rb
 - lib/mailman/receiver.rb
@@ -134,28 +125,28 @@ files:
 - LICENSE
 - README.md
 - USER_GUIDE.md
-homepage: http://mailmanrb.com
+- CHANGELOG.md
+homepage: https://github.com/titanous/mailman
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: mailman
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A incoming email processing microframework
 test_files: []