jubjub 0.0.5 → 0.0.6

data/README.mdown

@@ -97,17 +97,22 @@ Examples
     node = u.pubsub.create('node_1')
     => #<Jubjub::Pubsub:0x101f3bae0 @service="pubsub.jabber.org" @node="node_1">
     
+    # Create a pubsub node with a custom configuration
+    u.pubsub.create('node_2'){|c|
+      c['pubsub#title'] = "Node 2" 
+    }
+    
     # Subscribe to node
     subscription = node.subscribe
-    => #<Jubjub::PubsubSubscription:0x101effd60 @service="pubsub.jabber.org" @node="node_1" @subscriber="theozaurus@jabber.org" @subid="5129CD7935528" @subscription="subscribed">
+    => #<Jubjub::Pubsub::Subscription:0x101effd60 @service="pubsub.jabber.org" @node="node_1" @subscriber="theozaurus@jabber.org" @subid="5129CD7935528" @subscription="subscribed">
     
     # Subscribe to something else
     u.pubsub.subscribe('new_thing')
-    => #<Jubjub::PubsubSubscription:0x101effd60 @service="pubsub.jabber.org" @node="new_thing" @subscriber="theozaurus@jabber.org" @subid="5129CD7935528" @subscription="subscribed">
+    => #<Jubjub::Pubsub::Subscription:0x101effd60 @service="pubsub.jabber.org" @node="new_thing" @subscriber="theozaurus@jabber.org" @subid="5129CD7935528" @subscription="subscribed">
     
     # Publish to a node
     item = u.pubsub['node_1'].publish(Jubjub::DataForm.new({:foo => {:type => 'boolean', :value => 'bar'}}))
-    => #<Jubjub::PubsubItem:0x101f2e9f8 @jid="pubsub.jabber.org" @node="node_1" @item_id="519DCAA72FFD6" @data="<x xmlns=\"jabber:x:data\" type=\"submit\">\n  <field var=\"foo\">\n    <value>false</value>\n  </field>\n</x>"> 
+    => #<Jubjub::Pubsub::Item:0x101f2e9f8 @jid="pubsub.jabber.org" @node="node_1" @item_id="519DCAA72FFD6" @data="<x xmlns=\"jabber:x:data\" type=\"submit\">\n  <field var=\"foo\">\n    <value>false</value>\n  </field>\n</x>"> 
     
     # Retract an item from a node
     item.retract
@@ -120,13 +125,45 @@ Examples
     # List items on a node
     u.pubsub['node_1'].items
     => [
-      #<Jubjub::PubsubItem:0x101f7bd48 @jid="pubsub.jabber.org" @node="node_1" @item_id="519DCAA72FFD6" @data="...">,
+      #<Jubjub::Pubsub::Item:0x101f7bd48 @jid="pubsub.jabber.org" @node="node_1" @item_id="519DCAA72FFD6" @data="...">,
       ...
     ]
     
     # Retrieve an item from a node
     u.pubsub['node_1'].items['519DCAA72FFD6']
-    => #<Jubjub::PubsubItem:0x101f7bd48 @jid="pubsub.jabber.org" @node="node_1" @item_id="519DCAA72FFD6" @data="...">
+    => #<Jubjub::Pubsub::Item:0x101f7bd48 @jid="pubsub.jabber.org" @node="node_1" @item_id="519DCAA72FFD6" @data="...">
+    
+    # Retrieve affiliations from a node
+    u.pubsub['node_1'].affiliations
+    => [
+      #<Jubjub::Pubsub::Affiliation:0x101f52830 @pubsub_jid="pubsub.jabber.org" @pubsub_node="node_1" @jid="theozaurus@jabber.org" @affiliation="owner">
+      ...
+    ]
+    
+    # Search affiliations
+    u.pubsub['node_1'].affiliations['theozaurus@jabber.org']
+    => #<Jubjub::Pubsub::Affiliation:0x101f52830 @pubsub_jid="pubsub.jabber.org" @pubsub_node="node_1" @jid="theozaurus@jabber.org" @affiliation="owner">
+    
+    # Test affiliations
+    u.pubsub['node_1'].affiliations['theozaurus@jabber.org'].owner?
+    => true
+    u.pubsub['node_1'].affiliations['theozaurus@jabber.org'].publisher?
+    => false
+    
+    # Set affiliation
+    u.pubsub['node_1'].affiliations['theozaurus@jabber.org'].set_publisher
+    => true
+    # or
+    u.pubsub['node_1'].affiliations['theozaurus@jabber.org'].set('publisher')
+    => true
+        
+    # Purge a node
+    node.purge
+    => true
+    
+    # Or
+    u.pubsub.purge('node_1')
+    => true
     
     # Unsubscribe
     subscription.unsubscribe
