punchblock 1.9.4 → 2.0.0.beta1

data/spec/punchblock/event/dtmf_spec.rb

@@ -6,29 +6,28 @@ module Punchblock
   class Event
     describe DTMF do
       it 'registers itself' do
-        RayoNode.class_from_registration(:dtmf, 'urn:xmpp:rayo:1').should be == DTMF
+        RayoNode.class_from_registration(:dtmf, 'urn:xmpp:rayo:1').should be == described_class
       end
 
       describe "from a stanza" do
         let(:stanza) { "<dtmf xmlns='urn:xmpp:rayo:1' signal='#' />" }
 
-        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+        subject { RayoNode.from_xml parse_stanza(stanza).root, '9f00061', '1' }
 
-        it { should be_instance_of DTMF }
+        it { should be_instance_of described_class }
 
         it_should_behave_like 'event'
 
         its(:signal) { should be == '#' }
-        its(:xmlns) { should be == 'urn:xmpp:rayo:1' }
       end
 
       describe "when setting options in initializer" do
         subject do
-          DTMF.new :signal => '#'
+          described_class.new :signal => '#'
         end
 
         its(:signal) { should be == '#' }
       end
     end
   end
-end # Punchblock
+end

data/spec/punchblock/event/end_spec.rb

@@ -6,14 +6,14 @@ module Punchblock
   class Event
     describe End do
       it 'registers itself' do
-        RayoNode.class_from_registration(:end, 'urn:xmpp:rayo:1').should be == End
+        RayoNode.class_from_registration(:end, 'urn:xmpp:rayo:1').should be == described_class
       end
 
       describe "from a stanza" do
         let :stanza do
           <<-MESSAGE
 <end xmlns="urn:xmpp:rayo:1">
-  <timeout />
+  <timeout platform-code="18" />
   <!-- Signaling (e.g. SIP) Headers -->
   <header name="X-skill" value="agent" />
   <header name="X-customer-id" value="8877" />
@@ -21,26 +21,36 @@ 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 End }
+        it { should be_instance_of described_class }
 
         it_should_behave_like 'event'
-        it_should_behave_like 'event_headers'
 
         its(:reason) { should be == :timeout }
-        its(:xmlns) { should be == 'urn:xmpp:rayo:1' }
+        its(:platform_code) { should be == '18' }
+        its(:headers) { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+
+        context "with no headers or reason provided" do
+          let(:stanza) { '<end xmlns="urn:xmpp:rayo:1"/>' }
+
+          its(:reason) { should be_nil}
+          its(:platform_code) { should be_nil }
+          its(:headers) { should == {} }
+        end
       end
 
       describe "when setting options in initializer" do
         subject do
-          End.new :reason => :hangup,
-                  :headers  => { :x_skill => "agent", :x_customer_id => "8877" }
+          described_class.new reason: :hangup,
+                              platform_code: 18,
+                              headers: { 'X-skill' => 'agent', 'X-customer-id' => '8877' }
         end
 
         its(:reason) { should be == :hangup }
-        it_should_behave_like 'command_headers'
+        its(:platform_code) { should be == '18' }
+        its(:headers) { should be == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
       end
     end
   end
-end # Punchblock
+end

data/spec/punchblock/event/joined_spec.rb

@@ -6,29 +6,30 @@ module Punchblock
   class Event
     describe Joined do
       it 'registers itself' do
-        RayoNode.class_from_registration(:joined, 'urn:xmpp:rayo:1').should be == Joined
+        RayoNode.class_from_registration(:joined, 'urn:xmpp:rayo:1').should be == described_class
       end
 
       describe "from a stanza" do
-        let(:stanza) { '<joined xmlns="urn:xmpp:rayo:1" call-id="b" mixer-name="m" />' }
+        let(:stanza) { '<joined xmlns="urn:xmpp:rayo:1" call-uri="b" mixer-name="m" />' }
 
-        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+        subject { RayoNode.from_xml parse_stanza(stanza).root, '9f00061', '1' }
 
-        it { should be_instance_of Joined }
+        it { should be_instance_of described_class }
 
         it_should_behave_like 'event'
 
+        its(:call_uri)    { should be == 'b' }
         its(:call_id)     { should be == 'b' }
         its(:mixer_name)  { should be == 'm' }
-        its(:xmlns)       { should be == 'urn:xmpp:rayo:1' }
       end
 
       describe "when setting options in initializer" do
-        subject { Joined.new :call_id => 'abc123', :mixer_name => 'blah' }
+        subject { described_class.new :call_uri => 'abc123', :mixer_name => 'blah' }
 
+        its(:call_uri)    { should be == 'abc123' }
         its(:call_id)     { should be == 'abc123' }
         its(:mixer_name)  { should be == 'blah' }
       end
     end
   end
-end # Punchblock
+end

data/spec/punchblock/event/offer_spec.rb

@@ -6,7 +6,7 @@ module Punchblock
   class Event
     describe Offer do
       it 'registers itself' do
-        RayoNode.class_from_registration(:offer, 'urn:xmpp:rayo:1').should be == Offer
+        RayoNode.class_from_registration(:offer, 'urn:xmpp:rayo:1').should be == described_class
       end
 
       describe "from a stanza" do
@@ -22,29 +22,58 @@ 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 Offer }
+        it { should be_instance_of described_class }
 
         it_should_behave_like 'event'
-        it_should_behave_like 'event_headers'
 
-        its(:to)    { should be == 'tel:+18003211212' }
-        its(:from)  { should be == 'tel:+13058881212' }
+        its(:to)      { should be == 'tel:+18003211212' }
+        its(:from)    { should be == 'tel:+13058881212' }
+        its(:headers) { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+
+        context "with no headers provided" do
+          let(:stanza) { '<offer xmlns="urn:xmpp:rayo:1"/>' }
+
+          its(:headers) { should == {} }
+        end
+
+        context "with multiple headers of the same name" do
+          let :stanza do
+            <<-MESSAGE
+<offer xmlns='urn:xmpp:rayo:1'
+    to='tel:+18003211212'
+    from='tel:+13058881212'>
+  <!-- Signaling (e.g. SIP) Headers -->
+  <header name="X-skill" value="sales" />
+  <header name="X-skill" value="complaints" />
+</offer>
+            MESSAGE
+          end
+
+          its(:headers) { should == {'X-skill' => ['sales', 'complaints']} }
+        end
       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" }
+          described_class.new to:      'tel:+18003211212',
+                              from:    'tel:+13058881212',
+                              headers: { 'X-skill' => 'agent', 'X-customer-id' => '8877' }
         end
 
-        it_should_behave_like 'command_headers'
-
         its(:to)    { should be == 'tel:+18003211212' }
         its(:from)  { should be == 'tel:+13058881212' }
+        its(:headers) { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+
+        context "with headers set to nil" do
+          subject do
+            described_class.new headers: nil
+          end
+
+          its(:headers) { should == {} }
+        end
       end
     end
   end
-end # Punchblock
+end

data/spec/punchblock/event/ringing_spec.rb

@@ -6,7 +6,7 @@ module Punchblock
   class Event
     describe Ringing do
       it 'registers itself' do
-        RayoNode.class_from_registration(:ringing, 'urn:xmpp:rayo:1').should be == Ringing
+        RayoNode.class_from_registration(:ringing, 'urn:xmpp:rayo:1').should be == described_class
       end
 
       describe "from a stanza" do
@@ -20,23 +20,25 @@ 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 Ringing }
+        it { should be_instance_of described_class }
 
         it_should_behave_like 'event'
-        it_should_behave_like 'event_headers'
+        its(:headers) { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
 
-        its(:xmlns) { should be == 'urn:xmpp:rayo:1' }
+        context "with no headers provided" do
+          let(:stanza) { '<ringing xmlns="urn:xmpp:rayo:1"/>' }
+
+          its(:headers) { should == {} }
+        end
       end
 
       describe "when setting options in initializer" do
-        subject do
-          Ringing.new :headers => { :x_skill => "agent", :x_customer_id => "8877" }
-        end
+        subject { described_class.new headers: { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
 
-        it_should_behave_like 'command_headers'
+        its(:headers) { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
       end
     end
   end
-end # Punchblock
+end

data/spec/punchblock/event/started_speaking_spec.rb

@@ -6,7 +6,7 @@ module Punchblock
   class Event
     describe StartedSpeaking do
       it 'registers itself' do
-        RayoNode.class_from_registration(:'started-speaking', 'urn:xmpp:rayo:1').should be == StartedSpeaking
+        RayoNode.class_from_registration(:'started-speaking', 'urn:xmpp:rayo:1').should be == described_class
       end
 
       describe "from a stanza" do
@@ -14,23 +14,22 @@ module Punchblock
           '<started-speaking xmlns="urn:xmpp:rayo:1" call-id="x0yz4ye-lx7-6ai9njwvw8nsb"/>'
         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 StartedSpeaking }
+        it { should be_instance_of described_class }
 
         it_should_behave_like 'event'
 
         its(:call_id) { should be == "x0yz4ye-lx7-6ai9njwvw8nsb" }
-        its(:xmlns)   { should be == 'urn:xmpp:rayo:1' }
       end
 
       describe "when setting options in initializer" do
         subject do
-          StartedSpeaking.new :call_id => 'abc123'
+          described_class.new :call_id => 'abc123'
         end
 
         its(:call_id) { should be == 'abc123' }
       end
     end
   end
-end # Punchblock
+end

data/spec/punchblock/event/stopped_speaking_spec.rb

@@ -6,7 +6,7 @@ module Punchblock
   class Event
     describe StoppedSpeaking do
       it 'registers itself' do
-        RayoNode.class_from_registration(:'stopped-speaking', 'urn:xmpp:rayo:1').should be == StoppedSpeaking
+        RayoNode.class_from_registration(:'stopped-speaking', 'urn:xmpp:rayo:1').should be == described_class
       end
 
       describe "from a stanza" do
@@ -14,23 +14,22 @@ module Punchblock
           '<stopped-speaking xmlns="urn:xmpp:rayo:1" call-id="x0yz4ye-lx7-6ai9njwvw8nsb"/>'
         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 StoppedSpeaking }
+        it { should be_instance_of described_class }
 
         it_should_behave_like 'event'
 
         its(:call_id) { should be == "x0yz4ye-lx7-6ai9njwvw8nsb" }
-        its(:xmlns)   { should be == 'urn:xmpp:rayo:1' }
       end
 
       describe "when setting options in initializer" do
         subject do
-          StoppedSpeaking.new :call_id => 'abc123'
+          described_class.new :call_id => 'abc123'
         end
 
         its(:call_id) { should be == 'abc123' }
       end
     end
   end
-end # Punchblock
+end

data/spec/punchblock/event/unjoined_spec.rb

@@ -6,29 +6,29 @@ module Punchblock
   class Event
     describe Unjoined do
       it 'registers itself' do
-        RayoNode.class_from_registration(:unjoined, 'urn:xmpp:rayo:1').should be == Unjoined
+        RayoNode.class_from_registration(:unjoined, 'urn:xmpp:rayo:1').should be == described_class
       end
 
       describe "from a stanza" do
-        let(:stanza) { '<unjoined xmlns="urn:xmpp:rayo:1" call-id="b" mixer-name="m" />' }
+        let(:stanza) { '<unjoined xmlns="urn:xmpp:rayo:1" call-uri="b" mixer-name="m" />' }
 
-        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+        subject { RayoNode.from_xml parse_stanza(stanza).root, '9f00061', '1' }
 
-        it { should be_instance_of Unjoined }
+        it { should be_instance_of described_class }
 
         it_should_behave_like 'event'
 
+        its(:call_uri)    { should be == 'b' }
         its(:call_id)     { should be == 'b' }
         its(:mixer_name)  { should be == 'm' }
-        its(:xmlns)       { should be == 'urn:xmpp:rayo:1' }
       end
 
       describe "when setting options in initializer" do
-        subject { Unjoined.new :call_id => 'abc123', :mixer_name => 'blah' }
+        subject { described_class.new :call_uri => 'abc123', :mixer_name => 'blah' }
 
         its(:call_id)     { should be == 'abc123' }
         its(:mixer_name)  { should be == 'blah' }
       end
     end
   end
-end # Punchblock
+end

data/spec/punchblock/ref_spec.rb

@@ -5,25 +5,102 @@ require 'spec_helper'
 module Punchblock
   describe Ref do
     it 'registers itself' do
-      RayoNode.class_from_registration(:ref, 'urn:xmpp:rayo:1').should be == Ref
+      RayoNode.class_from_registration(:ref, 'urn:xmpp:rayo:1').should be == described_class
     end
 
     describe "from a stanza" do
-      let(:stanza) { "<ref id='fgh4590' xmlns='urn:xmpp:rayo:1' />" }
+      let(:uri)     { 'some_uri' }
+      let(:stanza)  { "<ref uri='#{uri}' 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 Ref }
+      it { should be_instance_of described_class }
+      its(:target_call_id)  { should be == '9f00061' }
 
-      it_should_behave_like 'event'
+      context "when the URI isn't actually a URI" do
+        let(:uri) { 'fgh4590' }
 
-      its(:id) { should be == 'fgh4590' }
+        its(:uri)           { should be == URI('fgh4590') }
+        its(:scheme)        { should be == nil }
+        its(:call_id)       { should be == 'fgh4590' }
+        its(:domain)        { should be == nil }
+        its(:component_id)  { should be == 'fgh4590' }
+      end
+
+      context "when the URI is an XMPP JID" do
+        let(:uri) { 'xmpp:fgh4590@rayo.net/abc123' }
+
+        its(:uri)           { should be == URI('xmpp:fgh4590@rayo.net/abc123') }
+        its(:scheme)        { should be == 'xmpp' }
+        its(:call_id)       { should be == 'fgh4590' }
+        its(:domain)        { should be == 'rayo.net' }
+        its(:component_id)  { should be == 'abc123' }
+      end
+
+      context "when the URI is an asterisk UUID" do
+        let(:uri) { 'asterisk:fgh4590' }
+
+        its(:uri)           { should be == URI('asterisk:fgh4590') }
+        its(:scheme)        { should be == 'asterisk' }
+        its(:call_id)       { should be == 'fgh4590' }
+        its(:domain)        { should be == nil }
+        its(:component_id)  { should be == 'fgh4590' }
+      end
     end
 
     describe "when setting options in initializer" do
-      subject { Ref.new :id => 'foo' }
+      subject { Ref.new uri: uri }
+      let(:uri) { 'xmpp:fgh4590@rayo.net/abc123' }
+
+      its(:uri) { should be == URI('xmpp:fgh4590@rayo.net/abc123') }
+
+      describe "exporting to Rayo" do
+        context "when the URI isn't actually a URI" do
+          let(:uri) { 'fgh4590' }
+
+          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.uri.should == URI('fgh4590')
+          end
+        end
+
+        context "when the URI is an XMPP JID" do
+          let(:uri) { 'xmpp:fgh4590@rayo.net' }
+
+          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.uri.should == URI('xmpp:fgh4590@rayo.net')
+          end
+        end
+
+        context "when the URI is an asterisk UUID" do
+          let(:uri) { 'asterisk:fgh4590' }
+
+          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.uri.should == URI('asterisk:fgh4590')
+          end
+        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 }
 
-      its(:id) { should be == 'foo' }
+          it "should not include them in the XML representation" do
+            subject.to_rayo['uri'].should be_nil
+          end
+        end
+      end
     end
   end
-end # Punchblock
+end