jubjub 0.0.5 → 0.0.6

data/lib/jubjub/pubsub/configuration.rb

@@ -0,0 +1,5 @@
+require 'jubjub/data_form'
+
+class Jubjub::Pubsub::Configuration < Jubjub::DataForm
+  
+end

data/lib/jubjub/pubsub/item.rb

@@ -0,0 +1,35 @@
+class Jubjub::Pubsub::Item
+  
+  attr_reader :jid, :node, :item_id, :data
+  
+  def initialize(jid, node, item_id, data, connection)
+    @jid = Jubjub::Jid.new jid
+    @node = node
+    @item_id = item_id
+    @data = data
+    @connection = connection
+  end
+  
+  # Hide the connection details and show jid as string for compactness
+  def inspect
+    obj_id = "%x" % (object_id << 1)
+    "#<#{self.class}:0x#{obj_id} @jid=\"#{jid}\" @node=#{node.inspect} @item_id=#{item_id.inspect} @data=#{data.inspect}>"
+  end
+  
+  def retract
+    @connection.pubsub.retract jid, node, item_id
+  end
+  
+  def ==(other)
+    other.is_a?( self.class ) &&
+    other.jid     == self.jid &&
+    other.node    == self.node &&
+    other.item_id == self.item_id &&
+    other.data    == self.data
+  end
+  
+  def uri
+    "xmpp:#{@jid}?;node=#{@node};item=#{@item_id}"
+  end
+  
+end

data/lib/jubjub/pubsub/item_collection.rb

@@ -0,0 +1,35 @@
+class Jubjub::Pubsub::ItemCollection
+  
+  attr_reader :jid, :node
+  
+  def initialize(jid,node,connection)
+    @jid = Jubjub::Jid.new jid
+    @node = node
+    @connection = connection
+  end
+
+  def [](item_num)
+    case item_num
+    when Fixnum
+      items[item_num]
+    else
+      items.find{|i| i.item_id == item_num }        
+    end
+  end
+
+  # Hint that methods are actually applied to list using method_missing
+  def inspect
+    items.inspect
+  end
+
+private
+
+  def method_missing(name, *args, &block)
+    items.send(name, *args, &block)
+  end
+  
+  def items
+    @items ||= @connection.pubsub.retrieve_items( @jid, @node )
+  end
+  
+end

data/lib/jubjub/pubsub/pubsub.rb

@@ -0,0 +1,66 @@
+class Jubjub::Pubsub
+  
+  attr_reader :jid, :node
+  
+  def initialize(jid, node, connection)
+    @jid = Jubjub::Jid.new jid
+    @node = node
+    @connection = connection
+  end
+  
+  def destroy(redirect_jid = nil, redirect_node = nil)
+    redirect_jid = Jubjub::Jid.new(redirect_jid) if redirect_jid
+    @connection.pubsub.destroy jid, node, redirect_jid, redirect_node
+  end
+  
+  def purge
+    @connection.pubsub.purge jid, node
+  end
+  
+  def subscribe
+    @connection.pubsub.subscribe jid, node
+  end
+  
+  def unsubscribe(subid = nil)
+    @connection.pubsub.unsubscribe jid, node, subid      
+  end
+  
+  def publish(data, item_id = nil)
+    @connection.pubsub.publish jid, node, data, item_id
+  end
+  
+  def retract(item_id)
+    @connection.pubsub.retract jid, node, item_id
+  end
+  
+  # Hide the connection details and show jid as string for compactness
+  def inspect
+    obj_id = "%x" % (object_id << 1)
+    "#<#{self.class}:0x#{obj_id} @jid=\"#{jid}\" @node=#{node.inspect}>"
+  end
+  
+  def items
+    ItemCollection.new jid, node, @connection
+  end
+  
+  def affiliations
+    AffiliationCollection.new jid, node, @connection
+  end
+  
+  def uri
+    "xmpp:#{@jid}?;node=#{@node}"
+  end
+  
+  def ==(other)
+    other.is_a?( self.class ) &&
+    other.jid     == self.jid &&
+    other.node    == self.node
+  end
+  
+private
+
+  def method_missing(name, *args, &block)
+    items.send(name, *args, &block)
+  end
+  
+end

