ruby-agi 1.1.2 → 2.0.0

data/lib/ruby-agi/rs/stream_file.rb

@@ -0,0 +1,138 @@
+#
+#  File: stream_file.rb
+#
+#  ruby-agi: Ruby Language API for Asterisk
+#
+#  Copyright (C) <2006>  Mohammad Khan <info@beeplove.com>
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; either version 2 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ruby-agi/rs/return_status'
+
+#
+# stream file: Sends audio file on channel
+# Send the given file, allowing playback to be interrupted by the given digits, if any. 
+# Use double quotes for the digits if you wish none to be permitted. 
+# If sample offset is provided then the audio will seek to sample offset before play starts. 
+# Remember, the file extension must not be included in the filename. 
+# 
+# Command Reference: STREAM FILE <filename> <escape digits> [sample offset] 
+#
+# - filename	: location of the file to be played
+# - escape_digit: digit to be pressed to escape from playback
+#
+# failure: 200 result=-1 endpos=<sample offset> 
+# failure on open: 200 result=0 endpos=0 
+# success: 200 result=0 endpos=<offset> 
+# digit pressed: 200 result=<digit> endpos=<offset> 
+# <offset> is the stream position streaming stopped. If it equals <sample offset> there was probably an error. 
+# <digit> is the ascii code for the digit pressed. 
+#
+
+class ReturnStatus
+end
+
+class StreamFile < ReturnStatus
+
+	def initialize(command, response)
+		super(command, response)
+	end
+
+	def failure?
+		if @is_failure.nil?
+			if result == '-1'
+				@is_failure = true
+			elsif result == '0'
+				if offset == '0'
+					@is_failure			= true
+					@is_failure_on_open	= true
+					@is_success			= false
+				else
+					@is_success			= true
+				end
+			else
+				@is_failure = false
+			end 
+		end
+
+		return @is_failure
+	end
+
+	def success?
+		if @is_success.nil?
+			if ((not failure?) and (offset.to_i > 0)) 
+				@is_success = true
+			else
+				@is_success = false
+			end
+		end
+		
+		return @is_success
+	end
+
+	def interrupted?
+		if @is_interrupted.nil?
+			@is_interrupted = false
+			if ((success?) and (result.to_i > 0))
+				@is_interrupted = true
+			end
+		end
+
+		return @is_interrupted
+	end
+
+	def offset
+		if @offset.nil?
+			rgx = Regexp.new(/^endpos/)
+			response.split(' ').each do | pair |
+				if rgx.match(pair)
+					@offset = pair.split('=').last
+				end
+			end
+			@offset = '' if @offset.nil?
+		end
+
+		return @offset
+	end
+
+	def digit
+		if @digit.nil?
+			if interrupted?
+				@digit = result.to_i.chr
+			end
+			@digit = '' if @digit.nil?
+		end
+		
+		return @digit
+	end
+
+	def error
+		if random_error?
+			return result
+		else
+			return ''
+		end
+	end
+
+	def error?
+		return command_error?
+	end
+
+	def response
+		return message
+	end
+
+end

data/lib/ruby-agi/rs/tdd_mode.rb

@@ -0,0 +1,95 @@
+#
+#  File: tdd_mode.rb
+#
+#  ruby-agi: Ruby Language API for Asterisk
+#
+#  Copyright (C) <2006>  Mohammad Khan <info@beeplove.com>
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; either version 2 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ruby-agi/rs/return_status'
+
+#
+# tdd mode: Activates TDD mode on channels supporting it, to enable communication with TDDs.
+# Enable/Disable TDD transmission/reception on a channel. 
+# This function is currently (01July2005) only supported on Zap channels. 
+# As of 02July2005, this function never returns 0 (Not Capable).
+# If it fails for any reason, -1 (Failure) will be returned, otherwise 1 (Success) will be returned.
+# The capability for returning 0 if the channel is not capable of TDD MODE is a future plan. 
+# 
+# Command Reference: TDD MODE <on|off|mate> 
+#
+# failure: 200 result=-1 
+# not capable: 200 result=0 
+# success: 200 result=1
+#
+
+class ReturnStatus
+end
+
+class TDDMode < ReturnStatus
+
+	def initialize(command, response)
+		super(command, response)
+	end
+
+	def success?
+		if @is_success.nil?
+			if result == '1'
+				@is_success = true
+				@is_capable = true
+				@is_failure = false
+			end 
+		end
+
+		return @is_success
+	end
+
+	def failure?
+		if @is_failure.nil?
+			if result == '-1'
+				@is_failure = true
+				@is_capable = true
+				@is_success = false
+			end 
+		end
+
+		return @is_failure
+	end
+
+	def capable?
+		if @is_capable.nil?
+			if result == '0'
+				@is_capable = false
+				@is_success = false
+				@is_failure = true
+			else
+				@is_capable = true
+			end
+		end
+		
+		return @is_capable
+	end
+
+	def error?
+		return command_error?
+	end
+
+	def response
+		return message
+	end
+
+end

