freeswitcher 0.4.2 → 0.4.3

data/lib/fsr.rb

@@ -67,11 +67,11 @@ module FSR
   #                       <tt>:host [String]</tt> The host/ip to bind to (Default: "localhost") 
   #                       <tt>:port [Integer]</tt> the port to listen on (Default: 8021)
   def self.start_ies!(klass, args = {})
-    port = args.delete(:port) || "8084"
-    host = args.delete(:host) || "localhost"
+    args[:port] ||= 8021
+    args[:host] ||= "localhost"
     EM.run do
-      EventMachine::connect(host, port, klass, args)
-      FSR::Log.info "*** FreeSWITCHer Inbound EventSocket Listener connected to #{host}:#{port} ***"
+      EventMachine::connect(args[:host], args[:port], klass, args)
+      FSR::Log.info "*** FreeSWITCHer Inbound EventSocket Listener connected to #{args[:host]}:#{args[:port]} ***"
       FSR::Log.info "*** http://code.rubyists.com/projects/fs"
     end
   end

data/lib/fsr/app/bind_meta_app.rb

@@ -0,0 +1,26 @@
+
+require "fsr/app"
+module FSR
+  module App
+    class BindMetaApp < Application
+      attr_reader :options
+
+      def initialize(args)
+        @options = args
+      end
+
+      # It would be better to fix App#app_name to transform
+      # CamelCase to snake_case, but that'll be later.
+      def app_name
+        "bind_meta_app"
+      end
+
+      def arguments
+        parameters = options[:parameters] ? "::#{options[:parameters]}" : ""
+        [options[:key], options[:listen_to], options[:respond_on], options[:application] + parameters]
+      end
+    end
+
+    register(:bind_meta_app, BindMetaApp)
+  end
+end

data/lib/fsr/app/bridge.rb

@@ -5,14 +5,15 @@ module FSR
     class Bridge < Application
       attr_reader :options
 
-      def initialize(target, opts = {})
-        # These are options that will precede the target address
-        @target = target
-        @options = opts || {}
+      def initialize(*params)
+        @options = params.last.is_a?(Hash) ? params.pop : {}
+        @sequential = @options.delete(:sequential)
+        @targets = params
       end
 
       def arguments
-        [@target]
+        delimeter = @sequential ? "|" : ","
+        [@targets.join(delimeter)]
       end
 
       def modifiers

data/lib/fsr/app/execute_app.rb

@@ -0,0 +1,15 @@
+require "fsr/app"
+module FSR
+  module App
+    # http://wiki.freeswitch.org/wiki/Misc._Dialplan_Tools_log
+    class ExecuteApp < Application
+      attr_reader :app_name, :arguments
+      def initialize(app, *args)
+        @app_name = app
+        @arguments = args
+      end
+    end
+
+    register(:execute_app, ExecuteApp)
+  end
+end

data/lib/fsr/app/play_and_get_digits.rb

@@ -4,17 +4,32 @@ module FSR
   module App
     class PlayAndGetDigits < Application
       attr_reader :chan_var
+      DEFAULT_ARGS = {:min => 0, :max => 10, :tries => 3, :timeout => 7000, :terminators => ["#"], :chan_var => "fsr_read_dtmf", :regexp => '\d'}
 
-      def initialize(sound_file, invalid_file, min = 0, max = 10, tries = 3, timeout = 7000, terminators = ["#"], chan_var = "fsr_read_dtmf", regexp = "\d")
+      # args format for array:
+      # sound_file, invalid_file, min = 0, max = 10, tries = 3, timeout = 7000, terminators = ["#"], chan_var = "fsr_read_dtmf", regexp = '\d'
+      def initialize(sound_file, invalid_file, *args)
+        #puts args.inspect
+        if args.size == 1 and args.first.kind_of?(Hash)
+          arg_hash = DEFAULT_ARGS.merge(args.first)
+        elsif args.size > 0
+          # The array used to .zip the args here can be replaced with DEFAULT_ARGS.keys if Hash keys are ordered (1.9)
+          # For now we'll hard code them to preserve order in 1.8/jruby
+          arg_hash = DEFAULT_ARGS.merge(Hash[[:min, :max, :tries, :timeout, :terminators, :chan_var, :regexp][0 .. (args.size-1)].zip(args)]) 
+        elsif args.size == 0
+          arg_hash = DEFAULT_ARGS
+        else
+          raise "Invalid Arguments for PlayAndGetDigits#new (must pass (sound_file, invalid_file, hash) or (sound_file, invalid_file, min = 0, max = 10, tries = 3, timeout = 7000, terminators = ['#'], chan_var = 'fsr_read_dtmf', regexp = '\d'))"
+        end
         @sound_file = sound_file
         @invalid_file = invalid_file
-        @min = min
-        @max = max
-        @tries = tries
-        @timeout = timeout
-        @chan_var = chan_var
-        @terminators = terminators
-        @regexp = regexp
+        @min = arg_hash[:min]
+        @max = arg_hash[:max]
+        @tries = arg_hash[:tries]
+        @timeout = arg_hash[:timeout]
+        @chan_var = arg_hash[:chan_var]
+        @terminators = arg_hash[:terminators]
+        @regexp = arg_hash[:regexp]
       end
 
       def arguments
@@ -30,7 +45,7 @@ module FSR
           @read_var = "variable_#{me.chan_var}"
           sendmsg me
           @queue.unshift Proc.new { update_session } 
-          @queue.unshift block if block_given?
+          @queue.unshift(block_given? ? block : lambda {})
         end
       |
     end

data/lib/fsr/app/read.rb

@@ -21,7 +21,7 @@ module FSR
           @read_var = "variable_#{me.chan_var}"
           sendmsg me
           @queue.unshift Proc.new { update_session } 
-          @queue.unshift block if block_given?
+          @queue.unshift(block_given? ? block : lambda {})
         end
       |
     end

data/lib/fsr/app/speak.rb

@@ -9,10 +9,11 @@ module FSR
         # wav file you wish to play, full path 
         @message = message
         @voice = opts[:voice] || "slt"
+        @engine = opts[:engine] || "flite"
       end
 
       def arguments
-        ["flite", @voice, @message]
+        [@engine, @voice, @message]
       end
 
       def sendmsg

data/lib/fsr/cmd/sofia_contact.rb

@@ -10,7 +10,7 @@ module FSR
       def initialize(fs_socket = nil, contact = {})
         @fs_socket = fs_socket # FSR::CommandSocket obj
         @contact = contact[:contact]
-        puts @contact
+        #puts @contact
       end
 
       # Send the command to the event socket, using api by default.

data/lib/fsr/listener/header_and_content_response.rb

@@ -9,6 +9,11 @@ module FSR
       def initialize(args = {})
         @headers = args[:headers]
         @content =  args[:content]
+        strip_newlines
+      end
+
+      def strip_newlines
+        @content.each {|k,v| v.chomp! if v.is_a?(String)}
       end
       
       # Keep backward compat with the other 2 people who use FSR

data/lib/fsr/listener/inbound.rb

@@ -6,21 +6,53 @@ require 'fsr/listener/header_and_content_response.rb'
 module FSR
   module Listener
     class Inbound < EventMachine::Protocols::HeaderAndContentProtocol
-      attr_reader :auth
+      attr_reader :auth, :hooks, :event, :server, :port
 
       HOOKS = {}
 
       def initialize(args = {})
         super
         @auth = args[:auth] || "ClueCon"
+        @host = args[:host]
+        @port = args[:port]
+        @hooks = {}
       end
 
-      # post_init is called upon each "new" socket connection
+      # post_init is called upon each "new" socket connection.
+      #
+      # If Freeswitcher hasn't started listening for inbound socket connections
+      # yet, EventMachine will silently do nothing. A periodic timer is added
+      # to check wether the connection has been initiated yet, otherwise tries
+      # again in five seconds.
       def post_init
+        if error?
+          reconnect_until_succeeding
+        else
+          authorize_and_register_for_events
+        end
+      end
+
+      def reconnect_until_succeeding
+        timer = EM::PeriodicTimer.new(5) {
+          if error?
+            FSR::Log.info "Couldn't establish connection. Trying again..."
+           reconnect @host, @port
+          else
+            timer.cancel
+            authorize_and_register_for_events
+          end
+        }
+      end
+
+      def authorize_and_register_for_events
+        FSR::Log.info "Connection established. Authorizing..."
         say("auth #{@auth}")
         say('event plain ALL')
       end
 
+      def before_session 
+      end
+
       # receive_request is the callback method when data is recieved from the socket
       #
       # param header headers from standard Header and Content protocol
@@ -28,12 +60,13 @@ module FSR
       def receive_request(header, content)
         hash_header = headers_2_hash(header)
         hash_content = headers_2_hash(content)
-        event = HeaderAndContentResponse.new({:headers => hash_header, :content => hash_content})
+        @event = HeaderAndContentResponse.new({:headers => hash_header, :content => hash_content})
         event_name = event.content[:event_name].to_s.strip
         unless event_name.empty?
-          HOOKS[event_name.to_sym].call(event) unless HOOKS[event_name.to_sym].nil?
+          instance_eval &HOOKS[event_name.to_sym] unless HOOKS[event_name.to_sym].nil?
+          instance_eval &@hooks[event_name.to_sym] unless @hooks[event_name.to_sym].nil?
         end
-        on_event(event)
+        on_event
       end
 
       # say encapsulates #send_data for the user
@@ -42,12 +75,19 @@ module FSR
       def say(line)
         send_data("#{line}\r\n\r\n")
       end
+
+      # api encapsulates #say("api blah") for the user
+      #
+      # param line Line of text to send to the socket proceeding api
+      def api(line)
+        say("api #{line}")
+      end
       
       # on_event is the callback method when an event is triggered
       #
       # param event The triggered event object
       # return event The triggered event object
-      def on_event(event)
+      def on_event
         event
       end
 
@@ -66,6 +106,23 @@ module FSR
         HOOKS.delete(event)  
       end
 
+      # add_event_hook adds an Event to listen for.  When that Event is triggered, it will call the defined block
+      #
+      # @param event The event to trigger the block on.  Examples, :CHANNEL_CREATE, :CHANNEL_DESTROY, etc
+      # @param block The block to execute when the event is triggered
+      def add_event(event, &block)
+        @hooks[event] = block 
+      end
+
+      # del_event_hook removes an Event.
+      #
+      # @param event The event to remove.  Examples, :CHANNEL_CREATE, :CHANNEL_DESTROY, etc
+      def del_event(event)
+        @hooks.delete(event)  
+      end
+
+
+
     end
 
   end

data/lib/fsr/listener/outbound.rb

@@ -16,7 +16,7 @@ module FSR
       SENDMSG_METHOD_DEFINITION = [
                                    "def %s(*args, &block)",
                                    "  sendmsg super",
-                                   "  @queue.unshift block if block_given?",
+                                   " @queue.unshift(block_given? ? block : lambda {})",
                                    "end"
                                   ].join("\n")
 
@@ -70,6 +70,13 @@ module FSR
         @queue.unshift block if block_given?
       end
 
+      # Scheduel Hangup
+
+      def sched_hangup(secs, &block)
+        send_data("api sched_hangup +#{secs} #{@session.headers[:unique_id]} alotted_timeout\n\n")
+        @queue.unshift block if block_given?
+      end
+
       def next_step
         @step += 1
         receive_reply(@session)

data/lib/fsr/version.rb

@@ -1,3 +1,3 @@
 module FSR
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

data/spec/fsr/app/bind_meta_app.rb

@@ -0,0 +1,18 @@
+require 'spec/helper'
+require "fsr/app"
+FSR::App.load_application("bind_meta_app")
+
+describe "Testing FSR::App::BindMetaApp" do
+  it "binds a meta app" do
+    meta_app = FSR::App::BindMetaApp.new :key => 1, :listen_to => "a",
+      :respond_on => "s", :application => "hangup"
+    meta_app.sendmsg.should == "call-command: execute\nexecute-app-name: bind_meta_app\nexecute-app-arg: 1 a s hangup\n\n"
+  end
+
+  it "binds a meta app with parameters" do
+    meta_app = FSR::App::BindMetaApp.new :key => 1, :listen_to => "a",
+      :respond_on => "s", :application => "execute_extension",
+      :parameters => "dx XML features"
+    meta_app.sendmsg.should == "call-command: execute\nexecute-app-name: bind_meta_app\nexecute-app-arg: 1 a s execute_extension::dx XML features\n\n"
+  end
+end