data/lib/jubjub/pubsub/subscription.rb

@@ -0,0 +1,24 @@
+class Jubjub::Pubsub::Subscription
+  
+  attr_reader :jid, :node, :subscriber, :subid, :subscription
+  
+  def initialize(jid, node, subscriber, subid, subscription, connection)
+    @jid          = Jubjub::Jid.new jid
+    @node         = node
+    @subscriber   = Jubjub::Jid.new subscriber
+    @subid        = subid
+    @subscription = subscription
+    @connection   = connection
+  end
+  
+  def unsubscribe
+    @connection.pubsub.unsubscribe jid, node, subid
+  end
+  
+  # Hide the connection details and show jid as string for compactness
+  def inspect
+    obj_id = "%x" % (object_id << 1)
+    "#<#{self.class}:0x#{obj_id} @jid=\"#{jid}\" @node=#{node.inspect} @subscriber=\"#{subscriber}\" @subid=#{subid.inspect} @subscription=#{subscription.inspect}>"
+  end
+  
+end

data/lib/jubjub/user.rb

@@ -54,12 +54,12 @@ module Jubjub
       # if no jid is specified will default to 'connection.JID_DOMAIN'
       def mucs(jid = nil)
         jid ||= "conference.#{jubjub_jid.domain}"
-        Jubjub::MucCollection.new jid, jubjub_connection
+        Jubjub::Muc::Collection.new jid, jubjub_connection
       end
       
       def pubsub(jid = nil)
         jid ||= "pubsub.#{jubjub_jid.domain}"
-        Jubjub::PubsubCollection.new jid, jubjub_connection
+        Jubjub::Pubsub::Collection.new jid, jubjub_connection
       end
     end
     

data/spec/connection/xmpp_gateway_muc_spec.rb

@@ -29,7 +29,7 @@ describe Jubjub::Connection::XmppGateway do
       use_vcr_cassette 'muc create with configuration', :record => :new_episodes
       
       it "return a Jubjub::Muc" do
-        @config = Jubjub::MucConfiguration.new("allow_query_users" => { :type => "boolean", :value => "1", :label => "Allow users to query other users" })
+        @config = Jubjub::Muc::Configuration.new("allow_query_users" => { :type => "boolean", :value => "1", :label => "Allow users to query other users" })
         
         @room = @connection.muc.create( Jubjub::Jid.new( 'room@conference.theo-template.local/nick' ), @config )
         @room.should be_a_kind_of Jubjub::Muc
@@ -46,7 +46,7 @@ describe Jubjub::Connection::XmppGateway do
       
       use_vcr_cassette 'muc configuration', :record => :new_episodes
       
-      it "return a Jubjub::MucConfiguration" do
+      it "return a Jubjub::Muc::Configuration" do
         config = @connection.muc.configuration( Jubjub::Jid.new 'room@conference.theo-template.local/nick' )
         
         expected_config = {
@@ -88,7 +88,7 @@ describe Jubjub::Connection::XmppGateway do
               { :value => "200", :label => "200" }]}
         }
         
-        config.should == Jubjub::MucConfiguration.new(expected_config)
+        config.should == Jubjub::Muc::Configuration.new(expected_config)
       end
       
     end

data/spec/connection/xmpp_gateway_pubsub_spec.rb

@@ -26,6 +26,67 @@ describe Jubjub::Connection::XmppGateway do
       end
     end
     
