mojodna-xmpp4r 0.4.0.2

data/lib/xmpp4r/pubsub/children/subscription_config.rb

@@ -0,0 +1,67 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
+require 'xmpp4r/xmppelement'
+require 'xmpp4r/pubsub/children/configuration'
+require 'xmpp4r/pubsub/iq/pubsub'
+
+module Jabber
+  module PubSub
+    ##
+    # SubscriptionConfig
+    #
+    # An <options> XMPP element, see example 57 in
+    # http://www.xmpp.org/extensions/xep-0060.html#subscriber-configure-success
+    class SubscriptionConfig < Configuration
+      name_xmlns 'options', NS_PUBSUB
+
+      ##
+      # Construct a new Options stanza
+      # node:: [String] the node to which this subscription applies
+      # jid:: [String] or [Jabber::JID] the jid that holds the subscription
+      # options:: [Hash] the configuration for this subscription
+      # subid:: [String] (optional) subscription id
+      def initialize(node = nil, jid = nil, options = nil, subid = nil)
+        super()
+
+        self.node = node
+        self.jid = jid
+        self.options = options
+        self.subid = subid
+      end
+
+      ##
+      # set the 'jid' attribute of this stanza
+      # jid:: [Jabber::JID] or [String] the jid owning the subscription
+      def jid=(jid)
+        attributes['jid'] = jid.to_s
+      end
+
+      ##
+      # get the 'jid' attribute for this stanza
+      def jid
+        attributes['jid'] ? Jabber::JID.new(attributes['jid']) : nil
+      end
+
+      ##
+      # set the 'subid' attribute
+      # subid:: [String] the subscription id
+      def subid=(subid)
+        attributes['subid'] = subid
+      end
+
+      ##
+      # get the 'subid' attribute
+      def subid
+        attributes['subid']
+      end
+
+      private
+
+      def form_type
+        'http://jabber.org/protocol/pubsub#subscribe_options'
+      end
+    end
+  end
+end

data/lib/xmpp4r/pubsub/children/unsubscribe.rb

@@ -0,0 +1,48 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
+require 'xmpp4r/iq'
+
+module Jabber
+  module PubSub
+    ##
+    # Unsubscribe
+    class Unsubscribe < XMPPElement
+      name_xmlns 'unsubscribe'
+      def initialize(myjid=nil,mynode=nil)
+        super()
+        jid = myjid
+        node =  mynode
+      end
+
+      ##
+      # shows the jid
+      # return:: [String]
+      def jid
+        (a = attribute('jid')).nil? ? a : JID.new(a.value)
+      end
+
+      ##
+      # sets the jid
+      # =:: [Jabber::JID] or [String]
+      def jid=(myjid)
+        add_attribute('jid', myjid ? myjid.to_s : nil)
+      end
+
+      ##
+      # shows the node
+      # return:: [String]
+      def node
+        attributes['node']
+      end
+
+      ##
+      # sets the node
+      # =:: [String]
+      def node=(mynode)
+        attributes['node'] = mynode
+      end
+    end
+  end
+end

data/lib/xmpp4r/pubsub/helper/nodebrowser.rb

