ruby-agi 1.0.2 → 1.1.0

data/ChangeLog

@@ -1,10 +1,29 @@
-2006-01-08 (revision 21)
-	gemspec file updated to work properly with ruby-1.8.3
+2006-01-16 (revision 23)
+	--	ruby-agi-1.1.0 released
+	--	method calleridnumber added and is generated from callerid
+	--	method calleridname gets name from callerid method,
+		currently I found asterisk returns nothing because of missing agi_calleridname
+	--	method jump_to added
+
+2006-01-10 (revision 22)
+	--	following files added to svn repository
+		ruby-agi-1.0.1.gem
+		ruby-agi-1.0.2.gem
+		Release-Notes
+		ruby-agi-1.0.2.tgz
+
+2006-01-09 (revision 21)
+	--	gemspec file updated to work properly with ruby-1.8.3
+
 2006-01-08 (revision 20)
-	ruby-agi-1.0.1 released
+	--	ruby-agi-1.0.1 released
+
 2006-01-08 (revision 19)
-	examples/call_log.rb added
+	--	examples/call_log.rb added
+
 2006-01-08 (revision 18)
-	ruby-agi-0.0.2.gem removed from subversion repository
+	--	ruby-agi-0.0.2.gem removed from subversion repository
+
 2006-01-08 (revision 17)
-	Started to maintain ChangeLog !!
+	--	Started to maintain ChangeLog !!
+

data/Release-Notes

@@ -1,3 +1,12 @@
+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

data/lib/ruby-agi/agi.rb

@@ -243,29 +243,45 @@ class AGI
 	end
 
 	#
-	# <method description>
+	# method to read callerid, Ex. "John Smith" <1234567890>
+	# regardless of asterisk version, method callerid would return "Caller Name" <Number>
 	#
 	# <b>Parameters</b>
 	# - none
+	#
 	# <b>Returns</b>
-	# - String
+	# - String : empty string for Unidentified 
 	#
 	def callerid
 		return env.callerid
 	end
 
 	#
-	# <method description>
+	# method to read calleridname, Ex. John Smith
 	#
 	# <b>Parameters</b>
 	# - none
+	#
 	# <b>Returns</b>
-	# - String
+	# - String : empty string for Unidentified 
 	#
 	def calleridname
 		return env.calleridname
 	end
 
+	#
+	# method to read calleridnumber, Ex. 1234567890
+	#
+	# <b>Parameters</b>
+	# - none
+	#
+	# <b>Returns</b>
+	# - String : empty string for Unidentified 
+	#
+	def calleridnumber
+		return env.calleridnumber
+	end
+
 	#
 	# <method description>
 	#
@@ -843,5 +859,20 @@ class AGI
 	def dial(telephone_number=nil, protocol=nil, username=nil, context=nil, timeout=nil, options=nil)
 		return command.dial(telephone_number, protocol, username, context, timeout, options)
 	end
+
+	#
+	# method to jump in a specified context, extension and priority
+	#
+	# <b>Parameters</b>
+	# - context		: name of the context
+	# - extension	: name of the extension
+	# - priority	: name of the priority
+	#
+	# <b>Returns</b>
+	# - none
+	#
+	def jump_to(context=nil, extension=nil, priority=nil)
+		command.jump_to(context, extension, priority)
+	end
 end
 

data/lib/ruby-agi/asterisk_variable.rb

@@ -23,6 +23,22 @@
 # == Overview
 #
 
+# Followings are the list of AGI variables
+#    -- ruby-agi >> agi_request
+#    -- ruby-agi >> agi_channel
+#    -- ruby-agi >> agi_language
+#    -- ruby-agi >> agi_type
+#    -- ruby-agi >> agi_uniqueid
+#    -- ruby-agi >> agi_callerid
+#    -- ruby-agi >> agi_dnid
+#    -- ruby-agi >> agi_rdnis
+#    -- ruby-agi >> agi_context
+#    -- ruby-agi >> agi_extension
+#    -- ruby-agi >> agi_priority
+#    -- ruby-agi >> agi_enhanced
+#    -- ruby-agi >> agi_accountcode
+
+
 require 'ruby-agi/agi.rb'
 require 'ruby-agi/error.rb'
 
