freeswitcher 0.3.1 → 0.4.0

data/AUTHORS

@@ -1,14 +1,15 @@
 Following persons have contributed to freeswitcher.
 (Sorted by number of submitted patches, then alphabetically)
 
-   118 TJ Vanderpoel <bougy.man@gmail.com>
+   123 TJ Vanderpoel <bougy.man@gmail.com>
     64 Jayson Vaughn <jayson@onedrop.home>
-    28 Michael Fellinger <m.fellinger@gmail.com>
-    11 Jayson Vaughn <jayson@onedrop.(none)>
+    40 Michael Fellinger <m.fellinger@gmail.com>
+    15 Jayson Vaughn <jayson@onedrop.(none)>
      9 Jayson Vaughn <jayson@onedrop.nationwide-recovery.com>
+     7 Jayson Vaughn <vaughn.jayson@gmail.com>
      6 Mikael Bjerkeland <mikael@consoll.no>
      4 foo <jvaughn@hellspass.nationwide-recovery.com>
-     4 Jayson Vaughn <vaughn.jayson@gmail.com>
      3 Kevin Berry <kevin@opensourcealchemist.com>
+     2 freeswitch <freeswitch@falcon.(none)>
      1 jayson vaughn <jayson@falcon.(none)>
      1 U-Paul-PC\Paul <Paul@Paul-PC.(none)>

data/CHANGELOG

