ruby-agi 1.1.2 → 2.0.0

data/ChangeLog

@@ -1,12 +1,3 @@
-2006-03-05
-	--  ruby-agi-1.1.2 released
-	--	bug # 3733 fixed.
-	--	AGI#initialize will make sure the above bug won't happen.
-
-2006-02-08
-	--	method AsteriskVariable#init_caller_variable updated to have correct callerid
-	--	method ReturnStatus#timeout? updated
-
 2006-01-16 (revision 23)
 	--	ruby-agi-1.1.0 released
 	--	method calleridnumber added and is generated from callerid

data/DOWNLOAD

@@ -1,3 +1,3 @@
 To download ruby-agi or ruby-agi dependent application, please visit
-	http://ruby-agi.rubyforge.org
+http://www.ruby-agi.org
 

data/INSTALL

@@ -1,10 +1,5 @@
 I strongly suggest to install ruby-agi using gem, 
-	% gem install ruby-agi
-To update your existing ruby-agi using gem,  try
-	% gem update ruby-agi
-
-If you don't have gem intalled on your computer, download it from here
-	http://www.rubygems.org
+gem install ruby-agi
 
 Alternatively, do
 	1. ruby extconf.rb

data/README

@@ -1,14 +1,17 @@
 This library comes with absolutely no warranty.
 
-ruby-agi is a library to write AGI scripts in ruby language for Asterisk. ruby-agi does not depend of Asterisk Manager.
-There have a very simple AGI script in example/call_log.rb
-I couldn't write any tutorial for ruby-agi and I am not good at it, if anybody want to give me a hand on writing documentation and tutorial, would be greatly appreciated.
+I wanted to write couple of AGI scripts in ruby for myself.
+But I didn't see any AGI library written in ruby available.
+So, I decided to develop one and share with everybody.
 
-Here are a sites that may help to know more about ruby-agi
-http://ruby-agi.rubyforge.org           (ruby-agi homepage)
+Hopefully, you already understood I am not good at documentation.
+I truely appolize for that.
+If anybody want to give a hand to write documentation for this project would be greatly appreciated.
 
-Feel free to send me email, if you don't find any answer related to ruby-agi.
+Project homepage: http://www.ruby-agi.org
+
+Please feel free to email me with your feature request, bug report or any suggession.
 
 Thank you,
 Mohammad Khan,
-email: info <AT> beeplove <DOT> com
+email: info at beeplove dot com

data/Release-Notes

@@ -1,11 +1,20 @@
-Release notes of ruby-agi-1.1.2
-March 06, 2006
+1.1.0 (2006-01-17)
+	addition of method 'jump_to'
+	jump_to would take three arguments ex. jump_to(context, extension, priority)
+	enhanced callerid, calleridname and calleridnumber. calleridnumber is an addtional method to this release.
+	Regardless of Asterisk version above three caller variables would return uniform value.
+	Such as, callerid would return "John Smith" <1234567890> or empty string, if unidentified 
+	calleridnumber would return number part of callerid (as string) ex. 1234567890 or empty string, if unidentified
+	calleridname would return name part of callerid ex. John Smith or emtpy string, if unidentified
+   
+1.0.2 (2006-01-09)
+	Because of a yaml bug in ruby-1.8.3, rubyforge server doesn't support any package that were built on ruby-1.8.3
+	This version is basically re-build of version 1.0.1 on ruby-1.8.4 instead of ruby-1.8.3
 
-In this release bug # 3722 has been fixed
+1.0.1 (2006-01-08)
+	This release have minor a minor change.
+	There have an example file in examples/call_log.rb
+	You can use call_log.rb to keep your incoming call history in syslog.
 
-Feedback, suggestion, feature request, bug report is always appreciated.
-
-
-Thanks,
-Mohammad Khan
-info <AT> beeplove <DOT> com
+1.0.0 (2006-01-08)
+	This is the first stable version of ruby-agi

data/lib/ruby-agi/asterisk_variable.rb

@@ -75,8 +75,8 @@ class AsteriskVariable < AGI
 	def read_env(name)
 		if debug?
 			semaphore do
-				$stderr.puts "    -- ruby-agi << Read asterisk variable '#{name}'"
-				$stderr.puts "    -- ruby-agi >> Asterisk variable #{name} = #{env[name].to_s}"
+				$stderr.puts "    -- ruby-agi-trunk << Read asterisk variable '#{name}'"
+				$stderr.puts "    -- ruby-agi-trunk >> Asterisk variable #{name} = #{env[name].to_s}"
 			end	
 		end
 

data/lib/ruby-agi/command.rb

@@ -36,12 +36,18 @@
 require 'sync'
 
 require 'ruby-agi/agi.rb'
-require 'ruby-agi/return_status.rb'
 require 'ruby-agi/error.rb'
+require 'ruby-agi/return_status.rb'
 
 class AGI
 end
 
+class ReturnStatus
+end
+
+class Answer < ReturnStatus
+end
+
 
 class Command < AGI
 	def initialize
