librevox 0.2.1 → 0.3

data/lib/librevox/listener/base.rb

@@ -7,19 +7,18 @@ module Librevox
     class Base < EventMachine::Protocols::HeaderAndContentProtocol
       class << self
         def hooks
-          @hooks ||= []
+          @hooks ||= Hash.new {|hash, key| hash[key] = []}
         end
 
         def event event, &block
-          hooks << [event, block]
+          hooks[event] << block
         end
       end
 
       # In some cases there are both applications and commands with the same
       # name, e.g. fifo. But we can't have two `fifo`-methods, so we include
-      # commands in CommandDelegate, and wrap all commands in the `api` call,
-      # which forwards the call to the CommandDelegate instance, which in turn
-      # forwards the #run_cmd-call from the command back to the listener. Yay.
+      # commands in CommandDelegate, and expose all commands through the `api`
+      # method, which wraps a CommandDelegate instance.
       class CommandDelegate
         include Librevox::Commands
 
@@ -27,25 +26,32 @@ module Librevox
           @listener = listener
         end
 
-        def run_cmd *args, &block
-          @listener.run_cmd *args, &block
+        def command *args, &block
+          @listener.command super(*args), &block
         end
       end
 
-      def api cmd, *args, &block
-        @command_delegate.send(cmd, *args, &block)
+      # Exposes an instance of {CommandDelegate}, which includes {Librevox::Commands}.
+      # @example
+      #   api.status
+      #   api.fsctl :pause
+      #   api.uuid_park "592567a2-1be4-11df-a036-19bfdab2092f"
+      # @see Librevox::Commands
+      def api
+        @command_delegate ||= CommandDelegate.new(self)
       end
 
-      def run_cmd cmd, &block
-        send_data "#{cmd}\n\n"
-        @command_queue << (block || lambda {})
+      def command msg
+        send_data "#{msg}\n\n"
+
+        @command_queue << Fiber.current
+        Fiber.yield
       end
 
       attr_accessor :response
       alias :event :response
 
       def post_init
-        @command_delegate = CommandDelegate.new(self)
         @command_queue = []
       end
 
@@ -56,9 +62,11 @@ module Librevox
 
       def handle_response
         if response.api_response? && @command_queue.any?
-          invoke_command_queue
-        elsif response.event?
-          on_event response.dup
+          @command_queue.shift.resume response
+        end
+
+        if response.event?
+          Fiber.new {on_event response.dup}.resume
           invoke_event_hooks
         end
       end
@@ -71,17 +79,13 @@ module Librevox
 
       private
       def invoke_event_hooks
-        self.class.hooks.each {|name,block| 
-          if name == response.event.downcase.to_sym
+        event = response.event.downcase.to_sym
+        self.class.hooks[event].each {|block|
+          Fiber.new {
             instance_exec response.dup, &block 
-          end
+          }.resume
         }
       end
-
-      def invoke_command_queue
-        block = @command_queue.shift
-        block.call response
-      end
     end
   end
 end

data/lib/librevox/listener/inbound.rb

@@ -3,7 +3,7 @@ require 'librevox/listener/base'
 module Librevox
   module Listener
     class Inbound < Base
-      def initialize(args={})
+      def initialize args={}
         super
 
         @auth = args[:auth] || "ClueCon"

data/lib/librevox/listener/outbound.rb

@@ -6,21 +6,20 @@ module Librevox
     class Outbound < Base
       include Librevox::Applications
 
-      def execute_app app, args="", params={}, &block
+      def application app, args=nil, params={}
         msg = "sendmsg\n"
         msg << "call-command: execute\n"
         msg << "execute-app-name: #{app}\n"
-        msg << "execute-app-arg: #{args}\n" unless args.empty?
+        msg << "execute-app-arg: #{args}\n" if args && !args.empty?
 
         send_data "#{msg}\n"
 
-        @read_channel_var = params[:read_var]
+        @application_queue << Fiber.current
 
-        if @read_channel_var
-          @application_queue << lambda {update_session}
-        end
+        Fiber.yield
+        update_session
 
-        @application_queue << (block || lambda {})
+        params[:variable] ? variable(params[:variable]) : nil
       end
 
       # This should probably be in Application#sendmsg instead.
@@ -41,36 +40,29 @@ module Librevox
 
         send_data "connect\n\n"
         send_data "myevents\n\n"
-        @application_queue << lambda {}
+        @application_queue << Fiber.new {}
         send_data "linger\n\n"
-        @application_queue << lambda {}
+        @application_queue << Fiber.new {session_initiated}
       end
 
       def handle_response
         if session.nil?
           @session = response.headers
-          session_initiated
         elsif response.event? && response.event == "CHANNEL_DATA"
           @session = response.content
-          resume_with_channel_var
         elsif response.command_reply? && !response.event?
-          @application_queue.shift.call if @application_queue.any?
+          @application_queue.shift.resume if @application_queue.any?
         end
 
         super
       end
 
-      def resume_with_channel_var
-        if @read_channel_var
-          variable = "variable_#{@read_channel_var}".to_sym
-          value = @session[variable]
-          @application_queue.shift.call(value) if @application_queue.any?
-        end
+      def variable name
+        session[:"variable_#{name}"]
       end
 
-      def update_session &block
-        send_data "api uuid_dump #{session[:unique_id]}\n\n"
-        @command_queue << (block || lambda {})
+      def update_session
+        api.command "uuid_dump", session[:unique_id]
       end
     end
   end

data/lib/librevox/response.rb

@@ -9,17 +9,17 @@ module Librevox
   class Response
     attr_accessor :headers, :content
 
-    def initialize(headers="", content="")
+    def initialize headers="", content=""
       self.headers = headers
       self.content = content
     end
 
-    def headers=(headers)
+    def headers= headers
       @headers = headers_2_hash(headers)
       @headers.each {|k,v| v.chomp! if v.is_a?(String)}
     end
 
-    def content=(content)
+    def content= content
       @content = content.match(/:/) ? headers_2_hash(content) : content
       @content.each {|k,v| v.chomp! if v.is_a?(String)}
     end
@@ -41,7 +41,7 @@ module Librevox
     end
 
     private
-    def headers_2_hash(*args)
+    def headers_2_hash *args
       EM::Protocols::HeaderAndContentProtocol.headers_2_hash *args
     end
   end

data/librevox.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name     = "librevox"
-  s.version  = "0.2.1"
-  s.date     = "2010-02-09"
+  s.version  = "0.3"
+  s.date     = "2010-09-30"
   s.summary  = "Ruby library for interacting with FreeSWITCH."
   s.email    = "harry@vangberg.name"
   s.homepage = "http://github.com/ichverstehe/librevox"
@@ -9,11 +9,11 @@ Gem::Specification.new do |s|
 open source telephony platform FreeSwitch."
   s.authors  = ["Harry Vangberg"]
   s.files    = [
-    "README.md", 
+    "README.md",
     "LICENSE",
     "TODO",
     "Rakefile",
-		"librevox.gemspec", 
+		"librevox.gemspec",
 		"lib/librevox.rb",
     "lib/librevox/applications.rb",
     "lib/librevox/command_socket.rb",
@@ -27,11 +27,14 @@ open source telephony platform FreeSwitch."
     "spec/helper.rb",
     "spec/librevox/listener.rb",
     "spec/librevox/spec_applications.rb",
-    "spec/librevox/spec_command_socket.rb",
+    #"spec/librevox/spec_command_socket.rb",
     "spec/librevox/spec_commands.rb",
     "spec/librevox/spec_response.rb",
     "spec/librevox/listener/spec_inbound.rb",
     "spec/librevox/listener/spec_outbound.rb"
   ]
+  s.add_dependency "eventmachine", "~> 0.12.10"
+  s.add_development_dependency "bacon", "~> 1.1"
+  s.add_development_dependency "rr", "~> 1"
 end
 

data/spec/helper.rb

@@ -1,6 +1,86 @@
-$:.unshift 'lib'
-
 require 'bacon'
 require 'librevox'
 
+module Librevox::Test
+  module Matchers
+    def send_command command
+      lambda {|obj|
+        obj.outgoing_data.shift.should == "#{command}\n\n"
+      }
+    end
+
+    def send_nothing
+      lambda {|obj| obj.outgoing_data.shift.should == nil}
+    end
+
+    def send_application app, args=nil
+      lambda {|obj|
+        msg = <<-EOM
+sendmsg
+call-command: execute
+execute-app-name: #{app}
+        EOM
+        msg << "execute-app-arg: #{args}\n" if args
+        msg << "\n"
+
+        obj.outgoing_data.shift.should == msg
+      }
+    end
+
+    def update_session session_id=nil
+      if session_id
+        lambda {|obj|
+          obj.outgoing_data.shift.should == "api uuid_dump #{session_id}\n\n"
+        }
+      else
+        lambda {|obj|
+          obj.outgoing_data.shift.should.match /^api uuid_dump \d+/
+        }
+      end
+    end
+  end
+
+  module ListenerHelpers
+    def command_reply args={}
+      args["Content-Type"] = "command/reply"
+      response args
+    end
+
+    def api_response args={}
+      args["Content-Type"] = "api/response"
+      response args
+    end
+
+    def channel_data args={}
+      api_response :body => {
+        "Event-Name"  => "CHANNEL_DATA",
+        "Session-Var" => "Second"
+      }.merge(args)
+    end
+
+    def response args={}
+      body    = args.delete :body
+      headers = args
+
+      if body.is_a? Hash
+        body = body.map {|k,v| "#{k}: #{v}"}.join "\n"
+      end
+
+      headers["Content-Length"] = body.size if body
+      msg = headers.map {|k, v| "#{k}: #{v}"}.join "\n"
+
+      msg << "\n\n" + body if body
+
+      @listener.receive_data msg + "\n\n"
+    end
+
+    def event name
+      body    = "Event-Name: #{name}"
+      headers = "Content-Length: #{body.size}"
+
+      @listener.receive_data "#{headers}\n\n#{body}\n\n"
+    end
+  end
+end
+
 Bacon.summary_on_exit

data/spec/librevox/listener.rb

@@ -1,7 +1,8 @@
-require 'spec/helper'
-
+require './spec/helper'
 require 'librevox/listener/base'
 
+include Librevox::Test::ListenerHelpers
+
 class Librevox::Listener::Base
   attr_accessor :outgoing_data
 
@@ -19,6 +20,8 @@ class Librevox::Listener::Base
   end
 end
 
+# These tests are a bit fragile, as they depend on event hooks being
+# executed before on_event.
 shared "events" do
   before do
     @class = @listener.class
@@ -37,43 +40,64 @@ shared "events" do
 
   should "add event hook" do
     @class.hooks.size.should == 3
+    @class.hooks.each do |event, hooks|
+      hooks.size.should == 1
+    end
   end
 
   should "execute callback for event" do
-    @listener.receive_data("Content-Length: 23\n\nEvent-Name: OTHER_EVENT\n\n")
+    event "OTHER_EVENT"
     @listener.read_data.should == "something else"
 
-    @listener.receive_data("Content-Length: 22\n\nEvent-Name: SOME_EVENT\n\n")
+    event "SOME_EVENT"
     @listener.read_data.should == "something"
   end
 
   should "pass response duplicate as arg to hook block" do
-    @listener.receive_data("Content-Length: 25\n\nEvent-Name: HOOK_WITH_ARG\n\n")
+    event "HOOK_WITH_ARG"
+
     reply = @listener.read_data
     reply.should =~ /^got event arg: /
     reply.should.not =~ /^got event arg: #{@listener.response.object_id}$/
   end
 
   should "expose response as event" do
-    @listener.receive_data("Content-Length: 23\n\nEvent-Name: OTHER_EVENT\n\n")
+    event "OTHER_EVENT"
+
     @listener.event.class.should == Librevox::Response
     @listener.event.content[:event_name].should == "OTHER_EVENT"
   end
 
   should "call on_event" do
-    @listener.receive_data("Content-Length: 23\n\nEvent-Name: THIRD_EVENT\n\n")
+    event "THIRD_EVENT"
+
     @listener.read_data.should =~ /^from on_event/
   end
 
   should "call on_event with response duplicate as argument" do
-    @listener.receive_data("Content-Length: 23\n\nEvent-Name: THIRD_EVENT\n\n")
+    event "THIRD_EVENT"
+
     @listener.read_data.should.not =~ /^from on_event: #{@listener.response.object_id}$/
   end
+
+  should "call event hooks and on_event on CHANNEL_DATA" do
+    @listener.outgoing_data.clear
+
+    def @listener.on_event e
+      send_data "on_event: CHANNEL_DATA test"
+    end
+    @class.event(:channel_data) {send_data "event hook: CHANNEL_DATA test"}
+
+    event "CHANNEL_DATA"
+
+    @listener.outgoing_data.should.include "on_event: CHANNEL_DATA test"
+    @listener.outgoing_data.should.include "event hook: CHANNEL_DATA test"
+  end
 end
 
 module Librevox::Commands
-  def sample_cmd(cmd, args="", &b)
-    execute_cmd cmd, args, &b
+  def sample_cmd cmd, args=""
+    command cmd, args
   end
 end
 
@@ -82,74 +106,35 @@ shared "api commands" do
     @class = @listener.class
 
     # Establish session
-    @listener.receive_data("Content-Type: command/reply\nTest: Testing\n\n")
+    command_reply "Test" => "Testing"
   end
 
   describe "multiple api commands" do
+    extend Librevox::Test::Matchers
+
     before do
       @listener.outgoing_data.clear
 
       def @listener.on_event(e) end # Don't send anything, kthx.
 
       @class.event(:api_test) {
-        api :sample_cmd, "foo" do
-          api :sample_cmd, "foo", "bar baz"
-        end
+        api.sample_cmd "foo"
+        r = api.sample_cmd "foo", "bar baz"
+        command "response #{r.content}"
       }
     end
 
-    should "only send one command at a time" do
-      @listener.receive_data("Content-Type: command/reply\nContent-Length: 22\n\nEvent-Name: API_TEST\n\n")
-      @listener.read_data.should == "api foo\n\n"
-      @listener.read_data.should == nil
-
-      @listener.receive_data("Content-Type: api/response\nReply-Text: +OK\n\n")
-      @listener.read_data.should == "api foo bar baz\n\n"
-      @listener.read_data.should == nil
-    end
-  end
-
-  describe "flat api commands" do
-    before do
-      @listener.outgoing_data.clear
-      @class.event(:api_flat_test) {
-        api :sample_cmd, "foo"
-        api :sample_cmd, "bar" do
-          api :sample_cmd, "baz"
-        end
-      }
-    end
-
-    should "wait for response before calling next proc" do
-      @listener.receive_data("Content-Type: command/reply\nContent-Length: 27\n\nEvent-Name: API_FLAT_TEST\n\n")
-
-      @listener.read_data.should.not == "api baz\n\n"
-
-      # response to "foo"
-      @listener.receive_data("Content-Type: api/response\nContent-Length: 3\n\n+OK\n\n")
-      @listener.read_data.should.not == "api baz\n\n"
-
-      # response to "bar"
-      @listener.receive_data("Content-Type: api/response\nContent-Length: 3\n\n+OK\n\n")
-      @listener.read_data.should == "api baz\n\n"
-    end
-  end
-
-  describe "api command with block argument" do
-    before do
-      @listener.outgoing_data.clear
-      @class.event(:api_arg_test) {
-        api :sample_cmd, "foo" do |r|
-          send_data "response: #{r.content}"
-        end
-      }
-    end
+    should "only send one command at a time, and return response for commands" do
+      command_reply :body => {"Event-Name" => "API_TEST"}
+      @listener.should send_command "api foo"
+      @listener.should send_nothing
 
-    should "pass response" do
-      @listener.receive_data("Content-Type: command/reply\nContent-Length: 26\n\nEvent-Name: API_ARG_TEST\n\n")
-      @listener.receive_data("Content-Type: api/response\nContent-Length: 3\n\n+OK\n\n")
+      api_response "Reply-Text" => "+OK"
+      @listener.should send_command "api foo bar baz"
+      @listener.should send_nothing
 
-      @listener.read_data.should == "response: +OK"
+      api_response :body => "+YAY"
+      @listener.should send_command "response +YAY"
     end
   end
 end