@@ -56,15 +72,14 @@ class AsteriskVariable < AGI
 
 	protected
 	def read_env(name)
-		val = env[name]
 		if debug?
 			semaphore do
 				$stderr.puts "    -- ruby-agi << Read asterisk variable '#{name}'"
-				$stderr.puts "    -- ruby-agi >> Asterisk variable #{name} = #{val.to_s}"
+				$stderr.puts "    -- ruby-agi >> Asterisk variable #{name} = #{env[name].to_s}"
 			end	
 		end
 
-		return val
+		return env[name]
 	end
 
 	public
@@ -94,32 +109,11 @@ class AsteriskVariable < AGI
 
 	public
 	def callerid
-		return read_env('agi_callerid') 
-	end
-
-	public
-	def calleridname
-		return read_env('agi_calleridname')	
-	end
-
-	public
-	def callingpres
-		return read_env('agi_callingpres')	
-	end
-
-	public
-	def callingani2
-		return read_env('agi_callingani2')	
-	end
-
-	public
-	def callington
-		return read_env('agi_callington')	
-	end
+		if @callerid.nil?
+			init_caller_variable
+		end
 
-	public
-	def callingtns
-		return read_env('agi_callingtns')	
+		return @callerid
 	end
 
 	public
@@ -156,4 +150,84 @@ class AsteriskVariable < AGI
 	def accountcode 
 		return read_env('agi_accountcode')
 	end
+
+	####################################################################
+	####  additional methods generated from existing basic methods  ####
+	####################################################################
+
+	public
+	def calleridname
+		if @calleridname.nil?
+			init_caller_variable
+		end
+		
+		return @calleridname
+	end
+
+	public
+	def calleridnumber
+		if @calleridnumber.nil?
+			init_caller_variable
+		end
+
+		return @calleridnumber
+	end
+
+	# following methods are not confirm that they are AGI variables
+	public
+	def callingpres
+		return read_env('agi_callingpres')	
+	end
+
+	public
+	def callingani2
+		return read_env('agi_callingani2')	
+	end
+
+	public
+	def callington
+		return read_env('agi_callington')	
+	end
+
+	public
+	def callingtns
+		return read_env('agi_callingtns')	
+	end
+
+	protected
+	def init_caller_variable
+		if read_env('callerid') == "unknown"
+			@callerid		= ""
+			@calleridname	= ""
+			@calleridnumber	= ""
+		else
+			if read_env('calleridname').nil?		# for asterisk that don't have agi variable 'agi_calleridname'
+				@callerid	= read_env('callerid')
+				name		= Regexp.new(/\".+\"/).match(@callerid)
+				number		= Regexp.new(/\<\d+\>/).match(@callerid)
+
+				if name.nil?
+					@calleridname = ""
+				else
+					name = name.to_s
+					name.gsub!(/\"/, '')
+					@calleridname = name.strip
+				end
+
+				if number.nil?
+					@calleridnumber = ""
+				else
+					number = number.to_s
+					number.sub!(/\</, '')
+					number.sub!(/\>/, '')
+					@calleridnumber = number
+				end
+			else									# for asterisk that have agi variable 'agi_calleridname'
+				@calleridnumber	= read_env('callerid')
+				@calleridname	= read_env('calleridname')
+				@callerid		= "\"#{@calleridname}\" <#{@calleridnumber}>"
+			end
+		end
+	end
+
 end

data/lib/ruby-agi/command.rb

@@ -894,4 +894,15 @@ class Command < AGI
 
 		return max_digit
 	end
+
+	############################################
+	###        More synthetic methods        ###
+	############################################
+
+	public
+	def jump_to(context, extension, priority)
+		set_context(context)		if not context.nil?
+		set_extension(extension)	if not extension.nil?
+		set_priority(priority)		if not priority.nil?
+	end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: ruby-agi
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
-date: 2006-01-09 00:00:00 -05:00
+  version: 1.1.0
+date: 2006-01-17 00:00:00 -05:00
 summary: Ruby Language API for Asterisk
 require_paths: 
 - lib