mailcatcher 0.8.0 → 0.10.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7bd063a1a2ccd3cd8e3cf6a8ee495acafdca0d90ab2c3a16e4b62f6180bb9aa
-  data.tar.gz: 62cec0bcce04b0f74e200c9f47d8ab157ab889060377137f840f2717923c3f3f
+  metadata.gz: 1aa3aa753b23a9b3bd275630bdcc3f327c4b20ce473d588a27dce358227402f1
+  data.tar.gz: 9501f6236cca02daa9856dbf1d9465710c2680cb2854e7c2c65034d04cc76b1a
 SHA512:
-  metadata.gz: f532803f11699a109ce7be2ec7c35251dfc15e448cb6d90c65fc5a1db7757a5924883dff6259fec7dbf3e3139ad41815a3a29e4c545575e252c40c9c29b50ba3
-  data.tar.gz: 9cfadf47007c3fe0362ce6c7111e688539caaff2dd32da84ae5af78840d2c67860aceb54f46cf7c511d4700f21a056e8218a0cc90f174ba4a8cacb9130e775f0
+  metadata.gz: f64c5dba1a1283516cb528c786dda5955ea0839aa9ee213dfc7953d96295ce523042a89052f3f524c2b04a096a85fc50032c156bf25d10f215e230efbf4c68a4
+  data.tar.gz: f2173054df228613688e6f478f3b81b50b6bab836318a6beb27dfdc07974b8a6aa406e56087b369d8a43c4adeac942a34fcf5c82f62905f50413f806585ed1e0

data/README.md

@@ -32,17 +32,30 @@ Use `mailcatcher --help` to see the command line options.
 
 ```
 Usage: mailcatcher [options]
+
+MailCatcher v0.8.0
+
         --ip IP                      Set the ip address of both servers
         --smtp-ip IP                 Set the ip address of the smtp server
         --smtp-port PORT             Set the port of the smtp server
         --http-ip IP                 Set the ip address of the http server
         --http-port PORT             Set the port address of the http server
+        --messages-limit COUNT       Only keep up to COUNT most recent messages
         --http-path PATH             Add a prefix to all HTTP paths
         --no-quit                    Don't allow quitting the process
     -f, --foreground                 Run in the foreground
     -b, --browse                     Open web browser
     -v, --verbose                    Be more verbose
     -h, --help                       Display this help information
+        --version                    Display the current version
+```
+
+### Upgrading
+
+Upgrading works the same as installation:
+
+```
+gem install mailcatcher
 ```
 
 ### Ruby
@@ -64,7 +77,7 @@ gem install thin -v 1.5.1 -- --with-cflags="-Wno-error=implicit-function-declara
 
 ### Bundler
 
-Please don't put mailcatcher into your Gemfile. It will conflict with your applications gems at some point.
+Please don't put mailcatcher into your Gemfile. It will conflict with your application's gems at some point.
 
 Instead, pop a note in your README stating you use mailcatcher, and to run `gem install mailcatcher` then `mailcatcher` to get started.
 
@@ -112,9 +125,32 @@ if DEBUG:
     EMAIL_USE_TLS = False
 ```
 
+### Docker
+
+There is a Docker image available [on Docker Hub](https://hub.docker.com/r/sj26/mailcatcher):
+
+```
+$ docker run -p 1080 -p 1025 sj26/mailcatcher
+Unable to find image 'sj26/mailcatcher:latest' locally
+latest: Pulling from sj26/mailcatcher
+8c6d1654570f: Already exists
+f5649d186f41: Already exists
+b850834ea1df: Already exists
+d6ac1a07fd46: Pull complete
+b609298bc3c9: Pull complete
+ab05825ece51: Pull complete
+Digest: sha256:b17c45de08a0a82b012d90d4bd048620952c475f5655c61eef373318de6c0855
+Status: Downloaded newer image for sj26/mailcatcher:latest
+Starting MailCatcher v0.9.0
+==> smtp://0.0.0.0:1025
+==> http://0.0.0.0:1080
+```
+
+How those ports appear and can be accessed may vary based on your Docker configuration. For example, your may need to use `http://127.0.0.1:1080` etc instead of the listed address. But MailCatcher will run and listen to those ports on all IPs it can from within the Docker container.
+
 ### API
 
