jubjub 0.0.3 → 0.0.4

data/README.mdown

@@ -72,6 +72,47 @@ Examples
       c['muc#roomconfig_persistentroom'] = true
     }.exit
     
+    # List pubsub nodes
+    u.pubsub
+    => [
+      #<Jubjub::Pubsub:0x101f23c88 @service="pubsub.jabber.org" @node="facts">,
+      #<Jubjub::Pubsub:0x101f23a30 @service="pubsub.jabber.org" @node="news">
+    ]
+    
+    # List from a different service?
+    u.pubsub('pubsub.jabber.ru')
+    => [
+      ...
+    ]
+    
+    # Create a pubsub node
+    node = u.pubsub.create('node_1')
+    => #<Jubjub::Pubsub:0x101f3bae0 @service="pubsub.jabber.org" @node="node_1">
+    
+    # Subscribe to node
+    subscription = node.subscribe
+    => #<Jubjub::PubsubSubscription: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">
+    
+    # Unsubscribe
+    subscription.unsubscribe
+    => true
+    
+    # Destroy a node directly
+    node.destroy
+    => true
+    
+    # Destroy another node
+    u.pubsub.destroy('spare_node')
+    => true
+    
+    # Destroy another node with redirect
+    u.pubsub.destroy('old_node', 'pubsub.jabber.ru', 'new_new')
+    => true
+    
 TODO
 ====
 

data/lib/jubjub/connection/xmpp_gateway.rb

@@ -1,6 +1,7 @@
 require "net/http"
 require "nokogiri"
 require "jubjub/connection/xmpp_gateway/muc"
+require "jubjub/connection/xmpp_gateway/pubsub"
 
 module Jubjub
   module Connection
@@ -18,6 +19,10 @@ module Jubjub
         @muc ||= Muc.new(self)
       end
       
+      def pubsub
+        @pubsub ||= Pubsub.new(self)
+      end
+      
       def write(stanza)
         req = Net::HTTP::Post.new( url.path )
         req.basic_auth( @jid.to_s, @password )

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

