librevox 0.2 → 0.2.1

data/README.md

@@ -124,13 +124,32 @@ Multiple listeners can be started at once by passing a block to `Librevox.start`
       run OtherListener, :port => "8080"
     end
 
+## Closing connection
+
+After a session has finished, e.g. because the calling part hangs up, an
+outbound socket still has its connection to FreeSWITCH open, so we can get post-
+session events. Therefore it is important that you close the connection manually
+when you are done. Otherwise you will have 'hanging' sessions, cloggering up
+your system. This can safely be done with `close_connection_after_writing`,
+which will wait for all outgoing data to be send before closing the connection.
+It is aliased as `done` for convenience.
+
+Unless you are doing something specific, closing the connection on CHANNEL_HANGUP
+is most likely sufficient:
+    
+    class MyListener < Librevox::Listener::Outbound
+      event :channel_hangup do
+        done
+      end
+    end
+
 ## Using `Librevox::CommandSocket`
 
 Librevox also ships with a CommandSocket class, which allows you to connect
 to the FreeSWITCH management console, from which you can originate calls,
 restart FreeSWITCH etc.
 
-    >> require `librevox`
+    >> require `librevox/command_socket`
     => true
     
     >> socket = Librevox::CommandSocket.new
@@ -158,7 +177,7 @@ the `Librevox::Commands` and `Librevox::Applications` modules.
 
 ## License
 
-(c) 2009 Harry Vangberg <harry@vangberg.name>
+(c) 2009, 2010 Harry Vangberg <harry@vangberg.name>
 
 Librevox was inspired by and uses code from Freeswitcher, which is distributed
 under the MIT license and (c) 2009 The Rubyists (Jayson Vaughn, Tj Vanderpoel,

data/lib/librevox/listener/base.rb

@@ -10,7 +10,7 @@ module Librevox
           @hooks ||= []
         end
 
-        def event(event, &block)
+        def event event, &block
           hooks << [event, block]
         end
       end
@@ -23,20 +23,20 @@ module Librevox
       class CommandDelegate
         include Librevox::Commands
 
-        def initialize(listener)
+        def initialize listener
           @listener = listener
         end
 
-        def run_cmd(*args, &block)
+        def run_cmd *args, &block
           @listener.run_cmd *args, &block
         end
       end
 
-      def api(cmd, *args, &block)
+      def api cmd, *args, &block
         @command_delegate.send(cmd, *args, &block)
       end
 
-      def run_cmd(cmd, &block)
+      def run_cmd cmd, &block
         send_data "#{cmd}\n\n"
         @command_queue << (block || lambda {})
       end
@@ -49,19 +49,22 @@ module Librevox
         @command_queue = []
       end
 
-      def receive_request(header, content)
+      def receive_request header, content
         @response = Librevox::Response.new(header, content)
+        handle_response
+      end
 
-        if response.event?
+      def handle_response
+        if response.api_response? && @command_queue.any?
+          invoke_command_queue
+        elsif response.event?
           on_event response.dup
           invoke_event_hooks
-        elsif response.api_response? && @command_queue.any?
-          invoke_command_queue
         end
       end
 
       # override
-      def on_event(event)
+      def on_event event
       end
 
       alias :done :close_connection_after_writing
@@ -77,7 +80,7 @@ module Librevox
 
       def invoke_command_queue
         block = @command_queue.shift
-        block.call(response)
+        block.call response
       end
     end
   end

data/lib/librevox/listener/outbound.rb

@@ -6,7 +6,7 @@ module Librevox
     class Outbound < Base
       include Librevox::Applications
 
-      def execute_app(app, args="", params={}, &block)
+      def execute_app app, args="", params={}, &block
         msg = "sendmsg\n"
         msg << "call-command: execute\n"
         msg << "execute-app-name: #{app}\n"
@@ -24,7 +24,7 @@ module Librevox
       end
 
       # This should probably be in Application#sendmsg instead.
-      def sendmsg(msg)
+      def sendmsg msg 
         send_data "sendmsg\n%s" % msg
       end
 
@@ -46,9 +46,7 @@ module Librevox
         @application_queue << lambda {}
       end
 
-      def receive_request(*args)
-        super(*args)
-        
+      def handle_response
         if session.nil?
           @session = response.headers
           session_initiated
@@ -58,6 +56,8 @@ module Librevox
         elsif response.command_reply? && !response.event?
           @application_queue.shift.call if @application_queue.any?
         end
+
+        super
       end
 
       def resume_with_channel_var
@@ -68,8 +68,9 @@ module Librevox
         end
       end
 
-      def update_session
-        send_data("api uuid_dump #{session[:unique_id]}\n\n")
+      def update_session &block
+        send_data "api uuid_dump #{session[:unique_id]}\n\n"
+        @command_queue << (block || lambda {})
       end
     end
   end

data/lib/librevox.rb

@@ -4,7 +4,7 @@ require 'librevox/listener/inbound'
 require 'librevox/listener/outbound'
 
 module Librevox
-  VERSION = "0.2"
+  VERSION = "0.2.1"
 
   def self.options
     @options ||= {

data/librevox.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name     = "librevox"
-  s.version  = "0.2"
-  s.date     = "2010-01-26"
+  s.version  = "0.2.1"
+  s.date     = "2010-02-09"
   s.summary  = "Ruby library for interacting with FreeSWITCH."
   s.email    = "harry@vangberg.name"
   s.homepage = "http://github.com/ichverstehe/librevox"

data/spec/librevox/listener/spec_outbound.rb

@@ -135,7 +135,7 @@ describe "Outbound listener with app reading data" do
 
   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.receive_data("Content-Type: api/response\nContent-Length: 44\n\nEvent-Name: CHANNEL_DATA\nSession-Var: Second\n\n")
     @listener.session[:session_var].should == "Second"
   end
 
@@ -219,3 +219,30 @@ describe "Outbound listener with both apps and api calls" do
     @listener.read_data.should == "sendmsg\ncall-command: execute\nexecute-app-name: baz\n\n"
   end
 end
+
+class OutboundListenerWithUpdateSessionCallback < Librevox::Listener::Outbound
+  def session_initiated
+    update_session do
+      send_data "yay, #{session[:session_var]}"
+    end
+  end
+end
+
+describe "Outbound listener with update session callback" do
+  before do
+    @listener = OutboundListenerWithUpdateSessionCallback.new(nil)
+    @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}
+
+    @listener.receive_data("Content-Type: api/response\nContent-Length: 44\n\nEvent-Name: CHANNEL_DATA\nSession-Var: Second\n\n")
+  end
+
+  should "execute callback" do
+    @listener.read_data.should =~ /^yay,/
+  end
+
+  should "update session before calling callback" do
+    @listener.read_data.should == "yay, Second"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: librevox
 version: !ruby/object:Gem::Version 
-  version: "0.2"
+  version: 0.2.1
 platform: ruby
 authors: 
 - Harry Vangberg
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-26 00:00:00 +01:00
+date: 2010-02-09 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -61,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.3
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Ruby library for interacting with FreeSWITCH.