ruby_ami 1.1.2 → 1.2.0

data/.travis.yml

@@ -4,7 +4,7 @@ rvm:
   - 1.9.3
   - jruby-19mode
   # - rbx-19mode
-  - ruby-head
+  # - ruby-head
 before_install:
   - wget http://ftp.us.debian.org/debian/pool/main/r/ragel/ragel_6.7-1.1_i386.deb
   - sudo dpkg -i ragel_6.7-1.1_i386.deb

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # [develop](https://github.com/adhearsion/ruby_ami)
 
+# [1.2.0](https://github.com/adhearsion/ruby_ami/compare/v1.1.2...v1.2.0) - [2012-07-18](https://rubygems.org/gems/ruby_ami/versions/1.2.0)
+  * Feature: Added parsers for (Async)AGI environment and result strings
+  * Bugfix: Avoid a race condition in stream establishment and event receipt
+  * Bugfix: If socket creation fails, log an appropriate error
+
 # [1.1.2](https://github.com/adhearsion/ruby_ami/compare/v1.1.1...v1.1.2) - [2012-07-04](https://rubygems.org/gems/ruby_ami/versions/1.1.2)
   * Bugfix: Avoid recursive stream stopping
 

data/lib/ruby_ami/agi_result_parser.rb

@@ -0,0 +1,42 @@
+require 'cgi'
+
+module RubyAMI
+  class AGIResultParser
+    attr_reader :code, :result, :data
+
+    FORMAT          = /^(\d{3}) result=(-?\d*) ?(\(?.*\)?)?$/.freeze
+    DATA_KV_FORMAT  = /([\w\d]+)=([\w\d]*)/.freeze
+    DATA_CLEANER    = /(^\()|(\)$)/.freeze
+
+    def initialize(result_string)
+      @result_string = result_string.dup
+      raise ArgumentError, "The result string did not match the required format." unless match
+      parse
+    end
+
+    def data_hash
+      return unless data_kv_match
+      {data_kv_match[1] => data_kv_match[2]}
+    end
+
+    private
+
+    def unescape
+      CGI.unescape @result_string
+    end
+
+    def match
+      @match ||= unescape.chomp.match(FORMAT)
+    end
+
+    def parse
+      @code = match[1].to_i
+      @result = match[2].to_i
+      @data = match[3] ? match[3].gsub(DATA_CLEANER, '').freeze : nil
+    end
+
+    def data_kv_match
+      @data_kv_match ||= data.match(DATA_KV_FORMAT)
+    end
+  end
+end

data/lib/ruby_ami/async_agi_environment_parser.rb

@@ -0,0 +1,26 @@
+require 'cgi'
+
+module RubyAMI
+  class AsyncAGIEnvironmentParser
+    def initialize(environment_string)
+      @environment_string = environment_string.dup
+    end
+
+    def to_hash
+      to_array.inject({}) do |accumulator, element|
+        accumulator[element[0].to_sym] = element[1] || ''
+        accumulator
+      end
+    end
+
+    def to_s
+      @environment_string.dup
+    end
+
+    private
+
+    def to_array
+      CGI.unescape(@environment_string).split("\n").map { |p| p.split ': ' }
+    end
+  end
+end

data/lib/ruby_ami/client.rb

@@ -41,8 +41,9 @@ module RubyAMI
     end
 
     def start
-      @events_stream  = start_stream lambda { |event| @event_processor << event }
-      @actions_stream = start_stream lambda { |message| @message_processor << message }
+      @events_stream  = new_stream lambda { |event| @event_processor << event }
+      @actions_stream = new_stream lambda { |message| @message_processor << message }
+      streams.each(&:run!)
       @state = :started
       streams.each(&:join)
     end
@@ -178,7 +179,7 @@ module RubyAMI
                  &block
     end
 
-    def start_stream(callback)
+    def new_stream(callback)
       Stream.new @options[:host], @options[:port], callback
     end
 

data/lib/ruby_ami/stream.rb

@@ -15,12 +15,9 @@ module RubyAMI
 
     def initialize(host, port, event_callback)
       super()
-      @event_callback = event_callback
+      @host, @port, @event_callback = host, port, event_callback
       logger.debug "Starting up..."
       @lexer = Lexer.new self
-      @socket = TCPSocket.from_ruby_socket ::TCPSocket.new(host, port)
-      post_init
-      run!
     end
 
     [:started, :stopped, :ready].each do |state|
@@ -28,7 +25,12 @@ module RubyAMI
     end
 
     def run
+      @socket = TCPSocket.from_ruby_socket ::TCPSocket.new(@host, @port)
+      post_init
       loop { receive_data @socket.readpartial(4096) }
