xmpp4r 0.4 → 0.5

data/lib/xmpp4r/message.rb

@@ -11,6 +11,8 @@ module Jabber
   # which is used for all messaging communication.
   class Message < XMPPStanza
 
+    CHAT_STATES = %w(active composing gone inactive paused).freeze
+
     name_xmlns 'message', 'jabber:client'
     force_xmlns true
 
@@ -144,5 +146,35 @@ module Jabber
     def thread
       first_element_text('thread')
     end
+
+    ##
+    # Returns the current chat state, or nil if no chat state is set
+    def chat_state
+      each_elements(*CHAT_STATES) { |el| return el.name.to_sym }
+      return nil
+    end
+
+    ##
+    # Sets the chat state :active, :composing, :gone, :inactive, :paused
+    def chat_state=(s)
+      s = s.to_s
+      raise InvalidChatState, "Chat state must be one of #{CHAT_STATES.join(', ')}" unless CHAT_STATES.include?(s)
+      CHAT_STATES.each { |state| delete_elements(state) }
+      add_element(REXML::Element.new(s).add_namespace('http://jabber.org/protocol/chatstates'))
+    end
+
+    ##
+    # Sets the message's chat state
+    def set_chat_state(s)
+      self.state = s
+      self
+    end
+
+    CHAT_STATES.each do |state|
+      define_method("#{state}?") do
+        chat_state == state.to_sym
+      end
+    end
+
   end
 end

data/lib/xmpp4r/presence.rb

@@ -18,7 +18,7 @@ module Jabber
 
     ##
     # Create presence stanza
-    # show:: [String] Initial Availability Status
+    # show:: [Symbol] Initial Availability Status (see show)
     # status:: [String] Initial status message
     # priority:: [Fixnum] Initial priority value
     def initialize(show=nil, status=nil, priority=nil)

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

@@ -75,7 +75,7 @@ module Jabber
         form.add(pubsub_config)
         options.each_pair do |key, value|
           f = Jabber::Dataforms::XDataField.new(key)
-          f.values = [value]
+          f.values = value.is_a?(Array) ? value : [value]
           form.add(f)
         end
 

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

@@ -10,6 +10,7 @@ module Jabber
     # Items
     # a collection of Items
     class Items < XMPPElement
+      include Enumerable
       name_xmlns 'items', NS_PUBSUB
 
       def node
@@ -22,13 +23,21 @@ module Jabber
         attributes['subid']
       end
       def subid=(mysubid)
-        attributes['subid'] = mysubid
+        attributes['subid'] = mysubid.to_s
       end
       def max_items
         attributes['max_items']
       end
       def max_items=(mymaxitems)
-        attributes['max_items'] = mymaxitems
+        attributes['max_items'] = mymaxitems.to_s
+      end
+
+      def items
+        get_elements("item")
+      end
+
+      def each(&block)
+        items.each(&block)
       end
     end
 

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

@@ -13,7 +13,21 @@ module Jabber
     # A <publish> XMPP element, see example 1 in
     # http://www.xmpp.org/extensions/xep-0060.html#intro-howitworks
     class Publish < XMPPElement
+      include Enumerable
       name_xmlns 'publish', NS_PUBSUB
+
+      ##
+      # support for enumerating <item> elements
+      def each(&block)
+        items.each(&block)
+      end
+
+      ##
+      # return child <item> elements
+      def items
+        get_elements("item")
+      end
+
       ##
       # return the node for this publication
       def node

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

@@ -0,0 +1,41 @@
+# =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'
+
+module Jabber
+  module PubSub
+
+    ##
+    # Retract
+    #
+    # A <retract> XMPP element, see example 103 in
+    # http://xmpp.org/extensions/xep-0060.html#publisher-delete
+    class Retract < XMPPElement
+      name_xmlns 'retract', NS_PUBSUB
+      ##
+      # get the node for this retraction
+      def node
+        attributes['node']
+      end
+
+      ##
+      # set the node for this retraction
+      def node=(s)
+        attributes['node'] = s
+      end
+
+      ##
+      # Get <item/> children
+      def items
+        res = []
+        each_element('item') { |item|
+          res << item
+        }
+        res
+      end
+    end
+  end
+end
+

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

