punchblock 0.9.2 → 0.10.0

data/lib/punchblock/event/unjoined.rb

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

data/lib/punchblock/event.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   class Event < RayoNode
     def self.new(options = {})

data/lib/punchblock/has_headers.rb

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

data/lib/punchblock/header.rb

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

data/lib/punchblock/key_value_pair_node.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module KeyValuePairNode
   def self.included(klass)
     klass.class_exec do

data/lib/punchblock/media_container.rb

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

data/lib/punchblock/media_node.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   class MediaNode < RayoNode
     include MediaContainer

data/lib/punchblock/protocol_error.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   ##
   # This exception may be raised if a transport error is detected.

data/lib/punchblock/rayo_node.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'active_support/core_ext/class/attribute'
 require 'niceogiri'
 
@@ -41,12 +43,11 @@ module Punchblock
     def self.import(node, call_id = nil, component_id = nil)
       ns = (node.namespace.href if node.namespace)
       klass = class_from_registration(node.element_name, ns)
-      event = if klass && klass != self
+      if klass && klass != self
         klass.import node, call_id, component_id
       else
         new.inherit node
-      end
-      event.tap do |event|
+      end.tap do |event|
         event.call_id = call_id
         event.component_id = component_id
       end

data/lib/punchblock/ref.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   ##
   # An rayo Ref message. This provides the command ID in response to execution of a command.

data/lib/punchblock/translator/asterisk/call.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'uri'
 
 module Punchblock
@@ -7,9 +9,10 @@ module Punchblock
         include HasGuardedHandlers
         include Celluloid
 
-        attr_reader :id, :channel, :translator, :agi_env, :direction
+        attr_reader :id, :channel, :translator, :agi_env, :direction, :pending_joins
 
         HANGUP_CAUSE_TO_END_REASON = Hash.new { :error }
+        HANGUP_CAUSE_TO_END_REASON[0] = :hangup
         HANGUP_CAUSE_TO_END_REASON[16] = :hangup
         HANGUP_CAUSE_TO_END_REASON[17] = :busy
         HANGUP_CAUSE_TO_END_REASON[18] = :timeout
@@ -18,11 +21,25 @@ module Punchblock
         HANGUP_CAUSE_TO_END_REASON[22] = :reject
         HANGUP_CAUSE_TO_END_REASON[102] = :timeout
 
-        def initialize(channel, translator, agi_env = '')
+        class << self
+          def parse_environment(agi_env)
+            agi_env_as_array(agi_env).inject({}) do |accumulator, element|
+              accumulator[element[0].to_sym] = element[1] || ''
+              accumulator
+            end
+          end
+
+          def agi_env_as_array(agi_env)
+            URI::Parser.new.unescape(agi_env).encode.split("\n").map { |p| p.split ': ' }
+          end
+        end
+
+        def initialize(channel, translator, agi_env = nil)
           @channel, @translator = channel, translator
-          @agi_env = parse_environment agi_env
+          @agi_env = agi_env || {}
           @id, @components = UUIDTools::UUID.random_create.to_s, {}
           @answered = false
+          @pending_joins = {}
           pb_logger.debug "Starting up call with channel #{channel}, id #{@id}"
         end
 
@@ -89,21 +106,19 @@ module Punchblock
         end
 
         def process_ami_event(ami_event)
-          pb_logger.trace "Processing AMI event #{ami_event.inspect}"
           case ami_event.name
           when 'Hangup'
-            pb_logger.debug "Received a Hangup AMI event. Sending End event."
+            pb_logger.trace "Received a Hangup AMI event. Sending End event."
             send_end_event HANGUP_CAUSE_TO_END_REASON[ami_event['Cause'].to_i]
           when 'AsyncAGI'
-            pb_logger.debug "Received an AsyncAGI event. Looking for matching AGICommand component."
+            pb_logger.trace "Received an AsyncAGI event. Looking for matching AGICommand component."
             if component = component_with_id(ami_event['CommandID'])
-              pb_logger.debug "Found component #{component.id} for event. Forwarding event..."
               component.handle_ami_event! ami_event
             else
-              pb_logger.debug "Could not find component for AMI event: #{ami_event}"
+              pb_logger.warn "Could not find component for AMI event: #{ami_event.inspect}"
             end
           when 'Newstate'