+    rescue Errno::ECONNREFUSED, SocketError => e
+      logger.error "Connection failed due to #{e.class}. Check your config and the server."
+      current_actor.terminate!
     rescue EOFError
       logger.info "Client socket closed!"
       current_actor.terminate!

data/lib/ruby_ami/version.rb

@@ -1,3 +1,3 @@
 module RubyAMI
-  VERSION = "1.1.2"
+  VERSION = "1.2.0"
 end

data/lib/ruby_ami.rb

@@ -16,6 +16,8 @@ end
 
 %w{
   action
+  agi_result_parser
+  async_agi_environment_parser
   client
   error
   event

data/ruby_ami.gemspec

@@ -25,10 +25,10 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency %q<countdownlatch>, ["~> 1.0"]
 
   s.add_development_dependency %q<bundler>, ["~> 1.0"]
-  s.add_development_dependency %q<rspec>, [">= 2.5.0"]
+  s.add_development_dependency %q<rspec>, ["~> 2.5"]
   s.add_development_dependency %q<cucumber>, [">= 0"]
-  s.add_development_dependency %q<ci_reporter>, [">= 1.6.3"]
-  s.add_development_dependency %q<yard>, ["~> 0.6.0"]
+  s.add_development_dependency %q<ci_reporter>, ["~> 1.6"]
+  s.add_development_dependency %q<yard>, ["~> 0.6"]
   s.add_development_dependency %q<rake>, [">= 0"]
   s.add_development_dependency %q<mocha>, [">= 0"]
   s.add_development_dependency %q<simplecov>, [">= 0"]

data/spec/ruby_ami/agi_result_parser_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module RubyAMI
+  describe AGIResultParser do
+    subject { described_class.new result_string }
+
+    context 'with something that does not match the valid format' do
+      let(:result_string) { 'foobar' }
+
+      it 'should raise ArgumentError on creation' do
+        expect { subject }.to raise_error(ArgumentError, /format/)
+      end
+    end
+
+    context 'with a simple result with no data' do
+      let(:result_string) { "200%20result=123%0A" }
+
+      its(:code)      { should == 200 }
+      its(:result)    { should == 123 }
+      its(:data)      { should == '' }
+      its(:data_hash) { should == nil }
+    end
+
+    context 'with a simple unescaped result with no data' do
+      let(:result_string) { "200 result=123" }
+
+      its(:code)      { should == 200 }
+      its(:result)    { should == 123 }
+      its(:data)      { should == '' }
+      its(:data_hash) { should == nil }
+    end
+
+    context 'with a result and data in parens' do
+      let(:result_string) { "200%20result=-123%20(timeout)%0A" }
+
+      its(:code)      { should == 200 }
+      its(:result)    { should == -123 }
+      its(:data)      { should == 'timeout' }
+      its(:data_hash) { should == nil }
+    end
+
+    context 'with a result and key-value data' do
+      let(:result_string) { "200%20result=123%20foo=bar%0A" }
+
+      its(:code)      { should == 200 }
+      its(:result)    { should == 123 }
+      its(:data)      { should == 'foo=bar' }
+      its(:data_hash) { should == {'foo' => 'bar'} }
+    end
+  end
+end

data/spec/ruby_ami/async_agi_environment_parser_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+module RubyAMI
+  describe AsyncAGIEnvironmentParser do
+    let :environment_string do
+      "agi_request%3A%20async%0Aagi_channel%3A%20SIP%2F1234-00000000%0Aagi_language%3A%20en%0Aagi_type%3A%20SIP%0Aagi_uniqueid%3A%201320835995.0%0Aagi_version%3A%201.8.4.1%0Aagi_callerid%3A%205678%0Aagi_calleridname%3A%20Jane%20Smith%0Aagi_callingpres%3A%200%0Aagi_callingani2%3A%200%0Aagi_callington%3A%200%0Aagi_callingtns%3A%200%0Aagi_dnid%3A%201000%0Aagi_rdnis%3A%20unknown%0Aagi_context%3A%20default%0Aagi_extension%3A%201000%0Aagi_priority%3A%201%0Aagi_enhanced%3A%200.0%0Aagi_accountcode%3A%20%0Aagi_threadid%3A%204366221312%0A%0A"
+    end
+
+    subject { described_class.new environment_string }
+
+    its(:to_s) { should == environment_string }
+    its(:to_s) { should_not be environment_string }
+
+    describe 'retrieving a hash representation' do
+      its(:to_hash) do
+        should == {
+          :agi_request      => 'async',
+          :agi_channel      => 'SIP/1234-00000000',
+          :agi_language     => 'en',
+          :agi_type         => 'SIP',
+          :agi_uniqueid     => '1320835995.0',
+          :agi_version      => '1.8.4.1',
+          :agi_callerid     => '5678',
+          :agi_calleridname => 'Jane Smith',
+          :agi_callingpres  => '0',
+          :agi_callingani2  => '0',
+          :agi_callington   => '0',
+          :agi_callingtns   => '0',
+          :agi_dnid         => '1000',
+          :agi_rdnis        => 'unknown',
+          :agi_context      => 'default',
+          :agi_extension    => '1000',
+          :agi_priority     => '1',
+          :agi_enhanced     => '0.0',
+          :agi_accountcode  => '',
+          :agi_threadid     => '4366221312'
+        }
+      end
+
+      it "should not return the same hash object every time" do
+        subject.to_hash.should_not be subject.to_hash
+      end
+    end
+  end
+end

data/spec/ruby_ami/client_spec.rb

@@ -329,8 +329,8 @@ module RubyAMI
     end
 
     describe '#stop' do
-      let(:mock_actions_stream) { mock 'Actions Stream' }
-      let(:mock_events_stream) { mock 'Events Stream' }
+      let(:mock_actions_stream) { mock 'Actions Stream', :alive? => true }
+      let(:mock_events_stream) { mock 'Events Stream', :alive? => true }
 
       let(:streams) { [mock_actions_stream, mock_events_stream] }
 

data/spec/ruby_ami/stream_spec.rb

@@ -26,6 +26,7 @@ module RubyAMI
       mock_target.expects(:receive_data).send(*(times ? [:times, times] : [:at_least, 1])).with &block
       s = ServerMock.new '127.0.0.1', server_port, mock_target
       @stream = Stream.new '127.0.0.1', server_port, lambda { |m| client.message_received m }
+      @stream.run!
       fake_client.call if fake_client.respond_to? :call
       s.join
       @stream.join

data/spec/spec_helper.rb

@@ -1,18 +1,23 @@
-require 'simplecov'
-require 'simplecov-rcov'
-class SimpleCov::Formatter::MergedFormatter
-  def format(result)
-     SimpleCov::Formatter::HTMLFormatter.new.format(result)
-     SimpleCov::Formatter::RcovFormatter.new.format(result)
+begin
+  require 'simplecov'
+  require 'simplecov-rcov'
+  class SimpleCov::Formatter::MergedFormatter
+    def format(result)
+       SimpleCov::Formatter::HTMLFormatter.new.format(result)
+       SimpleCov::Formatter::RcovFormatter.new.format(result)
+    end
   end
-end
-SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
-SimpleCov.start do
-  add_filter "/vendor/"
+  SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+  SimpleCov.start do
+    add_filter "/vendor/"
+  end
+rescue Exception => e
+  puts "Couldn't load simplecov"
+  puts e.message
+  puts e.backtrace.join("\n")
 end
 
 require 'ruby_ami'
-require 'mocha'
 require 'countdownlatch'
 
 Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_ami
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-04 00:00:00.000000000 Z
+date: 2012-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools
@@ -112,17 +112,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -144,17 +144,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.3
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.3
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -162,7 +162,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -170,7 +170,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -293,6 +293,8 @@ files:
 - features/support/lexer_helper.rb
 - lib/ruby_ami.rb
 - lib/ruby_ami/action.rb
+- lib/ruby_ami/agi_result_parser.rb
+- lib/ruby_ami/async_agi_environment_parser.rb
 - lib/ruby_ami/client.rb
 - lib/ruby_ami/error.rb
 - lib/ruby_ami/event.rb
@@ -304,6 +306,8 @@ files:
 - lib/ruby_ami/version.rb
 - ruby_ami.gemspec
 - spec/ruby_ami/action_spec.rb
+- spec/ruby_ami/agi_result_parser_spec.rb
+- spec/ruby_ami/async_agi_environment_parser_spec.rb
 - spec/ruby_ami/client_spec.rb
 - spec/ruby_ami/error_spec.rb
 - spec/ruby_ami/event_spec.rb
@@ -326,7 +330,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 726303340289195819
+      hash: 1172578337856307051
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -335,7 +339,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 726303340289195819
+      hash: 1172578337856307051
 requirements: []
 rubyforge_project: ruby_ami
 rubygems_version: 1.8.24
@@ -350,6 +354,8 @@ test_files:
 - features/support/introspective_lexer.rb
 - features/support/lexer_helper.rb
 - spec/ruby_ami/action_spec.rb
+- spec/ruby_ami/agi_result_parser_spec.rb
+- spec/ruby_ami/async_agi_environment_parser_spec.rb
 - spec/ruby_ami/client_spec.rb
 - spec/ruby_ami/error_spec.rb
 - spec/ruby_ami/event_spec.rb
@@ -357,3 +363,4 @@ test_files:
 - spec/ruby_ami/stream_spec.rb
 - spec/spec_helper.rb
 - spec/support/mock_server.rb
+has_rdoc: