mini-smtp-server 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Aaron Gough (http://thingsaaronmade.com/)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,78 @@
+= mini-smtp-server
+
+MiniSmtpServer is a small and easily customizable SMTP server. It is designed mainly to be integrated into other systems that will decide what to do with the mail that is received. By default mini-smtp-server operates as a black-hole and does not do anything with the mail being sent to it... Don't let that discourage you though, as MiniSmtpServer is designed to be extremely easy to customize which makes it fit more easily into your system!
+
+=== Using the server
+
+To run the default server simply use:
+
+  # Create a new server instance listening at 127.0.0.1:2525
+  # and accepting a maximum of 4 simultaneous connections
+  server = MiniSmtpServer.new(2525, "127.0.0.1", 4)
+  
+  # Start the server
+  server.start
+  
+  # ...
+  # serving requests & doing other work here
+  # ...
+  
+  # Shutdown the server without interrupting any connections:
+  server.shutdown
+  while(server.connections > 0)
+    sleep 0.01
+  end
+  server.stop
+  server.join
+  
+=== Installation
+
+For convenience MiniSmtpServer is packaged as a RubyGem, to install it simply enter the following at your command line:
+
+  gem install mini-smtp-server
+
+=== Customizing the server
+
+MiniSmtpServer is designed to be easy to customize via subclassing. Simply subclass the `MiniSmtpServer` class and re-define the `new_message_event` event handler:
+
+  # This is an SMTP server that logs all
+  # the messages it receives to STDOUT
+  class StdoutSmtpServer < MiniSmtpServer
+  
+    def new_message_event(message_hash)
+      puts "# New email received:"
+      puts "-- From: #{message_hash[:from]}"
+      puts "-- To:   #{message_hash[:to]}"
+      puts "--"
+      puts "-- " + message_hash[:data].gsub(/\r\n/, "\r\n-- ")
+      puts
+    end
+    
+  end
+  
+Then create an instance of your new server and run it like you would normally:
+
+  server = StdoutSmtpServer.new
+  server.start
+  server.join
+  
+The possibilities are endless, and easy to implement! Want all your email stored in a database? No worries:
+
+  class DatabaseSmtpServer < MiniSmtpServer
+    def new_message_event(message_hash)
+      # Imagine we have an ActiveRecord model named 'Email'
+      Email.create(message_hash)
+    end
+  end
+  
+  # Presto!
+  
+If you have a great example of something you've done with MiniSmtpServer let me know and I will add it here!
+
+=== Author & Credits
+
+Author:: {Aaron Gough}[mailto:aaron@aarongough.com]
+
+MiniSmtpServer is based on code originally written by {Peter Cooper}[http://peterc.org/]
+
+Copyright (c) 2010 {Aaron Gough}[http://thingsaaronmade.com/] ({thingsaaronmade.com}[http://thingsaaronmade.com/]), released under the MIT license

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "mini-smtp-server"
+    gemspec.summary = "A small and simple SMTP server"
+    gemspec.description = "A small and simple SMTP server"
+    gemspec.email = "aaron@aarongough.com"
+    gemspec.homepage = "https://github.com/aarongough/mini-smtp-server"
+    gemspec.authors = ["Aaron Gough"]
+    gemspec.rdoc_options << '--line-numbers' << '--inline-source'
+    gemspec.extra_rdoc_files = ['README.rdoc', 'MIT-LICENSE']
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+
+desc 'Test mini-smtp-server.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib/*.rb'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+
+desc 'Generate documentation for mini-smtp-server.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ruby-tmdb'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('app/**/*.rb')
+end

data/lib/mini-smtp-server.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "mini-smtp-server", "mini-smtp-server.rb"))

data/lib/mini-smtp-server/mini-smtp-server.rb

@@ -0,0 +1,72 @@
+require 'gserver'
+
+class MiniSmtpServer < GServer
+
+  def initialize(port = 2525, host = "127.0.0.1", max_connections = 4, *args)
+    super(port, host, max_connections, *args)
+  end
+  
+  def serve(io)
+    @data_mode = false
+    @message = {:data => ""}
+    @connection_active = true
+    io.print "220 hello\r\n"
+    loop do
+      if IO.select([io], nil, nil, 0.1)
+	      data = io.readpartial(4096)
+	      log("<<< " + data) if(@audit)
+	      output = process_line(data)
+        log(">>> " + output) if(@audit && !output.empty?)
+	      io.print(output) unless output.empty?
+      end
+      break if(!@connection_active || io.closed?)
+    end
+    io.print "221 bye\r\n"
+    io.close
+    @message[:data].gsub!(/\r\n\Z/, '').gsub!(/\.\Z/, '')
+    new_message_event(@message)
+  end
+
+  def process_line(line)
+    # Handle specific messages from the client
+    case line
+    when (/^(HELO|EHLO)/)
+      return "220 go on...\r\n"
+    when (/^QUIT/)
+      @connection_active = false
+      return ""
+    when (/^MAIL FROM\:/)
+      @message[:from] = line.gsub(/^MAIL FROM\:/, '').strip
+      return "220 OK\r\n"
+    when (/^RCPT TO\:/)
+      @message[:to] = line.gsub(/^RCPT TO\:/, '').strip
+      return "220 OK\r\n"
+    when (/^DATA/)
+      @data_mode = true
+      return "354 Enter message, ending with \".\" on a line by itself\r\n"
+    end
+    
+    # If we are in data mode and the entire message consists
+    # solely of a period on a line by itself then we
+    # are being told to exit data mode
+    if((@data_mode) && (line.chomp =~ /^\.$/))
+      @message[:data] += line
+      @data_mode = false
+      return "220 OK\r\n"
+    end
+    
+    # If we are in date mode then we need to add
+    # the new data to the message
+    if(@data_mode)
+      @message[:data] += line
+      return ""
+    else
+      # If we somehow get to this point then
+      # we have encountered an error
+      return "500 ERROR\r\n"
+    end
+  end
+  
+  def new_message_event(message_hash)
+  end
+end

data/test/setup/.gitignore

@@ -0,0 +1 @@
+tmdb_api_key.txt

data/test/setup/custom_assertions.rb

@@ -0,0 +1,13 @@
+module Test::Unit::Assertions
+  
+  def assert_difference(measure, difference = 1)
+    before = eval(measure)
+    yield
+    after = eval(measure)
+    message = "Expected '#{measure}' to be: #{before + difference} but was: #{after}\n"
+    assert_block(message) do
+      after == (before + difference)
+    end
+  end
+  
+end

data/test/setup/test_unit_extensions.rb

@@ -0,0 +1,21 @@
+module Test::Unit
+  # Used to fix a minor minitest/unit incompatibility in flexmock
+  AssertionFailedError = Class.new(StandardError)
+  
+  class TestCase
+   
+    def self.test(name, &block)
+      test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
+      defined = instance_method(test_name) rescue false
+      raise "#{test_name} is already defined in #{self}" if defined
+      if block_given?
+        define_method(test_name, &block)
+      else
+        define_method(test_name) do
+          flunk "No implementation provided for #{name}"
+        end
+      end
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'net/smtp'
+
+require_files = []
+require_files << File.join(File.dirname(__FILE__), '..', 'lib', 'mini-smtp-server.rb')
+require_files.concat Dir[File.join(File.dirname(__FILE__), 'setup', '*.rb')]
+
+require_files.each do |file|
+  require File.expand_path(file)
+end

data/test/unit/mini_smtp_server_test.rb

@@ -0,0 +1,80 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper.rb'))
+
+class TestSmtpServer < MiniSmtpServer
+  def new_message_event(message_hash)
+    $messages << message_hash
+  end
+end
+
+$example_mail = <<EOD
+From: Your Name <your@mail.address>
+To: Destination Address <someone@example.com>
+Subject: test message
+Date: Sat, 23 Jun 2001 16:26:43 +0900
+Message-Id: <unique.message.id.string@example.com>
+
+This is a test message.
+EOD
+
+class MiniSmtpServerTest < Test::Unit::TestCase
+  
+  def setup
+    $messages = []
+    @server = TestSmtpServer.new(1234)
+    @server.start
+  end
+  
+  test "should receive new message" do
+    assert_difference("$messages.length") do
+      send_mail
+    end
+  end
+  
+  test "should receive 10 new messages" do
+    assert_difference("$messages.length", 10) do
+      10.times do
+        send_mail
+      end
+    end
+  end
+  
+  test "should store email from address in hash" do
+    assert_difference("$messages.length") do
+      send_mail
+    end
+    assert_equal "<smtp@test.com>", $messages.first[:from]
+  end
+  
+  test "should store email to address in hash" do
+    assert_difference("$messages.length") do
+      send_mail
+    end
+    assert_equal "<some1@test.com>", $messages.first[:to]
+  end
+  
+  test "should store email body in message hash" do
+    assert_difference("$messages.length") do
+      send_mail
+    end
+    assert_equal $example_mail.gsub("\n", "\r\n"), $messages.first[:data]
+  end
+  
+  def teardown
+    @server.shutdown
+    while(@server.connections > 0)
+    end
+    @server.stop
+    @server.join
+  end
+  
+  private
+  
+    def send_mail(message = $example_mail, from_address = "smtp@test.com", to_address = "some1@test.com")
+      Net::SMTP.start('127.0.0.1', 1234) do |smtp|
+        smtp.send_message(message, from_address, to_address)
+        smtp.finish
+        sleep 0.01
+      end
+    end
+  
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: mini-smtp-server
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Aaron Gough
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-05 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: A small and simple SMTP server
+email: aaron@aarongough.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/mini-smtp-server.rb
+- lib/mini-smtp-server/mini-smtp-server.rb
+- test/setup/.gitignore
+- test/setup/custom_assertions.rb
+- test/setup/test_unit_extensions.rb
+- test/test_helper.rb
+- test/unit/mini_smtp_server_test.rb
+has_rdoc: true
+homepage: https://github.com/aarongough/mini-smtp-server
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- --line-numbers
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A small and simple SMTP server
+test_files: 
+- test/setup/custom_assertions.rb
+- test/setup/test_unit_extensions.rb
+- test/test_helper.rb
+- test/unit/mini_smtp_server_test.rb