ruby-agi 0.0.3 → 1.0.0

data/lib/command.rb

@@ -1,486 +0,0 @@
-#
-#  File: command.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
-#
-
-# this would be the most used class
-
-# most common arguements
-# timeout: nil=forever, 
-# escape_digit, by default #, if nil passed as argument there will not have any escape
-# escape_digits, by default #, if nil passed as argument there will not have any escape
-# channel, current channel otherwise mentioned
-# max_digit, maximum number of digits would be accepted from user, always 255 otherwise mentioned
-# filename, name of file to be streamed, recoreds ..
-# beep, always yes, otherwise passed false or nil as argument
-# format, always gsm otherwise mentioned
-# secs, all methods need time as an argument are passed as seconds
-
-require 'agi.rb'
-require 'return_status.rb'
-require 'error.rb'
-require 'sync'
-
-class AGI
-end
-
-
-class Command < AGI
-
-    # answer: Asserts answer
-	public
-	def answer
-		cmd = 'ANSWER'
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # set autohangup: Autohangup channel in some time
-	public
-	def set_auto_hangup(secs=0)
-		cmd = 'SET AUTOHANGUP ' + secs.to_s
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # channel status: Returns status of the connected channel
-	# we are returing channel object
-	public
-	def channel_status(channel=nil)
-		cmd = 'CHANNEL STATUS'
-		cmd = cmd + ' ' + channel.to_s if not channel.nil?
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # database del: Removes database key/value
-	#def database_del
-	# I am not quite sure how it works and what it do
-	# I will update code once I about this	
-	#end
-
-    # database deltree: Removes database keytree/value
-	#def database_deltree
-	# I am not quite sure how it works and what it do
-	# I will update code once I about this	
-	#end
-	
-    # database get: Gets database value
-	#def database_get
-	# I am not quite sure how it works and what it do
-	# I will update code once I about this	
-	#end
-
-    # database put: Adds/updates database value
-	#def database_put
-	# I am not quite sure how it works and what it do
-	# I will update code once I about this	
-	#end	
-
-    # exec: Executes a given Application. (Applications are the functions you use to create a dial plan in extensions.conf ).
-	# returns the message like 200, result=0
-	# to get result use rs.result 
-	# exec return whatever the asterisk command returns
-	public
-	def exec(asterisk_application, options=nil)
-		cmd = 'EXEC ' + asterisk_application.to_s
-		cmd = cmd + ' ' + options.to_s if not options.nil?
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # get data: Gets data on a channel
-	public
-	def get_data(filename, timeout=nil, max_digit=nil)
-		cmd = 'GET DATA' + ' ' + filename.to_s
-		timeout = timeout.to_i * 1000 if not timeout.nil?
-		if (timeout.nil? and (not max_digit.nil?))
-			cmd = cmd + ' -1 ' + max_digit.to_s
-		elsif max_digit.nil?
-			cmd = cmd + ' ' + timeout.to_s
-		else
-			cmd = cmd + ' ' + timeout.to_s + ' ' + max_digit.to_s
-		end
-
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # get variable: Gets a channel variable
-	public
-	def get_variable(name)
-		cmd = 'GET VARIABLE ' + name.to_s
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # hangup: Hangup the current channel
-	public
-	def hangup(channel=nil)
-		cmd = 'HANGUP'
-		cmd = cmd + ' ' + channel.to_s if channel.nil?
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # noop: Does nothing
-	public
-	def noop(msg)
-		cmd = 'NOOP ' + msg.to_s
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # receive char: Receives one character from channels supporting it
-	public
-	def receive_char(timeout=0)
-		cmd = 'RECEIVE CHAR'
-		if not timeout.zero?
-			timeout = timeout * 1000	
-			cmd = cmd + ' ' + timeout.to_s
-		end
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-	
-    # receive text: Receives text from channels supporting it
-	public
-	def receive_text(timeout=0)
-		cmd = 'RECEIVE TEXT'
-		if not timeout.zero?
-			timeout = timeout * 1000	
-			cmd = cmd + ' ' + timeout.to_s
-		end
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # record file: Records to a given file
-	public
-	def record_file(filename, format='gsm', escape_digits=nil, timeout=nil, beep=true)
-		cmd = 'RECORD FILE ' + filename.to_s  + ' ' + format.to_s + ' '
-		if escape_digits.nil?
-			cmd = cmd + ' ' + '#'
-		else
-			cmd = cmd + ' ' + escape_digits.to_s
-		end
-
-		if timeout.nil?
-			timeout = -1
-		else
-			timeout = timeout * 1000 if timeout.to_i > 0
-		end
-
-		cmd = cmd + ' ' + timeout.to_s
-		cmd = cmd + ' ' + 'beep' if beep
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # say digits: Says a given digit string
-	public
-	def say_digits(digit_string, escape_digits=nil)
-		cmd = 'SAY DIGITS ' + digit_string.to_s + ' '
-		if escape_digits.nil?
-			cmd = cmd + '""'
-		else
-			cmd = cmd + escape_digits.to_s
-		end
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # say number: Says a given number
-	public
-	def say_number(number, escape_digits=nil)
-		cmd = 'SAY NUMBER ' + number.to_s + ' '
-		if escape_digits.nil?
-			cmd = cmd + '""'
-		else
-			cmd = cmd + escape_digits.to_s
-		end
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # say phonetic: Say the given character string.
-	public
-	def say_phonetic(string, escape_digits=nil)
-		cmd = 'SAY PHONETIC ' + '"' + string.to_s + '"'
-		cmd = cmd + ' ' + escape_digits.to_s if not escape_digits.nil?
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # say time: Say a time
-	# SAY TIME <time> <escape digits>
-	# <time> is number of seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC).
-	public
-	def say_time(time=Time.now.to_i, escape_digits='#')
-		cmd = 'SAY TIME ' + time.to_s
-		cmd = cmd + ' ' + escape_digits.to_s
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # send image: Sends images to channels supporting it
-	public
-	def send_image(image)
-		cmd = 'SEND IMAGE ' + image.to_s
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # send text: Sends text to channels supporting it
-	public
-	def send_text(text)
-		cmd = 'SEND TEXT ' + text.to_s
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # set callerid: Sets callerid for the current channel
-	public
-	def set_caller_id(number)
-		cmd = 'SET CALLERID ' + number.to_s
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # set context: Sets channel context
-	public
-	def set_context(context)
-		cmd = 'SET CONTEXT ' + context.to_s
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # set extension: Changes channel extension
-	public
-	def set_extension(extension)
-		cmd = 'SET EXTENSION ' + extension.to_s
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # set music: Enable/Disable Music on hold generator, example "SET MUSIC ON default"
-	public
-	def set_music(mode=true, moh_class='default')
-		if mode
-			mode = 'ON'
-		else
-			mode = 'OFF'
-		end
-		cmd = 'SET MUSIC ' + mode.to_s + ' ' + moh_class.to_s
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # set priority: Prioritizes the channel
-	public
-	def set_priority(priority)
-		cmd = 'SET PRIORITY ' + priority.to_i.to_s
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # set variable: Sets a channel variable
-	public
-	def set_variable(name, value)
-		cmd = 'SET VARIABLE ' + name.to_s + ' ' + '"' + value.to_s + '"'
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # stream file: Sends audio file on channel
-	public
-	def stream_file(filename, escape_digits='#')
-		cmd = 'STREAM FILE ' + filename.to_s
-		cmd = cmd + ' ' + '"' + escape_digits.to_s + '"'
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # tdd mode: Activates TDD mode on channels supporting it, to enable communication with TDDs.
-	public
-	def tdd_mode(settings=true)
-		if settings
-			settings = 'ON'
-		else
-			settings = 'OFF'
-		end
-		cmd = 'TDD MODE ' + settings.to_s
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # verbose: Logs a message to the asterisk verbose log
-	public
-	def verbose(message, level=3)
-		cmd = 'VERBOSE ' + '"' + message.to_s + '"' + ' ' + level.to_s
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-    # wait for digit: Waits for a digit to be pressed 
-	public
-	def wait_for_digit(timeout=nil)
-		cmd = 'WAIT FOR DIGIT'
-		
-		if timeout.nil?	
-			timeout = -1
-		else
-			timeout = timeout * 1000
-		end
-		cmd = cmd + ' ' + timeout.to_i.to_s
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-	####### More commands ######
-
-	# record is just an enhancement of record file
-	# after each record, caller will get an option 
-	# to record or accept. also this method would be 
-	# called by max_tries argument, which can not 
-	# be more than 255
-	def record(filename, format='gsm', escape_digits=nil, timeout=nil, beep=true, max_tries=255)
-		try_count = 0
-		try_again = true
-
-		while (try_again and (try_count < max_tries))
-			self.record_file(filename, format, escape_digits, timeout, beep)
-
-			replay = true
-
-			while replay
-				status = stream_file("ruby-agi/record-menu", "123#*")
-				$stderr.puts status.to_s
-				if status.result.zero?
-					status = self.wait_for_digit(10)
-					$stderr.puts status.to_s
-				end
-				if status.digit == '1'			# accept record
-					try_again = false
-					replay = false
-				elsif status.digit == '2'		# listen record
-					self.stream_file(filename)
-					replay = true
-				elsif status.digit == '3'		# re-record
-					# we need to make sure to delete previously recored file
-					max_tries = max_tries.next
-					replay = false
-				elsif status.digit == '*'		# replay menu
-					replay = true
-				elsif status.digit == '#'		# quit
-					replay = false
-					try_again = false
-				else							
-				end
-			end
-		end
-	end
-
-
-	def dial(telephone_number=nil, protocol=nil, username=nil, context='default', extension=nil, timeout=nil, options=nil)
-		dial_string = nil
-
-		if protocol == 'LOCAL'
-			return nil if (extension.nil? or context.nil?)
-			dial_string = "LOCAL/#{extension}@#{context}"
-		elsif protocol == 'IAX2'
-			return nil if (telephone_number.nil? or username.nil? or context.nil?)
-			telephone_number.strip!
-			dial_string = "IAX2/#{username}@#{context}/#{telephone_number}" 
-		elsif protocol == 'SIP'
-		else
-			return nil
-		end
-
-		timeout.nil? ? dial_string += "|" : dial_string += "|#{timeout}"
-		options.nil? ? dial_string += "|" : dial_string += "|#{options}"
-		rs = exec('DIAL', dial_string)
-		return rs
-	end
-
-	###### Process methods #######
-	
-	public
-	def raw_command(cmd)
-		rs = exec_command(cmd)
-		raise CommandError, rs.to_s if rs.command_error?
-		return rs
-	end
-
-	private
-	def escape(str)
-		rxp = Regexp.new(/\"/)
-		return str.gsub(rxp, '\"') 
-	end
-
-	private
-	def exec_command(cmd)
-		rs = nil
-		begin
-			semaphore do
-				$stdout.puts cmd
-				responses = $stdin.gets
-				rs = ReturnStatus.new(cmd, responses)
-				if debug?
-					$stderr.puts "  -- ruby-agi << #{cmd}"
-					$stderr.puts "  -- ruby-agi >> #{rs.message}"
-				end
-			end
-
-		rescue Errno::EPIPE
-			raise HangupError, "Line hung up during command execution!!"
-		end
-
-		return rs
-	end
-
-end

data.tar.gz.sig

@@ -1 +0,0 @@
-wv(�8z��?{�1�K	�M��vx��Sˤf���-M?E�_��2pt31��)1���w�ɝ�� }�ع���}��?*�@!�] i�6f��i�&�cc��@��Kl�k��+�
�O{�h�os�I��2��
��,3���d˜uM�����Y���5�(O��Rbos�ޤ����/�<����t=�x�_c�l1<��rn	�B߰ӳ�]��#6��UZm]':���G���a���̂��6����$�1���6