freeswitcher 0.0.13 → 0.1.3

data/examples/play_and_get_test.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), "..", 'lib', 'fsr')
+require "fsr/listener/outbound"
+$stdout.flush
+
+FSR.load_all_applications
+FSR.load_all_commands
+class PlayAndGetTest < 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}"
+      play_and_get_digits "tone_stream://%(10000,0,350,440)","/home/freeswitch/freeswitch/sounds/en/us/callie/misc/8000/error.wav",2,10,3,7000,["#"],"test", "\d+" # play_and_get_digits test
+    when 2
+      FSR::Log.info "*** updating session for #{exten}"
+      update_session
+    when 3
+      FSR::Log.info "** Success, grabbed #{@session.headers[:variable_test]} from #{exten}"
+      FSR::Log.info "*** Hanging up call"
+      hangup # Hangup the call
+    end
+  end
+
+end
+
+FSR.start_oes! PlayAndGetTest, :port => 8084, :host => "127.0.0.1"

data/lib/fsr.rb

@@ -6,7 +6,7 @@ require 'pp'
 module FSR
   # Global configuration options
   #
-  VERSION = '0.0.13'
+  VERSION = '0.1.3'
   FS_INSTALL_PATHS = ["/usr/local/freeswitch", "/opt/freeswitch", "/usr/freeswitch"]
   DEFAULT_CALLER_ID_NUMBER = '8675309'
   DEFAULT_CALLER_ID_NAME   = "FSR"

data/lib/fsr/app/limit.rb

@@ -0,0 +1,19 @@
+require "fsr/app"
+module FSR
+  module App
+    class Limit < Application
+
+      def initialize(id = nil, realm = "$${domain}", limit = 5)
+        @realm, @id, @limit = realm, id, limit
+        raise "Must supply a valid id" if @id.nil?
+      end
+
+      def arguments
+        [@realm, @id, @limit]
+      end
+
+    end
+
+    register(:limit, Limit)
+  end
+end

data/lib/fsr/app/play_and_get_digits.rb

@@ -0,0 +1,30 @@
+require "fsr/app"
+module FSR
+  #http://wiki.freeswitch.org/wiki/Misc._Dialplan_Tools_play_and_get_digits
+  module App
+    class PlayAndGetDigits < Application
+      def initialize(sound_file, invalid_file, min = 0, max = 10, tries = 3, timeout = 7000, terminators = ["#"], chan_var = "fsr_read_dtmf", regexp = "\d")
+        @sound_file = sound_file
+        @invalid_file = invalid_file
+        @min = min
+        @max = max
+        @tries = tries
+        @timeout = timeout
+        @chan_var = chan_var
+        @terminators = terminators
+        @regexp = regexp
+      end
+
+      def arguments
+        [@min, @max, @tries, @timeout, @terminators.join(","), @sound_file, @invalid_file, @chan_var, @regexp]
+      end
+
+      def sendmsg
+        "call-command: execute\nexecute-app-name: %s\nexecute-app-arg: %s\nevent-lock:true\n\n" % ["play_and_get_digits", arguments.join(" ")]
+      end
+
+    end
+
+    register(:play_and_get_digits, PlayAndGetDigits)
+  end
+end

data/lib/fsr/cmd/calls.rb

@@ -0,0 +1,46 @@
+require "fsr/app"
+module FSR
+  module Cmd
+    class Calls < Command
+
+      include Enumerable
+      def each(&block)
+        @calls ||= run
+        if @calls
+          @calls.each { |call| yield call }
+        end
+      end
+
+      def initialize(fs_socket = nil)
+        @fs_socket = fs_socket # FSR::CommandSocket obj
+      end
+
+      # Send the command to the event socket, using bgapi by default.
+      def run(api_method = :api)
+        orig_command = "%s %s" % [api_method, raw]
+        Log.debug "saying #{orig_command}"
+        resp = @fs_socket.say(orig_command)
+        unless resp["body"] == "0 total."
+          call_info, count = resp["body"].split("\n\n")
+          require "fsr/model/call"
+          begin
+            require "fastercsv"
+            calls = FCSV.parse(call_info)
+          rescue LoadError
+            require "csv"
+            calls = CSV.parse(call_info)
+          end
+          return calls[1 .. -1].map { |c| FSR::Model::Call.new(*c) }
+        end
+        nil
+      end
+
+      # This method builds the API command to send to the freeswitch event socket
+      def raw
+        orig_command = "show calls"
+      end
+    end
+
+    register(:calls, Calls)
+  end
+end

data/lib/fsr/listener/outbound.rb

@@ -31,7 +31,6 @@ module FSR
       # @param reply This HeaderAndContent instance will have the channel variables
       #              in #content, if the session has been updated
       def receive_reply(reply)
-        FSR::Log.warn "#{self.class.name}#receive_reply not overwritten"
         FSR::Log.debug reply.inspect
       end
 
@@ -53,9 +52,15 @@ module FSR
         send_data("api uuid_dump #{@session.headers[:unique_id]}\n\n")
       end
 
+      def next_step
+        @step += 1
+        receive_reply(@session)
+      end
+
       protected
       def post_init
         @session = nil # holds the session object
+        @stack = [] # Keep track of stack for state machine
         send_data("connect\n\n")
         FSR::Log.debug "Accepting connections."
       end
@@ -83,20 +88,26 @@ module FSR
             session_header_and_content = HeaderAndContentResponse.new({:headers => hash_header.merge(hash_content.strip_value_newlines), :content => {}})
             @session = session_header_and_content
             @step += 1
+            @stack.pop.call unless @stack.empty?
             receive_reply(hash_header)
           end
         else
           @step += 1
+          @stack.pop.call unless @stack.empty?
           receive_reply(session_header_and_content)
         end
       end
 
+      def cmd(&block)
+        @stack << block
+      end
+
     end
   end
 end
 
 class Hash
   def strip_value_newlines
-    Hash[self.map { |k,v| v.respond_to?(:to_s) ? [k, v.to_s.strip] : [k, v] }]
+    Hash[*(self.map { |k,v| v.respond_to?(:to_s) ? [k, v.to_s.strip] : [k, v] }.flatten)]
   end
 end

data/lib/fsr/model/call.rb

@@ -0,0 +1,48 @@
+module FSR
+  module Model
+    class Call
+      attr_reader :created, :created_epoch, :function, :caller_id_name, :caller_id_number,
+                  :caller_destination, :caller_channel_name, :caller_uuid, :callee_id_name,
+                  :callee_id_number, :callee_destination, :callee_channel_name, :callee_uuid
+      def initialize(created,
+                     created_epoch,
+                     function,
+                     caller_cid_name,
+                     caller_cid_num,
+                     caller_dest_num,
+                     caller_chan_name,
+                     caller_uuid,
+                     callee_cid_name,
+                     callee_cid_num,
+                     callee_dest_num,
+                     callee_chan_name,
+                     callee_uuid)
+        @created,
+        @created_epoch,
+        @function,
+        @caller_id_name,
+        @caller_id_number,
+        @caller_destination,
+        @caller_chan_name,
+        @caller_uuid,
+        @callee_id_name,
+        @callee_id_number,
+        @callee_destination,
+        @callee_channel_name,
+        @callee_uuid = created, 
+                       created_epoch,
+                       function,
+                       caller_cid_name,
+                       caller_cid_num,
+                       caller_dest_num,
+                       caller_chan_name,
+                       caller_uuid,
+                       callee_cid_name,
+                       callee_cid_num,
+                       callee_dest_num,
+                       callee_chan_name,
+                       callee_uuid
+      end
+    end
+  end
+end

data/spec/fsr/app/limit.rb