@@ -149,7 +186,6 @@ TODO
 
  - Error handling
  - MUC user role and affiliation control
- - Pubsub configuration
  - Service discovery
  - Operations that are not IQ based, such as rosters and two way messaging
  - Other backends (for servers that are evented)

data/lib/jubjub/connection/xmpp_gateway/muc.rb

@@ -33,7 +33,7 @@ module Jubjub
         #     to='crone1@shakespeare.lit/desktop'
         #     type='result'/>
         #
-        def create(full_jid, configuration = Jubjub::MucConfiguration.new)
+        def create(full_jid, configuration = Jubjub::Muc::Configuration.new)
           room_jid = Jubjub::Jid.new full_jid.node, full_jid.domain
           
           request = Nokogiri::XML::Builder.new do |xml|
@@ -217,27 +217,11 @@ module Jubjub
             request.to_xml
           ).xpath(
             # Get fields
-            "//iq[@type='result']/muc_owner:query/x_data:x[@type='form']/x_data:field",
+            "//iq[@type='result']/muc_owner:query/x_data:x[@type='form']",
             namespaces
-          ).inject({}){|result,field|
-            # Build MucConfiguration parameters
-            hash = {}
-            hash[:type]  = field.attr 'type'
-            hash[:label] = field.attr 'label'
-            
-            value = field.xpath('x_data:value', namespaces)
-            hash[:value] = hash[:type].match(/\-multi$/) ? value.map{|e| e.content } : value.text
-            
-            options = field.xpath('x_data:option', namespaces).map{|o|
-              { :label => o.attr('label'), :value => o.xpath('x_data:value', namespaces).text }
-            }
-            hash[:options] = options if options.any?
-            
-            result[field.attr 'var'] = hash
-            result
-          }
+          )
           
-          Jubjub::MucConfiguration.new response
+          Jubjub::Muc::Configuration.new response if response
         end
         
         # http://xmpp.org/extensions/xep-0045.html#destroyroom

data/lib/jubjub/connection/xmpp_gateway/pubsub.rb

@@ -55,13 +55,22 @@ module Jubjub
           }
         end
         
-        # http://xmpp.org/extensions/xep-0060.html#owner-create
+        # http://xmpp.org/extensions/xep-0060.html#owner-create-and-configure
         # <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>
+        #       <x xmlns='jabber:x:data' type='submit'>
+        #         <field var='FORM_TYPE' type='hidden'>
+        #           <value>http://jabber.org/protocol/pubsub#node_config</value>
+        #         </field>
+        #         <field var='pubsub#title'><value>Princely Musings (Atom)</value></field>
+        #         ...
+        #       </x>
+        #     </configure>
         #   </pubsub>
         # </iq>
         # 
@@ -69,16 +78,17 @@ module Jubjub
         # <iq type='result'
         #     from='pubsub.shakespeare.lit'
         #     to='hamlet@denmark.lit/elsinore'
-        #     id='create2'>
-        #     <pubsub xmlns='http://jabber.org/protocol/pubsub'>
-        #       <create node='25e3d37dabbab9541f7523321421edc5bfeb2dae'/>
-        #     </pubsub>
-        # </iq>
-        def create(jid, node)          
+        #     id='create1'/>
+        def create(jid, node, configuration = nil)
           request = Nokogiri::XML::Builder.new do |xml|
             xml.iq_(:to => jid, :type => 'set') {
               xml.pubsub_('xmlns' => namespaces['pubsub']) {
                 xml.create_('node' => node)
+                if configuration 
+                  xml.configure_{
+                    configuration.to_builder(xml.parent)
+                  }
+                end
               }
             }
           end
