larynx 0.1.1 → 0.1.2

data/Rakefile

@@ -25,6 +25,10 @@ spec = Gem::Specification.new do |s|
   s.require_path = 'lib'
   s.autorequire = GEM_NAME
   s.files = %w(MIT-LICENSE README.rdoc Rakefile) + Dir.glob("{lib,spec,examples}/**/*")
+  s.add_dependency "eventmachine",   ">= 0.12.10"
+  s.add_dependency "active_support", ">= 2.3.5"
+  s.add_development_dependency "rspec",   ">= 1.3.0"
+  s.add_development_dependency "em-spec", ">= 0.1.3"
 end
 
 desc 'Default: run specs.'

data/lib/larynx/call_handler.rb

@@ -1,4 +1,3 @@
-# FIXME interrupted commands callback can be fired out of order if new command sent on break
 module Larynx
   class CallHandler < EventMachine::Protocols::HeaderAndContentProtocol
     include Observable
@@ -36,16 +35,18 @@ module Larynx
       @session[:caller_caller_id_number]
     end
 
-    def interrupt_command
-      if @state == :executing && current_command.interruptable?
-        break!
-      end
-    end
-
     def clear_input
       @input = []
     end
 
+    def current_command
+      @queue.first
+    end
+
+    def next_command
+      @queue[1]
+    end
+
     def execute(command, immediately=false)
       log "Queued: #{command.name}"
       if immediately
@@ -59,10 +60,13 @@ module Larynx
 
     def timer(name, timeout, &block)
       @timers[name] = [RestartableTimer.new(timeout) {
-        timer = @timers.delete(name)
-        timer[1].call if timer[1]
-        notify_observers :timed_out
-        send_next_command if @state == :ready
+        if timer = @timers.delete(name)
+          timer[1].call if timer[1]
+          notify_observers :timed_out
+          send_next_command if @state == :ready
+        else
+          puts name
+        end
       }, block]
     end
 
@@ -91,17 +95,11 @@ module Larynx
       end
     end
 
-    def cleanup
-      break! if @state == :executing
-      cancel_all_timers
-      clear_observers!
-    end
-
     def receive_request(header, content)
       @response = Response.new(header, content)
 
       case
-      when @response.reply? && !current_command.is_a?(AppCommand)
+      when @response.reply? && current_command && !current_command.is_a?(AppCommand)
         log "Completed: #{current_command.name}"
         finalize_command
         @state = :ready
@@ -111,11 +109,13 @@ module Larynx
         run_command_setup
         @state = :executing
       when @response.executed? && current_command
+        this_command = current_command
         finalize_command
-				unless interrupted?
-					@state = :ready
-					send_next_command
-				end
+        unless this_command.interrupted?
+          current_command.fire_callback(:after) if this_command.command == 'break'
+          @state = :ready
+          send_next_command
+        end
       when @response.dtmf?
         log "Button pressed: #{@response.body[:dtmf_digit]}"
         handle_dtmf
@@ -136,16 +136,11 @@ module Larynx
       send_next_command if @state == :ready
     end
 
-    def current_command
-      @queue.first
-    end
-
-    def interrupting?
-      current_command && current_command.command == 'break'
-    end
-
-    def interrupted?
-      last_command && last_command.command == 'break'
+    def interrupt_command
+      if @state == :executing && current_command.interruptable?
+        current_command.interrupted = true
+        break!
+      end
     end
 
     def run_command_setup
@@ -154,18 +149,28 @@ module Larynx
 
     def finalize_command
       if command = @queue.shift
-        command.fire_callback :after
+        command.fire_callback(:after) unless command.interrupted?
         @last_command = command
       end
     end
 
+    def command_to_send
+      current_command.try(:interrupted?) ? next_command : current_command
+    end
+
     def send_next_command
-      if current_command
+      if command = command_to_send
         @state = :sending
-        send_data current_command.to_s
+        send_data command.to_s
       end
     end
 
+    def cleanup
+      break! if @state == :executing
+      cancel_all_timers
+      clear_observers!
+    end
+
     def log(msg)
       LARYNX_LOGGER.info msg
     end

data/lib/larynx/command.rb

@@ -2,6 +2,7 @@ module Larynx
   class Command
     include Callbacks
     attr_reader :command
+    attr_accessor :interrupted
 
     define_callback :before, :after
 
@@ -21,6 +22,10 @@ module Larynx
     def interruptable?
       false
     end
+
+    def interrupted?
+      @interrupted
+    end
   end
 
   class CallCommand < Command

data/lib/larynx/fields.rb

@@ -38,6 +38,46 @@ module Larynx
 
     end
 
