ruby-agi 1.1.2 → 2.0.0

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

@@ -0,0 +1,85 @@
+#
+#  File: say_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'
+
+# Say a given digit string, returning early if any of the given DTMF digits are received on the channel.
+#
+# Command Reference:  SAY DIGITS <number> <escape digits>
+#
+# failure: 200 result=-1
+# success: 200 result=0
+# digit pressed: 200 result=<digit>
+# <digit> is the ascii code for the digit pressed. 
+#
+
+
+class ReturnStatus
+end
+
+class SayDigits < ReturnStatus
+
+	def initialize(command, response)
+		super(command, response)
+	end
+
+	def success?
+		if @is_success.nil?
+			if result == '0'
+				@is_success = true
+			else
+				@is_success = false
+			end 
+		end
+
+		return @is_success
+	end
+
+	def failure?
+		if @is_failure.nil?
+			if result == '-1'
+				@is_failure = true
+			else
+				@is_failure = false
+			end 
+		end
+
+		return @is_failure
+	end
+
+	def digit
+		if @digit.nil?
+			@digit = result.to_i.chr
+		end
+
+		return @digit
+	end
+
+	def error?
+		return command_error?
+	end
+
+	def response
+		return message
+	end
+
+end

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

@@ -0,0 +1,88 @@
+#
+#  File: say_number.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'
+
+# Say a given number, returning early if any of the given DTMF digits are received on the channel.
+#
+# Command Reference:  SAY NUMBER <number> <escape digits>
+#
+# - number			: number to announce
+# - escape_digit	: if pressed, return from program
+#
+# failure: 200 result=-1
+# success: 200 result=0
+# digit pressed: 200 result=<digit>
+#<digit> is the ascii code for the digit pressed. 
+#
+
+
+class ReturnStatus
+end
+
+class SayNumber < ReturnStatus
+
+	def initialize(command, response)
+		super(command, response)
+	end
+
+	def success?
+		if @is_success.nil?
+			if result == '0'
+				@is_success = true
+			else
+				@is_success = false
+			end 
+		end
+
+		return @is_success
+	end
+
+	def failure?
+		if @is_failure.nil?
+			if result == '-1'
+				@is_failure = true
+			else
+				@is_failure = false
+			end 
+		end
+
+		return @is_failure
+	end
+
+	def digit
+		if @digit.nil?
+			@digit = result.to_i.chr
+		end
+
+		return @digit
+	end
+
+	def error?
+		return command_error?
+	end
+
+	def response
+		return message
+	end
+
+end

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

@@ -0,0 +1,88 @@
+#
+#  File: say_phonetic.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'
+
+#
+# Say a given character string with phonetics, returning early if any of the given DTMF digits are received on the channel.
+#
+# Command Reference: SAY PHONETIC <string> <escape digits>
+#
+# - string			: character string to announce 
+# - escape_digit	: digit to be pressed to escape from program 
+#
+# failure: 200 result=-1
+# success: 200 result=0
+# digit pressed: 200 result=<digit>
+# <digit> is the ascii code for the digit pressed.
+#
+
+class ReturnStatus
+end
+
+class SayPhonetic < ReturnStatus
+
+	def initialize(command, response)
+		super(command, response)
+	end
+
+	def success?
+		if @is_success.nil?
+			if result == '0'
+				@is_success = true
+			else
+				@is_success = false
+			end 
+		end
+
+		return @is_success
+	end
+
+	def failure?
+		if @is_failure.nil?
+			if result == '-1'
+				@is_failure = true
+			else
+				@is_failure = false
+			end 
+		end
+
+		return @is_failure
+	end
+
+	def digit
+		if @digit.nil?
+			@digit = result.to_i.chr
+		end
+
+		return @digit
+	end
+
+	def error?
+		return command_error?
+	end
+
+	def response
+		return message
+	end
+
+end

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

@@ -0,0 +1,90 @@
+#
+#  File: say_time.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'
+
+#
+# Say a given time, returning early if any of the given DTMF digits are received on the channel.
+#
+# Command Reference: SAY TIME <time> <escape digits>
+#
+# - time			: number of seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC).
+# - escape_digits	: digit to be pressed to escape from the program
+#
+# failure: 200 result=-1
+# success: 200 result=0
+# digit pressed: 200 result=<digit>
+# <digit> is the ascii code for the digit pressed.
+#
+#
+
+
+class ReturnStatus
+end
+
+class SayTime < ReturnStatus
+
+	def initialize(command, response)
+		super(command, response)
+	end
+
+	def success?
+		if @is_success.nil?
+			if result == '0'
+				@is_success = true
+			else
+				@is_success = false
+			end 
+		end
+
+		return @is_success
+	end
+
+	def failure?
+		if @is_failure.nil?
+			if result == '-1'
+				@is_failure = true
+			else
+				@is_failure = false
+			end 
+		end
+
+		return @is_failure
+	end
+
+	def digit
+		if @digit.nil?
+			@digit = result.to_i.chr
+		end
+
+		return @digit
+	end
+
+	def error?
+		return command_error?
+	end
+
+	def response
+		return message
+	end
+
+end

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

@@ -0,0 +1,83 @@
+#
+#  File: send_image.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 the given image on a channel.
+# Most channels do not support the transmission of images.
+# Image names should not include extensions.
+#
+# <b>Parameters</b>
+# - image : location of image
+#
+# <b>Returns</b>
+# - ReturnStatus (object)
+#
+# failure: 200 result=-1
+# success: 200 result=0 
+#
+# Command Reference: SEND IMAGE <image>
+#
+
+class ReturnStatus
+end
+
+class SendImage < ReturnStatus
+
+	def initialize(command, response)
+		super(command, response)
+	end
+
+	def success?
+		if @is_success.nil?
+			if result == '0'
+				@is_success = true
+			else
+				@is_success = false
+			end 
+		end
+
+		return @is_success
+	end
+
+	def failure?
+		if @is_failure.nil?
+			if result == '-1'
+				@is_failure = true
+			else
+				@is_failure = false
+			end 
+		end
+
+		return @is_failure
+	end
+
+	def error?
+		return command_error?
+	end
+
+	def response
+		return message
+	end
+
+end

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

@@ -0,0 +1,83 @@
+#
+#  File: send_text.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 the given text on a channel.
+# Most channels do not support the transmission of text.
+# Text consisting of greater than one word should be placed in quotes since the command only accepts a single argument.
+#
+# <b>Parameters</b>
+# - text : text to be send 
+#
+# <b>Returns</b>
+# - ReturnStatus (object)
+#
+# failure: 200 result=-1
+# success: 200 result=0 
+#
+# Command Reference: SEND TEXT "<text to send>"
+#
+
+class ReturnStatus
+end
+
+class SendText < ReturnStatus
+
+	def initialize(command, response)
+		super(command, response)
+	end
+
+	def success?
+		if @is_success.nil?
+			if result == '0'
+				@is_success = true
+			else
+				@is_success = false
+			end 
+		end
+
+		return @is_success
+	end
+
+	def failure?
+		if @is_failure.nil?
+			if result == '-1'
+				@is_failure = true
+			else
+				@is_failure = false
+			end 
+		end
+
+		return @is_failure
+	end
+
+	def error?
+		return command_error?
+	end
+
+	def response
+		return message
+	end
+
+end