punchblock 0.6.0 → 0.6.1

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # develop
 
+# v0.6.1
+  * Feature: Allow instructing the connection we are ready. An XMPP connection will send initial presence with a status of 'chat' to the rayo domain
+  * Bugfix: When running on Asterisk, two FullyBooted events will now trigger a connected event
+  * Bugfix: No longer ignore offers from the specified rayo domain on XMPP connections
+  * Feature: Tag all event objects with the XMPP domain they came from
+
 # v0.6.0
   * API change: Punchblock consumers now need to instantiate both a Connection and a Client (see the punchblock-console gem for an example)
   * Feature: Added a Connection for Asterisk, utilising RubyAMI to open an AMI connection to Asterisk, and allowing AMI actions to be executed. AMI events are handled by the client event handler.

data/lib/punchblock/connection.rb

@@ -4,6 +4,7 @@ module Punchblock
 
     autoload :Asterisk
     autoload :Connected
+    autoload :GenericConnection
     autoload :XMPP
   end
 end

data/lib/punchblock/connection/asterisk.rb

@@ -2,13 +2,15 @@ require 'ruby_ami'
 
 module Punchblock
   module Connection
-    class Asterisk
+    class Asterisk < GenericConnection
       attr_reader :ami_client, :translator
       attr_accessor :event_handler
 
       def initialize(options = {})
+        options[:logger] = options[:wire_logger]
         @ami_client = RubyAMI::Client.new options.merge(:event_handler => lambda { |event| translator.handle_ami_event! event })
         @translator = Translator::Asterisk.new @ami_client, self
+        super()
       end
 
       def run

data/lib/punchblock/connection/connected.rb

@@ -8,6 +8,11 @@ module Punchblock
       def client=(other)
         nil
       end
+
+      def eql?(other)
+        other.is_a? self.class
+      end
+      alias :== :eql?
     end
   end
 end

data/lib/punchblock/connection/generic_connection.rb

@@ -0,0 +1,13 @@
+module Punchblock
+  module Connection
+    class GenericConnection
+      def initialize
+        @event_handler = lambda { |event| raise 'No event handler set' }
+      end
+
+      def ready!
+
+      end
+    end
+  end
+end

data/lib/punchblock/connection/xmpp.rb

@@ -7,7 +7,7 @@
 
 module Punchblock
   module Connection
-    class XMPP
+    class XMPP < GenericConnection
       include Blather::DSL
       attr_accessor :event_handler
 
@@ -37,9 +37,9 @@ module Punchblock
 
         @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)
+
+        super()
       end
 
       def write(command, options = {})
@@ -91,15 +91,23 @@ module Punchblock
         client.connected?
       end
 
+      def ready!
+        status = Blather::Stanza::Presence::Status.new :chat
+        status.to = @rayo_domain
+        client.write status
+        super
+      end
+
       private
 
       def handle_presence(p)
-        throw :pass unless p.rayo_event? && p.from.domain == @rayo_domain
+        throw :pass unless p.rayo_event?
         @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.domain = p.from.domain
         event_handler.call event
       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, :client, :original_component
+    attr_accessor :call_id, :component_id, :domain, :connection, :client, :original_component
 
     # Register a new stanza class to a name and/or namespace
     #

data/lib/punchblock/translator/asterisk.rb

@@ -18,6 +18,7 @@ module Punchblock
       def initialize(ami_client, connection)
         @ami_client, @connection = ami_client, connection
         @calls, @components = {}, {}
+        @fully_booted_count = 0
       end
 
       def register_call(call)
@@ -38,7 +39,15 @@ module Punchblock
 
       def handle_ami_event(event)
         return unless event.is_a? RubyAMI::Event
-        connection.handle_event Event::Asterisk::AMI::Event.new(:name => event.name, :attributes => event.headers)
+        if event.name.downcase == "fullybooted"
+          @fully_booted_count += 1
+          if @fully_booted_count >= 2
+            connection.handle_event Connection::Connected.new
+            @fully_booted_count = 0
+          end
+        else
+          connection.handle_event Event::Asterisk::AMI::Event.new(:name => event.name, :attributes => event.headers)
+        end
       end
 
       def execute_command(command, options = {})

data/lib/punchblock/version.rb

@@ -1,3 +1,3 @@
 module Punchblock
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/spec/punchblock/connection/xmpp_spec.rb

@@ -117,6 +117,7 @@ module Punchblock
               mock_event_handler.expects(:call).once.with do |event|
                 event.should be_instance_of Event::Offer
                 event.call_id.should == '9f00061'
+                event.domain.should == 'call.rayo.net'
               end
               handle_presence
             end
@@ -144,25 +145,6 @@ module Punchblock
               lambda { connection.__send__ :handle_presence, example_irrelevant_event }.should throw_symbol(:pass)
             end
           end
-
-          describe "from someone other than the rayo domain" do
-            let :irrelevant_xml do
-              <<-MSG
-<presence to='16577@app.rayo.net/1' from='9f00061@jabber.org/fgh4590'>
-  <complete xmlns='urn:xmpp:rayo:ext:1'>
-    <success xmlns='urn:xmpp:tropo:say:complete:1' />
-  </complete>
-</presence>
-              MSG
-            end
-
-            let(:example_irrelevant_event) { import_stanza irrelevant_xml }
-
-            it 'should not handle the event' do
-              mock_event_handler.expects(:call).never
-              lambda { connection.__send__ :handle_presence, example_irrelevant_event }.should throw_symbol(:pass)
-            end
-          end
         end
       end
 