@@ -88,12 +98,64 @@ module Jubjub
             request.to_xml
           ).xpath(
             # Pull out required parts
-            '//iq[@type="result"]/pubsub:pubsub/pubsub:create',
-            namespaces
+            '//iq[@type="result"]'
           ).any?
           Jubjub::Pubsub.new jid, node, @connection if success
         end
         
+        # http://xmpp.org/extensions/xep-0060.html#owner-configure
+        # <iq type='get'
+        #     from='hamlet@denmark.lit/elsinore'
+        #     to='pubsub.shakespeare.lit'
+        #     id='config1'>
+        #   <pubsub xmlns='http://jabber.org/protocol/pubsub#owner'>
+        #     <configure node='princely_musings'/>
+        #   </pubsub>
+        # </iq>
+        # 
+        # Expected
+        # <iq type='result'
+        #     from='pubsub.shakespeare.lit'
+        #     to='hamlet@denmark.lit/elsinore'
+        #     id='config1'>
+        #   <pubsub xmlns='http://jabber.org/protocol/pubsub#owner'>
+        #     <configure node='princely_musings'>
+        #       <x xmlns='jabber:x:data' type='form'>
+        #         <field var='FORM_TYPE' type='hidden'>
+        #           <value>http://jabber.org/protocol/pubsub#node_config</value>
+        #         </field>
+        #         <field var='pubsub#title' type='text-single'
+        #                label='A friendly name for the node'/>
+        #         <field var='pubsub#deliver_notifications' type='boolean'
+        #                label='Whether to deliver event notifications'>
+        #           <value>true</value>
+        #         </field>
+        #         ...
+        #       </x>
+        #     </configure>
+        #   </pubsub>
+        # </iq>
+        def default_configuration(jid)          
+          request = Nokogiri::XML::Builder.new do |xml|
+            xml.iq_(:to => jid, :type => 'get') {
+              xml.pubsub_('xmlns' => namespaces['pubsub_owner']) {
+                xml.default_
+              }
+            }
+          end
+          
+          response = write(
+            # Request default node configuration
+            request.to_xml
+          ).xpath(
+            # Get fields
+            "//iq[@type='result']/pubsub_owner:pubsub/pubsub_owner:default/x_data:x[@type='form']",
+            namespaces
+          )
+          
+          Jubjub::Pubsub::Configuration.new response if response
+        end
+        
         # http://xmpp.org/extensions/xep-0060.html#owner-delete
         # <iq type='set'
         #     from='hamlet@denmark.lit/elsinore'
@@ -130,6 +192,38 @@ module Jubjub
           ).any?
         end
         
+        # http://xmpp.org/extensions/xep-0060.html#owner-purge
+        # <iq type='set'
+        #     from='hamlet@denmark.lit/elsinore'
+        #     to='pubsub.shakespeare.lit'
+        #     id='purge1'>
+        #   <pubsub xmlns='http://jabber.org/protocol/pubsub#owner'>
+        #     <purge node='princely_musings'/>
+        #   </pubsub>
+        # </iq>
+        #
+        # Expected
+        # <iq type='result'
+        #     from='pubsub.shakespeare.lit'
+        #     id='purge1'/>
+        def purge(jid,node)
+          request = Nokogiri::XML::Builder.new do |xml|
+            xml.iq_(:to => jid, :type => 'set') {
+              xml.pubsub_('xmlns' => namespaces['pubsub_owner']) {
+                xml.purge_('node' => node)
+              }
+            }
+          end
+          
+          success = write(
+            # Generate stanza
+            request.to_xml
+          ).xpath(
+            # Pull out required parts
+            '//iq[@type="result"]'
+          ).any?
+        end
+        
         # http://xmpp.org/extensions/xep-0060.html#subscriber-subscribe
         # <iq type='set'
         #     from='francisco@denmark.lit/barracks'
@@ -176,7 +270,7 @@ module Jubjub
             subscriber   = Jubjub::Jid.new(result.first.attr('jid'))
             subid        = result.first.attr('subid') 
             subscription = result.first.attr('subscription')
-            Jubjub::PubsubSubscription.new jid, node, subscriber, subid, subscription, @connection
+            Jubjub::Pubsub::Subscription.new jid, node, subscriber, subid, subscription, @connection
           end
         end
         
