punchblock 0.4.3 → 0.5.0

data/lib/punchblock/connection/xmpp.rb

@@ -0,0 +1,161 @@
+%w{
+  timeout
+  blather/client/dsl
+  punchblock/core_ext/blather/stanza
+  punchblock/core_ext/blather/stanza/presence
+}.each { |f| require f }
+
+module Punchblock
+  module Connection
+    class XMPP
+      include Blather::DSL
+      attr_accessor :event_handler
+
+      ##
+      # Initialize the required connection attributes
+      #
+      # @param [Hash] options
+      # @option options [String] :username client JID
+      # @option options [String] :password XMPP password
+      # @option options [String] :rayo_domain the domain on which Rayo is running
+      # @option options [Logger] :wire_logger to which all XMPP transactions will be logged
+      # @option options [Boolean, Optional] :auto_reconnect whether or not to auto reconnect
+      # @option options [Numeric, Optional] :write_timeout for which to wait on a command response
+      # @option options [Numeric, nil, Optional] :ping_period interval in seconds on which to ping the server. Nil or false to disable
+      #
+      def initialize(options = {})
+        raise ArgumentError unless (@username = options[:username]) && options[:password]
+
+        setup *[:username, :password, :host, :port, :certs].map { |key| options.delete key }
+
+        @rayo_domain = options[:rayo_domain] || Blather::JID.new(@username).domain
+
+        @callmap = {} # This hash maps call IDs to their XMPP domain.
+
+        @auto_reconnect = !!options[:auto_reconnect]
+        @reconnect_attempts = 0
+
+        @ping_period = options.has_key?(:ping_period) ? options[:ping_period] : 60
+
+        @event_handler = lambda { |event| raise 'No event handler set' }
+
+        Blather.logger = options.delete(:wire_logger) if options.has_key?(:wire_logger)
+      end
+
+      def write(command, options = {})
+        iq = prep_command_for_execution command, options
+        client.write_with_handler iq do |response|
+          if response.result?
+            handle_iq_result response, command
+          elsif response.error?
+            handle_error response, command
+          end
+        end
+        command.request!
+      end
+
+      def prep_command_for_execution(command, options = {})
+        call_id, component_id = options.values_at :call_id, :component_id
+        command.connection = self
+        command.call_id = call_id
+        jid = command.is_a?(Command::Dial) ? @rayo_domain : "#{call_id}@#{@callmap[call_id]}"
+        jid << "/#{component_id}" if component_id
+        create_iq(jid).tap do |iq|
+          @logger.debug "Sending IQ ID #{iq.id} #{command.inspect} to #{jid}" if @logger
+          iq << command
+        end
+      end
+
+      ##
+      # Fire up the connection
+      #
+      def run
+        register_handlers
+        connect
+      end
+
+      def connect
+        begin
+          EM.run { client.run }
+        rescue Blather::SASLError, Blather::StreamError => e
+          raise ProtocolError.new(e.class.to_s, e.message)
+        end
+      end
+
+      def stop
+        @reconnect_attempts = nil
+        client.close
+      end
+
+      def connected?
+        client.connected?
+      end
+
+      private
+
+      def handle_presence(p)
+        throw :pass unless p.rayo_event? && p.from.domain == @rayo_domain
+        @logger.info "Receiving event for call ID #{p.call_id}" if @logger
+        @callmap[p.call_id] = p.from.domain
+        @logger.debug p.inspect if @logger
+        event = p.event
+        event.connection = self
+        event_handler.call event
+      end
+
+      def handle_iq_result(iq, command)
+        # FIXME: Do we need to raise a warning if the domain changes?
+        @callmap[iq.from.node] = iq.from.domain
+        @logger.debug "Command #{iq.id} completed successfully" if @logger
+        command.response = iq.rayo_node.is_a?(Ref) ? iq.rayo_node : true
+      end
+
+      def handle_error(iq, command = nil)
+        e = Blather::StanzaError.import iq
+        protocol_error = ProtocolError.new e.name, e.text, iq.call_id, iq.component_id
+        command.response = protocol_error if command
+      end
+
+      def register_handlers
+        # Push a message to the queue and the log that we connected
+        when_ready do
+          event_handler.call Connected
+          @logger.info "Connected to XMPP as #{@username}" if @logger
+          @reconnect_attempts = 0
+          @rayo_ping = EM::PeriodicTimer.new(@ping_period) { ping_rayo } if @ping_period
+        end
+
+        disconnected do
+          @rayo_ping.cancel if @rayo_ping
+          if @auto_reconnect && @reconnect_attempts
+            timer = 30 * 2 ** @reconnect_attempts
+            @logger.warn "XMPP disconnected. Tried to reconnect #{@reconnect_attempts} times. Reconnecting in #{timer}s." if @logger
+            sleep timer
+            @logger.info "Trying to reconnect..." if @logger
+            @reconnect_attempts += 1
+            connect
+          end
+        end
+
+        # Read/handle presence requests. This is how we get events.
+        presence do |msg|
+          handle_presence msg
+        end
+      end
+
+      def ping_rayo
+        client.write_with_handler Blather::Stanza::Iq::Ping.new(:set, @rayo_domain) do |response|
+          begin
+            handle_error response if response.is_a? Blather::BlatherError
+          rescue ProtocolError => e
+            raise e unless e.name == :feature_not_implemented
+          end
+        end
+      end
+
+      def create_iq(jid = nil)
+        Blather::Stanza::Iq.new :set, jid || @call_id
+      end
+    end
+  end
+end

