librevox 0.1

data/lib/librevox/listener/base.rb

@@ -0,0 +1,80 @@
+require 'eventmachine'
+require 'librevox/response'
+require 'librevox/commands'
+
+module Librevox
+  module Listener
+    class Base < EventMachine::Protocols::HeaderAndContentProtocol
+      class << self
+        def hooks
+          @hooks ||= []
+        end
+
+        def event(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.
+      class CommandDelegate
+        include Librevox::Commands
+
+        def initialize(listener)
+          @listener = listener
+        end
+
+        def run_cmd(*args, &block)
+          @listener.run_cmd *args, &block
+        end
+      end
+
+      def api(cmd, *args, &block)
+        @command_delegate.send(cmd, *args, &block)
+      end
+
+      def run_cmd(cmd, &block)
+        send_data "#{cmd}\n\n"
+        @api_queue << (block || lambda {})
+      end
+
+      attr_accessor :response
+      alias :event :response
+
+      def post_init
+        @command_delegate = CommandDelegate.new(self)
+        @api_queue = []
+      end
+
+      def receive_request(header, content)
+        @response = Librevox::Response.new(header, content)
+
+        if response.event?
+          on_event
+          invoke_event response.event
+        elsif response.api_response? && @api_queue.any?
+          invoke_api_queue
+        end
+      end
+
+      # override
+      def on_event
+      end
+
+      private
+      def invoke_event(event_name)
+        self.class.hooks.each do |name,block| 
+          instance_eval(&block) if name == event_name.downcase.to_sym
+        end
+      end
+
+      def invoke_api_queue
+        block = @api_queue.shift
+        block.call(response)
+      end
+    end
+  end
+end

data/lib/librevox/listener/inbound.rb

@@ -0,0 +1,19 @@
+require 'librevox/listener/base'
+
+module Librevox
+  module Listener
+    class Inbound < Base
+      def initialize(args={})
+        super
+
+        @auth = args[:auth] || "ClueCon"
+      end
+
+      def post_init
+        super
+        send_data "auth #{@auth}\n\n"
+        send_data "event plain ALL\n\n"
+      end
+    end
+  end
+end

data/lib/librevox/listener/outbound.rb

@@ -0,0 +1,83 @@
+require 'librevox/listener/base'
+require 'librevox/applications'
+
+module Librevox
+  module Listener
+    class Outbound < Base
+      class << self
+        attr_reader :session_callback
+
+        def session(&block)
+          @session_callback = block
+        end
+      end
+
+      include Librevox::Applications
+
+      def execute_app(app, args="", params={}, &block)
+        msg = "sendmsg\n"
+        msg << "call-command: execute\n"
+        msg << "execute-app-name: #{app}\n"
+        msg << "execute-app-arg: #{args}\n" unless args.empty?
+
+        send_data "#{msg}\n"
+
+        @read_channel_var = params[:read_var]
+
+        if @read_channel_var
+          @command_queue << lambda {update_session}
+        end
+
+        @command_queue << (block || lambda {})
+      end
+
+      # This should probably be in Application#sendmsg instead.
+      def sendmsg(msg)
+        send_data "sendmsg\n%s" % msg
+      end
+
+      attr_accessor :session
+
+      def post_init
+        super
+        @session = nil
+        @command_queue = []
+
+        send_data "connect\n\n"
+        send_data "myevents\n\n"
+        @command_queue << lambda {}
+        send_data "linger\n\n"
+        @command_queue << lambda {}
+      end
+
+      def receive_request(*args)
+        super(*args)
+        
+        if session.nil?
+          @session = response
+          instance_eval &self.class.session_callback
+        elsif response.event? && response.event == "CHANNEL_DATA"
+          @session = response
+          resume_with_channel_var
+        elsif response.command_reply? && !response.event?
+          @command_queue.shift.call if @command_queue.any?
+        end
+      end
+
+      def resume_with_channel_var
+        if @read_channel_var
+          variable = "variable_#{@read_channel_var}".to_sym
+          value = @session.content[variable]
+          @command_queue.shift.call(value) if @command_queue.any?
+        end
+      end
+
+      def update_session
+        send_data("api uuid_dump #{session.headers[:unique_id]}\n\n")
+      end
+
+      def session_initiated
+      end
+    end
+  end
+end

data/lib/librevox/response.rb

@@ -0,0 +1,48 @@
+require 'eventmachine'
+require 'em/protocols/header_and_content'
+
+class String
+  alias :each :each_line
+end
+
+module Librevox
+  class Response
+    attr_accessor :headers, :content
+
+    def initialize(headers="", content="")
+      self.headers = headers
+      self.content = content
+    end
+
+    def headers=(headers)
+      @headers = headers_2_hash(headers)
+      @headers.each {|k,v| v.chomp! if v.is_a?(String)}
+    end
+
+    def content=(content)
+      @content = content.match(/:/) ? headers_2_hash(content) : content
+      @content.each {|k,v| v.chomp! if v.is_a?(String)}
+    end
+
+    def event?
+      @content.is_a?(Hash) && @content.include?(:event_name)
+    end
+
+    def event
+      @content[:event_name] if event?
+    end
+
+    def api_response?
+      @headers[:content_type] == "api/response"
+    end
+
+    def command_reply?
+      @headers[:content_type] == "command/reply"
+    end
+
+    private
+    def headers_2_hash(*args)
+      EM::Protocols::HeaderAndContentProtocol.headers_2_hash *args
+    end
+  end
+end

data/librevox.gemspec

@@ -0,0 +1,37 @@
+Gem::Specification.new do |s|
+  s.name     = "librevox"
+  s.version  = "0.1"
+  s.date     = "2009-12-14"
+  s.summary  = "Ruby library for interacting with FreeSWITCH."
+  s.email    = "harry@vangberg.name"
+  s.homepage = "http://github.com/ichverstehe/librevox"
+  s.description = "EventMachine-based Ruby library for interacting with the
+open source telephony platform FreeSwitch."
+  s.authors  = ["Harry Vangberg"]
+  s.files    = [
+    "README.md", 
+    "LICENSE",
+    "TODO",
+    "Rakefile",
+		"librevox.gemspec", 
+		"lib/librevox.rb",
+    "lib/librevox/applications.rb",
+    "lib/librevox/command_socket.rb",
+    "lib/librevox/commands.rb",
+    "lib/librevox/response.rb",
+    "lib/librevox/listener/base.rb",
+    "lib/librevox/listener/inbound.rb",
+    "lib/librevox/listener/outbound.rb"
+  ]
+  s.test_files  = [
+    "spec/helper.rb",
+    "spec/librevox/listener.rb",
+    "spec/librevox/spec_applications.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"
+  ]
+end
+

data/spec/helper.rb

@@ -0,0 +1,6 @@
+$:.unshift 'lib'
+
+require 'bacon'
+require 'librevox'
+
+Bacon.summary_on_exit

data/spec/librevox/listener.rb

@@ -0,0 +1,130 @@
+require 'spec/helper'
+
+require 'librevox/listener/base'
+
+class Librevox::Listener::Base
+  attr_accessor :outgoing_data
+
+  def initialize(*args)
+    @outgoing_data = []
+    super *args
+  end
+
+  def send_data(data)
+    @outgoing_data << data
+  end
+
+  def read_data
+    @outgoing_data.pop
+  end
+end
+
+shared "events" do
+  before do
+    @class = @listener.class
+
+    @class.event(:some_event) {send_data "something"}
+    @class.event(:other_event) {send_data "something else"}
+
+    # Establish session
+    @listener.receive_data("Content-Length: 0\nTest: Testing\n\n")
+  end
+
+  should "add event hook" do
+    @class.hooks.size.should == 2
+  end
+
+  should "execute callback for event" do
+    @listener.receive_data("Content-Length: 23\n\nEvent-Name: OTHER_EVENT\n\n")
+    @listener.read_data.should == "something else"
+
+    @listener.receive_data("Content-Length: 22\n\nEvent-Name: SOME_EVENT\n\n")
+    @listener.read_data.should == "something"
+  end
+
+  should "expose response as event" do
+    @listener.receive_data("Content-Length: 23\n\nEvent-Name: OTHER_EVENT\n\n")
+    @listener.event.class.should == Librevox::Response
+    @listener.event.content[:event_name].should == "OTHER_EVENT"
+  end
+end
+
+module Librevox::Commands
+  def sample_cmd(cmd, args="", &b)
+    execute_cmd cmd, args, &b
+  end
+end
+
+shared "api commands" do
+  before do
+    @class = @listener.class
+
+    # Establish session
+    @listener.receive_data("Content-Type: command/reply\nTest: Testing\n\n")
+  end
+
+  describe "multiple api commands" do
+    before do
+      @listener.outgoing_data.clear
+      @class.event(:api_test) {
+        api :sample_cmd, "foo" do
+          api :sample_cmd, "foo", "bar baz"
+        end
+      }
+    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 "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")
+
+      @listener.read_data.should == "response: +OK"
+    end
+  end
+end

