fakesmtpd 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+*.pid
+
+/.bundle/
+/.config/
+/.yardoc/
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/lib/bundler/man/
+/pkg/
+/rdoc/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/.artifacts/

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p448

data/.travis.yml

@@ -0,0 +1,5 @@
+---
+language: ruby
+rvm:
+- 1.9.3
+- 2.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 ModCloth, Inc.
+
+MIT License
+
+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.md

@@ -0,0 +1,21 @@
+`fakesmtpd`
+===========
+
+A fake SMTP server with a minimal HTTP API.
+Inspired by [mailtrap](https://github.com/mmower/mailtrap).
+
+## installation
+You may install either via `gem` or by directly downloading the server
+file which may then be used as an executable, e.g.:
+
+``` bash
+gem install fakesmtpd
+```
+
+**OR**
+
+``` bash
+curl -o fakesmtpd https://raw.github.com/modcloth-labs/fakesmtpd/master/lib/fakesmtpd/server.rb
+chmod +x fakesmtpd
+```
+

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+
+desc 'Run minitest tests in ./test'
+task test: :load_minitest do
+  Dir.glob("#{File.expand_path('../test', __FILE__)}/*_test.rb").each do |f|
+    require f
+  end
+
+  mkdir_p(File.expand_path('../.artifacts', __FILE__))
+  exit(MiniTest::Unit.new.run(%W(#{ENV['MINITEST_ARGS'] || ''})) || 1)
+end
+
+task :load_minitest do
+  require 'minitest/spec'
+end
+
+task default: :test

data/bin/fakesmtpd

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'fakesmtpd'
+FakeSMTPd::Server.main(ARGV)

data/fakesmtpd.gemspec

@@ -0,0 +1,25 @@
+# vim:fileencoding=utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fakesmtpd'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fakesmtpd'
+  spec.version       = FakeSMTPd::VERSION
+  spec.authors       = ['Dan Buch']
+  spec.email         = ['d.buch@modcloth.com']
+  spec.description   = %q{A fake SMTP server with a minimal HTTP API}
+  spec.summary       = %q{A fake SMTP server with a minimal HTTP API}
+  spec.homepage      = 'https://github.com/modcloth-labs/fakesmtpd'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
+end

data/lib/fakesmtpd.rb

@@ -0,0 +1,6 @@
+module FakeSMTPd
+  autoload :Server, 'fakesmtpd/server'
+  autoload :HTTPServer, 'fakesmtpd/server'
+  autoload :Runner, 'fakesmtpd/runner'
+  autoload :VERSION, 'fakesmtpd/version'
+end

data/lib/fakesmtpd/runner.rb

@@ -0,0 +1,63 @@
+# vim:fileencoding=utf-8
+
+require 'fileutils'
+require 'logger'
+
+class FakeSMTPd::Runner
+  attr_reader :port, :dir, :pidfile, :http_port
+  attr_reader :startup_sleep, :server_pid, :options
+
+  def initialize(options = {})
+    @dir = options.fetch(:dir)
+    @port = Integer(options.fetch(:port))
+    @http_port = Integer(options[:http_port] || port + 1)
+    @pidfile = options[:pidfile] || 'fakesmtpd.pid'
+    @startup_sleep = options[:startup_sleep] || 0.5
+  end
+
+  def description
+    "fakesmtpd server on port #{port}"
+  end
+
+  def command
+    [
+      RbConfig.ruby,
+      File.expand_path('../server.rb', __FILE__),
+      port.to_s,
+      dir,
+      pidfile,
+    ].join(' ')
+  end
+
+  def start
+    if dir
+      FileUtils.mkdir_p(dir)
+    end
+    process_command = command
+    log.info "Starting #{description}"
+    log.info "  ---> #{process_command}"
+    @server_pid = Process.spawn(process_command)
+    sleep startup_sleep
+    server_pid
+  end
+
+  def stop
+    real_pid = Integer(File.read(pidfile).chomp) rescue nil
+    if server_pid && real_pid
+      log.info "Stopping #{description} " <<
+               "(shell PID=#{server_pid}, server PID=#{real_pid})"
+
+      [real_pid, server_pid].each do |pid|
+        Process.kill(:TERM, pid) rescue nil
+      end
+    end
+  end
+
+  def log
+    @log ||= Logger.new($stderr).tap do |l|
+      l.formatter = proc do |severity, datetime, _, msg|
+        "[fakesmtpd] #{severity} #{datetime} - #{msg}\n"
+      end
+    end
+  end
+end

data/lib/fakesmtpd/server.rb

@@ -0,0 +1,248 @@
+#!/usr/bin/env ruby
+# vim:fileencoding=utf-8
+# Inspired by mailtrap (https://github.com/mmower/mailtrap)
+#
+# Copyright (c) 2013 ModCloth, Inc.
+#
+# MIT License
+#
+# 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.
+
+require 'json'
+require 'logger'
+require 'socket'
+require 'thread'
+
+$fakesmtpd_semaphore = Mutex.new
+
+module FakeSMTPd
+  class HTTPServer
+    attr_reader :server, :port, :smtpd, :log
+
+    def initialize(options = {})
+      @port = options.fetch(:port)
+      @smtpd = options.fetch(:smtpd)
+      @log = Logger.new($stderr).tap do |l|
+        l.formatter = proc do |severity, datetime, _, msg|
+          "[fakesmtpd-http] #{severity} #{datetime} - #{msg}\n"
+        end
+      end
+    end
+
+    def start
+      @server = Thread.new do
+        httpd = TCPServer.new(port)
+        log.info "FakeSMTPd HTTP server serving on #{port}"
+        log.info "PID=#{$$} Thread=#{Thread.current.inspect}"
+        loop do
+          client = httpd.accept
+          request_line = client.gets
+          log.info request_line.chomp
+          if request_line =~ /^GET \/messages /
+            client.puts 'HTTP/1.1 200 OK'
+            client.puts 'Content-type: application/json;charset=utf-8'
+            client.puts
+            $fakesmtpd_semaphore.synchronize do
+              client.puts JSON.pretty_generate(
+                message_files: smtpd.message_files_written
+              )
+            end
+          elsif request_line =~ /^DELETE \/messages /
+            $fakesmtpd_semaphore.synchronize do
+            smtpd.message_files_written.clear
+          end
+          client.puts 'HTTP/1.1 204 No Content'
+          client.puts
+          else
+            client.puts 'HTTP/1.1 405 Method Not Allowed'
+            client.puts 'Content-type: text/plain;charset=utf-8'
+            client.puts
+            client.puts 'Only "(GET|DELETE) /messages" is supported, eh.'
+          end
+          client.close
+        end
+      end
+    end
+
+    def kill!
+      @server && @server.kill
+    end
+  end
+
+  class Server
+    VERSION = '0.1.0'
+    USAGE = "Usage: #{File.basename($0)} <port> <message-dir> [pidfile]"
+
+    attr_reader :port, :message_dir, :log, :pidfile, :message_files_written
+
+    class << self
+      def main(argv = [].freeze)
+        if argv.include?('-h') || argv.include?('--help')
+          puts USAGE
+          exit 0
+        end
+        if argv.include?('--version')
+          puts FakeSMTPd::Server::VERSION
+          exit 0
+        end
+        unless argv.length > 1
+          abort USAGE
+        end
+        @smtpd = FakeSMTPd::Server.new(
+          port: Integer(argv.fetch(0)),
+          dir: argv.fetch(1),
+          pidfile: argv[2]
+        )
+        @httpd = FakeSMTPd::HTTPServer.new(
+          port: Integer(argv.fetch(0)) + 1,
+          smtpd: @smtpd,
+        )
+
+        $stderr.puts '--- Starting up ---'
+        @httpd.start
+        @smtpd.start
+        loop { sleep 1 }
+      rescue Exception => e
+        $stderr.puts '--- Shutting down ---'
+        @httpd && @httpd.kill!
+        @smtpd && @smtpd.kill!
+        unless e.is_a?(Interrupt)
+          raise e
+        end
+      end
+    end
+
+    def initialize(options = {})
+      @port = options.fetch(:port)
+      @message_dir = options.fetch(:dir)
+      @pidfile = options[:pidfile] || 'fakesmtpd.pid'
+      @log = Logger.new($stderr).tap do |l|
+        l.formatter = proc do |severity, datetime, _, msg|
+          "[fakesmtpd-smtp] #{severity} #{datetime} - #{msg}\n"
+        end
+      end
+      @message_files_written = []
+    end
+
+    def start
+      @server = Thread.new do
+        smtpd = TCPServer.new(port)
+        log.info "FakeSMTPd SMTP server serving on #{port}, " <<
+        "writing messages to #{message_dir.inspect}"
+        log.info "PID=#{$$}, Thread=#{Thread.current.inspect}"
+        File.open(pidfile, 'w') { |f| f.puts($$) }
+
+        loop do
+          begin
+            serve(smtpd.accept)
+          rescue => e
+            log.error "WAT: #{e.class.name} #{e.message}"
+          end
+        end
+      end
+    end
+
+    def kill!
+      @server && @server.kill
+    end
+
+    def serve(client)
+      class << client
+        attr_reader :client_id
+
+        def getline
+          line = gets
+          line.chomp! unless line.nil?
+          line
+        end
+
+        def to_s
+          @client_id ||= Time.now.utc.strftime('%Y%m%d%H%M%S%N')
+          "<smtp client #{@client_id}>"
+        end
+      end
+
+      client.puts '220 localhost fakesmtpd ready ESMTP'
+      helo = client.getline
+      log.info "#{client} Helo: #{helo.inspect}"
+
+      if helo =~ /^EHLO\s+/
+        log.info "#{client} Seen an EHLO"
+        client.puts '250-localhost only has this one extension'
+        client.puts '250 HELP'
+      end
+
+      from = client.getline
+      client.puts '250 OK'
+      log.info "#{client} From: #{from.inspect}"
+
+      recipients = []
+      loop do
+        to = client.getline
+        break if to.nil?
+
+        if to =~ /^DATA/
+          client.puts '354 Lemme have it'
+          break
+        else
+          log.info "#{client} To: #{to.inspect}"
+          recipients << to
+          client.puts '250 OK'
+        end
+      end
+
+      lines = []
+      loop do
+        line = client.getline
+        break if line.nil? || line == '.'
+        lines << line
+        log.debug "#{client} + #{line}"
+      end
+
+      client.puts '250 OK'
+      client.gets
+      client.puts '221 Buhbye'
+      client.close
+      log.info "#{client} ding!"
+
+      record(client, from, recipients, lines)
+    end
+
+    def record(client, from, recipients, body)
+      outfile = File.join(message_dir, "fakesmtpd-client-#{client.client_id}.json")
+      File.open(outfile, 'w') do |f|
+        f.write JSON.pretty_generate(
+          client_id: client.client_id,
+          from: from,
+          recipients: recipients,
+          body: body,
+        )
+      end
+      $fakesmtpd_semaphore.synchronize do
+        message_files_written << outfile
+      end
+      outfile
+    end
+  end
+end
+
+if __FILE__ == $0
+  FakeSMTPd::Server.main(ARGV)
+end

data/lib/fakesmtpd/version.rb

@@ -0,0 +1,3 @@
+module FakeSMTPd
+  VERSION = '0.1.0'
+end

data/test/fakesmtpd_test.rb

@@ -0,0 +1,56 @@
+require 'json'
+require 'net/http'
+require 'net/smtp'
+require 'uri'
+
+require 'fakesmtpd'
+
+describe 'fakesmtpd server' do
+  RUNNER = FakeSMTPd::Runner.new(
+    dir: File.expand_path('../../.artifacts', __FILE__),
+    port: rand(9100..9199)
+  )
+  RUNNER.start
+
+  at_exit { RUNNER.stop }
+
+  def randint
+    @randint ||= rand(999..1999)
+  end
+
+  def subject_header
+    @subject_header ||= "DERF DERF DERF #{randint}"
+  end
+
+  def msg
+    <<-EOM.gsub(/^ {6}/, '')
+      From: fakesmtpd <fakesmtpd@example.org>
+      To: Fruit Cake <fruitcake@example.org>
+      Subject: #{subject_header}
+      Date: Sat, 10 Aug 2013 16:59:20 +0500
+      Message-Id: <fancy.pants.are.fancy.#{randint}@example.org>
+
+      Herp derp derp herp.
+    EOM
+  end
+
+  def send_message
+    Net::SMTP.start('localhost', RUNNER.port) do |smtp|
+      smtp.send_message msg, 'fakesmtpd@example.org', 'fruitcake@example.org'
+    end
+  end
+
+  it 'accepts messages via SMTP' do
+    send_message
+  end
+
+  it 'reports messages sent via HTTP' do
+    send_message
+
+    uri = URI("http://localhost:#{RUNNER.http_port}/messages")
+    response = JSON.parse(Net::HTTP.get_response(uri).body)
+    message_file = response.fetch('message_files').last
+    message_body = JSON.parse(File.read(message_file)).fetch('body')
+    message_body.must_include("Subject: #{subject_header}")
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: fakesmtpd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Dan Buch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A fake SMTP server with a minimal HTTP API
+email:
+- d.buch@modcloth.com
+executables:
+- fakesmtpd
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/fakesmtpd
+- fakesmtpd.gemspec
+- lib/fakesmtpd.rb
+- lib/fakesmtpd/runner.rb
+- lib/fakesmtpd/server.rb
+- lib/fakesmtpd/version.rb
+- test/fakesmtpd_test.rb
+homepage: https://github.com/modcloth-labs/fakesmtpd
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 55468274672838870
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 55468274672838870
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A fake SMTP server with a minimal HTTP API
+test_files:
+- test/fakesmtpd_test.rb