fakesmtpd 0.1.0 → 0.2.0

data/.travis.yml

@@ -3,3 +3,7 @@ language: ruby
 rvm:
 - 1.9.3
 - 2.0.0
+notifications:
+  email:
+    recipients:
+    - github+fakesmtpd@modcloth.com

data/README.md

@@ -1,12 +1,15 @@
 `fakesmtpd`
 ===========
 
+[![Build Status](https://travis-ci.org/modcloth-labs/fakesmtpd.png?branch=master)](https://travis-ci.org/modcloth-labs/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.:
+## Installation
+`fakesmtpd` may be installed either as a Ruby gem or by directly
+downloading the server file which may then be used as an executable,
+e.g.:
 
 ``` bash
 gem install fakesmtpd
@@ -19,3 +22,69 @@ curl -o fakesmtpd https://raw.github.com/modcloth-labs/fakesmtpd/master/lib/fake
 chmod +x fakesmtpd
 ```
 
+## Usage
+`fakesmtpd` is usable either as an executable or from within a Ruby
+process.  The following examples are roughly equivalent.
+
+``` bash
+# example command line invocation:
+fakesmtpd 9025 ./fakesmtpd-messages -p ./fakesmtpd.pid -l ./fakesmtpd.log
+```
+
+``` ruby
+# example in-process Ruby invocation:
+require 'fakesmtpd'
+FakeSMTPd::Server.main(
+  %w(9025 ./fakesmtpd-messages -p ./fakesmtpd.pid -l ./fakesmtpd.log)
+)
+```
+
+The `FakeSMTPd::Runner` class is intended to provide a
+formalized way to spawn and manage a separate Ruby process running
+`FakeSMTPd::Server`.  This example is also equivalent to those provided
+above:
+
+``` ruby
+require 'fakesmtpd'
+
+fakesmtpd = FakeSMTPd::Runner.new(
+  dir: File.expand_path('../fakesmtpd-messages', __FILE__),
+  port: 9025,
+  logfile: File.expand_path('../fakesmtpd.log', __FILE__),
+  pidfile: File.expand_path('../fakesmtpd.pid', __FILE__)
+)
+# This spawns another Ruby process via `RbConfig.ruby`
+fakesmtpd.start
+
+# ... do other stuff ...
+
+# This will kill the previously-spawned process
+fakesmtpd.stop
+```
+
+Once `FakeSMTPd::Server.main` has been invoked via one of the above
+methods, there will be both an SMTP and HTTP server running in a single
+Ruby process.  The HTTP port is one more than the SMTP port specified.
+
+### HTTP API Usage
+
+The HTTP API provides an index of all sent messages, the ability to
+fetch sent message content, and the ability to clear sent messages
+via the following:
+
+#### `GET /`
+
+Contains almost nothing but a link to `/messages`.
+
+#### `GET /messages`
+
+Contains an index of all sent messages, their IDs, their absolute
+filenames, and links to the content for each.
+
+#### `GET /messages/[[:digit:]]`
+
+Returns the content of the message with the given ID.
+
+#### `DELETE /messages`
+
+Clears all files out of the sent messages directory.

data/Rakefile

@@ -1,7 +1,7 @@
 require 'bundler/gem_tasks'
 
 desc 'Run minitest tests in ./test'
-task test: :load_minitest do
+task test: [:load_minitest, :clean_artifacts] do
   Dir.glob("#{File.expand_path('../test', __FILE__)}/*_test.rb").each do |f|
     require f
   end
@@ -14,4 +14,38 @@ task :load_minitest do
   require 'minitest/spec'
 end
 
+task :clean_artifacts do
+  rm_rf(File.expand_path('../.artifacts', __FILE__))
+end
+
+desc 'Send a test email to a local SMTP server (on $PORT)'
+task :send_email do
+  smtp_port = Integer(ENV['PORT'])
+  require 'net/smtp'
+  msg = <<-EOMSG.gsub(/^ {4}/, '')
+    From: Fake SMTPd <fakesmtpd@example.org>
+    To: Recipient Person <recipient@example.org>
+    Subject: Test Sandwich
+    Date: Sun, 11 Aug 2013 21:54:13 +0500
+    Message-Id: <this.sandwich.is.a.test.#{rand(999..1999)}@example.org>
+
+    Why have one sandwich when you can have #{rand(2..9)}?
+                          ____
+              .----------'    '-.
+             /  .      '     .   \\
+            /        '    .      /|
+           /      .             \ /
+          /  ' .       .     .  || |
+         /.___________    '    / //
+         |._          '------'| /|
+         '.............______.-' /
+     jgs |-.                  | /
+         `"""""""""""""-.....-'
+
+  EOMSG
+  Net::SMTP.start('localhost', smtp_port) do |smtp|
+    smtp.send_message(msg, 'fakesmtpd@example.org', 'recipient@example.org')
+  end
+end
+
 task default: :test

data/fakesmtpd.gemspec

@@ -21,5 +21,4 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'pry'
 end

data/lib/fakesmtpd/runner.rb

@@ -5,7 +5,7 @@ require 'logger'
 
 class FakeSMTPd::Runner
   attr_reader :port, :dir, :pidfile, :http_port
-  attr_reader :startup_sleep, :server_pid, :options
+  attr_reader :startup_sleep, :server_pid, :options, :logfile
 
   def initialize(options = {})
     @dir = options.fetch(:dir)
@@ -13,6 +13,7 @@ class FakeSMTPd::Runner
     @http_port = Integer(options[:http_port] || port + 1)
     @pidfile = options[:pidfile] || 'fakesmtpd.pid'
     @startup_sleep = options[:startup_sleep] || 0.5
+    @logfile = options[:logfile] || $stderr
   end
 
   def description
@@ -20,13 +21,15 @@ class FakeSMTPd::Runner
   end
 
   def command
-    [
-      RbConfig.ruby,
-      File.expand_path('../server.rb', __FILE__),
-      port.to_s,
-      dir,
-      pidfile,
-    ].join(' ')
+    (
+      [
+        RbConfig.ruby,
+        File.expand_path('../server.rb', __FILE__),
+        port.to_s,
+        dir,
+        '--pidfile', pidfile,
+      ] + (logfile == $stderr ? [] : ['--logfile', logfile])
+    ).join(' ')
   end
 
   def start
@@ -54,9 +57,9 @@ class FakeSMTPd::Runner
   end
 
   def log
-    @log ||= Logger.new($stderr).tap do |l|
+    @log ||= Logger.new(@logfile).tap do |l|
       l.formatter = proc do |severity, datetime, _, msg|
-        "[fakesmtpd] #{severity} #{datetime} - #{msg}\n"
+        "[fakesmtpd-runner] #{severity} #{datetime} - #{msg}\n"
       end
     end
   end

data/lib/fakesmtpd/server.rb

@@ -25,13 +25,13 @@
 # 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 'fileutils'
 require 'json'
 require 'logger'
+require 'optparse'
 require 'socket'
 require 'thread'
 
-$fakesmtpd_semaphore = Mutex.new
-
 module FakeSMTPd
   class HTTPServer
     attr_reader :server, :port, :smtpd, :log
@@ -39,7 +39,7 @@ module FakeSMTPd
     def initialize(options = {})
       @port = options.fetch(:port)
       @smtpd = options.fetch(:smtpd)
-      @log = Logger.new($stderr).tap do |l|
+      @log = Logger.new(options[:logfile]).tap do |l|
         l.formatter = proc do |severity, datetime, _, msg|
           "[fakesmtpd-http] #{severity} #{datetime} - #{msg}\n"
         end
@@ -53,76 +53,203 @@ module FakeSMTPd
         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.'
+          begin
+            request_line = client.gets
+            path = request_line.split[1]
+            handle_client(request_line, path, client)
+          rescue => e
+            handle_500(path, client, e)
           end
-          client.close
         end
       end
     end
 
     def kill!
-      @server && @server.kill
+      if @server
+        log.info "FakeSMTPd HTTP server stopping"
+        @server.kill
+      end
+    end
+
+    private
+
+    def handle_client(request_line, path, client)
+      log.info request_line.chomp
+      case request_line
+      when /^GET \/ /
+        handle_get_root(path, client)
+      when /^GET \/messages /
+        handle_get_messages(path, client)
+      when /^GET \/messages\/([[:digit:]]+) /
+        handle_get_message(path, client, $1)
+      when /^DELETE \/messages /
+        handle_clear_messages(path, client)
+      else
+        handle_404(path, client)
+      end
+      client.close
+    end
+
+    def handle_get_root(path, client)
+      client.puts 'HTTP/1.1 200 OK'
+      client.puts 'Content-type: application/json;charset=utf-8'
+      client.puts
+      client.puts JSON.pretty_generate(
+        _links: {
+          self: {href: path},
+          messages: {href: '/messages'},
+        }
+      )
+    end
+
+    def handle_get_messages(path, client)
+      client.puts 'HTTP/1.1 200 OK'
+      client.puts 'Content-type: application/json;charset=utf-8'
+      client.puts
+      client.puts JSON.pretty_generate(
+        _links: {
+          self: {href: path}
+        },
+        _embedded: {
+          messages: smtpd.messages.to_hash.map do |message_id, filename|
+            {
+              _links: {
+                self: {href: "/messages/#{message_id}"}
+              },
+              message_id: message_id,
+              filename: filename
+            }
+          end
+        }
+      )
+    end
+
+    def handle_get_message(path, client, message_id)
+      message_file = smtpd.messages[message_id]
+      if message_file
+        client.puts 'HTTP/1.1 200 OK'
+        client.puts 'Content-type: application/json;charset=utf-8'
+        client.puts
+        message = JSON.parse(File.read(message_file))
+        client.puts JSON.pretty_generate(
+          message.merge(
+            _links: {
+              self: {href: path}
+            },
+            filename: message_file
+          )
+        )
+      else
+        client.puts 'HTTP/1.1 404 Not Found'
+        client.puts 'Content-type: application/json;charset=utf-8'
+        client.puts
+        client.puts JSON.pretty_generate(
+          _links: {
+            self: {href: path}
+          },
+          error: "Message #{message_id.inspect} not found"
+        )
+      end
+    end
+
+    def handle_clear_messages(path, client)
+      smtpd.messages.clear
+      client.puts 'HTTP/1.1 204 No Content'
+      client.puts
+    end
+
+    def handle_404(path, client)
+      client.puts 'HTTP/1.1 404 Not Found'
+      client.puts 'Content-type: application/json;charset=utf-8'
+      client.puts
+      client.puts JSON.pretty_generate(
+        _links: {
+          self: {href: path}
+        },
+        error: 'Nothing is here'
+      )
+    end
+
+    def handle_500(path, client, e)
+      client.puts 'HTTP/1.1 500 Internal Server Error'
+      client.puts 'Content-type: application/json;charset=utf-8'
+      client.puts
+      client.puts JSON.pretty_generate(
+        _links: {
+          self: {href: path}
+        },
+        error: "#{e.class.name} #{e.message}",
+        backtrace: e.backtrace
+      )
     end
   end
 
   class Server
-    VERSION = '0.1.0'
-    USAGE = "Usage: #{File.basename($0)} <port> <message-dir> [pidfile]"
+    VERSION = '0.2.0'
+    USAGE = <<-EOU.gsub(/^ {6}/, '')
+      Usage: #{File.basename($0)} <smtp-port> <message-dir> [options]
 
-    attr_reader :port, :message_dir, :log, :pidfile, :message_files_written
+      The `<smtp-port>` argument will be incremented by 1 for the HTTP API port.
+      The `<message-dir>` is where each SMTP transaction will be written as a
+      JSON file containing the "smtp client id" (timestamp from beginning of SMTP
+      transaction), the sender, recipients, and combined headers and body as
+      an array of strings.
+
+    EOU
+
+    attr_reader :port, :message_dir, :log, :logfile, :pidfile
+    attr_reader :messages
 
     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
+      def main(argv = [])
+        options = {
+          pidfile: nil,
+          logfile: $stderr,
+        }
+
+        OptionParser.new do |opts|
+          opts.banner = USAGE
+          opts.on('--version', 'Show version and exit') do |*|
+            puts "fakesmtpd #{FakeSMTPd::Server::VERSION}"
+            exit 0
+          end
+          opts.on('-p PIDFILE', '--pidfile PIDFILE',
+                  'Optional file where process PID will be written') do |pidfile|
+            options[:pidfile] = pidfile
+          end
+          opts.on('-l LOGFILE', '--logfile LOGFILE',
+                  'Optional file where all log messages will be written ' <<
+                  '(default $stderr)') do |logfile|
+            options[:logfile] = logfile
+          end
+        end.parse!(argv)
+
+        unless argv.length == 2
           abort USAGE
         end
+
         @smtpd = FakeSMTPd::Server.new(
           port: Integer(argv.fetch(0)),
           dir: argv.fetch(1),
-          pidfile: argv[2]
+          pidfile: options[:pidfile],
+          logfile: options[:logfile],
         )
         @httpd = FakeSMTPd::HTTPServer.new(
           port: Integer(argv.fetch(0)) + 1,
           smtpd: @smtpd,
+          logfile: options[:logfile],
         )
 
-        $stderr.puts '--- Starting up ---'
         @httpd.start
         @smtpd.start
         loop { sleep 1 }
       rescue Exception => e
-        $stderr.puts '--- Shutting down ---'
-        @httpd && @httpd.kill!
-        @smtpd && @smtpd.kill!
+        if @httpd
+          @httpd.kill!
+        end
+        if @smtpd
+          @smtpd.kill!
+        end
         unless e.is_a?(Interrupt)
           raise e
         end
@@ -133,12 +260,12 @@ module FakeSMTPd
       @port = options.fetch(:port)
       @message_dir = options.fetch(:dir)
       @pidfile = options[:pidfile] || 'fakesmtpd.pid'
-      @log = Logger.new($stderr).tap do |l|
+      @log = Logger.new(options[:logfile]).tap do |l|
         l.formatter = proc do |severity, datetime, _, msg|
           "[fakesmtpd-smtp] #{severity} #{datetime} - #{msg}\n"
         end
       end
-      @message_files_written = []
+      @messages = MessageStore.new(@message_dir)
     end
 
     def start
@@ -160,7 +287,10 @@ module FakeSMTPd
     end
 
     def kill!
-      @server && @server.kill
+      if @server
+        log.info "FakeSMTPd SMTP server stopping"
+        @server.kill
+      end
     end
 
     def serve(client)
@@ -226,20 +356,56 @@ module FakeSMTPd
     end
 
     def record(client, from, recipients, body)
-      outfile = File.join(message_dir, "fakesmtpd-client-#{client.client_id}.json")
+      messages.store(
+        client.client_id, from, recipients, body
+      )
+    end
+  end
+
+  class MessageStore
+    attr_reader :message_dir
+
+    def initialize(message_dir)
+      @message_dir = message_dir
+    end
+
+    def store(message_id, from, recipients, body)
+      outfile = File.join(message_dir, "fakesmtpd-client-#{message_id}.json")
       File.open(outfile, 'w') do |f|
         f.write JSON.pretty_generate(
-          client_id: client.client_id,
+          message_id: message_id,
           from: from,
           recipients: recipients,
           body: body,
         )
       end
-      $fakesmtpd_semaphore.synchronize do
-        message_files_written << outfile
-      end
       outfile
     end
+
+    def to_hash
+      message_files.each_with_object({}) do |filename, h|
+        message_id = File.basename(filename, '.json').gsub(/[^0-9]+/, '')
+        h[message_id] = File.expand_path(filename)
+      end
+    end
+
+    def [](message_id)
+      message_file = "#{message_dir}/fakesmtpd-client-#{message_id}.json"
+      if File.exists?(message_file)
+        return message_file
+      end
+      nil
+    end
+
+    def clear
+      FileUtils.rm_f(message_files)
+    end
+
+    private
+
+    def message_files
+      Dir.glob("#{message_dir}/fakesmtpd-client-*.json")
+    end
   end
 end
 

data/lib/fakesmtpd/version.rb

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

data/test/fakesmtpd_test.rb

@@ -8,11 +8,17 @@ require 'fakesmtpd'
 describe 'fakesmtpd server' do
   RUNNER = FakeSMTPd::Runner.new(
     dir: File.expand_path('../../.artifacts', __FILE__),
-    port: rand(9100..9199)
+    port: rand(9100..9199),
+    logfile: File.expand_path('../../.artifacts/fakesmtpd.log', __FILE__),
+    pidfile: File.expand_path('../../.artifacts/fakesmtpd.pid', __FILE__),
   )
   RUNNER.start
 
-  at_exit { RUNNER.stop }
+  at_exit do
+    RUNNER.stop
+  end
+
+  after(:each) { clear_messages }
 
   def randint
     @randint ||= rand(999..1999)
@@ -36,21 +42,49 @@ describe 'fakesmtpd server' do
 
   def send_message
     Net::SMTP.start('localhost', RUNNER.port) do |smtp|
-      smtp.send_message msg, 'fakesmtpd@example.org', 'fruitcake@example.org'
+      smtp.send_message(msg, 'fakesmtpd@example.org', 'fruitcake@example.org')
     end
   end
 
+  def get_messages
+    uri = URI("http://localhost:#{RUNNER.http_port}/messages")
+    JSON.parse(Net::HTTP.get_response(uri).body)
+  end
+
+  def clear_messages
+    Net::HTTP.start('localhost', RUNNER.http_port) do |http|
+      http.request(Net::HTTP::Delete.new('/messages'))
+    end
+  end
+
+  def get_message(message_id)
+    uri = URI("http://localhost:#{RUNNER.http_port}/messages/#{message_id}")
+    JSON.parse(Net::HTTP.get_response(uri).body)
+  end
+
   it 'accepts messages via SMTP' do
     send_message
   end
 
-  it 'reports messages sent via HTTP' do
+  it 'supports clearing sent messages via HTTP' do
+    clear_messages
+  end
+
+  it 'supports getting messages sent via HTTP' do
     send_message
+    response = get_messages
 
-    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_file = response.fetch('_embedded').fetch('messages').last.fetch('filename')
     message_body = JSON.parse(File.read(message_file)).fetch('body')
     message_body.must_include("Subject: #{subject_header}")
   end
+
+  it 'supports getting individual messages sent via HTTP' do
+    send_message
+    response = get_messages
+
+    message_id = response.fetch('_embedded').fetch('messages').last.fetch('message_id')
+    message_body = get_message(message_id).fetch('body')
+    message_body.must_include("Subject: #{subject_header}")
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fakesmtpd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-11 00:00:00.000000000 Z
+date: 2013-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,22 +43,6 @@ dependencies:
     - - ! '>='
       - !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
@@ -96,7 +80,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 55468274672838870
+      hash: 2803386961380935915
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -105,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 55468274672838870
+      hash: 2803386961380935915
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23