@@ -63,7 +69,7 @@ class Command < AGI
 	public
 	def answer
 		cmd = "ANSWER"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, Answer)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -85,7 +91,7 @@ class Command < AGI
 	public
 	def set_auto_hangup(secs=0)
 		cmd = "SET AUTOHANGUP #{secs.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, SetAutoHangup)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -120,7 +126,7 @@ class Command < AGI
 		end
 
 		cmd = "CHANNEL STATUS #{channel.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, ChannelStatus)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -146,7 +152,7 @@ class Command < AGI
 			options = ""
 		end
 		cmd = "EXEC #{application.to_s} #{options.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, Exec)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -179,7 +185,7 @@ class Command < AGI
 
 		cmd = "GET DATA #{filename.to_s} #{timeout.to_s} #{max_digit.to_s}"
 
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, WaitForDigits)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -201,7 +207,7 @@ class Command < AGI
 	public
 	def get_variable(name)
 		cmd = "GET VARIABLE #{name.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, GetVariable)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -226,7 +232,7 @@ class Command < AGI
 		end
 
 		cmd = "HANGUP #{channel.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, Hangup)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -245,7 +251,7 @@ class Command < AGI
 	public
 	def noop(msg)
 		cmd = "NOOP #{msg.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, Noop)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -273,7 +279,7 @@ class Command < AGI
 		raise(ArgumentError, "timeout need to be positive") if (timeout < 1)
 
 		cmd = "RECEIVE CHAR #{timeout.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, ReceiveChar)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -300,7 +306,7 @@ class Command < AGI
 		raise(ArgumentError, "timeout need to be positive") if (timeout < 1)
 
 		cmd = "RECEIVE TEXT #{timeout.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, ReceiveText)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -349,7 +355,7 @@ class Command < AGI
 		
 		cmd = "RECORD FILE #{filename} #{format} #{escape_digits} #{timeout}"
 		cmd = "#{cmd} beep" if beep == true
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, RecordFile)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -377,7 +383,7 @@ class Command < AGI
 		escape_digits = sanitize_escape_digits(escape_digits)
 
 		cmd = "SAY DIGITS #{digit_string.to_s} #{escape_digits}" 
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, SayDigits)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -403,7 +409,7 @@ class Command < AGI
 	def say_number(number, escape_digits=nil)
 		escape_digits = sanitize_escape_digits(escape_digits)
 		cmd = "SAY NUMBER #{number.to_s} #{escape_digits.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, SayNumber)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -429,7 +435,7 @@ class Command < AGI
 	def say_phonetic(string, escape_digits=nil)
 		escape_digits = sanitize_escape_digits(escape_digits)
 		cmd = "SAY PHONETIC #{string.to_s} #{escape_digits}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, SayPhonetic)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -455,7 +461,7 @@ class Command < AGI
 	def say_time(time=Time.now.to_i, escape_digits='#')
 		escape_digits = sanitize_escape_digits(escape_digits)
 		cmd = "SAY TIME #{time.to_s} #{escape_digits.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, SayTime)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -479,7 +485,7 @@ class Command < AGI
 	public
 	def send_image(image)
 		cmd = "SEND IMAGE #{image.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, SendImage)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -503,7 +509,7 @@ class Command < AGI
 	public
 	def send_text(text)
 		cmd = "SEND TEXT #{text.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, SendText)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -524,7 +530,7 @@ class Command < AGI
 	public
 	def set_caller_id(number)
 		cmd = "SET CALLERID #{number.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, SetCallerID)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -547,7 +553,7 @@ class Command < AGI
 	public
 	def set_context(context)
 		cmd = "SET CONTEXT #{context.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, SetContext)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -571,7 +577,7 @@ class Command < AGI
 	public
 	def set_extension(extension)
 		cmd = "SET EXTENSION #{extension.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, SetExtension)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -598,7 +604,7 @@ class Command < AGI
 			mode = 'OFF'
 		end
 		cmd = "SET MUSIC #{mode.to_s} #{moh_class.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, SetMusic)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -618,7 +624,7 @@ class Command < AGI
 	public
 	def set_priority(priority)
 		cmd = "SET PRIORITY #{priority.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, SetPriority)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -644,7 +650,7 @@ class Command < AGI
 	public
 	def set_variable(name, value)
 		cmd = "SET VARIABLE #{name.to_s} \"#{value.to_s}\""
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, SetVariable)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -678,7 +684,7 @@ class Command < AGI
 		escape_digits = sanitize_escape_digits(escape_digits)
 		
 		cmd = "STREAM FILE #{filename.to_s} #{escape_digits}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, StreamFile)
 		raise CommandError, rs.to_s if rs.command_error?
 
 		return rs
