adhearsion 2.0.0.beta1 → 2.0.0.rc1

data/EVENTS

@@ -1,11 +0,0 @@
-# Below are a list of framework events:
-
-- after_initialized
-- shutdown
-- asterisk:
-  - manager_interface
-  - before_call
-  - failed_call
-  - hungup_call
-
-# Note: This file is valid YAML for programatic parsing.

data/lib/adhearsion/call_controller/menu.rb

@@ -1,124 +0,0 @@
-module Adhearsion
-  class CallController
-    module Menu
-
-      # Creates and manages a multiple choice menu driven by DTMF, handling playback of prompts,
-      # invalid input, retries and timeouts, and final failures.
-      #
-      # @example A complete example of the method is as follows:
-      #   menu "Welcome, ", "/opt/sounds/menu-prompt.mp3", :tries => 2, :timeout => 10 do
-      #     match 1, OperatorController
-      #
-      #     match 10..19 do
-      #       pass DirectController
-      #     end
-      #
-      #     match 5, 6, 9 do |exten|
-      #      play "The #{exten} extension is currently not active"
-      #     end
-      #
-      #     match '7', OfficeController
-      #
-      #     invalid { play "Please choose a valid extension" }
-      #     timeout { play "Input timed out, try again." }
-      #     failure { pass OperatorController }
-      #   end
-      #
-      # The first arguments to #menu will be a list of sounds to play, as accepted by #play, including strings for TTS, Date and Time objects, and file paths.
-      # :tries and :timeout options respectively specify the number of tries before going into failure, and the timeout in seconds allowed on each digit input.
-      # The most important part is the following block, which specifies how the menu will be constructed and handled.
-      #
-      # #match handles connecting an input pattern to a payload.
-      # The pattern can be one or more of: an integer, a Range, a string, an Array of the possible single types.
-      # Input is matched against patterns, and the first exact match has it's payload executed.
-      # Matched input is passed in to the associated block, or to the controller through #options.
-      #
-      # Allowed payloads are the name of a controller class, in which case it is executed through its #run method, or a block.
-      #
-      # #invalid has its associated block executed when the input does not possibly match any pattern.
-      # #timeout's block is run when time expires before or between input digits.
-      # #failure runs its block when the maximum number of tries is reached without an input match.
-      #
-      # Execution of the current context resumes after #menu finishes. If you wish to jump to an entirely different controller, use #pass.
-      # Menu will return :failed if failure was reached, or :done if a match was executed.
-      #
-      # @param [Object] A list of outputs to play, as accepted by #play
-      # @param [Hash] options Options to use for the menu
-      # @option options [Integer] :tries Number of tries allowed before failure
-      # @option options [Integer] :timeout Timeout in seconds before the first and between each input digit
-      #
-      # @return [Symbol] :failure on failure, :done if a match is reached and executed. Will only return if control is not passed.
-      #
-      # @raise [ArgumentError] Raised if no block is passed in
-      #
-      # @see play
-      # @see pass
-      #
-      def menu(*args, &block)
-        raise ArgumentError, "You must provide a block to the #menu method." unless block_given?
-
-        options = args.last.kind_of?(Hash) ? args.pop : {}
-        sound_files = args.flatten
-
-        menu_instance = MenuDSL::Menu.new options, &block
-        result_of_menu = nil
-
-        until MenuDSL::Menu::MenuResultDone === result_of_menu
-          if menu_instance.should_continue?
-            result_of_menu = menu_instance.continue
-          else
-            logger.debug "Menu failed to get valid input. Executing failure hook."
-            menu_instance.execute_failure_hook
-            return :failed
-          end
-
-          case result_of_menu
-          when MenuDSL::Menu::MenuResultInvalid
-            logger.debug "Menu get invalid input. Executing invalid hook and restarting."
-            menu_instance.execute_invalid_hook
-            menu_instance.restart!
-            result_of_menu = nil
-          when MenuDSL::Menu::MenuGetAnotherDigit
-            next_digit = play_sound_files_for_menu menu_instance, sound_files
-            if next_digit
-              menu_instance << next_digit
-            else
-              case result_of_menu
-              when MenuDSL::Menu::MenuGetAnotherDigitOrFinish
-                jump_to result_of_menu.match_object, :extension => result_of_menu.new_extension
-                return true
-              when MenuDSL::Menu::MenuGetAnotherDigitOrTimeout
-                logger.debug "Menu timed out. Executing timeout hook and restarting."
-                menu_instance.execute_timeout_hook
-                menu_instance.restart!
-                result_of_menu = nil
-              end
-            end
-          when MenuDSL::Menu::MenuResultFound
-            logger.debug "Menu got a valid input (#{result_of_menu.new_extension}). Executing the match."
-            jump_to result_of_menu.match_object, :extension => result_of_menu.new_extension
-            return true
-          end # case
-        end # while
-        return :done
-      end
-
-      def play_sound_files_for_menu(menu_instance, sound_files) # :nodoc:
-        digit = nil
-        if sound_files.any? && menu_instance.digit_buffer_empty?
-          digit = interruptible_play *sound_files
-        end
-        digit || wait_for_digit(menu_instance.timeout)
-      end
-
-      def jump_to(match_object, overrides = nil) # :nodoc:
-        if match_object.block
-          instance_exec overrides[:extension], &match_object.block
-        else
-          invoke match_object.match_payload, overrides
-        end
-      end
-
-    end # module
-  end
-end

