blather 0.3.4 → 0.4.0

data/spec/blather/stanza/presence/subscription_spec.rb

@@ -1,28 +1,35 @@
 require File.join(File.dirname(__FILE__), *%w[.. .. .. spec_helper])
 
-describe 'Blather::Stanza::Presence::Subscription' do
+describe Blather::Stanza::Presence::Subscription do
   it 'registers itself' do
-    XMPPNode.class_from_registration(:subscription, nil).must_equal Stanza::Presence::Subscription
+    Blather::XMPPNode.class_from_registration(:subscription, nil).must_equal Blather::Stanza::Presence::Subscription
+  end
+
+  [:subscribe, :subscribed, :unsubscribe, :unsubscribed].each do |type|
+    it "must be importable as #{type}" do
+      doc = parse_stanza "<presence type='#{type}'/>"
+      Blather::XMPPNode.import(doc.root).must_be_instance_of Blather::Stanza::Presence::Subscription
+    end
   end
 
   it 'can set to on creation' do
-    sub = Stanza::Presence::Subscription.new 'a@b'
+    sub = Blather::Stanza::Presence::Subscription.new 'a@b'
     sub.to.to_s.must_equal 'a@b'
   end
 
   it 'can set a type on creation' do
-    sub = Stanza::Presence::Subscription.new nil, :subscribed
+    sub = Blather::Stanza::Presence::Subscription.new nil, :subscribed
     sub.type.must_equal :subscribed
   end
 
-  it 'strips JIDs when setting #to' do
-    sub = Stanza::Presence::Subscription.new 'a@b/c'
+  it 'strips Blather::JIDs when setting #to' do
+    sub = Blather::Stanza::Presence::Subscription.new 'a@b/c'
     sub.to.to_s.must_equal 'a@b'
   end
 
   it 'generates an approval using #approve!' do
-    jid = JID.new 'a@b'
-    sub = Stanza::Presence::Subscription.new
+    jid = Blather::JID.new 'a@b'
+    sub = Blather::Stanza::Presence::Subscription.new
     sub.from = jid
     sub.approve!
     sub.to.must_equal jid
@@ -30,8 +37,8 @@ describe 'Blather::Stanza::Presence::Subscription' do
   end
 
   it 'generates a refusal using #refuse!' do
-    jid = JID.new 'a@b'
-    sub = Stanza::Presence::Subscription.new
+    jid = Blather::JID.new 'a@b'
+    sub = Blather::Stanza::Presence::Subscription.new
     sub.from = jid
     sub.refuse!
     sub.to.must_equal jid
@@ -39,8 +46,8 @@ describe 'Blather::Stanza::Presence::Subscription' do
   end
 
   it 'generates an unsubscript using #unsubscribe!' do
-    jid = JID.new 'a@b'
-    sub = Stanza::Presence::Subscription.new
+    jid = Blather::JID.new 'a@b'
+    sub = Blather::Stanza::Presence::Subscription.new
     sub.from = jid
     sub.unsubscribe!
     sub.to.must_equal jid
@@ -48,8 +55,8 @@ describe 'Blather::Stanza::Presence::Subscription' do
   end
 
   it 'generates a cancellation using #cancel!' do
-    jid = JID.new 'a@b'
-    sub = Stanza::Presence::Subscription.new
+    jid = Blather::JID.new 'a@b'
+    sub = Blather::Stanza::Presence::Subscription.new
     sub.from = jid
     sub.cancel!
     sub.to.must_equal jid
@@ -57,8 +64,8 @@ describe 'Blather::Stanza::Presence::Subscription' do
   end
 
   it 'generates a request using #request!' do
-    jid = JID.new 'a@b'
-    sub = Stanza::Presence::Subscription.new
+    jid = Blather::JID.new 'a@b'
+    sub = Blather::Stanza::Presence::Subscription.new
     sub.from = jid
     sub.request!
     sub.to.must_equal jid
@@ -66,20 +73,33 @@ describe 'Blather::Stanza::Presence::Subscription' do
   end
 
   it 'has a #request? helper' do
-    sub = Stanza::Presence::Subscription.new
+    sub = Blather::Stanza::Presence::Subscription.new
     sub.must_respond_to :request?
     sub.type = :subscribe
     sub.request?.must_equal true
   end
 