-            pb_logger.debug "Received a Newstate AMI event with state #{ami_event['ChannelState']}: #{ami_event['ChannelStateDesc']}"
+            pb_logger.trace "Received a Newstate AMI event with state #{ami_event['ChannelState']}: #{ami_event['ChannelStateDesc']}"
             case ami_event['ChannelState']
             when '5'
               send_pb_event Event::Ringing.new
@@ -111,6 +126,33 @@ module Punchblock
               @answered = true
               send_pb_event Event::Answered.new
             end
+          when 'BridgeExec'
+            if join_command = pending_joins[ami_event['Channel2']]
+              join_command.response = true
+            end
+          when 'Bridge'
+            other_call_channel = ([ami_event['Channel1'], ami_event['Channel2']] - [channel]).first
+            if other_call = translator.call_for_channel(other_call_channel)
+              event = case ami_event['Bridgestate']
+              when 'Link'
+                Event::Joined.new.tap do |e|
+                  e.other_call_id = other_call.id
+                end
+              when 'Unlink'
+                Event::Unjoined.new.tap do |e|
+                  e.other_call_id = other_call.id
+                end
+              end
+              send_pb_event event
+            end
+          when 'Unlink'
+            other_call_channel = ([ami_event['Channel1'], ami_event['Channel2']] - [channel]).first
+            if other_call = translator.call_for_channel(other_call_channel)
+              event = Event::Unjoined.new.tap do |e|
+                e.other_call_id = other_call.id
+              end
+              send_pb_event event
+            end
           end
           trigger_handler :ami, ami_event
         end
@@ -143,6 +185,13 @@ module Punchblock
             send_ami_action 'Hangup', 'Channel' => channel do |response|
               command.response = true
             end
+          when Command::Join
+            other_call = translator.call_with_id command.other_call_id
+            pending_joins[other_call.channel] = command
+            send_agi_action 'EXEC Bridge', other_call.channel
+          when Command::Unjoin
+            other_call = translator.call_with_id command.other_call_id
+            redirect_back other_call
           when Punchblock::Component::Asterisk::AGI::Command
             execute_component Component::Asterisk::AGICommand, command
           when Punchblock::Component::Output
@@ -155,12 +204,12 @@ module Punchblock
         end
 
         def send_agi_action(command, *params, &block)
-          pb_logger.debug "Sending AGI action #{command}"
+          pb_logger.trace "Sending AGI action #{command}"
           @current_agi_command = Punchblock::Component::Asterisk::AGI::Command.new :name => command, :params => params, :call_id => id
           @current_agi_command.request!
           @current_agi_command.register_handler :internal, Punchblock::Event::Complete do |e|
-            pb_logger.debug "AGI action received complete event #{e.inspect}"
-            block.call e
+            pb_logger.trace "AGI action received complete event #{e.inspect}"
+            block.call e if block
           end
           execute_component Component::Asterisk::AGICommand, @current_agi_command, :internal => true
         end
@@ -168,7 +217,7 @@ module Punchblock
         def send_ami_action(name, headers = {}, &block)
           (name.is_a?(RubyAMI::Action) ? name : RubyAMI::Action.new(name, headers, &block)).tap do |action|
             @current_ami_action = action
-            pb_logger.debug "Sending AMI action #{action.inspect}"
+            pb_logger.trace "Sending AMI action #{action.inspect}"
             translator.send_ami_action! action
           end
         end
@@ -179,9 +228,25 @@ module Punchblock
 
         private
 
+        def redirect_back(other_call = nil)
+          redirect_options = {
+            'Channel'   => channel,
+            'Exten'     => Asterisk::REDIRECT_EXTENSION,
+            'Priority'  => Asterisk::REDIRECT_PRIORITY,
+            'Context'   => Asterisk::REDIRECT_CONTEXT
+          }
+          redirect_options.merge!({
+            'ExtraChannel' => other_call.channel,
+            'ExtraExten'     => Asterisk::REDIRECT_EXTENSION,
+            'ExtraPriority'  => Asterisk::REDIRECT_PRIORITY,
+            'ExtraContext'   => Asterisk::REDIRECT_CONTEXT
+          }) if other_call
+          send_ami_action 'Redirect', redirect_options
+        end
+
         def send_end_event(reason)
           send_pb_event Event::End.new(:reason => reason)
-          current_actor.terminate!
+          after(5) { shutdown }
         end
 
         def execute_component(type, command, options = {})
@@ -194,7 +259,7 @@ module Punchblock
 
         def send_pb_event(event)
           event.call_id = id
