ruby_ami 2.2.1 → 2.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5953bb5e6fa27b0deeee4847c2a858ac569fcc0a
+  data.tar.gz: 55cf2a66637e697c1395e89da1ae2c6d79dd05cf
+SHA512:
+  metadata.gz: a98f86436f743270e3d0950a3056ac3ed673df03648379726a86a28717cc059688f94aded13b090c98cb25e7456a2c61af60179d2702dcacd53dd2ed5d4e298f
+  data.tar.gz: d5a21a2b1bd5e35813a38d724415a3acd519a4461e9690ef0e2bd177a1d74037c3bc2cf62bc34748b4b8c447866130ac996fb7b87763f4901e081c31a8a2a8cb

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # [develop](https://github.com/adhearsion/ruby_ami)
 
+# [2.3.0](https://github.com/adhearsion/ruby_ami/compare/v2.2.1...v2.3.0) - [2015-06-01](https://rubygems.org/gems/ruby_ami/versions/2.3.0)
+  * Feature: Allow optional error handler when calling `send_action`
+  * Bugfix: Catch for Errno::HOSTUNREACH error when connecting to AMI
+  * Bugfix: Add support for Goodbye responses instead of processing them as syntax errors
+  * Bugfix: Allow simple example of event handling (switching on `event.name` only) to work by giving connection status events a name to match their class names
+
 # [2.2.1](https://github.com/adhearsion/ruby_ami/compare/v2.2.0...v2.2.1) - [2014-05-22](https://rubygems.org/gems/ruby_ami/versions/2.2.1)
   * Bugfix: Ensure DateTime is present when consumer code doesn't `require 'time'` ([#24](https://github.com/adhearsion/ruby_ami/issues/24))
 

data/README.md

