bougyman-freeswitcher 0.0.9 → 0.1.0

data/README

@@ -44,11 +44,11 @@ Example of creating an Outbound Eventsocket listener:
 
     class OesDemo < FSR::Listener::Outbound
 
-      def session_initiated(session)
-        number = session.headers[:caller_caller_id_number] # Grab the inbound caller id
+      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
+        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
@@ -59,12 +59,53 @@ Example of creating an Outbound Eventsocket listener:
 
 
 
+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 'fsr/listener/inbound'
+    require 'pp'
 
     class IesDemo < FSR::Listener::Inbound
 

data/examples/bin/dtmf_test.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", 'start_common')
+require 'eventmachine'
+require "fsr/listener/outbound"
+require 'pp'
+$stdout.flush
+FSR.load_all_applications
+FSR.load_all_commands
+class ConsumerLogin < FSR::Listener::Outbound
+
+  def session_initiated(session, step = 0)
+    @step ||= step
+    exten = session.headers[:channel_caller_id_number]
+    pp session.headers
+    FSR::Log.info "*** Answering incoming call from #{exten}"
+    answer # Answer the call
+  end
+
+  def receive_reply(reply)
+    exten = @session.headers[:channel_caller_id_number]
+    @step += 1
+    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 #{reply.content[:variable_test].strip} from #{exten}"
+      FSR::Log.info "*** Hanging up call"
+      hangup # Hangup the call
+    end
+  end
+
+end
+
+FSR.start_oes! ConsumerLogin, :port => 8084, :host => "127.0.0.1"

data/{bin → examples/bin}/ies_demo_with_hook.rb

@@ -20,8 +20,6 @@ end
 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/dtmf_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 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"

data/examples/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/examples/ies_demo_with_hook.rb

@@ -0,0 +1,25 @@
+#!/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/examples/oes_demo.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), "..", 'lib', 'fsr')
+$stdout.flush
+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
+    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/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.8'
+  VERSION = '0.1.0'
   FS_INSTALL_PATHS = ["/usr/local/freeswitch", "/opt/freeswitch", "/usr/freeswitch"]
   DEFAULT_CALLER_ID_NUMBER = '8675309'
   DEFAULT_CALLER_ID_NAME   = "FSR"

data/lib/fsr/app/hangup.rb

@@ -3,12 +3,12 @@ module FSR
   module App
     # http://wiki.freeswitch.org/wiki/Misc._Dialplan_Tools_hangup
     class Hangup < Application
-      def initialize(data = nil)
-        @data = data
+      def initialize(cause = nil)
+        @cause = cause
       end
 
       def arguments
-        @data
+        @cause
       end
 
       def sendmsg

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/app/playback.rb

@@ -1,4 +1,3 @@
-
 require "fsr/app"
 module FSR
   module App
@@ -10,11 +9,11 @@ module FSR
         @wavfile = wavfile
       end
       def arguments
-        [@wavfile]
+        @wavfile
       end
 
       def sendmsg
-        "call-command: execute\nexecute-app-name: %s\nexecute-app-arg: %s\nevent-lock:true\n\n" % [app_name, arguments.join(" ")] 
+        "call-command: execute\nexecute-app-name: %s\nexecute-app-arg: %s\nevent-lock:true\n\n" % [app_name, arguments] 
       end
     end
 

data/lib/fsr/app/read.rb

@@ -0,0 +1,22 @@
+require "fsr/app"
+module FSR
+    # http://wiki.freeswitch.org/wiki/Misc._Dialplan_Tools_read
+  module App
+    class Read < Application
+      def initialize(sound_file, min = 0, max = 10, chan_var = "fsr_read_dtmf", timeout = 10000, terminators = ["#"])
+        @sound_file, @min, @max, @chan_var, @timeout, @terminators = sound_file, min, max, chan_var, timeout, terminators
+      end
+
+      def arguments
+        [@min, @max, @sound_file, @chan_var, @timeout, @terminators.join(",")]
+      end
+
+      def sendmsg
+        "call-command: execute\nexecute-app-name: %s\nexecute-app-arg: %s\nevent-lock:true\n\n" % [app_name, arguments.join(" ")]
+      end
+
+    end
+
+    register(:read, Read)
+  end
+end

