librevox 0.1

data/spec/librevox/spec_applications.rb

@@ -0,0 +1,142 @@
+require 'spec/helper'
+require 'librevox/applications'
+
+module ApplicationTest
+  include Librevox::Applications
+
+  extend self
+
+  def execute_app(name, args=[], params={}, &block)
+    {
+      :name   => name,
+      :args   => args,
+      :params => params,
+      :block  => block
+    }
+  end
+end
+
+describe Librevox::Applications do
+  A = ApplicationTest
+
+  should "answer" do
+    app = A.answer
+    app[:name].should == "answer"
+  end
+
+  describe "bind_meta_app" do
+    should "bind meta app" do
+      app = A.bind_meta_app :key => "2",
+                            :listen_to => :a,
+                            :respond_on => :s,
+                            :application => "hangup"
+
+      app[:name].should == "bind_meta_app"
+      app[:args].should == "2 a s hangup"
+    end
+
+    should "bind meta app with parameters" do
+      app = A.bind_meta_app :key => "2",
+                            :listen_to => :a,
+                            :respond_on => :s,
+                            :application => "execute_extension",
+                            :parameters => "dx XML features"
+
+      app[:name].should == "bind_meta_app"
+      app[:args].should == "2 a s execute_extension::dx XML features"
+    end
+  end
+
+  should "bridge" do
+    app = A.bridge('user/coltrane')
+    app[:name].should == "bridge"
+    app[:args].should == 'user/coltrane'
+
+    app = A.bridge('user/coltrane', 'user/davis')
+    app[:args].should == 'user/coltrane,user/davis'
+  end
+
+  should "hangup" do
+    app = A.hangup
+    app[:name].should == "hangup"
+
+    app = A.hangup("some cause")
+    app[:args].should == "some cause"
+  end
+
+  describe "play_and_get_digits" do
+    should "have defaults" do
+      app = A.play_and_get_digits "please-enter", "wrong-try-again"
+      app[:name].should == "play_and_get_digits"
+      app[:args].should == "1 2 3 5000 # please-enter wrong-try-again read_digits_var \\d+"
+      app[:params][:read_var].should == "read_digits_var"
+    end
+
+    should "take params" do
+      app = A.play_and_get_digits "please-enter", "invalid-choice",
+        :min          => 2,
+        :max          => 3,
+        :tries        => 4,
+        :terminators  => "0",
+        :timeout      => 10000,
+        :read_var     => "other_var",
+        :regexp       => "[125]"
+
+      app[:args].should == "2 3 4 10000 0 please-enter invalid-choice other_var [125]"
+      app[:params][:read_var].should == "other_var"
+    end
+  end
+
+  should "playback" do
+    app = A.playback("uri://some/file.wav")
+    app[:name].should == "playback"
+    app[:args].should == "uri://some/file.wav"
+  end
+
+  describe "read" do
+    should "read with defaults" do
+      app = A.read "please-enter.wav"
+      app[:name].should == "read"
+      app[:args].should == "1 2 please-enter.wav read_digits_var 5000 #"
+      app[:params][:read_var].should == "read_digits_var"
+    end
+
+    should "take params" do
+      app = A.read "please-enter.wav",
+        :min          => 2,
+        :max          => 3,
+        :terminators  => "0",
+        :timeout      => 10000,
+        :read_var     => "other_var"
+
+      app[:args].should == "2 3 please-enter.wav other_var 10000 0"
+      app[:params][:read_var].should == "other_var"
+    end
+  end
+
+  describe "record" do
+    should "start recording" do
+      app = A.record "/path/to/file.mp3"
+      app[:name].should == "record"
+      app[:args].should == "/path/to/file.mp3"
+    end
+
+    should "start recording with time limit" do
+      app = A.record "/path/to/file.mp3", :limit => 15
+      app[:name].should == "record"
+      app[:args].should == "/path/to/file.mp3 15"
+    end
+  end
+
+  should "set" do
+    app = A.set("foo", "bar")
+    app[:name].should == "set"
+    app[:args].should == "foo=bar"
+  end
+
+  should "transfer" do
+    app = A.transfer "new_extension"
+    app[:name].should == "transfer"
+    app[:args].should == "new_extension"
+  end
+end

