xmpp4r 0.3.2 → 0.4

data/lib/xmpp4r/presence.rb

@@ -7,7 +7,7 @@ require 'xmpp4r/x'
 
 module Jabber
   ##
-  # The presence class is used to construct presence messages to 
+  # The presence class is used to construct presence messages to
   # send to the Jabber service.
   class Presence < XMPPStanza
     name_xmlns 'presence', 'jabber:client'
@@ -107,6 +107,7 @@ module Jabber
         xe = add_element('show')
       end
       case val
+        when String then raise "Invalid value for show."
         when :away then text = 'away'
         when :chat then text = 'chat'
         when :dnd then text = 'dnd'

data/lib/xmpp4r/pubsub.rb

@@ -1 +1,8 @@
+require 'xmpp4r/pubsub/iq/pubsub'
+require 'xmpp4r/pubsub/children/event'
+require 'xmpp4r/pubsub/children/item'
+require 'xmpp4r/pubsub/children/items'
+require 'xmpp4r/pubsub/children/publish'
+require 'xmpp4r/pubsub/children/subscription'
+require 'xmpp4r/pubsub/children/unsubscribe'
 require 'xmpp4r/pubsub/helper/servicehelper'

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

@@ -0,0 +1,86 @@
+# =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/iq/pubsub'
+
+module Jabber
+  module PubSub
+
+    class Configuration < XMPPElement
+      ##
+      # get the underlying XData form element
+      def form
+        children.each do |c|
+          return c if c.kind_of?(Jabber::Dataforms::XData)
+        end
+
+        nil
+      end
+
+      def form=(form)
+        children.each do |c|
+          delete_element(c)
+          if c.kind_of?(Jabber::Dataforms::XData)
+            delete(c)
+          end
+        end
+        add(form)
+      end
+
+      # Implemented by NodeConfig and SubscriptionConfig
+      def form_type
+        ''
+      end
+
+      def options=(options)
+        if options
+          self.form = form_for_options( form_type, options )
+        end
+      end
+
+      ##
+      # get a list of the configured options represented by this stanza
+      # return:: [Hash] the options and their values
+      def options
+        configured_options = {}
+
+        if !form.nil?
+          form.fields.each do |f|
+            f.values.size == 1 ? configured_options[f.var] = f.values.first : configured_options[f.var] = f.values
+          end
+        end
+
+        configured_options
+      end
+
+      def node=(node)
+        attributes['node'] = node
+      end
+
+      def node
+        attributes['node']
+      end
+
+      private
+
+      ##
+      # creates a Dataform for configuration
+      # config:: [Hash] the desired configuration options
+      def form_for_options(type, options)
+        form = Jabber::Dataforms::XData.new(:submit)
+        pubsub_config = Jabber::Dataforms::XDataField.new('FORM_TYPE', :hidden)
+        pubsub_config.values = [type]
+        form.add(pubsub_config)
+        options.each_pair do |key, value|
+          f = Jabber::Dataforms::XDataField.new(key)
+          f.values = [value]
+          form.add(f)
+        end
+
+        form
+      end
+    end
+  end
+end

data/lib/xmpp4r/pubsub/{stanzas → children}/event.rb

@@ -13,7 +13,7 @@ module Jabber
     class Event < XMPPElement
       name_xmlns 'event', NS_PUBSUB + '#event'
       force_xmlns true
-      
+
       ##
       # return payload
       def payload
@@ -26,23 +26,23 @@ module Jabber
       def payload=(pl)
         add_element = pl
       end
-      
+
       ##
       # return the payload type
       def event_type?
         # each child of event
-	# this should interate only one time
+        # this should iterate only one time
         each_element('./event/*') { |plelement|
-	  case plelement.name
-	    when 'collection' 	   then return :collection
-	    when 'configuration'   then	return :configuration
-	    when 'delete'	   then return :delete
-	    when 'items'	   then return :items
-	    when 'purge'	   then return :purge
-	    when 'subscription'	   then return :subscription
-	    else return nil
-	  end
-	 }
+          case plelement.name
+            when 'collection' 	   then return :collection
+            when 'configuration'   then	return :configuration
+            when 'delete'	   then return :delete
+            when 'items'	   then return :items
+            when 'purge'	   then return :purge
+            when 'subscription'	   then return :subscription
+            else return nil
+          end
+        }
       end
     end
   end

data/lib/xmpp4r/pubsub/{stanzas → children}/item.rb

@@ -11,7 +11,6 @@ module Jabber
     # One PubSub Item
     class Item < XMPPElement
       name_xmlns 'item', NS_PUBSUB