data/lib/fsr/app/transfer.rb

@@ -6,8 +6,8 @@ module FSR
 
       def initialize(destination_number, dialplan = nil, context = nil)
         @destination_number = destination_number
-        @dialplan = dialplan || "XML"
-        @context = context || "default"
+        @dialplan = dialplan
+        @context = context
       end
 
       def arguments

data/lib/fsr/app/uuid_dump.rb

@@ -0,0 +1,22 @@
+require "fsr/app"
+module FSR
+  #http://wiki.freeswitch.org/wiki/Mod_commands#uuid_dump
+  module App
+    class UuidDump < Application
+      def initialize(uuid)
+        @uuid = uuid # Unique channel ID
+      end
+
+      def arguments
+        [@uuid]
+      end
+
+      def sendmsg
+        "call-command: execute\nexecute-app-name: %s\nexecute-app-arg: %s\nevent-lock:true\n\n" % [app_name, arguments.join(" ")]
+      end
+
+    end
+
+    register(:uuid_dump, UuidDump)
+  end
+end

data/lib/fsr/app/uuid_getvar.rb

@@ -0,0 +1,23 @@
+require "fsr/app"
+module FSR
+  #http://wiki.freeswitch.org/wiki/Mod_commands#uuid_getvar
+  module App
+    class UuidGetVar < Application
+      def initialize(uuid, var)
+        @uuid = uuid # Unique channel ID
+        @var = var # Channel variable you wish to 'get'
+      end
+
+      def arguments
+        [@uuid, @var]
+      end
+
+      def sendmsg
+        "call-command: execute\nexecute-app-name: %s\nexecute-app-arg: %s\nevent-lock:true\n\n" % [app_name, arguments.join(" ")]
+      end
+
+    end
+
+    register(:uuid_getvar, UuidGetVar)
+  end
+end

data/lib/fsr/app/uuid_setvar.rb

@@ -0,0 +1,24 @@
+require "fsr/app"
+module FSR
+  #http://wiki.freeswitch.org/wiki/Mod_commands#uuid_setvar
+  module App
+    class UuidSetVar < Application
+      def initialize(uuid, var, assignment)
+        @uuid = uuid # Unique channel ID
+        @var = var # Channel variable you wish to 'set'
+        @assignment
+      end
+
+      def arguments
+        [@uuid, @var, @assignment]
+      end
+
+      def sendmsg
+        "call-command: execute\nexecute-app-name: %s\nexecute-app-arg: %s\nevent-lock:true\n\n" % [app_name, arguments.join(" ")]
+      end
+
+    end
+
+    register(:uuid_setvar, UuidSetVar)
+  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

@@ -7,6 +7,7 @@ module FSR
   load_all_applications
   module Listener
     class Outbound < EventMachine::Protocols::HeaderAndContentProtocol
+      attr_reader :session
 
       # Include FSR::App to get all the applications defined as methods
       include FSR::App
@@ -15,33 +16,23 @@ module FSR
       SENDMSG_METHOD_DEFINITION = "def %s(*args, &block); sendmsg super; end"
       APPLICATIONS.each { |app, obj| module_eval(SENDMSG_METHOD_DEFINITION % app.to_s) }
 
-      def post_init
-        @session = nil # holds the session object
-        send_data("connect\n\n")
-        FSR::Log.debug "Accepting connections."
+      # session_initiated is called when a @session is first created.
+      # Overwrite this in your worker class with the call/channel
+      # handling logic you desire
+      def session_initiated
+        FSR::Log.warn "#{self.class.name}#session_initiated not overwritten"
+        FSR::Log.debug session_data.inspect
       end
 
