ruby_ami 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb7606f130bf3753537649990fbc188a62b31441
-  data.tar.gz: eef9574ee77d8721fb9b480978595ec412a82857
+  metadata.gz: f5e6e035e1967a44a905b10ad704dbac564d4c90
+  data.tar.gz: 20f7fd7d4a8061c6e15dffa0b2f178645ef31b32
 SHA512:
-  metadata.gz: 29b7868e1c9e4a99babf6a169b97741b53ea05dfa5b8a0d31de0caa6e919912b8aab09863ec3c874c6e2fabec9e674789e9524212117a64c198b4b9799eba34e
-  data.tar.gz: 4213b880af9d91452b351b15ee5d55261e00954bacd79632f04467343e52371a1ee725d301216046d01ed83005b7f23e90eb8adce24ef63c94c9dce289be075e
+  metadata.gz: a5fafdd9ed56328ed906339a18d1ad8e3671985b6fd5a834ce9c6fe3d6e7ffccd7c44c2f0960d7f6f77358b3739ea6bb3e522f92191209e30b2ad12648cf0e7d
+  data.tar.gz: 0dc58ad3d2f2e3bf7e88fb66c43230d8c513bd61f7bdf7a196bd816e94fc78d7542b0eb55b26c154a7de6c26a56e4c881cd65ea52988192d5dd0d9e6d24be0f2

data/.gitignore

@@ -3,7 +3,6 @@
 Gemfile.lock
 pkg/*
 
-lib/ruby_ami/lexer.rb
 .rvmrc
 .yardoc
 doc

data/.travis.yml

@@ -5,6 +5,9 @@ rvm:
   - 2.0.0
   - jruby-19mode
   - rbx-19mode
-  - ruby-head
+  - ruby-head  
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
 notifications:
   irc: "irc.freenode.org#adhearsion"

data/CHANGELOG.md

@@ -1,11 +1,18 @@
 # [develop](https://github.com/adhearsion/ruby_ami)
 
+# [2.1.0](https://github.com/adhearsion/ruby_ami/compare/v2.0.0...v2.1.0) - [2013-05-29](https://rubygems.org/gems/ruby_ami/versions/2.1.0)
+  * Enhancement: Replace Ragel parser with pure Ruby version, which is much more performant and simpler
+  * Bugfix: Handle AGI 5xx responses
+
 # [2.0.0](https://github.com/adhearsion/ruby_ami/compare/v1.3.3...v2.0.0) - [2013-04-15](https://rubygems.org/gems/ruby_ami/versions/2.0.0)
   * Major refactoring for simplification and performance
   * Actions are no longer synchronised on the wire since ActionID is now a reliable method of response/event association
   * Callbacks are no longer required. #send_action now simply blocks waiting for a response
   * Client still starts up two Streams, one for actions and one for events, but only for possible performance gains. It is possible to use Stream directly since it now does its own login and response association. Client is a very thin routing layer. It's encouraged that if you expect low traffic, you should use Stream directly. Client may be removed in v3.0.
 
+# [1.3.4](https://github.com/adhearsion/ruby_ami/compare/v1.3.3...v1.3.4) - [2013-04-25](https://rubygems.org/gems/ruby_ami/versions/1.3.4)
+  * Bugfix: Handle AGI 5xx responses
+
 # [1.3.3](https://github.com/adhearsion/ruby_ami/compare/v1.3.2...v1.3.3) - [2013-04-09](https://rubygems.org/gems/ruby_ami/versions/1.3.3)
   * Bugfix: DBGet actions are now not terminated specially
 

data/Guardfile

@@ -1,9 +1,17 @@
-guard 'shell', :all_on_start => true do
-  watch("lib/ruby_ami/lexer_machine.rl") { `rake ragel` }
-end
-
-guard 'rspec', :version => 2, :cli => '--format documentation' do
+guard 'rspec', :cli => '--format documentation' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec/" }
 end
+
+guard 'cucumber', cli: '--profile default --color --format progress' do
+  watch("lib/ruby_ami/lexer.rb")                        { 'features' }
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})                      { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end
+
+guard 'rake', task: 'benchmark' do
+  watch("lib/ruby_ami/lexer.rb")
+  watch(/benchmarks\/*/)
+end

data/README.md

