FreeSWITCHeR 0.0.8

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 rubyists.com (TJ Vanderpoel, Jayson Vaughn, Michael Fellinger, Kevin Berry)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/NEWS

@@ -0,0 +1,3 @@
+2009-04-08 - Released new gem version, using EventMachine's HeaderAndContent protocol
+             in listeners now
+2009-04-01 - Added inspired to git committers

data/README

@@ -0,0 +1,85 @@
+=========================================================
+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(session)
+        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 Inbound Eventsocket listener:
+
+    #!/usr/bin/env ruby
+
+    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)
+
+
+
+Support
+-------
+Home page at http://code.rubyists.com/projects/fs
+#rubyists on FreeNode

data/Rakefile

@@ -0,0 +1,82 @@
+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
+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
+
+  ensure
+    ARGV.replace(old_argv) if extconf
+  end
+end

data/bin/cmd_demo.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+require File.join(File.dirname(__FILE__), "..", 'lib', 'fsr')
+require "fsr/cmd"
+
+FSR.load_all_commands
+sock = FSR::CommandSocket.new
+
+# Check the status of our server
+pp sock.status.run
+
+# Check max sessions
+pp sock.fsctl.max_sessions
+# Set max sessions
+pp sock.fsctl.max_sessions = 3000
+
+# Check up a sofia user
+pp sock.sofia_contact(:contact => "internal/user@domain.com").run

data/bin/ies_demo.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+require File.join(File.dirname(__FILE__), "..", 'lib', 'fsr')
+puts $LOAD_PATH.inspect
+$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/bin/ies_demo_with_hook.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+require File.join(File.dirname(__FILE__), "..", 'lib', 'fsr')
+puts $LOAD_PATH.inspect
+$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/bin/oes_demo.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), "..", 'lib', 'fsr')
+puts $LOAD_PATH.inspect
+$stdout.flush
+require "fsr/listener/outbound"
+
+class OesDemo < FSR::Listener::Outbound
+
+  def session_initiated(session)
+    number = session.headers[:caller_caller_id_number] # Grab the inbound caller id
+    FSR::Log.info "*** Answering incoming call from #{number}"
+    answer # Answer the call
+    log("1", "Pong from the FSR event socket!")
+    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")

data/lib/fsr.rb

@@ -0,0 +1,86 @@
+require 'logger'
+require 'socket'
+require 'pathname'
+require 'pp'
+
+module FSR
+  # Global configuration options
+  #
+  VERSION = '0.0.8'
+  FS_INSTALL_PATHS = ["/usr/local/freeswitch", "/opt/freeswitch", "/usr/freeswitch"]
+  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
+
+  ROOT = Pathname(__FILE__).dirname.expand_path.freeze
+  $LOAD_PATH.unshift(FSR::ROOT)
+
+  # Load all FSR::Cmd classes
+  def self.load_all_commands(retrying = false)
+    require 'fsr/command_socket'
+    load_all_applications
+    Cmd.load_all
+  end
+  
+  # Load all FSR::App classes
+  def self.load_all_applications
+    require "fsr/app"
+    App.load_all
+  end
+
+  # Method to start EM for Outbound Event Socket
+  def self.start_oes!(klass, args = {})
+    port = args[:port] || "8084"
+    host = args[:host] || "localhost"
+    EM.run do
+      EventMachine::start_server(host, port, klass)
+      FSR::Log.info "*** FreeSWITCHer Outbound EventSocket Listener on #{host}:#{port} ***"
+      FSR::Log.info "*** http://code.rubyists.com/projects/fs"
+    end
+  end
+  
+  # Method to start EM for Inbound Event Socket
+  def self.start_ies!(klass, args = {})
+    port = args[:port] || "8021"
+    host = args[:host] || "localhost"
+    EM.run do
+      EventMachine::connect(host, port, klass)
+      FSR::Log.info "*** FreeSWITCHer Inbound EventSocket Listener connected to #{host}:#{port} ***"
+      FSR::Log.info "*** http://code.rubyists.com/projects/fs"
+    end
+  end
+
+  private
+
+  # Find the FreeSWITCH install path if running FSR on a local box with FreeSWITCH installed.
+  # This will enable sqlite db access
+  def self.find_freeswitch_install
+    good_path = FS_INSTALL_PATHS.find do |fs_path|
+      Log.warn("#{fs_path} is not a directory!") if File.exists?(fs_path) && !File.directory?(fs_path)
+      Log.warn("#{fs_path} is not readable by this user!") if File.exists?(fs_path) && !File.readable?(fs_path)
+      Dir["#{fs_path}/{conf,db}/"].size == 2
+    end
+    if good_path.nil?
+      Log.warn("No FreeSWITCH install found, database and configuration functionality disabled")
+      return nil
+    end
+  end
+
+  FS_ROOT = find_freeswitch_install # FreeSWITCH $${base_dir}
+
+  if FS_ROOT
+    FS_CONFIG_PATH = (FS_ROOT + 'conf').freeze # FreeSWITCH conf dir
+    FS_DB_PATH = (FS_ROOT + 'db').freeze       # FreeSWITCH db dir
+  else
+    FS_CONFIG_PATH = FS_DB_PATH = nil
+  end
+end
+

data/lib/fsr/app.rb

@@ -0,0 +1,72 @@
+module FSR
+  module App
+    class Application
+      def to_s
+        sendmsg
+      end
+
+      def app_name
+        self.class.name.split("::").last.downcase
+      end
+
+      # This method builds the API command to send to freeswitch
+      def raw
+        "%s(%s)" % [app_name, arguments.join(" ")]
+      end
+
+      def sendmsg
+        "call-command: execute\nexecute-app-name: %s\nexecute-app-arg: %s\n\n" % [app_name, arguments.join(" ")] 
+      end
+    end
+
+    APPLICATIONS = {}
+    LOAD_PATH = [FSR::ROOT.join("fsr/app")]
+    REGISTER_CODE = "def %s(*args, &block); APPLICATIONS[%p].new(*args, &block); end"
+
+    def self.register(application, obj)
+      APPLICATIONS[application.to_sym] = obj
+
+      code = REGISTER_CODE % [application, application]
+      App.module_eval(code)
+    end
+     
+    def self.list
+      APPLICATIONS.keys
+    end
+
+    def self.load_application(application, force_reload = false)
+      exception = nil
+
+      if Pathname(application).absolute?
+        glob = application
+      else
+        glob = "{#{LOAD_PATH.join(',')}}/#{application}.{so,rb,bundle}"
+      end
+
+      Dir[glob].each do |file|
+        begin
+          return force_reload ? load(file) : require(file)
+        rescue LoadError => exception
+        end
+      end
+
+      raise("Couldn't find %s in %p" % [application, LOAD_PATH])
+    end
+
+    # Load all of the applications we find in App::LOAD_PATH
+    def self.load_all(force_reload = false)
+      glob = "{#{LOAD_PATH.join(',')}}/*.{so,rb,bundle}"
+
+      Dir[glob].each do |file|
+        force_reload ? load(file) : require(file)
+      end
+
+      list
+    end
+
+    def applications
+      FSR::App.list
+    end
+  end
+end
+FSA = FSR::App