malm 0.0.4 → 0.0.5

data/Gemfile

@@ -4,6 +4,11 @@ gem "json", "1.5.3"
 gem "clamp", "0.2.1"
 gem "sinatra", "1.2.6"
 gem "thin", "1.2.11"
+gem "mail", "2.3.0"
+gem "therubyracer", "0.9.2"
+gem "execjs", "1.2.0"
+gem "coffee-script", "2.2.0"
+gem "daemons", "1.1.4"
 
 group :development do
   gem "rspec", "~> 2.3.0"

data/Gemfile.lock

@@ -2,15 +2,30 @@ GEM
   remote: http://rubygems.org/
   specs:
     clamp (0.2.1)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.1.1)
     daemons (1.1.4)
     diff-lcs (1.1.2)
     eventmachine (0.12.10)
+    execjs (1.2.0)
+      multi_json (~> 1.0)
     git (1.2.5)
+    i18n (0.6.0)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
     json (1.5.3)
+    libv8 (3.3.10.2)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    multi_json (1.0.3)
+    polyglot (0.3.1)
     rack (1.3.1)
     rake (0.9.2)
     rcov (0.9.9)
@@ -25,11 +40,15 @@ GEM
     sinatra (1.2.6)
       rack (~> 1.1)
       tilt (< 2.0, >= 1.2.2)
+    therubyracer (0.9.2)
+      libv8 (~> 3.3.10)
     thin (1.2.11)
       daemons (>= 1.0.9)
       eventmachine (>= 0.12.6)
       rack (>= 1.0.0)
     tilt (1.3.2)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
 
 PLATFORMS
   ruby
@@ -37,9 +56,14 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0.0)
   clamp (= 0.2.1)
+  coffee-script (= 2.2.0)
+  daemons (= 1.1.4)
+  execjs (= 1.2.0)
   jeweler (~> 1.6.2)
   json (= 1.5.3)
+  mail (= 2.3.0)
   rcov
   rspec (~> 2.3.0)
   sinatra (= 1.2.6)
+  therubyracer (= 0.9.2)
   thin (= 1.2.11)

data/README.md