data/spec/fsr/app/bridge.rb

@@ -3,15 +3,46 @@ require "fsr/app"
 FSR::App.load_application("bridge")
 
 describe "Testing FSR::App::Bridge" do
-  # Utilize the [] shortcut to start a conference
-  it "Bridges a call, for FSR::Listener::Inbound" do
-    bridge = FSR::App::Bridge.new("user/bougyman")
-    bridge.raw.should == "bridge({}user/bougyman)"
+  describe "with a single endpoint" do
+    before do
+      @bridge = FSR::App::Bridge.new("user/bougyman")
+    end
+
+    # Utilize the [] shortcut to start a conference
+    it "bridges a call, for FSR::Listener::Inbound" do
+      @bridge.raw.should == "bridge({}user/bougyman)"
+    end
+
+    it "bridges a call, for FSR::Listener::Outbound" do
+      @bridge.sendmsg.should == "call-command: execute\nexecute-app-name: bridge\nexecute-app-arg: user/bougyman\n\n"
+    end
   end
 
-  it "Bridges a call, for FSR::Listener::Outbound" do
-    bridge = FSR::App::Bridge.new("user/bougyman")
-    bridge.sendmsg.should == "call-command: execute\nexecute-app-name: bridge\nexecute-app-arg: user/bougyman\n\n"
+  describe "with multiple simultaneous endpoints" do
+    before do
+      @bridge = FSR::App::Bridge.new("user/bougyman", "user/coltrane")
+    end
+
+    it "bridges a call, for FSR::Listener::Inbound" do
+      @bridge.raw.should == "bridge({}user/bougyman,user/coltrane)"
+    end
+
+    it "bridges a call, for FSR::Listener::Outbound" do
+      @bridge.sendmsg.should == "call-command: execute\nexecute-app-name: bridge\nexecute-app-arg: user/bougyman,user/coltrane\n\n"
+    end
   end
+  
+  describe "with multiple sequential endpoints" do
+    before do
+      @bridge = FSR::App::Bridge.new("user/bougyman", "user/coltrane", :sequential => true)
+    end
+
+    it "bridges a call, for FSR::Listener::Inbound" do
+      @bridge.raw.should == "bridge({}user/bougyman|user/coltrane)"
+    end
 
+    it "bridges a call, for FSR::Listener::Outbound" do
+      @bridge.sendmsg.should == "call-command: execute\nexecute-app-name: bridge\nexecute-app-arg: user/bougyman|user/coltrane\n\n"
+    end
+  end
 end

data/spec/fsr/app/execute_app.rb

@@ -0,0 +1,15 @@
+require 'spec/helper'
+require "fsr/app"
+FSR::App.load_application("execute_app")
+
+describe "Testing FSR::App::ExecuteApp" do
+  it "executes arbitrary app with one argument" do
+    log = FSR::App::ExecuteApp.new("att_xfer", "sofia/user/1")
+    log.sendmsg.should == "call-command: execute\nexecute-app-name: att_xfer\nexecute-app-arg: sofia/user/1\n\n"
+  end
+
+  it "executes arbitrary app with multiple argument" do
+    log = FSR::App::ExecuteApp.new("log", "INFO", "foo bar")
+    log.sendmsg.should == "call-command: execute\nexecute-app-name: log\nexecute-app-arg: INFO foo bar\n\n"
+  end
+end

data/spec/fsr/app/play_and_get_digits.rb

@@ -4,9 +4,48 @@ FSR::App.load_application("play_and_get_digits")
 
 describe "Testing FSR::App::PlayAndGetDigits" do
   # Utilize the [] shortcut to start a conference
-  it "Send a play_and_gets_digits command" do
+  it "Send a play_and_gets_digits command, default args" do
     tmp = FSR::App::PlayAndGetDigits.new("soundfile.wav", "invalid.wav")
