punchblock 0.5.1 → 0.6.0

data/spec/punchblock/event/complete_spec.rb

@@ -75,6 +75,14 @@ module Punchblock
 
       its(:name) { should == :error }
       its(:details) { should == "Something really bad happened" }
+
+      describe "when setting options in initializer" do
+        subject do
+          Complete::Error.new :details => 'Ooops'
+        end
+
+        its(:details) { should == 'Ooops' }
+      end
     end
   end
 end # Punchblock

data/spec/punchblock/event/dtmf_spec.rb

@@ -19,6 +19,14 @@ module Punchblock
         its(:signal) { should == '#' }
         its(:xmlns) { should == 'urn:xmpp:rayo:1' }
       end
+
+      describe "when setting options in initializer" do
+        subject do
+          DTMF.new :signal => '#'
+        end
+
+        its(:signal) { should == '#' }
+      end
     end
   end
 end # Punchblock

data/spec/punchblock/event/end_spec.rb

@@ -25,6 +25,14 @@ module Punchblock
         its(:reason) { should == :timeout }
         its(:xmlns) { should == 'urn:xmpp:rayo:1' }
       end
+
+      describe "when setting options in initializer" do
+        subject do
+          End.new :reason => :hangup
+        end
+
+        its(:reason) { should == :hangup }
+      end
     end
   end
 end # Punchblock

data/spec/punchblock/event/offer_spec.rb

@@ -27,8 +27,21 @@ module Punchblock
         it_should_behave_like 'event'
         it_should_behave_like 'event_headers'
 
-        its(:to) { should == 'tel:+18003211212' }
-        its(:from) { should == 'tel:+13058881212' }
+        its(:to)    { should == 'tel:+18003211212' }
+        its(:from)  { should == 'tel:+13058881212' }
+      end
+
+      describe "when setting options in initializer" do
+        subject do
+          Offer.new :to       => 'tel:+18003211212',
+                    :from     => 'tel:+13058881212',
+                    :headers  => { :x_skill => "agent", :x_customer_id => "8877" }
+        end
+
+        it_should_behave_like 'event_headers'
+
+        its(:to)    { should == 'tel:+18003211212' }
+        its(:from)  { should == 'tel:+13058881212' }
       end
     end
   end

data/spec/punchblock/ref_spec.rb

@@ -17,5 +17,11 @@ module Punchblock
 
       its(:id) { should == 'fgh4590' }
     end
+
+    describe "when setting options in initializer" do
+      subject { Ref.new :id => 'foo' }
+
+      its(:id) { should == 'foo' }
+    end
   end
 end # Punchblock

data/spec/punchblock/translator/asterisk/ami_action_spec.rb