@@ -1,4 +1,12 @@
-# RubyAMI [![Build Status](https://secure.travis-ci.org/adhearsion/ruby_ami.png?branch=master)](http://travis-ci.org/adhearsion/ruby_ami)
+# RubyAMI
+
+[![Gem Version](https://badge.fury.io/rb/ruby_ami.png)](https://rubygems.org/gems/ruby_ami)
+[![Build Status](https://secure.travis-ci.org/adhearsion/ruby_ami.png?branch=develop)](http://travis-ci.org/adhearsion/ruby_ami)
+[![Dependency Status](https://gemnasium.com/adhearsion/ruby_ami.png?travis)](https://gemnasium.com/adhearsion/ruby_ami)
+[![Code Climate](https://codeclimate.com/github/adhearsion/ruby_ami.png)](https://codeclimate.com/github/adhearsion/ruby_ami)
+[![Coverage Status](https://coveralls.io/repos/adhearsion/ruby_ami/badge.png?branch=develop)](https://coveralls.io/r/adhearsion/ruby_ami)
+[![Inline docs](http://inch-ci.org/github/adhearsion/ruby_ami.png?branch=develop)](http://inch-ci.org/github/adhearsion/ruby_ami)
+
 RubyAMI is an AMI client library in Ruby and based on EventMachine with the sole purpose of providing a connection to the Asterisk Manager Interface. RubyAMI does not provide any features beyond connection management and protocol parsing. Actions are sent over the wire, and responses are returned. Events are passed to a callback you define. It's up to you to match these up into something useful. In this regard, RubyAMI is very similar to [Blather](https://github.com/sprsquish/blather) for XMPP or [Punchblock](https://github.com/adhearsion/punchblock), the Ruby 3PCC library. In fact, Punchblock uses RubyAMI under the covers for its Asterisk implementation, including an implementation of AsyncAGI.
 
 NB: If you're looking to develop an application on Asterisk, you should take a look at the [Adhearsion](http://adhearsion.com) framework first. This library is much lower level.
@@ -10,20 +18,18 @@ NB: If you're looking to develop an application on Asterisk, you should take a l
 ```ruby
 require 'ruby_ami'
 
-stream = RubyAMI::Stream.new '127.0.0.1', 5038, 'manager', 'password',
+$stream = RubyAMI::Stream.new '127.0.0.1', 5038, 'manager', 'password',
                               ->(e) { handle_event e },
                               Logger.new(STDOUT), 10
 
 def handle_event(event)
   case event.name
   when 'FullyBooted'
-    stream.async.send_action 'Originate', 'Channel' => 'SIP/foo'
+    $stream.async.send_action 'Originate', 'Channel' => 'SIP/foo'
   end
 end
 
-stream.start
-
-Celluloid::Actor.join stream
+$stream.run # This will block until the actor is terminated elsewhere. $stream.async.run is also available if you need to do other things in the main thread.
 ```
 
 RubyAMI also has a class called `RubyAMI::Client` which used to be the main usage method. The purpose of this class was to tie together two AMI connections and separate events and action execution between the two in order to avoid some issues present in Asterisk < 1.8 with regards to separating overlapping events and executing multiple actions simultaneously. These issues are no longer present, and so **`RubyAMI::Client` is now deprecated and will be removed in RubyAMI 3.0**.

data/lib/ruby_ami/lexer.rb

@@ -11,10 +11,11 @@ module RubyAMI
     EVENT             = /event: *(?<event_name>.*)?/i
     ERROR             = /response: *error/i
     FOLLOWS           = /response: *follows/i
+    GOODBYE           = /response: *goodbye/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
+    CLASSIFIER        = /((?<event>#{EVENT})|(?<success>#{SUCCESS})|(?<pong>#{PONG})|(?<follows>#{FOLLOWS})|(?<error>#{ERROR})|(?<goodbye>#{GOODBYE})|(?<immediate>#{IMMEDIATE_RESP})\r\n)\r\n/i
 
     attr_accessor :ami_version
 
@@ -69,7 +70,7 @@ module RubyAMI
 
       msg = if match[:event]
         Event.new match[:event_name]
-      elsif match[:success] || match[:pong]
+      elsif match[:success] || match[:pong] || match[:goodbye]
         Response.new
       elsif match[:follows]
         response_follows = true

data/lib/ruby_ami/stream.rb

@@ -2,6 +2,10 @@
 module RubyAMI
   class Stream
     class ConnectionStatus
+      def name
+        self.class.to_s
+      end
+
       def eql?(other)
         other.is_a? self.class
       end
@@ -37,7 +41,7 @@ module RubyAMI
       end
       post_init
       loop { receive_data @socket.readpartial(4096) }
-    rescue Errno::ECONNREFUSED, SocketError => e
+    rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, SocketError => e
       logger.error "Connection failed due to #{e.class}. Check your config and the server."
     rescue EOFError
       logger.info "Client socket closed!"
@@ -57,14 +61,16 @@ module RubyAMI
       @socket.write data
     end
 
-    def send_action(name, headers = {})
+    def send_action(name, headers = {}, error_handler = self.method(:abort))
       condition = Celluloid::Condition.new
       action = dispatch_action name, headers do |response|
         condition.signal response
       end
       condition.wait
       action.response.tap do |resp|
-        abort resp if resp.is_a? Exception
+        if resp.is_a? Exception
+          error_handler.call(resp)
+        end
       end
     end
 

data/lib/ruby_ami/version.rb

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

data/spec/ruby_ami/client_spec.rb

@@ -66,7 +66,7 @@ module RubyAMI
       it 'should shut down the client' do
         subject.events_stream.terminate
         sleep 0.2
-        subject.should_not be_alive
+        subject.alive?.should be_false
       end
     end
 
@@ -74,7 +74,7 @@ module RubyAMI
       it 'should shut down the client' do
         subject.actions_stream.terminate
         sleep 0.2
-        subject.should_not be_alive
+        subject.alive?.should be_false
       end
     end
 

data/spec/ruby_ami/stream_spec.rb

@@ -190,20 +190,56 @@ Message: Recording started
         response.should == Response.new('ActionID' => RubyAMI.new_uuid, 'Message' => 'Recording started')
       end
 
+      it 'should handle disconnect as a Response' do
+        response = nil
+        mocked_server(1, lambda { response = @stream.send_action 'Logoff' }) do |val, server|
+          server.send_data <<-EVENT
+Response: Goodbye
+ActionID: #{RubyAMI.new_uuid}
+Message: Thanks for all the fish.
+
+          EVENT
+        end
+  
+        response.should == Response.new('ActionID' => RubyAMI.new_uuid, 'Message' => 'Thanks for all the fish.')
+      end
+
       describe 'when it is an error' do
-        it 'should be raised by #send_action, but not kill the stream' do
-          send_action = lambda do
-            expect { @stream.send_action 'status' }.to raise_error(RubyAMI::Error, 'Action failed')
-            @stream.should be_alive
+        describe 'when there is no error handler' do
+          it 'should be raised by #send_action, but not kill the stream' do
+            send_action = lambda do
+              expect { @stream.send_action 'status' }.to raise_error(RubyAMI::Error, 'Action failed')
+              @stream.should be_alive
+            end
+
+            mocked_server(1, send_action) do |val, server|
+              server.send_data <<-EVENT
+Response: Error
+ActionID: #{RubyAMI.new_uuid}
+Message: Action failed
+
+              EVENT
+            end
           end
+        end
 
-          mocked_server(1, send_action) do |val, server|
-            server.send_data <<-EVENT
+        describe 'when there is an error handler' do
+          it 'should call the error handler' do
+            error_handler = lambda { |resp| resp.should be_a_kind_of RubyAMI::Error }
+
+            send_action = lambda do
+              expect { @stream.send_action 'status', {}, error_handler }.to_not raise_error
+              @stream.should be_alive
+            end
+
+            mocked_server(1, send_action) do |val, server|
+              server.send_data <<-EVENT
 Response: Error
 ActionID: #{RubyAMI.new_uuid}
 Message: Action failed
 
-            EVENT
+              EVENT
+            end
           end
         end
       end
@@ -257,4 +293,12 @@ ActionID: #{RubyAMI.new_uuid}
       @stream.alive?.should be false
     end
   end
+
+  describe Stream::Connected do
+    its(:name) { should == 'RubyAMI::Stream::Connected' }
+  end
+
+  describe Stream::Disconnected do
+    its(:name) { should == 'RubyAMI::Stream::Disconnected' }
+  end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_ami
 version: !ruby/object:Gem::Version
-  version: 2.2.1
-  prerelease: 
+  version: 2.3.0
 platform: ruby
 authors:
 - Ben Langfeld
@@ -10,182 +9,160 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2015-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid-io
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-shell
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-cucumber
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: benchmark_suite
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A Ruby client library for the Asterisk Management Interface built on
@@ -197,9 +174,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -240,27 +217,26 @@ files:
 - spec/support/mock_server.rb
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: ruby_ami
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Futzing with AMI so you don't have to
 test_files:
 - features/lexer.feature