data/lib/punchblock/dsl.rb

@@ -4,8 +4,8 @@
 # THIS IS IMPERMANENT AND WILL DISAPPEAR
 module Punchblock
   class DSL
-    def initialize(connection, call, queue) # :nodoc:
-      @connection, @call, @queue = connection, call, queue
+    def initialize(client, call_id, queue) # :nodoc:
+      @client, @call_id, @queue = client, call_id, queue
     end
 
     def accept # :nodoc:
@@ -38,8 +38,8 @@ module Punchblock
       component.complete_event.resource
     end
 
-    def write(msg) # :nodoc:
-      @connection.write @call, msg
+    def write(command) # :nodoc:
+      @client.execute_command command, :call_id => @call_id, :async => false
     end
   end
 end

data/lib/punchblock/rayo_node.rb

@@ -7,7 +7,7 @@ module Punchblock
 
     class_attribute :registered_ns, :registered_name
 
-    attr_accessor :call_id, :component_id, :connection, :original_component
+    attr_accessor :call_id, :component_id, :connection, :client, :original_component
 
     # Register a new stanza class to a name and/or namespace
     #
@@ -78,7 +78,7 @@ module Punchblock
     # @return [RayoNode] the original command issued that lead to this event
     #
     def source
-      @source ||= connection.original_component_from_id component_id if connection && component_id
+      @source ||= client.find_component_by_id component_id if client && component_id
       @source ||= original_component
     end
 

data/lib/punchblock/version.rb

@@ -1,3 +1,3 @@
 module Punchblock
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

data/punchblock.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency %q<activesupport>, [">= 2.1.0"]
   s.add_runtime_dependency %q<state_machine>, [">= 1.0.1"]
   s.add_runtime_dependency %q<future-resource>, [">= 0.0.2"]
-  s.add_runtime_dependency %q<has-guarded-handlers>, [">= 0.0.3"]
+  s.add_runtime_dependency %q<has-guarded-handlers>, [">= 0.1.0"]
 
   s.add_development_dependency %q<bundler>, ["~> 1.0.0"]
   s.add_development_dependency %q<rspec>, ["~> 2.3.0"]

data/spec/punchblock/client/component_registry_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+module Punchblock
+  class Client
+    describe ComponentRegistry do
+      let(:component_id)  { 'abc123' }
+      let(:component)     { stub 'Component', :component_id => component_id }
+
+      it 'should store components and allow lookup by ID' do
+        subject << component
+        subject.find_by_id(component_id).should be component
+      end
+    end
+  end
+end