@@ -45,10 +45,10 @@ module Jabber
         iq.from = @stream.jid
         iq.add(Discovery::IqQueryDiscoItems.new)
         nodes = []
-        @stream.send_with_id(iq) { |answer|
+        @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
@@ -95,7 +95,6 @@ module Jabber
           info['type'] = identity.type
           info['category'] = identity.category
           info['features'] = answer.query.features
-          
           answer.query.each_element('x') { |x|
             info['nodeinformation'] = x
           }

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

@@ -30,7 +30,7 @@ module Jabber
         @jid = jid
         @stream = stream
 
-        if create_if_not_exist and not node_exist?
+        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
@@ -87,7 +87,7 @@ module Jabber
       # gets all items from the node
       # get_all_items
       def get_all_items
-        items(@nodename)
+        get_items_from(@nodename)
       end
 
       ##
@@ -95,7 +95,7 @@ module Jabber
       # get_items(count)
       # count:: [Fixnum]
       def get_items(count)
-        items(@nodename,count)
+        get_items_from(@nodename,count)
       end
 
       ##
@@ -153,4 +153,4 @@ module Jabber
 
     end #class
   end #module
-end #module
+end #module

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

@@ -0,0 +1,90 @@
+module Jabber
+  module PubSub
+    # Jabber::Stream helper that will transparently sign PubSub requests
+    module OAuthPubSubStreamHelper
+      attr_accessor :pubsubjid, :oauth_consumer, :oauth_token, :oauth_options
+
+      # enhanced #send_with_id method that signs stanzas
+      def send_with_id(iq)
+        if iq.first_element("pubsub")
+          oauth = OAuthServiceHelper.create_oauth_node(self.jid, self.pubsubjid, self.oauth_consumer, self.oauth_token, self.oauth_options)
+          iq.pubsub.add(oauth)
+        end
+
+        super(iq)
+      end
+    end
+
+    # PubSub service helper for use with OAuth-authenticated nodes
+    class OAuthServiceHelper < ServiceHelper
+      def initialize(stream, pubsubjid, oauth_consumer, oauth_token, options = {})
+        # imbue the stream with magical OAuth signing powers
+        stream.extend(OAuthPubSubStreamHelper)
+        stream.oauth_consumer = oauth_consumer
+        stream.oauth_token = oauth_token
+        stream.oauth_options = options
+        stream.pubsubjid = pubsubjid
+
+        super(stream, pubsubjid)
+      end
+
+      # add the OAuth sauce (XEP-0235)
+      # The `options` hash may contain the following parameters:
+      #  :oauth_nonce            => nonce (one will be generated otherwise)
+      #  :oauth_timestamp        => timestamp (one will be generated otherwise)
+      #  :oauth_signature_method => signature method (defaults to HMAC-SHA1)
+      #  :oauth_version          => OAuth version (defaults to "1.0")
+      def self.create_oauth_node(jid, pubsubjid, oauth_consumer, oauth_token, options = {})
+        require 'oauth'
+
+        request = OAuth::RequestProxy.proxy \
+          "method" => "iq",
+          "uri"    => [jid.strip.to_s, pubsubjid.strip.to_s] * "&",
+          "parameters" => {
+            "oauth_consumer_key"     => oauth_consumer.key,
+            "oauth_nonce"            => options[:oauth_nonce] || OAuth::Helper.generate_nonce,
+            "oauth_timestamp"        => options[:oauth_timestamp] || OAuth::Helper.generate_timestamp,
+            "oauth_token"            => oauth_token.token,
+            "oauth_signature_method" => options[:oauth_signature_method] || "HMAC-SHA1",
+            "oauth_version"          => options[:oauth_version] || "1.0"
+          }
+
+        request.sign!(:consumer => oauth_consumer, :token => oauth_token)
+
+        # TODO create XMPPElements for OAuth elements
+        oauth = REXML::Element.new("oauth")
+        oauth.attributes['xmlns'] = 'urn:xmpp:oauth:0'
+
+        oauth_consumer_key = REXML::Element.new("oauth_consumer_key")
+        oauth_consumer_key.text = request.oauth_consumer_key
+        oauth.add(oauth_consumer_key)
+
+        oauth_token_node = REXML::Element.new("oauth_token")
+        oauth_token_node.text = request.oauth_token
+        oauth.add(oauth_token_node)
+
+        oauth_signature_method = REXML::Element.new("oauth_signature_method")
+        oauth_signature_method.text = request.oauth_signature_method
+        oauth.add(oauth_signature_method)
+
+        oauth_signature = REXML::Element.new("oauth_signature")
+        oauth_signature.text = request.oauth_signature
+        oauth.add(oauth_signature)
+
+        oauth_timestamp = REXML::Element.new("oauth_timestamp")
+        oauth_timestamp.text = request.oauth_timestamp
+        oauth.add(oauth_timestamp)
+
+        oauth_nonce = REXML::Element.new("oauth_nonce")
+        oauth_nonce.text = request.oauth_nonce
+        oauth.add(oauth_nonce)
+
+        oauth_version = REXML::Element.new("oauth_version")
+        oauth_version.text = request.oauth_version
+        oauth.add(oauth_version)
+
+        oauth
+      end
+    end
+  end
+end

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

@@ -2,11 +2,11 @@
 # License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
 # Website::http://home.gna.org/xmpp4r/
 #
-# It's recommented to read the XEP-0060 before you use this Helper. (Maybe its 
+# It's recommented to read the XEP-0060 before you use this Helper. (Maybe its
 # better not use the helper for now ) ;)
 # The whole code is getting better, but may still contain bugs - be careful!
-# 
-# Maybe the following structure is good 
+#
+# Maybe the following structure is good
 # ( taken from the xep-0060 )
 #
 # entity usecases
@@ -31,12 +31,12 @@
 #   process pending subscriptions
 #   manage subscriptions
 #   manage affiliations
-#  
+#
 # collection nodes
-#    
-#  If someone want to implement something i think its better to do this in  
+#
+#  If someone want to implement something i think its better to do this in
 #  this order because everyone who reads the xep-0060 do know where to search in the file
-# 
+#
 require 'xmpp4r/pubsub/iq/pubsub'
 require 'xmpp4r/pubsub/children/event'
 require 'xmpp4r/pubsub/children/item'
@@ -45,6 +45,7 @@ require 'xmpp4r/pubsub/children/subscription'
 require 'xmpp4r/pubsub/children/unsubscribe'
 require 'xmpp4r/pubsub/children/node_config'
 require 'xmpp4r/pubsub/children/subscription_config'
+require 'xmpp4r/pubsub/children/retract'
 require 'xmpp4r/dataforms'
 
 module Jabber
@@ -118,12 +119,12 @@ module Jabber
         unsub.jid = @stream.jid.strip
         iq.pubsub.add(unsub)
         ret = false
-        @stream.send_with_id(iq) { |reply| 
+        @stream.send_with_id(iq) { |reply|
           ret = reply.kind_of?(Jabber::Iq) and reply.type == :result
         } # @stream.send_with_id(iq)
         ret
       end
-      
+
       ##
       # gets all items from a pubsub node
       # node:: [String]
@@ -132,6 +133,7 @@ module Jabber
       def get_items_from(node, count=nil)
         iq = basic_pubsub_query(:get)
         items = Jabber::PubSub::Items.new
+        items.max_items = count
         items.node = node
         iq.pubsub.add(items)
         res = nil
@@ -148,19 +150,17 @@ module Jabber
       end
 
       ##
-      # NOTE: this method sends only one item per publish request because some services 
+      # NOTE: this method sends only one item per publish request because some services
       # may not allow batch processing.  Maybe this will changed in the future?
       # node:: [String]
       # item:: [Jabber::PubSub::Item]
       # return:: true
-      # it automatically generates an id for the item 
       def publish_item_to(node,item)
         iq = basic_pubsub_query(:set)
 	      publish = iq.pubsub.add(REXML::Element.new('publish'))
         publish.attributes['node'] = node
-        
+
         if item.kind_of?(Jabber::PubSub::Item)
-          item.id = Jabber::IdGenerator.generate_id
           publish.add(item)
           @stream.send_with_id(iq)
         end
@@ -175,7 +175,7 @@ module Jabber
         iq = basic_pubsub_query(:set)
         publish = iq.pubsub.add(REXML::Element.new('publish'))
         publish.attributes['node'] = node
-          
+
         if item.kind_of?(REXML::Element)
           xmlitem = Jabber::PubSub::Item.new
           xmlitem.id = id
@@ -187,6 +187,32 @@ module Jabber
         @stream.send_with_id(iq)
       end
 
+      ##
+      # deletes an item from a persistent node
+      # node:: [String]
+      # item_id:: [String] or [Array] of [String]
+      # return:: true
+      def delete_item_from(node, item_id)
+        iq = basic_pubsub_query(:set)
+        retract = iq.pubsub.add(Jabber::PubSub::Retract.new)
+        retract.node = node
+
+        if item_id.kind_of? Array
+          item_id.each { |id|
+            xmlitem = Jabber::PubSub::Item.new
+            xmlitem.id = id
+            retract.add(xmlitem)
+          }
+        else
+          xmlitem = Jabber::PubSub::Item.new
+          xmlitem.id = item_id
+          retract.add(xmlitem)
+        end
+
+        @stream.send_with_id(iq)
+      end
+
+
       ##
       # purges all items on a persistent node
       # node:: [String]
@@ -256,8 +282,8 @@ module Jabber
       # options:: [Jabber::PubSub::NodeConfig]
       # return:: true on success
       def set_config_for(node, config)
-        iq = basic_pubsub_query( :set )
-        iq.pubsub.add(config.form)
+        iq = basic_pubsub_query(:set, true)
+        iq.pubsub.add(config)
         @stream.send_with_id(iq)
       end
 
@@ -271,6 +297,19 @@ module Jabber
         @stream.send_with_id(iq)
       end
 
+      def set_affiliations(node, jid, role = 'publisher')
+        iq = basic_pubsub_query(:set, true)
+        affiliations = iq.pubsub.add(REXML::Element.new('affiliations'))
+        affiliations.attributes['node'] = node
+        affiliation = affiliations.add(REXML::Element.new('affiliation'))
+        affiliation.attributes['jid'] = jid.to_s
+        affiliation.attributes['affiliation'] = role.to_s
+        res = nil
+        @stream.send_with_id(iq) { |reply|
+          true
+        }
+        res
+      end
 
       ##
       # shows the affiliations on a pubsub service
@@ -316,7 +355,7 @@ module Jabber
             if reply.pubsub.first_element('subscriptions').attributes['node'] == node
               reply.pubsub.first_element('subscriptions').each_element('subscription') { |subscription|
     	        res << PubSub::Subscription.import(subscription)
-              } 
+              }
             end
           end
           true
@@ -359,7 +398,7 @@ module Jabber
       # jid:: [Jabber::JID] or [String]
       # options:: [Jabber::PubSub::SubscriptionConfig} specifying configuration options
       # subid:: [String] or nil
-      # return:: true 
+      # return:: true
       def set_options_for(node, jid, options, subid = nil)
         iq = basic_pubsub_query(:set)
         iq.pubsub.add(Jabber::PubSub::SubscriptionConfig.new(node, jid.kind_of?(String) ? Jabber::JID.new(jid).strip: jid.strip, options, subid))
@@ -370,7 +409,7 @@ module Jabber
 
         ret
       end
-     
+
       ##
       # String representation
       # result:: [String] The PubSub service's JID