bougyman-freeswitcher 0.1.3 → 0.1.4

data/MANIFEST

@@ -0,0 +1,101 @@
+.gitignore
+AUTHORS
+CHANGELOG
+License.txt
+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
+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

data/README

@@ -4,108 +4,88 @@ Copyright (c) 2009 The Rubyists (Jayson Vaughn, Tj Vanderpoel, Michael Fellinger
 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"
 
 
+An Inbound Event Socket Listener example using FreeSWITCHeR's hook system:
+--------------------------------------------------------------------------
 
-Example of creating an Outbound Eventsocket listener that can read DTMF input and keep state:
-
-    #!/usr/bin/env ruby
-    
+    require 'pp'
     require 'fsr'
-    require 'fsr/listener/outbound'
-
-    FSR.load_all_applications
-    FSR.load_all_commands
+    require "fsr/listener/inbound"
 
-    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
+    # 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
 
@@ -119,8 +99,24 @@ Example of creating an Inbound Eventsocket listener:
     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

data/Rakefile

@@ -1,82 +1,36 @@
 require 'rake/clean'
 require "rubygems"
-
-import(*Dir['tasks/*rake'])
-
-task :default => :spec
-
-desc 'install dependencies'
-task :setup do
-  GemSetup.new do
-    github = 'http://gems.github.com'
-    Gem.sources << github
-
-    gem('bacon')
-    setup
-  end
+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_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?
+
+
+GEMSPEC = Gem::Specification.new do |spec|
+  spec.name = "freeswitcher"
+  spec.version = ENV["FSR_VERSION"] || FSR::VERSION
+  spec.summary = 'A library for interacting with the "FreeSWITCH":http://freeswitch.org telephony platform'
+  spec.authors = ["Jayson Vaughn", "Michael Fellinger", "Kevin Berry", "TJ Vanderpoel"]
+  spec.email = "FreeSWITCHeR@rubyists.com"
+  spec.homepage = "http://code.rubyists.com/projects/fs"
+  spec.add_dependency "eventmachine"
+  
+  spec.files = GEM_FILES
+  spec.test_files = PROJECT_SPECS
+  spec.require_path = "lib"
+
+  description = File.read(PROJECT_README)
+  spec.description = description
+  spec.rubyforge_project = "freeswitcher"
+  spec.post_install_message = description
 end
 
-class GemSetup
-  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
-    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
+import(*Dir['tasks/*rake'])
 
-  ensure
-    ARGV.replace(old_argv) if extconf
-  end
-end
+task :default => :bacon

data/examples/inbound_event_socket.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+require File.join(File.dirname(__FILE__), "..", 'lib', 'fsr')
+$stdout.flush
+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)

data/examples/inbound_socket_events.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+require File.join(File.dirname(__FILE__), "..", 'lib', 'fsr')
+$stdout.flush
+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)
+

data/examples/outbound_event_socket.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), "..", 'lib', 'fsr')
+require "fsr/listener/outbound"
+$stdout.flush
+
+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"