jubjub 0.0.4 → 0.0.5

data/README.mdown

@@ -50,6 +50,10 @@ Examples
       #<Jubjub::Muc:0x10166dcb0 @jid="think_linux@conference.jabber.ru" @name="think_linux (n/a)">
     ...
 
+    # Find a room
+    u.mucs('conference.jabber.ru')['tota-room']
+    => #<Jubjub::Muc:0x10166e930 @jid="tota-room@conference.jabber.ru" @name="tota-room (5)">
+
     # Create a room
     room = u.mucs.create('jubjub')
     => #<Jubjub::Muc:0x101532f58 @jid="jubjub@conference.jabber.org" @name=nil>
@@ -79,6 +83,10 @@ Examples
       #<Jubjub::Pubsub:0x101f23a30 @service="pubsub.jabber.org" @node="news">
     ]
     
+    # Find a pubsub node
+    u.pubsub['facts']
+    => #<Jubjub::Pubsub:0x101f23c88 @service="pubsub.jabber.org" @node="facts">
+    
     # List from a different service?
     u.pubsub('pubsub.jabber.ru')
     => [
@@ -97,6 +105,29 @@ Examples
     u.pubsub.subscribe('new_thing')
     => #<Jubjub::PubsubSubscription: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>"> 
+    
+    # Retract an item from a node
+    item.retract
+    => true
+    
+    # Or
+    u.pubsub['node_1'].retract('abc')
+    => true
+    
+    # List items on a node
+    u.pubsub['node_1'].items
+    => [
+      #<Jubjub::PubsubItem: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="...">
+    
     # Unsubscribe
     subscription.unsubscribe
     => true
@@ -118,7 +149,7 @@ TODO
 
  - Error handling
  - MUC user role and affiliation control
+ - Pubsub configuration
  - Service discovery
- - Pubsub / PEP
  - 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,21 +33,13 @@ module Jubjub
         #     to='crone1@shakespeare.lit/desktop'
         #     type='result'/>
         #
-        def create(full_jid, configuration = nil)
+        def create(full_jid, configuration = Jubjub::MucConfiguration.new)
           room_jid = Jubjub::Jid.new full_jid.node, full_jid.domain
           
           request = Nokogiri::XML::Builder.new do |xml|
             xml.iq_(:type => 'set', :to => room_jid) {
               xml.query_('xmlns' => 'http://jabber.org/protocol/muc#owner'){
-                xml.x_('xmlns' => 'jabber:x:data', :type => 'submit') {
-                  configuration.settings.each{|name,values|
-                    xml.field_('var' => name){
-                      values.each {|v|
-                        xml.value_ v
-                      }
-                    }
-                  } if configuration
-                }
+                configuration.to_builder(xml.parent)
               }
             }
           end

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

@@ -217,7 +217,159 @@ module Jubjub
             '//iq[@type="result"]'
           ).any?
         end
-      
+        
+        # http://xmpp.org/extensions/xep-0060.html#publisher-publish
+        # <iq type='set'
+        #     from='hamlet@denmark.lit/blogbot'
+        #     to='pubsub.shakespeare.lit'
+        #     id='publish1'>
+        #   <pubsub xmlns='http://jabber.org/protocol/pubsub'>
+        #     <publish node='princely_musings'>
+        #       <item id='ae890ac52d0df67ed7cfdf51b644e901'>
+        #         ...
+        #       </item>
+        #     </publish>
+        #   </pubsub>
+        # </iq>
+        # 
+        # Expected
+        # <iq type='result'
+        #     from='pubsub.shakespeare.lit'
+        #     to='hamlet@denmark.lit/blogbot'
+        #     id='publish1'>
+        #   <pubsub xmlns='http://jabber.org/protocol/pubsub'>
+        #     <publish node='princely_musings'>
+        #       <item id='ae890ac52d0df67ed7cfdf51b644e901'/>
+        #     </publish>
+        #   </pubsub>
+        # </iq>
+        def publish(jid, node, data, item_id = nil)
+          item_options = {}
+          item_options[:id] = item_id if item_id
+          
+          request = Nokogiri::XML::Builder.new do |xml|
+            xml.iq_(:to => jid, :type => 'set') {
+              xml.pubsub_('xmlns' => namespaces['pubsub']) {
+                xml.publish_(:node => node){
+                  xml.item_(item_options){
+                    if data.respond_to?( :to_builder )
+                      data.to_builder(xml.parent)
+                    else
+                      xml << data
+                    end
+                  }
+                }
+              }
+            }
+          end
+          
+          result = write(
+            # Generate stanza
+            request.to_xml
+          ).xpath(
+            # Pull out required parts
+            '//iq[@type="result"]/pubsub:pubsub/pubsub:publish/pubsub:item',
+            namespaces
+          )
+          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
+          end
+        end
+        
+        # http://xmpp.org/extensions/xep-0060.html#publisher-delete
+        # <iq type='set'
+        #     from='hamlet@denmark.lit/elsinore'
+        #     to='pubsub.shakespeare.lit'
+        #     id='retract1'>
+        #   <pubsub xmlns='http://jabber.org/protocol/pubsub'>
+        #     <retract node='princely_musings'>
+        #       <item id='ae890ac52d0df67ed7cfdf51b644e901'/>
+        #     </retract>
+        #   </pubsub>
+        # </iq>
+        # 
+        # Expected
+        # <iq type='result'
+        #     from='pubsub.shakespeare.lit'
+        #     to='hamlet@denmark.lit/elsinore'
+        #     id='retract1'/>
+        def retract(jid, node, item_id)
+          request = Nokogiri::XML::Builder.new do |xml|
+            xml.iq_(:to => jid, :type => 'set') {
+              xml.pubsub_('xmlns' => namespaces['pubsub']) {
+                xml.retract_(:node => node){
+                  xml.item_ :id => item_id
+                }
+              }
+            }
+          end
+          
+          write(
+            # Generate stanza
+            request.to_xml
+          ).xpath('//iq[@type="result"]').any?
+        end
+        
+        # http://xmpp.org/extensions/xep-0060.html#subscriber-retrieve
+        # <iq type='get'
+        #     from='francisco@denmark.lit/barracks'
+        #     to='pubsub.shakespeare.lit'
+        #     id='items1'>
+        #   <pubsub xmlns='http://jabber.org/protocol/pubsub'>
+        #     <items node='princely_musings'/>
+        #   </pubsub>
+        # </iq>
+        # 
+        # Expected
+        # <iq type='result'
+        #     from='pubsub.shakespeare.lit'
+        #     to='francisco@denmark.lit/barracks'
+        #     id='items1'>
+        #   <pubsub xmlns='http://jabber.org/protocol/pubsub'>
+        #     <items node='princely_musings'>
+        #       <item id='368866411b877c30064a5f62b917cffe'>
+        #         <entry xmlns='http://www.w3.org/2005/Atom'>
+        #           <title>The Uses of This World</title>
+        #           <summary>
+        # O, that this too too solid flesh would melt
+        # Thaw and resolve itself into a dew!
+        #           </summary>
+        #           <link rel='alternate' type='text/html'
+        #                 href='http://denmark.lit/2003/12/13/atom03'/>
+        #           <id>tag:denmark.lit,2003:entry-32396</id>
+        #           <published>2003-12-12T17:47:23Z</published>
+        #           <updated>2003-12-12T17:47:23Z</updated>
+        #         </entry>
+        #       </item>
+        #       ...
+        #     </items>
+        #   </pubsub>
+        # </iq>
+        def retrieve_items(jid, node)
+          request = Nokogiri::XML::Builder.new do |xml|
+            xml.iq_(:to => jid, :type => 'get') {
+              xml.pubsub_(:xmlns => namespaces['pubsub']){
+                xml.items_(:node => node)
+              }
+            }
+          end
+          
+          write(
+            # Generate stanza
+            request.to_xml
+          ).xpath(
+            # Pull out required parts
+            '//iq[@type="result"]/pubsub:pubsub/pubsub:items/pubsub:item',
+            namespaces
+          ).map{|item|
+            item_id = item.attr('id')
+            data = item.xpath('./*').to_xml
+            Jubjub::PubsubItem.new jid, node, item_id, data, @connection
+          }
+        end
+        
       private
       
         def subscriber

data/lib/jubjub/data_form.rb

@@ -0,0 +1,91 @@
+require "nokogiri"
+
+module Jubjub
+  class DataForm
+    
+    attr_reader :fields
+
+    def initialize(config={})
+      check_config config
+
+      @fields = config
+    end
+
+    def [](arg)
+      if fields.has_key? arg
+        case fields[arg][:type]
+        when 'boolean'
+          fields[arg][:value] == '1' || fields[arg][:value] == 'true' || fields[arg][:value] == true ? true : false
+        when 'jid-multi'
+          fields[arg][:value].map{|j| Jubjub::Jid.new j }
+        when 'jid-single'
+          Jubjub::Jid.new fields[arg][:value]
+        else
+          fields[arg][:value]
+        end
+      end
+    end
+
+    def []=(arg,value)
+      if fields.has_key? arg
+        check_options arg, value if fields[arg].has_key?(:options)
+        value = Array[value].flatten if fields[arg][:type].match /-multi$/
+        fields[arg][:value] = value
+      else
+        raise Jubjub::ArgumentError.new("#{arg} is not a valid field")
+      end
+    end
+
+    def settings
+      Hash[fields.keys.map{|field|
+        [field, Array[self[field]].flatten]
+      }]
+    end
+
+    def ==(thing)
+      thing.is_a?( self.class ) && thing.fields == self.fields
+    end
+    
+    def to_builder(root_doc=Nokogiri::XML.parse(""))
+      Nokogiri::XML::Builder.with(root_doc) do |xml|
+        xml.x_('xmlns' => 'jabber:x:data', :type => 'submit') {
+          settings.each{|name,values|
+            xml.field_('var' => name){
+              values.each {|v|
+                xml.value_ v
+              }
+            }
+          }
+        }
+      end
+    end
+
+  private
+
+    def check_options(name, value)
+      valid_options = fields[name][:options].map{|o| o[:value].to_s }
+      invalid_options = Array[value].flatten - valid_options
+      raise Jubjub::ArgumentError.new(
+        "#{invalid_options.join(', ')} is not an accepted value please choose from #{valid_options.join(', ')}"
+      ) if invalid_options.any?
+    end
+
+    def check_config(config)
+      required = [:type]
+      understood = required + [:label, :options, :value]    
+
+      raise Jubjub::ArgumentError.new("please initialize with a hash of the format { 'foo' => {:type => 'boolean', :value => false, :label => 'Fooey'} }") unless config.is_a? Hash
+
+      config.each do |name,argument|
+        required.each{|r| raise Jubjub::ArgumentError.new(":#{r} is missing for #{name}") unless argument.keys.include? r }
+
+        mystery_arguments = (argument.keys - understood)
+        raise Jubjub::ArgumentError.new(
+          ":#{mystery_arguments.join(', :')} is not a recognised option for #{name}"
+        ) if mystery_arguments.any?
+      end
+    end
+
+  end
+  
+end

data/lib/jubjub/muc.rb

@@ -1,3 +1,5 @@
+require 'jubjub/data_form'
+
 module Jubjub
   class Muc
     
@@ -55,6 +57,18 @@ module Jubjub
       
     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
@@ -72,76 +86,7 @@ module Jubjub
     
   end
   
-  class MucConfiguration
-    
-    attr_reader :fields
-    
-    def initialize(config)
-      check_config config
-      
-      @fields = config
-    end
-    
-    def [](arg)
-      if fields.has_key? arg
-        case fields[arg][:type]
-        when 'boolean'
-          fields[arg][:value] == '1' || fields[arg][:value] == 'true' || fields[arg][:value] == true ? true : false
-        when 'jid-multi'
-          fields[arg][:value].map{|j| Jubjub::Jid.new j }
-        when 'jid-single'
-          Jubjub::Jid.new fields[arg][:value]
-        else
-          fields[arg][:value]
-        end
-      end
-    end
-    
-    def []=(arg,value)
-      if fields.has_key? arg
-        check_options arg, value if fields[arg].has_key?(:options)
-        value = Array[value].flatten if fields[arg][:type].match /-multi$/
-        fields[arg][:value] = value
-      else
-        raise Jubjub::ArgumentError.new("#{arg} is not a valid field")
-      end
-    end
-    
-    def settings
-      Hash[fields.keys.map{|field|
-        [field, Array[self[field]].flatten]
-      }]
-    end
-    
-    def ==(thing)
-      thing.is_a?( self.class ) && thing.fields == self.fields
-    end
-    
-  private
-  
-    def check_options(name, value)
-      valid_options = fields[name][:options].map{|o| o[:value].to_s }
-      invalid_options = Array[value].flatten - valid_options
-      raise Jubjub::ArgumentError.new(
-        "#{invalid_options.join(', ')} is not an accepted value please choose from #{valid_options.join(', ')}"
-      ) if invalid_options.any?
-    end
-  
-    def check_config(config)
-      required = [:type]
-      understood = required + [:label, :options, :value]    
-      
-      raise Jubjub::ArgumentError.new("please initialize with a hash of the format { 'foo' => {:type => 'boolean', :value => false, :label => 'Fooey'} }") unless config.is_a? Hash
-      
-      config.each do |name,argument|
-        required.each{|r| raise Jubjub::ArgumentError.new(":#{r} is missing for #{name}") unless argument.keys.include? r }
-        
-        mystery_arguments = (argument.keys - understood)
-        raise Jubjub::ArgumentError.new(
-          ":#{mystery_arguments.join(', :')} is not a recognised option for #{name}"
-        ) if mystery_arguments.any?
-      end
-    end
+  class MucConfiguration < DataForm
     
   end
   

data/lib/jubjub/pubsub.rb

@@ -25,12 +25,98 @@ module Jubjub
       @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
+      PubsubItemCollection.new jid, node, @connection
+    end
+    
+  private
+  
+    def method_missing(name, *args, &block)
+      items.send(name, *args, &block)
+    end
+    
+  end
+  
+  class PubsubItemCollection
+    
+    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
+  
+  class PubsubItem
+    
+    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
+    
   end
   
   class PubsubSubscription
@@ -87,6 +173,15 @@ module Jubjub
       @connection.pubsub.unsubscribe jid, node, subid
     end
     
+    def [](node_num)
+      case node_num
+      when Fixnum
+        list[node_num]
+      else
+        list.find{|p| p.node == node_num }        
+      end
+    end
+    
     # Hint that methods are actually applied to list using method_missing
     def inspect
       list.inspect