data/lib/ruby-agi/rs/verbose.rb

@@ -0,0 +1,73 @@
+#
+#  File: verbose.rb
+#
+#  ruby-agi: Ruby Language API for Asterisk
+#
+#  Copyright (C) <2006>  Mohammad Khan <info@beeplove.com>
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; either version 2 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ruby-agi/rs/return_status'
+
+#
+# Sends <message> to the console via verbose message system. 
+# The Asterisk verbosity system works as follows.
+# The Asterisk user gets to set the desired verbosity at startup time
+# or later using the console 'set verbose' command.
+# Messages are displayed on the console if their verbose level
+# is less than or equal to desired verbosity set by the user.
+# More important messages should have a low verbose level;
+# less important messages should have a high verbose level. 
+#
+# Command Reference: VERBOSE <message> [level] 
+#
+# 200 result=1 
+# 
+
+class ReturnStatus
+end
+
+class Verbose < ReturnStatus
+
+	def initialize(command, response)
+		super(command, response)
+	end
+
+	def success?
+		if @is_success.nil?
+			if result == '1'
+				@is_success = true
+			else
+				@is_success = false
+			end 
+		end
+
+		return @is_success
+	end
+
+	def failure?
+		return (not success?)
+	end
+
+	def error?
+		return command_error?
+	end
+
+	def response
+		return message
+	end
+
+end

data/lib/ruby-agi/rs/wait_for_digit.rb

@@ -0,0 +1,90 @@
+#
+#  File: wait_for_digit.rb
+#
+#  ruby-agi: Ruby Language API for Asterisk
+#
+#  Copyright (C) <2006>  Mohammad Khan <info@beeplove.com>
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; either version 2 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ruby-agi/rs/return_status'
+
+#
+# wait for digit: Waits for a digit to be pressed 
+# Waits up to <timeout> milliseconds for channel to receive a DTMF digit. 
+# 
+# Command Reference: WAIT FOR DIGIT <timeout> 
+#
+# failure: 200 result=-1 
+# timeout: 200 result=0 
+# success: 200 result=<digit> 
+# <digit> is the ascii code for the digit received. 
+#
+
+class ReturnStatus
+end
+
+class WaitForDigit < ReturnStatus
+
+	def initialize(command, response)
+		super(command, response)
+	end
+
+	def failure?
+		if @is_failure.nil?
+			if result == '-1'
+				@is_failure = true
+			else
+				@is_failure = false
+			end 
+		end
+
+		return @is_failure
+	end
+
+	def timeout?
+		if @is_timeout.nil?
+			if result == '0'
+				@is_timeout = true
+			else
+				@is_timeout = false
+			end 
+		end
+
+		return @is_timeout
+	end
+
+	def digit
+		if success?
+			return result.to_i.chr
+		else
+			return nil
+		end
+	end
+
+	def success?
+		return ((not timeout?) and (not failure?))
+	end
+
+	def error?
+		return command_error?
+	end
+
+	def response
+		return message
+	end
+
+end

data/lib/ruby-agi/rs/wait_for_digits.rb

@@ -0,0 +1,88 @@
+#
+#  File: wait_for_digits.rb
+#
+#  ruby-agi: Ruby Language API for Asterisk
+#
+#  Copyright (C) <2006>  Mohammad Khan <info@beeplove.com>
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; either version 2 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ruby-agi/rs/return_status'
+
+#
+# class to handle return status from Command#wait_for_digits
+# pressing '#' will always terminate the input process
+#
+# Command Reference: GET DATA <file to be streamed> [timeout] [max digits]
+#
+# failure: 200 result=-1
+# timeout: 200 result=<digits> (timeout)
+# success: 200 result=<digits>
+# <digits> is the digits pressed. 
+#
+
+class ReturnStatus
+end
+
+class WaitForDigits < ReturnStatus
+
+	def initialize(command, response)
+		super(command, response)
+	end
+
+	def success?
+		return ((not failure?) and (not timeout?)) 
+	end
+
+	def failure?
+		if @is_failure.nil?
+			if result == '-1'
+				@is_failure = true
+			else
+				@is_failure = false
+			end 
+		end
+
+		return @is_failure
+	end
+
+	public
+	def timeout?
+		if @is_timeout.nil?
+			rgx = Regexp.new(/\(timeout\)$/)
+			if rgx.match(response)
+				@is_timeout = true
+			else
+				@is_timeout = false
+			end
+		end
+
+		return @is_timeout
+	end
+
+	def digits
+		return result
+	end
+
+	def error?
+		return ((not timeout?) and command_error?)
+	end
+
+	def response
+		return message
+	end
+
+end