data/spec/librevox/spec_command_socket.rb

@@ -0,0 +1,111 @@
+require 'spec/helper'
+require 'rr'
+require 'mocksocket'
+
+require 'librevox/command_socket'
+
+class Bacon::Context
+  include RR::Adapters::RRMethods
+end
+
+module Librevox
+  module Commands
+    def sample_cmd(args="")
+    execute_cmd "sample_cmd", args
+    end
+  end
+end
+
+describe Librevox::CommandSocket do
+  before do
+    @socket, @server = MockSocket.pipe
+    stub(TCPSocket).open(anything, anything).times(any_times) {@socket}
+
+    @server.print "Content-Type: command/reply\nReply-Text: +OK\n\n"
+  end
+
+  # This should be tested with some mocks. How do we use rr + bacon?
+  describe ":connect => false" do
+    should "not connect" do
+      @cmd = Librevox::CommandSocket.new(:connect => false)
+      @server.should.be.empty?
+    end
+
+    should "connect when asked" do
+      @cmd.connect
+      @server.gets.should == "auth ClueCon\n"
+    end
+  end
+
+  describe "with auto-connect" do
+    before do
+      @cmd = Librevox::CommandSocket.new
+    end
+
+    should "authenticate" do
+      @server.gets.should == "auth ClueCon\n"
+    end
+
+    should "read header response" do
+      @server.print "Content-Type: command/reply\nSome-Header: Some value\n\n"
+      reply = @cmd.run_cmd "foo"
+
+      reply.class.should == Librevox::Response
+      reply.headers[:some_header].should == "Some value"
+    end
+
+    should "read command/reply responses" do
+      @server.print "Content-Type: api/log\nSome-Header: Old data\n\n"
+
+      @server.print "Content-Type: command/reply\nSome-Header: New data\n\n"
+      reply = @cmd.run_cmd "foo"
+
+      reply.headers[:some_header].should == "New data"
+    end
+
+    should "read api/response responses" do
+      @server.print "Content-Type: api/log\nSome-Header: Old data\n\n"
+
+      @server.print "Content-Type: api/response\nSome-Header: New data\n\n"
+      reply = @cmd.run_cmd "foo"
+
+      reply.headers[:some_header].should == "New data"
+    end
+
+    should "read content if present" do
+      @server.print "Content-Type: command/reply\nContent-Length: 3\n\n+OK\n\n"
+      reply = @cmd.run_cmd "foo"
+
+      reply.content.should == "+OK"
+    end
+
+    should "register command" do
+      @cmd.should.respond_to? :sample_cmd
+    end
+
+    describe "registered" do
+      before do
+        2.times {@server.gets} # get rid of the auth message
+      end
+
+      should "send command" do
+        @server.print "Content-Type: command/reply\nContent-Length: 3\n\n+OK\n\n"
+        @cmd.sample_cmd
+        @server.gets.should == "api sample_cmd\n"
+      end
+
+      should "return response from command" do
+        @server.print "Content-Type: command/reply\nContent-Length: 3\n\n+OK\n\n"
+        response = @cmd.sample_cmd
+        response.class.should == Librevox::Response
+        response.content.should == "+OK"
+      end
+
+      should "pass arguments" do
+        @server.print "Content-Type: command/reply\nContent-Length: 3\n\n+OK\n\n"
+        @cmd.sample_cmd("foo bar")
+        @server.gets.should == "api sample_cmd foo bar\n"
+      end
+    end
+  end
+end

data/spec/librevox/spec_commands.rb