@@ -274,7 +368,7 @@ module Jubjub
           if result.any?
             item_id = result.first.attr('id')
             data = request.doc.xpath("//pubsub:item/*", namespaces).to_s
-            Jubjub::PubsubItem.new jid, node, item_id, data, @connection
+            Jubjub::Pubsub::Item.new jid, node, item_id, data, @connection
           end
         end
         
@@ -366,10 +460,96 @@ module Jubjub
           ).map{|item|
             item_id = item.attr('id')
             data = item.xpath('./*').to_xml
-            Jubjub::PubsubItem.new jid, node, item_id, data, @connection
+            Jubjub::Pubsub::Item.new jid, node, item_id, data, @connection
+          }
+        end
+        
+        
+        # http://xmpp.org/extensions/xep-0060.html#owner-affiliations
+        # <iq type='get'
+        #     from='hamlet@denmark.lit/elsinore'
+        #     to='pubsub.shakespeare.lit'
+        #     id='ent1'>
+        #   <pubsub xmlns='http://jabber.org/protocol/pubsub#owner'>
+        #     <affiliations node='princely_musings'/>
+        #   </pubsub>
+        # </iq>
+        # 
+        # Expected
+        # <iq type='result'
+        #     from='pubsub.shakespeare.lit'
+        #     to='hamlet@denmark.lit/elsinore'
+        #     id='ent1'>
+        #   <pubsub xmlns='http://jabber.org/protocol/pubsub#owner'>
+        #     <affiliations node='princely_musings'>
+        #       <affiliation jid='hamlet@denmark.lit' affiliation='owner'/>
+        #       <affiliation jid='polonius@denmark.lit' affiliation='outcast'/>
+        #     </affiliations>
+        #   </pubsub>
+        # </iq>
+        def retrieve_affiliations(pubsub_jid, pubsub_node)
+          request = Nokogiri::XML::Builder.new do |xml|
+            xml.iq_(:to => pubsub_jid, :type => 'get') {
+              xml.pubsub_(:xmlns => namespaces['pubsub_owner']){
+                xml.affiliations_(:node => pubsub_node)
+              }
+            }
+          end
+          
+          write(
+            # Generate stanza
+            request.to_xml
+          ).xpath(
+            # Pull out required parts
+            '//iq[@type="result"]/pubsub_owner:pubsub/pubsub_owner:affiliations/pubsub_owner:affiliation',
+            namespaces
+          ).map{|affiliation|
+            jid = Jubjub::Jid.new affiliation.attr('jid')
+            affiliation = affiliation.attr('affiliation')
+            Jubjub::Pubsub::Affiliation.new pubsub_jid, pubsub_node, jid, affiliation, @connection
           }
         end
         
+        # http://xmpp.org/extensions/xep-0060.html#owner-affiliations-modify
+        # <iq type='set'
+        #     from='hamlet@denmark.lit/elsinore'
+        #     to='pubsub.shakespeare.lit'
+        #     id='ent2'>
+        #   <pubsub xmlns='http://jabber.org/protocol/pubsub#owner'>
+        #     <affiliations node='princely_musings'>
+        #       <affiliation jid='bard@shakespeare.lit' affiliation='publisher'/>
+        #     </affiliations>
+        #   </pubsub>
+        # </iq>
+        # 
+        # Expected
+        # <iq type='result'
+        #     from='pubsub.shakespeare.lit'
+        #     id='ent2'/>
+        def modify_affiliations(pubsub_jid, pubsub_node, *affiliations)
+          affiliations = [affiliations].flatten
+          
+          request = Nokogiri::XML::Builder.new do |xml|
+            xml.iq_(:to => pubsub_jid, :type => 'set') {
+              xml.pubsub_(:xmlns => namespaces['pubsub_owner']){
+                xml.affiliations_(:node => pubsub_node){
+                  affiliations.each {|a|
+                    xml.affiliation_(:jid => a.jid, :affiliation => a.affiliation)
+                  }
+                }
+              }
+            }
+          end
+          
+          write(
+            # Generate stanza
+            request.to_xml
+          ).xpath(
+            # Pull out required parts
+            '//iq[@type="result"]'
+          ).any?
+        end
+        
       private
       
         def subscriber
