punchblock 0.9.2 → 0.10.0

data/.gitignore

@@ -11,3 +11,4 @@ spec/reports
 vendor
 .rbx/
 *.rbc
+tmp

data/CHANGELOG.md

@@ -1,24 +1,37 @@
-# develop
-
-# v0.9.2 - 2012-02-18
+# [develop](https://github.com/adhearsion/punchblock)
+
+# [v0.10.0](https://github.com/adhearsion/punchblock/compare/v0.9.2...v0.10.0) - [2012-03-19](https://rubygems.org/gems/punchblock/versions/0.10.0)
+  * Feature: app_swift is now supported on Asterisk with a media_engine type of :swift
+  * Feature: Asterisk calls now support the Join API
+  * Feature: On Asterisk, Punchblock creates a context and extension to redirect calls to
+  * Bugfix: Unjoining calls now redirects both legs
+  * Bugfix: Unlink events on Asterisk correctly send Unjoin Punchblock events
+  * Bugfix: The Asterisk translator now ignores calls to 'h' or of type 'Kill'
+  * Bugfix: Handle more XMPP connection errors gracefully
+  * Bugfix: The XMPP connection ready event is now available to external handlers
+  * Bugfix: The Asterisk connection now passes the `:media_engine` option down to the translator
+  * Bugfix: Connections now always respond to `#connected?`
+  * Bugfix: Connection termination handled gracefully on Asterisk
+
+# [v0.9.2](https://github.com/adhearsion/punchblock/compare/v0.9.1...v0.9.2) - [2012-02-18](https://rubygems.org/gems/punchblock/versions/0.9.2)
   * Feature: Asterisk calls receiving media commands are implicitly answered
   * Bugfix: Unrenderable output documents on Asterisk should return a sensible error
   * Bugfix: Log the target of commands correctly
   * Bugfix: Do not wrap exceptions in ProtocolError
 
-# v0.9.1 - 2012-01-30
+# [v0.9.1](https://github.com/adhearsion/punchblock/compare/v0.9.0...v0.9.1) - [2012-01-30](https://rubygems.org/gems/punchblock/versions/0.9.1)
   * Bugfix: Closing an disconnected XMPP connection is a no-op
 
-# v0.9.0 - 2012-01-30
+# [v0.9.0](https://github.com/adhearsion/punchblock/compare/v0.8.4...v0.9.0) - [2012-01-30](https://rubygems.org/gems/punchblock/versions/0.9.0)
   * Bugfix: Remove the rest of the deprecated Tropo components (conference)
   * Feature: Outbound dials on Asterisk now respect the dial timeout
   * Bugfix: Registering stanza handlers on an XMPP connection now sets them in the correct order such that they do not override the internally defined handlers
 
-# v0.8.4 - 2012-01-19
+# [v0.8.4](https://github.com/adhearsion/punchblock/compare/v0.8.3...v0.8.4) - [2012-01-19](https://rubygems.org/gems/punchblock/versions/0.8.4)
   * Bugfix: End, Ringing & Answered events are allowed to have headers
   * Feature: Dial commands may have an optional timeout
 
-# v0.8.3 - 2012-01-17
+# [v0.8.3](https://github.com/adhearsion/punchblock/compare/v0.8.2...v0.8.3) - [2012-01-17](https://rubygems.org/gems/punchblock/versions/0.8.3)
   * Feature: Return an error when trying to execute a command for unknown calls/components or when not understood
   * Feature: Log calls/translator shutting down
   * Feature: Calls and components should log their IDs
@@ -35,20 +48,20 @@
   * Bugfix: A call being hung up should terminate the call actor
   * Bugfix: Fix a mock expectation error in a test
 
-# v0.8.2 - 2012-01-10
+# [v0.8.2](https://github.com/adhearsion/punchblock/compare/v0.8.1...v0.8.2) - [2012-01-10](https://rubygems.org/gems/punchblock/versions/0.8.2)
   * Feature: Support outbound dial on Asterisk
   * Bugfix: Asterisk hangup causes should map to correct Rayo End reason
 
