freeswitcher 0.4.2 → 0.4.3

data/spec/fsr/listener/header_and_content_response.rb

@@ -4,13 +4,22 @@ require 'fsr/listener/header_and_content_response'
 describe FSL::HeaderAndContentResponse do
   HCR = FSL::HeaderAndContentResponse
 
-  it "is initializable with 2 hash arguments" do
+  before do
     header = {:foo => "bar", :jumbo => "shrimp"}
-    content = {:response => "w00t"}
-    hcr = HCR.new({:headers => header, :content => content})
-    hcr.headers.should.include? :foo
-    hcr.content.should.include? :response
+    content = {:response => "w00t\n"}
+    @hcr = HCR.new({:headers => header, :content => content})
   end
+
+  it "is initializable with 2 hash arguments" do
+    @hcr.headers.should.include? :foo
+    @hcr.content.should.include? :response
+  end
+
+  it "strips newlines from content values" do
+    @hcr.content[:response].should == "w00t"
+  end
+end
+
 =begin manveru's future specs
 
   it "can be created with headers" do
@@ -45,4 +54,3 @@ describe FSL::HeaderAndContentResponse do
   end
 
 =end
-end

data/spec/fsr/listener/inbound.rb

@@ -1,30 +1,39 @@
 require 'spec/helper'
+require 'lib/fsr'
 require "fsr/listener"
 require "fsr/listener/inbound"
-gem "tmm1-em-spec"
 require "em/spec"
 
 # Bare class to use for testing
 class InboundListener < FSR::Listener::Inbound
   attr_accessor :test_event
 
+  # Stub error? out
+  def error?
+    false
+  end
+
   def initialize(*args)
     super(*args)
     @test_event = nil
   end
 
-  def on_event(event)
+  def on_event
     recvd_event << event
   end
 
   def recvd_event
     @recvd_event ||= []
   end
+end
 
+class InboundListener2 < InboundListener
+  def before_session
+    add_event(:TEST_EVENT) {recvd_event << event}
+  end
 end
 
 describe "Testing FSR::Listener::Inbound" do
-
   it "defines #post_init" do
     FSR::Listener::Inbound.method_defined?(:post_init).should == true
   end
@@ -35,13 +44,12 @@ describe "Testing FSR::Listener::Inbound" do
     FSL::Inbound.del_event_hook(:CHANNEL_CREATE)
     FSL::Inbound::HOOKS.size.should == 0
   end
-
 end
 
 EM.describe InboundListener do
-
   before do
-    @listener = InboundListener.new("test", {:auth => 'SecretPassword'})
+    @listener = InboundListener.new(1234, {:auth => 'SecretPassword'})
+    @listener2 = InboundListener2.new(1234, {:auth => 'SecretPassword'})
   end
 
   should "be able to receive an event and call the on_event callback method" do
@@ -50,8 +58,15 @@ EM.describe InboundListener do
     done
   end
 
+  should "be able to add custom event hooks in the pre_session" do
+    @listener2.receive_data("Content-Length: 22\n\nEvent-Name: TEST_EVENT\n\n")
+    @listener2.recvd_event.first.content[:event_name].should.equal "TEST_EVENT"
+    done
+  end
+
   should "be able to add custom event hooks" do
-    FSL::Inbound.add_event_hook(:HANGUP_EVENT) {|event| @listener.test_event = event}
+    listener = @listener
+    FSL::Inbound.add_event_hook(:HANGUP_EVENT) {listener.test_event = event}
     @listener.test_event.should.equal nil
     @listener.receive_data("Content-Length: 24\n\nEvent-Name: HANGUP_EVENT\n\n")
     @listener.test_event.content[:event_name].should.equal "HANGUP_EVENT"
@@ -62,5 +77,4 @@ EM.describe InboundListener do
     @listener.auth.should.equal 'SecretPassword'
     done
   end
-
 end

data/spec/fsr/listener/outbound.rb

@@ -1,12 +1,12 @@
 require "lib/fsr"
 require FSR::ROOT/".."/:spec/:helper
 require FSR::ROOT/:fsr/:listener/:outbound
-gem "tmm1-em-spec"
 require "em/spec"
 
 # Bare class to use for testing
 class MyListener < FSR::Listener::Outbound
-  attr_accessor :recvd_reply, :state_machine_test
+  attr_accessor :recvd_reply, :state_machine_test, :state_machine_test2
+  attr_reader :queue
 
   def session_initiated
   end
