adhearsion 0.8.6 → 1.0.0

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

@@ -6,14 +6,34 @@ module Adhearsion
       module Manager
         class AbstractAsteriskManagerInterfaceStreamLexer
 
-          BUFFER_SIZE = 8.kilobytes unless defined? BUFFER_SIZE
+          BUFFER_SIZE = 128.kilobytes unless defined? BUFFER_SIZE
+
+          ##
+          # IMPORTANT! See method documentation for adjust_pointers!
+          #
+          # @see  adjust_pointers
+          #
+          POINTERS = [
+            :@current_pointer,
+            :@token_start,
+            :@token_end,
+            :@version_start,
+            :@event_name_start,
+            :@current_key_position,
+            :@current_value_position,
+            :@last_seen_value_end,
+            :@error_reason_start,
+            :@follows_text_start,
+            :@current_syntax_error_start,
+            :@immediate_response_start
+            ]
 
           %%{
           	machine ami_protocol_parser;
 
             # All required Ragel actions are implemented as Ruby methods.
 
-            # Executed after a "Respone: Success" or "Response: Pong"
+            # Executed after a "Response: Success" or "Response: Pong"
             action init_success { init_success }
 
             action init_response_follows { init_response_follows }
@@ -68,7 +88,6 @@ module Adhearsion
         			variable cs    @current_state;
         			variable ts    @token_start;
         			variable te    @token_end;
-        			variable stack @stack;
         			variable act   @ragel_act;
         			variable eof   @eof;
 			        variable stack @ragel_stack;
@@ -90,10 +109,23 @@ module Adhearsion
           end
 
           def extend_buffer_with(new_data)
-            if new_data.size + @data.size > BUFFER_SIZE
-              @data.slice! 0...new_data.size
-              # TODO: What if the current_pointer wasn't at the end of the data for some reason?
-              @current_pointer = @data.size
+            length = new_data.size
+
+            if length > BUFFER_SIZE
+              raise Exception, "ERROR: Buffer overrun! Input size (#{new_data.size}) larger than buffer (#{BUFFER_SIZE})"
+            end
+
+            if length + @data.size > BUFFER_SIZE
+              if @data.size != @current_pointer
+                if @current_pointer < length
+                  # We are about to shift more bytes off the array than we have
+                  # parsed.  This will cause the parser to lose state so
+                  # integrity cannot be guaranteed.
+                  raise Exception, "ERROR: Buffer overrun! AMI parser cannot guarantee sanity. New data size: #{new_data.size}; Current pointer at #{@current_pointer}; Data size: #{@data.size}"
+                end
+              end
+              @data.slice! 0...length
+              adjust_pointers -length
             end
             @data << new_data
             @data_ending_pointer = @data.size
@@ -101,6 +133,27 @@ module Adhearsion
 
           protected
 
+          ##
+          # This method will adjust all pointers into the buffer according
+          # to the supplied offset.  This is necessary any time the buffer
+          # changes, for example when the sliding window is incremented forward
+          # after new data is received.
+          #
+          # It is VERY IMPORTANT that when any additional pointers are defined
+          # that they are added to this method.  Unpredictable results may
+          # otherwise occur!
+          #
+          # @see https://adhearsion.lighthouseapp.com/projects/5871-adhearsion/tickets/72-ami-lexer-buffer-offset#ticket-72-26
+          #
+          # @param offset Adjust pointers by offset.  May be negative.
+          #
+          def adjust_pointers(offset)
+            POINTERS.each do |ptr|
+              value = instance_variable_get(ptr)
+              instance_variable_set(ptr, value + offset) if !value.nil?
+            end
+          end
+
           ##
           # Called after a response or event has been successfully parsed.
           #
@@ -144,12 +197,12 @@ module Adhearsion
           end
 
           def version_starts
-            @start_of_version = @current_pointer
+            @version_start = @current_pointer
           end
 
           def version_stops
-            self.ami_version = @data[@start_of_version...@current_pointer].to_f
-            @start_of_version = nil
+            self.ami_version = @data[@version_start...@current_pointer].to_f
+            @version_start = nil
           end
 
           def event_name_starts

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

@@ -13,7 +13,7 @@ module Adhearsion
 
           class << self
             def from_immediate_response(text)
-              returning new do |instance|
+              new.tap do |instance|
                 instance.text_body = text
               end
             end

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

@@ -9,7 +9,7 @@ module Adhearsion
           macro_name = options.delete :macro
           options[:play] &&= options[:play].kind_of?(Array) ? options[:play].join('++') : options[:play]
           encoded_options = URI.escape options.map { |key,value| "#{key}:#{value}" }.join('!')
-          returning "M(#{macro_name}^#{encoded_options})" do |str|
+          "M(#{macro_name}^#{encoded_options})".tap do |str|
             if str.rindex('^') != str.index('^')
               raise ArgumentError, "You seem to have supplied a :confirm option with a caret (^) in it!" +
                                    " Please remove it. This will blow Asterisk up."
@@ -31,7 +31,7 @@ module Adhearsion
           unencoded = URI.unescape(encoded_hash).split('!')
           unencoded.shift unless unencoded.first.include?(':')
           unencoded = unencoded.map { |pair| key, value = pair.split(':'); [key.to_sym ,value] }.flatten
-          returning Hash[*unencoded] do |hash|
+          Hash[*unencoded].tap do |hash|
             hash[:timeout]    &&= hash[:timeout].to_i
             hash[:play]       &&= hash[:play].split('++')
           end

data/lib/adhearsion/voip/call.rb

@@ -174,7 +174,7 @@ module Adhearsion
       # Given an IO (probably a socket accepted from an Asterisk service),
       # creates a Call instance which encapsulates everything we know about that call.
       def receive_from(io, &block)
-        returning new(io, variable_parser_for(io).variables) do |call|
+        new(io, variable_parser_for(io).variables).tap do |call|
           block.call(call) if block
         end
       end
@@ -332,7 +332,7 @@ module Adhearsion
 
           def remove_agi_prefixes_from_keys_and_strip_whitespace(variables)
             variables.inject({}) do |new_variables,(key,value)|
-              returning new_variables do
+              new_variables.tap do
                 stripped_name = key.kind_of?(String) ? key[/^(agi_)?(.+)$/,2] : key
                 new_variables[stripped_name] = value.kind_of?(String) ? value.strip : value
               end
@@ -341,21 +341,21 @@ module Adhearsion
 
           def coerce_keys_into_symbols(variables)
             variables.inject({}) do |new_variables,(key,value)|
-              returning new_variables do
+              new_variables.tap do
                 new_variables[key.to_sym] = value
               end
             end
           end
 
           def coerce_extension_into_phone_number_object(variables)
-            returning variables do
+            variables.tap do
               variables[:extension] = Adhearsion::VoIP::DSL::PhoneNumber.new(variables[:extension])
             end
           end
 
           def coerce_numerical_values_to_numerics(variables)
             variables.inject({}) do |vars,(key,value)|
-              returning vars do
+              vars.tap do
                 is_numeric = value =~ /^-?\d+(?:(\.)\d+)?$/
                 is_float   = $1
                 vars[key] = if is_numeric
@@ -402,13 +402,13 @@ module Adhearsion
           end
 
           def coerce_type_of_number_into_symbol(variables)
-            returning variables do
+            variables.tap do
               variables[:type_of_calling_number] = Adhearsion::VoIP::Constants::Q931_TYPE_OF_NUMBER[variables.delete(:callington).to_i]
             end
           end
 
           def decompose_uri_query_into_hash(variables)
-            returning variables do
+            variables.tap do
               if variables[:request] && variables[:request].query
                 variables[:query] = variables[:request].query.split('&').inject({}) do |query_string_parameters, key_value_pair|
                   parameter_name, parameter_value = *key_value_pair.match(/(.+)=(.*)/).captures
@@ -422,7 +422,7 @@ module Adhearsion
           end
 
           def override_variables_with_query_params(variables)
-            returning variables do
+            variables.tap do
               if variables[:query]
                 variables[:query].each do |key, value|
                   variables[key.to_sym] = value
@@ -432,7 +432,7 @@ module Adhearsion
           end
 
           def remove_dashes_from_context_name(variables)
-            returning variables do
+            variables.tap do
               variables[:context].gsub!('-', '_')
             end
           end
@@ -444,7 +444,7 @@ module Adhearsion
 
         class << self
           def parse(*args, &block)
-            returning new(*args, &block) do |parser|
+            new(*args, &block).tap do |parser|
               parser.parse
             end
           end
@@ -476,7 +476,7 @@ module Adhearsion
 
           def initialize_variables_as_hash_from_lines
             @variables = lines.inject({}) do |new_variables,line|
-              returning new_variables do
+              new_variables.tap do
                 key, value = self.class.separate_line_into_key_value_pair line
                 new_variables[key] = value
               end

data/lib/adhearsion/voip/call_routing.rb

@@ -31,7 +31,7 @@ module Adhearsion
           attr_accessor :rules
 
           def define(&block)
-            returning new do |router|
+            new.tap do |router|
               router.define(&block)
               rules.concat router.rules
             end

data/lib/adhearsion/voip/dial_plan.rb

@@ -9,7 +9,7 @@ begin
   minver = Adhearsion::PkgVersion.new("1.6.0")
   if curver < minver
     puts "****************************************************************************"
-    puts "Versions of JRuby prior to 1.6.0 contain a bug that limits the prevents"
+    puts "Versions of JRuby prior to 1.6.0 contain a bug that impacts"
     puts "using the \"+\" operator to jump from one context to another."
     puts "Adhearsion has detected JRuby version #{JRUBY_VERSION}. For more information see:"
     puts "https://adhearsion.lighthouseapp.com/projects/5871/tickets/92-menu-method-under-jruby-does-not-appear-to-work"
@@ -40,7 +40,7 @@ module Adhearsion
 
       class << self
         def create(*args)
-          returning(new(*args)) { |instance| instance.stage! }
+          new(*args).tap { |instance| instance.stage! }
         end
       end
 
@@ -127,10 +127,19 @@ module Adhearsion
       # Find the dialplan by the context name from the call or from the
       # first path entry in the AGI URL
       def entry_point_for(call)
+
+        # Try the request URI for an entry point first
         if call.respond_to?(:request) && m = call.request.path.match(%r{/([^/]+)})
-          dial_plan.lookup(m[1].to_sym)
-        elsif entry_point = dial_plan.lookup(call.context.to_sym)
-          entry_point
+          if entry_point = dial_plan.lookup(m[1].to_sym)
+            return entry_point
+          else
+            ahn_log.warn "AGI URI requested context \"#{m[1]}\" but matching Adhearsion context not found!  Falling back to Asterisk context."
+          end
+        end
+
+        # Fall back to the matching Asterisk context name
+        if entry_point = dial_plan.lookup(call.context.to_sym)
+          return entry_point
         end
       end
 
@@ -170,7 +179,7 @@ module Adhearsion
                 raise ArgumentError, "Unrecognized type of file #{file.inspect}"
             end
           end
-          returning new do |loader|
+          new.tap do |loader|
             files.each do |file|
               loader.load file
             end

data/lib/adhearsion/voip/dsl/dialing_dsl.rb

@@ -76,7 +76,7 @@ module Adhearsion
           end
 
           def defined_properties_without_name
-            returning @table.clone do |copy|
+            @table.clone.tap do |copy|
               copy.delete :name
             end
           end

data/lib/adhearsion/voip/dsl/dialing_dsl/dialing_dsl_monkey_patches.rb

@@ -22,7 +22,7 @@ module Adhearsion
                 when ProviderDefinition
                   RouteRule.new :patterns => self, :providers => other
                 when RouteRule
-                  returning other do |route|
+                  other.tap do |route|
                     route.unshift_pattern self
                   end
                 else raise ArgumentError, "Unsupported route definition #{other.inspect}"

data/lib/adhearsion/voip/dsl/dialplan/dispatcher.rb

@@ -108,7 +108,7 @@ module Adhearsion
           end
 
           def clone
-            returning super do |nemesis|
+            super.tap do |nemesis|
               instance_variables.each do |iv|
                 value = instance_variable_get(iv)
                 nemesis.instance_variable_set iv, value.clone if value

data/lib/adhearsion/voip/dsl/dialplan/parser.rb

@@ -19,7 +19,7 @@ module Adhearsion
             dialplans = AHN_CONFIG.files_from_setting "paths", "dialplan"
             ahn_log.dialplan.warn "No dialplan files were found!" if dialplans.empty?
 
-            returning({}) do |contexts|
+            {}.tap do |contexts|
               dialplans.each do |file|
                 raise "Dialplan file #{file} does not exist!" unless File.exists? file
                 envelope.instance_eval do
@@ -31,7 +31,7 @@ module Adhearsion
                     warn %'Dialplan context "#{name}" exists in both #{contexts[name].file} and #{file}.' +
                          %' Using the "#{name}" context from #{contexts[name].file}.'
                   else
-                    contexts[name] = returning OpenStruct.new do |metadata|
+                    contexts[name] = OpenStruct.new.tap do |metadata|
                       metadata.file  = file
                       metadata.name  = name
                       metadata.block = block
@@ -45,10 +45,8 @@ module Adhearsion
 
         class ContextsEnvelope
 
-          keep = %w"__send__ __id__ define_method instance_eval meta_def meta_eval metaclass"
-          (instance_methods - keep).each do |m|
-            undef_method m
-          end
+          keep = %w"define_method instance_eval meta_def meta_eval metaclass"
+          (instance_methods - keep).each { |m| undef_method m unless m =~ /^__/ }
 
           def initialize
             @parsed_contexts = {}

data/lib/adhearsion/voip/dsl/numerical_string.rb

@@ -19,9 +19,7 @@ module Adhearsion
           end
         end
 
-        (instance_methods - %w"__id__ __send__ __real_num __real_string").each do |m|
-          undef_method m
-        end
+        (instance_methods - %w{instance_eval object_id}).each { |m| undef_method m unless m =~ /^__/ }
 
         attr_reader :__real_num, :__real_string
 

data/lib/adhearsion/voip/freeswitch/basic_connection_manager.rb

@@ -18,7 +18,7 @@ module Adhearsion
         end
 
         def get_raw_header
-          (returning [] do |lines|
+          ([].tap do |lines|
             until line = @io.gets and line.chomp.empty?
               lines << line.chomp
             end
@@ -34,7 +34,7 @@ module Adhearsion
 
         def separate_pairs(lines)
           lines.inject({}) do |h,line|
-            returning h do |hash|
+            h.tap do |hash|
               k,v = line.split(/\s*:\s*/)
               hash[k] = URI.unescape(v).strip if k && v
             end

data/lib/adhearsion/voip/freeswitch/freeswitch_dialplan_command_factory.rb

@@ -84,7 +84,7 @@ module Adhearsion
             end
 
             rec_cmd = cmd "record", file, :on_keypress => dtmf_breaker
-            returning [] do |cmds|
+            [].tap do |cmds|
               cmds << play('beep') if hash[:beep]
               cmds << rec_cmd
               if hash[:timeout]
@@ -112,7 +112,7 @@ module Adhearsion
             digits << digit
             return! digits.to_s if number && digits.size >= number
           end
-          returning DSL::Dialplan::NoOpEventCommand.new do |command|
+          DSL::Dialplan::NoOpEventCommand.new.tap do |command|
             command.on_keypress &dtmf_hook
           end
         end

data/lib/adhearsion/voip/freeswitch/oes_server.rb

@@ -95,7 +95,7 @@ module Adhearsion
         end
 
         def rubyize_keys_for(hash)
-          returning({}) do |pretty|
+          {}.tap do |pretty|
             hash.each { |k,v| pretty[k.to_s.underscore] = v }
           end
         end

data/lib/adhearsion/voip/menu_state_machine/matchers.rb

@@ -79,7 +79,7 @@ module Adhearsion
       def numbers_in_range_like(num)
         return (pattern === 0 ? [0] : nil) if num == 0
         raise ArgumentError unless num.kind_of?(Numeric)
-        returning Array.new do |matches|
+        Array.new.tap do |matches|
           first, last = pattern.first, pattern.last
           power = 0
           while num < last

data/lib/adhearsion/voip/menu_state_machine/menu_builder.rb

@@ -46,7 +46,7 @@ module Adhearsion
       end
 
       def calculate_matches_for(result)
-        returning CalculatedMatchCollection.new do |collection|
+        CalculatedMatchCollection.new.tap do |collection|
           weighted_match_calculators.each do |pattern|
             collection << pattern.match(result)
           end

data/lib/theatre/callback_definition_loader.rb

@@ -61,7 +61,7 @@ module Theatre
 
     class BlankSlateMessageRecorder
 
-      (instance_methods - %w[__send__ __id__]).each { |m| undef_method m }
+      (instance_methods - %w{instance_eval object_id}).each { |method| undef_method method unless method =~ /^__/ }
 
       def initialize(&notify_on_completion)
         @notify_on_completion = notify_on_completion

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: adhearsion
 version: !ruby/object:Gem::Version 
-  hash: 51
+  hash: 23
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 8
-  - 6
-  version: 0.8.6
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Jay Phillips
@@ -17,57 +17,115 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-24 00:00:00 -04:00
+date: 2010-10-28 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rubigen
+  name: log4r
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 29
         segments: 
         - 1
         - 0
-        - 6
-        version: 1.0.6
+        - 5
+        version: 1.0.5
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: log4r
+  name: activesupport
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 29
+        hash: 11
         segments: 
+        - 2
         - 1
         - 0
-        - 5
-        version: 1.0.5
+        version: 2.1.0
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: rubigen
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 11
+        hash: 27
         segments: 
-        - 2
         - 1
         - 0
-        version: 2.1.0
-  type: :runtime
+        - 6
+        version: 1.0.6
+  type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: flexmock
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: active_record
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
 description: Adhearsion is an open-source telephony development framework
 email: dev&Adhearsion.com
 executables: 
@@ -140,6 +198,7 @@ files:
 - lib/adhearsion/initializer/xmpp.rb
 - lib/adhearsion/logging.rb
 - lib/adhearsion/tasks.rb
+- lib/adhearsion/tasks/components.rb
 - lib/adhearsion/tasks/database.rb
 - lib/adhearsion/tasks/deprecations.rb
 - lib/adhearsion/tasks/generating.rb
@@ -197,7 +256,7 @@ has_rdoc: true
 homepage: http://adhearsion.com
 licenses: []
 
-post_install_message: 
+post_install_message: "    *******************************************************************\n    * NOTE: You must manually install the \"rubigen\" gem to create     *\n    * new Adhearsion applications.                                    *\n    *                                                                 *\n    * The Rubigen package is no longer automatically installed due to *\n    * dependency conflicts with ActiveSupport 3.0.                    *\n    * Users of existing Adhearsion applications can safely ignore     *\n    * this message.                                                   *\n    *******************************************************************\n"
 rdoc_options: []
 
 require_paths: