post_office 0.1.0 → 0.2.0

data/README.md

@@ -1,10 +1,66 @@
 PostOffice mock SMTP/POP3 server
 ================================
 
+https://github.com/bluerail/post_office
+
 By Rene van Lieshout <rene@bluerail.nl>
 
-Usage:
+Description
+-----------
+
+PostOffice is a mock SMTP/POP3 server to accept mails sent from your Rails application when it's running in development. The messages can be retrieved using a standard POP3 client, such as mail.app. Just connect to localhost with any username and password.
+
+Note: Received messages are **not** sent to their final recipient and will remain available until deleted or when the process is quit.
+
+Installation
+------------
+
+    sudo gem install post_office
+
+Usage
+-----
+
+    sudo post_office [options]
+    
+    -v, --verbose                    Output more information
+    -l, --logfile FILE               Write log to FILE. Outputs to STDOUT (or /var/log/post_office.log when daemonized) by default.
+    -h, --help                       Display this screen
+
+This starts the service and listens on port 25 and 110. Configure your POP3 client with any username and password.
+
+Daemon
+------
+
+It's possible to start PostOffice as a daemon using post_officed:
+
+    Usage: post_officed <command> <options> -- <application options>
+
+    * where <command> is one of:
+      start         start an instance of the application
+      stop          stop all instances of the application
+      restart       stop all instances and restart them afterwards
+      reload        send a SIGHUP to all instances of the application
+      run           start the application and stay on top
+      zap           set the application to a stopped state
+      status        show status (PID) of application instances
+
+    * and where <options> may contain several of the following:
+
+        -t, --ontop                      Stay on top (does not daemonize)
+        -f, --force                      Force operation
+        -n, --no_wait                    Do not wait for processes to stop
+
+    Common options:
+        -h, --help                       Show this message
+            --version                    Show version
+
+Planned features
+----------------
 
-    sudo post_office
+* Ability to use custom ports for SMTP and POP
+* Growl notifications
+* Mac OS X Startup Item / launchctl service
+* Store mail in tempfiles instead of in-memory array
+* Tests :)
 
-Listens on port 25 and 110. Configure your POP3 client with any username and password.
+Contributions are welcome! Feel free to fork and send a pull request through Github.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'  
+require 'rake'  
+
+begin  
+  require 'jeweler'  
+  Jeweler::Tasks.new do |gemspec|  
+    gemspec.name = "post_office"  
+    gemspec.summary = "PostOffice mock SMTP/POP3 server"  
+    gemspec.description = "PostOffice mock SMTP/POP3 server"  
+    gemspec.email = "rene@bluerail.nl"
+    gemspec.homepage = "http://github.com/bluerail/post_office"
+    gemspec.description = "A mock SMTP/POP3 server to aid in the development of applications with mail functionality."
+    gemspec.authors = ["Rene van Lieshout"]  
+    gemspec.bindir = "bin"
+    gemspec.executables = ['post_office', 'post_officed']
+  end  
+rescue LoadError  
+  puts "Jeweler not available. Install it with: sudo gem install jeweler" 
+end  

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/bin/post_office

@@ -1,10 +1,44 @@
 #!/usr/bin/env ruby
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 
+require 'optparse'
+require 'logger'
 require 'thread'
 require 'smtp_server.rb'
 require 'pop_server.rb'
 