@@ -0,0 +1,26 @@
+require 'spec/helper'
+require "fsr/app"
+FSR::App.load_application("limit")
+
+describe "Testing FSR::App::Limit" do
+  ## Calls ##
+  # Interface to calls
+  it "FSR::App::Limit should send proper limit command only passing an id" do
+    limit = FSR::App::Limit.new("fsr_caller")
+    limit.raw.should == "limit($${domain} fsr_caller 5)"
+    limit.sendmsg.should == "call-command: execute\nexecute-app-name: limit\nexecute-app-arg: $${domain} fsr_caller 5\n\n"
+  end
+
+  it "FSR::App::Limit should send proper limit command passing id and realm" do
+    limit = FSR::App::Limit.new("fsr_caller", "foodomain")
+    limit.raw.should == "limit(foodomain fsr_caller 5)"
+    limit.sendmsg.should == "call-command: execute\nexecute-app-name: limit\nexecute-app-arg: foodomain fsr_caller 5\n\n"
+  end
+
+  it "FSR::App::Limit should send proper limit command passing id, realm, and limit" do
+    limit = FSR::App::Limit.new("fsr_caller", "foodomain", 10)
+    limit.raw.should == "limit(foodomain fsr_caller 10)"
+    limit.sendmsg.should == "call-command: execute\nexecute-app-name: limit\nexecute-app-arg: foodomain fsr_caller 10\n\n"
+  end
+
+end

data/spec/fsr/app/play_and_get_digits.rb

@@ -0,0 +1,12 @@
+require 'spec/helper'
+require "fsr/app"
+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
+    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"
+  end
+
+end

data/spec/fsr/cmd/calls.rb

@@ -0,0 +1,13 @@
+require 'spec/helper'
+require "fsr/cmd"
+FSR::Cmd.load_command("calls")
+
+describe "Testing FSR::Cmd::Calls" do
+  ## Calls ##
+  # Interface to calls
+  it "FSR::Cmd::Calls should send show calls" do
+    sofia = FSR::Cmd::Calls.new
+    sofia.raw.should == "show calls"
+  end
+
+end

data/spec/fsr/loading.rb

@@ -4,7 +4,7 @@ require 'spec/helper'
 describe "Testing FSR module loading methods" do
   # When you add applications  you must modify the expected apps_loaded behavior
   it "Loads all applications" do
-    all_apps = [:uuid_dump, :uuid_setvar, :uuid_getvar, :read, :set, :transfer, :speak, :fs_sleep, :playback, :answer, :fifo, :bridge, :hangup, :conference, :fs_break, :log]
+    all_apps = [:play_and_get_digits, :uuid_dump, :uuid_setvar, :uuid_getvar, :read, :set, :transfer, :speak, :fs_sleep, :playback, :answer, :fifo, :bridge, :hangup, :conference, :fs_break, :log, :limit]
     # Add any apps which will load to this set
     apps_loaded = FSR.load_all_applications
     apps_loaded.kind_of?(Array).should == true
@@ -16,7 +16,7 @@ describe "Testing FSR module loading methods" do
 
   # When you add commands  you must modify the expected cmds_loaded behavior
   it "Loads all commands" do
-    all_commands = [:originate, :sofia, :fsctl, :sofia_contact, :status] # If you add a command add it to this set
+    all_commands = [:originate, :sofia, :fsctl, :sofia_contact, :status, :calls] # If you add a command add it to this set
     cmds_loaded = FSR.load_all_commands
     cmds_loaded.kind_of?(Array).should == true
     all_commands.each do |cmd|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: freeswitcher
 version: !ruby/object:Gem::Version 
-  version: 0.0.13
+  version: 0.1.3
 platform: ruby
 authors: 
 - Jayson Vaughn
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-16 00:00:00 -05:00
+date: 2009-05-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,6 +43,7 @@ files:
 - 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
@@ -53,7 +54,9 @@ files:
 - 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
@@ -64,6 +67,7 @@ files:
 - lib/fsr/app/uuid_setvar.rb
 - lib/fsr/app.rb
 - lib/fsr/cmd
+- lib/fsr/cmd/calls.rb
 - lib/fsr/cmd/fsctl.rb
 - lib/fsr/cmd/originate.rb
 - lib/fsr/cmd/sofia
@@ -91,6 +95,8 @@ files:
 - 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
@@ -259,12 +265,15 @@ test_files:
 - 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/app.rb
 - spec/fsr/cmd
+- spec/fsr/cmd/calls.rb
 - spec/fsr/cmd/originate.rb
 - spec/fsr/cmd/sofia
 - spec/fsr/cmd/sofia/profile.rb