punchblock 0.7.2 → 0.8.0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # develop
 
+# v0.8.0 - 2012-01-06
+  * Feature: Expose Blather's connection timeout config when creating a Connection::XMPP
+  * Bugfix: Remove some deprecated Tropo extension components
+  * Bugfix: Remove reconnection logic since it really belongs in the consumer
+  * Feature: Raise a DisconnectedError when a disconnection is detected
+
 # v0.7.2 - 2011-12-28
   * Feature: Allow sending commands to mixers easily
   * Feature: Allow configuration of Rayo XMPP domains (root, call and mixer)

data/lib/punchblock.rb

@@ -16,6 +16,7 @@ module Punchblock
   autoload :CommandNode
   autoload :Component
   autoload :Connection
+  autoload :DisconnectedError
   autoload :HasHeaders
   autoload :Header
   autoload :MediaContainer
@@ -53,7 +54,7 @@ module Punchblock
     RAYO_NAMESPACES[:"#{ns}_complete"] = [BASE_RAYO_NAMESPACE, ns.to_s, 'complete', RAYO_VERSION].compact.join(':')
   end
 
-  [:ask, :conference, :say, :transfer].each do |ns|
+  [:conference].each do |ns|
     RAYO_NAMESPACES[ns] = [BASE_TROPO_NAMESPACE, ns.to_s, RAYO_VERSION].compact.join(':')
     RAYO_NAMESPACES[:"#{ns}_complete"] = [BASE_TROPO_NAMESPACE, ns.to_s, 'complete', RAYO_VERSION].compact.join(':')
   end

data/lib/punchblock/component/tropo.rb

@@ -3,10 +3,7 @@ module Punchblock
     module Tropo
       extend ActiveSupport::Autoload
 
-      autoload :Ask
       autoload :Conference
-      autoload :Say
-      autoload :Transfer
     end
   end # Command
 end # Punchblock

data/lib/punchblock/connection/xmpp.rb

@@ -18,14 +18,14 @@ module Punchblock
       # @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 [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, Optional] :connection_timeout for which to wait on a connection being established
       # @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 }
+        setup *[:username, :password, :host, :port, :certs, :connection_timeout].map { |key| options.delete key }
 
         @root_domain    = Blather::JID.new(options[:root_domain] || options[:rayo_domain] || @username).domain
         @calls_domain   = options[:calls_domain]  || "calls.#{@root_domain}"
@@ -33,9 +33,6 @@ module Punchblock
 
         @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
 
         Blather.logger = pb_logger
@@ -59,7 +56,7 @@ module Punchblock
       def prep_command_for_execution(command, options = {})
         command.connection    = self
         command.call_id       ||= options[:call_id]
-        command.mixer_name      ||= options[:mixer_name]
+        command.mixer_name    ||= options[:mixer_name]
         command.component_id  ||= options[:component_id]
         create_iq(jid_for_command(command)).tap do |iq|
           pb_logger.debug "Sending IQ ID #{iq.id} #{command.inspect} to #{jid}"
@@ -78,13 +75,17 @@ module Punchblock
       def connect
         begin
           EM.run { client.run }
+        rescue Blather::Stream::ConnectionFailed, Blather::Stream::ConnectionTimeout => e
+          raise DisconnectedError.new(e.class.to_s, e.message)
         rescue => e
+          # Preserve Punchblock native exceptions
+          raise e if e.class.to_s =~ /^Punchblock/
+          # Wrap everything else
           raise ProtocolError.new(e.class.to_s, e.message)
         end
       end
 
       def stop
-        @reconnect_attempts = nil
         client.close
       end
 
@@ -155,20 +156,12 @@ module Punchblock
         when_ready do
           event_handler.call Connected.new
           pb_logger.info "Connected to XMPP as #{@username}"
-          @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
-            pb_logger.warn "XMPP disconnected. Tried to reconnect #{@reconnect_attempts} times. Reconnecting in #{timer}s."
-            sleep timer
-            pb_logger.info "Trying to reconnect..."
-            @reconnect_attempts += 1
-            connect
-          end
+          raise DisconnectedError
         end
 
         # Read/handle presence requests. This is how we get events.

data/lib/punchblock/disconnected_error.rb

@@ -0,0 +1,16 @@
+module Punchblock
+  ##
+  # This exception may be raised if the connection to the server is interrupted.
+  class DisconnectedError < StandardError
+    attr_accessor :cause, :message
+
+    def initialize(cause = nil, message = nil)
+      @cause, @message = cause, message
+    end
+
+    def to_s
+      "#<#{self.class}: cause=#{cause.inspect} message=#{message.inspect}"
+    end
+    alias :inspect :to_s
+  end
+end

data/lib/punchblock/version.rb

@@ -1,3 +1,3 @@
 module Punchblock
-  VERSION = "0.7.2"
+  VERSION = "0.8.0"
 end

data/punchblock.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 1.3.7") if s.respond_to? :required_rubygems_version=
 
   s.add_runtime_dependency %q<niceogiri>, [">= 0.0.4"]