-          pb_logger.debug "Sending Punchblock event: #{event.inspect}"
+          pb_logger.trace "Sending Punchblock event: #{event.inspect}"
           translator.handle_pb_event! event
         end
 
@@ -210,17 +275,6 @@ module Punchblock
             accumulator
           end
         end
-
-        def parse_environment(agi_env)
-          agi_env_as_array(agi_env).inject({}) do |accumulator, element|
-            accumulator[element[0].to_sym] = element[1] || ''
-            accumulator
-          end
-        end
-
-        def agi_env_as_array(agi_env)
-          URI.unescape(agi_env).encode.split("\n").map { |p| p.split ': ' }
-        end
       end
     end
   end

data/lib/punchblock/translator/asterisk/component/asterisk/agi_command.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'uri'
 require 'active_support/core_ext/string/filters'
 
@@ -28,7 +30,7 @@ module Punchblock
             end
 
             def parse_agi_result(result)
-              match = URI.decode(result).chomp.match(/^(\d{3}) result=(-?\d*) ?(\(?.*\)?)?$/)
+              match = URI::Parser.new.unescape(result).chomp.match(/^(\d{3}) result=(-?\d*) ?(\(?.*\)?)?$/)
               if match
                 data = match[3] ? match[3].gsub(/(^\()|(\)$)/, '') : nil
                 [match[1].to_i, match[2].to_i, data]

data/lib/punchblock/translator/asterisk/component/asterisk/ami_action.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Translator
     class Asterisk
@@ -55,7 +57,7 @@ module Punchblock
 
             def success_reason(response)
               headers = response.headers
-              headers.merge! @extra_complete_attributes if @extra_complete_attributes
+              headers.merge! @extra_complete_attributes if instance_variable_defined?(:@extra_complete_attributes)
               headers.delete 'ActionID'
               Punchblock::Component::Asterisk::AMI::Action::Complete::Success.new :message => headers.delete('Message'), :attributes => headers
             end

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

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

data/lib/punchblock/translator/asterisk/component/input.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
   module Translator
     class Asterisk
@@ -71,7 +73,7 @@ module Punchblock
           end
 
           def cancel_initial_timer
-            return unless @initial_timer
+            return unless instance_variable_defined?(:@initial_timer) && @initial_timer
             @initial_timer.cancel
             @initial_timer = nil
           end
@@ -90,7 +92,7 @@ module Punchblock
           end
 
           def cancel_inter_digit_timer
-            return unless @inter_digit_timer
+            return unless instance_variable_defined?(:@inter_digit_timer) && @inter_digit_timer
             @inter_digit_timer.cancel
             @inter_digit_timer = nil
           end

data/lib/punchblock/translator/asterisk/component/output.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'active_support/core_ext/string/filters'
 
 module Punchblock
@@ -38,7 +40,11 @@ module Punchblock
 
               send_ref
 
-              @interrupt_digits = '0123456789*#' if [:any, :dtmf].include? @component_node.interrupt_on
+              @interrupt_digits = if [:any, :dtmf].include? @component_node.interrupt_on
+                '0123456789*#'
+              else
+                nil
+              end
 
               @execution_elements.each do |element|
                 element.call
@@ -46,12 +52,20 @@ module Punchblock
                 process_playback_completion
               end
             when :unimrcp