-      def receive_request(header, content)
-        hash_header = headers_2_hash(header)
-        hash_content = headers_2_hash(content)
-        session = HeaderAndContentResponse.new({:headers => hash_header, :content => hash_content})
-        if @session.nil?
-          @session = self
-          session_initiated(session) 
-        else
-          receive_reply(session)
-        end
-      end
-
-      # Received data dispatches the data received by the EM socket,
-      # Either as a Session, a continuation of a Session, or as a Session's last CommandReply
-      
-      def session_initiated(session)
-        session
-      end
-
-      def receive_reply(session)
-        session
+      # receive_reply is called when a response is received.
+      # Overwrite this in your worker class with the call/channel
+      # handling logic you desire, taking @step into account for
+      # state management between commands
+      # @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
 
       # sendmsg sends data to the EM app socket via #send_data, or
@@ -56,7 +47,56 @@ module FSR
         self.respond_to?(:send_data) ? send_data(message) : message
       end
 
+      # Update_session
+
+      def update_session
+        send_data("api uuid_dump #{@session.headers[:unique_id]}\n\n")
+      end
+
+      protected
+      def post_init
+        @session = nil # holds the session object
+        send_data("connect\n\n")
+        FSR::Log.debug "Accepting connections."
+      end
+
+      # receive_request is called each time data is received by the event machine
+      # it will manipulate the received data into either a new session or a reply,
+      # to be picked up by #session_initiated or #receive_reply.
+      # If your listener is listening for events, this will also renew your @session
+      # each time you receive a CHANNEL_DATA event.
+      # @param header The header of the request, as passed by HeaderAndContentProtocol
+      # @param content The content of the request, as passed by HeaderAndContentProtocol
+      #
+      # @returns HeaderAndContentResponse
+      def receive_request(header, content)
+        hash_header = headers_2_hash(header)
+        hash_content = headers_2_hash(content)
+        session_header_and_content = HeaderAndContentResponse.new({:headers => hash_header, :content => hash_content})
+        # If we're a new session, call session initiate
+        if @session.nil?
+          @session = session_header_and_content
+          @step = 0
+          session_initiated 
+        elsif session_header_and_content.content[:event_name] # If content includes an event_name, it must be a response from an api command
+          if session_header_and_content.content[:event_name].to_s.match(/CHANNEL_DATA/i) # Anytime we see CHANNEL_DATA event, we want to update our @session
+            session_header_and_content = HeaderAndContentResponse.new({:headers => hash_header.merge(hash_content.strip_value_newlines), :content => {}})
+            @session = session_header_and_content
+            @step += 1
+            receive_reply(hash_header)
+          end
+        else
+          @step += 1
+          receive_reply(session_header_and_content)
+        end
+      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] }.flatten)]
   end
 end

data/lib/fsr/listener/outbound.rb.orig