+    describe "default_configuration" do
+      use_vcr_cassette 'pubsub default configuration', :record => :new_episodes
+      
+      it "should return a Jubjub::Pubsub::Configuration" do
+        expected_config = {
+          "pubsub#deliver_payloads" => { :type => "boolean", :value => "1", :label => "Deliver payloads with event notifications" },
+          "pubsub#subscribe" => { :type => "boolean", :value => "1", :label => "Whether to allow subscriptions" },
+          "pubsub#notify_delete" => { :type => "boolean", :value => "0", :label => "Notify subscribers when the node is deleted" },
+          "pubsub#deliver_notifications" => { :type => "boolean", :value => "1", :label => "Deliver event notifications" },
+          "pubsub#persist_items" => { :type => "boolean", :value => "1", :label => "Persist items to storage" },
+          "pubsub#presence_based_delivery" => { :type => "boolean", :value => "0", :label => "Only deliver notifications to available users" },
+          "pubsub#notify_retract"  => { :type => "boolean", :value => "1", :label => "Notify subscribers when items are removed from the node" },
+          "pubsub#notify_config" => { :type => "boolean", :value => "0", :label => "Notify subscribers when the node configuration changes" },
+          "pubsub#max_payload_size"  => { :type => "text-single", :value => "60000", :label => "Max payload size in bytes" },
+          "pubsub#title" => { :type => "text-single", :value => "", :label => "A friendly name for the node" },
+          "pubsub#max_items" => { :type => "text-single", :value => "10", :label => "Max # of items to persist" },
+          "pubsub#collection" => { :type => "text-multi", :value => [], :label => "The collections with which a node is affiliated" },
+          "pubsub#roster_groups_allowed" => { :type => "list-multi", :value => [], :label => "Roster groups allowed to subscribe" },
+          "FORM_TYPE"  => { :type => "hidden", :value => "http://jabber.org/protocol/pubsub#node_config", :label => "" },
+          "pubsub#send_last_published_item" => {
+            :type => "list-single",
+            :value => "on_sub_and_presence",
+            :label => "When to send the last published item",
+            :options => [
+              { :value => "never",               :label => nil },
+              { :value => "on_sub",              :label => nil },
+              { :value => "on_sub_and_presence", :label => nil }]},
+          "pubsub#access_model" => {
+            :type    => "list-single",
+            :value   => "open",
+            :label   => "Specify the access model",
+            :options => [
+              { :value => "open",      :label => nil },
+              { :value => "authorize", :label => nil },
+              { :value => "presence",  :label => nil },
+              { :value => "roster",    :label => nil },
+              { :value => "whitelist", :label => nil }]},
+          "pubsub#publish_model" => {
+            :type => "list-single",
+            :value => "publishers",
+            :label => "Specify the publisher model",
+            :options => [
+              { :value => "publishers",  :label => nil },
+              { :value => "subscribers", :label => nil },
+              { :value => "open",        :label => nil }]},
+          "pubsub#notification_type" => {
+            :type    => "list-single",
+            :value   => "headline",
+            :label   => "Specify the event message type",
+            :options => [
+              { :value => "headline", :label => nil },
+              { :value => "normal",   :label => nil }]}
+        }
+        
+        config = @connection.pubsub.default_configuration 'pubsub.theo-template.local'
+        
+        config.should be_a_kind_of Jubjub::Pubsub::Configuration
+        config.should == Jubjub::Pubsub::Configuration.new( expected_config ) 
+      end
+    end
+    
     describe "destroy" do
       use_vcr_cassette 'pubsub destroy', :record => :new_episodes
       
@@ -40,6 +101,24 @@ describe Jubjub::Connection::XmppGateway do
       end
     end
     
+    describe "purge" do
+      use_vcr_cassette 'pubsub purge', :record => :new_episodes
+      
+      before do
+        @connection.pubsub.create 'pubsub.theo-template.local', 'node_pubsub_purge'
+      end
+      
+      it "should send correct stanza" do
+        # will attempt to create new vcr cassette if the stanza is wrong
+        # relies on cassette being manually checked
+        @connection.pubsub.purge('pubsub.theo-template.local', 'node_pubsub_purge').should be_true
+      end
+      
+      after do
+        @connection.pubsub.destroy 'pubsub.theo-template.local', 'node_pubsub_purge'
+      end
+    end
+    
     describe "list" do
       
       use_vcr_cassette 'pubsub list', :record => :new_episodes
@@ -91,10 +170,10 @@ describe Jubjub::Connection::XmppGateway do
         @connection.pubsub.create 'pubsub.theo-template.local', 'node_1'
       end
       
-      it "return a Jubjub::PubsubSubscription" do
+      it "return a Jubjub::Pubsub::Subscription" do
         @subscription = @connection.pubsub.subscribe( 'pubsub.theo-template.local', 'node_1' )
         
