punchblock 1.3.0 → 1.4.0

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # [develop](https://github.com/adhearsion/punchblock)
 
+# [v1.4.0](https://github.com/adhearsion/punchblock/compare/v1.3.0...v1.4.0) - [2012-08-07](https://rubygems.org/gems/punchblock/versions/1.4.0)
+  * Feature: FreeSWITCH support (mostly complete, experimental, proceed with caution)
+  * Bugfix: Report the correct caller ID in offers from Asterisk
+  * Bugfix: Strip out caller ID name from dial commands on Asterisk
+
 # [v1.3.0](https://github.com/adhearsion/punchblock/compare/v1.2.0...v1.3.0) - [2012-07-22](https://rubygems.org/gems/punchblock/versions/1.3.0)
   * Change: Asterisk output now uses Playback rather than STREAM FILE
   * Feature: The recordings dir is now checked for existence on startup, and logs an error if it is not there. Asterisk only.

data/lib/punchblock.rb

@@ -44,7 +44,7 @@ module Punchblock
     #
     # Get a new Punchblock client with a connection attached
     #
-    # @param [Symbol] type the connection type (eg :XMPP, :asterisk)
+    # @param [Symbol] type the connection type (eg :XMPP, :asterisk, :freeswitch)
     # @param [Hash] options the options to pass to the connection (credentials, etc
     #
     # @return [Punchblock::Client] a punchblock client object

data/lib/punchblock/connection.rb

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

data/lib/punchblock/connection/asterisk.rb

@@ -15,7 +15,6 @@ module Punchblock
       end
 
       def run
-        pb_logger.debug "Starting the RubyAMI client"
         ami_client.start
         raise DisconnectedError
       end

data/lib/punchblock/connection/freeswitch.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'ruby_fs'
+
+module Punchblock
+  module Connection
+    class Freeswitch < GenericConnection
+      attr_reader :translator, :stream
+      attr_accessor :event_handler
+
+      def initialize(options = {})
+        @translator = Translator::Freeswitch.new self, options[:media_engine], options[:default_voice]
+        @stream_options = options.values_at(:host, :port, :password)
+        @stream = new_fs_stream
+        super()
+      end
+
+      def run
+        pb_logger.debug "Starting the RubyFS stream"
+        start_stream
+        raise DisconnectedError
+      end
+
+      def stop
+        stream.shutdown
+        translator.terminate
+      end
+
+      def write(command, options)
+        translator.execute_command! command, options
+      end
+
+      def handle_event(event)
+        event_handler.call event if event_handler.respond_to?(:call)
+      end
+
+      private
+
+      def new_fs_stream
+        RubyFS::Stream.new(*@stream_options, lambda { |e| translator.handle_es_event! e })
+      end
+
+      def start_stream
+        @stream = new_fs_stream unless @stream.alive?
+        @stream.run
+      end
+    end
+  end
+end

data/lib/punchblock/event/offer.rb

@@ -28,7 +28,7 @@ module Punchblock
       end
 
       def inspect
-        "#<Punchblock::Event::Offer to=\"#{to}\", from=\"#{from}\", call_id=\"#{target_call_id}\""
+        "#<Punchblock::Event::Offer to=\"#{to}\", from=\"#{from}\", headers=#{headers_hash.inspect}, call_id=\"#{target_call_id}\""
       end
     end # Offer
   end

data/lib/punchblock/translator.rb

@@ -4,6 +4,11 @@ module Punchblock
   module Translator
     extend ActiveSupport::Autoload
 
+    OptionError = Class.new Punchblock::Error
+
     autoload :Asterisk
+    autoload :Freeswitch
+
+    autoload :InputComponent
   end
 end

data/lib/punchblock/translator/asterisk.rb

@@ -22,7 +22,6 @@ module Punchblock
       trap_exit :actor_died
 
       def initialize(ami_client, connection, media_engine = nil)
-        pb_logger.debug "Starting up..."
         @ami_client, @connection, @media_engine = ami_client, connection, media_engine
         @calls, @components, @channel_to_call_id = {}, {}, {}
         @fully_booted_count = 0
@@ -55,42 +54,38 @@ module Punchblock
       end
 
       def shutdown
-        pb_logger.debug "Shutting down"
         @calls.values.each(&:shutdown!)
         current_actor.terminate!
       end
 
       def handle_ami_event(event)