@@ -0,0 +1,131 @@
+require "yaml"
+require "fsr/listener"
+module FSR
+  load_all_applications
+  module Listener
+    module Outbound
+      include FSR::Listener
+
+      # Include FSR::App to get all the applications defined as methods
+      include FSR::App
+
+      # Redefine the FSR::App methods to wrap sendmsg around them
+      SENDMSG_METHOD_DEFINITION = "def %s(*args, &block); sendmsg super; end"
+      APPLICATIONS.each { |app, obj| module_eval(SENDMSG_METHOD_DEFINITION % app.to_s) }
+
+      def post_init
+        @session = nil # holds the session object
+        send_data("connect\n\n")
+        FSR::Log.debug "Accepting connections."
+      end
+
+      # Received data dispatches the data received by the EM socket,
+      # Either as a Session, a continuation of a Session, or as a Session's last CommandReply
+      def receive_data(data)
+        FSR::Log.debug("received #{data}")
+        if @session.nil? # if @session is nil, create a new Session object
+          @session = Session.new(data)
+          session_initiated(@session) if @session.initiated?
+        else
+          # If it's not nil, we add the data to this session, Session knows whether
+          # or not to create a CommandReply, complete a CommandReply, or simply add to
+          # its own @data array and @headers/@body structures
+          if @session.initiated?
+            @session << data
+            reply_received(@session.replies.last) if @session.replies.last.complete?
+          else
+            @session << data
+            session_initiated(@session) if @session.initiated?
+          end
+        end
+        @session
+      end
+
+      def session_initiated(session)
+        session
+      end
+
+      def reply_received(command_reply)
+        command_reply
+      end
+
+      alias :receive_response :reply_received
+      # sendmsg sends data to the EM app socket via #send_data, or
+      # returns the string it would send if #send_data is not defined.
+      # It expects an object which responds to either #sendmsg or #to_s, 
+      # which should return a EM Outbound Event Socket formatted instruction
+      def sendmsg(message)
+        text = message.respond_to?(:sendmsg) ? message.sendmsg : message.to_s
+        FSR::Log.debug "sending #{text}"
+        message = "sendmsg\n%s\n" % text
+        self.respond_to?(:send_data) ? send_data(message) : message
+      end
+
+
+      class SocketResponse
+        attr_accessor :headers, :body, :data
+        def initialize(data = "")
+          @data = [data]
+          @headers = {}
+          if data.match(/\n$/)
+            headers, @body = data.split("\n\n")
+            headers.each_line do |line|
+              key, value = line.split(":")
+              @headers[key] = value.to_s.strip
+            end
+          end
+          @body ||= ""
+          FSR::Log.debug("New #{self.class.name} created: #{self}")
+        end
+
+        def <<(data)
+          if data.match(/\n$/)
+            @data.last.match(/\n$/) ? @data << data : @data.last << data
+            extra_headers, more_body = @data.last.split("\n\n")
+            extra_headers.each_line do |line|
+              key, value = line.split(":")
+              @headers[key] = value.to_s.strip
+            end
+            @body << more_body unless more_body.nil?
+          else
+            @data.last.match(/\n$/) ? @data << data : @data.last << data
+          end
+          self
+        end
+      end
+
+      class Session < SocketResponse
+        attr_accessor :replies
+        def initialize(data = "")
+          super
+          @replies = []
+        end
+
+        def <<(data)
+          if initiated?
+            if @replies.empty? or @replies.last.complete?
+              @replies << CommandReply.new(data)
+            else
+              @replies.last << data
+            end
+          else
+            super
+          end
+        end
+
+        def initiated?
+          @headers.keys.include?("Control")
+        end
+        
+      end
+
+      class CommandReply < SocketResponse
+        # Set this to true for now, fill it in when we know what completed a reply
+        def complete?
+          true
+        end
+      end
+    end
+
+  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/hangup.rb

@@ -0,0 +1,16 @@
+require 'spec/helper'
+require "fsr/app"
+FSR::App.load_application("hangup")
+
+describe "Testing FSR::App::Hangup" do
+  it "Hangs up the channel" do
+    hangup = FSR::App::Hangup.new
+    hangup.sendmsg.should == "call-command: execute\nexecute-app-name: hangup\nexecute-app-arg: \n\n"
+  end
+
+  it "Hangs up the channel using a hangup cause" do
+    hangup = FSR::App::Hangup.new("USER_BUSY")
+    hangup.sendmsg.should == "call-command: execute\nexecute-app-name: hangup\nexecute-app-arg: USER_BUSY\n\n"
+  end
+
+end

data/spec/fsr/app/log.rb

@@ -0,0 +1,11 @@
+require 'spec/helper'
+require "fsr/app"
+FSR::App.load_application("log")
+
+describe "Testing FSR::App::Log" do
+  it "Logs to the console" do
+    log = FSR::App::Log.new(1, "This is a test! :-)")
+    log.sendmsg.should == "call-command: execute\nexecute-app-name: log\nexecute-app-arg: 1 This is a test! :-)\nevent-lock:true\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/app/playback.rb

@@ -0,0 +1,11 @@
+require 'spec/helper'
+require "fsr/app"
+FSR::App.load_application("playback")
+
+describe "Testing FSR::App::Playback" do
+  it "Plays a file or stream" do
+    playback = FSR::App::Playback.new("shout://scfire-ntc-aa01.stream.aol.com/stream/1035")
+    playback.sendmsg.should == "call-command: execute\nexecute-app-name: playback\nexecute-app-arg: shout://scfire-ntc-aa01.stream.aol.com/stream/1035\nevent-lock:true\n\n"
+  end
+
+end

data/spec/fsr/app/set.rb

@@ -0,0 +1,12 @@
+require 'spec/helper'
+require "fsr/app"
+FSR::App.load_application("set")
+
+describe "Testing FSR::App::Set" do
+  # Utilize the [] shortcut to start a conference
+  it "Sets a single variable" do
+    set = FSR::App::Set.new("hangup_after_bridge", true)
+    set.sendmsg.should == "call-command: execute\nexecute-app-name: set\nexecute-app-arg: hangup_after_bridge=true\nevent-lock:true\n\n"
+  end
+
+end

data/spec/fsr/app/transfer.rb

@@ -0,0 +1,11 @@
+require 'spec/helper'
+require "fsr/app"
+FSR::App.load_application("transfer")
+
+describe "Testing FSR::App::Transfer" do
+  it "Transfers the call" do
+    transfer = FSR::App::Transfer.new("500", "XML", "default")
+    transfer.sendmsg.should == "call-command: execute\nexecute-app-name: transfer\nexecute-app-arg: 500 XML default\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/listener/inbound.rb

@@ -16,4 +16,11 @@ describe "Testing FSR::Listener::Inbound" do
     FSR::Listener::Inbound.method_defined?(:post_init).should == true
   end
 
+  it "adds and deletes hooks" do
+    FSL::Inbound.add_event_hook(:CHANNEL_CREATE) {|event| puts event.inspect }
+    FSL::Inbound::HOOKS.size.should == 1
+    FSL::Inbound.del_event_hook(:CHANNEL_CREATE)
+    FSL::Inbound::HOOKS.size.should == 0
+  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 = [: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]
     # 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: bougyman-freeswitcher
 version: !ruby/object:Gem::Version 
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jayson Vaughn
@@ -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(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"
+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"
 email: FreeSWITCHeR@rubyists.com
 executables: []
 
@@ -38,12 +38,18 @@ files:
 - NEWS
 - README
 - Rakefile
-- bin
-- bin/cmd_demo.rb
-- bin/ies_demo.rb
-- bin/ies_demo_with_hook.rb
-- bin/oes_demo.rb
-- bin/oes_demo2.rb
+- examples
+- examples/bin
+- 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/oes_demo.rb
+- examples/play_and_get_test.rb
 - lib
 - lib/fsr
 - lib/fsr/app
@@ -55,12 +61,18 @@ files:
 - lib/fsr/app/fs_sleep.rb
 - lib/fsr/app/hangup.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/app.rb
 - lib/fsr/cmd
+- lib/fsr/cmd/calls.rb
 - lib/fsr/cmd/fsctl.rb
 - lib/fsr/cmd/originate.rb
 - lib/fsr/cmd/sofia
@@ -88,13 +100,12 @@ 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
-- tasks/ride.rake
-- tasks/rspec.rake
 - tasks/spec.rake
-- tmp
 has_rdoc: false
 homepage: http://code.rubyists.com/projects/fs
 post_install_message: |
@@ -144,11 +155,11 @@ post_install_message: |
   
       class OesDemo < FSR::Listener::Outbound
   
-        def session_initiated(session)
-          number = session.headers[:caller_caller_id_number] # Grab the inbound caller id
+        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
+          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
@@ -159,12 +170,53 @@ post_install_message: |
   
   
   
+  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 'fsr/listener/inbound'
+      require 'pp'
   
       class IesDemo < FSR::Listener::Inbound
   
@@ -214,8 +266,15 @@ test_files:
 - spec/fsr/app/bridge.rb
 - spec/fsr/app/conference.rb
 - spec/fsr/app/fifo.rb
+- spec/fsr/app/hangup.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