tp-blather 0.8.2

data/lib/blather/stanza/pubsub/subscribe.rb

@@ -0,0 +1,68 @@
+module Blather
+class Stanza
+class PubSub
+
+  # # PubSub Subscribe Stanza
+  #
+  # [XEP-0060 Section 6.1 - Subscribe to a Node](http://xmpp.org/extensions/xep-0060.html#subscriber-subscribe)
+  #
+  # @handler :pubsub_subscribe
+  class Subscribe < PubSub
+    register :pubsub_subscribe, :subscribe, self.registered_ns
+
+    # Create a new subscription node
+    #
+    # @param [Blather::Stanza::Iq::VALID_TYPES] type the IQ stanza type
+    # @param [String] host the host name to send the request to
+    # @param [String] node the node to subscribe to
+    # @param [Blather::JID, #to_s] jid see {#jid=}
+    def self.new(type = :set, host = nil, node = nil, jid = nil)
+      new_node = super(type, host)
+      new_node.node = node
+      new_node.jid = jid
+      new_node
+    end
+
+    # Get the JID of the entity to subscribe
+    #
+    # @return [Blather::JID]
+    def jid
+      JID.new(subscribe[:jid])
+    end
+
+    # Set the JID of the entity to subscribe
+    #
+    # @param [Blather::JID, #to_s] jid
+    def jid=(jid)
+      subscribe[:jid] = jid
+    end
+
+    # Get the name of the node to subscribe to
+    #
+    # @return [String]
+    def node
+      subscribe[:node]
+    end
+
+    # Set the name of the node to subscribe to
+    #
+    # @param [String] node
+    def node=(node)
+      subscribe[:node] = node
+    end
+
+    # Get or create the actual subscribe node on the stanza
+    #
+    # @return [Blather::XMPPNode]
+    def subscribe
+      unless subscribe = pubsub.find_first('ns:subscribe', :ns => self.class.registered_ns)
+        self.pubsub << (subscribe = XMPPNode.new('subscribe', self.document))
+        subscribe.namespace = self.pubsub.namespace
+      end
+      subscribe
+    end
+  end  # Subscribe
+
+end  # PubSub
+end  # Stanza
+end  # Blather

data/lib/blather/stanza/pubsub/subscription.rb

@@ -0,0 +1,135 @@
+module Blather
+class Stanza
+class PubSub
+
+  # # PubSub Subscription Stanza
+  #
+  # [XEP-0060 Section 8.8 Manage Subscriptions](http://xmpp.org/extensions/xep-0060.html#owner-subscriptions)
+  #
+  # @handler :pubsub_subscription
+  class Subscription < PubSub
+    # @private
+    VALID_TYPES = [:none, :pending, :subscribed, :unconfigured]
+
+    register :pubsub_subscription, :subscription, self.registered_ns
+
+    # Create a new subscription request node
+    #
+    # @param [Blather::Stanza::Iq::VALID_TYPES] type the IQ type
+    # @param [String] host the host to send the request to
+    # @param [String] node the node to look for requests on
+    # @param [Blather::JID, #to_s] jid the JID of the subscriber
+    # @param [String] subid the subscription ID
+    # @param [VALID_TYPES] subscription the subscription type
+    def self.new(type = :result, host = nil, node = nil, jid = nil, subid = nil, subscription = nil)
+      new_node = super(type, host)
+      new_node.node = node
+      new_node.jid = jid
+      new_node.subid = subid
+      new_node.subscription = subscription
+      new_node
+    end
+
+    # Check if the type is none
+    #
+    # @return [Boolean]
+    def none?
+      self.subscription == :none
+    end
+
+    # Check if the type is pending
+    #
+    # @return [Boolean]
+    def pending?
+      self.subscription == :pending
+    end
+
+    # Check if the type is subscribed
+    #
+    # @return [Boolean]
+    def subscribed?
+      self.subscription == :subscribed
+    end
+
+    # Check if the type is unconfigured
+    #
+    # @return [Boolean]
+    def unconfigured?
+      self.subscription == :unconfigured
+    end
+
+    # Get the JID of the subscriber
+    #
+    # @return [Blather::JID]
+    def jid
+      JID.new(subscription_node[:jid])
+    end
+
+    # Set the JID of the subscriber
+    #
+    # @param [Blather::JID, #to_s] jid
+    def jid=(jid)
+      subscription_node[:jid] = jid
+    end
+
+    # Get the name of the subscription node
+    #
+    # @return [String]
+    def node
+      subscription_node[:node]
+    end
+
+    # Set the name of the subscription node
+    #
+    # @param [String] node
+    def node=(node)
+      subscription_node[:node] = node
+    end
+
+    # Get the ID of the subscription
+    #
+    # @return [String]
+    def subid
+      subscription_node[:subid]
+    end
+
+    # Set the ID of the subscription
+    #
+    # @param [String] subid
+    def subid=(subid)
+      subscription_node[:subid] = subid
+    end
+
+    # Get the subscription type
+    #
+    # @return [VALID_TYPES, nil]
+    def subscription
+      s = subscription_node[:subscription]
+      s.to_sym if s
+    end
+
+    # Set the subscription type
+    #
+    # @param [VALID_TYPES, nil] subscription
+    def subscription=(subscription)
+      if subscription && !VALID_TYPES.include?(subscription.to_sym)
+        raise ArgumentError, "Invalid Type (#{type}), use: #{VALID_TYPES*' '}"
+      end
+      subscription_node[:subscription] = subscription
+    end
+
+    # Get or create the actual subscription node
+    #
+    # @return [Blather::XMPPNode]
+    def subscription_node
+      unless subscription = pubsub.find_first('ns:subscription', :ns => self.class.registered_ns)
+        self.pubsub << (subscription = XMPPNode.new('subscription', self.document))
+        subscription.namespace = self.pubsub.namespace
+      end
+      subscription
+    end
+  end  # Subscribe
+
+end  # PubSub
+end  # Stanza
+end  # Blather