data/spec/punchblock/client_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+module Punchblock
+  describe Client do
+    let(:connection) { Connection::XMPP.new :username => '1@call.rayo.net', :password => 1 }
+
+    subject { Client.new :connection => connection }
+
+    its(:event_queue)         { should be_a Queue }
+    its(:connection)          { should be connection }
+    its(:component_registry)  { should be_a Client::ComponentRegistry }
+
+    let(:call_id)         { 'abc123' }
+    let(:mock_event)      { stub_everything 'Event' }
+    let(:component_id)    { 'abc123' }
+    let(:mock_component)  { stub 'Component', :component_id => component_id }
+    let(:mock_command)    { stub 'Command' }
+
+    describe '#run' do
+      it 'should start up the connection' do
+        connection.expects(:run).once
+        subject.run
+      end
+    end
+
+    describe '#stop' do
+      it 'should stop the connection' do
+        connection.expects(:stop).once
+        subject.stop
+      end
+    end
+
+    it 'should handle connection events' do
+      subject.expects(:handle_event).with(mock_event).once
+      connection.event_handler.call mock_event
+    end
+
+    describe '#handle_event' do
+      it "sets the event's client" do
+        event = Event::Offer.new
+        subject.handle_event event
+        event.client.should be subject
+      end
+
+      context 'if the event can be associated with a source component' do
+        before do
+          mock_event.stubs(:source).returns mock_component
+          mock_component.expects(:add_event).with mock_event
+        end
+
+        it 'should not queue up the event' do
+          subject.handle_event mock_event
+          subject.event_queue.should be_empty
+        end
+
+        it 'should not call event handlers' do
+          handler = mock 'handler'
+          handler.expects(:call).never
+          subject.register_event_handler do |event|
+            handler.call event
+            throw :halt
+          end
+          subject.handle_event mock_event
+        end
+      end
+
+      context 'if the event cannot be associated with a source component' do
+        context 'if event handlers have been set' do
+          it 'should call the event handler and not queue up the event' do
+            handler = mock 'handler'
+            handler.expects(:call).once.with mock_event
+            subject.register_event_handler do |event|
+              handler.call event
+              throw :halt
+            end
+            subject.handle_event mock_event
+            subject.event_queue.should be_empty
+          end
+        end
+
+        context 'if event handlers have not been set' do
+          it 'should queue up the event' do
+            subject.handle_event mock_event
+            subject.event_queue.pop(true).should == mock_event
+          end
+        end
+      end
+    end
+
+    it 'should be able to register and retrieve components' do
+      subject.register_component mock_component
+      subject.find_component_by_id(component_id).should be mock_component
+    end
+
+    describe '#execute_command' do
+      let(:component) { Component::Output.new }
+      let(:event)     { Event::Complete.new }
+
+      before do
+        connection.expects(:write).once.with component, :call_id => call_id
+      end
+
+      let :execute_command do
+        subject.execute_command component, :call_id => call_id
+      end
+
+      it 'should write the command to the connection' do
+        execute_command
+      end
+
+      it "should set the command's client" do
+        execute_command
+        component.client.should be subject
+      end
+
+      it "should handle a component's events" do
+        subject.expects(:trigger_handler).with(:event, event).once
+        execute_command
+        component.request!
+        component.execute!
+        component.add_event event
+      end
+    end
+  end # describe Client
+end # Punchblock

data/spec/punchblock/command/dial_spec.rb

@@ -37,15 +37,8 @@ module Punchblock
           end
         end
 
-        let :iq do
-          Blather::Stanza::Iq.new(:result, 'blah').tap do |iq|
-            iq.from = "call.rayo.net"
-            iq << ref
-          end
-        end
-
         it "should set the call ID from the ref" do
-          subject.response = iq
+          subject.response = ref
           subject.call_id.should == call_id
         end
       end

data/spec/punchblock/component/input_spec.rb

@@ -92,12 +92,13 @@ module Punchblock
       end
 
       describe "actions" do
+        let(:mock_client) { mock 'Client' }
         let(:command) { Input.new :grammar => '[5 DIGITS]' }
 
         before do
           command.component_id = 'abc123'
           command.call_id = '123abc'
-          command.connection = Connection.new :username => '123', :password => '123'
+          command.client = mock_client
         end
 
         describe '#stop_action' do
@@ -116,7 +117,7 @@ module Punchblock
             end
 
             it "should send its command properly" do
-              Connection.any_instance.expects(:write).with('123abc', command.stop_action, 'abc123')
+              mock_client.expects(:execute_command).with(command.stop_action, :call_id => '123abc', :component_id => 'abc123')
               command.stop!
             end
           end