-  s.add_runtime_dependency %q<blather>, [">= 0.5.9"]
+  s.add_runtime_dependency %q<blather>, [">= 0.5.12"]
   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"]

data/spec/punchblock/connection/xmpp_spec.rb

@@ -73,8 +73,8 @@ module Punchblock
         offer = Event::Offer.new
         offer.call_id = '9f00061'
         offer.to = 'sip:whatever@127.0.0.1'
-        say = <<-MSG
-<say xmlns='urn:xmpp:tropo:say:1' voice='allison'>
+        output = <<-MSG
+<output xmlns='urn:xmpp:tropo:say:1'>
   <audio url='http://acme.com/greeting.mp3'>
   Thanks for calling ACME company
   </audio>
@@ -82,16 +82,16 @@ module Punchblock
   Your package was shipped on
   </audio>
   <say-as interpret-as='date'>12/01/2011</say-as>
-</say>
+</output>
         MSG
-        Component::Tropo::Say
-        say = RayoNode.import parse_stanza(say).root
+        Component::Output
+        output = RayoNode.import parse_stanza(output).root
         connection.expects(:write_to_stream).once.returns true
         iq = Blather::Stanza::Iq.new :set, '9f00061@call.rayo.net'
         connection.expects(:create_iq).returns iq
 
         write_thread = Thread.new do
-          connection.write offer.call_id, say
+          connection.write offer.call_id, output
         end
 
         result = import_stanza <<-MSG
@@ -106,22 +106,22 @@ module Punchblock
 
         write_thread.join
 
-        say.state_name.should == :executing
+        output.state_name.should == :executing
 
-        connection.original_component_from_id('fgh4590').should == say
+        connection.original_component_from_id('fgh4590').should == output
 
         example_complete = import_stanza <<-MSG
 <presence to='16577@app.rayo.net/1' from='9f00061@call.rayo.net/fgh4590'>
   <complete xmlns='urn:xmpp:rayo:ext:1'>
-  <success xmlns='urn:xmpp:tropo:say:complete:1' />
+  <success xmlns='urn:xmpp:rayo:output:complete:1' />
   </complete>
 </presence>
         MSG
 
         connection.__send__ :handle_presence, example_complete
-        say.complete_event(0.5).source.should == say
+        output.complete_event(0.5).source.should == output
 
-        say.component_id.should == 'fgh4590'
+        output.component_id.should == 'fgh4590'
       end
 
       it 'should send a "Chat" presence when ready' do
@@ -164,7 +164,7 @@ module Punchblock
           <<-MSG
 <presence to='16577@app.rayo.net/1' from='9f00061@call.rayo.net/fgh4590'>
   <complete xmlns='urn:xmpp:rayo:ext:1'>
-  <success xmlns='urn:xmpp:tropo:say:complete:1' />
+  <success xmlns='urn:xmpp:rayo:output:complete:1' />
   </complete>
 </presence>
           MSG

data/spec/punchblock/event/complete_spec.rb

@@ -11,7 +11,7 @@ module Punchblock
         let :stanza do
           <<-MESSAGE
 <complete xmlns='urn:xmpp:rayo:ext:1'>
-  <success xmlns='urn:xmpp:tropo:say:complete:1' />
+  <success xmlns='urn:xmpp:rayo:output:complete:1' />
 </complete>
           MESSAGE
         end
@@ -22,7 +22,7 @@ module Punchblock
 
         it_should_behave_like 'event'
 
-        its(:reason) { should be_instance_of Component::Tropo::Say::Complete::Success }
+        its(:reason) { should be_instance_of Component::Output::Complete::Success }
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: punchblock
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-28 00:00:00.000000000 Z
+date: 2012-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceogiri
-  requirement: &2164396920 !ruby/object:Gem::Requirement
+  requirement: &2152641860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,21 +23,21 @@ dependencies:
         version: 0.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2164396920
+  version_requirements: *2152641860
 - !ruby/object:Gem::Dependency
   name: blather
-  requirement: &2164396380 !ruby/object:Gem::Requirement
+  requirement: &2152641280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.5.9
+        version: 0.5.12
   type: :runtime
   prerelease: false
-  version_requirements: *2164396380
+  version_requirements: *2152641280
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2164395740 !ruby/object:Gem::Requirement
+  requirement: &2152640660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2164395740
+  version_requirements: *2152640660
 - !ruby/object:Gem::Dependency
   name: state_machine
-  requirement: &2164395120 !ruby/object:Gem::Requirement
+  requirement: &2152639980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: 1.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *2164395120
+  version_requirements: *2152639980
 - !ruby/object:Gem::Dependency
   name: future-resource
-  requirement: &2164394580 !ruby/object:Gem::Requirement
+  requirement: &2152639220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: 0.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *2164394580
+  version_requirements: *2152639220
 - !ruby/object:Gem::Dependency
   name: has-guarded-handlers