-        exclusive do
-          return unless event.is_a? RubyAMI::Event
-
-          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
+        return unless event.is_a? RubyAMI::Event
+
+        if event.name.downcase == "fullybooted"
+          @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
 
-          handle_varset_ami_event event
+        handle_varset_ami_event event
 
-          ami_dispatch_to_or_create_call event
+        ami_dispatch_to_or_create_call event
 
-          unless ami_event_known_call?(event)
-            handle_pb_event Event::Asterisk::AMI::Event.new(:name => event.name, :attributes => event.headers)
-          end
+        unless ami_event_known_call?(event)
+          handle_pb_event Event::Asterisk::AMI::Event.new(:name => event.name, :attributes => event.headers)
         end
       end
+      exclusive :handle_ami_event
 
       def handle_pb_event(event)
         connection.handle_event event
       end
 
       def execute_command(command, options = {})
-        pb_logger.trace "Executing command #{command.inspect}"
         command.request!
 
         command.target_call_id ||= options[:call_id]
@@ -144,7 +139,6 @@ module Punchblock
         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}"
         send_ami_action('Command', {
           'Command' => "dialplan show #{REDIRECT_CONTEXT}"
         }) do |result|
@@ -160,9 +154,7 @@ module Punchblock
 
       def actor_died(actor, reason)
         return unless reason
-        pb_logger.error "A linked actor (#{actor.inspect}) died due to #{reason.inspect}"
         if id = @calls.key(actor)
-          pb_logger.info "Dead actor was a call we know about, with ID #{id}. Removing it from the registry..."
           @calls.delete id
           end_event = Punchblock::Event::End.new :target_call_id  => id,
                                                  :reason          => :error
@@ -175,9 +167,7 @@ module Punchblock
       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
@@ -206,10 +196,8 @@ module Punchblock
       def handle_async_agi_start_event(event)
         env = RubyAMI::AsyncAGIEnvironmentParser.new(event['Env']).to_hash
 
-        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'
+        return if env[:agi_extension] == 'h' || env[:agi_type] == 'Kill'
 
-        pb_logger.trace "Handling AsyncAGI Start event by creating a new call"
         call = Call.new event['Channel'], current_actor, env
         link call
         register_call call

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

@@ -28,7 +28,6 @@ module Punchblock
           @id, @components = Punchblock.new_uuid, {}
           @answered = false
           @pending_joins = {}
-          pb_logger.debug "Starting up call with channel #{channel}, id #{@id}"
           @progress_sent = false
         end
 
@@ -46,7 +45,6 @@ module Punchblock
         end
 
         def shutdown
-          pb_logger.debug "Shutting down"
           current_actor.terminate!
         end
 
@@ -57,10 +55,12 @@ module Punchblock
 
         def dial(dial_command)
           @direction = :outbound
+          channel = dial_command.to || ''
+          channel.match(/.* <(?<channel>.*)>/) { |m| channel = m[:channel] }
           params = { :async       => true,
                      :application => 'AGI',
                      :data        => 'agi:async',
-                     :channel     => dial_command.to,
+                     :channel     => channel,
                      :callerid    => dial_command.from,
                      :variable    => "punchblock_call_id=#{id}"
                    }
@@ -87,13 +87,11 @@ module Punchblock
 
         def send_progress
           return if answered? || outbound? || @progress_sent
-          pb_logger.debug "Sending Progress to start early media"
           @progress_sent = true
           send_agi_action "EXEC Progress"
         end
 
         def channel=(other)
-          pb_logger.info "Channel is changing from #{channel} to #{other}."
           @channel = other
         end
 
@@ -102,7 +100,6 @@ module Punchblock
 
           case ami_event.name
           when 'Hangup'
-            pb_logger.trace "Received a Hangup AMI event. Sending End event."
             @components.dup.each_pair do |id, component|
               safe_from_dead_actors do
                 component.call_ended if component.alive?
@@ -110,14 +107,10 @@ module Punchblock
             end
             send_end_event HANGUP_CAUSE_TO_END_REASON[ami_event['Cause'].to_i]
           when 'AsyncAGI'
-            pb_logger.trace "Received an AsyncAGI event. Looking for matching AGICommand component."
             if component = component_with_id(ami_event['CommandID'])
               component.handle_ami_event ami_event
-            else
-              pb_logger.trace "Could not find component for AMI event: #{ami_event.inspect}"
             end
           when 'Newstate'
