freeswitcher 0.0.12 → 0.0.13

data/README

@@ -44,8 +44,8 @@ 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
@@ -71,16 +71,14 @@ Example of creating an Outbound Eventsocket listener that can read DTMF input an
 
     class DtmfDemo < FSR::Listener::Outbound
 
-      def session_initiated(session, step = 0)
-        @step ||= step
-        exten = session.headers[:channel_caller_id_number]
+      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[:channel_caller_id_number]
-        @step += 1
+        exten = @session.headers[:caller_caller_id_number]
         case @step
         when 1
           FSR::Log.info "*** Reading dtmf for #{exten}"
@@ -89,7 +87,7 @@ Example of creating an Outbound Eventsocket listener that can read DTMF input an
           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 "** Success, grabbed #{@session.headers[:variable_test].strip} from #{exten}"
           FSR::Log.info "*** Hanging up call"
           hangup # Hangup the call
         end

data/examples/dtmf_test.rb

@@ -8,16 +8,14 @@ FSR.load_all_applications
 FSR.load_all_commands
 class DtmfDemo < FSR::Listener::Outbound
 
-  def session_initiated(session, step = 0)
-    @step ||= step
-    exten = session.headers[:channel_caller_id_number]
+  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[:channel_caller_id_number]
-    @step += 1
+    exten = @session.headers[:caller_caller_id_number]
     case @step
     when 1
       FSR::Log.info "*** Reading dtmf for #{exten}"
@@ -26,7 +24,7 @@ class DtmfDemo < FSR::Listener::Outbound
       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 "** Success, grabbed #{@session.headers[:variable_test].strip} from #{exten}"
       FSR::Log.info "*** Hanging up call"
       hangup # Hangup the call
     end

data/examples/oes_demo.rb

@@ -6,8 +6,8 @@ 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
+  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!")

data/lib/fsr.rb

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

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,40 +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 = session
-          session_initiated(session) 
-        else
-          if session.headers[:event_name].nil?
-            receive_reply(session)
-          else
-            if session.headers[:event_name].to_s.match(/CHANNEL_DATA/i)
-              @session = session
-              receive_reply(HeaderAndConentResponse.new({:headers => {:session => "update"}, :content => {}}))
-            end
-          end
-        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
@@ -69,7 +53,50 @@ module FSR
         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] }]
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: freeswitcher
 version: !ruby/object:Gem::Version 
-  version: 0.0.12
+  version: 0.0.13
 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 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(session, step = 0) @step ||= step exten = session.headers[:channel_caller_id_number] 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! 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"
+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: []
 
@@ -147,8 +147,8 @@ 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
@@ -174,16 +174,14 @@ post_install_message: |
   
       class DtmfDemo < FSR::Listener::Outbound
   
-        def session_initiated(session, step = 0)
-          @step ||= step
-          exten = session.headers[:channel_caller_id_number]
+        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[:channel_caller_id_number]
-          @step += 1
+          exten = @session.headers[:caller_caller_id_number]
           case @step
           when 1
             FSR::Log.info "*** Reading dtmf for #{exten}"
@@ -192,7 +190,7 @@ post_install_message: |
             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 "** Success, grabbed #{@session.headers[:variable_test].strip} from #{exten}"
             FSR::Log.info "*** Hanging up call"
             hangup # Hangup the call
           end