data/lib/blather/stanza/pubsub/subscriptions.rb

@@ -0,0 +1,83 @@
+module Blather
+class Stanza
+class PubSub
+
+  # # PubSub Subscriptions Stanza
+  #
+  # [XEP-0060 Section 5.6 Retrieve Subscriptions](http://xmpp.org/extensions/xep-0060.html#entity-subscriptions)
+  #
+  # @handler :pubsub_subscriptions
+  class Subscriptions < PubSub
+    register :pubsub_subscriptions, :subscriptions, self.registered_ns
+
+    include Enumerable
+    alias_method :find, :xpath
+
+    # Overrides the parent to ensure a subscriptions node is created
+    # @private
+    def self.new(type = nil, host = nil)
+      new_node = super type
+      new_node.to = host
+      new_node.subscriptions
+      new_node
+    end
+
+    # Overrides the parent to ensure the subscriptions node is destroyed
+    # @private
+    def inherit(node)
+      subscriptions.remove
+      super
+    end
+
+    # Get or create the actual subscriptions node
+    #
+    # @return [Blather::XMPPNode]
+    def subscriptions
+      aff = pubsub.find_first('subscriptions', self.class.registered_ns)
+      unless aff
+        (self.pubsub << (aff = XMPPNode.new('subscriptions', self.document)))
+      end
+      aff
+    end
+
+    # Iterate over the list of subscriptions
+    #
+    # @yieldparam [Hash] subscription
+    # @see {#list}
+    def each(&block)
+      list.each &block
+    end
+
+    # Get the size of the subscriptions list
+    #
+    # @return [Fixnum]
+    def size
+      list.size
+    end
+
+    # Get a hash of subscriptions
+    #
+    # @example
+    #   { :subscribed => [{:node => 'node1', :jid => 'francisco@denmark.lit', :subid => 'fd8237yr872h3f289j2'}, {:node => 'node2', :jid => 'francisco@denmark.lit', :subid => 'h8394hf8923ju'}],
+    #     :unconfigured => [{:node => 'node3', :jid => 'francisco@denmark.lit'}],
+    #     :pending => [{:node => 'node4', :jid => 'francisco@denmark.lit'}],
+    #     :none => [{:node => 'node5', :jid => 'francisco@denmark.lit'}] }
+    #
+    # @return [Hash]
+    def list
+      subscriptions.find('//ns:subscription', :ns => self.class.registered_ns).inject({}) do |hash, item|
+        hash[item[:subscription].to_sym] ||= []
+        sub = {
+          :node => item[:node],
+          :jid => item[:jid]
+        }
+        sub[:subid] = item[:subid] if item[:subid]
+        hash[item[:subscription].to_sym] << sub
+        hash
+      end
+    end
+  end  # Subscriptions
+
+end  # PubSub
+end  # Stanza
+end  # Blather

data/lib/blather/stanza/pubsub/unsubscribe.rb