-            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
@@ -127,7 +120,6 @@ module Punchblock
             end
           when 'OriginateResponse'
             if ami_event['Response'] == 'Failure' && ami_event['Uniqueid'] == '<null>'
-              pb_logger.info "Outbound call could not be established!"
               send_end_event :error
             end
           when 'BridgeExec'
@@ -162,7 +154,6 @@ module Punchblock
         end
 
         def execute_command(command)
-          pb_logger.debug "Executing command: #{command.inspect}"
           if command.component_id
             if component = component_with_id(command.component_id)
               component.execute_command command
@@ -173,10 +164,8 @@ module Punchblock
           case command
           when Command::Accept
             if outbound?
-              pb_logger.trace "Attempting to accept an outbound call. Skipping RINGING."
               command.response = true
             else
-              pb_logger.trace "Attempting to accept an inbound call. Executing RINGING."
               send_agi_action 'EXEC RINGING' do |response|
                 command.response = true
               end
@@ -231,11 +220,9 @@ module Punchblock
         end
 
         def send_agi_action(command, *params, &block)
-          pb_logger.trace "Sending AGI action #{command}"
           @current_agi_command = Punchblock::Component::Asterisk::AGI::Command.new :name => command, :params => params, :target_call_id => id
           @current_agi_command.request!
           @current_agi_command.register_handler :internal, Punchblock::Event::Complete do |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
@@ -244,7 +231,6 @@ 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.trace "Sending AMI action #{action.inspect}"
             translator.send_ami_action action
           end
         end
@@ -271,9 +257,7 @@ module Punchblock
 
         def actor_died(actor, reason)
           return unless reason
-          pb_logger.error "A linked actor (#{actor.inspect}) died due to #{reason.inspect}"
           if id = @components.key(actor)
-            pb_logger.info "Dead actor was a component we know about, with ID #{id}. Removing it from the registry..."
             @components.delete id
             complete_event = Punchblock::Event::Complete.new :component_id => id, :reason => Punchblock::Event::Complete::Error.new
             send_pb_event complete_event
@@ -298,13 +282,12 @@ module Punchblock
 
         def send_pb_event(event)
           event.target_call_id = id
-          pb_logger.trace "Sending Punchblock event: #{event.inspect}"
           translator.handle_pb_event event
         end
 
         def offer_event
           Event::Offer.new :to      => agi_env.values_at(:agi_dnid, :agi_extension).detect { |e| e && e != 'unknown' },
-                           :from    => "#{agi_env[:agi_calleridname]} <#{[agi_env[:agi_type].downcase, agi_env[:agi_callerid]].join(':')}>",
+                           :from    => "#{agi_env[:agi_calleridname]} <#{[agi_env[:agi_type], agi_env[:agi_callerid]].join('/')}>",
                            :headers => sip_headers
         end
 

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

@@ -13,8 +13,6 @@ module Punchblock
         autoload :StopByRedirect
 
         class Component
-          OptionError = Class.new Punchblock::Error
-
           include Celluloid
           include DeadActorSafety
 
@@ -27,7 +25,6 @@ module Punchblock
             @id = Punchblock.new_uuid
             @complete = false
             setup
-            pb_logger.debug "Starting up..."
           end
 
           def setup
@@ -51,7 +48,6 @@ module Punchblock
           def send_event(event)
             event.component_id    = id
             event.target_call_id  = call_id
-            pb_logger.debug "Sending event #{event}"
             if internal
               @component_node.add_event event
             else
@@ -74,7 +70,6 @@ module Punchblock
           end
 
           def set_node_response(value)
-            pb_logger.debug "Setting response on component node to #{value}"
             @component_node.response = value
           end
 

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

@@ -20,17 +20,14 @@ module Punchblock
             end
 
             def handle_ami_event(event)
-              pb_logger.debug "Handling AMI event: #{event.inspect}"
               if event.name == 'AsyncAGI'
                 if event['SubEvent'] == 'Exec'
-                  pb_logger.debug "Received AsyncAGI:Exec event, sending complete event."
                   send_complete_event success_reason(event)
                 end
               end
             end
 
             def handle_response(response)
-              pb_logger.debug "Handling response: #{response.inspect}"
               case response
               when RubyAMI::Error
                 set_node_response false

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

@@ -24,7 +24,6 @@ module Punchblock
             end
 
             def handle_response(response)
-              pb_logger.debug "Handling response #{response.inspect}"
               case response
               when RubyAMI::Error
                 send_complete_event error_reason(response)

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

@@ -6,114 +6,24 @@ module Punchblock
       module Component
         class Input < Component
 
-          attr_reader :grammar, :buffer
-
-          def setup
-            @buffer = ""
-          end
+          include InputComponent
 
           def execute
             @call.send_progress
-            initial_timeout = @component_node.initial_timeout || -1
-            @inter_digit_timeout = @component_node.inter_digit_timeout || -1
-
-            raise OptionError, 'A grammar document is required.' unless @component_node.grammar
-            raise OptionError, 'A mode value other than DTMF is unsupported on Asterisk.' unless @component_node.mode == :dtmf
-            raise OptionError, 'An initial timeout value that is negative (and not -1) is invalid.' unless initial_timeout >= -1
-            raise OptionError, 'An inter-digit timeout value that is negative (and not -1) is invalid.' unless @inter_digit_timeout >= -1
-
-            send_ref
-
-            @grammar = @component_node.grammar.value.clone
-            grammar.inline!
-            grammar.tokenize!
-            grammar.normalize_whitespace
-
-            begin_initial_timer initial_timeout/1000 unless initial_timeout == -1
-
-            component = current_actor
-
-            @dtmf_handler_id = call.register_handler :ami, :name => 'DTMF' do |event|
-              component.process_dtmf! event['Digit'] if event['End'] == 'Yes'
-            end
-          rescue OptionError => e
-            with_error 'option error', e.message
-          end
-
-          def process_dtmf(digit)
-            pb_logger.trace "Processing incoming DTMF digit #{digit}"
-            buffer << digit
-            cancel_initial_timer
-            case (match = grammar.match buffer.dup)
-            when RubySpeech::GRXML::Match
-              pb_logger.trace "Found a match against buffer #{buffer}"
-              complete success_reason(match)
-            when RubySpeech::GRXML::NoMatch
-              pb_logger.trace "Buffer #{buffer} does not match grammar"
-              complete Punchblock::Component::Input::Complete::NoMatch.new
-            when RubySpeech::GRXML::PotentialMatch
-              pb_logger.trace "Buffer #{buffer} potentially matches grammar. Waiting..."
-              reset_inter_digit_timer
-            end
-          end
-
-          def execute_command(command)
-            case command
-            when Punchblock::Component::Stop
-              command.response = true
-              complete Punchblock::Event::Complete::Stop.new
-            else
-              super
-            end
+            super
           end
 
           private
 
-          def begin_initial_timer(timeout)
-            pb_logger.trace "Setting initial timer for #{timeout} seconds"
-            @initial_timer = after timeout do
-              pb_logger.trace "Initial timer expired."
-              complete Punchblock::Component::Input::Complete::NoInput.new
-            end
-          end
-
-          def cancel_initial_timer
-            return unless instance_variable_defined?(:@initial_timer) && @initial_timer
-            @initial_timer.cancel
-            @initial_timer = nil
-          end
-
-          def reset_inter_digit_timer
-            return if @inter_digit_timeout == -1
-            @inter_digit_timer ||= begin
-              pb_logger.trace "Setting inter-digit timer for #{@inter_digit_timeout/1000} seconds"
-              after @inter_digit_timeout/1000 do
-                pb_logger.trace "Inter digit-timer expired."
-                complete Punchblock::Component::Input::Complete::NoMatch.new
-              end
+          def register_dtmf_event_handler
+            component = current_actor
+            call.register_handler :ami, :name => 'DTMF' do |event|
+              component.process_dtmf! event['Digit'] if event['End'] == 'Yes'
             end
-            pb_logger.trace "Resetting inter-digit timer"
-            @inter_digit_timer.reset
-          end
-
-          def cancel_inter_digit_timer
-            return unless instance_variable_defined?(:@inter_digit_timer) && @inter_digit_timer
-            @inter_digit_timer.cancel
-            @inter_digit_timer = nil
-          end
-
-          def success_reason(match)
-            Punchblock::Component::Input::Complete::Success.new :mode           => match.mode,
-                                                                :confidence     => match.confidence,
-                                                                :utterance      => match.utterance,
-                                                                :interpretation => match.interpretation
           end
 
-          def complete(reason)
+          def unregister_dtmf_event_handler
             call.unregister_handler :ami, @dtmf_handler_id if instance_variable_defined?(:@dtmf_handler_id)
-            cancel_initial_timer
-            cancel_inter_digit_timer
-            send_complete_event reason
           end
         end
       end