+  it "successfully routes chained actions" do
+    from = Blather::JID.new("foo@bar.com")
+    to = Blather::JID.new("baz@quux.com")
+    sub = Blather::Stanza::Presence::Subscription.new
+    sub.from = from
+    sub.to = to
+    sub.cancel!
+    sub.unsubscribe!
+    sub.type.must_equal :unsubscribe
+    sub.to.must_equal from
+    sub.from.must_equal to
+  end
+
   it "will inherit only another node's attributes" do
-    inheritable = XMPPNode.new 'foo'
-    inheritable.attributes[:bar] = 'baz'
+    inheritable = Blather::XMPPNode.new 'foo'
+    inheritable[:bar] = 'baz'
 
-    sub = Stanza::Presence::Subscription.new
+    sub = Blather::Stanza::Presence::Subscription.new
     sub.must_respond_to :inherit
 
     sub.inherit inheritable
-    sub.attributes[:bar].must_equal 'baz'
+    sub[:bar].must_equal 'baz'
   end
 end

data/spec/blather/stanza/presence_spec.rb

@@ -1,53 +1,66 @@
 require File.join(File.dirname(__FILE__), *%w[.. .. spec_helper])
 
-describe 'Blather::Stanza::Presence' do
+describe Blather::Stanza::Presence do
   it 'registers itself' do
-    XMPPNode.class_from_registration(:presence, nil).must_equal Stanza::Presence
+    Blather::XMPPNode.class_from_registration(:presence, nil).must_equal Blather::Stanza::Presence
   end
 
-  it 'ensures type is one of Stanza::Presence::VALID_TYPES' do
-    presence = Stanza::Presence.new
+  it 'must be importable' do
+    doc = parse_stanza '<presence type="probe"/>'
+    Blather::XMPPNode.import(doc.root).must_be_instance_of Blather::Stanza::Presence
+  end
+
+  it 'ensures type is one of Blather::Stanza::Presence::VALID_TYPES' do
+    presence = Blather::Stanza::Presence.new
     lambda { presence.type = :invalid_type_name }.must_raise(Blather::ArgumentError)
 
-    Stanza::Presence::VALID_TYPES.each do |valid_type|
+    Blather::Stanza::Presence::VALID_TYPES.each do |valid_type|
       presence.type = valid_type
       presence.type.must_equal valid_type
     end
   end
 
-  Stanza::Presence::VALID_TYPES.each do |valid_type|
+  Blather::Stanza::Presence::VALID_TYPES.each do |valid_type|
     it "provides a helper (#{valid_type}?) for type #{valid_type}" do
-      Stanza::Presence.new.must_respond_to :"#{valid_type}?"
+      Blather::Stanza::Presence.new.must_respond_to :"#{valid_type}?"
+    end
+
+    it "returns true on call to (#{valid_type}?) if type == #{valid_type}" do
+      method = "#{valid_type}?".to_sym
+      pres = Blather::Stanza::Presence.new
+      pres.type = valid_type
+      pres.must_respond_to method
+      pres.__send__(method).must_equal true
     end
   end
 
   it 'creates a Status object when importing a node with type == nil' do
-    s = Stanza::Presence.import(XMPPNode.new)
-    s.must_be_kind_of Stanza::Presence::Status
+    s = Blather::Stanza::Presence.import(Blather::XMPPNode.new)
+    s.must_be_kind_of Blather::Stanza::Presence::Status
     s.state.must_equal :available
   end
 
   it 'creates a Status object when importing a node with type == "unavailable"' do
-    n = XMPPNode.new
-    n.attributes[:type] = :unavailable
-    s = Stanza::Presence.import(n)
-    s.must_be_kind_of Stanza::Presence::Status
+    n = Blather::XMPPNode.new
+    n[:type] = :unavailable
+    s = Blather::Stanza::Presence.import(n)
+    s.must_be_kind_of Blather::Stanza::Presence::Status
     s.state.must_equal :unavailable
   end
 
   it 'creates a Subscription object when importing a node with type == "subscribe"' do
-    n = XMPPNode.new
-    n.attributes[:type] = :subscribe
-    s = Stanza::Presence.import(n)
-    s.must_be_kind_of Stanza::Presence::Subscription
+    n = Blather::XMPPNode.new
+    n[:type] = :subscribe
+    s = Blather::Stanza::Presence.import(n)
+    s.must_be_kind_of Blather::Stanza::Presence::Subscription
     s.type.must_equal :subscribe
   end
 
   it 'creates a Presence object when importing a node with type equal to something unkown' do
-    n = XMPPNode.new
-    n.attributes[:type] = :foo
-    s = Stanza::Presence.import(n)
-    s.must_be_kind_of Stanza::Presence
+    n = Blather::XMPPNode.new
+    n[:type] = :foo
+    s = Blather::Stanza::Presence.import(n)
+    s.must_be_kind_of Blather::Stanza::Presence
     s.type.must_equal :foo
   end
 end

data/spec/blather/stanza/pubsub/affiliations_spec.rb

@@ -0,0 +1,57 @@
+require File.join(File.dirname(__FILE__), *%w[.. .. .. spec_helper])
+require File.join(File.dirname(__FILE__), *%w[.. .. .. fixtures pubsub])
+
+def control_affiliations
+  { :owner => ['node1', 'node2'],
+    :publisher => ['node3'],
+    :outcast => ['node4'],
+    :member => ['node5'],
+    :none => ['node6'] }
+end
+
+describe Blather::Stanza::PubSub::Affiliations do
+  it 'registers itself' do
+    Blather::XMPPNode.class_from_registration(:affiliations, Blather::Stanza::PubSub.registered_ns).must_equal Blather::Stanza::PubSub::Affiliations
+  end
+
+  it 'can be imported' do
+    Blather::XMPPNode.import(parse_stanza(affiliations_xml).root).must_be_instance_of Blather::Stanza::PubSub::Affiliations
+  end
+
+  it 'ensures an affiliations node is present on create' do
+    affiliations = Blather::Stanza::PubSub::Affiliations.new
+    affiliations.find_first('//ns:affiliations', :ns => Blather::Stanza::PubSub.registered_ns).wont_be_nil
+  end
+
+  it 'ensures an affiliations node exists when calling #affiliations' do
+    affiliations = Blather::Stanza::PubSub::Affiliations.new
+    affiliations.pubsub.remove_children :affiliations
+    affiliations.find_first('//ns:affiliations', :ns => Blather::Stanza::PubSub.registered_ns).must_be_nil
+
+    affiliations.affiliations.wont_be_nil
+    affiliations.find_first('//ns:affiliations', :ns => Blather::Stanza::PubSub.registered_ns).wont_be_nil
+  end
+
+  it 'defaults to a get node' do
+    Blather::Stanza::PubSub::Affiliations.new.type.must_equal :get
+  end
+
+  it 'sets the host if requested' do
+    aff = Blather::Stanza::PubSub::Affiliations.new :get, 'pubsub.jabber.local'
+    aff.to.must_equal Blather::JID.new('pubsub.jabber.local')
+  end
+
+  it 'can import an affiliates result node' do
+    node = parse_stanza(affiliations_xml).root
+
+    affiliations = Blather::Stanza::PubSub::Affiliations.new.inherit node
+    affiliations.size.must_equal 5
+    affiliations.list.must_equal control_affiliations
+  end
+
+  it 'will iterate over each affiliation' do
+    Blather::XMPPNode.import(parse_stanza(affiliations_xml).root).each do |type, nodes|
+      nodes.must_equal control_affiliations[type]
+    end
+  end
+end

data/spec/blather/stanza/pubsub/create_spec.rb

@@ -0,0 +1,56 @@
+require File.join(File.dirname(__FILE__), *%w[.. .. .. spec_helper])
+require File.join(File.dirname(__FILE__), *%w[.. .. .. fixtures pubsub])
+
+describe Blather::Stanza::PubSub::Create do
+  it 'registers itself' do
+    Blather::XMPPNode.class_from_registration(:create, 'http://jabber.org/protocol/pubsub').must_equal Blather::Stanza::PubSub::Create
+  end
+
+  it 'can be imported' do
+    Blather::XMPPNode.import(parse_stanza(<<-NODE).root).must_be_instance_of Blather::Stanza::PubSub::Create
+    <iq type='set'
+        from='hamlet@denmark.lit/elsinore'
+        to='pubsub.shakespeare.lit'
+        id='create1'>
+      <pubsub xmlns='http://jabber.org/protocol/pubsub'>
+        <create node='princely_musings'/>
+        <configure/>
+      </pubsub>
+    </iq>
+    NODE
+  end
+
+  it 'ensures a create node is present on create' do
+    create = Blather::Stanza::PubSub::Create.new
+    create.find('//ns:pubsub/ns:create', :ns => Blather::Stanza::PubSub.registered_ns).wont_be_empty
+  end
+
+  it 'ensures a configure node is present on create' do
+    create = Blather::Stanza::PubSub::Create.new
+    create.find('//ns:pubsub/ns:configure', :ns => Blather::Stanza::PubSub.registered_ns).wont_be_empty
+  end
+
+  it 'ensures a create node exists when calling #create_node' do
+    create = Blather::Stanza::PubSub::Create.new
+    create.pubsub.remove_children :create
+    create.find('//ns:pubsub/ns:create', :ns => Blather::Stanza::PubSub.registered_ns).must_be_empty
+
+    create.create_node.wont_be_nil
+    create.find('//ns:pubsub/ns:create', :ns => Blather::Stanza::PubSub.registered_ns).wont_be_empty
+  end
+
+  it 'defaults to a set node' do
+    create = Blather::Stanza::PubSub::Create.new
+    create.type.must_equal :set
+  end
+
+  it 'sets the host if requested' do
+    create = Blather::Stanza::PubSub::Create.new :set, 'pubsub.jabber.local'
+    create.to.must_equal Blather::JID.new('pubsub.jabber.local')
+  end
+
+  it 'sets the node' do
+    create = Blather::Stanza::PubSub::Create.new :set, 'host', 'node-name'
+    create.node.must_equal 'node-name'
+  end
+end