@@ -0,0 +1,68 @@
+require 'spec/helper'
+require 'librevox/commands'
+
+module CommandTest
+  include Librevox::Commands
+
+  extend self
+
+  def execute_cmd(name, args="", &block)
+    {
+      :name   => name,
+      :args   => args,
+      :block  => block
+    }
+  end
+end
+
+describe Librevox::Commands do
+  C = CommandTest
+
+  should "status" do
+    cmd = C.status
+    cmd[:name].should == "status"
+  end
+
+  describe "originate" do
+    should "originate url to extension" do
+      cmd = C.originate "user/coltrane", :extension => 4000
+      cmd[:name].should == "originate"
+      cmd[:args].should == "{}user/coltrane 4000"
+    end
+
+    should "send variables" do
+      cmd = C.originate 'user/coltrane',
+                        :extension => 1234,
+                        :ignore_early_media => true,
+                        :other_option => "value"
+
+      cmd[:args].should.match %r|^\{\S+\}user/coltrane 1234$|
+      cmd[:args].should.match /ignore_early_media=true/
+      cmd[:args].should.match /other_option=value/
+    end
+
+    should "take dialplan and context" do
+      cmd = C.originate "user/coltrane",
+                        :extension => "4000",
+                        :dialplan => "XML",
+                        :context => "public"
+      cmd[:name].should == "originate"
+      cmd[:args].should == "{}user/coltrane 4000 XML public"
+    end
+  end
+
+  should "fsctl" do
+    cmd = C.fsctl :hupall, :normal_clearing
+    cmd[:name].should == "fsctl"
+    cmd[:args].should == "hupall normal_clearing"
+  end
+
+  should "huball" do
+    cmd = C.hupall
+    cmd[:name].should == "hupall"
+
+    cmd = C.hupall("some_cause")
+    cmd[:name].should == "hupall"
+    cmd[:args].should == "some_cause"
+  end
+end

data/spec/librevox/spec_response.rb

@@ -0,0 +1,56 @@
+require 'spec/helper'
+require 'librevox/response'
+
+include Librevox
+
+describe Response do
+  should "parse headers to hash" do
+    response = Response.new("Header1:some value\nOther-Header:other value")
+
+    response.headers.should.include :header1
+    response.headers[:header1].should.equal "some value"
+
+    response.headers.should.include :other_header
+    response.headers[:other_header].should.equal "other value"
+  end
+
+  should "parse key-value content to hash" do
+    response = Response.new("", "Key:value\nOther-Key:other value")
+
+    response.content.class.should.equal Hash
+    response.content[:key].should.equal "value"
+    response.content[:other_key].should.equal "other value"
+  end
+
+  should "not parse regular content" do
+    response = Response.new("", "OK.")
+
+    response.content.class.should.equal String
+    response.content.should.equal "OK."
+  end
+
+  should "check for event" do
+    response = Response.new("Content-Type: command/reply", "Event-Name: Hangup")
+    response.event?.should.be.true
+    response.event.should == "Hangup"
+
+    response = Response.new("Content-Type: command/reply", "Foo-Bar: Baz")
+    response.event?.should.be.false
+  end
+
+  should "check for api response" do
+    response = Response.new("Content-Type: api/response", "+OK")
+    response.api_response?.should.be.true
+
+    response = Response.new("Content-Type: command/reply", "Foo-Bar: Baz")
+    response.api_response?.should.be.false
+  end
+
+  should "check for command reply" do
+    response = Response.new("Content-Type: command/reply", "+OK")
+    response.command_reply?.should.be.true
+
+    response = Response.new("Content-Type: api/response", "Foo-Bar: Baz")
+    response.command_reply?.should.be.false
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: librevox
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Harry Vangberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-14 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: |-
+  EventMachine-based Ruby library for interacting with the
+  open source telephony platform FreeSwitch.
+email: harry@vangberg.name
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+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
+has_rdoc: true
+homepage: http://github.com/ichverstehe/librevox
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby library for interacting with FreeSWITCH.
+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