@@ -31,22 +31,6 @@ client.start
 Celluloid::Actor.join client
 ```
 
-## Development Requirements
-
-ruby_ami uses [ragel](http://www.complang.org/ragel/) to generate some of it's files.
-
-On OS X (if you use homebrew):
-
-    brew install ragel
-
-On Linux:
-
-    apt-get install ragel OR yum install ragel
-
-Once you are inside the repository, before anything else, you will want to run:
-
-    rake ragel
-
 ## Links:
 * [Source](https://github.com/adhearsion/ruby_ami)
 * [Documentation](http://rdoc.info/github/adhearsion/ruby_ami/master/frames)

data/Rakefile

@@ -17,37 +17,22 @@ Cucumber::Rake::Task.new(:wip) do |t|
   t.cucumber_opts = %w{-p wip}
 end
 
-task :default => [:ragel, :spec, :features]
-
-require 'yard'
-YARD::Rake::YardocTask.new
-
-desc "Check Ragel version"
-task :check_ragel_version do
-  ragel_version_match = `ragel --version`.match /(\d)\.(\d)+/
-  abort "Could not get Ragel version! Is it installed? You must have at least version 6.7" unless ragel_version_match
-  big, small = ragel_version_match.captures.map &:to_i
-  puts "You're using Ragel v#{ragel_version_match[0]}"
-  if big < 6 || big == 6 && small < 7
-    abort "Please upgrade Ragel! v6.7 or later is required"
+task :default => [:spec, :features]
+require 'timeout'
+desc "Run benchmarks"
+task :benchmark do
+  begin
+    Timeout.timeout(120) do
+      glob = File.expand_path("../benchmarks/*.rb", __FILE__)
+      Dir[glob].each { |benchmark| load benchmark }
+    end
+  rescue Exception, Timeout::Error => ex
+    puts "ERROR: Couldn't complete benchmark: #{ex.class}: #{ex}"
+    puts "  #{ex.backtrace.join("\n  ")}"
+
+    exit 1 unless ENV['CI'] # Hax for running benchmarks on Travis
   end
 end
 
-desc "Used to regenerate the AMI source code files. Note: requires Ragel 6.3 or later be installed on your system"
-task :ragel => :check_ragel_version do
-  run_ragel '-n -R'
-end
-
-desc "Generates a GraphVis document showing the Ragel state machine"
-task :visualize_ragel => :check_ragel_version do
-  run_ragel '-V', 'dot'
-end
-
-def run_ragel(options = nil, extension = 'rb')
-  ragel_file = 'lib/ruby_ami/lexer.rl.rb'
-  base_file = ragel_file.sub ".rl.rb", ""
-  command = ["ragel", options, "#{ragel_file} -o #{base_file}.#{extension} 2>&1"].compact.join ' '
-  puts "Running command '#{command}'"
-  puts `#{command}`
-  raise "Failed generating code from Ragel file #{ragel_file}" if $?.to_i.nonzero?
-end
+require 'yard'
+YARD::Rake::YardocTask.new

data/benchmarks/lexer.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+require 'ruby_ami'
+require 'benchmark/ips'
+
+class LexerHost
+  def initialize
+    @lexer = RubyAMI::Lexer.new self
+  end
+
+  def receive_data(data)
+    @lexer << data
+  end
+
+  def message_received(message)
+  end
+
+  def error_received(error)
+  end
+
+  def syntax_error_encountered(ignored_chunk)
+  end
+end
+
+lexer_host = LexerHost.new
+
+event = <<-EVENT
+Event: Dial
+SubEvent: <value>
+Channel: <value>
+Destination: <value>
+CallerIDNum: <value>
+CallerIDName: <value>
+ConnectedLineNum: <value>
+ConnectedLineName: <value>
+UniqueID: <value>
+DestUniqueID: <value>
+Dialstring: <value>
+
+EVENT
+event.gsub!("\n", "\r\n")
+
+Benchmark.ips do |ips|
+  ips.report("event lexing") { lexer_host.receive_data event }
+end

data/features/lexer.feature

@@ -7,8 +7,6 @@ Feature: Lexing AMI
     Given a new lexer
     And a version header for AMI 1.0
 
-    When the buffer is lexed
-
     Then the protocol should have lexed without syntax errors
     And the version should be set to 1.0
 
@@ -17,28 +15,22 @@ Feature: Lexing AMI
     And a version header for AMI 1.0
     And a normal login success with events
 
-    When the buffer is lexed
-
     Then the protocol should have lexed without syntax errors
     And 1 message should have been received
 
   Scenario: Lexing the initial AMI header and then a Response:Follows section
     Given a new lexer
     And a version header for AMI 1.0
-    And a multi-line Response:Follows body of ragel_description
-
-    When the buffer is lexed
+    And a multi-line Response:Follows body of show_channels_from_wayne
 
     Then the protocol should have lexed without syntax errors
-    And the 'follows' body of 1 message received should equal ragel_description
+    And the 'follows' body of 1 message received should equal show_channels_from_wayne
 
   Scenario: Lexing a Response:Follows section with no body
     Given a new lexer
     And a version header for AMI 1.0
     And a multi-line Response:Follows body of empty_String
 
-    When the buffer is lexed
-
     Then the protocol should have lexed without syntax errors
     And the 'follows' body of 1 message received should equal empty_string
 
@@ -47,8 +39,6 @@ Feature: Lexing AMI
     And a version header for AMI 1.0
     Given a multi-line Response:Follows body of show_channels_from_wayne
 