-# v0.8.1 - 2012-01-09
+# [v0.8.1](https://github.com/adhearsion/punchblock/compare/v0.8.0...v0.8.1) - [2012-01-09](https://rubygems.org/gems/punchblock/versions/0.8.1)
   * Feature: Support DTMF Input components on Asterisk
 
-# v0.8.0 - 2012-01-06
+# [v0.8.0](https://github.com/adhearsion/punchblock/compare/v0.7.2...v0.8.0) - [2012-01-06](https://rubygems.org/gems/punchblock/versions/0.8.0)
   * 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
+# [v0.7.2](https://github.com/adhearsion/punchblock/compare/v0.7.1...v0.7.2) - [2011-12-28](https://rubygems.org/gems/punchblock/versions/0.7.2)
   * Feature: Allow sending commands to mixers easily
   * Feature: Allow configuration of Rayo XMPP domains (root, call and mixer)
   * Feature: Log Blather messages to the trace log level
@@ -60,12 +73,12 @@
   * Bugfix: Asterisk media output should default to Asterisk native output (STREAM FILE)
   * Bugfix: An Output node's default max_time value should be nil rather than zero
 
-# v0.7.1 - 2011-11-24
+# [v0.7.1](https://github.com/adhearsion/punchblock/compare/v0.7.0...v0.7.1) - [2011-11-24](https://rubygems.org/gems/punchblock/versions/0.7.1)
   * [FEATURE] Add `Connection#not_ready!`, to instruct the server not to send any more offers.
   * [BUGFIX] Translate all exceptions raised by the XMPP connection into a ProtocolError
   * [UPDATE] Blather dependency to >= 0.5.9
 
-# v0.7.0 - 2011-11-22
+# [v0.7.0](https://github.com/adhearsion/punchblock/compare/v0.6.2...v0.7.0) - [2011-11-22](https://rubygems.org/gems/punchblock/versions/0.7.0)
   * Bugfix: Some spec mistakes
   * Feature: Allow execution of actions against global components on Asterisk
   * API change: The console has been removed
@@ -74,37 +87,37 @@
   * Bugfix: Bump the Celluloid dependency to avoid spec failures on JRuby and monkey-patching for mockability
   * API change: Event handlers registered on components are no longer triggered by incoming events internally to Punchblock. These events must be consumed via a Client's event handlers or event queue and manually triggered on a component using ComponentNode#trigger_event_handler
 
-# v0.6.2
+# [v0.6.2](https://github.com/adhearsion/punchblock/compare/v0.6.1...v0.6.2)
   # Feature: Added basic support for running Punchblock apps on Asterisk. Calls coming in to AsyncAGI result in the client receiving an Offer, hangup events are sent, and accept/answer/hangup commands work.
   # API change: The logger is now set using Punchblock.logger= rather than as a hash key to Connection.new
 
-# v0.6.1
+# [v0.6.1](https://github.com/adhearsion/punchblock/compare/v0.6.0...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
+# [v0.6.0](https://github.com/adhearsion/punchblock/compare/v0.5.1...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.
   * Deprecation: The punchblock-console and the associated DSL are now deprecated and the punchblock-console gem should be used instead
 
-# v0.5.1
+# [v0.5.1](https://github.com/adhearsion/punchblock/compare/v0.5.0...v0.5.1)
   API change: Connections now raise a Punchblock::Connection::Connected instance as an event, rather than the class itself
 
-# v0.5.0
+# [v0.5.0](https://github.com/adhearsion/punchblock/compare/v0.4.3...v0.5.0)
   * Refactoring/API change: Client and connection level concerns are now separated, and one must create a Connection to be passed to a Client on creation. Client now has the choice between an event queue and guarded event handlers.
 
-# v0.4.3
+# [v0.4.3](https://github.com/adhearsion/punchblock/compare/v0.4.2...v0.4.3)
   * Feature: Support for meta-data on recordings (size & duration)
   * Feature: Allow specifying all of Blather's setup options (required to use PB as an XMPP component)
   * Bugfix: Rayo events are discarded if they don't come from the specified domain
   * Bugfix: Component execution in the sample DSL now doesn't expect events on the main queue
 
-# v0.4.2
+# [v0.4.2](https://github.com/adhearsion/punchblock/compare/v0.4.1...v0.4.2)
   * Bugfix: Conference complete event was not being handled
 
-# v0.4.1
+# [v0.4.1](https://github.com/adhearsion/punchblock/compare/v0.4.0...v0.4.1)
   * Feature/API change: Components no longer have an event queue, but instead it is possible to define guarded event handlers via #register_event_handler
 
 # v0.4.0

data/Rakefile

@@ -8,6 +8,7 @@ require 'ci/reporter/rake/rspec'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rspec_opts = '--color'
+  spec.ruby_opts = "-w -r./spec/capture_warnings"
 end
 
 task :default => :spec
@@ -16,3 +17,22 @@ task :hudson => :ci
 
 require 'yard'
 YARD::Rake::YardocTask.new
+
+task :encodeify do
+  Dir['{lib,spec}/**/*.rb'].each do |filename|
+    File.open filename do |file|
+      first_line = file.first
+      if first_line == "# encoding: utf-8\n"
+        puts "#{filename} is utf-8"
+      else
+        puts "Making #{filename} utf-8..."
+        File.unlink filename
+        File.open filename, "w" do |new_file|
+          new_file.write "# encoding: utf-8\n\n"
+          new_file.write first_line
+          new_file.write file.read
+        end
+      end
+    end
+  end
+end

data/lib/punchblock/client/component_registry.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   class Client
     class ComponentRegistry

data/lib/punchblock/client.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   class Client
     extend ActiveSupport::Autoload
@@ -24,7 +26,6 @@ module Punchblock
 
     def handle_event(event)
       event.client = self
-      pb_logger.debug "Handling event #{event} with source #{event.source}."
       if event.source
         event.source.add_event event
       else
@@ -51,7 +52,6 @@ module Punchblock
     end
 
     def execute_command(command, options = {})
-      pb_logger.debug "Executing command: #{command.inspect} with options #{options.inspect}"
       async = options.has_key?(:async) ? options.delete(:async) : true
       command.client = self
       if command.respond_to?(:register_handler)

data/lib/punchblock/command/accept.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Command
     class Accept < CommandNode

data/lib/punchblock/command/answer.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Command
     class Answer < CommandNode

data/lib/punchblock/command/dial.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Command
     class Dial < CommandNode

data/lib/punchblock/command/hangup.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Command
     class Hangup < CommandNode

data/lib/punchblock/command/join.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Command
     class Join < CommandNode

data/lib/punchblock/command/mute.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Command
     class Mute < CommandNode

data/lib/punchblock/command/redirect.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Command
     class Redirect < CommandNode

data/lib/punchblock/command/reject.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Command
     class Reject < CommandNode
@@ -53,7 +55,7 @@ module Punchblock
         if reject_reason && !VALID_REASONS.include?(reject_reason.to_sym)
           raise ArgumentError, "Invalid Reason (#{reject_reason}), use: #{VALID_REASONS*' '}"
         end
-        children.each &:remove
+        children.each(&:remove)
         self << RayoNode.new(reject_reason)
       end
 

data/lib/punchblock/command/unjoin.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Command
     class Unjoin < CommandNode

data/lib/punchblock/command/unmute.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Command
     class Unmute < CommandNode

data/lib/punchblock/command.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Command
     extend ActiveSupport::Autoload

data/lib/punchblock/command_node.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'state_machine'
 
 module Punchblock

data/lib/punchblock/component/asterisk/agi/command.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Component
     module Asterisk
@@ -23,7 +25,7 @@ module Punchblock
           # @return [Array[String]] array of values of params
           #
           def params_array
-            params.map &:value
+            params.map(&:value)
           end
 
           ##
@@ -39,7 +41,7 @@ module Punchblock
           # @param [Hash, Array] params A hash of key-value param pairs, or an array of Param objects
           #
           def params=(params)
-            find('//ns:param', :ns => self.class.registered_ns).each &:remove
+            find('//ns:param', :ns => self.class.registered_ns).each(&:remove)
             [params].flatten.each { |i| self << Param.new(i) } if params.is_a? Array
           end
 

data/lib/punchblock/component/asterisk/agi.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Component
     module Asterisk

data/lib/punchblock/component/asterisk/ami/action.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'punchblock/key_value_pair_node'
 
 module Punchblock
@@ -44,7 +46,7 @@ module Punchblock
           # @param [Hash, Array] params A hash of key-value param pairs, or an array of Param objects
           #
           def params=(params)
-            find('//ns:param', :ns => self.class.registered_ns).each &:remove
+            find('//ns:param', :ns => self.class.registered_ns).each(&:remove)
             if params.is_a? Hash
               params.each_pair { |k,v| self << Param.new(k, v) }
             elsif params.is_a? Array
@@ -120,7 +122,7 @@ module Punchblock
               # @param [Hash, Array] attributes A hash of key-value attribute pairs, or an array of Attribute objects
               #
               def attributes=(attributes)
-                find('//ns:attribute', :ns => self.class.registered_ns).each &:remove
+                find('//ns:attribute', :ns => self.class.registered_ns).each(&:remove)
                 if attributes.is_a? Hash
                   attributes.each_pair { |k,v| self << Attribute.new(k, v) }
                 elsif attributes.is_a? Array

data/lib/punchblock/component/asterisk/ami.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Component
     module Asterisk

data/lib/punchblock/component/asterisk.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Component
     module Asterisk

data/lib/punchblock/component/component_node.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Component
     class ComponentNode < CommandNode

data/lib/punchblock/component/input.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Component
     class Input < ComponentNode

data/lib/punchblock/component/output.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Component
     class Output < ComponentNode

data/lib/punchblock/component/record.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Component
     class Record < ComponentNode

data/lib/punchblock/component/stop.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Component
     class Stop < CommandNode # :nodoc:

data/lib/punchblock/component.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Component
     extend ActiveSupport::Autoload

data/lib/punchblock/connection/asterisk.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'ruby_ami'
 
 module Punchblock
@@ -8,13 +10,14 @@ module Punchblock
 
       def initialize(options = {})
         @ami_client = RubyAMI::Client.new options.merge(:event_handler => lambda { |event| translator.handle_ami_event! event }, :logger => pb_logger)
-        @translator = Translator::Asterisk.new @ami_client, self
+        @translator = Translator::Asterisk.new @ami_client, self, options[:media_engine]
         super()
       end
 
       def run
         pb_logger.debug "Starting the RubyAMI client"
         ami_client.start
+        raise DisconnectedError
       end
 
       def stop

data/lib/punchblock/connection/connected.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Connection
     Connected = Class.new do

data/lib/punchblock/connection/generic_connection.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Connection
     class GenericConnection
@@ -10,6 +12,9 @@ module Punchblock
 
       def not_ready!
       end
+
+      def connected?
+      end
     end
   end
 end

data/lib/punchblock/connection/xmpp.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 %w{
   timeout
   blather/client/dsl
@@ -25,7 +27,7 @@ module Punchblock
       def initialize(options = {})
         raise ArgumentError unless (@username = options[:username]) && options[:password]
 
-        setup *[:username, :password, :host, :port, :certs, :connection_timeout].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}"
@@ -61,7 +63,6 @@ module Punchblock
         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 #{iq.to}"
           iq << command
         end
       end
@@ -76,7 +77,7 @@ module Punchblock
       def connect
         begin
           EM.run { client.run }