@@ -0,0 +1,149 @@
+require 'spec_helper'
+
+module Punchblock
+  module Translator
+    class Asterisk
+      describe AMIAction do
+        let(:mock_ami_client) { mock 'RubyAMI::Client' }
+
+        let :command do
+          Punchblock::Component::Asterisk::AMI::Action.new :name => 'ExtensionStatus', :params => { :context => 'default', :exten => 'idonno' }
+        end
+
+        subject { AMIAction.new command, mock_ami_client }
+
+        let :expected_action do
+          RubyAMI::Action.new 'ExtensionStatus', 'Context' => 'default', 'Exten' => 'idonno'
+        end
+
+        context 'initial execution' do
+          let(:component_id) { UUIDTools::UUID.random_create }
+
+          let :expected_response do
+            Ref.new :id => component_id
+          end
+
+          before { UUIDTools::UUID.stubs :random_create => component_id }
+
+          it 'should send the appropriate RubyAMI::Action and send the component node a ref with the action ID' do
+            mock_ami_client.expects(:send_action).once.with(expected_action).returns(expected_action)
+            command.expects(:response=).once.with(expected_response)
+            subject.execute
+          end
+        end
+
+        context 'when the AMI action completes' do
+          before do
+            command.request!
+            command.execute!
+          end
+
+          let :response do
+            RubyAMI::Response.new.tap do |r|
+              r['ActionID'] = "552a9d9f-46d7-45d8-a257-06fe95f48d99"
+              r['Message']  = 'Channel status will follow'
+              r["Exten"]    = "idonno"
+              r["Context"]  = "default"
+              r["Hint"]     = ""
+              r["Status"]   = "-1"
+            end
+          end
+
+          let :expected_complete_reason do
+            Punchblock::Component::Asterisk::AMI::Action::Complete::Success.new :message => 'Channel status will follow', :attributes => {:exten => "idonno", :context => "default", :hint => "", :status => "-1"}
+          end
+
+          context 'for a non-causal action' do
+            it 'should send a complete event to the component node' do
+              subject.action.response = response
+
+              command.should be_complete
+
+              command.complete_event.resource(0.5).reason.should == expected_complete_reason
+            end
+          end
+
+          context 'for a causal action' do
+            let :command do
+              Punchblock::Component::Asterisk::AMI::Action.new :name => 'CoreShowChannels'
+            end
+
+            let :expected_action do
+              RubyAMI::Action.new 'CoreShowChannels'
+            end
+
+            let :event do
+              RubyAMI::Event.new('CoreShowChannel').tap do |e|
+                e['ActionID']         = "552a9d9f-46d7-45d8-a257-06fe95f48d99"
+                e['Channel']          = 'SIP/127.0.0.1-00000013'
+                e['UniqueID']         = '1287686437.19'
+                e['Context']          = 'adhearsion'
+                e['Extension']        = '23432'
+                e['Priority']         = '2'
+                e['ChannelState']     = '6'
+                e['ChannelStateDesc'] = 'Up'
+              end
+            end
+
+            let :terminating_event do
+              RubyAMI::Event.new('CoreShowChannelsComplete').tap do |e|
+                e['EventList'] = 'Complete'
+                e['ListItems'] = '3'
+                e['ActionID'] = 'umtLtvSg-RN5n-GEay-Z786-YdiaSLNXkcYN'
+              end
+            end
+
+            let :event_node do
+              Punchblock::Event::Asterisk::AMI::Event.new :name => 'CoreShowChannel', :attributes => {
+                :channel          => 'SIP/127.0.0.1-00000013',
+                :uniqueid         => '1287686437.19',
+                :context          => 'adhearsion',
+                :extension        => '23432',
+                :priority         => '2',
+                :channelstate     => '6',
+                :channelstatedesc => 'Up'
+              }
+            end
+
+            let :expected_complete_reason do
+              Punchblock::Component::Asterisk::AMI::Action::Complete::Success.new :message => 'Channel status will follow', :attributes => {:exten => "idonno", :context => "default", :hint => "", :status => "-1", :eventlist => 'Complete', :listitems => '3'}
+            end
+
+            it 'should send events to the component node' do
+              command.register_event_handler Punchblock::Event::Asterisk::AMI::Event do |event|
+                @event = event
+              end
+              subject.action << event
+              subject.action << response
+              subject.action << terminating_event
+              @event.should == event_node
+            end
+
+            it 'should send a complete event to the component node' do
+              subject.action << response
+              subject.action << terminating_event
+
+              command.complete_event.resource(0.5).reason.should == expected_complete_reason
+            end
+          end
+
+          context 'with an error' do
+            let :error do
+              RubyAMI::Error.new.tap { |e| e.message = 'Action failed' }
+            end
+
+            let :expected_complete_reason do
+              Punchblock::Event::Complete::Error.new :details => 'Action failed'
+            end
+
+            it 'should send a complete event to the component node' do
+              subject.action << error
+
+              command.complete_event.resource(0.5).reason.should == expected_complete_reason
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/punchblock/translator/asterisk/call_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+module Punchblock
+  module Translator
+    class Asterisk
+      describe Call do
+        describe '#register_component' do
+          it 'should make the component accessible by ID' do
+            component_id = 'abc123'
+            component    = mock 'Translator::Asterisk::Component', :id => component_id
+            subject.register_component component
+            subject.component_with_id(component_id).should be component
+          end
+        end
+      end
+    end
+  end
+end

data/spec/punchblock/translator/asterisk/component_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+module Punchblock
+  module Translator
+    class Asterisk
+      describe Component do
+
+      end
+    end
+  end
+end

