jicksta-adhearsion 0.8.2 → 0.8.3

data/CHANGELOG

@@ -1,3 +1,14 @@
+0.8.3
+
+0.8.2
+ - When a call hangs up, Adhearsion will no longer show random exceptions (that were okay) and instead allows the user to rescue a Hangup exception.
+ - ManagerInterfaceResponse now include()s DRbUndumped, allowing send_action() to be called directly over DRb.
+ - Fixes an inconsequential bug when CTL-C'ing Adhearsion.
+
+0.8.1
+ - The sandbox component now comes 
+ - Minor bug fixes
+
 0.8.0 rev 2
  - Added a few non-critical files to the .gemspec. They were ignored
 

data/Rakefile

@@ -118,3 +118,10 @@ task :debug_gem do
   Thread.new { spec = eval("$SAFE = 3\n#{gemspec}") }.join
   puts "SUCCESS: Gemspec runs at the $SAFE level 3."
 end
+
+desc 'Install the package as a gem.'
+task :install_gem => [:clobber_package, :package] do
+  windows = /djgpp|(cyg|ms|bcc)win|mingw/ =~ RUBY_PLATFORM
+  gem = Dir['pkg/*.gem'].first
+  sh "#{'sudo ' unless windows}gem install --local #{gem}"
+end

data/adhearsion.gemspec

@@ -112,7 +112,7 @@ ADHEARSION_FILES = %w{
 
 Gem::Specification.new do |s|
   s.name = "adhearsion"
-  s.version = "0.8.2"
+  s.version = "0.8.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jay Phillips"]

data/lib/adhearsion/initializer.rb

@@ -128,15 +128,15 @@ module Adhearsion
       switch_to_root_directory
       catch_termination_signal
       bootstrap_rc
-      daemonize! if should_daemonize?
       initialize_log_file
       load_all_init_files
       init_components_subsystem
       init_modules
       init_events_subsystem
-      create_pid_file if pid_file
       load_components
       init_events_file
+      daemonize! if should_daemonize?
+      create_pid_file if pid_file
       
       ahn_log "Adhearsion initialized!"
       

data/lib/adhearsion/version.rb

@@ -2,7 +2,7 @@ module Adhearsion #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0 unless defined? MAJOR
     MINOR = 8 unless defined? MINOR
-    TINY  = 2 unless defined? TINY
+    TINY  = 3 unless defined? TINY
 
     STRING = [MAJOR, MINOR, TINY].join('.') unless defined? STRING
   end

data/lib/adhearsion/voip/asterisk/commands.rb

@@ -161,12 +161,13 @@ module Adhearsion
       		execute "SendDTMF", digits.to_s
       	end
       	
+      	# The with_next_message method...
       	def with_next_message(&block)
       	  raise LocalJumpError, "Must supply a block" unless block_given?
       	  block.call(next_message)
     	  end
 
-        # This command shouled be used to advance to the next message in the Asterisk Comedian Voicemail application
+        # This command should be used to advance to the next message in the Asterisk Comedian Voicemail application
         def next_message
           @call.inbox.pop
         end
@@ -438,6 +439,9 @@ module Adhearsion
           raise Adhearsion::VoIP::DSL::Dialplan::ControlPassingException.new(context)
         end
       	
+      	# The queue method puts a call into a call queue to be answered by an agent registered with that queue.
+      	# A full description may be found here: http://www.voip-info.org/wiki-Asterisk+cmd+Queue
+      	# The queue method takes a queue_name as an argument to place the caller in the appropriate queue.
       	def queue(queue_name)
       	  queue_name = queue_name.to_s
       	  
@@ -558,6 +562,9 @@ module Adhearsion
     	    raw_response("SET VARIABLE %s %p" % [variable_name.to_s, value.to_s]) == "200 result=1"
   	    end
     	  
+    	  # The variable method allows you to either set or get a channel variable from Asterisk
+    	  # The method takes a hash key/value pair if you would like to set a variable
+    	  # Or a single string with the variable to get from Asterisk
     	  def variable(*args)
     	    if args.last.kind_of? Hash
       	    assignments = args.pop
@@ -574,6 +581,11 @@ module Adhearsion
     	    end
   	    end
     	  
+    	  # Use the voicemail method to send a caller to a voicemail box to leave a message. 
+    	  # A complete description is avilable at:
+    	  # http://www.voip-info.org/tiki-index.php?page=Asterisk+cmd+VoiceMail
+    	  # The method takes the mailbox_number of the user to leave a message for and a
+    	  # greeting_option that will determine which message gets played to the caller.
         def voicemail(*args)
           options_hash    = args.last.kind_of?(Hash) ? args.pop : {}
           mailbox_number  = args.shift
@@ -606,6 +618,9 @@ module Adhearsion
           end
         end
         
+        # The voicemail_main method puts a caller into the voicemail system to fetch their voicemail
+        # or set options for their voicemail box. A full description may be found here:
+        # http://www.voip-info.org/wiki-Asterisk+cmd+VoiceMailMain
         def voicemail_main(options={})
           mailbox, context, folder = options.values_at :mailbox, :context, :folder
           authenticate = options.has_key?(:authenticate) ? options[:authenticate] : true
