adhearsion 2.2.1 → 2.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14d65bdfc20111980b8445acf33c5a6d18ba166a
+  data.tar.gz: c10a07432dec071a4cdcf8e508517c4e2717cf62
+SHA512:
+  metadata.gz: 2ecd96983d91e8e5da635158cb07537b18179958ea3e148c37086d4ab8e8b0099b3237407bae8aa33d644bef1ae0db7592ea083be58a7296bd7963716505131b
+  data.tar.gz: 3d2f040a64a072c7271690b5582e476b35e7449d7ce92be633e06bf0beb554853333e684efaec6db371a4a786eda5cb70f9f0abb6b47d42c869b81c2e86114dc

data/.travis.yml

@@ -9,6 +9,7 @@ rvm:
 matrix:
   allow_failures:
     - rvm: rbx-19mode
+    - rvm: ruby-head
 env: ARUBA_TIMEOUT=120 RAILS_ENV=development AHN_ENV=development
 notifications:
   irc: "irc.freenode.org#adhearsion"

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # [develop](https://github.com/adhearsion/adhearsion)
 
+# [2.3.0](https://github.com/adhearsion/adhearsion/compare/v2.2.1...v2.3.0) - [2013-03-25](https://rubygems.org/gems/adhearsion/versions/2.3.0)
+  * Feature: Allow specifying a renderer per invocation of `#menu`, `#interruptible_play`, `#ask`, `#play` and `#play!`
+
+    ```ruby
+    play 'tt-monkeys', renderer: :native
+    ```
+
+  * Feature: Make it possible to disable punchblock connection by way of settings
+  * Feature: Allow specifying exact input digits to recognize for interrupting a recording
+  * Bugfix: Run input validations before length check so we always return the more appropriate response
+  * Bugfix: Plugin initializers now run in the context of the plugin class, not nil
+  * Bugfix: Write PID without race conditions (#266)
+  * CS: Prevent Celluloid deprecation warnings
+
 # [2.2.1](https://github.com/adhearsion/adhearsion/compare/v2.2.0...v2.2.1) - [2013-01-06](https://rubygems.org/gems/adhearsion/versions/2.2.1)
   * Bugfix: No longer crash logging randomly
   * Bugfix: Correctly route outbound calls

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec

data/README.markdown

@@ -17,7 +17,7 @@ Adhearsion rests above a lower-level telephony platform, for example [Asterisk](
 
 ## Requirements
 
-* Ruby 1.9.2+ or JRuby 1.6.7+
+* Ruby 1.9.2+ or JRuby 1.7.0+
 * A VoIP platform:
   * Asterisk 1.8+
   * FreeSWITCH
@@ -61,7 +61,7 @@ Original author: [Jay Phillips](https://github.com/jicksta)
 
 ### Contributions
 
-Adhearsion has a set of [contribution guidelines](https://github.com/adhearsion/adhearsion/wiki/Contributing) which help to smooth the contribution process.
+Adhearsion has a set of [contribution guidelines](http://adhearsion.com/docs/contributing) which help to smooth the contribution process.
 There is a pre-commit hook that runs encoding checks available in pre-commit. To use it, please copy it to .git/hooks/pre-commit and make it executable.
 
 ### Copyright

data/adhearsion.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'activesupport', ["~> 3.0"]
   s.add_runtime_dependency 'adhearsion-loquacious', ["~> 1.9"]
   s.add_runtime_dependency 'bundler', ["~> 1.0"]
-  s.add_runtime_dependency 'celluloid', ["~> 0.12", ">= 0.12.1"]
+  s.add_runtime_dependency 'celluloid', ["~> 0.13"]
   s.add_runtime_dependency 'countdownlatch'
   s.add_runtime_dependency 'deep_merge'
   s.add_runtime_dependency 'ffi', ["~> 1.0"]

data/features/app_generator.feature

@@ -42,7 +42,7 @@ Feature: Adhearsion App Generator
     And the file "Rakefile" should contain "adhearsion/tasks"
     And the file "Gemfile" should contain each of these content parts:
     """
-    source :rubygems
+    source 'https://rubygems.org
     gem 'adhearsion-asterisk'
     """
     And the file "lib/simon_game.rb" should contain "class SimonGame"

data/lib/adhearsion/call.rb

@@ -135,7 +135,7 @@ module Adhearsion
         clear_from_active_calls
         @end_reason = event.reason
         commands.terminate
-        after(Adhearsion.config.platform.after_hangup_lifetime) { current_actor.terminate! }
+        after(Adhearsion.config.platform.after_hangup_lifetime) { terminate }
         throw :pass
       end
     end

data/lib/adhearsion/call_controller.rb

@@ -101,7 +101,7 @@ module Adhearsion
 
     # @private
     def execute!(*options)
-      call.register_controller! self
+      call.async.register_controller self
       execute_callbacks :before_call
       run
     rescue Call::Hangup
@@ -125,6 +125,7 @@ module Adhearsion
     #
     # @param [Class] controller_class The class of controller to execute
     # @param [Hash] metadata generic key-value storage applicable to the controller
+    # @return The return value of the controller's run method
     #
     def invoke(controller_class, metadata = nil)
       controller = controller_class.new call, metadata

data/lib/adhearsion/call_controller/input.rb

@@ -188,9 +188,9 @@ module Adhearsion
         digit = nil
         if sound_files.any? && menu_instance.digit_buffer_empty?
           if menu_instance.interruptible
-            digit = interruptible_play(*sound_files)
+            digit = interruptible_play(*sound_files, renderer: menu_instance.renderer)
           else
-            play(*sound_files)
+            play(*sound_files, renderer: menu_instance.renderer)
           end
         end
         digit || wait_for_digit(menu_instance.timeout)

data/lib/adhearsion/call_controller/menu_dsl/menu.rb

@@ -11,7 +11,7 @@ module Adhearsion
 
         InvalidStructureError = Class.new Adhearsion::Error
 
-        attr_reader :builder, :timeout, :tries_count, :max_number_of_tries, :terminator, :limit, :interruptible, :status
+        attr_reader :builder, :timeout, :tries_count, :max_number_of_tries, :terminator, :limit, :interruptible, :status, :renderer
 
         def initialize(options = {}, &block)
           @tries_count          = 0 # Counts the number of tries the menu's been executed
@@ -22,6 +22,7 @@ module Adhearsion
           @interruptible        = options.has_key?(:interruptible) ? options[:interruptible] : true
           @builder              = MenuDSL::MenuBuilder.new
           @terminated           = false
+          @renderer             = options[:renderer]
 
           @builder.build(&block) if block
 
@@ -62,9 +63,8 @@ module Adhearsion
           return get_another_digit_or_timeout! if digit_buffer_empty?
 
           return menu_terminated! if @terminated
-          return menu_limit_reached! if limit && digit_buffer.size >= limit
-
           return menu_validator_terminated! if execute_validator_hook
+          return menu_limit_reached! if limit && digit_buffer.size >= limit
 
           calculated_matches = builder.calculate_matches_for digit_buffer_string
 

data/lib/adhearsion/call_controller/output.rb

@@ -61,7 +61,8 @@ module Adhearsion
       # @raises [PlaybackError] if (one of) the given argument(s) could not be played
       #
       def play(*arguments)
-        player.play_ssml output_formatter.ssml_for_collection(arguments)
+        options = process_output_options arguments
+        player.play_ssml output_formatter.ssml_for_collection(arguments), options
         true
       end
 
@@ -89,7 +90,8 @@ module Adhearsion
       # @returns [Punchblock::Component::Output]
       #
       def play!(*arguments)
-        async_player.play_ssml output_formatter.ssml_for_collection(arguments)
+        options = process_output_options arguments
+        async_player.play_ssml output_formatter.ssml_for_collection(arguments), options
       end
 
       #
@@ -98,13 +100,15 @@ module Adhearsion
       # The Punchblock backend will have to handle cases like Asterisk where there is a fixed sounds directory.
       #
       # @param [String] file http:// URL or full disk path to the sound file
-      # @param [Hash] options Additional options to specify how exactly to say time specified.
+      # @param [Hash] options Additional options
       # @option options [String] :fallback The text to play if the file is not available
+      # @option options [Symbol] :renderer The media engine to use for rendering the file
       #
       # @raises [PlaybackError] if (one of) the given argument(s) could not be played
       #
-      def play_audio(file, options = nil)
-        player.play_ssml output_formatter.ssml_for_audio(file, options)
+      def play_audio(file, options = {})
+        renderer = options.delete :renderer
+        player.play_ssml(output_formatter.ssml_for_audio(file, options), renderer: renderer)
         true
       end
 
@@ -120,8 +124,9 @@ module Adhearsion
       # @raises [PlaybackError] if (one of) the given argument(s) could not be played
       # @returns [Punchblock::Component::Output]
       #
-      def play_audio!(file, options = nil)
-        async_player.play_ssml output_formatter.ssml_for_audio(file, options)
+      def play_audio!(file, options = {})
+        renderer = options.delete :renderer
+        async_player.play_ssml(output_formatter.ssml_for_audio(file, options), renderer: renderer)
       end
 
       #
@@ -214,8 +219,9 @@ module Adhearsion
       # @raises [PlaybackError] if (one of) the given argument(s) could not be played
       #
       def interruptible_play(*outputs)
+        options = process_output_options outputs 
         outputs.find do |output|
-          digit = stream_file output
+          digit = stream_file output, '0123456789#*', options
           return digit if digit
         end
       end
@@ -229,14 +235,14 @@ module Adhearsion
       # @return [String, nil] The pressed digit, or nil if nothing was pressed
       # @private
       #
-      def stream_file(argument, digits = '0123456789#*')
+      def stream_file(argument, digits = '0123456789#*', output_options = {})
         result = nil
         stopper = Punchblock::Component::Input.new :mode => :dtmf,
           :grammar => {
             :value => grammar_accept(digits)
           }
 
-        player.output output_formatter.ssml_for(argument) do |output_component|
+        player.output output_formatter.ssml_for(argument), output_options do |output_component|
           stopper.register_event_handler Punchblock::Event::Complete do |event|
             output_component.stop! unless output_component.complete?
           end
@@ -259,6 +265,11 @@ module Adhearsion
         @async_player ||= AsyncPlayer.new(self)
       end
 
+      # @private
+      def process_output_options(arguments)
+        arguments.last.is_a?(Hash) && arguments.count > 1 ? arguments.pop : {}
+      end
+
       #
       # @return [Formatter] an output formatter for the preparation of SSML documents for submission to the engine
       #

data/lib/adhearsion/call_controller/record.rb

@@ -29,7 +29,8 @@ module Adhearsion
 
           @async = options.delete :async
 
-          @stopper_component  = options.delete(:interruptible) ? setup_stopper : nil
+          interruptible = options.delete :interruptible
+          @stopper_component  = interruptible ? setup_stopper(interruptible) : nil
           @record_component   = Punchblock::Component::Record.new options
         end
 
@@ -56,10 +57,11 @@ module Adhearsion
 
         private
 
-        def setup_stopper
+        def setup_stopper(interrupt_digits)
+          interrupt_digits = interrupt_digits == true ? '0123456789#*' : interrupt_digits.to_s
           @stopper_component = Punchblock::Component::Input.new :mode => :dtmf,
             :grammar => {
-              :value => @controller.grammar_accept('0123456789#*')
+              :value => @controller.grammar_accept(interrupt_digits)
             }
           @stopper_component.register_event_handler Punchblock::Event::Complete do |event|
             @record_component.stop! unless @record_component.complete?
@@ -112,7 +114,7 @@ module Adhearsion
       # @option options [String, Optional] :format File format used during recording.
       # @option options [String, Optional] :initial_timeout Controls how long (seconds) 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 (seconds) 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
+      # @option options [Boolean, String, Optional] :interruptible Allows the recording to be terminated by any single DTMF key, default is false
       #
       # @return Punchblock::Component::Record
       #

data/lib/adhearsion/foundation/custom_daemonizer.rb

@@ -8,7 +8,7 @@ module Adhearsion
 
     # Try to fork if at all possible retrying every 5 sec if the
     # maximum process limit for the system has been reached
-    def safefork
+    def self.safefork
       begin
         pid = fork
         return pid if pid
@@ -19,18 +19,25 @@ module Adhearsion
     end
 
     # This method causes the current running process to become a daemon
-    def daemonize(log_file = '/dev/null')
-      oldmode = 0
+    def self.daemonize(log_file = '/dev/null')
       srand # Split rand streams between spawning and daemonized process
-      safefork and exit # Fork and exit from the parent
+
+      # Fork, then exit when the child has exited below
+      if pid = safefork
+        ::Process.wait pid
+        exit
+      end
 
       # Detach from the controlling terminal
       raise 'Cannot detach from controlled terminal' unless sess_id = ::Process.setsid
 
       # Prevent the possibility of acquiring a controlling terminal
-      if oldmode.zero?
-        trap 'SIGHUP', 'IGNORE'
-        exit if safefork
+      # Fork again, allow a PID file to be written, then exit
+      trap 'SIGHUP', 'IGNORE'
+
+      if pid = safefork
+        yield pid if block_given?
+        exit
       end
 
       Dir.chdir "/"   # Release old working directory
@@ -39,7 +46,7 @@ module Adhearsion
       STDIN.reopen "/dev/null"
       STDOUT.reopen '/dev/null', "a"
       STDERR.reopen log_file, "a"
-      oldmode ? sess_id : 0
+      return sess_id
     end
   end
 end

data/lib/adhearsion/generators/app/templates/Gemfile.erb

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gem "adhearsion", "~> <%= Adhearsion::VERSION.split('.')[0,2].join('.') %>"
 

data/lib/adhearsion/initializer.rb

@@ -42,13 +42,18 @@ module Adhearsion
       load_lib_folder
       load_config_file
       initialize_log_paths
-      daemonize! if should_daemonize?
+
+      if should_daemonize?
+        daemonize!
+      else
+        create_pid_file
+      end
+
       Adhearsion.statistics
       start_logging
       debugging_log
       launch_console if need_console?
       catch_termination_signal
-      create_pid_file
       set_ahn_proc_name
       initialize_exception_logger
       update_rails_env_var
@@ -218,9 +223,9 @@ module Adhearsion
 
     def daemonize!
       logger.info "Daemonizing now!"
-      logger.debug "Creating PID file #{pid_file}"
-      extend Adhearsion::CustomDaemonizer
-      daemonize resolve_log_file_path
+      Adhearsion::CustomDaemonizer.daemonize resolve_log_file_path do |pid|
+        create_pid_file pid
+      end
     end
 
     def launch_console
@@ -261,11 +266,13 @@ module Adhearsion
       end
     end
 
-    def create_pid_file
+    def create_pid_file(pid = nil)
       return unless pid_file
 
+      logger.debug "Creating PID file #{pid_file}"
+
       File.open pid_file, 'w' do |file|
-        file.puts ::Process.pid
+        file.puts pid || ::Process.pid
       end
 
       Events.register_callback :shutdown do

data/lib/adhearsion/plugin.rb

@@ -188,11 +188,11 @@ module Adhearsion
       # @param opts Hash
       #     * :before specify the plugin to be loaded before another plugin
       #     * :after  specify the plugin to be loaded after another plugin
-      def init(name = nil, opts = {})
+      def init(name = nil, opts = {}, &block)
         name = plugin_name unless name
         block_given? or raise ArgumentError, "A block must be passed while defining the Plugin initialization process"
         opts[:after] ||= initializers.last.name unless initializers.empty? || initializers.find { |i| i.name == opts[:before] }
-        Adhearsion::Plugin.initializers << Initializer.new(name, nil, opts, &Proc.new)
+        Adhearsion::Plugin.initializers << Initializer.new(name, self, opts, &block)
       end
 
       # Class method that will be used by subclasses to run the plugin
@@ -200,11 +200,11 @@ module Adhearsion
       # @param opts Hash
       #     * :before specify the plugin to be loaded before another plugin
       #     * :after  specify the plugin to be loaded after another plugin
-      def run(name = nil, opts = {})
+      def run(name = nil, opts = {}, &block)
         name = plugin_name unless name
         block_given? or raise ArgumentError, "A block must be passed while defining the Plugin run process"
         opts[:after] ||= runners.last.name unless runners.empty? || runners.find { |i| i.name == opts[:before] }
-        Adhearsion::Plugin.runners << Initializer.new(name, nil, opts, &Proc.new)
+        Adhearsion::Plugin.runners << Initializer.new(name, self, opts, &block)
       end
 
       def count

data/lib/adhearsion/process.rb

@@ -74,7 +74,7 @@ module Adhearsion
 
     def final_shutdown
       Adhearsion.active_calls.each do |_, call|
-        call.hangup!
+        call.hangup
       end
 
       # This should shut down any remaining threads.  Once those threads have

data/lib/adhearsion/punchblock_plugin.rb

@@ -7,6 +7,7 @@ module Adhearsion
     autoload :Initializer
 
     config :punchblock do
+      enabled             true             , :transform => Proc.new { |v| v == 'true' }, :desc => "Enable or disable Punchblock connectivity to a Voice server"
       platform            :xmpp            , :transform => Proc.new { |v| v.to_sym }, :desc => <<-__
         Platform punchblock shall use to connect to the Telephony provider. Currently supported values:
         - :xmpp
@@ -28,11 +29,11 @@ module Adhearsion
     end
 
     init :punchblock do
-      Initializer.init
+      Initializer.init if config.enabled
     end
 
     run :punchblock do
-      Initializer.run
+      Initializer.run if config.enabled
     end
 
     class << self

data/lib/adhearsion/punchblock_plugin/initializer.rb

@@ -109,30 +109,28 @@ module Adhearsion
         end
 
         def connect_to_server
-          begin
-            logger.info "Starting connection to server"
-            client.run
-          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
+          logger.info "Starting connection to server"
+          client.run
+        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
 
-            Adhearsion::Process.reset unless Adhearsion::Process.state_name == :booting
+          Adhearsion::Process.reset unless Adhearsion::Process.state_name == :booting
 
-            self.attempts += 1
+          self.attempts += 1
 
-            if self.attempts >= self.config.reconnect_attempts
-              logger.fatal "Connection lost. Connection retry attempts exceeded."
-              Adhearsion::Process.stop!
-              return
-            end
-
-            logger.error "Connection lost. Attempting reconnect #{self.attempts} of #{self.config.reconnect_attempts}"
-            sleep self.config.reconnect_timer
-            retry
-          rescue Punchblock::ProtocolError => e
-            logger.fatal "The connection failed due to a protocol error: #{e.name}."
-            raise e
+          if self.attempts >= self.config.reconnect_attempts
+            logger.fatal "Connection lost. Connection retry attempts exceeded."
+            Adhearsion::Process.stop!
+            return
           end
+
+          logger.error "Connection lost. Attempting reconnect #{self.attempts} of #{self.config.reconnect_attempts}"
+          sleep self.config.reconnect_timer
+          retry
+        rescue Punchblock::ProtocolError => e
+          logger.fatal "The connection failed due to a protocol error: #{e.name}."
+          raise e
         end
 
         def dispatch_offer(offer)
@@ -142,7 +140,7 @@ module Adhearsion
             when :booting, :rejecting
               logger.info "Declining call because the process is not yet running."
               call.reject :decline
-            when :running
+            when :running, :stopping
               Adhearsion.router.handle call
             else
               call.reject :error