data/spec/punchblock/component/output_spec.rb

@@ -51,12 +51,13 @@ module Punchblock
       end
 
       describe "actions" do
+        let(:mock_client) { mock 'Client' }
         let(:command) { Output.new :text => 'Once upon a time there was a message...', :voice => 'kate' }
 
         before do
           command.component_id = 'abc123'
           command.call_id = '123abc'
-          command.connection = Connection.new :username => '123', :password => '123'
+          command.client = mock_client
         end
 
         describe '#pause_action' do
@@ -75,7 +76,7 @@ module Punchblock
             end
 
             it "should send its command properly" do
-              Connection.any_instance.expects(:write).with('123abc', command.pause_action, 'abc123').returns true
+              mock_client.expects(:execute_command).with(command.pause_action, :call_id => '123abc', :component_id => 'abc123').returns true
               command.expects :paused!
               command.pause!
             end
@@ -119,7 +120,7 @@ module Punchblock
             end
 
             it "should send its command properly" do
-              Connection.any_instance.expects(:write).with('123abc', command.resume_action, 'abc123').returns true
+              mock_client.expects(:execute_command).with(command.resume_action, :call_id => '123abc', :component_id => 'abc123').returns true
               command.expects :resumed!
               command.resume!
             end
@@ -163,7 +164,7 @@ module Punchblock
             end
 
             it "should send its command properly" do
-              Connection.any_instance.expects(:write).with('123abc', command.stop_action, 'abc123')
+              mock_client.expects(:execute_command).with(command.stop_action, :call_id => '123abc', :component_id => 'abc123')
               command.stop!
             end
           end
@@ -196,7 +197,7 @@ module Punchblock
               it "should send its command properly" do
                 seek_action = command.seek_action seek_options
                 command.stubs(:seek_action).returns seek_action
-                Connection.any_instance.expects(:write).with('123abc', seek_action, 'abc123').returns true
+                mock_client.expects(:execute_command).with(seek_action, :call_id => '123abc', :component_id => 'abc123').returns true
                 command.expects :seeking!
                 command.expects :stopped_seeking!
                 command.seek! seek_options
@@ -263,7 +264,7 @@ module Punchblock
               it "should send its command properly" do
                 speed_up_action = command.speed_up_action
                 command.stubs(:speed_up_action).returns speed_up_action
-                Connection.any_instance.expects(:write).with('123abc', speed_up_action, 'abc123').returns true
+                mock_client.expects(:execute_command).with(speed_up_action, :call_id => '123abc', :component_id => 'abc123').returns true
                 command.expects :speeding_up!
                 command.expects :stopped_speeding!
                 command.speed_up!
@@ -321,7 +322,7 @@ module Punchblock
               it "should send its command properly" do
                 slow_down_action = command.slow_down_action
                 command.stubs(:slow_down_action).returns slow_down_action
-                Connection.any_instance.expects(:write).with('123abc', slow_down_action, 'abc123').returns true
+                mock_client.expects(:execute_command).with(slow_down_action, :call_id => '123abc', :component_id => 'abc123').returns true
                 command.expects :slowing_down!
                 command.expects :stopped_speeding!
                 command.slow_down!
@@ -396,7 +397,7 @@ module Punchblock
               it "should send its command properly" do
                 volume_up_action = command.volume_up_action
                 command.stubs(:volume_up_action).returns volume_up_action
-                Connection.any_instance.expects(:write).with('123abc', volume_up_action, 'abc123').returns true
+                mock_client.expects(:execute_command).with(volume_up_action, :call_id => '123abc', :component_id => 'abc123').returns true
                 command.expects :voluming_up!
                 command.expects :stopped_voluming!
                 command.volume_up!
@@ -454,7 +455,7 @@ module Punchblock
               it "should send its command properly" do
                 volume_down_action = command.volume_down_action
                 command.stubs(:volume_down_action).returns volume_down_action
-                Connection.any_instance.expects(:write).with('123abc', volume_down_action, 'abc123').returns true
+                mock_client.expects(:execute_command).with(volume_down_action, :call_id => '123abc', :component_id => 'abc123').returns true
                 command.expects :voluming_down!
                 command.expects :stopped_voluming!
                 command.volume_down!