-  requirement: &2164393880 !ruby/object:Gem::Requirement
+  requirement: &2152638480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2164393880
+  version_requirements: *2152638480
 - !ruby/object:Gem::Dependency
   name: celluloid
-  requirement: &2164392120 !ruby/object:Gem::Requirement
+  requirement: &2152637500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *2164392120
+  version_requirements: *2152637500
 - !ruby/object:Gem::Dependency
   name: ruby_ami
-  requirement: &2164391380 !ruby/object:Gem::Requirement
+  requirement: &2152636520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: 0.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *2164391380
+  version_requirements: *2152636520
 - !ruby/object:Gem::Dependency
   name: ruby_speech
-  requirement: &2164390440 !ruby/object:Gem::Requirement
+  requirement: &2152635380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,10 +111,10 @@ dependencies:
         version: 0.3.4
   type: :runtime
   prerelease: false
-  version_requirements: *2164390440
+  version_requirements: *2152635380
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2164389600 !ruby/object:Gem::Requirement
+  requirement: &2152634520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -122,10 +122,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2164389600
+  version_requirements: *2152634520
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2164353240 !ruby/object:Gem::Requirement
+  requirement: &2152633440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -133,10 +133,10 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *2164353240
+  version_requirements: *2152633440
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2164352260 !ruby/object:Gem::Requirement
+  requirement: &2152632400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -144,10 +144,10 @@ dependencies:
         version: 1.6.3
   type: :development
   prerelease: false
-  version_requirements: *2164352260
+  version_requirements: *2152632400
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2164351080 !ruby/object:Gem::Requirement
+  requirement: &2152631620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -155,10 +155,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *2164351080
+  version_requirements: *2152631620
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2164350380 !ruby/object:Gem::Requirement
+  requirement: &2152630600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -166,10 +166,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164350380
+  version_requirements: *2152630600
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2164348740 !ruby/object:Gem::Requirement
+  requirement: &2152629520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -177,10 +177,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164348740
+  version_requirements: *2152629520
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2164348020 !ruby/object:Gem::Requirement
+  requirement: &2152622020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -188,10 +188,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164348020
+  version_requirements: *2152622020
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2164347400 !ruby/object:Gem::Requirement
+  requirement: &2152620880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -199,10 +199,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164347400
+  version_requirements: *2152620880
 - !ruby/object:Gem::Dependency
   name: countdownlatch
-  requirement: &2164346700 !ruby/object:Gem::Requirement
+  requirement: &2152619940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -210,10 +210,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164346700
+  version_requirements: *2152619940
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2164346200 !ruby/object:Gem::Requirement
+  requirement: &2152619460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -221,7 +221,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164346200
+  version_requirements: *2152619460
 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,10 +265,7 @@ files:
 - lib/punchblock/component/record.rb
 - lib/punchblock/component/stop.rb
 - lib/punchblock/component/tropo.rb
-- lib/punchblock/component/tropo/ask.rb
 - lib/punchblock/component/tropo/conference.rb
-- lib/punchblock/component/tropo/say.rb
-- lib/punchblock/component/tropo/transfer.rb
 - lib/punchblock/connection.rb
 - lib/punchblock/connection/asterisk.rb
 - lib/punchblock/connection/connected.rb
@@ -277,6 +274,7 @@ files:
 - lib/punchblock/core_ext/blather/stanza.rb
 - lib/punchblock/core_ext/blather/stanza/presence.rb
 - lib/punchblock/core_ext/ruby.rb
+- lib/punchblock/disconnected_error.rb
 - lib/punchblock/event.rb
 - lib/punchblock/event/answered.rb
 - lib/punchblock/event/asterisk.rb
@@ -326,10 +324,7 @@ files:
 - spec/punchblock/component/input_spec.rb
 - spec/punchblock/component/output_spec.rb
 - spec/punchblock/component/record_spec.rb
-- spec/punchblock/component/tropo/ask_spec.rb
 - spec/punchblock/component/tropo/conference_spec.rb
-- spec/punchblock/component/tropo/say_spec.rb
-- spec/punchblock/component/tropo/transfer_spec.rb
 - spec/punchblock/connection/asterisk_spec.rb
 - spec/punchblock/connection/xmpp_spec.rb
 - spec/punchblock/event/answered_spec.rb
@@ -366,7 +361,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1241799790800462241
+      hash: -4143902595723607278
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -399,10 +394,7 @@ test_files:
 - spec/punchblock/component/input_spec.rb
 - spec/punchblock/component/output_spec.rb
 - spec/punchblock/component/record_spec.rb
-- spec/punchblock/component/tropo/ask_spec.rb
 - spec/punchblock/component/tropo/conference_spec.rb
-- spec/punchblock/component/tropo/say_spec.rb
-- spec/punchblock/component/tropo/transfer_spec.rb
 - spec/punchblock/connection/asterisk_spec.rb
 - spec/punchblock/connection/xmpp_spec.rb
 - spec/punchblock/event/answered_spec.rb