-        @subscription.should be_a_kind_of Jubjub::PubsubSubscription
+        @subscription.should be_a_kind_of Jubjub::Pubsub::Subscription
         @subscription.jid.should == Jubjub::Jid.new('pubsub.theo-template.local')
         @subscription.node.should == 'node_1'
         @subscription.subscriber.should == @jid
@@ -158,9 +237,9 @@ describe Jubjub::Connection::XmppGateway do
       describe "with id" do
         use_vcr_cassette 'pubsub publish with id', :record => :new_episodes
         
-        it "should return a Jubjub::PubsubItem" do
+        it "should return a Jubjub::Pubsub::Item" do
           i = @connection.pubsub.publish 'pubsub.theo-template.local', 'node_1', Jubjub::DataForm.new, '123'
-          i.should be_a_kind_of Jubjub::PubsubItem
+          i.should be_a_kind_of Jubjub::Pubsub::Item
           i.item_id.should == '123'
           i.data.should == "<x xmlns=\"jabber:x:data\" type=\"submit\"/>"
         end
@@ -170,10 +249,10 @@ describe Jubjub::Connection::XmppGateway do
       describe "with string payload" do
         use_vcr_cassette 'pubsub publish with string payload', :record => :new_episodes
         
-        it "should return a Jubjub::PubsubItem" do
+        it "should return a Jubjub::Pubsub::Item" do
           item = "<x xmlns=\"jabber:x:data\" type=\"submit\"><field var=\"foo\"><value>true</value></field></x>"
           i = @connection.pubsub.publish 'pubsub.theo-template.local', 'node_1', item
-          i.should be_a_kind_of Jubjub::PubsubItem
+          i.should be_a_kind_of Jubjub::Pubsub::Item
           i.item_id.should be_a_kind_of String
           i.data.should == "<x xmlns=\"jabber:x:data\" type=\"submit\">\n  <field var=\"foo\">\n    <value>true</value>\n  </field>\n</x>"
         end
@@ -183,9 +262,9 @@ describe Jubjub::Connection::XmppGateway do
       describe "with dataform payload" do
         use_vcr_cassette 'pubsub publish with dataform payload', :record => :new_episodes
         
-        it "should return a Jubjub::PubsubItem" do
+        it "should return a Jubjub::Pubsub::Item" do
           i = @connection.pubsub.publish 'pubsub.theo-template.local', 'node_1', Jubjub::DataForm.new({ :foo => {:type => "boolean", :value => true }})
-          i.should be_a_kind_of Jubjub::PubsubItem
+          i.should be_a_kind_of Jubjub::Pubsub::Item
           i.item_id.should be_a_kind_of String
           i.data.should == "<x xmlns=\"jabber:x:data\" type=\"submit\">\n  <field var=\"foo\">\n    <value>true</value>\n  </field>\n</x>"
         end
@@ -231,10 +310,10 @@ describe Jubjub::Connection::XmppGateway do
         @connection.pubsub.publish 'pubsub.theo-template.local', 'node_retrieve_items', Jubjub::DataForm.new(:foo => {:type => :boolean, :value => false}), 'abc'
       end
       
-      it "should return array of PubsubItem when successful" do
+      it "should return array of Pubsub::Item when successful" do
         expected = [
-          Jubjub::PubsubItem.new( 'pubsub.theo-template.local', 'node_retrieve_items', 'abc', "<x xmlns=\"jabber:x:data\" type=\"submit\">\n          <field var=\"foo\">\n            <value>false</value>\n          </field>\n        </x>", @connection ),
-          Jubjub::PubsubItem.new( 'pubsub.theo-template.local', 'node_retrieve_items', 'efg', "<x xmlns=\"jabber:x:data\" type=\"submit\">\n          <field var=\"bar\">\n            <value>true</value>\n          </field>\n        </x>", @connection )
+          Jubjub::Pubsub::Item.new( 'pubsub.theo-template.local', 'node_retrieve_items', 'abc', "<x xmlns=\"jabber:x:data\" type=\"submit\">\n          <field var=\"foo\">\n            <value>false</value>\n          </field>\n        </x>", @connection ),
+          Jubjub::Pubsub::Item.new( 'pubsub.theo-template.local', 'node_retrieve_items', 'efg', "<x xmlns=\"jabber:x:data\" type=\"submit\">\n          <field var=\"bar\">\n            <value>true</value>\n          </field>\n        </x>", @connection )
         ]
         
         @connection.pubsub.retrieve_items( 'pubsub.theo-template.local', 'node_retrieve_items' ).should == expected