@@ -31,6 +31,10 @@ class MyListener < FSR::Listener::Outbound
     @queue.unshift block if block_given? 
   end
 
+  def set(var, value, &block)
+     @queue.unshift(block_given? ? block : lambda {})
+  end
+
   def test_state_machine
     @state_machine_test = nil
     do_something do 
@@ -46,6 +50,12 @@ class MyListener < FSR::Listener::Outbound
     end
   end
 
+  def test_state_machine_without_blocks
+    answer
+    set("test", "test1")
+    set("another_one", "bites_the_dust")
+  end
+
 end
 
 # Begin testing MyListener
@@ -106,6 +116,20 @@ EM.describe MyListener do
     done
   end
 
+  should "use implicit blocks to 'fake' I/O blocking and wait for a response before calling the next implicit block" do
+    @listener.receive_data("Content-Length: 0\nEstablished-Session: session\n\n")
+    @listener.test_state_machine_without_blocks
+    @listener.queue.size.should.equal 3
+    @listener.receive_data("Content-Length: 3\n\nOk\n\n")
+    @listener.queue.size.should.equal 2
+    @listener.receive_data("Content-Length: 3\n\nOk\n\n")
+    @listener.queue.size.should.equal 1
+    @listener.receive_data("Content-Length: 3\n\nOk\n\n")
+    @listener.queue.empty?.should.equal true
+    done
+  end
+
+
   should "be able to update an existing session" do
     @listener.receive_data("Content-Length: 0\nUnique-ID: abcd-1234-efgh-5678\n\n")
     @listener.session.headers[:unique_id].should.equal "abcd-1234-efgh-5678"

data/spec/fsr/loading.rb

@@ -4,7 +4,7 @@ require 'spec/helper'
 describe "Testing FSR module loading methods" do
   # When you add applications  you must modify the expected apps_loaded behavior
   it "Loads all applications" do