-        rescue Blather::Stream::ConnectionFailed, Blather::Stream::ConnectionTimeout => e
+        rescue Blather::Stream::ConnectionFailed, Blather::Stream::ConnectionTimeout, Blather::StreamError => e
           raise DisconnectedError.new(e.class.to_s, e.message)
         end
       end
@@ -125,9 +126,7 @@ module Punchblock
 
       def handle_presence(p)
         throw :pass unless p.rayo_event?
-        pb_logger.info "Receiving event for call ID #{p.call_id}"
         @callmap[p.call_id] = p.from.domain
-        pb_logger.debug p.inspect
         event = p.event
         event.connection = self
         event.domain = p.from.domain
@@ -137,7 +136,6 @@ module Punchblock
       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
-        pb_logger.debug "Command #{iq.id} completed successfully"
         command.response = iq.rayo_node.is_a?(Ref) ? iq.rayo_node : true
       end
 
@@ -153,6 +151,7 @@ module Punchblock
           event_handler.call Connected.new
           pb_logger.info "Connected to XMPP as #{@username}"
           @rayo_ping = EM::PeriodicTimer.new(@ping_period) { ping_rayo } if @ping_period
+          throw :pass
         end
 
         disconnected do

data/lib/punchblock/connection.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Connection
     extend ActiveSupport::Autoload

data/lib/punchblock/core_ext/blather/stanza/presence.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Blather
   class Stanza
     class Presence

data/lib/punchblock/core_ext/blather/stanza.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Blather
   class Stanza
     ##

data/lib/punchblock/core_ext/ruby.rb

@@ -1,15 +1,4 @@
-class Hash
-  def select(&block)
-    val = super(&block)
-    if val.is_a?(Array)
-      val = val.inject({}) do |accumulator, element|
-        accumulator[element[0]] = element[1]
-        accumulator
-      end
-    end
-    val
-  end
-end
+# encoding: utf-8
 
 class NullObject
   def method_missing(*args)

data/lib/punchblock/disconnected_error.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   ##
   # This exception may be raised if the connection to the server is interrupted.

data/lib/punchblock/event/answered.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   class Event
     class Answered < Event

data/lib/punchblock/event/asterisk/ami/event.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'punchblock/key_value_pair_node'
 
 module Punchblock
@@ -44,7 +46,7 @@ module Punchblock
           # @param [Hash, Array] attributes A hash of key-value attribute pairs, or an array of Attribute objects
           #
           def attributes=(attributes)
-            find('//ns:attribute', :ns => self.class.registered_ns).each &:remove
+            find('//ns:attribute', :ns => self.class.registered_ns).each(&:remove)
             if attributes.is_a? Hash
               attributes.each_pair { |k,v| self << Attribute.new(k, v) }
             elsif attributes.is_a? Array

data/lib/punchblock/event/asterisk/ami.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   class Event
     module Asterisk

data/lib/punchblock/event/asterisk.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   class Event
     module Asterisk

data/lib/punchblock/event/complete.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   class Event
     class Complete < Event
@@ -18,7 +20,7 @@ module Punchblock
       end
 
       def reason=(other)
-        children.map &:remove
+        children.map(&:remove)
         self << other
       end
 

data/lib/punchblock/event/dtmf.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   class Event
     class DTMF < Event

data/lib/punchblock/event/end.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   class Event
     class End < Event

data/lib/punchblock/event/joined.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   class Event
     class Joined < Event

data/lib/punchblock/event/offer.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   class Event
     class Offer < Event
@@ -24,6 +26,10 @@ module Punchblock
       def inspect_attributes # :nodoc:
         [:to, :from] + super
       end
+
+      def inspect
+        "#<Punchblock::Event::Offer to=\"#{to}\", from=\"#{from}\", call_id=\"#{call_id}\""
+      end
     end # Offer
   end
 end # Punchblock

data/lib/punchblock/event/ringing.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   class Event
     class Ringing < Event