Merge branch 'master' into apps

Conflicts:
	lib/hector.rb
	lib/hector/concerns/authentication.rb
	lib/hector/session.rb
	test/unit/session_test.rb

lib/hector.rb

@@ -6,6 +6,7 @@
 require "hector/errors"
 
 require "hector/concerns/authentication"
+require "hector/concerns/keep_alive"
 require "hector/concerns/presence"
 
 require "hector/commands/join"
@@ -14,6 +15,7 @@
 require "hector/commands/notice"
 require "hector/commands/part"
 require "hector/commands/ping"
+require "hector/commands/pong"
 require "hector/commands/privmsg"
 require "hector/commands/quit"
 require "hector/commands/topic"
@@ -22,6 +24,7 @@
 
 require "hector/channel"
 require "hector/connection"
+require "hector/heartbeat"
 require "hector/identity"
 require "hector/logging"
 require "hector/request"

lib/hector/commands/pong.rb

@@ -0,0 +1,9 @@
+module Hector
+  module Commands
+    module Pong
+      def on_pong
+        @received_pong = true
+      end
+    end
+  end
+end

lib/hector/commands/quit.rb

@@ -3,7 +3,7 @@ module Commands
     module Quit
       def on_quit
         @quit_message = "Quit: #{request.text}"
-        connection.close_connection
+        connection.close_connection(true)
       end
     end
   end

lib/hector/concerns/authentication.rb

@@ -32,7 +32,6 @@ def set_identity
         def set_session
           if @identity && @nickname
             @session = UserSession.create(@nickname, self, @identity, @realname)
-            @session.commence_presence
           end
         end
     end

lib/hector/concerns/keep_alive.rb

@@ -0,0 +1,24 @@
+module Hector
+  module Concerns
+    module KeepAlive
+      def initialize_keep_alive
+        @received_pong = true
+        @heartbeat = Hector::Heartbeat.new { on_heartbeat }
+      end
+
+      def on_heartbeat
+        if @received_pong
+          @received_pong = false
+          respond_with(:ping, Hector.server_name)
+        else
+          @quit_message = "Ping timeout"
+          connection.close_connection(true)
+        end
+      end
+
+      def destroy_keep_alive
+        @heartbeat.stop
+      end
+    end
+  end
+end

lib/hector/concerns/presence.rb

@@ -11,13 +11,13 @@ def channels
         Channel.find_all_for_session(self)
       end
 
-      def commence_presence
+      def initialize_presence
         @created_at = Time.now
         @updated_at = Time.now
         deliver_welcome_message
       end
 
-      def conclude_presence
+      def destroy_presence
         deliver_quit_message
         leave_all_channels
       end

lib/hector/connection.rb

@@ -18,7 +18,7 @@ def receive_line(line)
         if respond_to?(request.event_name)
           send(request.event_name)
         else
-          close_connection
+          close_connection(true)
         end
       end
 

lib/hector/heartbeat.rb

@@ -0,0 +1,25 @@
+module Hector
+  class Heartbeat
+    def self.create_timer(interval, &block)
+      EventMachine::PeriodicTimer.new(interval, &block)
+    end
+
+    def initialize(interval = 60, &block)
+      @interval, @block = interval, block
+      start
+    end
+
+    def start
+      @timer ||= self.class.create_timer(@interval) { pulse }
+    end
+
+    def pulse
+      @block.call
+    end
+
+    def stop
+      @timer.cancel
+      @timer = nil
+    end
+  end
+end

lib/hector/session.rb

@@ -1,13 +1,12 @@
 module Hector
   class Session
-    include Concerns::Presence
-
     include Commands::Join
     include Commands::Names
     include Commands::Nick
     include Commands::Notice
     include Commands::Part
     include Commands::Ping
+    include Commands::Pong
     include Commands::Privmsg
     include Commands::Quit
     include Commands::Topic
@@ -85,7 +84,8 @@ def deliver(message_type, session, options)
     end
 
     def destroy
-      conclude_presence
+      destroy_presence
+      destroy_keep_alive
       self.class.delete(nickname)
     end
 

lib/hector/user_session.rb

@@ -1,5 +1,8 @@
 module Hector
   class UserSession < Session
+    include Concerns::KeepAlive
+    include Concerns::Presence
+
     attr_reader :connection, :identity, :realname
 
     class << self
@@ -17,6 +20,8 @@ def initialize(nickname, connection, identity, realname)
       @connection = connection
       @identity   = identity
       @realname   = realname
+      initialize_keep_alive
+      initialize_presence
     end
 
     def respond_with(*)

test/integration/keep_alive_test.rb

@@ -0,0 +1,53 @@
+require "test_helper"
+
+module Hector
+  class KeepAliveTest < IntegrationTest
+    test :"keep-alive ping is sent on pulse" do
+      authenticated_connection.tap do |c|
+        assert_not_sent_to c, "PING hector.irc"
+        assert_sent_to c, "PING hector.irc" do
+          pulse(c)
+        end
+        assert !c.connection_closed?
+      end
+    end
+
+    test :"responding with pong results in another ping on the next pulse" do
+      authenticated_connection.tap do |c|
+        pulse(c)
+        c.receive_line "PONG hector.irc"
+        assert_sent_to c, "PING hector.irc" do
+          pulse(c)
+        end
+        assert !c.connection_closed?
+      end
+    end
+
+    test :"not responding with pong results in disconnection on the next pulse" do
+      authenticated_connection.tap do |c|
+        pulse(c)
+        assert_not_sent_to c, "PING hector.irc" do
+          pulse(c)
+        end
+        assert c.connection_closed?
+      end
+    end
+
+    test :"channel members are notified of keep-alive timeouts" do
+      authenticated_connections(:join => "#test") do |c1, c2|
+        pulse(c1)
+        assert_sent_to c2, ":user1!sam@hector.irc QUIT" do
+          pulse(c1)
+        end
+      end
+    end
+
+    def pulse(connection)
+      heartbeat(connection).pulse
+    end
+
+    def heartbeat(connection)
+      connection.session.instance_variable_get(:@heartbeat)
+    end
+  end
+end

test/lib/hector/test_heartbeat.rb

@@ -0,0 +1,9 @@
+module Hector
+  class Heartbeat
+    def self.create_timer(interval)
+      Object.new.tap do |o|
+        def o.cancel; end
+      end
+    end
+  end
+end

test/test_helper.rb

@@ -18,6 +18,7 @@
 
 require "hector/test_case"
 require "hector/test_connection"
+require "hector/test_heartbeat"
 require "hector/integration_test"
 
 module Hector
@@ -28,3 +29,4 @@ def self.fixture_path(filename)
   IDENTITY_FIXTURES = fixture_path("identities.yml")
   Identity.adapter = YamlIdentityAdapter.new(IDENTITY_FIXTURES)
 end
+

test/unit/session_test.rb

@@ -113,9 +113,7 @@ def teardown
     end
 
     def create_session(nickname)
-      UserSession.create(nickname, connection, identity, "Real Name").tap do |session|
-        session.commence_presence
-      end
+      UserSession.create(nickname, connection, identity, "Real Name")
     end
 
     def session_names