@@ -0,0 +1,242 @@
+require 'jubjub/connection/xmpp_gateway/helper'
+require 'jubjub/pubsub'
+
+module Jubjub
+  module Connection
+    class XmppGateway
+      class Pubsub
+        
+        include Helper
+        
+        def initialize(connection)
+          @connection = connection
+        end
+        
+        # http://xmpp.org/extensions/xep-0060.html#entity-nodes
+        # <iq type='get'
+        #     from='francisco@denmark.lit/barracks'
+        #     to='pubsub.shakespeare.lit'
+        #     id='nodes1'>
+        #   <query xmlns='http://jabber.org/protocol/disco#items'/>
+        # </iq>
+        # 
+        # Expected
+        # <iq type='result'
+        #     from='pubsub.shakespeare.lit'
+        #     to='francisco@denmark.lit/barracks'
+        #     id='nodes1'>
+        #   <query xmlns='http://jabber.org/protocol/disco#items'>
+        #     <item jid='pubsub.shakespeare.lit'
+        #           node='blogs'
+        #           name='Weblog updates'/>
+        #     <item jid='pubsub.shakespeare.lit'
+        #           node='news'
+        #           name='News and announcements'/>
+        #   </query>
+        # </iq>
+        def list(jid)
+          request = Nokogiri::XML::Builder.new do |xml|
+            xml.iq_(:to => jid, :type => 'get') {
+              xml.query_('xmlns' => namespaces['disco_items'])
+            }
+          end
+          
+          write(
+            # Generate stanza
+            request.to_xml
+          ).xpath(
+            # Pull out required parts
+            '//iq[@type="result"]/disco_items:query/disco_items:item',
+            namespaces
+          ).map{|item|
+            jid  = item.attr('jid')
+            node = item.attr('node')
+            Jubjub::Pubsub.new jid, node, @connection
+          }
+        end
+        
+        # http://xmpp.org/extensions/xep-0060.html#owner-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'/>
+        #   </pubsub>
+        # </iq>
+        # 
+        # Expected
+        # <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)          
+          request = Nokogiri::XML::Builder.new do |xml|
+            xml.iq_(:to => jid, :type => 'set') {
+              xml.pubsub_('xmlns' => namespaces['pubsub']) {
+                xml.create_('node' => node)
+              }
+            }
+          end
+          
+          success = write(
+            # Generate stanza
+            request.to_xml
+          ).xpath(
+            # Pull out required parts
+            '//iq[@type="result"]/pubsub:pubsub/pubsub:create',
+            namespaces
+          ).any?
+          Jubjub::Pubsub.new jid, node, @connection if success
+        end
+        
+        # http://xmpp.org/extensions/xep-0060.html#owner-delete
+        # <iq type='set'
+        #     from='hamlet@denmark.lit/elsinore'
+        #     to='pubsub.shakespeare.lit'
+        #     id='delete1'>
+        #   <pubsub xmlns='http://jabber.org/protocol/pubsub#owner'>
+        #     <delete node='princely_musings'>
+        #       <redirect uri='xmpp:hamlet@denmark.lit?;node=blog'/>
+        #     </delete>
+        #   </pubsub>
+        # </iq>
+        # 
+        # Expected
+        # <iq type='result'
+        #     from='pubsub.shakespeare.lit'
+        #     id='delete1'/>
+        def destroy(jid, node, redirect_jid = nil, redirect_node = nil)        
+          request = Nokogiri::XML::Builder.new do |xml|
+            xml.iq_(:to => jid, :type => 'set') {
+              xml.pubsub_('xmlns' => namespaces['pubsub_owner']) {
+                xml.delete_('node' => node){
+                  xml.redirect( 'uri' => pubsub_uri(redirect_jid, redirect_node) ) if redirect_jid && redirect_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'
+        #     to='pubsub.shakespeare.lit'
+        #     id='sub1'>
+        #   <pubsub xmlns='http://jabber.org/protocol/pubsub'>
+        #     <subscribe
+        #         node='princely_musings'
+        #         jid='francisco@denmark.lit'/>
+        #   </pubsub>
+        # </iq>
+        #
+        # Expected
+        # <iq type='result'
+        #     from='pubsub.shakespeare.lit'
+        #     to='francisco@denmark.lit/barracks'
+        #     id='sub1'>
+        #   <pubsub xmlns='http://jabber.org/protocol/pubsub'>
+        #     <subscription
+        #         node='princely_musings'
+        #         jid='francisco@denmark.lit'
+        #         subid='ba49252aaa4f5d320c24d3766f0bdcade78c78d3'
+        #         subscription='subscribed'/>
+        #   </pubsub>
+        # </iq>
+        def subscribe(jid, node)        
+          request = Nokogiri::XML::Builder.new do |xml|
+            xml.iq_(:to => jid, :type => 'set') {
+              xml.pubsub_('xmlns' => namespaces['pubsub']) {
+                xml.subscribe_('node' => node, 'jid' => subscriber)
+              }
+            }
+          end
+          
+          result = write(
+            # Generate stanza
+            request.to_xml
+          ).xpath(
+            # Pull out required parts
+            '//iq[@type="result"]/pubsub:pubsub/pubsub:subscription',
+            namespaces
+          )
+          if result.any?
+            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
+          end
+        end
+        
+        # http://xmpp.org/extensions/xep-0060.html#subscriber-unsubscribe
+        # <iq type='set'
+        #     from='francisco@denmark.lit/barracks'
+        #     to='pubsub.shakespeare.lit'
+        #     id='unsub1'>
+        #   <pubsub xmlns='http://jabber.org/protocol/pubsub'>
+        #      <unsubscribe
+        #          node='princely_musings'
+        #          jid='francisco@denmark.lit'/>
+        #   </pubsub>
+        # </iq>
+        # 
+        # Expected
+        # <iq type='result'
+        #     from='pubsub.shakespeare.lit'
+        #     to='francisco@denmark.lit/barracks'
+        #     id='unsub1'/>
+        def unsubscribe(jid, node, subid=nil)        
+          unsubscribe_options = {'node' => node, 'jid' => subscriber}
+          unsubscribe_options['subid'] = subid if subid
+          
+          request = Nokogiri::XML::Builder.new do |xml|
+            xml.iq_(:to => jid, :type => 'set') {
+              xml.pubsub_('xmlns' => namespaces['pubsub']) {
+                xml.unsubscribe_(unsubscribe_options)
+              }
+            }
+          end
+          
+          write(
+            # Generate stanza
+            request.to_xml
+          ).xpath(
+            # Pull out required parts
+            '//iq[@type="result"]'
+          ).any?
+        end
+      
+      private
+      
+        def subscriber
+          Jubjub::Jid.new @connection.jid.node, @connection.jid.domain
+        end
+        
+        def pubsub_uri(jid, node)
+          "xmpp:#{jid}?;node=#{node}"
+        end
+      
+        def namespaces
+          {
+            'disco_items'  => 'http://jabber.org/protocol/disco#items',
+            'pubsub'       => 'http://jabber.org/protocol/pubsub',
+            'pubsub_owner' => 'http://jabber.org/protocol/pubsub#owner'
+          }
+        end
+        
+      end
+    end
+  end
+end

data/lib/jubjub/muc.rb

@@ -60,14 +60,12 @@ module Jubjub
       list.inspect
     end
     
-  protected
+  private
   
     def method_missing(name, *args, &block)
       list.send(name, *args, &block)
     end
-    
-  private
-  
+      
     def list
       @list ||= @connection.muc.list @jid
     end

data/lib/jubjub/pubsub.rb

@@ -0,0 +1,107 @@
+require "jubjub/connection/xmpp_gateway/pubsub"
+
+module Jubjub
+  
+  class 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 subscribe
+      @connection.pubsub.subscribe jid, node
+    end
+    
+    def unsubscribe(subid = nil)
+      @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}>"
+    end
+    
+  end
+  
+  class PubsubSubscription
+    
+    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
+  
+  # Uses proxy pattern for syntax sugar
+  # and delaying expensive operations until
+  # required
+  class PubsubCollection
+     
+    attr_reader :jid
+     
+    def initialize(jid, connection)
+      @jid = Jubjub::Jid.new jid
+      @connection = connection
+    end
+    
+    def create(node)
+      @connection.pubsub.create jid, node
+    end
+    
+    def destroy(node, 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 subscribe(node)
+      @connection.pubsub.subscribe jid, node
+    end
+    
+    def unsubscribe(node, subid=nil)
+      @connection.pubsub.unsubscribe jid, node, subid
+    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.pubsub.list jid
+    end
+    
+  end
+  
+end

data/lib/jubjub/user.rb

@@ -51,7 +51,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::MucCollection.new jid, jubjub_connection
+      end
+      
+      def pubsub(jid = nil)
+        jid ||= "pubsub.#{jubjub_jid.domain}"
+        Jubjub::PubsubCollection.new jid, jubjub_connection
       end
     end