freeswitcher 0.1.4 → 0.3.0

data/AUTHORS

@@ -1,10 +1,11 @@
 Following persons have contributed to freeswitcher.
 (Sorted by number of submitted patches, then alphabetically)
 
-   103 TJ Vanderpoel <bougy.man@gmail.com>
-    64 Jayson Vaughn <vaughn.jayson@gmail.com>
+   117 TJ Vanderpoel <bougy.man@gmail.com>
+    64 Jayson Vaughn <jayson@onedrop.home>
     28 Michael Fellinger <m.fellinger@gmail.com>
-     7 Jayson Vaughn <jayson@onedrop.(none)>
+    11 Jayson Vaughn <jayson@onedrop.(none)>
+     9 Jayson Vaughn <jayson@onedrop.nationwide-recovery.com>
      6 Mikael Bjerkeland <mikael@consoll.no>
      4 foo <jvaughn@hellspass.nationwide-recovery.com>
      4 Jayson Vaughn <vaughn.jayson@gmail.com>

data/CHANGELOG

@@ -1,3 +1,126 @@
+[fbaf84c | Mon May 18 23:24:58 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * Version 0.3.0
+
+[bf6befa | Mon May 18 23:22:36 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * functionality for receiving variables passed to a block complete.  README updated.  Convert Rakefile file options to Pathname
+
+[7b0bf11 | Mon May 18 20:31:48 UTC 2009] Jayson Vaughn <jayson@onedrop.nationwide-recovery.com>
+
+  * Added yardoc comments
+
+[7b7efa7 | Mon May 18 20:10:30 UTC 2009] Jayson Vaughn <jayson@onedrop.nationwide-recovery.com>
+
+  * Removed FSR::Log.info debugging line from uuid_getvar and setvar
+
+[fda2ff4 | Mon May 18 19:55:19 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * Added FSR::App::UuidGetVar and UuidSetVar
+
+[39338cd | Mon May 18 18:55:17 UTC 2009] Jayson Vaughn <jayson@onedrop.nationwide-recovery.com>
+
+  * Corrected typo s/header_and_content/header_and_content_hash
+
+[cb4d1cc | Mon May 18 18:54:08 UTC 2009] Jayson Vaughn <jayson@onedrop.nationwide-recovery.com>
+
+  * And also it seems I need to include a parameter for hash_header in
+
+[a818d62 | Mon May 18 18:51:25 UTC 2009] Jayson Vaughn <jayson@onedrop.nationwide-recovery.com>
+
+  * Need to add a second paremeter to check_for_updated_session that
+
+
+
+[6302892 | Mon May 18 18:49:17 UTC 2009] Jayson Vaughn <jayson@onedrop.nationwide-recovery.com>
+
+  * Changed session_header_and_content to header_and_content_hash
+
+[5b8d9a4 | Mon May 18 18:47:57 UTC 2009] Jayson Vaughn <jayson@onedrop.nationwide-recovery.com>
+
+  * Corrected some typos in previous refactor of Outbound#receive_reply
+
+[12a13eb | Mon May 18 18:41:40 UTC 2009] Jayson Vaughn <jayson@onedrop.nationwide-recovery.com>
+
+  * Refactored Outbound#receive_request to decouple it a tad.  Still could
+
+
+
+[6a95fa1 | Mon May 18 18:16:43 UTC 2009] Jayson Vaughn <jayson@onedrop.nationwide-recovery.com>
+
+  * Refactored FSR::App::PlayAndGetDigits to now yeild the read_var in a
+
+
+
+[5093e71 | Mon May 18 15:08:39 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * Read will now yield the read variable in a block
+
+    Updated README
+
+[e71a1a5 | Mon May 18 01:55:43 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * reverted design error, putting SENDMSG_METHOD into Read attaching to Outbound, not App
+
+[273bdaf | Mon May 18 01:34:02 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * removed &block from read method definition after failing spec
+
+[ad1bbd1 | Mon May 18 00:37:44 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * left out another to_sym
+
+[19f8581 | Mon May 18 00:32:23 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * left out a to_sym
+
+[f445058 | Mon May 18 00:31:43 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * typos galore, fixed wrong constant name in Read.  created the queue_pop method to handle popping procs, adding the session.headers[@read_var] if it exist to the proc called
+
+[93ecad2 | Mon May 18 00:19:16 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * TEST push to test changes, read/outbound test needed
+
+[30a39ad | Sat May 16 20:41:41 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * Added specs for originate, defaults to Cmd
+
+     * Added specs for failing cases of Cmd::Originate
+     * Move DEFAULT_OPTIONS to FSR::Cmd::Command so commands inherit this
+     * Move default_options method to FSR::Cmd::Command as well.
+     * Used default_options block in Originate for options population
+
+[865d177 | Sat May 16 17:56:45 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * filling out originate specs, testing options and argument types
+
+[19b81ff | Wed May 13 16:03:35 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * refactored to a new default_options
+
+[081112a | Wed May 13 15:32:20 UTC 2009] TJ Vanderpoel <bougy.man@gmail.com>
+
+  * changed handling of :ignore_early_media in target_options of originate to behave properly.  Added argument checks for some originate arguments
+
+[55ec1c5 | Mon May 11 17:14:34 UTC 2009] Jayson Vaughn <jayson@onedrop.(none)>
+
+  * New specs now pass
+
+[ab262c9 | Mon May 11 17:13:48 UTC 2009] Jayson Vaughn <jayson@onedrop.(none)>
+
+  * Added specs for FSR::App::Answer, FSBreak, and FSSleep
+
+[1faf55f | Mon May 11 16:44:51 UTC 2009] Jayson Vaughn <jayson@onedrop.(none)>
+
+  * Updated gemspec for 0.1.4
+
+[011a3e6 | Mon May 11 16:43:14 UTC 2009] Jayson Vaughn <jayson@onedrop.(none)>
+
+  * Sync changes with Master
+
+
+
 [f036509 | Mon May 11 16:36:04 UTC 2009] Jayson Vaughn <jayson@onedrop.(none)>
 
   * Version 0.1.4

data/MANIFEST

@@ -6,14 +6,6 @@ MANIFEST
 NEWS
 README
 Rakefile
-examples/bin/cmd_demo.rb
-examples/bin/dtmf_test.rb
-examples/bin/ies_demo.rb
-examples/bin/ies_demo_with_hook.rb
-examples/bin/oes_demo.rb
-examples/dtmf_test.rb
-examples/ies_demo.rb
-examples/ies_demo_with_hook.rb
 examples/inbound_event_socket.rb
 examples/inbound_socket_events.rb
 examples/outbound_event_socket.rb
@@ -61,7 +53,6 @@ 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/listener/outbound.rb.orig
 lib/fsr/model/call.rb
 lib/fsr/version.rb
 tasks/authors.rake
@@ -80,9 +71,12 @@ 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

data/README

@@ -10,8 +10,8 @@ A ruby library for interacting with the "FreeSWITCH" (http://www.freeswitch.org)
 
 REQUIREMENTS
 ------------
-- ruby (>= 1.8)
-- eventmachine (If you wish to use Outbound and Inbound listener)
+* ruby (>= 1.8)
+* eventmachine (If you wish to use Outbound and Inbound listener)
 
 USAGE
 -----
@@ -22,97 +22,94 @@ 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.
  
-  * NOTE:  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"
-
-    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
-            FSR::Log.info "*** Updating session for #{exten}"
-            update_session do
-              FSR::Log.info "***Success, grabbed #{@session.headers[:variable_input].strip} from #{exten}"
-              hangup #Hangup the call
-            end
-          end
-        end
+<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
 
-    FSR.start_oes! OutboundDemo, :port => 8084, :host => "127.0.0.1"
+  end
 
+  FSR.start_oes! OutboundDemo, :port => 8084, :host => "127.0.0.1"
 
 An Inbound Event Socket Listener example using FreeSWITCHeR's hook system:
 --------------------------------------------------------------------------
 
-    require 'pp'
-    require 'fsr'
-    require "fsr/listener/inbound"
+  #!/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 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
+  # 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) }
+  # 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)
+  # 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:
 ---------------------------------------------------------------------------------------------
 
-    require 'pp'
-    require 'fsr'
-    require "fsr/listener/inbound"
-
+  #!/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
+  class IesDemo < FSR::Listener::Inbound
 
+    def on_event(event)
+      pp event.headers
+      pp event.content[:event_name]
     end
 
-    FSR.start_ies!(IesDemo, :host => "localhost", :port => 8021)
+  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):001:0> require 'fsr'
+  => true
 
-    irb(main):002:0> FSR.load_all_commands
-    => [:sofia, :originate]
+  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):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"}
+  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"}
 
 
 

data/Rakefile

@@ -3,13 +3,13 @@ require "rubygems"
 require "lib/fsr"
 require "pathname"
 
-PROJECT_COPYRIGHT = File.read(Pathname.new(__FILE__).dirname.join("License.txt"))
-PROJECT_README = Pathname.new(__FILE__).dirname.join("README").expand_path.to_s
+PROJECT_COPYRIGHT = Pathname(__FILE__).dirname.join("License.txt").read
+PROJECT_README = Pathname(__FILE__).dirname.join("README").expand_path.to_s
 PROJECT_FILES  = %x{git ls-files}.split
 RELEASE_FILES  = PROJECT_FILES.reject { |f| f.match(/^(?:contrib)(?:\/|$)/) }
 GEM_FILES      = RELEASE_FILES.reject { |f| f.match(/^(?:spec)(?:\/|$)/) }
 PROJECT_SPECS  = (RELEASE_FILES - GEM_FILES).reject { |d| d.match(/(?:helper.rb)$/) }
-GEM_FILES << "spec/helper.rb" if Pathname.new("spec/helper.rb").file?
+GEM_FILES << "spec/helper.rb" if Pathname("spec/helper.rb").file?
 
 
 GEMSPEC = Gem::Specification.new do |spec|
@@ -25,7 +25,7 @@ GEMSPEC = Gem::Specification.new do |spec|
   spec.test_files = PROJECT_SPECS
   spec.require_path = "lib"
 
-  description = File.read(PROJECT_README)
+  description = Pathname(PROJECT_README).read
   spec.description = description
   spec.rubyforge_project = "freeswitcher"
   spec.post_install_message = description

data/examples/outbound_event_socket.rb

@@ -12,12 +12,9 @@ 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
-        FSR::Log.info "*** Updating session for #{exten}"
-        update_session do
-          FSR::Log.info "***Success, grabbed #{@session.headers[:variable_input].strip} 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
 

data/freeswitcher.gemspec

@@ -2,14 +2,14 @@
 
 Gem::Specification.new do |s|
   s.name = %q{freeswitcher}
-  s.version = "0.1.4"
+  s.version = "0.3.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-11}
-  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.  * NOTE:  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"  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 FSR::Log.info "*** Updating session for #{exten}" update_session do FSR::Log.info "***Success, grabbed #{@session.headers[:variable_input].strip} from #{exten}" hangup #Hangup the call 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: --------------------------------------------------------------------------  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: ---------------------------------------------------------------------------------------------  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-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.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/listener/outbound.rb.orig", "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/bridge.rb", "spec/fsr/app/conference.rb", "spec/fsr/app/fifo.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/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
@@ -23,8 +23,8 @@ A ruby library for interacting with the "FreeSWITCH" (http://www.freeswitch.org)
 
 REQUIREMENTS
 ------------
-- ruby (>= 1.8)
-- eventmachine (If you wish to use Outbound and Inbound listener)
+* ruby (>= 1.8)
+* eventmachine (If you wish to use Outbound and Inbound listener)
 
 USAGE
 -----
@@ -35,97 +35,94 @@ 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.
  
-  * NOTE:  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"
-
-    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
-            FSR::Log.info "*** Updating session for #{exten}"
-            update_session do
-              FSR::Log.info "***Success, grabbed #{@session.headers[:variable_input].strip} from #{exten}"
-              hangup #Hangup the call
-            end
-          end
-        end
+<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
 
-    FSR.start_oes! OutboundDemo, :port => 8084, :host => "127.0.0.1"
+  end
 
+  FSR.start_oes! OutboundDemo, :port => 8084, :host => "127.0.0.1"
 
 An Inbound Event Socket Listener example using FreeSWITCHeR's hook system:
 --------------------------------------------------------------------------
 
-    require 'pp'
-    require 'fsr'
-    require "fsr/listener/inbound"
+  #!/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 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
+  # 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) }
+  # 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)
+  # 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:
 ---------------------------------------------------------------------------------------------
 
-    require 'pp'
-    require 'fsr'
-    require "fsr/listener/inbound"
-
+  #!/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
+  class IesDemo < FSR::Listener::Inbound
 
+    def on_event(event)
+      pp event.headers
+      pp event.content[:event_name]
     end
 
-    FSR.start_ies!(IesDemo, :host => "localhost", :port => 8021)
+  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):001:0> require 'fsr'
+  => true
 
-    irb(main):002:0> FSR.load_all_commands
-    => [:sofia, :originate]
+  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):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"}
+  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"}
 
 
 
@@ -138,7 +135,7 @@ Home page at http://code.rubyists.com/projects/fs
   s.rubyforge_project = %q{freeswitcher}
   s.rubygems_version = %q{1.3.1}
   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/bridge.rb", "spec/fsr/app/conference.rb", "spec/fsr/app/fifo.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/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