+    module CallbacksWithMode
+
+      def setup(mode=:sync, &block)
+        block = app_scope(block)
+        callback = (mode == :async) ? lambda { EM.defer(block, lambda { send_next_command } ) } : block
+        super &callback
+      end
+
+      def success(mode=:sync, &block)
+        block = app_scope(block)
+        callback = (mode == :async) ? lambda { EM.defer(block, lambda { send_next_command } ) } : block
+        super &callback
+      end
+
+      def failure(mode=:sync, &block)
+        block = app_scope(block)
+        callback = (mode == :async) ? lambda { EM.defer(block, lambda { send_next_command } ) } : block
+        super &callback
+      end
+
+      def validate(mode=:sync, &block)
+        block = app_scope(block)
+        if mode == :async
+          super &lambda { EM.defer(block, lambda {|result| evaluate_validity(result) } ) }
+        else
+          super &lambda { evaluate_validity(block.call) }
+        end
+      end
+
+      def invalid(mode=:sync, &block)
+        block = app_scope(block)
+        if mode == :async
+          super &lambda { EM.defer(block, lambda {|result| invalid_input } ) }
+        else
+          super &lambda { block.call; invalid_input }
+        end
+      end
+
+    end
+
     class Field
       include Callbacks
 
@@ -45,6 +85,8 @@ module Larynx
       define_callback :setup, :validate, :invalid, :success, :failure
 
       def initialize(name, options, &block)
+        class_eval { include CallbacksWithMode }
+
         @name, @callbacks = name, {}
         @options = options.reverse_merge(:attempts => 3)
         @prompt_queue = []
@@ -82,38 +124,46 @@ module Larynx
 
       def execute_prompt
         call.execute current_prompt.command
+        send_next_command
       end
 
       def increment_attempts
         @attempt += 1
       end
 
-      def fire_callback(callback)
-        if block = @callbacks[callback]
-          @app.instance_eval(&block)
+      def valid_length?
+        @value.size >= minimum_length
+      end
+
+      def evaluate_input
+        if valid_length?
+          fire_callback(:validate) { evaluate_validity(true) }
         else
-          true
+          fire_callback(:invalid) { invalid_input }
         end
       end
 
-      def valid?
-        @value.size >= minimum_length && fire_callback(:validate)
+      def evaluate_validity(result)
+        if result
+          fire_callback(:success) { send_next_command }
+        else
+          fire_callback(:invalid) { invalid_input }
+        end
       end
 
-      def evaluate_input
-        if valid?
-          fire_callback(:success)
+      def invalid_input
+        if @attempt < @options[:attempts]
+          increment_attempts
+          execute_prompt
         else
-          fire_callback(:invalid)
-          if @attempt < @options[:attempts]
-            increment_attempts
-            execute_prompt
-          else
-            fire_callback(:failure)
-          end
+          fire_callback(:failure) { send_next_command }
         end
       end
 
+      def send_next_command
+        call.send_next_command if call.state == :ready
+      end
+
       def set_instance_variables(input)
         @value = input
         @app.send("#{@name}=", input)
@@ -137,6 +187,20 @@ module Larynx
       def call
         @app.call
       end
+
+      def app_scope(block)
+        lambda { @app.instance_eval(&block) }
+      end
+
+      # fire callback with a default block if callback not defined
+      def fire_callback(callback, *args, &block)
+        if @callbacks && @callbacks[callback]
+          @callbacks[callback].call(*args)
+        else
+          yield if block_given?
+        end
+      end
+
     end
 
   end

data/lib/larynx/version.rb

@@ -1,3 +1,3 @@
 module Larynx
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/spec/fixtures/break.rb

@@ -0,0 +1,51 @@
+RESPONSES[:break] = {
+  :header  => [ "Content-Length: 1630", "Content-Type: text/event-plain" ],
+  :content => <<-DATA
+Event-Name: CHANNEL_EXECUTE
+Core-UUID: 8a4da428-37c0-11df-8380-0166d7747984
+FreeSWITCH-Hostname: ubuntu
+FreeSWITCH-IPv4: 172.16.150.131
+FreeSWITCH-IPv6: %3A%3A1
+Event-Date-Local: 2010-03-26%2018%3A11%3A13
+Event-Date-GMT: Sat,%2027%20Mar%202010%2001%3A11%3A13%20GMT
+Event-Date-Timestamp: 1269652273898632
+Event-Calling-File: switch_core_session.c
+Event-Calling-Function: switch_core_session_exec
+Event-Calling-Line-Number: 1823
+Channel-State: CS_EXECUTE
+Channel-State-Number: 4
+Channel-Name: sofia/internal/1000%40172.16.150.131
+Unique-ID: 3e19d55a-394f-11df-8485-0166d7747984
+Call-Direction: inbound
+Presence-Call-Direction: inbound
+Channel-Presence-ID: 1000%40172.16.150.131
+Answer-State: answered
+Channel-Read-Codec-Name: GSM
+Channel-Read-Codec-Rate: 8000
+Channel-Write-Codec-Name: GSM
+Channel-Write-Codec-Rate: 8000
+Caller-Username: 1000
+Caller-Dialplan: XML
+Caller-Caller-ID-Name: FreeSWITCH
+Caller-Caller-ID-Number: 1000
+Caller-Network-Addr: 172.16.150.1
+Caller-ANI: 1000
+Caller-Destination-Number: 502
+Caller-Unique-ID: 3e19d55a-394f-11df-8485-0166d7747984
+Caller-Source: mod_sofia
+Caller-Context: default
+Caller-Channel-Name: sofia/internal/1000%40172.16.150.131
+Caller-Profile-Index: 1
+Caller-Profile-Created-Time: 1269652267394234
+Caller-Channel-Created-Time: 1269652267394234
+Caller-Channel-Answered-Time: 1269652267509097
+Caller-Channel-Progress-Time: 0
+Caller-Channel-Progress-Media-Time: 0
+Caller-Channel-Hangup-Time: 0
+Caller-Channel-Transfer-Time: 0
+Caller-Screen-Bit: true
+Caller-Privacy-Hide-Name: false
+Caller-Privacy-Hide-Number: false
+Application: break
+DATA
+}

data/spec/larynx/call_handler_spec.rb

@@ -241,6 +241,50 @@ describe Larynx::CallHandler do
     end
   end
 
+  context "interrupting a command" do
+    before do
+      call.queue = []
+      @executing_command = call.speak('hello', :bargein => true) { call.speak 'next hello' }
+      call.send_next_command
+      call.send_response :execute
+      call.interrupt_command
+    end
+
+    it "should push break onto front of queue" do
+      call.queue[0].command.should == 'break'
+      call.queue[1].should == @executing_command
+    end
+
+    it "should execute break immediately" do
+      call.sent_data.should match(/break/)
+    end
+
+    it "should set executing command to interrupted" do
+      @executing_command.interrupted?.should be_true
+    end
+
+    it "should fire callback of interrupted command when break execute complete" do
+      @executing_command.should_receive(:fire_callback).with(:after).once
+      call.send_response :execute_complete
+    end
+
+    it "should leave executing command in queue" do
+      call.send_response :execute_complete
+      call.queue[0].should == @executing_command
+    end
+
+    it "should execute next command after interrupted command" do
+      call.send_response :execute_complete
+      call.sent_data.should match(/next hello/)
+    end
+
+    it "should not fire callback of interrupted command once execute complete" do
+      call.send_response :execute_complete
+      @executing_command.should_not_receive(:fire_callback).with(:after)
+      call.send_response :execute_complete
+    end
+  end
+
   context "timer" do
     it "should add EM timer with name and timeout" do
       Larynx::RestartableTimer.stub!(:new)

data/spec/larynx/fields_spec.rb

@@ -86,16 +86,18 @@ describe Larynx::Fields do
       fld.current_prompt.message.should == 'second'
     end
 
-    context 'valid?' do
+    context 'valid_length?' do
       it 'should be false if input size less than minimum' do
         fld = field(:guess) do
           prompt :speak => 'first'
         end
         fld.run app
         fld.current_prompt.finalise
-        fld.valid?.should be_false
+        fld.valid_length?.should be_false
       end
+    end
 
+    context 'input evaluation' do
       it 'should run validate callback if input minimum length' do
         call_me = should_be_called
         fld = field(:guess, :min_length => 1) do
@@ -106,9 +108,7 @@ describe Larynx::Fields do
         call.input << '1'
         fld.current_prompt.finalise
       end
-    end
 
-    context 'input evaluation' do
       it 'should run invalid callback if length not valid' do
         call_me = should_be_called
         fld = field(:guess) do
@@ -185,6 +185,20 @@ describe Larynx::Fields do
       end
     end
 
+    context "async callbacks" do
+      # it "should be run in thread" do
+      #   em do
+      #     fld = field(:guess) do
+      #       prompt :speak => 'first'
+      #       validate(:async) { sleep(0.25) }
+      #       success { done }
+      #     end.run(app)
+      #     call.input << '1'
+      #   end
+      #   @callback.should be_nil
+      # end
+    end
+
   end
 
   def field(name, options={}, &block)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Adam Meehan
@@ -14,10 +14,65 @@ autorequire: larynx
 bindir: bin
 cert_chain: []
 
-date: 2010-03-25 00:00:00 +11:00
+date: 2010-03-31 00:00:00 +11:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 12
+        - 10
+        version: 0.12.10
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: em-spec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 3
+        version: 0.1.3
+  type: :development
+  version_requirements: *id004
 description: ""
 email: adam.meehan@gmail.com
 executables: 
@@ -46,6 +101,7 @@ files:
 - lib/larynx/version.rb
 - lib/larynx.rb
 - spec/fixtures/answer.rb
+- spec/fixtures/break.rb
 - spec/fixtures/channel_data.rb
 - spec/fixtures/dtmf.rb
 - spec/fixtures/execute.rb