data/spec/punchblock/translator/asterisk_spec.rb

@@ -144,6 +144,26 @@ module Punchblock
             subject.handle_ami_event :foo
           end
         end
+
+
+        describe 'with a FullyBooted event' do
+          let(:ami_event) { RubyAMI::Event.new 'FullyBooted' }
+
+          context 'once' do
+            it 'does not send anything to the connection' do
+              subject.connection.expects(:handle_event).never
+              subject.handle_ami_event ami_event
+            end
+          end
+
+          context 'twice' do
+            it 'sends a connected event to the event handler' do
+              subject.connection.expects(:handle_event).once.with Connection::Connected.new
+              subject.handle_ami_event ami_event
+              subject.handle_ami_event ami_event
+            end
+          end
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: punchblock
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -15,7 +15,7 @@ date: 2011-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceogiri
-  requirement: &2160733620 !ruby/object:Gem::Requirement
+  requirement: &2164783340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: 0.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2160733620
+  version_requirements: *2164783340
 - !ruby/object:Gem::Dependency
   name: blather
-  requirement: &2160732480 !ruby/object:Gem::Requirement
+  requirement: &2164802760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: 0.5.7
   type: :runtime
   prerelease: false
-  version_requirements: *2160732480
+  version_requirements: *2164802760
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2160730960 !ruby/object:Gem::Requirement
+  requirement: &2164801920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: 0.8.3
   type: :runtime
   prerelease: false
-  version_requirements: *2160730960
+  version_requirements: *2164801920
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2160729840 !ruby/object:Gem::Requirement
+  requirement: &2164800700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2160729840
+  version_requirements: *2164800700
 - !ruby/object:Gem::Dependency
   name: state_machine
-  requirement: &2160729040 !ruby/object:Gem::Requirement
+  requirement: &2164799620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: 1.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *2160729040
+  version_requirements: *2164799620
 - !ruby/object:Gem::Dependency
   name: future-resource
-  requirement: &2160728280 !ruby/object:Gem::Requirement
+  requirement: &2164798360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: 0.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *2160728280
+  version_requirements: *2164798360
 - !ruby/object:Gem::Dependency
   name: has-guarded-handlers
-  requirement: &2160727760 !ruby/object:Gem::Requirement
+  requirement: &2164797820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2160727760
+  version_requirements: *2164797820
 - !ruby/object:Gem::Dependency
   name: celluloid
-  requirement: &2160727280 !ruby/object:Gem::Requirement
+  requirement: &2164797340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *2160727280
+  version_requirements: *2164797340
 - !ruby/object:Gem::Dependency
   name: ruby_ami
-  requirement: &2160726780 !ruby/object:Gem::Requirement
+  requirement: &2164796840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,10 +111,10 @@ dependencies:
         version: 0.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *2160726780
+  version_requirements: *2164796840
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2160726080 !ruby/object:Gem::Requirement
+  requirement: &2164796320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -122,10 +122,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2160726080
+  version_requirements: *2164796320
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2160546520 !ruby/object:Gem::Requirement
+  requirement: &2164795840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -133,10 +133,10 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *2160546520
+  version_requirements: *2164795840
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2160546040 !ruby/object:Gem::Requirement
+  requirement: &2164795280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -144,10 +144,10 @@ dependencies:
         version: 1.6.3
   type: :development
   prerelease: false
-  version_requirements: *2160546040
+  version_requirements: *2164795280
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2160545300 !ruby/object:Gem::Requirement
+  requirement: &2164746600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -155,10 +155,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *2160545300
+  version_requirements: *2164746600
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2160544240 !ruby/object:Gem::Requirement
+  requirement: &2164745540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -166,10 +166,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160544240
+  version_requirements: *2164745540
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2160543520 !ruby/object:Gem::Requirement
+  requirement: &2164744600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -177,10 +177,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160543520
+  version_requirements: *2164744600
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2160542900 !ruby/object:Gem::Requirement
+  requirement: &2164744080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -188,10 +188,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160542900
+  version_requirements: *2164744080
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2160542320 !ruby/object:Gem::Requirement
+  requirement: &2164743260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -199,10 +199,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160542320
+  version_requirements: *2164743260
 - !ruby/object:Gem::Dependency
   name: countdownlatch
-  requirement: &2160541740 !ruby/object:Gem::Requirement
+  requirement: &2164742420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -210,7 +210,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160541740
+  version_requirements: *2164742420
 description: Like Rack is to Rails and Sinatra, Punchblock provides a consistent API
   on top of several underlying third-party call control protocols.
 email: punchblock@adhearsion.com
@@ -265,6 +265,7 @@ files:
 - lib/punchblock/connection.rb
 - lib/punchblock/connection/asterisk.rb
 - lib/punchblock/connection/connected.rb
+- lib/punchblock/connection/generic_connection.rb
 - lib/punchblock/connection/xmpp.rb
 - lib/punchblock/core_ext/blather/stanza.rb
 - lib/punchblock/core_ext/blather/stanza/presence.rb