data/spec/librevox/listener/spec_inbound.rb

@@ -0,0 +1,21 @@
+require 'spec/helper'
+require 'spec/librevox/listener'
+
+require 'librevox/listener/inbound'
+
+class InboundTestListener < Librevox::Listener::Inbound
+end
+
+describe "Inbound listener" do
+  before do
+    @listener = InboundTestListener.new(nil)
+  end
+
+  behaves_like "events"
+  behaves_like "api commands"
+
+  should "authorize and subscribe to events" do
+    @listener.outgoing_data.shift.should == "auth ClueCon\n\n"
+    @listener.outgoing_data.shift.should == "event plain ALL\n\n"
+  end
+end

data/spec/librevox/listener/spec_outbound.rb

@@ -0,0 +1,221 @@
+require 'spec/helper'
+require 'spec/librevox/listener'
+
+require 'librevox/listener/outbound'
+
+module Librevox::Applications
+  def sample_app(name, *args, &b)
+    execute_app name, args.join(" "), &b
+  end
+end
+
+class OutboundTestListener < Librevox::Listener::Outbound
+  session do
+    send_data "session was initiated"
+  end
+end
+
+def receive_event_and_linger_replies
+  @listener.receive_data("Content-Type: command/reply\nReply-Text: +OK Events Enabled\n\n")
+  @listener.receive_data("Content-Type: command/reply\nReply-Text: +OK will linger\n\n")
+end
+
+describe "Outbound listener" do
+  before do
+    @listener = OutboundTestListener.new(nil)
+    @listener.receive_data("Content-Type: command/reply\nCaller-Caller-ID-Number: 8675309\n\n")
+    receive_event_and_linger_replies
+  end
+
+  should "connect to freeswitch and subscribe to events" do
+    @listener.outgoing_data.shift.should.equal "connect\n\n"
+    @listener.outgoing_data.shift.should.equal "myevents\n\n"
+    @listener.outgoing_data.shift.should.equal "linger\n\n"
+  end
+
+  should "establish a session" do
+    @listener.session.class.should.equal Librevox::Response
+  end
+
+  should "call session callback after establishing new session" do
+    @listener.read_data.should.equal "session was initiated"
+  end
+
+  should "make channel variables available through session" do
+    @listener.session.headers[:caller_caller_id_number].should.equal "8675309"
+  end
+
+  behaves_like "events"
+  behaves_like "api commands"
+
+  should "register app" do
+    @listener.respond_to?(:sample_app).should.be.true?
+  end
+end
+
+class OutboundListenerWithNestedApps < Librevox::Listener::Outbound
+  session do
+    sample_app "foo" do
+      sample_app "bar"
+    end
+  end
+end
+
+describe "Outbound listener with apps" do
+  before do
+    @listener = OutboundListenerWithNestedApps.new(nil)
+
+    # Establish session and get rid of connect-string
+    @listener.receive_data("Content-Type: command/reply\nEstablish-Session: OK\n\n")
+    receive_event_and_linger_replies
+    3.times {@listener.outgoing_data.shift}
+  end
+
+  should "only send one app at a time" do
+    @listener.read_data.should == "sendmsg\ncall-command: execute\nexecute-app-name: foo\n\n"
+    @listener.read_data.should == nil
+
+    @listener.receive_data("Content-Type: command/reply\nReply-Text: +OK\n\n")
+    @listener.read_data.should == "sendmsg\ncall-command: execute\nexecute-app-name: bar\n\n"
+    @listener.read_data.should == nil
+  end
+
+  should "not be driven forward by events" do
+    @listener.read_data # sample_app "foo"
+    @listener.receive_data("Content-Type: command/reply\nContent-Length: 45\n\nEvent-Name: CHANNEL_EXECUTE\nSession-Var: Some\n\n")
+    @listener.read_data.should == nil
+  end
+
+  should "not be driven forward by api responses" do
+    @listener.read_data # sample_app "foo"
+    @listener.receive_data("Content-Type: api/response\nContent-Length: 3\n\nFoo")
+    @listener.read_data.should == nil
+  end
+
+  should "not be driven forward by disconnect notifications" do
+    @listener.read_data # sample_app "foo"
+    @listener.receive_data("Content-Type: text/disconnect-notice\nContent-Length: 9\n\nLingering")
+    @listener.read_data.should == nil
+  end
+end
+
+module Librevox::Applications
+  def reader_app(&b)
+    execute_app 'reader_app', [], {:read_var => 'a_reader_var'}, &b
+  end
+end
+
+class OutboundListenerWithReader < Librevox::Listener::Outbound
+  session do
+    reader_app do |data|
+      send_data "read this: #{data}"
+    end
+  end
+end
+
+describe "Outbound listener with app reading data" do
+  before do
+    @listener = OutboundListenerWithReader.new(nil)
+
+    # Establish session and get rid of connect-string
+    @listener.receive_data("Content-Type: command/reply\nSession-Var: First\nUnique-ID: 1234\n\n")
+    receive_event_and_linger_replies
+    3.times {@listener.outgoing_data.shift}
+  end
+
+  should "not send anything while missing response" do
+    @listener.read_data # the command executing reader_app
+    @listener.read_data.should == nil
+  end
+
+  should "send uuid_dump to get channel var, after getting response" do
+    @listener.receive_data("Content-Type: command/reply\nReply-Text: +OK\n\n")
+    @listener.read_data.should == "api uuid_dump 1234\n\n"
+  end
+
+  should "update session with new data" do
+    @listener.receive_data("Content-Type: command/reply\nContent-Length: 3\n\n+OK\n\n")
+    @listener.receive_data("Content-Type: command/reply\nContent-Length: 44\n\nEvent-Name: CHANNEL_DATA\nSession-Var: Second\n\n")
+    @listener.session.content[:session_var].should == "Second"
+  end
+
+  should "pass value of channel variable to block" do
+    @listener.receive_data("Content-Type: command/reply\nContent-Length: 3\n\n+OK\n\n")
+    @listener.receive_data("Content-Type: command/reply\nContent-Length: 59\n\nEvent-Name: CHANNEL_DATA\nvariable_a-reader-var: some value\n\n")
+    @listener.read_data.should == "read this: some value"
+  end
+end
+
+class OutboundListenerWithNonNestedApps < Librevox::Listener::Outbound
+  attr_reader :queue
+  session do
+    sample_app "foo"
+    reader_app do |data|
+      send_data "the end: #{data}"
+    end
+  end
+end
+
+describe "Outbound listener with non-nested apps" do
+  before do
+    @listener = OutboundListenerWithNonNestedApps.new(nil)
+
+    # Establish session and get rid of connect-string
+    @listener.receive_data("Content-Type: command/reply\nSession-Var: First\nUnique-ID: 1234\n\n")
+    receive_event_and_linger_replies
+    3.times {@listener.outgoing_data.shift}
+  end
+
+  should "wait for response before calling next proc" do
+    # response to sample_app
+    @listener.read_data.should.not.match /the end/
+    @listener.receive_data("Content-Type: command/reply\nContent-Length: 3\n\n+OK\n\n")
+
+    # response to reader_app
+    @listener.read_data.should.not.match /the end/
+    @listener.receive_data("Content-Type: command/reply\nContent-Length: 3\n\n+OK\n\n")
+
+    # response to uuid_dump caused by reader_app
+    @listener.read_data.should.not.match /the end/
+    @listener.receive_data("Content-Type: command/reply\nContent-Length: 59\n\nEvent-Name: CHANNEL_DATA\nvariable_a-reader-var: some value\n\n")
+
+    @listener.read_data.should == "the end: some value"
+  end
+end
+
+module Librevox::Commands
+  def sample_cmd(cmd, *args, &b)
+    execute_cmd cmd, *args, &b
+  end
+end
+
+class OutboundListenerWithAppsAndApi < Librevox::Listener::Outbound
+  session do
+    sample_app "foo" do
+      api :sample_cmd, "bar" do
+        sample_app "baz"
+      end
+    end
+  end
+end
+
+describe "Outbound listener with both apps and api calls" do
+  before do
+    @listener = OutboundListenerWithAppsAndApi.new(nil)
+
+    # Establish session and get rid of connect-string
+    @listener.receive_data("Content-Type: command/reply\nSession-Var: First\nUnique-ID: 1234\n\n")
+    receive_event_and_linger_replies
+    3.times {@listener.outgoing_data.shift}
+  end
+
+  should "wait for response before calling next proc" do
+    @listener.read_data.should == "sendmsg\ncall-command: execute\nexecute-app-name: foo\n\n"
+    @listener.receive_data("Content-Type: command/reply\nContent-Length: 3\n\n+OK\n\n")
+
+    @listener.read_data.should == "api bar\n\n"
+    @listener.receive_data("Content-Type: api/response\nContent-Length: 3\n\n+OK\n\n")
+
+    @listener.read_data.should == "sendmsg\ncall-command: execute\nexecute-app-name: baz\n\n"
+  end
+end