ruby_ami 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5953bb5e6fa27b0deeee4847c2a858ac569fcc0a
-  data.tar.gz: 55cf2a66637e697c1395e89da1ae2c6d79dd05cf
+  metadata.gz: 78ab0e1cb98c4b9cc7937dce36985dd5f928f3b6
+  data.tar.gz: b933392977d95722eacbe58881d6a61848f9652c
 SHA512:
-  metadata.gz: a98f86436f743270e3d0950a3056ac3ed673df03648379726a86a28717cc059688f94aded13b090c98cb25e7456a2c61af60179d2702dcacd53dd2ed5d4e298f
-  data.tar.gz: d5a21a2b1bd5e35813a38d724415a3acd519a4461e9690ef0e2bd177a1d74037c3bc2cf62bc34748b4b8c447866130ac996fb7b87763f4901e081c31a8a2a8cb
+  metadata.gz: 4e9e1e68b4c7526f2c0943575285f95c19dd8a466d53b514115a524eb2d38806bea6bf962d6a169fc734be01e5d564b00ae1c5a9fdd7bee5e5a8107cfb8a100e
+  data.tar.gz: 98128f68562f0971c1b6912b52626fbe5bc6b6ed930dd7c6365640cf515b3ec8337f3eb1478e7e4018b8a7bac95eafda388eb56fe306262dc87f5a5161b29be0

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+sudo: false
 rvm:
   - 1.9.3
   - 2.0.0

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # [develop](https://github.com/adhearsion/ruby_ami)
 
+# [2.4.0](https://github.com/adhearsion/ruby_ami/compare/v2.3.0...v2.4.0) - [2015-12-07](https://rubygems.org/gems/ruby_ami/versions/2.4.0)
+  # Feature: Reveal the AMI version for a `Stream` via `Stream#version`
+
 # [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

data/Guardfile

@@ -1,4 +1,4 @@
-guard 'rspec', :cli => '--format documentation' do
+guard 'rspec', cmd: 'bundle exec rspec --format documentation' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec/" }

data/README.md

@@ -15,23 +15,51 @@ NB: If you're looking to develop an application on Asterisk, you should take a l
     gem install ruby_ami
 
 ## Usage
+
+In order to setup a connection to listen for AMI events, one can do:
+
 ```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'
+    puts "The server booted and is available for commands."
+  else
+    puts "Received an event from Asterisk: #{event.inspect}"
   end
 end
 
 $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.
 ```
 
+It is also possible to execute actions in response to events:
+
+```ruby
+require 'ruby_ami'
+
+$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'
+    puts "The connection was successful. Originating a call."
+    response = $stream.send_action 'Originate', 'Channel' => 'SIP/foo'
+    puts "The call origination resulted in #{response.inspect}"
+  end
+end
+
+$stream.run
+```
+
+Executing actions does not strictly have to be done within the event handler, but it is not valid to send AMI events before receiving a `FullyBooted` event. If you attempt to execute an action prior to this, it may fail, and `RubyAMI::Stream` will not help you recover or queue the action until the connection is `FullyBooted`; you must manage this timing yourself. That said, assuming you take care of this, you may invoke `RubyAMI::Stream#send_action` from anywhere in your code and it will return the response of the action.
+
 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**.
 
 ## Links:

data/features/lexer.feature

@@ -5,10 +5,10 @@ Feature: Lexing AMI
 
   Scenario: Lexing only the initial AMI version header
     Given a new lexer
-    And a version header for AMI 1.0
+    And a version header for AMI 2.8.0
 
     Then the protocol should have lexed without syntax errors
-    And the version should be set to 1.0
+    And the version should be set to 2.8.0
 
   Scenario: Lexing the initial AMI header and a login attempt
     Given a new lexer

data/features/step_definitions/lexer_steps.rb

@@ -17,7 +17,7 @@ Given "a new lexer" do
 end
 
 Given "a version header for AMI $version" do |version|
-  @lexer << "Asterisk Call Manager/1.0\r\n"
+  @lexer << "Asterisk Call Manager/#{version}\r\n"
 end
 
 Given "a normal login success with events" do

data/lib/ruby_ami/lexer.rb

@@ -3,7 +3,7 @@
 module RubyAMI
   class Lexer
     STANZA_BREAK      = "\r\n\r\n"
-    PROMPT            = /Asterisk Call Manager\/(\d+\.\d+)\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

data/lib/ruby_ami/stream.rb

@@ -57,6 +57,10 @@ module RubyAMI
       login @username, @password if @username && @password
     end
 
+    def version
+      @lexer.ami_version
+    end
+
     def send_data(data)
       @socket.write data
     end

data/lib/ruby_ami/version.rb

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

data/spec/ruby_ami/stream_spec.rb

@@ -59,6 +59,25 @@ module RubyAMI
         mocked_server 0, -> { @stream.started?.should be_true }
       end
 
+      it "stores the reported AMI version" do
+        expect_connected_event
+        expect_disconnected_event
+        mocked_server(1, lambda {
+          @stream.send_action('Command') # Just to get the server kicked in to replying using the below block
+          expect(@stream.version).to eq('2.8.0')
+        }) do |val, server|
+          server.send_data "Asterisk Call Manager/2.8.0\n"
+
+          # Just to unblock the above command before the actor shuts down
+          server.send_data <<-EVENT
+Response: Success
+ActionID: #{RubyAMI.new_uuid}
+Message: Recording started
+
+          EVENT
+        end
+      end
+
       it "can send an action" do
         expect_connected_event
         expect_disconnected_event

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_ami
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Ben Langfeld
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2015-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid-io