freeswitcher 0.1.3 → 0.1.4

data/tasks/gem.rake

@@ -0,0 +1,23 @@
+require 'rake/gempackagetask'
+
+desc "make a gemspec"
+task :gemspec => [:manifest, :changelog, :authors] do
+  gemspec_file = "#{GEMSPEC.name}.gemspec"
+  File.open(gemspec_file, 'w+'){|gs| gs.puts(GEMSPEC.to_ruby) }
+end
+
+desc "package and install from gemspec"
+task :install => [:gemspec] do
+  sh "gem build #{GEMSPEC.name}.gemspec"
+  sh "gem install #{GEMSPEC.name}-#{GEMSPEC.version}.gem"
+end
+
+desc "uninstall the gem"
+task :uninstall => [:clean] do
+  sh %{gem uninstall -x #{GEMSPEC.name}}
+end
+
+Rake::GemPackageTask.new(GEMSPEC) do |p|
+  p.need_tar = true
+  p.need_zip = true
+end

data/tasks/gem_installer.rake

@@ -0,0 +1,76 @@
+task :gem_installer do
+  class GemInstaller
+    def initialize(options = {}, &block)
+      @gems = []
+      @options = options
+
+      run(&block)
+    end
+
+    def run(&block)
+      instance_eval(&block) if block_given?
+    end
+
+    def gem(name, version = nil, options = {})
+      if version.respond_to?(:merge!)
+        options = version
+      else
+        options[:version] = version
+      end
+
+      @gems << [name, options]
+    end
+
+    def setup_gemspec(gemspec)
+      gemspec.dependencies.each do |dependency|
+        dependency.version_requirements.as_list.each do |version|
+          gem(dependency.name, version)
+        end
+      end
+
+      setup
+    end
+
+    def setup
+      require 'rubygems'
+      require 'rubygems/dependency_installer'
+
+      @gems.each do |name, options|
+        setup_gem(name, options)
+      end
+    end
+
+    def setup_gem(name, options, try_install = true)
+      print "activating #{name} ... "
+      Gem.activate(name, *[options[:version]].compact)
+      require(options[:lib] || name)
+      puts "success."
+    rescue LoadError => error
+      puts error
+      install_gem(name, options) if try_install
+      setup_gem(name, options, try_install = false)
+    end
+
+    def install_gem(name, options)
+      installer = Gem::DependencyInstaller.new(options)
+
+      temp_argv(options[:extconf]) do
+        print "Installing #{name} ... "
+        installer.install(name, options[:version])
+        puts "done."
+      end
+    end
+
+    def temp_argv(extconf)
+      if extconf ||= @options[:extconf]
+        old_argv = ARGV.clone
+        ARGV.replace(extconf.split(' '))
+      end
+
+      yield
+
+    ensure
+      ARGV.replace(old_argv) if extconf
+    end
+  end
+end

data/tasks/install_dependencies.rake

@@ -0,0 +1,6 @@
+desc 'install dependencies'
+task :install_dependencies => [:gem_installer] do
+  GemInstaller.new do
+    # setup_gemspec(GEMSPEC)
+  end
+end

data/tasks/manifest.rake

@@ -0,0 +1,4 @@
+desc 'update manifest'
+task :manifest do
+  File.open('MANIFEST', 'w+'){|io| io.puts(*GEMSPEC.files) }
+end

data/tasks/rcov.rake

@@ -0,0 +1,23 @@
+desc 'code coverage'
+task :rcov => :clean do
+  specs = PROJECT_SPECS
+
+  ignore = %w[ gem rack bacon ]
+
+  if RUBY_VERSION >= '1.8.7'
+    ignore << 'begin_with' << 'end_with'
+  end
+  if RUBY_VERSION < '1.9'
+    ignore << 'fiber'
+  end
+
+  ignored = ignore.join(',')
+
+  cmd = "rcov --aggregate coverage.data --sort coverage -t --%s -x '#{ignored}' %s"
+
+  while spec = specs.shift
+    puts '', "Gather coverage for #{spec} ..."
+    html = specs.empty? ? 'html' : 'no-html'
+    sh(cmd % [html, spec])
+  end
+end

data/tasks/release.rake

@@ -0,0 +1,52 @@
+namespace :release do
+  task :all => [:release_github, :release_rubyforge]
+
+  desc 'Display instructions to release on github'
+  task :github => [:reversion, :gemspec] do
+    name, version = GEMSPEC.name, GEMSPEC.version
+
+    puts <<INSTRUCTIONS
+First add the relevant files:
+
+git add AUTHORS MANIFEST CHANGELOG #{name}.gemspec lib/#{name}/version.rb
+
+Then commit them, tag the commit, and push:
+
+git commit -m 'Version #{version}'
+git tag -a -m '#{version}' '#{version}'
+git push
+
+INSTRUCTIONS
+
+  end
+
+  # TODO: Not tested
+  desc 'Display instructions to release on rubyforge'
+  task :rubyforge => [:reversion, :gemspec, :package] do
+    name, version = GEMSPEC.name, GEMSPEC.version
+
+    puts <<INSTRUCTIONS
+To publish to rubyforge do following:
+
+rubyforge login
+rubyforge add_release #{name} #{name} '#{version}' pkg/#{name}-#{version}.gem
+
+After you have done these steps, see:
+
+rake release:rubyforge_archives
+
+INSTRUCTIONS
+  end
+
+  desc 'Display instructions to add archives after release:rubyforge'
+  task :rubyforge_archives do
+    name, version = GEMSPEC.name, GEMSPEC.version
+    puts "Adding archives for distro packagers is:", ""
+
+    Dir["pkg/#{name}-#{version}.{tgz,zip}"].each do |file|
+      puts "rubyforge add_file #{name} #{name} '#{version}' '#{file}'"
+    end
+
+    puts
+  end
+end

data/tasks/reversion.rake

@@ -0,0 +1,8 @@
+desc "update version.rb"
+task :reversion do
+  File.open("lib/fsr/version.rb", 'w+') do |file|
+    file.puts("module FSR")
+    file.puts('  VERSION = %p' % GEMSPEC.version.to_s)
+    file.puts('end')
+  end
+end

data/tasks/setup.rake

@@ -0,0 +1,16 @@
+desc 'install all possible dependencies'
+task :setup => :gem_installer do
+  GemInstaller.new do
+    # core
+    gem 'eventmachine'
+
+    # spec
+    gem 'bacon'
+    gem 'rcov'
+    
+    # doc
+    gem 'yard'
+
+    setup
+  end
+end

data/tasks/spec.rake

@@ -1,59 +0,0 @@
-#          Copyright (c) 2009 Michael Fellinger m.fellinger@gmail.com
-# All files in this distribution are subject to the terms of the Ruby license.
-
-require 'rake'
-
-desc 'Run all specs'
-task :spec => :setup do
-  require 'open3'
-
-  specs = Dir['spec/fsr/**/*.rb']
-  # specs.delete_if{|f| f =~ /cache\/common\.rb/ }
-
-  some_failed = false
-  total = specs.size
-  len = specs.sort.last.size
-  left_format = "%4d/%d: %-#{len + 12}s"
-  red, green = "\e[31m%s\e[0m", "\e[32m%s\e[0m"
-  matcher = /(\d+) specifications \((\d+) requirements\), (\d+) failures, (\d+) errors/
-  tt = ta = tf = te = 0
-
-  specs.each_with_index do |spec, idx|
-    print(left_format % [idx + 1, total, spec])
-    unless RUBY_PLATFORM.include?("mswin32")
-      Open3.popen3("#{RUBY} -rubygems #{spec}") do |sin, sout, serr|
-        out = sout.read
-        err = serr.read
-
-        all = out.match(matcher).captures.map{|c| c.to_i }
-        tests, assertions, failures, errors = all
-        tt += tests; ta += assertions; tf += failures; te += errors
-  
-        if tests == 0 || failures + errors > 0
-          some_failed = true
-          puts((red % "%5d tests, %d assertions, %d failures, %d errors") % all)
-          puts "", out, err, ""
-        else
-          puts((green % "%5d passed") % tests)
-        end
-      end 
-    else
-      out = %x{#{RUBY} -rubygems #{spec}}
-      error = ""
-      all = out.match(matcher).captures.map{|c| c.to_i }
-      tests, assertions, failures, errors = all
-      tt += tests; ta += assertions; tf += failures; te += errors
-  
-      if tests == 0 || failures + errors > 0
-        some_failed = true
-        puts((red % "%5d tests, %d assertions, %d failures, %d errors") % all)
-        puts "", out, err, ""
-      else
-        puts((green % "%5d passed") % tests)
-      end
-    end
-  end
-
-  puts "#{tt} specifications, (#{ta} requirements), #{tf} failures, #{te} errors"
-  exit 1 if some_failed
-end

data/tasks/yard.rake

@@ -0,0 +1,4 @@
+desc 'Generate YARD documentation'
+task :yard => :clean do
+  sh("yardoc -o ydoc --protected -r #{PROJECT_README}")
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: freeswitcher
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Jayson Vaughn
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-04 00:00:00 -05:00
+date: 2009-05-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,7 +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 ----- *** STILL UNDER HEAVY DEVELOPMENT ***  A ruby library for interacting with the \"FreeSWITCH\" (http://www.freeswitch.org) opensource telephony platform  *** STILL UNDER HEAVY DEVELOPMENT ***  Requirements ------------ - ruby (>= 1.8) - eventmachine (If you wish to use Outbound and Inbound listener)  Usage -----  Example of originating a new call in 'irb' using FSR::CommandSocket#originate:  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\"}   Example of creating an Outbound Eventsocket listener:  #!/usr/bin/env ruby  require 'fsr' require \"fsr/listener/outbound\"  class OesDemo < FSR::Listener::Outbound  def session_initiated number = @session.headers[:caller_caller_id_number] # Grab the inbound caller id FSR::Log.info \"*** Answering incoming call from #{number}\" answer # Answer the call set(\"hangup_after_bridge\", \"true\")# Set a variable speak 'Hello, This is your phone switch.  Have a great day' # use mod_flite to speak hangup # Hangup the call end  end  FSR.start_oes!(OesDemo, :port => 1888, :host => \"localhost\")    Example of creating an Outbound Eventsocket listener that can read DTMF input and keep state:  #!/usr/bin/env ruby  require 'fsr' require 'fsr/listener/outbound'  FSR.load_all_applications FSR.load_all_commands  class DtmfDemo < FSR::Listener::Outbound  def session_initiated exten = @session.headers[:caller_caller_id_number] FSR::Log.info \"*** Answering incoming call from #{exten}\" answer # Answer the call end  def receive_reply(reply) exten = @session.headers[:caller_caller_id_number] case @step when 1 FSR::Log.info \"*** Reading dtmf for #{exten}\" read \"/home/freeswitch/freeswitch/sounds/music/8000/sweet.wav\",4,10,\"test\",15000 # read test when 2 FSR::Log.info \"*** updating session for #{exten}\" update_session when 3 FSR::Log.info \"** Success, grabbed #{@session.headers[:variable_test].strip} from #{exten}\" FSR::Log.info \"*** Hanging up call\" hangup # Hangup the call end end  end  FSR.start_oes! DtmfDemo, :port => 8084, :host => \"127.0.0.1\"    Example of creating an Inbound Eventsocket listener:  #!/usr/bin/env ruby  require 'fsr' require 'fsr/listener/inbound' require 'pp'  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)    Support ------- Home page at http://code.rubyists.com/projects/fs #rubyists on FreeNode"
+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.  * 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"
 email: FreeSWITCHeR@rubyists.com
 executables: []
 
@@ -34,19 +34,20 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
+- AUTHORS
+- CHANGELOG
 - License.txt
+- MANIFEST
 - NEWS
 - README
 - Rakefile
-- examples
-- examples/dtmf_test.rb
-- examples/ies_demo.rb
-- examples/ies_demo_with_hook.rb
-- examples/oes_demo.rb
-- examples/play_and_get_test.rb
-- lib
-- lib/fsr
-- lib/fsr/app
+- 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
@@ -65,45 +66,67 @@ files:
 - lib/fsr/app/uuid_dump.rb
 - lib/fsr/app/uuid_getvar.rb
 - lib/fsr/app/uuid_setvar.rb
-- lib/fsr/app.rb
-- lib/fsr/cmd
+- lib/fsr/cmd.rb
 - lib/fsr/cmd/calls.rb
 - lib/fsr/cmd/fsctl.rb
 - lib/fsr/cmd/originate.rb
-- lib/fsr/cmd/sofia
+- lib/fsr/cmd/sofia.rb
 - lib/fsr/cmd/sofia/profile.rb
 - lib/fsr/cmd/sofia/status.rb
-- lib/fsr/cmd/sofia.rb
 - lib/fsr/cmd/sofia_contact.rb
 - lib/fsr/cmd/status.rb
-- lib/fsr/cmd.rb
 - lib/fsr/command_socket.rb
-- lib/fsr/database
+- 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/database.rb
 - lib/fsr/event_socket.rb
 - lib/fsr/fake_socket.rb
-- lib/fsr/listener
+- lib/fsr/listener.rb
 - lib/fsr/listener/header_and_content_response.rb
-- lib/fsr/listener/inbound
-- lib/fsr/listener/inbound/event.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/listener.rb
-- lib/fsr/model
 - lib/fsr/model/call.rb
-- lib/fsr.rb
-- tasks
-- tasks/package.rake
-- tasks/ride.rake
-- tasks/rspec.rake
+- 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
-- tmp
+- 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
 has_rdoc: false
 homepage: http://code.rubyists.com/projects/fs
 post_install_message: |
@@ -113,108 +136,88 @@ post_install_message: |
   Distributed under the terms of the MIT License.
   ==========================================================
   
-  About
+  ABOUT
   -----
-  *** STILL UNDER HEAVY DEVELOPMENT ***
-  
   A ruby library for interacting with the "FreeSWITCH" (http://www.freeswitch.org) opensource telephony platform
   
-  *** STILL UNDER HEAVY DEVELOPMENT ***
-  
-  Requirements
+  REQUIREMENTS
   ------------
   - ruby (>= 1.8)
   - eventmachine (If you wish to use Outbound and Inbound listener)
   
-  Usage
+  USAGE
   -----
   
-  Example of originating a new call in 'irb' using FSR::CommandSocket#originate:
-  
-    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">
+  An Outbound Event Listener Example that reads and returns DTMF input:
+  --------------------------------------------------------------------
   
-    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"}
-  
-  
-  Example of creating an Outbound Eventsocket listener:
-  
-      #!/usr/bin/env ruby
+  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"
+      require 'fsr/listener/outbound'
   
-      class OesDemo < FSR::Listener::Outbound
+      class OutboundDemo < FSR::Listener::Outbound
   
         def session_initiated
-          number = @session.headers[:caller_caller_id_number] # Grab the inbound caller id
-          FSR::Log.info "*** Answering incoming call from #{number}"
-          answer # Answer the call
-          set("hangup_after_bridge", "true")# Set a variable
-          speak 'Hello, This is your phone switch.  Have a great day' # use mod_flite to speak
-          hangup # Hangup the call
+          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!(OesDemo, :port => 1888, :host => "localhost")
-  
+      FSR.start_oes! OutboundDemo, :port => 8084, :host => "127.0.0.1"
   
   
-  Example of creating an Outbound Eventsocket listener that can read DTMF input and keep state:
+  An Inbound Event Socket Listener example using FreeSWITCHeR's hook system:
+  --------------------------------------------------------------------------
   
-      #!/usr/bin/env ruby
-      
+      require 'pp'
       require 'fsr'
-      require 'fsr/listener/outbound'
-  
-      FSR.load_all_applications
-      FSR.load_all_commands
-  
-      class DtmfDemo < FSR::Listener::Outbound
-  
-        def session_initiated
-          exten = @session.headers[:caller_caller_id_number]
-          FSR::Log.info "*** Answering incoming call from #{exten}"
-          answer # Answer the call
-        end
+      require "fsr/listener/inbound"
   
-        def receive_reply(reply)
-          exten = @session.headers[:caller_caller_id_number]
-          case @step
-          when 1
-            FSR::Log.info "*** Reading dtmf for #{exten}"
-            read "/home/freeswitch/freeswitch/sounds/music/8000/sweet.wav",4,10,"test",15000 # read test
-          when 2
-            FSR::Log.info "*** updating session for #{exten}"
-            update_session
-          when 3
-            FSR::Log.info "** Success, grabbed #{@session.headers[:variable_test].strip} from #{exten}"
-            FSR::Log.info "*** Hanging up call"
-            hangup # Hangup the call
-          end
-        end
+      # 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
   
-      FSR.start_oes! DtmfDemo, :port => 8084, :host => "127.0.0.1"
+      # 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)
   
-  Example of creating an Inbound Eventsocket listener:
   
-      #!/usr/bin/env ruby
+  An Inbound Event Socket Listener example using the on_event callback method instead of hooks:
+  ---------------------------------------------------------------------------------------------
   
-      require 'fsr'
-      require 'fsr/listener/inbound'
       require 'pp'
+      require 'fsr'
+      require "fsr/listener/inbound"
+  
   
       class IesDemo < FSR::Listener::Inbound
   
@@ -228,8 +231,24 @@ post_install_message: |
       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
+  
+  SUPPORT
   -------
   Home page at http://code.rubyists.com/projects/fs
   #rubyists on FreeNode
@@ -252,15 +271,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: freeswitcher
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: A library for interacting with the "FreeSWITCH":http://freeswitch.org telephony platform
 test_files: 
-- spec
-- spec/fsr
-- spec/fsr/app
+- spec/fsr/app.rb
 - spec/fsr/app/bridge.rb
 - spec/fsr/app/conference.rb
 - spec/fsr/app/fifo.rb
@@ -271,17 +288,12 @@ test_files:
 - spec/fsr/app/playback.rb
 - spec/fsr/app/set.rb
 - spec/fsr/app/transfer.rb
-- spec/fsr/app.rb
-- spec/fsr/cmd
+- spec/fsr/cmd.rb
 - spec/fsr/cmd/calls.rb
 - spec/fsr/cmd/originate.rb
-- spec/fsr/cmd/sofia
-- spec/fsr/cmd/sofia/profile.rb
 - spec/fsr/cmd/sofia.rb
-- spec/fsr/cmd.rb
-- spec/fsr/listener
+- spec/fsr/cmd/sofia/profile.rb
+- spec/fsr/listener.rb
 - spec/fsr/listener/inbound.rb
 - spec/fsr/listener/outbound.rb
-- spec/fsr/listener.rb
 - spec/fsr/loading.rb
-- spec/helper.rb