@@ -384,7 +564,8 @@ module Jubjub
           {
             'disco_items'  => 'http://jabber.org/protocol/disco#items',
             'pubsub'       => 'http://jabber.org/protocol/pubsub',
-            'pubsub_owner' => 'http://jabber.org/protocol/pubsub#owner'
+            'pubsub_owner' => 'http://jabber.org/protocol/pubsub#owner',
+            'x_data'       => 'jabber:x:data'
           }
         end
         

data/lib/jubjub/data_form.rb

@@ -6,6 +6,8 @@ module Jubjub
     attr_reader :fields
 
     def initialize(config={})
+      config = convert_xml config if config.respond_to? :xpath
+
       check_config config
 
       @fields = config
@@ -85,6 +87,34 @@ module Jubjub
         ) if mystery_arguments.any?
       end
     end
+    
+    def convert_xml(config)
+      config.xpath(
+        # Get fields
+        "//x_data:x[@type='form']/x_data:field",
+        namespaces
+      ).inject({}){|result,field|
+        # Build parameters
+        hash = {}
+        hash[:type]  = field.attr 'type'
+        hash[:label] = field.attr 'label'
+        
+        value = field.xpath('x_data:value', namespaces)
+        hash[:value] = hash[:type].match(/\-multi$/) ? value.map{|e| e.content } : value.text
+        
+        options = field.xpath('x_data:option', namespaces).map{|o|
+          { :label => o.attr('label'), :value => o.xpath('x_data:value', namespaces).text }
+        }
+        hash[:options] = options if options.any?
+        
+        result[field.attr 'var'] = hash unless hash[:type] == 'fixed'
+        result
+      }
+    end
+    
+    def namespaces
+      { 'x_data' => 'jabber:x:data' }
+    end
 
   end
   

data/lib/jubjub/muc.rb

@@ -1,93 +1,4 @@
-require 'jubjub/data_form'
-
-module Jubjub
-  class Muc
-    
-    attr_reader :jid, :name
-    
-    def initialize(jid, name = nil, connection = nil)
-      @jid = Jubjub::Jid.new(jid)
-      @name = name
-      @connection = connection
-    end 
-    
-    def exit(nick = nil)
-      full_jid = Jubjub::Jid.new @jid.node, @jid.domain, nick || @connection.jid.node
-      
-      @connection.muc.exit(full_jid)
-      self
-    end
-    
-    def destroy
-      @connection.muc.destroy(@jid)
-    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}\" @name=#{@name.inspect}>"
-    end
-    
-  end
-  
-  # Uses proxy pattern for syntax sugar
-  # and delaying expensive operations until
-  # required
-  class MucCollection
-     
-    attr_reader :jid
-     
-    def initialize(jid, connection)
-      @jid = Jubjub::Jid.new(jid)
-      @connection = connection
-    end
-    
-    def create(node, nick = nil, &block)
-      full_jid = Jubjub::Jid.new node, @jid.domain, nick || @connection.jid.node
-
-      if block_given?
-        # Reserved room
-        config = @connection.muc.configuration full_jid
-        yield config
-        @connection.muc.create full_jid, config
-      else
-        # Instant room
-        result = @connection.muc.create full_jid
-      end
-      
-    end
-    
-    def [](jid_node_num)
-      case jid_node_num
-      when Fixnum
-        list[jid_node_num]
-      when Jubjub::Jid
-        list.find{|m| m.jid == jid_node_num }
-      else
-        j = Jubjub::Jid.new jid_node_num, jid.domain
-        list.find{|m| m.jid == j }        
-      end
-    end
-    
-    # Hint that methods are actually applied to list using method_missing
-    def inspect
-      list.inspect
-    end
-    
-  private
-  
-    def method_missing(name, *args, &block)
-      list.send(name, *args, &block)
-    end
-      
-    def list
-      @list ||= @connection.muc.list @jid
-    end
-    
-  end
-  
-  class MucConfiguration < DataForm
-    
-  end
-  
-end
+require "jubjub/connection/xmpp_gateway/muc"
+require 'jubjub/muc/muc'
+require 'jubjub/muc/collection'
+require 'jubjub/muc/configuration'