+#
+# Parse command line arguments
+#
+options = {}
+ 
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: #{__FILE__} [options]"
+
+  options[:verbose] = false
+  opts.on( '-v', '--verbose', 'Output more information' ) do
+    options[:verbose] = true
+  end
+
+  options[:logfile] = nil
+  opts.on( '-l', '--logfile FILE', 'Write log to FILE. Outputs to STDOUT (or /var/log/post_office.log when daemonized) by default.' ) do |file|
+    options[:logfile] = file
+  end
+
+  opts.on( '-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
+end
+
+optparse.parse!
+
+#
+# Create our logger
+#
+$log = Logger.new(options[:logfile] || STDOUT)
+$log.level = options[:verbose] ? Logger::DEBUG : Logger::INFO
+
 begin
   smtp_server = Thread.new{ SMTPServer.new }
   pop_server  = Thread.new{ POPServer.new  }
@@ -12,7 +46,7 @@ begin
   smtp_server.join
   pop_server.join
 rescue Interrupt
-  puts "Interrupt..."
+  $log.info "Interrupt..."
 rescue Errno::EACCES
-  puts "I need root access to open ports 25 and 110. Please sudo #{__FILE__}"
+  $log.error "I need root access to open ports 25 and 110. Please sudo #{__FILE__}"
 end

data/bin/post_officed

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'daemons'
+
+# use /var/log/post_office.log as default logger
+# /var/log/post_office.log
+unless ARGV.include?("-l") || ARGV.include?("--logfile")
+  ARGV.push "--" unless ARGV.include?("--")
+  ARGV.push "--logfile"
+  ARGV.push "/var/log/post_office.log"
+end
+
+Daemons.run(File.dirname(__FILE__) + '/post_office')

data/lib/generic_server.rb

@@ -25,12 +25,14 @@ class GenericServer
   def initialize(options)
     @port = options[:port]
     server = TCPServer.open(@port)
-    puts "#{self.class.to_s} listening on port #{@port}"
+    $log.info "#{self.class.to_s} listening on port #{@port}"
     
     # Accept connections until infinity and beyond
     loop do
       Thread.start(server.accept) do |client|
         begin
+          client_addr = client.addr
+          $log.info "#{self.class.to_s} accepted connection #{client.object_id} from #{client_addr.inspect}"
           greet client
 
           # Keep processing commands until somebody closed the connection
@@ -40,12 +42,13 @@ class GenericServer
             # The first word of a line should contain the command
             command = input.to_s.gsub(/ .*/,"").upcase.gsub(/[\r\n]/,"")
 
-            puts "#{client.object_id}:#{@port} < #{input}"
+            $log.debug "#{client.object_id}:#{@port} < #{input}"
 
             process(client, command, input)
           end until client.closed?
+          $log.info "#{self.class.to_s} closed connection #{client.object_id} with #{client_addr.inspect}"
         rescue => detail
-          puts "#{client.object_id}:#{@port} ! #{$!}"
+          $log.error "#{client.object_id}:#{@port} ! #{$!}"
           client.close
         end
       end
@@ -54,10 +57,10 @@ class GenericServer
   
   # Respond to client by sending back text
   def respond(client, text)
-    puts "#{client.object_id}:#{@port} > #{text}"
+    $log.debug "#{client.object_id}:#{@port} > #{text}"
     client.puts text
   rescue
-    puts "#{client.object_id}:#{@port} ! #{$!}"
+    $log.error "#{client.object_id}:#{@port} ! #{$!}"
     client.close
   end
   

data/lib/smtp_server.rb

@@ -45,7 +45,7 @@ class SMTPServer < GenericServer
   # Stores sender address
   def mail_from(client, full_data)
     if /^MAIL FROM:/ =~ full_data.upcase
-      set_client_data(client, :from, full_data.gsub(/^MAIL FROM:/i,""))
+      set_client_data(client, :from, full_data.gsub(/^MAIL FROM:\s*/i,"").gsub(/[\r\n]/,""))
       respond(client, 250)
     else
       respond(client, 500)
@@ -55,7 +55,7 @@ class SMTPServer < GenericServer
   # Stores recepient address
   def rcpt_to(client, full_data)
     if /^RCPT TO:/ =~ full_data.upcase
-      set_client_data(client, :to, full_data.gsub(/^RCPT TO:/i,""))
+      set_client_data(client, :to, full_data.gsub(/^RCPT TO:\s*/i,"").gsub(/[\r\n]/,""))
       respond(client, 250)
     else
       respond(client, 500)
@@ -84,6 +84,7 @@ class SMTPServer < GenericServer
         get_client_data(client, :data).to_s
       )
       respond(client, 250)
+      $log.info "Received mail from #{get_client_data(client, :from).to_s} with recipient #{get_client_data(client, :to).to_s}"
     else
       set_client_data(client, :data, get_client_data(client, :data).to_s + full_data)
     end

data/post_office.gemspec

@@ -0,0 +1,46 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{post_office}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rene van Lieshout"]
+  s.date = %q{2011-04-19}
+  s.description = %q{A mock SMTP/POP3 server to aid in the development of applications with mail functionality.}
+  s.email = %q{rene@bluerail.nl}
+  s.executables = ["post_office", "post_officed"]
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/post_office",
+    "bin/post_officed",
+    "lib/generic_server.rb",
+    "lib/pop_server.rb",
+    "lib/smtp_server.rb",
+    "lib/store.rb",
+    "pkg/post_office-0.1.0.gem",
+    "post_office.gemspec"
+  ]
+  s.homepage = %q{http://github.com/bluerail/post_office}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.0}
+  s.summary = %q{PostOffice mock SMTP/POP3 server}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: post_office
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Rene van Lieshout
@@ -15,26 +15,31 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-18 00:00:00 +02:00
-default_executable: post_office
+date: 2011-04-19 00:00:00 +02:00
+default_executable: 
 dependencies: []
 
 description: A mock SMTP/POP3 server to aid in the development of applications with mail functionality.
 email: rene@bluerail.nl
 executables: 
 - post_office
+- post_officed
 extensions: []
 
 extra_rdoc_files: 
 - README.md
 files: 
 - README.md
+- Rakefile
 - VERSION
+- bin/post_office
+- bin/post_officed
 - lib/generic_server.rb
 - lib/pop_server.rb
 - lib/smtp_server.rb
 - lib/store.rb
-- bin/post_office
+- pkg/post_office-0.1.0.gem
+- post_office.gemspec
 has_rdoc: true
 homepage: http://github.com/bluerail/post_office
 licenses: []
@@ -65,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: PostOffice mock SMTP/POP3 server