@@ -0,0 +1,84 @@
+module Blather
+class Stanza
+class PubSub
+
+  # # PubSub Unsubscribe Stanza
+  #
+  # [XEP-0060 Section 6.2 - Unsubscribe from a Node](http://xmpp.org/extensions/xep-0060.html#subscriber-unsubscribe)
+  #
+  # @handler :pubsub_unsubscribe
+  class Unsubscribe < PubSub
+    register :pubsub_unsubscribe, :unsubscribe, self.registered_ns
+
+    # Create a new unsubscribe node
+    #
+    # @param [Blather::Stanza::Iq::VALID_TYPES] type the IQ stanza type
+    # @param [String] host the host to send the request to
+    # @param [String] node the node to unsubscribe from
+    # @param [Blather::JID, #to_s] jid the JID of the unsubscription
+    # @param [String] subid the subscription ID of the unsubscription
+    def self.new(type = :set, host = nil, node = nil, jid = nil, subid = nil)
+      new_node = super(type, host)
+      new_node.node = node
+      new_node.jid = jid
+      new_node.subid = subid
+      new_node
+    end
+
+    # Get the JID of the unsubscription
+    #
+    # @return [Blather::JID]
+    def jid
+      JID.new(unsubscribe[:jid])
+    end
+
+    # Set the JID of the unsubscription
+    #
+    # @param [Blather::JID, #to_s] jid
+    def jid=(jid)
+      unsubscribe[:jid] = jid
+    end
+
+    # Get the name of the node to unsubscribe from
+    #
+    # @return [String]
+    def node
+      unsubscribe[:node]
+    end
+
+    # Set the name of the node to unsubscribe from
+    #
+    # @param [String] node
+    def node=(node)
+      unsubscribe[:node] = node
+    end
+
+    # Get the subscription ID to unsubscribe from
+    #
+    # @return [String]
+    def subid
+      unsubscribe[:subid]
+    end
+
+    # Set the subscription ID to unsubscribe from
+    #
+    # @param [String] node
+    def subid=(subid)
+      unsubscribe[:subid] = subid
+    end
+
+    # Get or create the actual unsubscribe node
+    #
+    # @return [Blather::XMPPNode]
+    def unsubscribe
+      unless unsubscribe = pubsub.find_first('ns:unsubscribe', :ns => self.class.registered_ns)
+        self.pubsub << (unsubscribe = XMPPNode.new('unsubscribe', self.document))
+        unsubscribe.namespace = self.pubsub.namespace
+      end
+      unsubscribe
+    end
+  end  # Unsubscribe
+
+end  # PubSub
+end  # Stanza
+end  # Blather

data/lib/blather/stanza/pubsub_owner.rb

@@ -0,0 +1,51 @@
+module Blather
+class Stanza
+
+  # # PubSubOwner Base Class
+  #
+  # [XEP-0060 - Publish-Subscribe](http://xmpp.org/extensions/xep-0060.html)
+  #
+  # @handler :pubsub_owner
+  class PubSubOwner < Iq
+    register :pubsub_owner, :pubsub, 'http://jabber.org/protocol/pubsub#owner'
+
+    # Creates the proper class from the stana's child
+    # @private
+    def self.import(node)
+      klass = nil
+      if pubsub = node.document.find_first('//ns:pubsub', :ns => self.registered_ns)
+        pubsub.children.each { |e| break if klass = class_from_registration(e.element_name, (e.namespace.href if e.namespace)) }
+      end
+      (klass || self).new(node[:type]).inherit(node)
+    end
+
+    # Overrides the parent to ensure a pubsub node is created
+    # @private
+    def self.new(type = nil, host = nil)
+      new_node = super type
+      new_node.to = host
+      new_node.pubsub
+      new_node
+    end
+
+    # Overrides the parent to ensure the pubsub node is destroyed
+    # @private
+    def inherit(node)
+      remove_children :pubsub
+      super
+    end
+
+    # Get or create the pubsub node on the stanza
+    #
+    # @return [Blather::XMPPNode]
+    def pubsub
+      unless p = find_first('ns:pubsub', :ns => self.class.registered_ns)
+        self << (p = XMPPNode.new('pubsub', self.document))
+        p.namespace = self.class.registered_ns
+      end
+      p
+    end
+  end  # PubSubOwner
+
+end  # Stanza
+end  # Blather

data/lib/blather/stanza/pubsub_owner/delete.rb

@@ -0,0 +1,52 @@
+module Blather
+class Stanza
+class PubSubOwner
+
+  # # PubSubOwner Delete Stanza
+  #
+  # [XEP-0060 Section 8.4 Delete a Node](http://xmpp.org/extensions/xep-0060.html#owner-delete)
+  #
+  # @handler :pubsub_delete
+  class Delete < PubSubOwner
+    register :pubsub_delete, :delete, self.registered_ns
+
+    # Create a new delete stanza
+    #
+    # @param [Blather::Stanza::Iq::VALID_TYPES] type the IQ stanza type
+    # @param [String] host the host to send the request to
+    # @param [String] node the name of the node to delete
+    def self.new(type = :set, host = nil, node = nil)
+      new_node = super(type, host)
+      new_node.node = node
+      new_node
+    end
+
+    # Get the name of the node to delete
+    #
+    # @return [String]
+    def node
+      delete_node[:node]
+    end
+
+    # Set the name of the node to delete
+    #
+    # @param [String] node
+    def node=(node)
+      delete_node[:node] = node
+    end
+
+    # Get or create the actual delete node on the stanza
+    #
+    # @return [Blather::XMPPNode]
+    def delete_node
+      unless delete_node = pubsub.find_first('ns:delete', :ns => self.class.registered_ns)
+        self.pubsub << (delete_node = XMPPNode.new('delete', self.document))
+        delete_node.namespace = self.pubsub.namespace
+      end
+      delete_node
+    end
+  end  # Retract
+
+end  # PubSub
+end  # Stanza
+end  # Blather