@@ -0,0 +1,130 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
+require 'xmpp4r/discovery'
+
+module Jabber
+  module PubSub
+    class NodeBrowser
+      ##
+      # Initialize a new NodeBrowser
+      # new(stream,pubsubservice)
+      # stream:: [Jabber::Stream]
+      def initialize(stream)
+        @stream = stream
+      end
+
+      ##
+      # Retrieve the nodes
+      # Throws an ServerError when receiving
+      # <tt><iq type='error'/></tt>
+      # jid:: [JID] Target entity (set only domain!)
+      # return:: [Array] of [String] or [nil]
+      def nodes(jid)
+        iq = Iq.new(:get,jid)
+        iq.from = @stream.jid
+        iq.add(Discovery::IqQueryDiscoItems.new)
+        nodes = []
+        @stream.send_with_id(iq) do |answer|
+          answer.query.each_element('item') { |item|
+            nodes.push(item.node)
+          }
+        end
+        nodes
+      end
+
+      ##
+      # Retrieve the nodes with names
+      # Throws a ServerError when receiving
+      # <tt><iq type='error'/></tt>
+      # jid:: [Jabber::JID] Target entity (set only domain!)
+      # return:: [Array] of [Hash] with keys 'node' => [String] and 'name' => [String] or [nil]
+      def nodes_names(jid)
+        iq = Iq.new(:get,jid)
+        iq.from = @stream.jid
+        iq.add(Discovery::IqQueryDiscoItems.new)
+        nodes = []
+        @stream.send_with_id(iq) do |answer|
+          answer.query.each_element('item') do |item|
+            nodes.push( {'node' => item.node,'name' => item.iname } )
+          end
+        end
+        nodes
+      end
+
+
+      ##
+      # Retrieve the items from a node
+      # Throws an ServerError when receiving
+      # <tt><iq type='error'/></tt>
+      # jid:: [Jabber::JID] Target entity (set only domain!)
+      # node:: [String]
+      # return:: [Array] of [Hash] with keys 'name' => [String] and 'jid' => [Jabber::JID]
+      def items(jid,node)
+        iq = Iq.new(:get,jid)
+        iq.from = @stream.jid
+        discoitems = Discovery::IqQueryDiscoItems.new
+        discoitems.node = node
+        iq.add(discoitems)
+        items = []
+        err = nil
+        @stream.send_with_id(iq) do |answer|
+          answer.query.each_element('item') { |item|
+            items.push( {'jid' => item.jid,'name' => item.iname } )
+          }
+        end
+        items
+      end
+
+      ##
+      # get disco info for a node
+      # jid:: [Jabber::JID]
+      # node:: [String]
+      # return:: [Hash] with possible keys type:: [String] ,category:: [String],features:: [Array] of feature, nodeinformation:: [Jabber::XData]
+      # check http://www.xmpp.org/extensions/xep-0060.html#entity for more infos
+      def get_info(jid,node)
+        iq = Iq.new(:get,jid)
+        iq.from = @stream.jid
+        discoinfo = Discovery::IqQueryDiscoInfo.new
+        discoinfo.node = node
+        iq.add(discoinfo)
+        info = {}
+        @stream.send_with_id(iq) do |answer|
+          identity = answer.query.identity
+          info['type'] = identity.type
+          info['category'] = identity.category
+          info['features'] = answer.query.features
+          
+          answer.query.each_element('x') { |x|
+            info['nodeinformation'] = x
+          }
+        end
+        info
+      end
+      # this is only for a xep <-> nodebrowser.rb understanding
+      alias get_metadata get_info
+
+      ##
+      # get type of node
+      # jid:: [Jabber::JID]
+      # node:: [String]
+      #
+      def type(jid,node)
+        info = get_info(jid,node)
+        return info['type']
+      end
+
+      ##
+      # get category of node
+      # jid:: [Jabber::JID]
+      # node:: [String]
+      #
+      def category(jid,node)
+        info = get_info(jid,node)
+        return info['category']
+      end
+
+    end #class
+  end #module
+end #module

data/lib/xmpp4r/pubsub/helper/nodehelper.rb

@@ -0,0 +1,156 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+#
+# For documentation of the return values please see [Jabber::PubSub::ServiceHelper]
+# This class is only a wrapper around [Jabber::PubSub::ServiceHelper]
+#
+
+
+require 'xmpp4r/pubsub/helper/servicehelper'
+require 'xmpp4r/pubsub/helper/nodebrowser'
+
+module Jabber
+  module PubSub
+    class NodeHelper < ServiceHelper
+
+      attr_reader :nodename
+      attr_reader :name
+      attr_reader :jid
+      attr_reader :my_subscriptions
+      ##
+      # creates a new node
+      # new(client,service,nodename)
+      # stream:: [Jabber::Stream]
+      # jid:: [String] (jid of the pubsub service)
+      # nodename:: [String]
+      def initialize(stream, jid, nodename = nil, create_if_not_exist = true)
+        super(stream,jid)
+        @nodename = nodename
+        @jid = jid
+        @stream = stream
+
+        if create_if_not_exist and !node_exist?
+          # if no nodename is given a instant node will created
+          # (if the service supports instant nodes)
+          @nodename = create_node
+        else
+          get_subscriptions
+        end
+      end
+
+      ##
+      # creates the node
+      # create(configuration=nil)
+      # configuration:: [Jabber::XData]
+      def create_node(configuration = Jabber::PubSub::NodeConfig.new)
+        unless node_exist?
+          super(@nodename,configuration)
+        else
+          false
+        end
+      end
+
+      ##
+      # get the configuration of the node
+      # get_configuration(configuration=nil)
+      # configuration:: [Jabber::XData]
+      def get_configuration(subid = nil)
+        get_options(@nodename, subid)
+      end
+
+      ##
+      # set the configuration of the node
+      # set_configuration(configuration=nil)
+      # configuration:: [Jabber::XData]
+      # subid:: [String] default is nil
+      def set_configuration(configuration,subid = nil)
+        set_options(@nodename, configuration, subid)
+      end
+
+      ##
+      # deletes the node
+      # delete
+      def delete_node
+        delete(@nodename)
+      end
+
+      ##
+      # publishing content on this node
+      # publish_content(items)
+      # items:: [REXML::Element]
+      def publish_content(items)
+        publish_item_to(@nodename,items)
+      end
+
+      ##
+      # gets all items from the node
+      # get_all_items
+      def get_all_items
+        get_items_from(@nodename)
+      end
+
+      ##
+      # get a count of items
+      # get_items(count)
+      # count:: [Fixnum]
+      def get_items(count)
+        get_items_from(@nodename,count)
+      end
+
+      ##
+      # get all node affiliations
+      # get_affiliations
+      def get_affiliations
+        affiliations
+      end
+
+      ##
+      # get all subscriptions on this node
+      # get_subscriptions
+      def get_subscriptions
+        get_subscriptions_from(@nodename)
+      end
+
+      ##
+      # get all subscribers subscribed on this node
+      # get_subscribers
+      def get_subscribers
+        @subscriptions = subscribers(@nodename)
+      end
+
+      ##
+      # subscribe to this node
+      # do_subscribe
+      def do_subscribe
+        subscribe_to(@nodename)
+        get_subscriptions
+      end
+
+      ##
+      # unsubscribe from this node
+      # do_unsubscribe(subid = nil)
+      # subid:: [String]
+      def do_unsubscribe(subid)
+        unsubscribe(@nodename,subid)
+      end
+
+      ##
+      # purge all items from this node
+      # purge_items
+      def purge_items
+        purge(@nodename)
+      end
+
+    private
+
+      def node_exist?
+        nodebrowser = PubSub::NodeBrowser.new(@stream)
+        nodebrowser.nodes(@jid).include?(@nodename)
+      end
+      def disco_info
+      end
+
+    end #class
+  end #module
+end #module