-      force_xmlns true
       def initialize(id=nil)
         super()
         attributes['id'] = id
@@ -23,5 +22,14 @@ module Jabber
         attributes['id'] = myid
       end
     end
+
+    ##
+    # An Item wrapped in a Pubsub Event.
+    #
+    # See example 2 in http://www.xmpp.org/extensions/xep-0060.html#intro-howitworks
+    # and http://www.xmpp.org/extensions/xep-0060.html#schemas-event
+    class EventItem < Item
+      name_xmlns 'item', NS_PUBSUB + "#event"
+    end
   end
 end

data/lib/xmpp4r/pubsub/{stanzas → children}/items.rb

@@ -11,7 +11,7 @@ module Jabber
     # a collection of Items
     class Items < XMPPElement
       name_xmlns 'items', NS_PUBSUB
-      force_xmlns true
+
       def node
         attributes['node']
       end
@@ -31,5 +31,14 @@ module Jabber
         attributes['max_items'] = mymaxitems
       end
     end
+
+    ##
+    # Items wrapped in a Pubsub Event.
+    #
+    # See example 2 in http://www.xmpp.org/extensions/xep-0060.html#intro-howitworks
+    # and http://www.xmpp.org/extensions/xep-0060.html#schemas-event
+    class EventItems < Items
+      name_xmlns 'items', NS_PUBSUB + "#event"
+    end
   end
 end

data/lib/xmpp4r/pubsub/children/node_config.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/xmppelement'
+require 'xmpp4r/pubsub/children/configuration'
+
+module Jabber
+  module PubSub
+    ##
+    # NodeConfig
+    #
+    # A <configure> XMPP element for pubsub nodes, see example 123 in
+    # http://www.xmpp.org/extensions/xep-0060.html#owner-create-and-configure
+    class NodeConfig < Configuration
+      name_xmlns 'configure', NS_PUBSUB
+
+      ##
+      # Construct a <configure> element.
+      # node:: [String] the node to configure
+      # options:: [Hash] the configuration to apply
+      def initialize(node = nil, options = nil)
+        super()
+
+        self.node = node
+        self.options = options
+      end
+
+      private
+
+      def form_type
+        'http://jabber.org/protocol/pubsub#node_config'
+      end
+    end
+
+    ##
+    #
+    # OwnerNodeConfig
+    #
+    # A <configure> stanza for 'Owner' use cases
+    #
+    # see example 125 in
+    # http://www.xmpp.org/extensions/xep-0060.html#owner-configure-request
+    class OwnerNodeConfig < NodeConfig
+      name_xmlns 'configure', NS_PUBSUB + '#owner'
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# =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
+
+    ##
+    # Publish
+    #
+    # A <publish> XMPP element, see example 1 in
+    # http://www.xmpp.org/extensions/xep-0060.html#intro-howitworks
+    class Publish < XMPPElement
+      name_xmlns 'publish', NS_PUBSUB
+      ##
+      # return the node for this publication
+      def node
+        attributes['node']
+      end
+    end
+  end
+end

data/lib/xmpp4r/pubsub/{stanzas → children}/subscription.rb

@@ -11,41 +11,41 @@ module Jabber
     class Subscription < XMPPElement
       name_xmlns 'subscription', NS_PUBSUB
       def initialize(myjid=nil,mynode=nil,mysubid=nil,mysubscription=nil)
-        super(true)
+        super()
         jid = myjid
-	node =  mynode
-	subid =  mysubid
-	state = mysubscription
+        node =  mynode
+        subid =  mysubid
+        state = mysubscription
       end
       def jid
-        attributes['jid']
+        (a = attribute('jid')).nil? ? a : JID.new(a.value)
       end
       def jid=(myjid)
-        attributes['jid'] = myjid
+        add_attribute('jid', myjid ? myjid.to_s : nil)
       end
-      
+
       def node
         attributes['node']
       end
       def node=(mynode)
         attributes['node'] = mynode
       end
-      
+
       def subid
         attributes['subid']
       end
       def subid=(mysubid)
         attributes['subid'] = mysubid
       end
-       
-      def state                                                                                                            
+
+      def state
           # each child of event
           # this should interate only one time
           case attributes['subscription']
               when 'none'      		then return :none
               when 'pending'   		then return :pending
               when 'subscribed'         then return :subscribed
-              when 'unconfigured'       then return :items
+              when 'unconfigured'       then return :unconfigured
               else return nil
           end
       end
@@ -53,6 +53,10 @@ module Jabber
         attributes['subscription'] = mystate
       end
       alias subscription state
+
+      def need_approval?
+        state == :pending
+      end
     end
   end
-end
+end

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