punchblock 1.9.4 → 2.0.0.beta1

data/spec/punchblock/command/hangup_spec.rb

@@ -6,18 +6,52 @@ module Punchblock
   module Command
     describe Hangup do
       it 'registers itself' do
-        RayoNode.class_from_registration(:hangup, 'urn:xmpp:rayo:1').should be == Hangup
+        RayoNode.class_from_registration(:hangup, 'urn:xmpp:rayo:1').should be == described_class
       end
 
-      it_should_behave_like 'command_headers'
-
       describe "from a stanza" do
-        let(:stanza) { '<hangup xmlns="urn:xmpp:rayo:1"/>' }
+        let(:stanza) do
+          <<-STANZA
+            <hangup xmlns="urn:xmpp:rayo:1">
+              <header name="X-skill" value="agent" />
+              <header name="X-customer-id" value="8877" />
+            </hangup>
+          STANZA
+        end
+
+        subject { RayoNode.from_xml parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of described_class }
+        its(:headers) { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+
+        context "with no headers provided" do
+          let(:stanza) { '<hangup xmlns="urn:xmpp:rayo:1"/>' }
+
+          its(:headers) { should == {} }
+        end
+      end
+
+      describe "when setting options in initializer" do
+        subject { described_class.new headers: { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+
+        its(:headers) { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
 
-        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+        describe "exporting to Rayo" do
+          it "should export to XML that can be understood by its parser" do
+            new_instance = RayoNode.from_xml subject.to_rayo
+            new_instance.should be_instance_of described_class
+            new_instance.headers.should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' }
+          end
 
-        it { should be_instance_of Hangup }
+          it "should render to a parent node if supplied" do
+            doc = Nokogiri::XML::Document.new
+            parent = Nokogiri::XML::Node.new 'foo', doc
+            doc.root = parent
+            rayo_doc = subject.to_rayo(parent)
+            rayo_doc.should == parent
+          end
+        end
       end
     end
   end
-end # Punchblock
+end

data/spec/punchblock/command/join_spec.rb

@@ -5,59 +5,101 @@ require 'spec_helper'
 module Punchblock
   module Command
     describe Join do
-
       it 'registers itself' do
-        RayoNode.class_from_registration(:join, 'urn:xmpp:rayo:1').should be == Join
+        RayoNode.class_from_registration(:join, 'urn:xmpp:rayo:1').should be == described_class
       end
 
       describe "when setting options in initializer" do
-        subject { Join.new :call_id => 'abc123', :mixer_name => 'blah', :direction => :duplex, :media => :bridge }
+        subject { described_class.new :call_uri => 'abc123', :mixer_name => 'blah', :direction => :duplex, :media => :bridge }
 
-        its(:call_id)     { should be == 'abc123' }
+        its(:call_uri)    { should be == 'abc123' }
         its(:mixer_name)  { should be == 'blah' }
         its(:direction)   { should be == :duplex }
         its(:media)       { should be == :bridge }
+
+        context "with old call_id attribute" do
+          subject { described_class.new call_id: 'abc123' }
+
+          its(:call_uri)  { should be == 'abc123' }
+        end
+
+        describe "exporting to Rayo" do
+          it "should export to XML that can be understood by its parser" do
+            new_instance = RayoNode.from_xml subject.to_rayo
+            new_instance.should be_instance_of described_class
+            new_instance.call_uri.should == 'abc123'
+            new_instance.mixer_name.should == 'blah'
+            new_instance.direction.should == :duplex
+            new_instance.media.should == :bridge
+          end
+
+          it "should render to a parent node if supplied" do
+            doc = Nokogiri::XML::Document.new
+            parent = Nokogiri::XML::Node.new 'foo', doc
+            doc.root = parent
+            rayo_doc = subject.to_rayo(parent)
+            rayo_doc.should == parent
+          end
+
+          context "when attributes are not set" do
+            subject { described_class.new call_uri: 'abc123' }
+
+            it "should not include them in the XML representation" do
+              subject.to_rayo['call-uri'].should == 'abc123'
+              subject.to_rayo['mixer-name'].should be_nil
+            end
+          end
+        end
       end
 
       describe "from a stanza" do
         let :stanza do
           <<-MESSAGE
 <join xmlns="urn:xmpp:rayo:1"
-      call-id="abc123"
+      call-uri="abc123"
       mixer-name="blah"
       direction="duplex"
       media="bridge" />
           MESSAGE
         end
 
-        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+        subject { RayoNode.from_xml parse_stanza(stanza).root, '9f00061', '1' }
 
-        it { should be_instance_of Join }
+        it { should be_instance_of described_class }
 
-        its(:call_id)     { should be == 'abc123' }
+        its(:call_uri)    { should be == 'abc123' }
         its(:mixer_name)  { should be == 'blah' }
         its(:direction)   { should be == :duplex }
         its(:media)       { should be == :bridge }
+
+        context "when no attributes are set" do
+          let(:stanza) { '<join xmlns="urn:xmpp:rayo:1" />' }
+
+          its(:call_uri)    { should be_nil }
+          its(:mixer_name)  { should be_nil }
+          its(:direction)   { should be_nil }
+          its(:media)       { should be_nil }
+        end
       end
 
       describe "with a direction" do
         [nil, :duplex, :send, :recv].each do |direction|
           describe direction do
-            subject { Join.new :direction => direction }
+            subject { described_class.new :direction => direction }
 
             its(:direction) { should be == direction }
           end
         end
 
         describe "no direction" do
-          subject { Join.new }
+          subject { described_class.new }
 
           its(:direction) { should be_nil }
         end
 
         describe "blahblahblah" do
           it "should raise an error" do
-            expect { Join.new(:direction => :blahblahblah) }.to raise_error ArgumentError
+            expect { described_class.new(:direction => :blahblahblah) }.to raise_error ArgumentError
           end
         end
       end

data/spec/punchblock/command/mute_spec.rb

@@ -6,16 +6,31 @@ module Punchblock
   module Command
     describe Mute do
       it 'registers itself' do
-        RayoNode.class_from_registration(:mute, 'urn:xmpp:rayo:1').should be == Mute
+        RayoNode.class_from_registration(:mute, 'urn:xmpp:rayo:1').should be == described_class
       end
 
       describe "from a stanza" do
         let(:stanza) { '<mute xmlns="urn:xmpp:rayo:1"/>' }
 
-        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+        subject { RayoNode.from_xml parse_stanza(stanza).root, '9f00061', '1' }
 
-        it { should be_instance_of Mute }
+        it { should be_instance_of described_class }
+      end
+
+      describe "exporting to Rayo" do
+        it "should export to XML that can be understood by its parser" do
+          new_instance = RayoNode.from_xml subject.to_rayo
+          new_instance.should be_instance_of described_class
+        end
+
+        it "should render to a parent node if supplied" do
+          doc = Nokogiri::XML::Document.new
+          parent = Nokogiri::XML::Node.new 'foo', doc
+          doc.root = parent
+          rayo_doc = subject.to_rayo(parent)
+          rayo_doc.should == parent
+        end
       end
     end
   end
-end # Punchblock
+end

data/spec/punchblock/command/redirect_spec.rb

@@ -6,15 +6,39 @@ module Punchblock
   module Command
     describe Redirect do
       it 'registers itself' do
-        RayoNode.class_from_registration(:redirect, 'urn:xmpp:rayo:1').should be == Redirect
+        RayoNode.class_from_registration(:redirect, 'urn:xmpp:rayo:1').should be == described_class
       end
 
       describe "when setting options in initializer" do
-        subject { Redirect.new :to => 'tel:+14045551234', :headers => { :x_skill => 'agent', :x_customer_id => 8877 } }
-
-        it_should_behave_like 'command_headers'
+        subject { described_class.new to: 'tel:+14045551234', headers: { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
 
         its(:to) { should be == 'tel:+14045551234' }
+        its(:headers) { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+
+        describe "exporting to Rayo" do
+          it "should export to XML that can be understood by its parser" do
+            new_instance = RayoNode.from_xml subject.to_rayo
+            new_instance.should be_instance_of described_class
+            new_instance.to.should == 'tel:+14045551234'
+            new_instance.headers.should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' }
+          end
+
+          it "should render to a parent node if supplied" do
+            doc = Nokogiri::XML::Document.new
+            parent = Nokogiri::XML::Node.new 'foo', doc
+            doc.root = parent
+            rayo_doc = subject.to_rayo(parent)
+            rayo_doc.should == parent
+          end
+
+          context "when attributes are not set" do
+            subject { described_class.new }
+
+            it "should not include them in the XML representation" do
+              subject.to_rayo['to'].should be_nil
+            end
+          end
+        end
       end
 
       describe "from a stanza" do
@@ -23,19 +47,25 @@ module Punchblock
 <redirect xmlns='urn:xmpp:rayo:1'
     to='tel:+14045551234'>
   <!-- Signaling (e.g. SIP) Headers -->
-  <header name="x-skill" value="agent" />
-  <header name="x-customer-id" value="8877" />
+  <header name="X-skill" value="agent" />
+  <header name="X-customer-id" value="8877" />
 </redirect>
           MESSAGE
         end
 
-        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
-
-        it { should be_instance_of Redirect }
+        subject { RayoNode.from_xml parse_stanza(stanza).root, '9f00061', '1' }
 
-        it_should_behave_like 'command_headers'
+        it { should be_instance_of described_class }
 
         its(:to) { should be == 'tel:+14045551234' }
+        its(:headers) { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+
+        context "with no headers or to provided" do
+          let(:stanza) { '<redirect xmlns="urn:xmpp:rayo:1"/>' }
+
+          its(:to) { should be_nil }
+          its(:headers) { should == {} }
+        end
       end
     end # Redirect
   end # Command

data/spec/punchblock/command/reject_spec.rb

@@ -6,15 +6,39 @@ module Punchblock
   module Command
     describe Reject do
       it 'registers itself' do
-        RayoNode.class_from_registration(:reject, 'urn:xmpp:rayo:1').should be == Reject
+        RayoNode.class_from_registration(:reject, 'urn:xmpp:rayo:1').should be == described_class
       end
 
       describe "when setting options in initializer" do
-        subject { Reject.new :reason => :busy, :headers => { :x_skill => 'agent', :x_customer_id => 8877 } }
-
-        it_should_behave_like 'command_headers'
+        subject { described_class.new reason: :busy, headers: { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
 
         its(:reason) { should be == :busy }
+        its(:headers) { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+
+        describe "exporting to Rayo" do
+          it "should export to XML that can be understood by its parser" do
+            new_instance = RayoNode.from_xml subject.to_rayo
+            new_instance.should be_instance_of described_class
+            new_instance.reason.should == :busy
+            new_instance.headers.should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' }
+          end
+
+          it "should render to a parent node if supplied" do
+            doc = Nokogiri::XML::Document.new
+            parent = Nokogiri::XML::Node.new 'foo', doc
+            doc.root = parent
+            rayo_doc = subject.to_rayo(parent)
+            rayo_doc.should == parent
+          end
+
+          context "when attributes are not set" do
+            subject { described_class.new }
+
+            it "should not include them in the XML representation" do
+              subject.to_rayo.children.count.should == 0
+            end
+          end
+        end
       end
 
       describe "from a stanza" do
@@ -23,37 +47,45 @@ module Punchblock
 <reject xmlns='urn:xmpp:rayo:1'>
   <busy />
   <!-- Sample Headers (optional) -->
-  <header name="x-reason-internal" value="bad-skill" />
+  <header name="X-skill" value="agent" />
+  <header name="X-customer-id" value="8877" />
 </reject>
           MESSAGE
         end
 
-        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+        subject { RayoNode.from_xml parse_stanza(stanza).root, '9f00061', '1' }
 
-        it { should be_instance_of Reject }
+        it { should be_instance_of described_class }
 
         its(:reason) { should be == :busy }
-        its(:headers_hash) { should be == { :x_reason_internal => 'bad-skill' } }
+        its(:headers) { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+
+        context "with no headers or reason provided" do
+          let(:stanza) { '<reject xmlns="urn:xmpp:rayo:1"/>' }
+
+          its(:reason) { should be_nil }
+          its(:headers) { should == {} }
+        end
       end
 
       describe "with the reason" do
         [nil, :decline, :busy, :error].each do |reason|
           describe reason do
-            subject { Reject.new :reason => reason }
+            subject { described_class.new :reason => reason }
 
             its(:reason) { should be == reason }
           end
         end
 
         describe "no reason" do
-          subject { Reject.new }
+          subject { described_class.new }
 
           its(:reason) { should be_nil }
         end
 
         describe "blahblahblah" do
           it "should raise an error" do
-            expect { Reject.new(:reason => :blahblahblah) }.to raise_error ArgumentError
+            expect { described_class.new(:reason => :blahblahblah) }.to raise_error ArgumentError
           end
         end
       end

data/spec/punchblock/command/unjoin_spec.rb

@@ -5,34 +5,65 @@ require 'spec_helper'
 module Punchblock
   module Command
     describe Unjoin do
-
       it 'registers itself' do
-        RayoNode.class_from_registration(:unjoin, 'urn:xmpp:rayo:1').should be == Unjoin
+        RayoNode.class_from_registration(:unjoin, 'urn:xmpp:rayo:1').should be == described_class
       end
 
       describe "when setting options in initializer" do
-        subject { Unjoin.new :call_id => 'abc123', :mixer_name => 'blah' }
+        subject { Unjoin.new :call_uri => 'abc123', :mixer_name => 'blah' }
 
-        its(:call_id)     { should be == 'abc123' }
+        its(:call_uri)    { should be == 'abc123' }
         its(:mixer_name)  { should be == 'blah' }
+
+        context "with old call_id attribute" do
+          subject { described_class.new call_id: 'abc123' }
+
+          its(:call_uri)  { should be == 'abc123' }
+        end
+
+        describe "exporting to Rayo" do
+          it "should export to XML that can be understood by its parser" do
+            new_instance = RayoNode.from_xml subject.to_rayo
+            new_instance.should be_instance_of described_class
+            new_instance.call_uri.should == 'abc123'
+            new_instance.mixer_name.should == 'blah'
+          end
+
+          it "should render to a parent node if supplied" do
+            doc = Nokogiri::XML::Document.new
+            parent = Nokogiri::XML::Node.new 'foo', doc
+            doc.root = parent
+            rayo_doc = subject.to_rayo(parent)
+            rayo_doc.should == parent
+          end
+
+          context "when attributes are not set" do
+            subject { described_class.new call_uri: 'abc123' }
+
+            it "should not include them in the XML representation" do
+              subject.to_rayo['call-uri'].should == 'abc123'
+              subject.to_rayo['mixer-name'].should be_nil
+            end
+          end
+        end
       end
 
       describe "from a stanza" do
         let :stanza do
           <<-MESSAGE
 <unjoin xmlns="urn:xmpp:rayo:1"
-      call-id="abc123"
+      call-uri="abc123"
       mixer-name="blah" />
           MESSAGE
         end
 
-        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+        subject { RayoNode.from_xml parse_stanza(stanza).root, '9f00061', '1' }
 
-        it { should be_instance_of Unjoin }
+        it { should be_instance_of described_class }
 
-        its(:call_id)     { should be == 'abc123' }
+        its(:call_uri)    { should be == 'abc123' }
         its(:mixer_name)  { should be == 'blah' }
       end
     end
   end
-end # Punchblock
+end

data/spec/punchblock/command/unmute_spec.rb

@@ -6,16 +6,31 @@ module Punchblock
   module Command
     describe Unmute do
       it 'registers itself' do
-        RayoNode.class_from_registration(:unmute, 'urn:xmpp:rayo:1').should be == Unmute
+        RayoNode.class_from_registration(:unmute, 'urn:xmpp:rayo:1').should be == described_class
       end
 
       describe "from a stanza" do
         let(:stanza) { '<unmute xmlns="urn:xmpp:rayo:1"/>' }
 
-        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+        subject { RayoNode.from_xml parse_stanza(stanza).root, '9f00061', '1' }
 
-        it { should be_instance_of Unmute }
+        it { should be_instance_of described_class }
+      end
+
+      describe "exporting to Rayo" do
+        it "should export to XML that can be understood by its parser" do
+          new_instance = RayoNode.from_xml subject.to_rayo
+          new_instance.should be_instance_of described_class
+        end
+
+        it "should render to a parent node if supplied" do
+          doc = Nokogiri::XML::Document.new
+          parent = Nokogiri::XML::Node.new 'foo', doc
+          doc.root = parent
+          rayo_doc = subject.to_rayo(parent)
+          rayo_doc.should == parent
+        end
       end
     end
   end
-end # Punchblock
+end

data/spec/punchblock/command_node_spec.rb

@@ -31,10 +31,6 @@ module Punchblock
         it "should raise a StateMachine::InvalidTransition when received a second time" do
           lambda { subject.request! }.should raise_error(StateMachine::InvalidTransition)
         end
-
-        it "should prevent altering attributes" do
-          lambda { subject.write_attr :foo, 'bar' }.should raise_error(StandardError, "Cannot alter attributes of a requested command")
-        end
       end
 
       describe "#execute!" do

data/spec/punchblock/component/asterisk/agi/command_spec.rb

@@ -8,7 +8,7 @@ module Punchblock
       module AGI
         describe Command do
           it 'registers itself' do
-            RayoNode.class_from_registration(:command, 'urn:xmpp:rayo:asterisk:agi:1').should be == Command
+            RayoNode.class_from_registration(:command, 'urn:xmpp:rayo:asterisk:agi:1').should be == described_class
           end
 
           describe "from a stanza" do
@@ -20,50 +20,27 @@ module Punchblock
               MESSAGE
             end
 
-            subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+            subject { RayoNode.from_xml parse_stanza(stanza).root, '9f00061', '1' }
 
             it { should be_instance_of Command }
 
             it_should_behave_like 'event'
 
-            its(:name)          { should be == 'GET VARIABLE' }
-            its(:params)        { should be == [Command::Param.new('UNIQUEID')] }
-            its(:params_array)  { should be == ['UNIQUEID'] }
+            its(:name)    { should be == 'GET VARIABLE' }
+            its(:params)  { should be == ['UNIQUEID'] }
           end
 
           describe "when setting options in initializer" do
             subject do
-              Command.new :name => 'GET VARIABLE',
-                          :params => ['UNIQUEID']
+              described_class.new name: 'GET VARIABLE',
+                                  params: ['UNIQUEID']
             end
 
-            its(:name)          { should be == 'GET VARIABLE' }
-            its(:params)        { should be == [Command::Param.new('UNIQUEID')] }
-            its(:params_array)  { should be == ['UNIQUEID'] }
+            its(:name)    { should be == 'GET VARIABLE' }
+            its(:params)  { should be == ['UNIQUEID'] }
           end
 
           class Command
-            describe Param do
-              it 'will auto-inherit nodes' do
-                n = parse_stanza "<param value='bah' />"
-                h = Param.new n.root
-                h.value.should be == 'bah'
-              end
-
-              it 'has a value attribute' do
-                n = Param.new 'en'
-                n.value.should be == 'en'
-                n.value = 'de'
-                n.value.should be == 'de'
-              end
-
-              it 'can determine equality' do
-                a = Param.new 'bah'
-                a.should be == Param.new('bah')
-                a.should_not be == Param.new('boo')
-              end
-            end
-
             describe Complete::Success do
               let :stanza do
                 <<-MESSAGE
@@ -77,9 +54,9 @@ module Punchblock
                 MESSAGE
               end
 
-              subject { RayoNode.import(parse_stanza(stanza).root).reason }
+              subject { RayoNode.from_xml(parse_stanza(stanza).root).reason }
 
-              it { should be_instance_of Complete::Success }
+              it { should be_instance_of described_class }
 
               its(:name)    { should be == :success }
               its(:code)    { should be == 200 }
@@ -88,7 +65,7 @@ module Punchblock
 
               describe "when setting options in initializer" do
                 subject do
-                  Complete::Success.new :code => 200, :result => 0, :data => '1187188485.0'
+                  Complete::Success.new code: 200, result: 0, data: '1187188485.0'
                 end
 
                 its(:code)    { should be == 200 }
@@ -97,8 +74,8 @@ module Punchblock
               end
             end
           end
-        end # Command
-      end # AGI
-    end # Asterisk
-  end # Component
-end # Punchblock
+        end
+      end
+    end
+  end
+end