@@ -712,7 +718,7 @@ class Command < AGI
 			mode = 'OFF'
 		end
 		cmd = "TDD MODE #{mode.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, TDDMode)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -745,7 +751,7 @@ class Command < AGI
 	public
 	def verbose(message, level=3)
 		cmd = "VERBOSE \"#{message.to_s}\" #{level.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, Verbose)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -772,7 +778,7 @@ class Command < AGI
 		timeout = sanitize_timeout(timeout)
 		
 		cmd = "WAIT FOR DIGIT #{timeout.to_s}"
-		rs = exec_command(cmd)
+		rs = exec_command(cmd, WaitForDigit)
 		raise CommandError, rs.to_s if rs.command_error?
 		return rs
 	end
@@ -823,14 +829,8 @@ class Command < AGI
 		return rs
 	end
 
-	#private
-	#def escape(str)
-	#	rxp = Regexp.new(/\"/)
-	#	return str.gsub(rxp, '\"') 
-	#end
-
 	protected
-	def exec_command(cmd)
+	def exec_command(cmd, return_status=nil)
 		rs = nil
 		begin
 			semaphore do
@@ -838,8 +838,11 @@ class Command < AGI
 				$stdout.puts cmd
 				responses = $stdin.gets
 				$stderr.puts "    -- ruby-agi >> #{responses}" if debug?
-				rs = ReturnStatus.new(cmd, responses)
-
+				if return_status.nil?
+					rs = ReturnStatus.new(cmd, responses)
+				else
+					rs = return_status.new(cmd, responses)
+				end
 			end
 
 		rescue Errno::EPIPE

data/lib/ruby-agi/error.rb

@@ -41,5 +41,8 @@ end
 class CommandError < Exception
 end
 
+class UnknownError < Exception
+end
+
 class AGIError < Exception
 end

data/lib/ruby-agi/return_status.rb

@@ -1,92 +1,31 @@
-#
-#  File: return_status.rb
-#
-#  ruby-agi: Ruby Language API for Asterisk
-#
-#  Copyright (C) <2005>  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
-#
-
-
-#  every method of this class would return string or boolean
-#  methods of command class usually return ReturnStatus object
-
-class ReturnStatus
-
-	def initialize(command, message)
-		@command = command.chomp
-		@message = message
-		@result = nil
-		@digit = nil
-		@digits = nil
-		@return_code = nil
-		@command_error = false
-
-		if message.nil?
-			@messsage = "No responses !!"
-		else
-			str = @message.split(' ')
-			@return_code = str[0]
-			if @return_code == '200'
-				@result = str[1].split('=')[1]
-			end
-		end
-	end
-
-	public
-	def to_s
-		return @command.to_s + ' >> ' + @message.to_s
-	end
-
-	public
-	def result
-		return @result.to_s
-	end
-
-	public
-	def digit
-		if (@result == '0')
-			return nil
-		else
-			return @result.to_i.chr
-		end
-	end
-
-	public
-	def digits
-		return @result.to_s
-	end
-	
-	public
-	def message
-		return @message.to_s
-	end
-	
-	public	
-	def command_error?
-		return (result.nil? or (not (@return_code == '200')))
-	end
-
-	public
-	def timeout?
-		rgx = Regexp.new(/\(timeout\)/)
-		if rgx.match(@message)
-			return true
-		else
-			return false
-		end
-	end
-end
+require 'ruby-agi/rs/return_status.rb'
+require 'ruby-agi/rs/answer.rb'
+require 'ruby-agi/rs/answer.rb'
+require 'ruby-agi/rs/channel_status.rb'
+require 'ruby-agi/rs/exec.rb'
+require 'ruby-agi/rs/get_variable.rb'
+require 'ruby-agi/rs/hangup.rb'
+require 'ruby-agi/rs/noop.rb'
+require 'ruby-agi/rs/receive_char.rb'
+require 'ruby-agi/rs/receive_text.rb'
+require 'ruby-agi/rs/record_file.rb'
+require 'ruby-agi/rs/return_status.rb'
+require 'ruby-agi/rs/say_digits.rb'
+require 'ruby-agi/rs/say_number.rb'
+require 'ruby-agi/rs/say_phonetic.rb'
+require 'ruby-agi/rs/say_time.rb'
+require 'ruby-agi/rs/send_image.rb'
+require 'ruby-agi/rs/send_text.rb'
+require 'ruby-agi/rs/set_auto_hangup.rb'
+require 'ruby-agi/rs/set_caller_id.rb'
+require 'ruby-agi/rs/set_context.rb'
+require 'ruby-agi/rs/set_extension.rb'
+require 'ruby-agi/rs/set_music.rb'
+require 'ruby-agi/rs/set_priority.rb'
+require 'ruby-agi/rs/set_variable.rb'
+require 'ruby-agi/rs/stream_file.rb'
+require 'ruby-agi/rs/tdd_mode.rb'
+require 'ruby-agi/rs/verbose.rb'
+require 'ruby-agi/rs/wait_for_digit.rb'
+require 'ruby-agi/rs/wait_for_digits.rb'
+require 'ruby-agi/rs/'