@@ -0,0 +1,37 @@
+Malm
+====
+Easy SMTP server for local development
+--------------------------------------
+Malm is a super simple SMTP trap that will catch everything sent to it, not forward it on, but instead display on a local web server.
+
+This is useful for when you're doing local development that requires your app to send mail, but you don't want to go through all the hassle of setting up a full featured mail server (and then pointing your mail client at it).
+
+Install
+-------
+    gem install malm
+
+Basic Usage
+-----------
+The following command starts Malm up. Running on it's defaults of listening for SMTP on port 2525, client web app running on port 4567, and starting as a process in the foreground
+
+    malm
+
+If you want to start up on regular SMTP port 25, you'll probably need to run it as sudo
+
+    sudo malm -p 25
+
+For more info try
+
+    sudo malm --help
+
+Viewing Messages
+----------------
+Once it's up and running, it works just like any other SMTP server - your app sends it mail, then happily goes about it's business. To view the mail messages Malm has picked up, point your web browser at [http://localhost:4567](http://localhost:4567)
+
+Who the hell?
+-------------
+I blame [@madlep](https://twitter.com/#!/madlep)
+
+Contributing
+------------
+Fork + pull request. Nice and easy.

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/bin/malm

@@ -1,52 +1,48 @@
 #!/usr/bin/env ruby
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
-require "malm_smtp_server"
-require "malm_web"
-require "clamp"
-require 'message_db'
+require 'malm'
+require 'clamp'
+require 'daemons'
 
 class MalmCommand < Clamp::Command
+  option "--start", :flag, "Start malm as a daemon process. PID will be written to '<PID DIRECTORY>/malm-<SMTP PORT>-<WEB PORT>.pid'"
+  option "--stop", :flag, "Stop malm running as a daemon process. Process id '<PID DIRECTORY>/malm-<SMTP PORT>-<WEB PORT>.pid' will be stopped"
+  option "--restart", :flag, "Restart malm running as a daemon process"
+  option "--piddir", "PID DIRECTORY", "Where to put pids", :default => "/var/run"
   option ["-l", "--log"], "FILE", "file to log mail messages to (optional)"
-
-  option ["-p", "--stmpport"], "STMP PORT", "SMTP port to listen on", :default => 2525 do |port|
+  option ["-p", "--smtpport"], "SMTP PORT", "SMTP port to listen on", :default => 2525 do |port|
     Integer(port)
   end
-  
   option ["-w", "--webport"], "WEB PORT", "Port for client web app to view malmed messages", :default => 4567 do |port|
     Integer(port)
   end
   
-  def execute
-    db = create_db
-    smtp = run_smtp!(db)
-    web = run_web!(db)
-  end
-  
-  private
-  def create_db
-    MessageDb.new
-  end
-  
-  def run_smtp!(db)
-    smtp_server = MalmSMTPServer.new(stmpport)
-    smtp_server.mail_log = log
-    smtp_server.message_db = db
+  def execute    
+    malm_proc = proc{
+      malm = Malm.new(:log => log, :smtpport => smtpport, :webport => webport)
+      malm.run!      
+    }
     
-    begin
-      smtp_server.start
-    rescue Errno::EACCES
-      STDERR.puts("Don't have permission to start SMTP server on port #{stmpport}. Maybe run with sudo?")
-      exit 1
+    if start? || stop? || restart?
+      mode = nil
+      mode ||= start? ? "start" : nil
+      mode ||= stop? ? "stop" : nil
+      mode ||= restart? ? "restart" : nil
+
+      daemon_options = {
+        :ARGV => [mode],
+        :dir_mode => :normal,
+        :dir => piddir,
+        :multiple => true,
+        :monitor => true,
+        :app_name => "malm-#{smtpport}-#{webport}"
+      }
+      
+      Daemons.run_proc("malm-#{smtpport}-#{webport}", daemon_options, &malm_proc)
+    else
+      malm_proc.call
     end
-    smtp_server
-  end
-  
-  def run_web!(db)
-    MalmWeb.set :port, webport
-    MalmWeb.set :message_db, db
-    MalmWeb.run!
   end
 end
-
 MalmCommand.run
 

data/lib/malm/message_db.rb

@@ -0,0 +1,33 @@
+require 'thread'
+
+class Malm
+  class MessageDb
+  
+    def initialize
+      @sempahore = Mutex.new
+    
+      @message_db = []
+    end
+  
+    def create(message)
+      @sempahore.synchronize do
+        message[:id] = @message_db.size
+        @message_db << message
+        @message_db.size
+      end
+    end
+  
+    def find_all
+      @sempahore.synchronize do
+        @message_db.dup
+      end
+    end
+  
+    def find(id)
+      @sempahore.synchronize do
+        @message_db[id].dup
+      end
+    end
+
+  end
+end

data/lib/malm/smtp_server.rb

@@ -0,0 +1,95 @@
+# based on copy + paste from http://snippets.dzone.com/posts/show/5152
+require 'gserver'
+
+class Malm
+  class SMTPServer < GServer
+  
+    attr_accessor :mail_log
+    attr_accessor :message_db
+  
+    class Session
+      attr_accessor :data_mode, :data_mode, :email_body, :mail_from, :rcpt_to, :subject
+      alias :data_mode? :data_mode
+    
+      def initialize
+        @data_mode = false
+        @email_body = ""
+      end
+        
+    end
+  
+    def serve(io)
+      session = Session.new
+      puts "Connected"
+      io.print "220 hello\r\n"
+      loop do
+        data = io.gets
+        puts ">>" + data
+        ok, op = process_line(data, session)
+        puts "<<" + op 
+        io.print op               
+        break unless ok
+        break if io.closed?
+      end
+      begin
+        io.close
+        db_insert(session)
+      rescue => e
+        log "something screwed up..."
+        log e.backtrace
+      end
+    end
+
+    def process_line(line, session)
+      if (session.data_mode?) && (line.chomp =~ /^\.$/)
+        session.data_mode = false
+        return true, "250 OK\r\n"
+      elsif session.data_mode?
+        session.email_body += line
+        return true, ""
+      elsif (line =~ /^(HELO|EHLO)/)
+        return true, "250 and..?\r\n"
+      elsif (line =~ /^QUIT/)
+        return false, "221 bye\r\n"
+      elsif (line =~ /^MAIL FROM\:/)
+        session.mail_from = (/^MAIL FROM\:<(.+)>.*$/).match(line)[1]
+        return true, "250 OK\r\n"
+      elsif (line =~ /^RCPT TO\:/)
+        session.rcpt_to = (/^RCPT TO\:<(.+)>.*$/).match(line)[1]
+        return true, "250 OK\r\n"
+      elsif (line =~ /^DATA/)
+        session.data_mode = true
+        return true, "354 Enter message, ending with \".\" on a line by itself\r\n"
+      else
+        return true, "500 ERROR\r\n"
+      end
+    end
+  
+    def db_insert(session)
+      subject_regex = /^Subject\: (.+)$/
+
+      subject_match = subject_regex.match(session.email_body)
+      subject = subject_match ? subject_match[1] : ""
+      subject.strip!
+    
+      message = {:subject => subject, :from => session.mail_from, :to => session.rcpt_to, :body => session.email_body}
+    
+      @mail_log_fd.puts(message.inspect) if @mail_log_fd
+      @message_db.create(message) if @message_db
+    
+      log("Message received: #{message.inspect}")
+    end
+  
+    protected
+    def starting
+      @mail_log_fd = File.open(@mail_log, "a") if @mail_log
+      super
+    end
+  
+    def stopping
+      @mail_log_fd.close if @mail_log_fd
+      super
+    end
+  
+  end
+end

data/lib/malm/web.rb

@@ -0,0 +1,63 @@
+require 'thin'
+require 'sinatra/base'
+require 'json'
+require 'v8'
+require 'execjs'
+require 'coffee_script'
+require 'mail'
+
+class Malm
+  class Web < Sinatra::Base
+  
+    set :public, File.join(File.dirname(__FILE__), "..", "..", "web", "static")
+    set :views, File.join(File.dirname(__FILE__), "..", "..", "web", "views")
+  
+    get "/messages.json" do
+      content_type :json
+      settings.message_db.find_all.map{|m|
+        m = m.dup
+        m.delete(:body)
+        m[:body_urls] = {:html => url("/messages/#{m[:id]}/body.html"), :text => url("/messages/#{m[:id]}/body.text")}
+        m
+      }.to_json
+    end
+  
+    get "/messages/:id.json" do
+      content_type :json
+      find_message(params[:id]).to_json
+    end
+  
+    get "/messages/:id/body.:type" do
+      render_message(params[:id], params[:type])
+    end
+    
+    get "/coffee/:script.coffee" do
+      content_type "text/javascript"
+      coffee params[:script].to_sym
+    end
+  
+    private
+    def find_message(id)
+      id = Integer(id)
+      settings.message_db.find(id)
+    end
+  
+    def render_message(id, type)
+      content_type type
+    
+      supported = ["text", "html"]
+      unless supported.include?(type.to_s)
+        halt 415, "don't know how to display message #{id} as #{type}. Try one of #{supported.join(",")}"
+        return
+      end
+    
+      msg_obj = find_message(id)
+      if msg_obj
+        Mail::Message.new(msg_obj[:body]).send("#{type}_part".to_sym).body.to_s
+      else
+        status 404
+        "don't know about message #{id}"
+      end
+    end
+  end
+end

data/lib/malm.rb

@@ -0,0 +1,42 @@
+require 'malm/message_db'
+require 'malm/smtp_server'
+require 'malm/web'
+
+class Malm
+  attr_accessor :log, :smtpport, :webport
+  
+  def initialize(options={})
+    options.each{|k,v| send("#{k}=", v)}
+  end
+  
+  def run!
+    create_db
+    run_smtp!
+    run_web!
+  end
+  
+  private
+  def create_db
+    @db = Malm::MessageDb.new
+  end
+
+  def run_smtp!
+    smtp_server = Malm::SMTPServer.new(@smtpport)
+    smtp_server.mail_log = @log
+    smtp_server.message_db = @db
+
+    begin
+      smtp_server.start
+    rescue Errno::EACCES
+      STDERR.puts("Don't have permission to start SMTP server on port #{smtpport}. Maybe run with sudo?")
+      exit 1
+    end
+    smtp_server
+  end
+
+  def run_web!
+    Malm::Web.set :port, @webport
+    Malm::Web.set :message_db, @db
+    Malm::Web.run!
+  end
+end

data/malm.gemspec

@@ -5,17 +5,18 @@
 
 Gem::Specification.new do |s|
   s.name = %q{malm}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["madlep"]
-  s.date = %q{2011-07-14}
+  s.date = %q{2011-07-23}
   s.default_executable = %q{malm}
   s.description = %q{SMTP server with web interface for easy local development. Sets up a little mail server that you can send messages to, and provides a web front end to let you see what your app did.}
   s.email = %q{julian.doherty.ml@gmail.com}
   s.executables = ["malm"]
   s.extra_rdoc_files = [
-    "LICENSE.txt"
+    "LICENSE.txt",
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -23,21 +24,31 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
+    "README.md",
     "Rakefile",
     "VERSION",
     "bin/malm",
-    "lib/malm_smtp_server.rb",
-    "lib/malm_web.rb",
-    "lib/message_db.rb",
+    "lib/malm.rb",
+    "lib/malm/message_db.rb",
+    "lib/malm/smtp_server.rb",
+    "lib/malm/web.rb",
     "malm.gemspec",
     "spec/bin/malm_test_message",
     "spec/help_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/spec_helper.rb",
+    "web/static/css/style.css",
+    "web/static/favicon.ico",
+    "web/static/index.html",
+    "web/static/js/backbone-min.js",
+    "web/static/js/backbone.js",
+    "web/static/js/jquery-1.6.2.js",
+    "web/static/js/jquery-1.6.2.min.js",
+    "web/views/hello_world.coffee"
   ]
   s.homepage = %q{http://github.com/madlep/malm}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.4.2}
+  s.rubygems_version = %q{1.6.2}
   s.summary = %q{Easy SMTP server for local development}
 
   if s.respond_to? :specification_version then
@@ -48,6 +59,11 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<clamp>, ["= 0.2.1"])
       s.add_runtime_dependency(%q<sinatra>, ["= 1.2.6"])
       s.add_runtime_dependency(%q<thin>, ["= 1.2.11"])
+      s.add_runtime_dependency(%q<mail>, ["= 2.3.0"])
+      s.add_runtime_dependency(%q<therubyracer>, ["= 0.9.2"])
+      s.add_runtime_dependency(%q<execjs>, ["= 1.2.0"])
+      s.add_runtime_dependency(%q<coffee-script>, ["= 2.2.0"])
+      s.add_runtime_dependency(%q<daemons>, ["= 1.1.4"])
       s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
@@ -57,6 +73,11 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<clamp>, ["= 0.2.1"])
       s.add_dependency(%q<sinatra>, ["= 1.2.6"])
       s.add_dependency(%q<thin>, ["= 1.2.11"])
+      s.add_dependency(%q<mail>, ["= 2.3.0"])
+      s.add_dependency(%q<therubyracer>, ["= 0.9.2"])
+      s.add_dependency(%q<execjs>, ["= 1.2.0"])
+      s.add_dependency(%q<coffee-script>, ["= 2.2.0"])
+      s.add_dependency(%q<daemons>, ["= 1.1.4"])
       s.add_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
@@ -67,6 +88,11 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<clamp>, ["= 0.2.1"])
     s.add_dependency(%q<sinatra>, ["= 1.2.6"])
     s.add_dependency(%q<thin>, ["= 1.2.11"])
+    s.add_dependency(%q<mail>, ["= 2.3.0"])
+    s.add_dependency(%q<therubyracer>, ["= 0.9.2"])
+    s.add_dependency(%q<execjs>, ["= 1.2.0"])
+    s.add_dependency(%q<coffee-script>, ["= 2.2.0"])
+    s.add_dependency(%q<daemons>, ["= 1.1.4"])
     s.add_dependency(%q<rspec>, ["~> 2.3.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.2"])