-              doc = @component_node.ssml.to_s.squish.gsub(/["\\]/) { |m| "\\#{m}" }
               send_ref
-              @call.send_agi_action! 'EXEC MRCPSynth', doc, mrcpsynth_options do |complete_event|
+              @call.send_agi_action! 'EXEC MRCPSynth', escaped_doc, mrcpsynth_options do |complete_event|
                 pb_logger.debug "MRCPSynth completed with #{complete_event}."
                 send_complete_event success_reason
               end
+            when :swift
+              doc = escaped_doc
+              doc << "|1|1" if [:any, :dtmf].include? @component_node.interrupt_on
+              doc.insert 0, "#{@component_node.voice}^" if @component_node.voice
+              send_ref
+              @call.send_agi_action! 'EXEC Swift', doc do |complete_event|
+                pb_logger.debug "Swift completed with #{complete_event}."
+                send_complete_event success_reason
+              end
             end
           end
 
@@ -79,6 +93,10 @@ module Punchblock
 
           private
 
+          def escaped_doc
+            @component_node.ssml.to_s.squish.gsub(/["\\]/) { |m| "\\#{m}" }
+          end
+
           def mrcpsynth_options
             [].tap do |opts|
               opts << 'i=any' if [:any, :dtmf].include? @component_node.interrupt_on

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

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

data/lib/punchblock/translator/asterisk.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'celluloid'
 require 'ruby_ami'
 
@@ -13,6 +15,10 @@ module Punchblock
 
       attr_reader :ami_client, :connection, :media_engine, :calls
 
+      REDIRECT_CONTEXT = 'adhearsion-redirect'
+      REDIRECT_EXTENSION = '1'
+      REDIRECT_PRIORITY = '1'
+
       def initialize(ami_client, connection, media_engine = nil)
         pb_logger.debug "Starting up..."
         @ami_client, @connection, @media_engine = ami_client, connection, media_engine
@@ -30,9 +36,7 @@ module Punchblock
       end
 
       def call_for_channel(channel)
-        call = call_with_id @channel_to_call_id[channel]
-        pb_logger.trace "Looking up call for channel #{channel} from #{@channel_to_call_id}. Found: #{call || 'none'}"
-        call
+        call_with_id @channel_to_call_id[channel]
       end
 
       def register_component(component)
@@ -45,37 +49,27 @@ module Punchblock
 
       def shutdown
         pb_logger.debug "Shutting down"
-        @calls.values.each &:shutdown!
+        @calls.values.each(&:shutdown!)
         current_actor.terminate!
       end
 
       def handle_ami_event(event)
         return unless event.is_a? RubyAMI::Event
-        pb_logger.trace "Handling AMI event #{event.inspect}"
+
         if event.name.downcase == "fullybooted"
           pb_logger.trace "Counting FullyBooted event"
           @fully_booted_count += 1
           if @fully_booted_count >= 2
             handle_pb_event Connection::Connected.new
             @fully_booted_count = 0
+            run_at_fully_booted
           end
           return
         end
 
-        if event.name == 'VarSet' && event['Variable'] == 'punchblock_call_id' && (call = call_with_id event['Value'])
-          pb_logger.trace "Received a VarSet event indicating the full channel for call #{call}"
-          @channel_to_call_id.delete call.channel
-          pb_logger.trace "Removed call with old channel from channel map: #{@channel_to_call_id}"
-          call.channel = event['Channel']
-          register_call call
-        end
+        handle_varset_ami_event event
 
-        if call = call_for_channel(event['Channel'])
-          pb_logger.trace "Found call by channel matching this event. Sending to call #{call.id}"
-          call.process_ami_event! event
-        elsif event.name.downcase == "asyncagi" && event['SubEvent'] == "Start"
-          handle_async_agi_start_event event
-        end
+        ami_dispatch_to_or_create_call event
 
         handle_pb_event Event::Asterisk::AMI::Event.new(:name => event.name, :attributes => event.headers)
       end
@@ -85,7 +79,7 @@ module Punchblock
       end
 
       def execute_command(command, options = {})
-        pb_logger.debug "Executing command #{command.inspect}"
+        pb_logger.trace "Executing command #{command.inspect}"
         command.request!
 
         command.call_id ||= options[:call_id]
@@ -135,10 +129,46 @@ module Punchblock
         ami_client.send_action name, headers, &block
       end
 
+      def run_at_fully_booted
+        send_ami_action('Command', {
+          'Command' => "dialplan add extension #{REDIRECT_EXTENSION},#{REDIRECT_PRIORITY},AGI,agi:async into #{REDIRECT_CONTEXT}"
+        })
+        pb_logger.trace "Added extension extension #{REDIRECT_EXTENSION},#{REDIRECT_PRIORITY},AGI,agi:async into #{REDIRECT_CONTEXT}"
+      end
+
       private
 
+      def handle_varset_ami_event(event)
+        return unless event.name == 'VarSet' && event['Variable'] == 'punchblock_call_id' && (call = call_with_id event['Value'])
+
+        pb_logger.trace "Received a VarSet event indicating the full channel for call #{call}"
+        @channel_to_call_id.delete call.channel
+        pb_logger.trace "Removed call with old channel from channel map: #{@channel_to_call_id}"
+        call.channel = event['Channel']
+        register_call call
+      end
+
+      def ami_dispatch_to_or_create_call(event)
+        if (event['Channel'] && call_for_channel(event['Channel'])) ||
+            (event['Channel1'] && call_for_channel(event['Channel1'])) ||
+            (event['Channel2'] && call_for_channel(event['Channel2']))
+          [event['Channel'], event['Channel1'], event['Channel2']].compact.each do |channel|
+            call = call_for_channel channel
+            call.process_ami_event! event if call
+          end
+        elsif event.name.downcase == "asyncagi" && event['SubEvent'] == "Start"
+          handle_async_agi_start_event event
+        end
+      end
+
       def handle_async_agi_start_event(event)
-        call = Call.new event['Channel'], current_actor, event['Env']
+        env = Call.parse_environment event['Env']
+
+        return pb_logger.warn "Ignoring AsyncAGI Start event because it is for an 'h' extension" if env[:agi_extension] == 'h'
+        return pb_logger.warn "Ignoring AsyncAGI Start event because it is for an 'Kill' type" if env[:agi_type] == 'Kill'
+
+        pb_logger.trace "Handling AsyncAGI Start event by creating a new call"
+        call = Call.new event['Channel'], current_actor, env
         register_call call
         call.send_offer!
       end

data/lib/punchblock/translator.rb

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

data/lib/punchblock/version.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Punchblock
-  VERSION = "0.9.2"
+  VERSION = "0.10.0"
 end

data/lib/punchblock.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 %w{
   active_support/dependencies/autoload
   active_support/core_ext/object/blank

data/punchblock.gemspec

@@ -28,11 +28,11 @@ Gem::Specification.new do |s|
   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.1.0"]
-  s.add_runtime_dependency %q<celluloid>, [">= 0.6.0"]
+  s.add_runtime_dependency %q<celluloid>, [">= 0.9.0"]
   s.add_runtime_dependency %q<ruby_ami>, [">= 0.1.3"]
   s.add_runtime_dependency %q<ruby_speech>, [">= 0.5.1"]
 
-  s.add_development_dependency %q<bundler>, ["~> 1.0.0"]
+  s.add_development_dependency %q<bundler>, [">= 1.0.0"]
   s.add_development_dependency %q<rspec>, ["~> 2.7.0"]
   s.add_development_dependency %q<ci_reporter>, [">= 1.6.3"]
   s.add_development_dependency %q<yard>, ["~> 0.6.0"]

data/spec/capture_warnings.rb

@@ -0,0 +1,32 @@
+require 'tempfile'
+stderr_file = Tempfile.new "ahn.stderr"
+$stderr.reopen stderr_file.path
+current_dir = Dir.pwd
+
+at_exit do
+  stderr_file.rewind
+  lines = stderr_file.read.split("\n").uniq
+  stderr_file.close!
+
+  pb_warnings, other_warnings = lines.partition { |line| line.include?(current_dir) && !line.include?('vendor') && line.include?('warning') }
+
+  if pb_warnings.any?
+    puts
+    puts "-" * 30 + " PB Warnings: " + "-" * 30
+    puts
+    puts pb_warnings.join("\n")
+    puts
+    puts "-" * 75
+    puts
+  end
+
+  if other_warnings.any?
+    Dir.mkdir 'tmp' unless Dir.exists? 'tmp'
+    File.open('tmp/warnings.txt', 'w') { |f| f.write other_warnings.join("\n") }
+    puts
+    puts "Non-PB warnings written to tmp/warnings.txt"
+    puts
+  end
+
+  exit 1 if pb_warnings.any? # fail the build...
+end

data/spec/punchblock/client/component_registry_spec.rb

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

data/spec/punchblock/client_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 module Punchblock
@@ -81,7 +83,7 @@ module Punchblock
         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
+            subject.event_queue.pop(true).should be == mock_event
           end
         end
       end

data/spec/punchblock/command/accept_spec.rb

@@ -1,10 +1,12 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 module Punchblock
   module Command
     describe Accept do
       it 'registers itself' do
-        RayoNode.class_from_registration(:accept, 'urn:xmpp:rayo:1').should == Accept
+        RayoNode.class_from_registration(:accept, 'urn:xmpp:rayo:1').should be == Accept
       end
 
       it_should_behave_like 'command_headers'

data/spec/punchblock/command/answer_spec.rb

@@ -1,10 +1,12 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 module Punchblock
   module Command
     describe Answer do
       it 'registers itself' do
-        RayoNode.class_from_registration(:answer, 'urn:xmpp:rayo:1').should == Answer
+        RayoNode.class_from_registration(:answer, 'urn:xmpp:rayo:1').should be == Answer
       end
 
       it_should_behave_like 'command_headers'