data/lib/adhearsion/foundation/all.rb

@@ -1,8 +0,0 @@
-require 'English'
-require 'tmpdir'
-require 'tempfile'
-
-# Require all other files here.
-Dir.glob File.join(File.dirname(__FILE__), "*rb") do |file|
-  require file
-end

data/spec/adhearsion/call_controller/menu_spec.rb

@@ -1,120 +0,0 @@
-require 'spec_helper'
-
-module Adhearsion
-  class CallController
-    describe Menu do
-      include CallControllerTestHelpers
-
-      describe "#play_sound_files_for_menu" do
-        let(:options) { Hash.new }
-        let(:menu_instance) { Adhearsion::MenuDSL::Menu.new(options) {} }
-        let(:sound_file) { "press a button" }
-        let(:sound_files) { [sound_file] }
-
-        it "should play the sound files for the menu" do
-          subject.should_receive(:interruptible_play).with(sound_file).and_return("1")
-          subject.play_sound_files_for_menu(menu_instance, sound_files)
-        end
-
-        it "should wait for digit if nothing is pressed during playback" do
-          subject.should_receive(:interruptible_play).with(sound_file).and_return(nil)
-          subject.should_receive(:wait_for_digit).with(menu_instance.timeout).and_return("1")
-          subject.play_sound_files_for_menu(menu_instance, sound_files)
-        end
-      end#play_sound_files_for_menu
-
-      describe "#jump_to" do
-        let(:match_object) { flexmock(Class.new) }
-        let(:overrides) { Hash.new(:extension => "1") }
-        let(:block) { Proc.new() {} }
-
-        it "calls instance_exec if the match object has a block" do
-          match_object.should_receive(:block).and_return(block)
-          subject.should_receive(:instance_exec).with(overrides[:extension], block)
-          subject.jump_to(match_object, overrides)
-        end
-
-        it "calls invoke if the match object does not have a block" do
-          match_object.should_receive(:block).and_return(false)
-          match_object.should_receive(:match_payload).and_return(:payload)
-          subject.should_receive(:invoke).with(:payload, overrides)
-          subject.jump_to(match_object, overrides)
-        end
-      end#jump_to
-
-      describe "#menu" do
-        let(:sound_files) { ["press", "button"] }
-        context "menu state flow" do
-          let(:menu_instance) do
-            menu_instance = flexmock(MenuDSL::Menu.new({}) {})
-          end
-          let(:result_done) { MenuDSL::Menu::MenuResultDone.new }
-          let(:result_invalid) { MenuDSL::Menu::MenuResultInvalid.new }
-          let(:result_get_another_or_timeout) { MenuDSL::Menu::MenuGetAnotherDigitOrTimeout.new }
-          let(:result_get_another_or_finish) { MenuDSL::Menu::MenuGetAnotherDigitOrFinish.new(:match_object, :new_extension) }
-          let(:result_found) { MenuDSL::Menu::MenuResultFound.new(:match_object, :new_extension) }
-
-         before(:each) do
-            flexmock(MenuDSL::Menu).should_receive(:new).and_return(menu_instance)
-          end
-
-          it "exits the function if MenuResultDone" do
-            menu_instance.should_receive(:should_continue?).and_return(true)
-            menu_instance.should_receive(:continue).and_return(result_done)
-            result = subject.menu(sound_files) {}
-            result.should == :done
-          end
-
-          it "executes failure hook and returns :failure if menu fails" do
-            menu_instance.should_receive(:should_continue?).and_return(false)
-            menu_instance.should_receive(:execute_failure_hook)
-            result = subject.menu(sound_files) {}
-            result.should == :failed
-          end
-
-          it "executes invalid hook if input is invalid" do
-            menu_instance.should_receive(:should_continue?).twice.and_return(true)
-            menu_instance.should_receive(:continue).and_return(result_invalid, result_done)
-            menu_instance.should_receive(:execute_invalid_hook)
-            menu_instance.should_receive(:restart!)
-            subject.menu(sound_files) {}
-          end
-
-          it "plays audio, then executes timeout hook if input times out" do
-            menu_instance.should_receive(:should_continue?).twice.and_return(true)
-            menu_instance.should_receive(:continue).and_return(result_get_another_or_timeout, result_done)
-            subject.should_receive(:play_sound_files_for_menu).with(menu_instance, sound_files).and_return(nil)
-            menu_instance.should_receive(:execute_timeout_hook)
-            menu_instance.should_receive(:restart!)
-            subject.menu(sound_files) {}
-          end
-
-          it "plays audio, then adds digit to digit buffer if input is received" do
-            menu_instance.should_receive(:should_continue?).twice.and_return(true)
-            menu_instance.should_receive(:continue).and_return(result_get_another_or_timeout, result_done)
-            subject.should_receive(:play_sound_files_for_menu).with(menu_instance, sound_files).and_return("1")
-            menu_instance.should_receive(:<<).with("1")
-            subject.menu(sound_files) {}
-          end
-
-          it "plays audio, then jumps to payload when input is finished" do
-            menu_instance.should_receive(:should_continue?).and_return(true)
-            menu_instance.should_receive(:continue).and_return(result_get_another_or_finish)
-            subject.should_receive(:play_sound_files_for_menu).with(menu_instance, sound_files).and_return(nil)
-            subject.should_receive(:jump_to).with(:match_object, :extension => :new_extension)
-            subject.menu(sound_files) {}
-          end
-
-          it "jumps to payload when result is found" do
-            menu_instance.should_receive(:should_continue?).and_return(true)
-            menu_instance.should_receive(:continue).and_return(result_found)
-            subject.should_receive(:jump_to).with(:match_object, :extension => :new_extension)
-            subject.menu(sound_files) {}
-          end
-        end#context
-
-      end#describe
-
-    end#shared
-  end
-end

data/spec/adhearsion/menu_dsl_spec.rb

@@ -1,12 +0,0 @@
-require 'spec_helper'
-
-module Adhearsion
-  describe MenuDSL do
-    it "should accept hash options"
-
-    it "should accept hash options and block"
-
-    it "should accept hash options and block and evaluate block"
-  end
-end
-