@@ -730,6 +745,7 @@ module Adhearsion
 
         protected
         
+          # wait_for_digits waits for the input of digits based on the number of milliseconds
           def wait_for_digit(timeout=-1)
             timeout *= 1_000 if timeout != -1
             result = result_digit_from raw_response("WAIT FOR DIGIT #{timeout.to_i}")
@@ -744,12 +760,14 @@ module Adhearsion
             nil
           end
           
+          # set_callier_id_number method allows setting of the callerid number of the call
           def set_caller_id_number(caller_id)
             return unless caller_id
             raise ArgumentError, "Caller ID must be numerical" if caller_id.to_s !~ /^\d+$/
             raw_response %(SET CALLERID %p) % caller_id
           end
           
+          # set_caller_id_name method allows the setting of the callerid name of the call
           def set_caller_id_name(caller_id_name)
             return unless caller_id_name
             variable "CALLERID(name)" => caller_id_name
@@ -891,7 +909,7 @@ module Adhearsion
           
           def validate_digits(digits)
             returning digits.to_s do |digits_as_string|
-              raise ArgumentError, "Can only be called with valid digits!" unless digits_as_string =~ /^\d+$/
+              raise ArgumentError, "Can only be called with valid digits!" unless digits_as_string =~ /^[0-9*#-]+$/
             end
           end
           

data/lib/adhearsion/voip/asterisk/manager_interface.rb

@@ -298,6 +298,8 @@ module Adhearsion
           ###########                                      ###########
           #######                                              #######
           
+          # ping sends an action to the Asterisk Manager Interface that returns a pong
+          # more details here: http://www.voip-info.org/wiki/index.php?page=Asterisk+Manager+API+Action+Ping
           def ping
             deprecation_warning
             send_action "Ping"
@@ -310,6 +312,29 @@ module Adhearsion
                 " See http://docs.adhearsion.com/AMI for more information."
           end
           
+          # The originate method launches a call to Asterisk, full details here:
+          # http://www.voip-info.org/tiki-index.php?page=Asterisk+Manager+API+Action+Originate
+          # Takes these arguments as a hash:
+          #
+          #   Channel: Channel on which to originate the call (The same as you specify in the Dial application command)
+          #   Context: Context to use on connect (must use Exten & Priority with it)
+          #   Exten: Extension to use on connect (must use Context & Priority with it)
+          #   Priority: Priority to use on connect (must use Context & Exten with it)
+          #   Timeout: Timeout (in milliseconds) for the originating connection to happen(defaults to 30000 milliseconds)
+          #   CallerID: CallerID to use for the call
+          #   Variable: Channels variables to set (max 32). Variables will be set for both channels (local and connected).
+          #   Account: Account code for the call
+          #   Application: Application to use on connect (use Data for parameters)
+          #   Data : Data if Application parameter is used
+          #   Async: For the origination to be asynchronous (allows multiple calls to be generated without waiting for a response)
+          #   ActionID: The request identifier. It allows you to identify the response to this request. 
+          #   You may use a number or a string. Useful when you make several simultaneous requests.
+          #
+          # For example:
+          # originate { :channel  => 'SIP/1000@sipnetworks.com',
+          #             :context  => 'my_context',
+          #             :exten    => 's',
+          #             :priority => '1' }
           def originate(options={})
             deprecation_warning
             options = options.clone
@@ -335,11 +360,15 @@ module Adhearsion
             call_and_exec caller, "Dial", :args => dial_args, :caller_id => opts[:caller_id]
           end
 
+          # hangup terminates a call accepts a channel as the argument
+          # full details here: http://www.voip-info.org/wiki/index.php?page=Asterisk+Manager+API+Action+Hangup
           def hangup(channel)
             deprecation_warning
             send_action "Hangup", :channel => channel
           end
 
+          # call_and_exec allows you to make a call to a channel and then execute an Astersik application
+          # on that call
           def call_and_exec(channel, app, opts={})
             deprecation_warning
             args = { :channel => channel, :application => app }
@@ -348,6 +377,10 @@ module Adhearsion
             originate args
           end
 
+          # call_into_context is syntactic sugar for the Asterisk originate command that allows you to 
+          # lanuch a call into a particular context. For example:
+          #
+          # call_into_context('SIP/1000@sipnetworks.com', 'my_context', { :variables => { :session_guid => new_guid }})
           def call_into_context(channel, context, options={})
             deprecation_warning
             args = {:channel => channel, :context => context}

data/lib/theatre/invocation.rb

@@ -32,7 +32,7 @@ module Theatre
       @returned_value_lock = Monitor.new
       
       # Used when wait() is called to notify all waiting threads by using a ConditionVariable
-      @returned_value_blocker = Monitor::ConditionVariable.new @returned_value_lock
+      @returned_value_blocker = @returned_value_lock.new_cond#Monitor::ConditionVariable.new @returned_value_lock
     end
     
     def queued

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jicksta-adhearsion
 version: !ruby/object:Gem::Version 
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors: 
 - Jay Phillips
@@ -14,6 +14,7 @@ default_executable:
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rubigen
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -23,6 +24,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: log4r
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: