adhearsion 2.0.1 → 2.1.0

data/lib/adhearsion/call_controller/output/abstract_player.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module Adhearsion
+  class CallController
+    module Output
+      class AbstractPlayer
+
+        attr_accessor :controller
+
+        def initialize(controller)
+          @controller = controller
+        end
+
+        def play_ssml(ssml, options = {})
+          if [RubySpeech::SSML::Speak, Nokogiri::XML::Document].include? ssml.class
+            output ssml, options
+          end
+        end
+
+        def play_ssml_for(*args)
+          play_ssml Formatter.ssml_for(args)
+        end
+
+        def new_output(options)
+          Punchblock::Component::Output.new options
+        end
+      end
+    end
+  end
+end

data/lib/adhearsion/call_controller/output/async_player.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module Adhearsion
+  class CallController
+    module Output
+      class AsyncPlayer < AbstractPlayer
+
+        #
+        # @yields The output component before executing it
+        # @raises [PlaybackError] if (one of) the given argument(s) could not be played
+        #
+        def output(content, options = {})
+          options.merge! :ssml => content.to_s
+          component = new_output options
+          component.register_event_handler Punchblock::Event::Complete do |event|
+            controller.logger.error event if event.reason.is_a?(Punchblock::Event::Complete::Error)
+          end
+          controller.write_and_await_response component
+          component
+        rescue Punchblock::ProtocolError => e
+          raise PlaybackError, "Async output failed due to #{e.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/adhearsion/call_controller/output/formatter.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+
+module Adhearsion
+  class CallController
+    module Output
+      module Formatter
+
+        class << self
+          def ssml_for_collection(collection)
+            collection.inject RubySpeech::SSML::Speak.new do |doc, argument|
+              doc + case argument
+              when Hash
+                Formatter.ssml_for argument.delete(:value), argument
+              when RubySpeech::SSML::Speak
+                argument
+              else
+                Formatter.ssml_for argument
+              end
+            end
+          end
+
+          def detect_type(output)
+            result = nil
+            result = :time if [Date, Time, DateTime].include? output.class
+            result = :numeric if output.kind_of?(Numeric) || output =~ /^\d+$/
+            result = :audio if !result && (/^\//.match(output.to_s) || URI::regexp.match(output.to_s))
+            result ||= :text
+          end
+
+          #
+          # Generates SSML for the argument and options passed, using automatic detection
+          # Directly returns the argument if it is already an SSML document
+          #
+          # @param [String, Hash, RubySpeech::SSML::Speak] the argument with options as accepted by the play_ methods, or an SSML document
+          # @return [RubySpeech::SSML::Speak] an SSML document
+          #
+          def ssml_for(*args)
+            return args[0] if args.size == 1 && args[0].is_a?(RubySpeech::SSML::Speak)
+            argument, options = args.flatten
+            options ||= {}
+            type = detect_type argument
+            send "ssml_for_#{type}", argument, options
+          end
+
+          def ssml_for_text(argument, options = {})
+            RubySpeech::SSML.draw { argument }
+          end
+
+          def ssml_for_time(argument, options = {})
+            interpretation = case argument
+            when Date then 'date'
+            when Time then 'time'
+            end
+
+            format = options.delete :format
+            strftime = options.delete :strftime
+
+            time_to_say = strftime ? argument.strftime(strftime) : argument.to_s
+
+            RubySpeech::SSML.draw do
+              say_as(:interpret_as => interpretation, :format => format) { time_to_say }
+            end
+          end
+
+          def ssml_for_numeric(argument, options = {})
+            RubySpeech::SSML.draw do
+              say_as(:interpret_as => 'cardinal') { argument.to_s }
+            end
+          end
+
+          def ssml_for_audio(argument, options = {})
+            fallback = (options || {}).delete :fallback
+            RubySpeech::SSML.draw do
+              audio(:src => argument) { fallback }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adhearsion/call_controller/output/player.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Adhearsion
+  class CallController
+    module Output
+      class Player < AbstractPlayer
+
+        #
+        # @yields The output component before executing it
+        # @raises [PlaybackError] if (one of) the given argument(s) could not be played
+        #
+        def output(content, options = {})
+          options.merge! :ssml => content.to_s
+          component = new_output options
+          yield component if block_given?
+          controller.execute_component_and_await_completion component
+        rescue Call::Hangup
+          raise
+        rescue Adhearsion::Error, Punchblock::ProtocolError => e
+          raise PlaybackError, "Output failed due to #{e.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/adhearsion/call_controller/record.rb

@@ -26,22 +26,39 @@ module Adhearsion
       # @option options [String, Optional] :format File format used during recording.
       # @option options [String, Optional] :initial_timeout Controls how long (milliseconds) the recognizer should wait after the end of the prompt for the caller to speak before sending a Recorder event.
       # @option options [String, Optional] :final_timeout Controls the length (milliseconds) of a period of silence after callers have spoken to conclude they finished.
+      # @option options [Boolean, Optional] :interruptible Allows the recording to be terminated by any single DTMF key, default is false
       #
       # @return Punchblock::Component::Record
       #
       def record(options = {})
         async = options.delete :async
+        interruptible = options.delete :interruptible
+        interrupt_key = '0123456789#*'
+        stopper_component = nil
 
-        component = ::Punchblock::Component::Record.new options
-        component.register_event_handler ::Punchblock::Event::Complete do |event|
+        component = Punchblock::Component::Record.new options
+        component.register_event_handler Punchblock::Event::Complete do |event|
           catching_standard_errors { yield event if block_given? }
         end
 
+        if interruptible
+          stopper_component = Punchblock::Component::Input.new :mode => :dtmf,
+            :grammar => {
+              :value => grammar_accept(interrupt_key)
+            }
+          stopper_component.register_event_handler Punchblock::Event::Complete do |event|
+            component.stop! unless component.complete?
+          end
+          write_and_await_response stopper_component
+        end
+
         if async
           write_and_await_response component
         else
           execute_component_and_await_completion component
         end
+        stopper_component.stop! if stopper_component && stopper_component.executing?
+        component
       end
     end
   end

data/lib/adhearsion/events.rb

@@ -1,5 +1,8 @@
 # encoding: utf-8
 
+require 'has_guarded_handlers'
+require 'girl_friday'
+
 module Adhearsion
   class Events
 

data/lib/adhearsion/foundation.rb

@@ -1,9 +1,15 @@
 # encoding: utf-8
 
-require 'English'
-require 'tmpdir'
-require 'tempfile'
+%w{
+  English
+  tmpdir
+  tempfile
+}.each { |f| require f }
 
-Dir.glob File.join(File.dirname(__FILE__), 'foundation', "*rb") do |file|
-  require file
-end
+%w{
+  custom_daemonizer
+  exception_handler
+  libc
+  object
+  thread_safety
+}.each { |f| require "adhearsion/foundation/#{f}" }

data/lib/adhearsion/foundation/exception_handler.rb

@@ -1,11 +1,13 @@
 # encoding: utf-8
 
-class Object
+module Adhearsion::Safely
   def catching_standard_errors(l = logger, &block)
-    begin
-      yield
-    rescue StandardError => e
-      Adhearsion::Events.trigger :exception, [e, l]
-    end
+    yield
+  rescue StandardError => e
+    Adhearsion::Events.trigger :exception, [e, l]
   end
 end
+
+class Object
+  include Adhearsion::Safely
+end

data/lib/adhearsion/generators/app/templates/README.md

@@ -15,6 +15,19 @@ and setup a user in `manager.conf` with read/write access to `all`.
 
 If you are using Asterisk 1.8, you will need to add an additional context with the name `adhearsion-redirect`. On Asterisk 10 and above this is auto-provisioned.
 
+## FreeSWITCH
+
+* Ensure that mod_event_socket is installed, and configure it in autoload_configs/event_socket.conf.xml to taste
+* Add an extension to your dialplan like so:
+
+```xml
+<extension name='Adhearsion'>
+  <condition field="destination_number" expression="^10$">
+    <action application='park'/>
+  </condition>
+</extension>
+```
+
 ## Voxeo PRISM
 
 Install the [rayo-server](https://github.com/rayo/rayo-server) app into PRISM 11 and follow the [configuration guide](https://github.com/rayo/rayo-server/wiki/Single-node-and-cluster-configuration-reference).

data/lib/adhearsion/generators/app/templates/config/adhearsion.rb

@@ -34,7 +34,13 @@ Adhearsion.config do |config|
   # config.punchblock.username = "" # Your AMI username
   # config.punchblock.password = "" # Your AMI password
   # config.punchblock.host = "127.0.0.1" # Your AMI host
-  # config.punchblock.port = 5038 # Your AMI port
+
+  ##
+  # Use with FreeSWITCH
+  #
+  # config.punchblock.platform = :freeswitch # Use FreeSWITCH
+  # config.punchblock.password = "" # Your Inbound EventSocket password
+  # config.punchblock.host = "127.0.0.1" # Your IES host
 end
 
 Adhearsion::Events.draw do

data/lib/adhearsion/generators/plugin/plugin_generator.rb

@@ -12,6 +12,7 @@ module Adhearsion
 
       def create_plugin
         @plugin_file = @plugin_name.underscore
+        @plugin_name = @plugin_name.camelize
         self.destination_root = '.'
 
         empty_directory @plugin_file

data/lib/adhearsion/generators/plugin/templates/plugin-template.gemspec.tt

@@ -20,15 +20,11 @@ Gem::Specification.new do |s|
   s.test_files    = Dir.glob("{spec}/**/*")
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency %q<adhearsion>, [">= <%= Adhearsion::VERSION %>"]
+  s.add_runtime_dependency %q<adhearsion>, ["~> <%= Adhearsion::VERSION.split('.')[0..1].join('.') %>"]
   s.add_runtime_dependency %q<activesupport>, [">= 3.0.10"]
 
-  s.add_development_dependency %q<bundler>, ["~> 1.0.0"]
-  s.add_development_dependency %q<rspec>, [">= 2.5.0"]
-  s.add_development_dependency %q<ci_reporter>, [">= 1.6.3"]
-  s.add_development_dependency %q<simplecov>, [">= 0"]
-  s.add_development_dependency %q<simplecov-rcov>, [">= 0"]
-  s.add_development_dependency %q<yard>, ["~> 0.6.0"]
+  s.add_development_dependency %q<bundler>, ["~> 1.0"]
+  s.add_development_dependency %q<rspec>, ["~> 2.5"]
   s.add_development_dependency %q<rake>, [">= 0"]
   s.add_development_dependency %q<mocha>, [">= 0"]
   s.add_development_dependency %q<guard-rspec>

data/lib/adhearsion/generators/plugin/templates/spec/spec_helper.rb.tt

@@ -1,5 +1,4 @@
 require 'adhearsion'
-require 'mocha'
 require '<%= @plugin_file %>'
 
 RSpec.configure do |config|

data/lib/adhearsion/outbound_call.rb

@@ -7,9 +7,9 @@ module Adhearsion
     delegate :to, :from, :to => :dial_command, :allow_nil => true
 
     class << self
-      def originate(to, opts = {})
+      def originate(to, opts = {}, &controller_block)
         new.tap do |call|
-          call.run_router_on_answer
+          call.execute_controller_or_router_on_answer opts.delete(:controller), &controller_block
           call.dial to, opts
         end
       end
@@ -33,7 +33,8 @@ module Adhearsion
     end
 
     def dial(to, options = {})
-      options.merge! :to => to
+      options = options.dup
+      options[:to] = to
       if options[:timeout]
         wait_timeout = options[:timeout]
         options[:timeout] = options[:timeout] * 1000
@@ -55,17 +56,26 @@ module Adhearsion
     end
 
     def run_router_on_answer
-      register_event_handler :class => Punchblock::Event::Answered do |event|
+      register_event_handler Punchblock::Event::Answered do |event|
         run_router
         throw :pass
       end
     end
 
     def on_answer(&block)
-      register_event_handler :class => Punchblock::Event::Answered do |event|
+      register_event_handler Punchblock::Event::Answered do |event|
         block.call event
         throw :pass
       end
     end
+
+    def execute_controller_or_router_on_answer(controller, &controller_block)
+      if controller || controller_block
+        route = Router::Route.new 'inbound', controller, &controller_block
+        on_answer { route.dispatch current_actor }
+      else
+        run_router_on_answer
+      end
+    end
   end
 end

data/lib/adhearsion/punchblock_plugin.rb

@@ -11,11 +11,12 @@ module Adhearsion
         Platform punchblock shall use to connect to the Telephony provider. Currently supported values:
         - :xmpp
         - :asterisk
+        - :freeswitch
       __
       username            "usera@127.0.0.1", :desc => "Authentication credentials"
       password            "1"              , :desc => "Authentication credentials"
-      host                nil              , :desc => "Host punchblock needs to connect (where rayo or asterisk are located)"
-      port                nil              , :transform => Proc.new { |v| PunchblockPlugin.validate_number v }, :desc => "Port punchblock needs to connect (by default 5038 for Asterisk, 5222 for Rayo)"
+      host                nil              , :desc => "Host punchblock needs to connect (where rayo/asterisk/freeswitch is located)"
+      port                Proc.new { PunchblockPlugin.default_port_for_platform platform }, :transform => Proc.new { |v| PunchblockPlugin.validate_number v }, :desc => "Port punchblock needs to connect"
       root_domain         nil              , :desc => "The root domain at which to address the server"
       calls_domain        nil              , :desc => "The domain at which to address calls"
       mixers_domain       nil              , :desc => "The domain at which to address mixers"
@@ -23,6 +24,7 @@ module Adhearsion
       reconnect_attempts  1.0/0.0          , :transform => Proc.new { |v| PunchblockPlugin.validate_number v }, :desc => "The number of times to (re)attempt connection to the server"
       reconnect_timer     5                , :transform => Proc.new { |v| PunchblockPlugin.validate_number v }, :desc => "Delay between connection attempts"
       media_engine        nil              , :transform => Proc.new { |v| v.to_sym }, :desc => "The media engine to use. Defaults to platform default."
+      default_voice       nil              , :transform => Proc.new { |v| v.to_sym }, :desc => "The default TTS voice to use."
     end
 
     init :punchblock do
@@ -42,6 +44,15 @@ module Adhearsion
         value.to_i
       end
 
+      def default_port_for_platform(platform)
+        case platform
+          when :freeswitch then 8021
+          when :asterisk then 5038
+          when :xmpp then 5222
+          else nil
+        end
+      end
+
       def execute_component(command, timeout = 60)
         client.execute_command command, :async => true
         response = command.response timeout

data/lib/adhearsion/punchblock_plugin/initializer.rb

@@ -19,9 +19,11 @@ module Adhearsion
             username = Blather::JID.new username
             username = Blather::JID.new username.node, username.domain, resource unless username.resource
             username = username.to_s
-            ::Punchblock::Connection::XMPP
+            Punchblock::Connection::XMPP
           when :asterisk
-            ::Punchblock::Connection::Asterisk
+            Punchblock::Connection::Asterisk
+          when :freeswitch
+            Punchblock::Connection::Freeswitch
           end
 
           connection_options = {
@@ -33,11 +35,12 @@ module Adhearsion
             :root_domain        => self.config.root_domain,
             :calls_domain       => self.config.calls_domain,
             :mixers_domain      => self.config.mixers_domain,
-            :media_engine       => self.config.media_engine
+            :media_engine       => self.config.media_engine,
+            :default_voice      => self.config.default_voice
           }
 
           self.connection = connection_class.new connection_options
-          self.client = ::Punchblock::Client.new :connection => connection
+          self.client = Punchblock::Client.new :connection => connection
 
           # Tell the Punchblock connection that we are ready to process calls.
           Events.register_callback :after_initialization do
@@ -60,12 +63,12 @@ module Adhearsion
             handle_event event
           end
 
-          Events.punchblock ::Punchblock::Connection::Connected do |event|
+          Events.punchblock Punchblock::Connection::Connected do |event|
             logger.info "Connected to Punchblock server"
             self.attempts = 0
           end
 
-          Events.punchblock ::Punchblock::Event::Offer do |offer|
+          Events.punchblock Punchblock::Event::Offer do |offer|
             dispatch_offer offer
           end
 
@@ -87,7 +90,7 @@ module Adhearsion
           m = Mutex.new
           blocker = ConditionVariable.new
 
-          Events.punchblock ::Punchblock::Connection::Connected do
+          Events.punchblock Punchblock::Connection::Connected do
             Adhearsion::Process.booted
             m.synchronize { blocker.broadcast }
           end
@@ -109,7 +112,7 @@ module Adhearsion
           begin
             logger.info "Starting connection to server"
             client.run
-          rescue ::Punchblock::DisconnectedError => e
+          rescue Punchblock::DisconnectedError => e
             # We only care about disconnects if the process is up or booting
             return unless [:booting, :running].include? Adhearsion::Process.state_name
 
@@ -126,7 +129,7 @@ module Adhearsion
             logger.error "Connection lost. Attempting reconnect #{self.attempts} of #{self.config.reconnect_attempts}"
             sleep self.config.reconnect_timer
             retry
-          rescue ::Punchblock::ProtocolError => e
+          rescue Punchblock::ProtocolError => e
             logger.fatal "The connection failed due to a protocol error: #{e.name}."
             raise e
           end
@@ -140,9 +143,7 @@ module Adhearsion
               logger.info "Declining call because the process is not yet running."
               call.reject :decline
             when :running
-              call.accept
-              dispatcher = Adhearsion.router.handle call
-              dispatcher.call call
+              Adhearsion.router.handle call
             else
               call.reject :error
             end