gmcmillan-xmpp4r 0.5

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

@@ -0,0 +1,49 @@
+# =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
+
+    ##
+    # Event
+    # a publishing event
+    class Event < XMPPElement
+      name_xmlns 'event', NS_PUBSUB + '#event'
+      force_xmlns true
+
+      ##
+      # return payload
+      def payload
+        elements
+      end
+
+      ##
+      # add payload
+      # payload:: [REXML::Element]
+      def payload=(pl)
+        add_element = pl
+      end
+
+      ##
+      # return the payload type
+      def event_type?
+        # each child of event
+        # 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
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# =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
+    ##
+    # Item
+    # One PubSub Item
+    class Item < XMPPElement
+      name_xmlns 'item', NS_PUBSUB
+      def initialize(id=nil)
+        super()
+        attributes['id'] = id
+      end
+      def id
+        attributes['id']
+      end
+      def id=(myid)
+        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/children/items.rb

@@ -0,0 +1,53 @@
+# =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
+    ##
+    # Items
+    # a collection of Items
+    class Items < XMPPElement
+      include Enumerable
+      name_xmlns 'items', NS_PUBSUB
+
+      def node
+        attributes['node']
+      end
+      def node=(mynodename)
+        attributes['node'] = mynodename
+      end
+      def subid
+        attributes['subid']
+      end
+      def subid=(mysubid)
+        attributes['subid'] = mysubid.to_s
+      end
+      def max_items
+        attributes['max_items']
+      end
+      def max_items=(mymaxitems)
+        attributes['max_items'] = mymaxitems.to_s
+      end
+
+      def items
+        get_elements("item")
+      end
+
+      def each(&block)
+        items.each(&block)
+      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,38 @@
+# =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
+      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
+        attributes['node']
+      end
+    end
+  end
+end

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/children/subscription.rb

@@ -0,0 +1,62 @@
+# =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
+    ##
+    # Subscription
+    class Subscription < XMPPElement
+      name_xmlns 'subscription', NS_PUBSUB
+      def initialize(myjid=nil,mynode=nil,mysubid=nil,mysubscription=nil)
+        super()
+        jid = myjid
+        node =  mynode
+        subid =  mysubid
+        state = mysubscription
+      end
+      def jid
+        (a = attribute('jid')).nil? ? a : JID.new(a.value)
+      end
+      def 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
+          # 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 :unconfigured
+              else return nil
+          end
+      end
+      def state=(mystate)
+        attributes['subscription'] = mystate
+      end
+      alias subscription state
+
+      def need_approval?
+        state == :pending
+      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,63 @@
+# =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,mysubid=nil)
+        super()
+        jid = myjid
+        node =  mynode
+        subid = mysubid
+      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
+
+      ##
+      # shows the subid
+      # return:: [String]
+      def subid
+        attributes['subid']
+      end
+
+      ##
+      # sets the subid
+      # =:: [String]
+      def subid=(mysubid)
+        attributes['subid'] = mysubid
+      end
+    end
+  end
+end