data/lib/xmpp4r/pubsub/helper/oauth_service_helper.rb

@@ -0,0 +1,107 @@
+module Jabber
+  module PubSub
+    # PubSub service helper for use with OAuth-authenticated nodes
+    class OAuthServiceHelper < ServiceHelper
+      def initialize(stream, pubsubjid)
+        super(stream, pubsubjid)
+      end
+
+      # override #get_subscriptions_from_all_nodes to add an oauth element
+      def get_subscriptions_from_all_nodes(oauth_consumer, oauth_token)
+        iq = basic_pubsub_query(:get)
+
+        iq.pubsub.add(create_oauth_node(oauth_consumer, oauth_token))
+
+        entities = iq.pubsub.add(REXML::Element.new('subscriptions'))
+        res = nil
+        @stream.send_with_id(iq) { |reply|
+          if reply.pubsub.first_element('subscriptions')
+            res = []
+            reply.pubsub.first_element('subscriptions').each_element('subscription') { |subscription|
+              res << Jabber::PubSub::Subscription.import(subscription)
+            }
+          end
+        }
+
+        res
+      end
+
+      # override #subscribe_to to add an oauth element
+      def subscribe_to(node, oauth_consumer, oauth_token)
+        iq = basic_pubsub_query(:set)
+        sub = REXML::Element.new('subscribe')
+        sub.attributes['node'] = node
+        sub.attributes['jid'] = @stream.jid.strip.to_s
+
+        sub.add(create_oauth_node(oauth_consumer, oauth_token))
+
+        iq.pubsub.add(sub)
+        res = nil
+        @stream.send_with_id(iq) do |reply|
+          pubsubanswer = reply.pubsub
+          if pubsubanswer.first_element('subscription')
+            res = PubSub::Subscription.import(pubsubanswer.first_element('subscription'))
+          end
+        end # @stream.send_with_id(iq)
+        res
+      end
+
+      # override #unsubscribe_from to add an oauth element
+      def unsubscribe_from(node, oauth_consumer, oauth_token, subid=nil)
+        iq = basic_pubsub_query(:set)
+        unsub = PubSub::Unsubscribe.new
+        unsub.node = node
+        unsub.jid = @stream.jid.strip
+
+        unsub.add(create_oauth_node(oauth_consumer, oauth_token))
+
+        iq.pubsub.add(unsub)
+        ret = false
+        @stream.send_with_id(iq) { |reply|
+          ret = reply.kind_of?(Jabber::Iq) and reply.type == :result
+        } # @stream.send_with_id(iq)
+        ret
+      end
+
+    protected
+
+      # add the OAuth sauce (XEP-235)
+      def create_oauth_node(oauth_consumer, oauth_token)
+        require 'oauth/signature/hmac/sha1'
+        require 'cgi'
+
+        request = OAuth::RequestProxy.proxy \
+          "method" => "iq",
+          "uri"    => [@stream.jid.strip.to_s, @pubsubjid.strip.to_s] * "&",
+          "parameters" => {
+            "oauth_consumer_key"     => oauth_consumer.key,
+            "oauth_token"            => oauth_token.token,
+            "oauth_signature_method" => "HMAC-SHA1"
+          }
+
+        signature = OAuth::Signature.sign(request, :consumer => oauth_consumer, :token => oauth_token)
+
+        oauth = REXML::Element.new("oauth")
+        oauth.attributes['xmlns'] = 'urn:xmpp:oauth'
+
+        oauth_consumer_key = REXML::Element.new("oauth_consumer_key")
+        oauth_consumer_key.text = oauth_consumer.key
+        oauth.add(oauth_consumer_key)
+
+        oauth_token_node = REXML::Element.new("oauth_token")
+        oauth_token_node.text = oauth_token.token
+        oauth.add(oauth_token_node)
+
+        oauth_signature_method = REXML::Element.new("oauth_signature_method")
+        oauth_signature_method.text = "HMAC-SHA1"
+        oauth.add(oauth_signature_method)
+
+        oauth_signature = REXML::Element.new("oauth_signature")
+        oauth_signature.text = signature
+        oauth.add(oauth_signature)
+
+        oauth
+      end
+    end
+  end
+end