-    tmp.sendmsg.should == "call-command: execute\nexecute-app-name: play_and_get_digits\nexecute-app-arg: 0 10 3 7000 # soundfile.wav invalid.wav fsr_read_dtmf d\nevent-lock:true\n\n"
+    tmp.sendmsg.should == "call-command: execute\nexecute-app-name: play_and_get_digits\nexecute-app-arg: 0 10 3 7000 # soundfile.wav invalid.wav fsr_read_dtmf \\d\nevent-lock:true\n\n"
+  end
+
+  it "Send a play_and_gets_digits command with array args, one arg" do
+    tmp = FSR::App::PlayAndGetDigits.new("soundfile.wav", "invalid.wav", "4")
+    tmp.sendmsg.should == "call-command: execute\nexecute-app-name: play_and_get_digits\nexecute-app-arg: 4 10 3 7000 # soundfile.wav invalid.wav fsr_read_dtmf \\d\nevent-lock:true\n\n"
+  end
+
+  it "Send a play_and_gets_digits command with array args, two args" do
+    tmp = FSR::App::PlayAndGetDigits.new("soundfile.wav", "invalid.wav", "4", "4")
+    tmp.sendmsg.should == "call-command: execute\nexecute-app-name: play_and_get_digits\nexecute-app-arg: 4 4 3 7000 # soundfile.wav invalid.wav fsr_read_dtmf \\d\nevent-lock:true\n\n"
+  end
+
+  it "Send a play_and_gets_digits command with array args, three args" do
+    tmp = FSR::App::PlayAndGetDigits.new("soundfile.wav", "invalid.wav", "4", "4", "2")
+    tmp.sendmsg.should == "call-command: execute\nexecute-app-name: play_and_get_digits\nexecute-app-arg: 4 4 2 7000 # soundfile.wav invalid.wav fsr_read_dtmf \\d\nevent-lock:true\n\n"
+  end
+  it "Send a play_and_gets_digits command with array args, four args" do
+    tmp = FSR::App::PlayAndGetDigits.new("soundfile.wav", "invalid.wav", "4", "4", "2", "10000")
+    tmp.sendmsg.should == "call-command: execute\nexecute-app-name: play_and_get_digits\nexecute-app-arg: 4 4 2 10000 # soundfile.wav invalid.wav fsr_read_dtmf \\d\nevent-lock:true\n\n"
+  end
+
+  it "Send a play_and_gets_digits command with array args, five args" do
+    tmp = FSR::App::PlayAndGetDigits.new("soundfile.wav", "invalid.wav", "4", "4", "2", "10000", ['*'])
+    tmp.sendmsg.should == "call-command: execute\nexecute-app-name: play_and_get_digits\nexecute-app-arg: 4 4 2 10000 * soundfile.wav invalid.wav fsr_read_dtmf \\d\nevent-lock:true\n\n"
+  end
+
+  it "Send a play_and_gets_digits command with array args, six args" do
+    tmp = FSR::App::PlayAndGetDigits.new("soundfile.wav", "invalid.wav", "4", "4", "2", "10000", ['*'], "read_var")
+    tmp.sendmsg.should == "call-command: execute\nexecute-app-name: play_and_get_digits\nexecute-app-arg: 4 4 2 10000 * soundfile.wav invalid.wav read_var \\d\nevent-lock:true\n\n"
+  end
+
+  it "Send a play_and_gets_digits command with array args, seven args" do
+    tmp = FSR::App::PlayAndGetDigits.new("soundfile.wav", "invalid.wav", "4", "4", "2", "10000", ['*'], "read_var", '\w')
+    tmp.sendmsg.should == "call-command: execute\nexecute-app-name: play_and_get_digits\nexecute-app-arg: 4 4 2 10000 * soundfile.wav invalid.wav read_var \\w\nevent-lock:true\n\n"
+  end
+
+  it "Send a play_and_gets_digits command with hash args, just max" do
+    tmp = FSR::App::PlayAndGetDigits.new("soundfile.wav", "invalid.wav", :max => "4")
+    tmp.sendmsg.should == "call-command: execute\nexecute-app-name: play_and_get_digits\nexecute-app-arg: 0 4 3 7000 # soundfile.wav invalid.wav fsr_read_dtmf \\d\nevent-lock:true\n\n"
   end
 
 end