-    all_apps = [:play_and_get_digits, :uuid_dump, :uuid_setvar, :uuid_getvar, :read, :set, :transfer, :speak, :fs_sleep, :playback, :answer, :fifo, :bridge, :hangup, :conference, :fs_break, :log, :limit]
+    all_apps = [:play_and_get_digits, :uuid_dump, :uuid_setvar, :uuid_getvar, :read, :set, :transfer, :speak, :fs_sleep, :playback, :answer, :fifo, :bridge, :hangup, :conference, :fs_break, :log, :limit, :bind_meta_app, :execute_app]
     # Add any apps which will load to this set
     apps_loaded = FSR.load_all_applications
     apps_loaded.kind_of?(Array).should == true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: freeswitcher
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors: 
 - Jayson Vaughn
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-03 00:00:00 -05:00
+date: 2009-11-18 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,7 +25,94 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: &id001 |
+description: "========================================================= FreeSWITCHeR Copyright (c) 2009 The Rubyists (Jayson Vaughn, Tj Vanderpoel, Michael Fellinger, Kevin Berry)  Distributed under the terms of the MIT License. ==========================================================  ABOUT ----- A ruby library for interacting with the \"FreeSWITCH\" (http://www.freeswitch.org) opensource telephony platform  REQUIREMENTS ------------ * ruby (>= 1.8) * eventmachine (If you wish to use Outbound and Inbound listener)  USAGE -----  An Outbound Event Listener Example that reads and returns DTMF input: --------------------------------------------------------------------  Simply just create a subclass of FSR::Listner::Outbound and all new calls/sessions will invoke the \"session_initiated\" callback method.  <b>NOTE</b>: FSR uses blocks within the 'session_inititated' method to ensure that the next \"freeswich command\" is not executed until the previous \"Freeswitch command\" has finished.  (Basically a continuation) This is kicked off by \"answer do\".   #!/usr/bin/ruby require 'fsr' require 'fsr/listener/outbound'  class OutboundDemo < FSR::Listener::Outbound  def session_initiated exten = @session.headers[:caller_caller_id_number] FSR::Log.info \"*** Answering incoming call from #{exten}\"  answer do FSR::Log.info \"***Reading DTMF from #{exten}\" read(\"/home/freeswitch/freeswitch/sounds/music/8000/sweet.wav\", 4, 10, \"input\", 7000) do |read_var| FSR::Log.info \"***Success, grabbed #{read_var.to_s.strip} from #{exten}\" # Tell the caller what they entered speak(\"Got the DTMF of: #{read_var.to_s.strip}\") do  #Hangup the call hangup  end end end  end  end  FSR.start_oes! OutboundDemo, :port => 8084, :host => \"127.0.0.1\"  An Inbound Event Socket Listener example using FreeSWITCHeR's hook system: --------------------------------------------------------------------------  #!/usr/bin/ruby require 'pp' require 'fsr' require \"fsr/listener/inbound\"  # EXAMPLE 1  # This adds a hook on CHANNEL_CREATE events. You can also create a method to handle the event you're after. See the next example FSL::Inbound.add_event_hook(:CHANNEL_CREATE) { FSR::Log.info \"*** [#{event.content[:unique_id]}] Channel created - greetings from the hook!\" }  # EXAMPLE 2 # Define a method to handle CHANNEL_HANGUP events. def custom_channel_hangup_handler(event) FSR::Log.info \"*** [#{event.content[:unique_id]}] Channel hangup. The event:\" pp event end  # This adds a hook for EXAMPLE 2 FSL::Inbound.add_event_hook(:CHANNEL_HANGUP) { custom_channel_hangup_handler(event) }   # Start FSR Inbound Listener FSR.start_ies!(FSL::Inbound, :host => \"localhost\", :port => 8021)   An Inbound Event Socket Listener example using the on_event callback method instead of hooks: ---------------------------------------------------------------------------------------------  #!/usr/bin/ruby require 'pp' require 'fsr' require \"fsr/listener/inbound\"   class IesDemo < FSR::Listener::Inbound  def on_event pp event.headers pp event.content[:event_name] end  end  FSR.start_ies!(IesDemo, :host => \"localhost\", :port => 8021, :auth => \"ClueCon\")   An example of using FSR::CommandSocket to originate a new call in irb: ----------------------------------------------------------------------  irb(main):001:0> require 'fsr' => true  irb(main):002:0> FSR.load_all_commands => [:sofia, :originate]  irb(main):003:0> sock = FSR::CommandSocket.new => #<FSR::CommandSocket:0xb7a89104 @server=\"127.0.0.1\", @socket=#<TCPSocket:0xb7a8908c>, @port=\"8021\", @auth=\"ClueCon\">  irb(main):007:0> sock.originate(:target => 'sofia/gateway/carlos/8179395222', :endpoint => FSR::App::Bridge.new(\"user/bougyman\")).run => {\"Job-UUID\"=>\"732075a4-7dd5-4258-b124-6284a82a5ae7\", \"body\"=>\"\", \"Content-Type\"=>\"command/reply\", \"Reply-Text\"=>\"+OK Job-UUID: 732075a4-7dd5-4258-b124-6284a82a5ae7\"}    SUPPORT ------- Home page at http://code.rubyists.com/projects/fs #rubyists on FreeNode"
+email: FreeSWITCHeR@rubyists.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- AUTHORS
+- CHANGELOG
+- License.txt
+- MANIFEST
+- NEWS
+- README
+- Rakefile
+- examples/inbound_event_socket.rb
+- examples/inbound_socket_events.rb
+- examples/outbound_event_socket.rb
+- freeswitcher.gemspec
+- lib/fsr.rb
+- lib/fsr/app.rb
+- lib/fsr/app/answer.rb
+- lib/fsr/app/bind_meta_app.rb
+- lib/fsr/app/bridge.rb
+- lib/fsr/app/conference.rb
+- lib/fsr/app/execute_app.rb
+- lib/fsr/app/fifo.rb
+- lib/fsr/app/fs_break.rb
+- lib/fsr/app/fs_sleep.rb
+- lib/fsr/app/hangup.rb
+- lib/fsr/app/limit.rb
+- lib/fsr/app/log.rb
+- lib/fsr/app/play_and_get_digits.rb
+- lib/fsr/app/playback.rb
+- lib/fsr/app/read.rb
+- lib/fsr/app/set.rb
+- lib/fsr/app/speak.rb
+- lib/fsr/app/transfer.rb
+- lib/fsr/app/uuid_dump.rb
+- lib/fsr/app/uuid_getvar.rb
+- lib/fsr/app/uuid_setvar.rb
+- lib/fsr/cmd.rb
+- lib/fsr/cmd/calls.rb
+- lib/fsr/cmd/fsctl.rb
+- lib/fsr/cmd/originate.rb
+- lib/fsr/cmd/sofia.rb
+- lib/fsr/cmd/sofia/profile.rb
+- lib/fsr/cmd/sofia/status.rb
+- lib/fsr/cmd/sofia_contact.rb
+- lib/fsr/cmd/status.rb
+- lib/fsr/cmd/uuid_dump.rb
+- lib/fsr/command_socket.rb
+- lib/fsr/database.rb
+- lib/fsr/database/call_limit.rb
+- lib/fsr/database/core.rb
+- lib/fsr/database/sofia_reg_external.rb
+- lib/fsr/database/sofia_reg_internal.rb
+- lib/fsr/database/voicemail_default.rb
+- lib/fsr/event_socket.rb
+- lib/fsr/fake_socket.rb
+- lib/fsr/listener.rb
+- lib/fsr/listener/header_and_content_response.rb
+- lib/fsr/listener/inbound.rb
+- lib/fsr/listener/inbound/event.rb
+- lib/fsr/listener/mock.rb
+- lib/fsr/listener/outbound.rb
+- lib/fsr/model/call.rb
+- lib/fsr/version.rb
+- tasks/authors.rake
+- tasks/bacon.rake
+- tasks/changelog.rake
+- tasks/copyright.rake
+- tasks/gem.rake
+- tasks/gem_installer.rake
+- tasks/install_dependencies.rake
+- tasks/manifest.rake
+- tasks/release.rake
+- tasks/reversion.rake
+- tasks/setup.rake
+- tasks/spec.rake
+- tasks/yard.rake
+- spec/helper.rb
+- spec/fsr_listener_helper.rb
+has_rdoc: false
+homepage: http://code.rubyists.com/projects/fs
+post_install_message: |
   =========================================================
   FreeSWITCHeR
   Copyright (c) 2009 The Rubyists (Jayson Vaughn, Tj Vanderpoel, Michael Fellinger, Kevin Berry) 