-    When the buffer is lexed
-
     Then the protocol should have lexed without syntax errors
     And the 'follows' body of 1 message received should equal show_channels_from_wayne
 
@@ -57,8 +47,6 @@ Feature: Lexing AMI
     And a version header for AMI 1.0
     Given a multi-line Response:Follows response simulating uptime
 
-    When the buffer is lexed
-
     Then the protocol should have lexed without syntax errors
     And the first message received should have a key "System uptime" with value "46 minutes, 30 seconds"
 
@@ -66,8 +54,6 @@ Feature: Lexing AMI
     Given a new lexer
     And a multi-line Response:Follows body of with_colon_after_first_line
 
-    When the buffer is lexed
-
     Then the protocol should have lexed without syntax errors
     And 1 message should have been received
     And the 'follows' body of 1 message received should equal with_colon_after_first_line
@@ -77,8 +63,6 @@ Feature: Lexing AMI
     Given a new lexer
     And an immediate response with text "markq        has 0 calls (max unlimited) in 'ringall' strategy (0s holdtime), W:0, C:0, A:0, SL:0.0% within 0s\r\n   No Members\r\n   No Callers\r\n\r\n\r\n\r\n"
 
-    When the buffer is lexed
-
     Then the protocol should have lexed without syntax errors
     And 1 message should have been received
     And 1 message should be an immediate response with text "markq        has 0 calls (max unlimited) in 'ringall' strategy (0s holdtime), W:0, C:0, A:0, SL:0.0% within 0s\r\n   No Members\r\n   No Callers"
@@ -88,27 +72,21 @@ Feature: Lexing AMI
     And a version header for AMI 1.0
     And an Authentication Required error
 
-    When the buffer is lexed
-
     Then the protocol should have lexed without syntax errors
 
   Scenario: Lexing the initial AMI header and then a Response:Follows section
     Given a new lexer
     And a version header for AMI 1.0
-    And a multi-line Response:Follows body of ragel_description
-    And a multi-line Response:Follows body of ragel_description
-
-    When the buffer is lexed
+    And a multi-line Response:Follows body of show_channels_from_wayne
+    And a multi-line Response:Follows body of show_channels_from_wayne
 
     Then the protocol should have lexed without syntax errors
-    And the 'follows' body of 2 messages received should equal ragel_description
+    And the 'follows' body of 2 messages received should equal show_channels_from_wayne
 
   Scenario: Lexing a stanza without receiving an AMI header
     Given a new lexer
     And a normal login success with events
 
-    When the buffer is lexed
-
     Then the protocol should have lexed without syntax errors
     And 1 message should have been received
 
@@ -116,8 +94,6 @@ Feature: Lexing AMI
     Given a new lexer
     And an immediate response with text "Immediate responses are so ridiculous"
 
-    When the buffer is lexed
-
     Then the protocol should have lexed without syntax errors
     And 1 message should have been received
     And 1 message should be an immediate response with text "Immediate responses are so ridiculous"
@@ -128,8 +104,6 @@ Feature: Lexing AMI
     And an immediate response with text "No queues have been created."
     And a normal login success with events
 
-    When the buffer is lexed
-
     Then the protocol should have lexed without syntax errors
     And 3 messages should have been received
     And 1 message should be an immediate response with text "No queues have been created."
@@ -140,8 +114,6 @@ Feature: Lexing AMI
     And a normal login success with events
     And a Pong response with an ActionID of randomness
 
-    When the buffer is lexed
-
     Then the protocol should have lexed without syntax errors
     And 2 messages should have been received
 
@@ -150,8 +122,6 @@ Feature: Lexing AMI
     And 5 Pong responses without an ActionID
     And 5 Pong responses with an ActionID of randomness
 
-    When the buffer is lexed
-
     Then the protocol should have lexed without syntax errors
     And 10 messages should have been received
 
@@ -159,8 +129,6 @@ Feature: Lexing AMI
     Given a new lexer
     And a Pong response with an ActionID of 1224469850.61673
 
-    When the buffer is lexed
-
     Then the first message received should have a key "ActionID" with value "1224469850.61673"
 
   Scenario: A response containing a floating point value
@@ -170,7 +138,6 @@ Feature: Lexing AMI
     And the custom stanza named "call" has key "Uniqueid" with value "1173223225.10309"
 
     When the custom stanza named "call" is added to the buffer
-    And the buffer is lexed
 
     Then the 1st message received should have a key "Uniqueid" with value "1173223225.10309"
 
@@ -186,7 +153,6 @@ Feature: Lexing AMI
     And the custom stanza named "person" has key "I have spaces" with value "i have trailing padding   "
 
     When the custom stanza named "person" is added to the buffer
-    And the buffer is lexed
 
     Then the protocol should have lexed without syntax errors
     And the first message received should have a key "Name" with value "Jay Phillips"