data/spec/punchblock/translator/asterisk_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+
+module Punchblock
+  module Translator
+    describe Asterisk do
+      let(:ami_client) { mock 'RubyAMI::Client' }
+      let(:connection) { mock 'Connection::Asterisk' }
+
+      subject { Asterisk.new ami_client, connection }
+
+      its(:ami_client) { should be ami_client }
+      its(:connection) { should be connection }
+
+      describe '#execute_command' do
+        describe 'with a call command' do
+          let(:command) { Command::Answer.new }
+          let(:call_id) { 'abc123' }
+
+          it 'executes the call command' do
+            subject.actor_subject.expects(:execute_call_command).with do |c|
+              c.should be command
+              c.call_id.should == call_id
+            end
+            subject.execute_command command, :call_id => call_id
+          end
+        end
+
+        describe 'with a component command' do
+          let(:command)       { Component::Stop.new }
+          let(:call_id)       { 'abc123' }
+          let(:component_id)  { '123abc' }
+
+          it 'executes the component command' do
+            subject.actor_subject.expects(:execute_component_command).with do |c|
+              c.should be command
+              c.call_id.should == call_id
+              c.component_id.should == component_id
+            end
+            subject.execute_command command, :call_id => call_id, :component_id => component_id
+          end
+        end
+
+        describe 'with a global command' do
+          let(:command) { Command::Dial.new }
+
+          it 'executes the command directly' do
+            subject.actor_subject.expects(:execute_global_command).with command
+            subject.execute_command command
+          end
+        end
+      end
+
+      describe '#register_call' do
+        it 'should make the call accessible by ID' do
+          call_id = 'abc123'
+          call    = mock 'Translator::Asterisk::Call', :id => call_id
+          subject.register_call call
+          subject.call_with_id(call_id).should be call
+        end
+      end
+
+      describe '#execute_call_command' do
+        let(:call_id) { 'abc123' }
+        let(:call)    { mock 'Translator::Asterisk::Call', :id => call_id }
+        let(:command) { mock 'Command::Answer', :call_id => call_id }
+
+        before do
+          subject.register_call call
+        end
+
+        it 'sends the command to the call for execution' do
+          call.expects(:execute_command).once.with command
+          subject.execute_call_command command
+        end
+      end
+
+      describe '#execute_component_command' do
+        let(:call_id) { 'abc123' }
+        let(:call)    { Translator::Asterisk::Call.new }
+
+        let(:component_id)  { '123abc' }
+        let(:component)     { mock 'Translator::Asterisk::Component', :id => component_id }
+
+        let(:command) { mock 'Component::Stop', :call_id => call_id, :component_id => component_id }
+
+        before do
+          call.stubs(:id).returns call_id
+          call.register_component component
+          subject.register_call call
+        end
+
+        it 'sends the command to the component for execution' do
+          component.expects(:execute_command).once.with command
+          subject.execute_component_command command
+        end
+      end
+
+      describe '#execute_global_command' do
+        context 'with a Dial' do
+          pending
+        end
+
+        context 'with an AMI action' do
+          let :command do
+            Component::Asterisk::AMI::Action.new :name => 'Status', :params => { :channel => 'foo' }
+          end
+
+          let(:mock_action) { mock 'Asterisk::AMIAction' }
+
+          it 'should create a component actor and execute it asynchronously' do
+            Asterisk::AMIAction.expects(:new).once.with(command, subject.ami_client).returns mock_action
+            mock_action.expects(:execute!).once
+            subject.execute_global_command command
+          end
+        end
+      end
+
+      describe '#handle_ami_event' do
+        let :ami_event do
+          RubyAMI::Event.new('Newchannel').tap do |e|
+            e['Channel']  = "SIP/101-3f3f"
+            e['State']    = "Ring"
+            e['Callerid'] = "101"
+            e['Uniqueid'] = "1094154427.10"
+          end
+        end
+
+        let :expected_pb_event do
+          Event::Asterisk::AMI::Event.new :name => 'Newchannel',
+                                          :attributes => { :channel  => "SIP/101-3f3f",
+                                                           :state    => "Ring",
+                                                           :callerid => "101",
+                                                           :uniqueid => "1094154427.10"}
+        end
+
+        it 'should create a Punchblock AMI event object and pass it to the connection' do
+          subject.connection.expects(:handle_event).once.with expected_pb_event
+          subject.handle_ami_event ami_event
+        end
+
+        context 'with something that is not a RubyAMI::Event' do
+          it 'does not send anything to the connection' do
+            subject.connection.expects(:handle_event).never
+            subject.handle_ami_event :foo
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -20,6 +20,7 @@ def import_stanza(xml)
   Blather::Stanza.import parse_stanza(xml).root
 end
 
+# FIXME: change this to rayo_event?  It can be ambigous
 shared_examples_for 'event' do
   its(:call_id) { should == '9f00061' }
   its(:component_id) { should == '1' }
@@ -41,3 +42,44 @@ shared_examples_for 'event_headers' do
   its(:headers) { should == [Punchblock::Header.new(:x_skill, 'agent'), Punchblock::Header.new(:x_customer_id, '8877')]}
   its(:headers_hash) { should == {:x_skill => 'agent', :x_customer_id => '8877'} }
 end
+
+shared_examples_for 'key_value_pairs' do
+  it 'will auto-inherit nodes' do
+    n = parse_stanza "<#{element_name} name='boo' value='bah' />"
+    h = class_name.new n.root
+    h.name.should == :boo
+    h.value.should == 'bah'
+  end
+
+  it 'has a name attribute' do
+    n = class_name.new :boo, 'bah'
+    n.name.should == :boo
+    n.name = :foo
+    n.name.should == :foo
+  end
+
+  it "substitutes - for _ on the name attribute when reading" do
+    n = parse_stanza "<#{element_name} name='boo-bah' value='foo' />"
+    h = class_name.new n.root
+    h.name.should == :boo_bah
+  end
+
+  it "substitutes _ for - on the name attribute when writing" do
+    h = class_name.new :boo_bah, 'foo'
+    h.to_xml.should == "<#{element_name} name=\"boo-bah\" value=\"foo\"/>"
+  end
+
+  it 'has a value param' do
+    n = class_name.new :boo, 'en'
+    n.value.should == 'en'
+    n.value = 'de'
+    n.value.should == 'de'
+  end
+
+  it 'can determine equality' do
+    a = class_name.new :boo, 'bah'
+    a.should == class_name.new(:boo, 'bah')
+    a.should_not == class_name.new(:bah, 'bah')
+    a.should_not == class_name.new(:boo, 'boo')
+  end
+end