ruby_ami 1.3.4 → 2.0.0

data/lib/ruby_ami/stream.rb

@@ -18,11 +18,13 @@ module RubyAMI
 
     finalizer :finalize
 
-    def initialize(host, port, event_callback, logger = Logger, timeout = 0)
+    def initialize(host, port, username, password, event_callback, logger = Logger, timeout = 0)
       super()
-      @host, @port, @event_callback, @logger, @timeout = host, port, event_callback, logger, timeout
+      @host, @port, @username, @password, @event_callback, @logger, @timeout = host, port, username, password, event_callback, logger, timeout
       logger.debug "Starting up..."
       @lexer = Lexer.new self
+      @sent_actions   = {}
+      @causal_actions = {}
     end
 
     [:started, :stopped, :ready].each do |state|
@@ -37,27 +39,33 @@ module RubyAMI
       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!
     rescue Timeout::Error
       logger.error "Timeout exceeded while trying to connect."
-      current_actor.terminate!
+    ensure
+      async.terminate
     end
 
     def post_init
       @state = :started
-      @event_callback.call Connected.new
+      fire_event Connected.new
+      login @username, @password if @username && @password
     end
 
     def send_data(data)
       @socket.write data
     end
 
-    def send_action(action)
-      logger.trace "[SEND] #{action.to_s}"
-      send_data action.to_s
+    def send_action(name, headers = {})
+      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
+      end
     end
 
     def receive_data(data)
@@ -67,7 +75,20 @@ module RubyAMI
 
     def message_received(message)
       logger.trace "[RECV] #{message.inspect}"
-      @event_callback.call message
+      case message
+      when Event
+        action = causal_action_for_event message
+        if action
+          action << message
+          complete_causal_action_for_event message if action.complete?
+        else
+          fire_event message
+        end
+      when Response, Error
+        action = sent_action_for_response message
+        raise StandardError, "Received an AMI response with an unrecognized ActionID! #{message.inspect}" unless action
+        action << message
+      end
     end
 
     def syntax_error_encountered(ignored_chunk)
@@ -78,11 +99,55 @@ module RubyAMI
 
     private
 
+    def login(username, password, event_mask = 'On')
+      dispatch_action 'Login',
+        'Username' => username,
+        'Secret'   => password,
+        'Events'   => event_mask
+    end
+
+    def dispatch_action(*args, &block)
+      action = Action.new *args, &block
+      logger.trace "[SEND] #{action.to_s}"
+      register_sent_action action
+      send_data action.to_s
+      action
+    end
+
+    def fire_event(event)
+      @event_callback.call event
+    end
+
+    def register_sent_action(action)
+      @sent_actions[action.action_id] = action
+      register_causal_action action if action.has_causal_events?
+    end
+
+    def sent_action_with_id(action_id)
+      @sent_actions.delete action_id
+    end
+
+    def sent_action_for_response(response)
+      sent_action_with_id response.action_id
+    end
+
+    def register_causal_action(action)
+      @causal_actions[action.action_id] = action
+    end
+
+    def causal_action_for_event(event)
+      @causal_actions[event.action_id]
+    end
+
+    def complete_causal_action_for_event(event)
+      @causal_actions.delete event.action_id
+    end
+
     def finalize
       logger.debug "Finalizing stream"
       @socket.close if @socket
       @state = :stopped
-      @event_callback.call Disconnected.new
+      fire_event Disconnected.new
     end
   end
 end

data/lib/ruby_ami/version.rb

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

data/lib/ruby_ami.rb

@@ -1,8 +1,4 @@
 %w{
-  future-resource
-  logger
-  girl_friday
-  countdownlatch
   celluloid/io
 }.each { |f| require f }
 
@@ -14,10 +10,6 @@ module RubyAMI
   def self.new_uuid
     SecureRandom.uuid
   end
-  
-  def self.rbx?
-    RbConfig::CONFIG['RUBY_INSTALL_NAME'] == 'rbx'
-  end
 end
 
 %w{
@@ -29,7 +21,6 @@ end
   error
   event
   lexer
-  metaprogramming
   response
   stream
   version

data/ruby_ami.gemspec

@@ -19,16 +19,12 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency %q<celluloid-io>, ["~> 0.13"]
-  s.add_runtime_dependency %q<future-resource>, [">= 0"]
-  s.add_runtime_dependency %q<girl_friday>, [">= 0"]
-  s.add_runtime_dependency %q<countdownlatch>, ["~> 1.0"]
 
   s.add_development_dependency %q<bundler>, ["~> 1.0"]
   s.add_development_dependency %q<rspec>, ["~> 2.5"]
   s.add_development_dependency %q<cucumber>, [">= 0"]
   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<guard-rspec>
   s.add_development_dependency %q<guard-shell>
   s.add_development_dependency %q<ruby_gntp>

data/spec/ruby_ami/action_spec.rb

@@ -7,34 +7,18 @@ module RubyAMI
     let(:headers) { {'foo' => 'bar'} }
 
     subject do
-      Action.new name, headers do |response|
-        @foo = response
+      described_class.new name, headers do |response|
+        @callback_result = response
       end
     end
 
-    it { should be_new }
+    it { should_not be_complete }
 
     describe "SIPPeers actions" do
       subject { Action.new('SIPPeers') }
       its(:has_causal_events?) { should be true }
     end
 
-    describe "Queues actions" do
-      subject { Action.new('Queues') }
-      its(:replies_with_action_id?) { should == false }
-    end
-
-    describe "IAXPeers actions" do
-      before { pending }
-      # FIXME: This test relies on the side effect that earlier tests have run
-      # and initialized the UnsupportedActionName::UNSUPPORTED_ACTION_NAMES
-      # constant for an "unknown" version of Asterisk.  This should be fixed
-      # to be more specific about which version of Asterisk is under test.
-      # IAXPeers is supported (with Action IDs!) since Asterisk 1.8
-      subject { Action.new('IAXPeers') }
-      its(:replies_with_action_id?) { should == false }
-    end
-
     describe "the ParkedCalls terminator event" do
       subject { Action.new('ParkedCalls') }
       its(:causal_event_terminator_name) { should == "parkedcallscomplete" }
@@ -52,34 +36,34 @@ module RubyAMI
       Action.new("ParkedCalls").to_s.should =~ /^Action: ParkedCalls\r\nActionID: [\w-]+\r\n\r\n$/i
     end
 
-    it 'should be able to be marked as sent' do
-      subject.state = :sent
-      subject.should be_sent
-    end
-
-    it 'should be able to be marked as complete' do
-      subject.state = :complete
-      subject.should be_complete
-    end
-
     describe '#<<' do
       describe 'for a non-causal action' do
         context 'with a response' do
           let(:response) { Response.new }
 
+          before { subject << response }
+
           it 'should set the response' do
-            subject << response
             subject.response.should be response
           end
+
+          it 'should call the callback' do
+            @callback_result.should be response
+          end
+
+          it { should be_complete }
         end
 
         context 'with an error' do
           let(:error) { Error.new.tap { |e| e.message = 'AMI error' } }
 
-          it 'should set the response and raise the error when reading it' do
-            subject << error
-            lambda { subject.response }.should raise_error Error, 'AMI error'
+          before { subject << error }
+
+          it 'should set the response' do
+            subject.response.should == error
           end
+
+          it { should be_complete }
         end
 
         context 'with an event' do
@@ -91,11 +75,10 @@ module RubyAMI
 
       describe 'for a causal action' do
         let(:name) { 'Status' }
+        let(:response) { Response.new }
 
         context 'with a response' do
-          let(:message) { Response.new }
-
-          before { subject << message }
+          before { subject << response }
 
           it { should_not be_complete }
         end
@@ -103,14 +86,15 @@ module RubyAMI
         context 'with an event' do
           let(:event) { Event.new 'foo' }
 
-          before { subject << event }
+          before { subject << response << event }
 
-          its(:events) { should == [event] }
+          it "should add the events to the response" do
+            subject.response.events.should == [event]
+          end
         end
 
         context 'with a terminating event' do
-          let(:response)  { Response.new }
-          let(:event)     { Event.new 'StatusComplete' }
+          let(:event) { Event.new 'StatusComplete' }
 
           before do
             subject << response
@@ -118,7 +102,9 @@ module RubyAMI
             subject << event
           end
 
-          its(:events) { should == [event] }
+          it "should add the events to the response" do
+            subject.response.events.should == [event]
+          end
 
           it { should be_complete }
 
@@ -127,19 +113,6 @@ module RubyAMI
       end
     end
 
-    describe 'setting the response' do
-      let(:response) { :bar }
-
-      before { subject.response = response }
-
-      it { should be_complete }
-      its(:response) { should == response }
-
-      it 'should call the response callback with the response' do
-        @foo.should == response
-      end
-    end
-
     describe 'comparison' do
       describe 'with another Action' do
         context 'with identical name and headers' do
@@ -160,29 +133,5 @@ module RubyAMI
 
       it { should_not == :foo }
     end
-
-    describe "#sync_timeout" do
-      it "should be 10 seconds" do
-        subject.sync_timeout.should be == 10
-      end
-
-      context "for an asynchronous Originate" do
-        let(:name) { 'Originate' }
-        let(:headers) { {:async => true} }
-
-        it "should be 60 seconds" do
-          subject.sync_timeout.should be == 10
-        end
-      end
-
-      context "for a synchronous Originate" do
-        let(:name) { 'Originate' }
-        let(:headers) { {:async => false} }
-
-        it "should be 60 seconds" do
-          subject.sync_timeout.should be == 60
-        end
-      end
-    end
   end # Action
 end # RubyAMI

data/spec/ruby_ami/agi_result_parser_spec.rb

@@ -48,14 +48,5 @@ 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