@@ -202,8 +168,6 @@ Feature: Lexing AMI
     Given a new lexer
     And a normal login success with events split into two pieces
 
-    When the buffer is lexed
-
     Then the protocol should have lexed without syntax errors
     And 1 message should have been received
 
@@ -212,8 +176,6 @@ Feature: Lexing AMI
     And an AMI error whose message is "Missing action in request"
     And a normal login success with events
 
-    When the buffer is lexed
-
     Then the protocol should have lexed without syntax errors
     And 1 AMI error should have been received
     And the 1st AMI error should have the message "Missing action in request"
@@ -225,8 +187,6 @@ Feature: Lexing AMI
     And an immediate response with text "Yes, plain English is sent sometimes over AMI."
     And a normal login success with events
 
-    When the buffer is lexed
-
     Then the protocol should have lexed without syntax errors
     And 3 messages should have been received
     And 1 message should be an immediate response with text "Yes, plain English is sent sometimes over AMI."
@@ -239,7 +199,6 @@ Feature: Lexing AMI
     And a custom header for event identified by "this_event" whose key is "AppData" and value is "agi://localhost"
 
     When the custom event identified by "this_event" is added to the buffer
-    And the buffer is lexed
 
     Then the protocol should have lexed without syntax errors
     And 1 event should have been received
@@ -253,8 +212,6 @@ Feature: Lexing AMI
     And syntactically invalid immediate_packet_with_colon
     And a stanza break
 
-    When the buffer is lexed
-
     Then 0 messages should have been received
     And the protocol should have lexed with 1 syntax error
     And the syntax error fixture named immediate_packet_with_colon should have been encountered

data/features/step_definitions/lexer_steps.rb

@@ -123,10 +123,6 @@ When 'the custom event identified by "$identifier" is added to the buffer' do |i
   @lexer << stringified_event
 end
 
-When "the buffer is lexed" do
-  @lexer.resume!
-end
-
 ########################################
 #### THEN
 ########################################
@@ -160,7 +156,7 @@ Then /^the 'follows' body of (\d+) messages? received should equal (\w+)$/ do |n
 end
 
 Then "the version should be set to $version" do |version|
-  @lexer.ami_version.should eql(version.to_f)
+  @lexer.ami_version.should eql(version)
 end
 
 Then /^the ([\w\d]*) message received should have a key "([^\"]*)" with value "([^\"]*)"$/ do |ordered,key,value|

data/features/support/lexer_helper.rb

@@ -93,11 +93,6 @@ end
 
 def follows_body_text(name)
   case name
-    when "ragel_description"
-      "Ragel is a software development tool that allows user actions to
-      be embedded into the transitions of a regular expression's corresponding state machine,
-      eliminating the need to switch from the regular expression engine and user code execution
-      environment and back again."
     when "with_colon_after_first_line"
       "Host                            Username       Refresh State                Reg.Time                 \r\nlax.teliax.net:5060             jicksta            105 Registered           Tue, 11 Nov 2008 02:29:55"
     when "show_channels_from_wayne"

data/lib/ruby_ami/agi_result_parser.rb

@@ -4,7 +4,7 @@ module RubyAMI
   class AGIResultParser
     attr_reader :code, :result, :data
 
-    FORMAT          = /^(?<code>\d{3}) result=(?<result>-?\d*) ?(?<data>\(?.*\)?)?$/.freeze
+    FORMAT          = /^(?<code>\d{3})( result=(?<result>-?\d*))? ?(?<data>\(?.*\)?)?$/.freeze
     DATA_KV_FORMAT  = /(?<key>[\w\d]+)=(?<value>[\w\d]*)/.freeze
     DATA_CLEANER    = /(^\()|(\)$)/.freeze
 
@@ -31,7 +31,7 @@ module RubyAMI
 
     def parse
       @code = match[:code].to_i
-      @result = match[:result].to_i
+      @result = match[:result] ? match[:result].to_i : nil
       @data = match[:data] ? match[:data].gsub(DATA_CLEANER, '').freeze : nil
     end
 

data/lib/ruby_ami/error.rb

@@ -12,6 +12,7 @@ module RubyAMI
     end
 
     def []=(key,value)
+      self.message = value if key == 'Message'
       @headers[key] = value
     end
 

data/lib/ruby_ami/lexer.rb

@@ -0,0 +1,148 @@
+# encoding: utf-8
+
+module RubyAMI
+  class Lexer
+    STANZA_BREAK      = "\r\n\r\n"
+    PROMPT            = /Asterisk Call Manager\/(\d+\.\d+)\r\n/
+    KEYVALUEPAIR      = /^([[[:alnum:]]-_ ]+): *(.*)\r\n/
+    FOLLOWSDELIMITER  = /\r?\n?--END COMMAND--\r\n\r\n/
+    SUCCESS           = /response: *success/i
+    PONG              = /response: *pong/i
+    EVENT             = /event: *(?<event_name>.*)?/i
+    ERROR             = /response: *error/i
+    FOLLOWS           = /response: *follows/i
+    SCANNER           = /.*?#{STANZA_BREAK}/m
+    HEADER_SLICE      = /.*\r\n/
+    IMMEDIATE_RESP    = /.*/
+    CLASSIFIER        = /((?<event>#{EVENT})|(?<success>#{SUCCESS})|(?<pong>#{PONG})|(?<follows>#{FOLLOWS})|(?<error>#{ERROR})|(?<immediate>#{IMMEDIATE_RESP})\r\n)\r\n/i
+
+    attr_accessor :ami_version
+
+    def initialize(delegate = nil)
+      @delegate = delegate
+      @buffer = ""
+      @ami_version = nil
+    end
+
+    def <<(new_data)
+      @buffer << new_data
+      parse_buffer
+    end
+
+    private
+
+    def parse_buffer
+      # Special case for the protocol header
+      if @buffer =~ PROMPT
+        @ami_version = $1
+        @buffer.slice! HEADER_SLICE
+      end
+
+      # We need at least one complete message before parsing
+      return unless @buffer.include?(STANZA_BREAK)
+
+      @processed = 0
+
+      response_follows_message = false
+      current_message = nil
+      @buffer.scan(SCANNER).each do |raw|
+        if response_follows_message
+          if handle_response_follows(response_follows_message, raw)
+            @processed += raw.length
+            message_received response_follows_message
+            response_follows_message = nil
+          end
+        else
+          response_follows_message = parse_message raw
+        end
+      end
+      @buffer.slice! 0, @processed
+    end
+
+    def parse_message(raw)
+      return if raw.length == 0
+
+      # Mark this message as processed, including the 4 stripped cr/lf bytes
+      @processed += raw.length
+
+      match = raw.match CLASSIFIER
+
+      msg = if match[:event]
+        Event.new match[:event_name]
+      elsif match[:success] || match[:pong]
+        Response.new
+      elsif match[:follows]
+        response_follows = true
+        Response.new
+      elsif match[:error]
+        Error.new
+      elsif match[:immediate]
+        if raw.include?(':')
+          syntax_error_encountered raw.chomp(STANZA_BREAK)
+          return
+        end
+        immediate_response = true
+        Response.from_immediate_response match[:immediate]
+      end
+
+      # Strip off the header line
+      raw.slice! HEADER_SLICE
+      populate_message_body msg, raw
+
+      return msg if response_follows && !handle_response_follows(msg, raw)
+
+      case msg
+      when Error
+        error_received msg
+      else
+        message_received msg
+      end
+
+      nil
+    end
+
+    ##
+    # Called after a response or event has been successfully parsed.
+    #
+    # @param [Response, Event] message The message just received
+    #
+    def message_received(message)
+      @delegate.message_received message
+    end
+
+    ##
+    # Called after an AMI error has been successfully parsed.
+    #
+    # @param [Response, Event] message The message just received
+    #
+    def error_received(message)
+      @delegate.error_received message
+    end
+
+    ##
+    # Called when there's a syntax error on the socket. This doesn't happen as often as it should because, in many cases,
+    # it's impossible to distinguish between a syntax error and an immediate packet.
+    #
+    # @param [String] ignored_chunk The offending text which caused the syntax error.
+    def syntax_error_encountered(ignored_chunk)
+      @delegate.syntax_error_encountered ignored_chunk
+    end
+
+    def populate_message_body(obj, raw)
+      while raw.slice! KEYVALUEPAIR
+        obj[$1] = $2
+      end
+      obj
+    end
+
+    def handle_response_follows(obj, raw)
+      obj.text_body ||= ''
+      obj.text_body << raw
+      return false unless raw =~ FOLLOWSDELIMITER
+      obj.text_body.sub! FOLLOWSDELIMITER, ''
+      obj.text_body.chomp!
+      true
+    end
+  end
+end
+

data/lib/ruby_ami/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module RubyAMI
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/ruby_ami.gemspec

@@ -5,11 +5,11 @@ require "ruby_ami/version"
 Gem::Specification.new do |s|
   s.name        = "ruby_ami"
   s.version     = RubyAMI::VERSION
-  s.authors     = ["Ben Langfeld"]
-  s.email       = ["ben@langfeld.me"]
+  s.authors     = ["Ben Langfeld", "Ben Klang"]
+  s.email       = ["ben@langfeld.me", "bklang@mojolingo.com"]
   s.homepage    = ""
   s.summary     = %q{Futzing with AMI so you don't have to}
-  s.description = %q{A Ruby client library for the Asterisk Management Interface build on eventmachine.}
+  s.description = %q{A Ruby client library for the Asterisk Management Interface built on Celluloid IO.}
 
   s.rubyforge_project = "ruby_ami"
 
@@ -27,5 +27,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency %q<rake>, [">= 0"]
   s.add_development_dependency %q<guard-rspec>
   s.add_development_dependency %q<guard-shell>
-  s.add_development_dependency %q<ruby_gntp>
+  s.add_development_dependency %q<guard-cucumber>
+  s.add_development_dependency %q<guard-rake>
+  s.add_development_dependency %q<benchmark_suite>
 end

data/spec/ruby_ami/agi_result_parser_spec.rb

@@ -48,5 +48,14 @@ module RubyAMI
       its(:data)      { should == 'foo=bar' }
       its(:data_hash) { should == {'foo' => 'bar'} }
     end
+
+    context 'with a 5xx error' do
+      let(:result_string) { "510%20Invalid%20or%20unknown%20command%0A" }
+
+      its(:code)      { should == 510 }
+      its(:result)    { should be_nil }
+      its(:data)      { should == 'Invalid or unknown command' }
+      its(:data_hash) { should be_nil }
+    end
   end
 end

data/spec/ruby_ami/stream_spec.rb

@@ -98,6 +98,32 @@ Message: Recording started
         end
       end
 
+      it "can process an action with a Response: Follows result" do
+        action_id = RubyAMI.new_uuid
+        response = nil
+        mocked_server(1, lambda { response = @stream.send_action('Command', 'Command' => 'dialplan add extension 1,1,AGI,agi:async into adhearsion-redirect') }) do |val, server|
+          val.should == <<-ACTION
+Action: command\r
+ActionID: #{action_id}\r
+Command: dialplan add extension 1,1,AGI,agi:async into adhearsion-redirect\r
+\r
+          ACTION
+
+          server.send_data <<-EVENT
+Response: Follows
+Privilege: Command
+ActionID: #{action_id}
+Extension '1,1,AGI(agi:async)' added into 'adhearsion-redirect' context
+--END COMMAND--
+
+          EVENT
+        end
+
+        expected_response = Response.new 'Privilege' => 'Command', 'ActionID' => action_id
+        expected_response.text_body = %q{Extension '1,1,AGI(agi:async)' added into 'adhearsion-redirect' context}
+        response.should == expected_response
+      end
+
       context "with a username and password set" do
         let(:username) { 'fred' }
         let(:password) { 'jones' }

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ruby_ami
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Ben Langfeld
+- Ben Klang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-15 00:00:00.000000000 Z
+date: 2013-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid-io
@@ -123,7 +124,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby_gntp
+  name: guard-cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -136,10 +137,39 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A Ruby client library for the Asterisk Management Interface build on
-  eventmachine.
+- !ruby/object:Gem::Dependency
+  name: guard-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark_suite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby client library for the Asterisk Management Interface built on
+  Celluloid IO.
 email:
 - ben@langfeld.me
+- bklang@mojolingo.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -153,6 +183,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks/lexer.rb
 - cucumber.yml
 - features/lexer.feature
 - features/step_definitions/lexer_steps.rb
@@ -168,8 +199,7 @@ files:
 - lib/ruby_ami/core_ext/celluloid.rb
 - lib/ruby_ami/error.rb
 - lib/ruby_ami/event.rb
-- lib/ruby_ami/lexer.rl.rb
-- lib/ruby_ami/lexer_machine.rl
+- lib/ruby_ami/lexer.rb
 - lib/ruby_ami/response.rb
 - lib/ruby_ami/stream.rb
 - lib/ruby_ami/version.rb
@@ -184,7 +214,6 @@ files:
 - spec/ruby_ami/stream_spec.rb
 - spec/spec_helper.rb
 - spec/support/mock_server.rb
-- lib/ruby_ami/lexer.rb
 homepage: ''
 licenses: []
 metadata: {}
@@ -204,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ruby_ami
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Futzing with AMI so you don't have to

data/lib/ruby_ami/lexer.rl.rb

@@ -1,304 +0,0 @@
-# encoding: utf-8
-module RubyAMI
-  class Lexer
-
-    KILOBYTE = 1024
-    BUFFER_SIZE = 128 * KILOBYTE 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 "Response: Success" or "Response: Pong"
-      action init_success { init_success }
-
-      action init_response_follows { init_response_follows }
-
-      action init_error { init_error }
-
-      action message_received { message_received @current_message }
-      action error_received   {   error_received @current_message }
-
-      action version_starts { version_starts }
-      action version_stops  { version_stops  }
-
-      action key_starts { key_starts }
-      action key_stops  { key_stops  }
-
-      action value_starts { value_starts }
-      action value_stops  { value_stops  }
-
-      action error_reason_starts { error_reason_starts }
-      action error_reason_stops  { error_reason_stops  }
-
-      action syntax_error_starts { syntax_error_starts }
-      action syntax_error_stops  { syntax_error_stops  }
-
-      action immediate_response_starts { immediate_response_starts }
-      action immediate_response_stops  { immediate_response_stops  }
-
-      action follows_text_starts { follows_text_starts }
-      action follows_text_stops  { follows_text_stops  }
-
-      action event_name_starts { event_name_starts }
-      action event_name_stops  { event_name_stops  }
-
-      include ami_protocol_parser_machine "lexer_machine.rl";
-
-    }%%##
-
-    attr_accessor :ami_version
-
-    def initialize(delegate = nil)
-      @delegate = delegate
-      @data = ''.force_encoding('ISO-8859-1')
-      @current_pointer = 0
-      @ragel_stack = []
-      @ami_version = 0.0
-
-      %%{
-        # All other variables become local, letting Ruby garbage collect them. This
-        # prevents us from having to manually reset them.
-
-        variable data  @data;
-        variable p     @current_pointer;
-        variable pe    @data_ending_pointer;
-        variable cs    @current_state;
-        variable ts    @token_start;
-        variable te    @token_end;
-        variable act   @ragel_act;
-        variable eof   @eof;
-        variable stack @ragel_stack;
-        variable top   @ragel_stack_top;
-
-        write data;
-        write init;
-      }%%##
-    end
-
-    def <<(new_data)
-      extend_buffer_with new_data
-      resume!
-    end
-
-    def resume!
-      %%{ write exec; }%%##
-    end
-
-    def extend_buffer_with(new_data)
-      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.force_encoding('ISO-8859-1')
-      @data_ending_pointer = @data.size
-    end
-
-    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.
-    #
-    # @param [Response, Event] message The message just received
-    #
-    def message_received(message)
-      @delegate.message_received message
-    end
-
-    ##
-    # Called when there is an Error: stanza on the socket. Could be caused by executing an unrecognized command, trying
-    # to originate into an invalid priority, etc. Note: many errors' responses are actually tightly coupled to a
-    # Event which comes directly after it. Often the message will say something like "Channel status
-    # will follow".
-    #
-    # @param [String] reason The reason given in the Message: header for the error stanza.
-    #
-    def error_received(message)
-      @delegate.error_received message
-    end
-
-    ##
-    # Called when there's a syntax error on the socket. This doesn't happen as often as it should because, in many cases,
-    # it's impossible to distinguish between a syntax error and an immediate packet.
-    #
-    # @param [String] ignored_chunk The offending text which caused the syntax error.
-    def syntax_error_encountered(ignored_chunk)
-      @delegate.syntax_error_encountered ignored_chunk
-    end
-
-    def init_success
-      @current_message = Response.new
-    end
-
-    def init_response_follows
-      @current_message = Response.new
-    end
-
-    def init_error
-      @current_message = Error.new
-    end
-
-    def version_starts
-      @version_start = @current_pointer
-    end
-
-    def version_stops
-      self.ami_version = @data[@version_start...@current_pointer].to_f
-      @version_start = nil
-    end
-
-    def event_name_starts
-      @event_name_start = @current_pointer
-    end
-
-    def event_name_stops
-      event_name = @data[@event_name_start...@current_pointer]
-      @event_name_start = nil
-      @current_message = Event.new(event_name)
-    end
-
-    def key_starts
-      @current_key_position = @current_pointer
-    end
-
-    def key_stops
-      @current_key = @data[@current_key_position...@current_pointer]
-    end
-
-    def value_starts
-      @current_value_position = @current_pointer
-    end
-
-    def value_stops
-      @current_value = @data[@current_value_position...@current_pointer]
-      @last_seen_value_end = @current_pointer + 2 # 2 for \r\n
-      add_pair_to_current_message
-    end
-
-    def error_reason_starts
-      @error_reason_start = @current_pointer
-    end
-
-    def error_reason_stops
-      @current_message.message = @data[@error_reason_start...@current_pointer]
-    end
-
-    def follows_text_starts
-      @follows_text_start = @current_pointer
-    end
-
-    def follows_text_stops
-      text = @data[@last_seen_value_end..@current_pointer]
-      text.sub! /\r?\n--END COMMAND--/, ""
-      @current_message.text_body = text
-      @follows_text_start = nil
-    end
-
-    def add_pair_to_current_message
-      @current_message[@current_key] = @current_value
-      reset_key_and_value_positions
-    end
-
-    def reset_key_and_value_positions
-      @current_key, @current_value, @current_key_position, @current_value_position = nil
-    end
-
-    def syntax_error_starts
-      @current_syntax_error_start = @current_pointer # Adding 1 since the pointer is still set to the last successful match
-    end
-
-    def syntax_error_stops
-      # Subtracting 3 from @current_pointer below for "\r\n" which separates a stanza
-      offending_data = @data[@current_syntax_error_start...@current_pointer - 1]
-      syntax_error_encountered offending_data
-      @current_syntax_error_start = nil
-    end
-
-    def immediate_response_starts
-      @immediate_response_start = @current_pointer
-    end
-
-    def immediate_response_stops
-      message = @data[@immediate_response_start...(@current_pointer -1)]
-      message_received Response.from_immediate_response(message)
-    end
-
-    ##
-    # This method is used primarily in debugging.
-    #
-    def view_buffer(message = nil)
-      message ||= "Viewing the buffer"
-
-      buffer = @data.clone
-      buffer.insert(@current_pointer, "\033[0;31m\033[1;31m^\033[0m")
-
-      buffer.gsub!("\r", "\\\\r")
-      buffer.gsub!("\n", "\\n\n")
-
-      puts <<-INSPECTION
-VVVVVVVVVVVVVVVVVVVVVVVVVVVVV
-####  #{message}
-#############################
-#{buffer}
-#############################
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-      INSPECTION
-    end
-  end
-end

data/lib/ruby_ami/lexer_machine.rl

@@ -1,87 +0,0 @@
-%%{ #%
-
-#########
-## This file is written with the Ragel programming language and parses the Asterisk Manager Interface protocol. It depends
-## upon Ragel actions which should be implemented in another Ragel-parsed file which includes this file.
-##
-## Ragel was used because the AMI protocol is extremely non-deterministic and, in the edge cases, requires something both
-## very robust and something which can recover from syntax errors.
-##
-## Note: This file is language agnostic. From this AMI parsers in many other languages can be generated.
-#########
-
-machine ami_protocol_parser_machine;
-
-cr = "\r";              # A carriage return. Used before (almost) every newline character.
-lf = "\n";              # Newline. Used (with cr) to separate key/value pairs and stanzas.
-crlf = cr lf;           # Means "carriage return and line feed". Used to separate key/value pairs and stanzas
-loose_newline = cr? lf; # Used sometimes when the AMI protocol is nondeterministic about the delimiter
-
-white = [\t ];                 # Single whitespace character, either a tab or a space
-colon = ":" [ ]**;             # Separates keys from values. "A colon followed by any number of spaces"
-stanza_break = crlf crlf;      # The seperator between two stanzas.
-rest_of_line = (any* -- crlf); # Match all characters until the next line seperator.
-
-Prompt = "Asterisk Call Manager/" digit+ >version_starts "." digit+ %version_stops crlf;
-
-Key = ((alnum | print) -- (cr | lf | ":"))+;
-KeyValuePair = Key >key_starts %key_stops colon rest_of_line >value_starts %value_stops crlf;
-
-FollowsDelimiter = loose_newline "--END COMMAND--";
-
-Response = "Response"i colon;
-
-Success  = Response "Success"i %init_success crlf @{ fgoto success; };
-Pong     = Response "Pong"i %init_success crlf @{ fgoto success; };
-Event    = "Event"i colon %event_name_starts rest_of_line %event_name_stops crlf @{ fgoto success; };
-Error    = Response "Error"i %init_error crlf (("Message"i colon rest_of_line >error_reason_starts crlf >error_reason_stops) | KeyValuePair)+ crlf @error_received;
-Follows  = Response "Follows"i crlf @init_response_follows @{ fgoto response_follows; };
-
-# For "Response: Follows"
-FollowsBody = (any* -- FollowsDelimiter) >follows_text_starts FollowsDelimiter @follows_text_stops crlf;
-
-ImmediateResponse = (any+ -- (loose_newline | ":")) >immediate_response_starts loose_newline @immediate_response_stops @{fret;};
-SyntaxError       = (any+ -- crlf) >syntax_error_starts crlf @syntax_error_stops;
-
-irregularity := |*
-  ImmediateResponse; # Performs the fret in the ImmediateResponse FSM
-  SyntaxError       => { fret; };
-*|;
-
-# When a new socket is established, Asterisk will send the version of the protocol per the Prompt machine. Because it's
-# tedious for unit tests to always send this, we'll put some intelligence into this parser to support going straight into
-# the protocol-parsing machine. It's also conceivable that a variant of AMI would not send this initial information.
-main := |*
-  Prompt => { fgoto protocol; };
-  any => {
-    # If this scanner's look-ahead capability didn't match the prompt, let's ignore the need for a prompt
-    fhold;
-    fgoto protocol;
-  };
-*|;
-
-protocol := |*
-  Prompt;
-  Success;
-  Pong;
-  Event;
-  Error;
-  Follows crlf;
-  crlf => { fgoto protocol; }; # If we get a crlf out of place, let's just ignore it.
-  any  => {
-    # If NONE of the above patterns match, we consider this a syntax error. The irregularity machine can recover gracefully.
-    fhold;
-    fcall irregularity;
-  };
-*|;
-
-success := KeyValuePair* crlf @message_received @{fgoto protocol;};
-
-# For the "Response: Follows" protocol abnormality. What happens if there's a protocol irregularity in this state???
-response_follows := |*
-    KeyValuePair+;
-    FollowsBody;
-    crlf @{ message_received @current_message; fgoto protocol; };
-*|;
-
-}%%