redial-ruby-agi 2.0.1

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

@@ -0,0 +1,68 @@
+#
+#  File: noop.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 of Command#noop
+#
+# Command Reference: Usage: NOOP 
+#
+# <b>Returns</b>
+# - ReturnStatus object
+# success: 200 result=0 
+#
+
+class ReturnStatus
+end
+
+class Noop < 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?
+		return (not success?)
+	end
+
+	def error?
+		return command_error?
+	end
+
+	def response
+		return message
+	end
+
+end

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

@@ -0,0 +1,112 @@
+#
+#  File: receive_char.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'
+require 'ruby-agi/error.rb'
+
+#
+# class to handle return status of Command#receive_char
+# Receives a character of text on a channel, and discards any further characters after the first one waiting.
+# Most channels do not support the reception of text. See Asterisk Text for details.
+#
+# Command Reference: RECEIVE CHAR <timeout>
+#
+# failure or hangup: 200 result=-1 (hangup)
+# timeout: 200 result=<char> (timeout)
+# success: 200 result=<char>
+# <char> is the character received, or 0 if the channel does not support text reception.
+#
+
+class ReturnStatus
+end
+
+class ReceiveChar < ReturnStatus
+
+	def initialize(command, response)
+		super(command, response)
+	end
+
+	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 hangup?
+		if @is_hangup.nil?
+			rgx = Regexp.new(/\(hangup\)$/)
+			if rgx.match(response)
+				@is_hangup = true
+
+				if not failure?
+					raise(UnknownError, "Please report to info@beeplove.com with as much information as you can provide")
+				end
+			else
+				@is_hangup = false
+			end
+		end
+
+		return @is_hangup
+	end
+
+	def success?
+		return ((not timeout?) and (not failure?))
+	end
+
+	def failure?
+		if @is_failure.nil?
+			if result == '-1'
+				@is_failure = true
+			else
+				@is_failure = false
+			end
+		end
+
+		return @is_failure
+	end
+
+	def char
+		if result == '0'
+			return nil
+		elsif not failure?
+			return result.to_i.chr
+		else
+			return nil
+		end
+	end
+
+	def error?
+		return command_error?
+	end
+
+	def response
+		return message
+	end
+
+end

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

@@ -0,0 +1,73 @@
+#
+#  File: receive_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'
+
+# class to handle return status of Command#receive_text 
+# Receives a string text on a channel.
+# Most channels do not support the reception of text.
+#
+# Command Reference: RECEIVE TEXT <timeout>
+#
+# failure, hangup, or timeout: 200 result=-1
+# success: 200 result=<text>
+# <text> is the text received on the channel.
+#
+
+class ReturnStatus
+end
+
+class ReceiveText < ReturnStatus
+
+	def initialize(command, response)
+		super(command, response)
+	end
+
+	def success?
+		return (not failure?)
+	end
+
+	def failure?
+		if @is_failure.nil?
+			if result == '-1'
+				@is_failure = true
+			else
+				@is_failure = false
+			end 
+		end
+
+		return @is_failure
+	end
+
+	def text
+		return result
+	end
+
+	def error?
+		return command_error?
+	end
+
+	def response
+		return message
+	end
+
+end

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

@@ -0,0 +1,184 @@
+#
+#  File: record_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'
+
+#
+# class to handle return status of Command#record_file
+# Record to a file until <escape digits> are received as dtmf.
+#
+# failure to write: 200 result=-1 (writefile)
+# failure on waitfor: 200 result=-1 (waitfor) endpos=<offset>
+# hangup: 200 result=0 (hangup) endpos=<offset>
+# interrrupted: 200 result=<digit> (dtmf) endpos=<offset>
+# timeout: 200 result=0 (timeout) endpos=<offset>
+# random error: 200 result=<error> (randomerror) endpos=<offset>
+# <offset> is the end offset in the file being recorded.
+# <digit> is the ascii code for the digit pressed.
+# <error> ?????
+#
+# Command Reference: RECORD FILE <filename> <format> <escape digits> <timeout> [offset samples] [BEEP] [s=<silence>]
+#
+
+class ReturnStatus
+end
+
+class RecordFile < ReturnStatus
+
+	def initialize(command, response)
+		super(command, response)
+	end
+
+	def failure?
+		if @is_failure.nil?
+			if result == '-1'
+				@is_failure = true
+				rgx_write	= Regexp.new(/\(writefile\)/)
+				rgx_waitfor	= Regexp.new(/\(waitfor\)/)
+				@is_failure_to_write	= rgx_write.match(response).nil?	? false : true
+				@is_failure_on_waitfor	= rgx_waitfor.match(response).nil?	? false : true
+			else
+				@is_failure = false
+			end 
+		end
+
+		return @is_failure
+	end
+
+	def failure_to_write?
+		if failure?
+			return @is_failure_to_write
+		else
+			return false
+		end
+	end
+
+	def failure_on_waitfor?
+		if failure?
+			return @is_failure_on_waitfor
+		else
+			return false
+		end
+	end
+
+	def hangup?
+		if @is_hangup.nil?
+			@is_hangup = false
+			if result == '0'
+				rgx= Regexp.new(/\(hangup\)/)
+				if rgx.match(response)
+					@is_hangup = true
+				end
+			end
+		end
+
+		return @is_hangup
+	end
+
+	def interrupted?
+		if @is_interrupted.nil?
+			@is_interrupted = false
+			if ((not failure?) and (result != '0'))
+				rgx= Regexp.new(/\(dtmf\)/)
+				if rgx.match(response)
+					@is_interrupted = true
+				end
+			end
+		end
+
+		return @is_interrupted
+	end
+
+	def timeout?
+		if @is_timeout.nil?
+			@is_timeout = false
+			if result == '0'
+				rgx= Regexp.new(/\(timeout\)/)
+				if rgx.match(response)
+					@is_timeout = true
+				end
+			end
+		end
+
+		return @is_timeout
+	end
+
+	def random_error?
+		if @is_random_error.nil?
+			@is_random_error = false
+			if ((not failure?) and (result != '0'))
+				rgx= Regexp.new(/\(randomerror\)/)
+				if rgx.match(response)
+					@is_randomerror = true
+				end
+			end
+		end
+
+		return @is_randomerror
+	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 success?
+		return (not failure?)
+	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/result.rb

@@ -0,0 +1,47 @@
+#
+#  File: result.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
+#
+
+
+class Result
+
+	def initialize(result)
+		@result = result
+	end
+
+	def to_i
+		@result.to_i
+	end
+
+	def to_s
+		@result.to_s
+	end
+
+	def ==(val)
+		if ((val.to_i.to_s == val.to_s) and (val.to_s.to_i == val.to_i))
+			if ((@result == val) or (@result.to_s == val.to_s) or (@result.to_i == val.to_i))
+				return true
+			end
+		end
+
+		return false
+	end
+end