@@ -250,6 +329,83 @@ describe Jubjub::Connection::XmppGateway do
       end
     end
     
+    describe "retrieve_affiliations" do
+      use_vcr_cassette 'pubsub retrieve affiliations', :record => :new_episodes
+      
+      it "should return array of Pubsub::Affiliation when successful" do
+        @connection.pubsub.create 'pubsub.theo-template.local', 'node_retrieve_affiliations'
+        
+        expected = [
+          Jubjub::Pubsub::Affiliation.new(
+            'pubsub.theo-template.local',
+            'node_retrieve_affiliations',
+            Jubjub::Jid.new('theozaurus@theo-template.local'),
+            'owner',
+            @connection 
+          )
+        ]
+        
+        @connection.pubsub.retrieve_affiliations( 'pubsub.theo-template.local', 'node_retrieve_affiliations' ).should == expected
+
+        # Clean up the node
+        @connection.pubsub.destroy 'pubsub.theo-template.local', 'node_retrieve_affiliations'
+      end
+      
+      it "should return empty array when not successful" do
+        @connection.pubsub.retrieve_affiliations( 'pubsub.theo-template.local', 'made-up' ).should == []
+      end
+    end
+    
+    describe "modify_affiliations" do
+      use_vcr_cassette 'pubsub modify affiliations', :record => :new_episodes
+            
+      it "should return true when successful" do
+        pubsub = 'pubsub.theo-template.local'
+        node = 'node_modify_affiliations_1'
+        @connection.pubsub.create pubsub, node
+        
+        affiliation = Jubjub::Pubsub::Affiliation.new pubsub, node, 'theozaurus@theo-template.local', 'owner', @connection
+        @connection.pubsub.modify_affiliations( pubsub, node, affiliation).should equal(true)
+        
+        @connection.pubsub.destroy pubsub, node
+      end
+      
+      it "should allow affiliations to be specified as an array" do
+        pubsub = 'pubsub.theo-template.local'
+        node = 'node_modify_affiliations_2'
+        @connection.pubsub.create pubsub, node
+        
+        affiliation_1 = Jubjub::Pubsub::Affiliation.new pubsub, node, 'theozaurus@theo-template.local','owner', @connection
+        affiliation_2 = Jubjub::Pubsub::Affiliation.new pubsub, node, 'trex@theo-template.local', 'publisher', @connection
+        @connection.pubsub.modify_affiliations pubsub, node, [affiliation_1, affiliation_2]
+        
+        @connection.pubsub.destroy pubsub, node
+      end
+      
+      it "should allow affiliations to be specified as arguments" do
+        pubsub = 'pubsub.theo-template.local'
+        node = 'node_modify_affiliations_3'
+        @connection.pubsub.create pubsub, node
+        
+        affiliation_1 = Jubjub::Pubsub::Affiliation.new pubsub, node, 'theozaurus@theo-template.local', 'owner', @connection
+        affiliation_2 = Jubjub::Pubsub::Affiliation.new pubsub, node, 'trex@theo-template.local', 'publisher', @connection
+        @connection.pubsub.modify_affiliations pubsub, node, affiliation_1, affiliation_2
+        
+        @connection.pubsub.destroy pubsub, node
+      end
+      
+      it "should return false if unsuccessful" do
+        pubsub = 'pubsub.theo-template.local'
+        node = 'node_modify_affiliations_4'
+        @connection.pubsub.create pubsub, node
+        
+        affiliation = Jubjub::Pubsub::Affiliation.new pubsub, node, 'theozaurus@theo-template.local', 'WIBBLE', @connection
+        @connection.pubsub.modify_affiliations( pubsub, node, affiliation ).should equal(false)
+        
+        @connection.pubsub.destroy pubsub, node
+      end
+    end
+    
   end
   
 end