-A fairly RESTful URL schema means you can download a list of messages in JSON from `/messages`, each message's metadata with `/messages/:id.json`, and then the pertinent parts with `/messages/:id.html` and `/messages/:id.plain` for the default HTML and plain text version, `/messages/:id/:cid` for individual attachments by CID, or the whole message with `/messages/:id.source`.
+A fairly RESTful URL schema means you can download a list of messages in JSON from `/messages`, each message's metadata with `/messages/:id.json`, and then the pertinent parts with `/messages/:id.html` and `/messages/:id.plain` for the default HTML and plain text version, `/messages/:id/parts/:cid` for individual attachments by CID, or the whole message with `/messages/:id.source`.
 
 ## Caveats
 

data/lib/mail_catcher/mail.rb

@@ -36,7 +36,7 @@ module MailCatcher::Mail extend self
             FOREIGN KEY (message_id) REFERENCES message (id) ON DELETE CASCADE
           )
         SQL
-        db.foreign_keys = true
+        db.execute("PRAGMA foreign_keys = ON")
       end
     end
   end

data/lib/mail_catcher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MailCatcher
-  VERSION = "0.8.0"
+  VERSION = "0.10.0.alpha1"
 end

data/lib/mail_catcher/web/application.rb

@@ -4,14 +4,31 @@ require "pathname"
 require "net/http"
 require "uri"
 
+require "faye/websocket"
 require "sinatra"
-require "skinny"
 
 require "mail_catcher/bus"
 require "mail_catcher/mail"
 
+Faye::WebSocket.load_adapter("thin")
+
+# Faye's adapter isn't smart enough to close websockets when thin is stopped,
+# so we teach it to do so.
+class Thin::Backends::Base
+  alias :thin_stop :stop
+
+  def stop
+    thin_stop
+    @connections.each_value do |connection|
+      if connection.socket_stream
+        connection.socket_stream.close_connection_after_writing
+      end
+    end
+  end
+end
+
 class Sinatra::Request
-  include Skinny::Helpers
+  include Faye::WebSocket::Adapter
 end
 
 module MailCatcher
@@ -62,20 +79,24 @@ module MailCatcher
 
       get "/messages" do
         if request.websocket?
-          request.websocket!(
-            :on_start => proc do |websocket|
-              bus_subscription = MailCatcher::Bus.subscribe do |message|
-                begin
-                  websocket.send_message(JSON.generate(message))
-                rescue => exception
-                  MailCatcher.log_exception("Error sending message through websocket", message, exception)
-                end
+          bus_subscription = nil
+
+          ws = Faye::WebSocket.new(request.env)
+          ws.on(:open) do |_|
+            bus_subscription = MailCatcher::Bus.subscribe do |message|
+              begin
+                ws.send(JSON.generate(message))
+              rescue => exception
+                MailCatcher.log_exception("Error sending message through websocket", message, exception)
               end
+            end
+          end
 
-              websocket.on_close do |*|
-                MailCatcher::Bus.unsubscribe bus_subscription
-              end
-            end)
+          ws.on(:close) do |_|
+            MailCatcher::Bus.unsubscribe(bus_subscription) if bus_subscription
+          end
+
+          ws.rack_response
         else
           content_type :json
           JSON.generate(Mail.messages)

data/lib/mail_catcher.rb

@@ -38,10 +38,10 @@ module MailCatcher extend self
   end
 
   def windows?
-    RbConfig::CONFIG["host_os"] =~ /mswin|mingw/
+    RbConfig::CONFIG["host_os"].match?(/mswin|mingw/)
   end
 
-  def browseable?
+  def browsable?
     windows? or which? "open"
   end
 
@@ -134,7 +134,7 @@ module MailCatcher extend self
           end
         end
 
-        if browseable?
+        if browsable?
           parser.on("-b", "--browse", "Open web browser") do
             options[:browse] = true
           end
@@ -185,13 +185,19 @@ module MailCatcher extend self
       end
 
       # Let Thin set itself up inside our EventMachine loop
-      # (Skinny/WebSockets just works on the inside)
+      # Faye connections are hijacked but continue to be supervised by thin
       rescue_port options[:http_port] do
-        Thin::Server.start(options[:http_ip], options[:http_port], Web)
+        Thin::Server.start(options[:http_ip], options[:http_port], Web, signals: false)
         puts "==> #{http_url}"
       end
 
-      # Open the web browser before detatching console
+      # Make sure we quit nicely when asked
+      # We need to handle outside the trap context, hence the timer
+      trap("INT") { EM.add_timer(0) { quit! } }
+      trap("TERM") { EM.add_timer(0) { quit! } }
+      trap("QUIT") { EM.add_timer(0) { quit! } } unless windows?
+
+      # Open the web browser before detaching console
       if options[:browse]
         EventMachine.next_tick do
           browse http_url