data/spec/blather/stanza/pubsub/event_spec.rb

@@ -0,0 +1,84 @@
+require File.join(File.dirname(__FILE__), *%w[.. .. .. spec_helper])
+require File.join(File.dirname(__FILE__), *%w[.. .. .. fixtures pubsub])
+
+describe Blather::Stanza::PubSub::Event do
+  it 'registers itself' do
+    Blather::XMPPNode.class_from_registration(:event, 'http://jabber.org/protocol/pubsub#event').must_equal Blather::Stanza::PubSub::Event
+  end
+
+  it 'is importable' do
+    Blather::XMPPNode.import(parse_stanza(event_notification_xml).root).must_be_instance_of Blather::Stanza::PubSub::Event
+  end
+
+  it 'ensures a query node is present on create' do
+    evt = Blather::Stanza::PubSub::Event.new
+    evt.find('ns:event', :ns => Blather::Stanza::PubSub::Event.registered_ns).wont_be_empty
+  end
+
+  it 'ensures an event node exists when calling #event_node' do
+    evt = Blather::Stanza::PubSub::Event.new
+    evt.remove_children :event
+    evt.find('*[local-name()="event"]').must_be_empty
+
+    evt.event_node.wont_be_nil
+    evt.find('ns:event', :ns => Blather::Stanza::PubSub::Event.registered_ns).wont_be_empty
+  end
+
+  it 'ensures an items node exists when calling #items_node' do
+    evt = Blather::Stanza::PubSub::Event.new
+    evt.remove_children :items
+    evt.find('*[local-name()="items"]').must_be_empty
+
+    evt.items_node.wont_be_nil
+    evt.find('ns:event/ns:items', :ns => Blather::Stanza::PubSub::Event.registered_ns).wont_be_empty
+  end
+
+  it 'knows the associated node name' do
+    evt = Blather::XMPPNode.import(parse_stanza(event_with_payload_xml).root)
+    evt.node.must_equal 'princely_musings'
+  end
+
+  it 'ensures newly inherited items are PubSubItem objects' do
+    evt = Blather::XMPPNode.import(parse_stanza(event_with_payload_xml).root)
+    evt.items?.must_equal true
+    evt.retractions?.must_equal false
+    evt.items.map { |i| i.class }.uniq.must_equal [Blather::Stanza::PubSub::PubSubItem]
+  end
+
+  it 'will iterate over each item' do
+    evt = Blather::XMPPNode.import(parse_stanza(event_with_payload_xml).root)
+    evt.items.each { |i| i.class.must_equal Blather::Stanza::PubSub::PubSubItem }
+  end
+
+  it 'handles receiving subscription ids' do
+    evt = Blather::XMPPNode.import(parse_stanza(event_subids_xml).root)
+    evt.subscription_ids.must_equal ['123-abc', '004-yyy']
+  end
+
+  it 'can have a list of retractions' do
+    evt = Blather::XMPPNode.import(parse_stanza(<<-NODE).root)
+    <message from='pubsub.shakespeare.lit' to='francisco@denmark.lit' id='foo'>
+      <event xmlns='http://jabber.org/protocol/pubsub#event'>
+        <items node='princely_musings'>
+          <retract id='ae890ac52d0df67ed7cfdf51b644e901'/>
+        </items>
+      </event>
+    </message>
+    NODE
+    evt.retractions?.must_equal true
+    evt.items?.must_equal false
+    evt.retractions.must_equal %w[ae890ac52d0df67ed7cfdf51b644e901]
+  end
+
+  it 'can be a purge' do
+    evt = Blather::XMPPNode.import(parse_stanza(<<-NODE).root)
+    <message from='pubsub.shakespeare.lit' to='francisco@denmark.lit' id='foo'>
+      <event xmlns='http://jabber.org/protocol/pubsub#event'>
+        <purge node='princely_musings'/>
+      </event>
+    </message>
+    NODE
+    evt.purge?.wont_be_nil
+    evt.node.must_equal 'princely_musings'
+  end
+end

data/spec/blather/stanza/pubsub/items_spec.rb

@@ -0,0 +1,79 @@
+require File.join(File.dirname(__FILE__), *%w[.. .. .. spec_helper])
+require File.join(File.dirname(__FILE__), *%w[.. .. .. fixtures pubsub])
+
+describe Blather::Stanza::PubSub::Items do
+  it 'registers itself' do
+    Blather::XMPPNode.class_from_registration(:items, 'http://jabber.org/protocol/pubsub').must_equal Blather::Stanza::PubSub::Items
+  end
+
+  it 'can be imported' do
+    Blather::XMPPNode.import(parse_stanza(items_all_nodes_xml).root).must_be_instance_of Blather::Stanza::PubSub::Items
+  end
+
+  it 'ensures an items node is present on create' do
+    items = Blather::Stanza::PubSub::Items.new
+    items.find('//ns:pubsub/ns:items', :ns => Blather::Stanza::PubSub.registered_ns).wont_be_empty
+  end
+
+  it 'ensures an items node exists when calling #items' do
+    items = Blather::Stanza::PubSub::Items.new
+    items.pubsub.remove_children :items
+    items.find('//ns:pubsub/ns:items', :ns => Blather::Stanza::PubSub.registered_ns).must_be_empty
+
+    items.items.wont_be_nil
+    items.find('//ns:pubsub/ns:items', :ns => Blather::Stanza::PubSub.registered_ns).wont_be_empty
+  end
+
+  it 'defaults to a get node' do
+    aff = Blather::Stanza::PubSub::Items.new
+    aff.type.must_equal :get
+  end
+
+  it 'ensures newly inherited items are PubSubItem objects' do
+    items = Blather::XMPPNode.import(parse_stanza(items_all_nodes_xml).root)
+    items.map { |i| i.class }.uniq.must_equal [Blather::Stanza::PubSub::PubSubItem]
+  end
+
+  it 'will iterate over each item' do
+    n = parse_stanza items_all_nodes_xml
+    items = Blather::Stanza::PubSub::Items.new.inherit n.root
+    count = 0
+    items.each { |i| i.must_be_instance_of Blather::Stanza::PubSub::PubSubItem; count += 1 }
+    count.must_equal 4
+  end
+
+  it 'can create an items request node to request all items' do
+    host = 'pubsub.jabber.local'
+    node = 'princely_musings'
+
+    items = Blather::Stanza::PubSub::Items.request host, node
+    items.find("//ns:items[@node=\"#{node}\"]", :ns => Blather::Stanza::PubSub.registered_ns).size.must_equal 1
+    items.to.must_equal Blather::JID.new(host)
+    items.node.must_equal node
+  end
+
+  it 'can create an items request node to request some items' do
+    host = 'pubsub.jabber.local'
+    node = 'princely_musings'
+    items = %w[item1 item2]
+
+    items_xpath = items.map { |i| "@id=\"#{i}\"" } * ' or '
+
+    items = Blather::Stanza::PubSub::Items.request host, node, items
+    items.find("//ns:items[@node=\"#{node}\"]/ns:item[#{items_xpath}]", :ns => Blather::Stanza::PubSub.registered_ns).size.must_equal 2
+    items.to.must_equal Blather::JID.new(host)
+    items.node.must_equal node
+  end
+
+  it 'can create an items request node to request "max_number" of items' do
+    host = 'pubsub.jabber.local'
+    node = 'princely_musings'
+    max = 3
+
+    items = Blather::Stanza::PubSub::Items.request host, node, nil, max
+    items.find("//ns:pubsub/ns:items[@node=\"#{node}\" and @max_items=\"#{max}\"]", :ns => Blather::Stanza::PubSub.registered_ns).size.must_equal 1
+    items.to.must_equal Blather::JID.new(host)
+    items.node.must_equal node
+    items.max_items.must_equal max
+  end
+end