@@ -1,3 +1,92 @@
+[55753af | Wed Jun 03 23:10:22 UTC 2009] Jayson Vaughn <vaughn.jayson@gmail.com>
+
+  * Updated outbound_event_socket.rb example
+
+[234a17e | Wed Jun 03 23:01:56 UTC 2009] Jayson Vaughn <vaughn.jayson@gmail.com>
+
+  * Refactored api to be a method of FSR::Listener::Outbound
+
+[0bc8973 | Wed Jun 03 21:55:02 UTC 2009] Jayson Vaughn <vaughn.jayson@gmail.com>
+
+  * Added FSR::App::Api
+
+[9d2cc41 | Sat May 30 18:49:08 UTC 2009] Jayson Vaughn <jayson@onedrop.(none)>
+
+  * Made some changes so FSR is Ruby 1.9.1 compat
+
+      * Monkey patched, unfortunately, String class with alias :each
+      * :each_line compat with EventMachine
+
+[a40e1ed | Sat May 30 18:10:35 UTC 2009] Jayson Vaughn <jayson@onedrop.(none)>
+
+  * Corrected typo in examples/outbound_event_socket.rb
+
+[0a3f680 | Fri May 29 16:15:15 UTC 2009] Jayson Vaughn <jayson@onedrop.(none)>
+
+  * Added .to_s at end of Dir[load_path.join("*.rb").to_s] for Ruby 1.9.1
+
+
+
+[f267c17 | Wed May 27 20:49:27 UTC 2009] Jayson Vaughn <jayson@onedrop.(none)>
+
+  * Updated header_and_content specs
+
+[19ee736 | Sat May 23 18:34:18 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * Change example and readme to match what is demoed at sip:8084@falcon.rubyists.com
+
+[5be4271 | Tue May 19 21:02:09 UTC 2009] freeswitch <freeswitch@falcon.(none)>
+
+  * try to load log4r for logging (Logger buffers, bugs with runit services), fall back to Logger from stdlib if log4r not found
+
+[921251a | Tue May 19 20:13:47 UTC 2009] freeswitch <freeswitch@falcon.(none)>
+
+  * reverted regression to listeners, back to functional
+
+[eb72db4 | Tue May 19 15:15:04 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * changed spacing in content#find
+
+[c275898 | Tue May 19 15:12:39 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * improve the regex for matching a header: value in content of HeaderAndContentResponse
+
+[4bfaf24 | Wed May 20 05:05:07 UTC 2009] Michael Fellinger <m.fellinger@gmail.com>
+
+  * headers/content come in as Array
+
+[5640b6f | Wed May 20 04:54:42 UTC 2009] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Fix the listener/outbound spec
+
+[29527e2 | Tue May 19 23:20:24 UTC 2009] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Minor cleanup
+
+[38b98fa | Tue May 19 21:04:41 UTC 2009] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Add some more outbound specs and refactor
+
+[817e731 | Tue May 19 21:04:22 UTC 2009] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Add HeaderAndContentResponse subclass that will take care of parsing the content if it should be parsed
+
+[d44c3f0 | Tue May 19 20:45:48 UTC 2009] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Minor refactor and some more specs for inbound listener
+
+[4f945e5 | Tue May 19 20:28:53 UTC 2009] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Refactor and basic specs of HeaderAndContentResponse, integration with inbound/outbound follow
+
+[e3c3142 | Tue May 19 19:29:21 UTC 2009] Michael Fellinger <m.fellinger@gmail.com>
+
+  * A little bit less annoying require_relative look-alike
+
+[e80cbc1 | Tue May 19 00:27:53 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * updated authors and changelog
+
 [9451ba8 | Tue May 19 00:26:26 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
 
   * Version 0.3.1 fixes bug in FS_ROOT not being populated properly
@@ -516,6 +605,10 @@
 
 
 
+[ab373dd | Tue Mar 24 00:52:38 UTC 2009] Michael Fellinger <m.fellinger@gmail.com>
+
+  * Remove cruft from form helper
+
 [0464d4e | Thu Mar 19 19:17:41 UTC 2009] Jayson Vaughn <jayson@onedrop.home>
 
   * Updated specs to include new apps

data/MANIFEST

@@ -90,6 +90,7 @@ spec/fsr/cmd/originate.rb
 spec/fsr/cmd/sofia.rb
 spec/fsr/cmd/sofia/profile.rb
 spec/fsr/listener.rb
+spec/fsr/listener/header_and_content_response.rb
 spec/fsr/listener/inbound.rb
 spec/fsr/listener/outbound.rb
 spec/fsr/loading.rb

data/README

@@ -37,8 +37,12 @@ new calls/sessions will invoke the "session_initiated" callback method.
       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}"
-            hangup #Hangup the call
+          FSR::Log.info "***Success, grabbed #{read_var.strip} from #{exten}"
+          # Tell the caller what they entered
+          speak("Got the DTMF of: #{read_var}") do 
+            #Hangup the call
+            hangup 
+          end
         end
       end
 

data/examples/outbound_event_socket.rb

@@ -12,9 +12,14 @@ class OutboundDemo < FSR::Listener::Outbound
 
     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|
+      #######################################################
+      ## NOTE YOU MUST MAKE SURE YOU PASS A VALID WAV FILE ##
+      #######################################################
+      read("/usr/local/freeswitch/sounds/music/8000/sweet.wav", 4, 10, "input", 7000) do |read_var|
           FSR::Log.info "***Success, grabbed #{read_var.strip} from #{exten}"
-          hangup #Hangup the call
+          # Tell the caller what they entered
+          # If you have mod_flite installed you should hear speech
+          speak("Got the DTMF of: #{read_var}") 
       end
     end
 

data/freeswitcher.gemspec

@@ -2,14 +2,137 @@
 
 Gem::Specification.new do |s|
   s.name = %q{freeswitcher}
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jayson Vaughn", "Michael Fellinger", "Kevin Berry", "TJ Vanderpoel"]
-  s.date = %q{2009-05-18}
-  s.description = %q{========================================================= 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.  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.strip} from #{exten}" hangup #Hangup the call 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) {|event| 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) {|event| 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(event) pp event.headers pp event.content[:event_name] end  end  FSR.start_ies!(IesDemo, :host => "localhost", :port => 8021)   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}
+  s.date = %q{2009-06-03}
+  s.description = %q{=========================================================
+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.  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.strip} from #{exten}"
+          # Tell the caller what they entered
+          speak("Got the DTMF of: #{read_var}") 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) {|event| 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) {|event| 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(event)
+      pp event.headers
+      pp event.content[:event_name]
+    end
+
+  end
+
+  FSR.start_ies!(IesDemo, :host => "localhost", :port => 8021)
+
+
+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
+}
   s.email = %q{FreeSWITCHeR@rubyists.com}
-  s.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/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/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/rcov.rake", "tasks/release.rake", "tasks/reversion.rake", "tasks/setup.rake", "tasks/spec.rake", "tasks/yard.rake", "spec/helper.rb", "spec/fsr/app.rb", "spec/fsr/app/answer.rb", "spec/fsr/app/bridge.rb", "spec/fsr/app/conference.rb", "spec/fsr/app/fifo.rb", "spec/fsr/app/fs_break.rb", "spec/fsr/app/fs_sleep.rb", "spec/fsr/app/hangup.rb", "spec/fsr/app/limit.rb", "spec/fsr/app/log.rb", "spec/fsr/app/play_and_get_digits.rb", "spec/fsr/app/playback.rb", "spec/fsr/app/set.rb", "spec/fsr/app/transfer.rb", "spec/fsr/cmd.rb", "spec/fsr/cmd/calls.rb", "spec/fsr/cmd/originate.rb", "spec/fsr/cmd/sofia.rb", "spec/fsr/cmd/sofia/profile.rb", "spec/fsr/listener.rb", "spec/fsr/listener/inbound.rb", "spec/fsr/listener/outbound.rb", "spec/fsr/loading.rb"]
+  s.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/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/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/rcov.rake", "tasks/release.rake", "tasks/reversion.rake", "tasks/setup.rake", "tasks/spec.rake", "tasks/yard.rake", "spec/helper.rb", "spec/fsr/app.rb", "spec/fsr/app/answer.rb", "spec/fsr/app/bridge.rb", "spec/fsr/app/conference.rb", "spec/fsr/app/fifo.rb", "spec/fsr/app/fs_break.rb", "spec/fsr/app/fs_sleep.rb", "spec/fsr/app/hangup.rb", "spec/fsr/app/limit.rb", "spec/fsr/app/log.rb", "spec/fsr/app/play_and_get_digits.rb", "spec/fsr/app/playback.rb", "spec/fsr/app/set.rb", "spec/fsr/app/transfer.rb", "spec/fsr/cmd.rb", "spec/fsr/cmd/calls.rb", "spec/fsr/cmd/originate.rb", "spec/fsr/cmd/sofia.rb", "spec/fsr/cmd/sofia/profile.rb", "spec/fsr/listener.rb", "spec/fsr/listener/header_and_content_response.rb", "spec/fsr/listener/inbound.rb", "spec/fsr/listener/outbound.rb", "spec/fsr/loading.rb"]
   s.homepage = %q{http://code.rubyists.com/projects/fs}
   s.post_install_message = %q{=========================================================
 FreeSWITCHeR
@@ -50,8 +173,12 @@ new calls/sessions will invoke the "session_initiated" callback method.
       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}"
-            hangup #Hangup the call
+          FSR::Log.info "***Success, grabbed #{read_var.strip} from #{exten}"
+          # Tell the caller what they entered
+          speak("Got the DTMF of: #{read_var}") do 
+            #Hangup the call
+            hangup 
+          end
         end
       end
 
@@ -133,13 +260,13 @@ Home page at http://code.rubyists.com/projects/fs
 }
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{freeswitcher}
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.3}
   s.summary = %q{A library for interacting with the "FreeSWITCH":http://freeswitch.org telephony platform}
-  s.test_files = ["spec/fsr/app.rb", "spec/fsr/app/answer.rb", "spec/fsr/app/bridge.rb", "spec/fsr/app/conference.rb", "spec/fsr/app/fifo.rb", "spec/fsr/app/fs_break.rb", "spec/fsr/app/fs_sleep.rb", "spec/fsr/app/hangup.rb", "spec/fsr/app/limit.rb", "spec/fsr/app/log.rb", "spec/fsr/app/play_and_get_digits.rb", "spec/fsr/app/playback.rb", "spec/fsr/app/set.rb", "spec/fsr/app/transfer.rb", "spec/fsr/cmd.rb", "spec/fsr/cmd/calls.rb", "spec/fsr/cmd/originate.rb", "spec/fsr/cmd/sofia.rb", "spec/fsr/cmd/sofia/profile.rb", "spec/fsr/listener.rb", "spec/fsr/listener/inbound.rb", "spec/fsr/listener/outbound.rb", "spec/fsr/loading.rb"]
+  s.test_files = ["spec/fsr/app.rb", "spec/fsr/app/answer.rb", "spec/fsr/app/bridge.rb", "spec/fsr/app/conference.rb", "spec/fsr/app/fifo.rb", "spec/fsr/app/fs_break.rb", "spec/fsr/app/fs_sleep.rb", "spec/fsr/app/hangup.rb", "spec/fsr/app/limit.rb", "spec/fsr/app/log.rb", "spec/fsr/app/play_and_get_digits.rb", "spec/fsr/app/playback.rb", "spec/fsr/app/set.rb", "spec/fsr/app/transfer.rb", "spec/fsr/cmd.rb", "spec/fsr/cmd/calls.rb", "spec/fsr/cmd/originate.rb", "spec/fsr/cmd/sofia.rb", "spec/fsr/cmd/sofia/profile.rb", "spec/fsr/listener.rb", "spec/fsr/listener/header_and_content_response.rb", "spec/fsr/listener/inbound.rb", "spec/fsr/listener/outbound.rb", "spec/fsr/loading.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<eventmachine>, [">= 0"])

data/lib/fsr.rb

@@ -1,4 +1,3 @@
-require 'logger'
 require 'socket'
 require 'pathname'
 require 'pp'
@@ -15,14 +14,19 @@ module FSR
   DEFAULT_CALLER_ID_NUMBER = '8675309'
   DEFAULT_CALLER_ID_NAME   = "FSR"
 
-  # Usage:
-  #
-  #   Log.info('foo')
-  #   Log.debug('bar')
-  #   Log.warn('foobar')
-  #   Log.error('barfoo')
-  Log = Logger.new($stdout)
-  Log.level = Logger::INFO
+  #  attempt to require log4r.  
+  #  if log4r is not available, load logger from stdlib
+  begin
+    require 'log4r'
+    Log = Log4r::Logger.new('FSR')
+    Log.outputters = Log4r::Outputter.stdout
+    Log.level = Log4r::INFO
+  rescue LoadError
+    $stderr.puts "No log4r found, falling back to standard ruby library Logger"
+    require 'logger'
+    Log = Logger.new(STDOUT)
+    Log.level = Logger::INFO
+  end
 
   ROOT = Pathname(__FILE__).dirname.expand_path.freeze
   $LOAD_PATH.unshift(FSR::ROOT)

data/lib/fsr/cmd.rb

@@ -62,7 +62,7 @@ module FSR
     # Load all of the commands we find in Cmd::LOAD_PATH
     def self.load_all(force_reload = false)
       LOAD_PATH.each do |load_path|
-        Dir[load_path.join("*.rb")].each { |command_file| load_command(command_file, force_reload) }
+        Dir[load_path.join("*.rb").to_s].each { |command_file| load_command(command_file, force_reload) }
       end
       list
     end

data/lib/fsr/listener.rb

@@ -7,4 +7,7 @@ module FSR
 
   end
 end
+class String
+  alias :each :each_line
+end
 FSL = FSR::Listener

data/lib/fsr/listener/outbound.rb

@@ -58,6 +58,12 @@ module FSR
         self.respond_to?(:send_data) ? send_data(message) : message
       end
 
+      # API
+      def api(command, &block)
+        send_data("api #{command}\r\n\r\n")
+        @queue.unshift block if block_given?
+      end
+
       # Update_session
 
       def update_session(&block)
@@ -104,8 +110,12 @@ module FSR
           FSR::Log.info("@uuid_var is set => #{session_header_and_content.inspect} : #{content}")
           r, @uuid_var = session_header_and_content.content.strip, nil
           @queue.pop.call(r) if @queue.size > 0
-        elsif session_header_and_content.content[:event_name] # If content includes an event_name, it must be a response from an api command
-          check_for_updated_session(session_header_and_content, hash_content, hash_header)
+        elsif @api_request and session_header_and_content.headers[:content_type] == "api/response"
+          @queue.pop.call if @queue.size > 0
+        elsif session_header_and_content.content.class == Hash
+          if session_header_and_content.content[:event_name] # If content includes an event_name, it must be a response from an api command
+            check_for_updated_session(session_header_and_content, hash_content, hash_header)
+          end
         else
           update_state_machine(session_header_and_content)
         end

data/lib/fsr/version.rb

@@ -1,3 +1,3 @@
 module FSR
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/spec/fsr/listener/header_and_content_response.rb

@@ -0,0 +1,48 @@
+require 'spec/helper'
+require 'fsr/listener/header_and_content_response'
+
+describe FSL::HeaderAndContentResponse do
+  HCR = FSL::HeaderAndContentResponse
+
+  it "is initializable with 2 hash arguments" 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
+  end
+=begin manveru's future specs
+
+  it "can be created with headers" do
+    hcr = HCR.new(:headers => {:a => 'b', :c => 'd'})
+    hcr.headers.should == {:a => 'b', :c => 'd'}
+  end
+
+  it 'strips whitespace around header values' do
+    hcr = HCR.new(:headers => {:a => ' b', :c => "d\t\n"})
+    hcr.headers.should == {:a => 'b', :c => 'd'}
+  end
+
+  it "returns an empty string if there's no event-name" do
+    hcr = HCR.from_raw([""], [""])
+    hcr.class.should == HCR
+    hcr.event_name.should == ''
+  end
+
+  it "returns the event-name if there is one" do
+    hcr = HCR.from_raw([""], ["event-name: foo"])
+    hcr.event_name.should == 'foo'
+    hcr.class.should == HCR::ParsedContent
+  end
+
+  it "can check for an event name in content" do
+    hcr = HCR.new(:content => {:event_name => ' YAY', :stuff => "d"})
+    hcr.class.should == HCR
+
+    hcr.has_event_name?('YAY').should.not == nil
+    hcr.content[:event_name] = 'NOES'
+    hcr.has_event_name?('YAY').should == false
+  end
+
+=end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: freeswitcher
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - Jayson Vaughn
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-18 00:00:00 -05:00
+date: 2009-06-03 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,90 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-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.  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.strip} from #{exten}\" hangup #Hangup the call 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) {|event| 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) {|event| 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(event) pp event.headers pp event.content[:event_name] end  end  FSR.start_ies!(IesDemo, :host => \"localhost\", :port => 8021)   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/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/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/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/rcov.rake
-- tasks/release.rake
-- tasks/reversion.rake
-- tasks/setup.rake
-- tasks/spec.rake
-- tasks/yard.rake
-- spec/helper.rb
-has_rdoc: false
-homepage: http://code.rubyists.com/projects/fs
-post_install_message: |
+description: &id001 |
   =========================================================
   FreeSWITCHeR
   Copyright (c) 2009 The Rubyists (Jayson Vaughn, Tj Vanderpoel, Michael Fellinger, Kevin Berry) 
@@ -148,8 +65,12 @@ post_install_message: |
         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}"
-              hangup #Hangup the call
+            FSR::Log.info "***Success, grabbed #{read_var.strip} from #{exten}"
+            # Tell the caller what they entered
+            speak("Got the DTMF of: #{read_var}") do 
+              #Hangup the call
+              hangup 
+            end
           end
         end
   
@@ -229,6 +150,91 @@ post_install_message: |
   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/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/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/rcov.rake
+- tasks/release.rake
+- tasks/reversion.rake
+- tasks/setup.rake
+- tasks/spec.rake
+- tasks/yard.rake
+- spec/helper.rb
+has_rdoc: true
+homepage: http://code.rubyists.com/projects/fs
+licenses: []
+
+post_install_message: *id001
 rdoc_options: []
 
 require_paths: 
@@ -248,9 +254,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: freeswitcher
-rubygems_version: 1.3.1
+rubygems_version: 1.3.3
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A library for interacting with the "FreeSWITCH":http://freeswitch.org telephony platform
 test_files: 
 - spec/fsr/app.rb
@@ -273,6 +279,7 @@ test_files:
 - spec/fsr/cmd/sofia.rb
 - spec/fsr/cmd/sofia/profile.rb
 - spec/fsr/listener.rb
+- spec/fsr/listener/header_and_content_response.rb
 - spec/fsr/listener/inbound.rb
 - spec/fsr/listener/outbound.rb
 - spec/fsr/loading.rb