@@ -50,7 +137,7 @@ description: &id001 |
   Simply just create a subclass of FSR::Listner::Outbound and all
   new calls/sessions will invoke the "session_initiated" callback method.
    
-  <b>NOTE</b>: FSR uses blocks within the 'session_inititated' method to ensure that the next "freeswich command" is not executed until the previous "Freeswitch command" has finished.  This is kicked off by "answer do"
+  <b>NOTE</b>: FSR uses blocks within the 'session_inititated' method to ensure that the next "freeswich command" is not executed until the previous "Freeswitch command" has finished.  (Basically a continuation) This is kicked off by "answer do". 
   
     #!/usr/bin/ruby
     require 'fsr'
@@ -65,9 +152,9 @@ description: &id001 |
         answer do
           FSR::Log.info "***Reading DTMF from #{exten}"
           read("/home/freeswitch/freeswitch/sounds/music/8000/sweet.wav", 4, 10, "input", 7000) do |read_var|
-            FSR::Log.info "***Success, grabbed #{read_var.strip} from #{exten}"
+            FSR::Log.info "***Success, grabbed #{read_var.to_s.strip} from #{exten}"
             # Tell the caller what they entered
-            speak("Got the DTMF of: #{read_var}") do 
+            speak("Got the DTMF of: #{read_var.to_s.strip}") do 
               #Hangup the call
               hangup 
             end
@@ -90,7 +177,7 @@ description: &id001 |
   
     # EXAMPLE 1 
     # This adds a hook on CHANNEL_CREATE events. You can also create a method to handle the event you're after. See the next example
-    FSL::Inbound.add_event_hook(:CHANNEL_CREATE) {|event| FSR::Log.info "*** [#{event.content[:unique_id]}] Channel created - greetings from the hook!" }
+    FSL::Inbound.add_event_hook(:CHANNEL_CREATE) { FSR::Log.info "*** [#{event.content[:unique_id]}] Channel created - greetings from the hook!" }
   
     # EXAMPLE 2
     # Define a method to handle CHANNEL_HANGUP events.
@@ -100,7 +187,7 @@ description: &id001 |
     end
   
     # This adds a hook for EXAMPLE 2
-    FSL::Inbound.add_event_hook(:CHANNEL_HANGUP) {|event| custom_channel_hangup_handler(event) }
+    FSL::Inbound.add_event_hook(:CHANNEL_HANGUP) { custom_channel_hangup_handler(event) }
   
   
     # Start FSR Inbound Listener
@@ -118,7 +205,7 @@ description: &id001 |
   
     class IesDemo < FSR::Listener::Inbound
   
-      def on_event(event)
+      def on_event
         pp event.headers
         pp event.content[:event_name]
       end
@@ -150,93 +237,6 @@ description: &id001 |
   Home page at http://code.rubyists.com/projects/fs
   #rubyists on FreeNode
 
-email: FreeSWITCHeR@rubyists.com
-executables: []
-
-extensions: []
-
-extra_rdoc_files: []
-
-files: 
-- .gitignore
-- AUTHORS
-- CHANGELOG
-- License.txt
-- MANIFEST
-- NEWS
-- README
-- Rakefile
-- examples/inbound_event_socket.rb
-- examples/inbound_socket_events.rb
-- examples/outbound_event_socket.rb
-- freeswitcher.gemspec
-- lib/fsr.rb
-- lib/fsr/app.rb
-- lib/fsr/app/answer.rb
-- lib/fsr/app/bridge.rb
-- lib/fsr/app/conference.rb
-- lib/fsr/app/fifo.rb
-- lib/fsr/app/fs_break.rb
-- lib/fsr/app/fs_sleep.rb
-- lib/fsr/app/hangup.rb
-- lib/fsr/app/limit.rb
-- lib/fsr/app/log.rb
-- lib/fsr/app/play_and_get_digits.rb
-- lib/fsr/app/playback.rb
-- lib/fsr/app/read.rb
-- lib/fsr/app/set.rb
-- lib/fsr/app/speak.rb
-- lib/fsr/app/transfer.rb
-- lib/fsr/app/uuid_dump.rb
-- lib/fsr/app/uuid_getvar.rb
-- lib/fsr/app/uuid_setvar.rb
-- lib/fsr/cmd.rb
-- lib/fsr/cmd/calls.rb
-- lib/fsr/cmd/fsctl.rb
-- lib/fsr/cmd/originate.rb
-- lib/fsr/cmd/sofia.rb
-- lib/fsr/cmd/sofia/profile.rb
-- lib/fsr/cmd/sofia/status.rb
-- lib/fsr/cmd/sofia_contact.rb
-- lib/fsr/cmd/status.rb
-- lib/fsr/cmd/uuid_dump.rb
-- lib/fsr/command_socket.rb
-- lib/fsr/database.rb
-- lib/fsr/database/call_limit.rb
-- lib/fsr/database/core.rb
-- lib/fsr/database/sofia_reg_external.rb
-- lib/fsr/database/sofia_reg_internal.rb
-- lib/fsr/database/voicemail_default.rb
-- lib/fsr/event_socket.rb
-- lib/fsr/fake_socket.rb
-- lib/fsr/listener.rb
-- lib/fsr/listener/header_and_content_response.rb
-- lib/fsr/listener/inbound.rb
-- lib/fsr/listener/inbound/event.rb
-- lib/fsr/listener/mock.rb
-- lib/fsr/listener/outbound.rb
-- lib/fsr/model/call.rb
-- lib/fsr/version.rb
-- tasks/authors.rake
-- tasks/bacon.rake
-- tasks/changelog.rake
-- tasks/copyright.rake
-- tasks/gem.rake
-- tasks/gem_installer.rake
-- tasks/install_dependencies.rake
-- tasks/manifest.rake
-- tasks/release.rake
-- tasks/reversion.rake
-- tasks/setup.rake
-- tasks/spec.rake
-- tasks/yard.rake
-- spec/helper.rb
-- spec/fsr_listener_helper.rb
-has_rdoc: true
-homepage: http://code.rubyists.com/projects/fs
-licenses: []
-
-post_install_message: *id001
 rdoc_options: []
 
 require_paths: 
@@ -256,15 +256,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: freeswitcher
-rubygems_version: 1.3.4
+rubygems_version: 1.3.1
 signing_key: 
-specification_version: 3
+specification_version: 2
 summary: A library for interacting with the "FreeSWITCH":http://freeswitch.org telephony platform
 test_files: 
 - spec/fsr/app.rb
 - spec/fsr/app/answer.rb
+- spec/fsr/app/bind_meta_app.rb
 - spec/fsr/app/bridge.rb
 - spec/fsr/app/conference.rb
+- spec/fsr/app/execute_app.rb
 - spec/fsr/app/fifo.rb
 - spec/fsr/app/fs_break.rb
 - spec/fsr/app/fs_sleep.rb