jabber4r-revive 0.9.0 → 0.10.0

data/lib/jabber4r/protocol/parsed_xml_element.rb

@@ -1,208 +1,208 @@
-# coding: utf-8
-
-# License: see LICENSE
-# Jabber4R - Jabber Instant Messaging Library for Ruby
-# Copyright (C) 2002  Rich Kilmer <rich@infoether.com>
-
-module Jabber::Protocol
-  ##
-  # This class is constructed from XML data elements that are received from
-  # the Jabber service.
-  #
-  class ParsedXMLElement
-
-    ##
-    # This class is used to return nil element values to prevent errors (and
-    # reduce the number of checks.
-    #
-    class NilParsedXMLElement
-
-      ##
-      # Override to return nil
-      #
-      # return:: [nil]
-      #
-      def method_missing(methId, *args)
-        return nil
-      end
-
-      ##
-      # Evaluate as nil
-      #
-      # return:: [Boolean] true
-      #
-      def nil?
-        return true
-      end
-
-      ##
-      # Return a zero count
-      #
-      # return:: [Integer] 0
-      #
-      def count
-        0
-      end
-
-      include Singleton
-    end
-
-    # The <tag> as String
-    attr_reader :element_tag
-
-    # The parent ParsedXMLElement
-    attr_reader :element_parent
-
-    # A hash of ParsedXMLElement children
-    attr_reader :element_children
-
-    # The data <tag>data</tag> for a tag
-    attr_reader :element_data
-
-    ##
-    # Construct an instance for the given tag
-    #
-    # tag:: [String] The tag
-    # parent:: [Jabber::Protocol::ParsedXMLElement = nil] The parent element
-    #
-    def initialize(tag, parent=nil)
-      @element_tag = tag
-      @element_parent = parent
-      @element_children = {}
-      @attributes = {}
-      @element_consumed = false
-    end
-
-    ##
-    # Add the attribute to the element
-    #   <tag name="value">data</tag>
-    #
-    # name:: [String] The attribute name
-    # value:: [String] The attribute value
-    # return:: [Jabber::Protocol::ParsedXMLElement] self for chaining
-    #
-    def add_attribute(name, value)
-      @attributes[name]=value
-      self
-    end
-
-    ##
-    # Factory to build a child element from this element with the given tag
-    #
-    # tag:: [String] The tag name
-    # return:: [Jabber::Protocol::ParsedXMLElement] The newly created child element
-    #
-    def add_child(tag)
-      child = ParsedXMLElement.new(tag, self)
-      @element_children[tag] = Array.new if not @element_children.has_key? tag
-      @element_children[tag] << child
-      return child
-    end
-
-    ##
-    # When an xml is received from the Jabber service and a ParsedXMLElement is created,
-    # it is propogated to all filters and listeners.  Any one of those can consume the element
-    # to prevent its propogation to other filters or listeners. This method marks the element
-    # as consumed.
-    #
-    def consume_element
-      @element_consumed = true
-    end
-
-    ##
-    # Checks if the element is consumed
-    #
-    # return:: [Boolean] True if the element is consumed
-    #
-    def element_consumed?
-      @element_consumed
-    end
-
-    ##
-    # Appends data to the element
-    #
-    # data:: [String] The data to append
-    # return:: [Jabber::Protocol::ParsedXMLElement] self for chaining
-    #
-    def append_data(data)
-      @element_data = "" unless @element_data
-      @element_data += data
-      self
-    end
-
-    ##
-    # Calls the parent's element_children (hash) index off of this elements
-    # tag and gets the supplied index.  In this sense it gets its sibling based
-    # on offset.
-    #
-    # number:: [Integer] The number of the sibling to get
-    # return:: [Jabber::Protocol::ParsedXMLElement] The sibling element
-    #
-    def [](number)
-      return @element_parent.element_children[@element_tag][number] if @element_parent
-    end
-
-    ##
-    # Returns the count of siblings with this element's tag
-    #
-    # return:: [Integer] The number of sibling elements
-    #
-    def count
-      return @element_parent.element_children[@element_tag].size if @element_parent
-      return 0
-    end
-
-    ##
-    # see _count
-    #
-    def size
-      count
-    end
-
-    ##
-    # Overrides to allow for directly accessing child elements
-    # and attributes.  If prefaced by attr_ it looks for an attribute
-    # that matches or checks for a child with a tag that matches
-    # the method name.  If no match occurs, it returns a
-    # NilParsedXMLElement (singleton) instance.
-    #
-    # Example:: <alpha number="1"><beta number="2">Beta Data</beta></alpha>
-    #
-    #  element.element_tag #=> alpha
-    #  element.attr_number #=> 1
-    #  element.beta.element_data #=> Beta Data
-    #
-    def method_missing(methId, *args)
-        tag = methId.id2name
-        if tag[0..4]=="attr_"
-          return @attributes[tag[5..-1]]
-        end
-        list = @element_children[tag]
-        return list[0] if list
-        return NilParsedXMLElement.instance
-    end
-
-    ##
-    # Returns the valid XML as a string
-    #
-    # return:: [String] XML string
-    def to_s
-      begin
-        result = "\n<#{@element_tag}"
-        @attributes.each {|key, value| result += (' '+key+'="'+value+'"') }
-        if @element_children.size>0 or @element_data
-          result += ">"
-        else
-          result += "/>"
-        end
-        result += @element_data if @element_data
-        @element_children.each_value {|array| array.each {|je| result += je.to_s} }
-        result += "\n" if @element_children.size>0
-        result += "</#{@element_tag}>" if @element_children.size>0 or @element_data
-        result
-      rescue => exception
-        puts exception.to_s
-      end
-    end
-  end
+# coding: utf-8
+
+# License: see LICENSE
+# Jabber4R - Jabber Instant Messaging Library for Ruby
+# Copyright (C) 2002  Rich Kilmer <rich@infoether.com>
+
+module Jabber::Protocol
+  ##
+  # This class is constructed from XML data elements that are received from
+  # the Jabber service.
+  #
+  class ParsedXMLElement
+
+    ##
+    # This class is used to return nil element values to prevent errors (and
+    # reduce the number of checks.
+    #
+    class NilParsedXMLElement
+
+      ##
+      # Override to return nil
+      #
+      # return:: [nil]
+      #
+      def method_missing(methId, *args)
+        return nil
+      end
+
+      ##
+      # Evaluate as nil
+      #
+      # return:: [Boolean] true
+      #
+      def nil?
+        return true
+      end
+
+      ##
+      # Return a zero count
+      #
+      # return:: [Integer] 0
+      #
+      def count
+        0
+      end
+
+      include Singleton
+    end
+
+    # The <tag> as String
+    attr_reader :element_tag
+
+    # The parent ParsedXMLElement
+    attr_reader :element_parent
+
+    # A hash of ParsedXMLElement children
+    attr_reader :element_children
+
+    # The data <tag>data</tag> for a tag
+    attr_reader :element_data
+
+    ##
+    # Construct an instance for the given tag
+    #
+    # tag:: [String] The tag
+    # parent:: [Jabber::Protocol::ParsedXMLElement = nil] The parent element
+    #
+    def initialize(tag, parent=nil)
+      @element_tag = tag
+      @element_parent = parent
+      @element_children = {}
+      @attributes = {}
+      @element_consumed = false
+    end
+
+    ##
+    # Add the attribute to the element
+    #   <tag name="value">data</tag>
+    #
+    # name:: [String] The attribute name
+    # value:: [String] The attribute value
+    # return:: [Jabber::Protocol::ParsedXMLElement] self for chaining
+    #
+    def add_attribute(name, value)
+      @attributes[name]=value
+      self
+    end
+
+    ##
+    # Factory to build a child element from this element with the given tag
+    #
+    # tag:: [String] The tag name
+    # return:: [Jabber::Protocol::ParsedXMLElement] The newly created child element
+    #
+    def add_child(tag)
+      child = ParsedXMLElement.new(tag, self)
+      @element_children[tag] = Array.new if not @element_children.has_key? tag
+      @element_children[tag] << child
+      return child
+    end
+
+    ##
+    # When an xml is received from the Jabber service and a ParsedXMLElement is created,
+    # it is propogated to all filters and listeners.  Any one of those can consume the element
+    # to prevent its propogation to other filters or listeners. This method marks the element
+    # as consumed.
+    #
+    def consume_element
+      @element_consumed = true
+    end
+
+    ##
+    # Checks if the element is consumed
+    #
+    # return:: [Boolean] True if the element is consumed
+    #
+    def element_consumed?
+      @element_consumed
+    end
+
+    ##
+    # Appends data to the element
+    #
+    # data:: [String] The data to append
+    # return:: [Jabber::Protocol::ParsedXMLElement] self for chaining
+    #
+    def append_data(data)
+      @element_data = "" unless @element_data
+      @element_data += data
+      self
+    end
+
+    ##
+    # Calls the parent's element_children (hash) index off of this elements
+    # tag and gets the supplied index.  In this sense it gets its sibling based
+    # on offset.
+    #
+    # number:: [Integer] The number of the sibling to get
+    # return:: [Jabber::Protocol::ParsedXMLElement] The sibling element
+    #
+    def [](number)
+      return @element_parent.element_children[@element_tag][number] if @element_parent
+    end
+
+    ##
+    # Returns the count of siblings with this element's tag
+    #
+    # return:: [Integer] The number of sibling elements
+    #
+    def count
+      return @element_parent.element_children[@element_tag].size if @element_parent
+      return 0
+    end
+
+    ##
+    # see _count
+    #
+    def size
+      count
+    end
+
+    ##
+    # Overrides to allow for directly accessing child elements
+    # and attributes.  If prefaced by attr_ it looks for an attribute
+    # that matches or checks for a child with a tag that matches
+    # the method name.  If no match occurs, it returns a
+    # NilParsedXMLElement (singleton) instance.
+    #
+    # Example:: <alpha number="1"><beta number="2">Beta Data</beta></alpha>
+    #
+    #  element.element_tag #=> alpha
+    #  element.attr_number #=> 1
+    #  element.beta.element_data #=> Beta Data
+    #
+    def method_missing(methId, *args)
+        tag = methId.id2name
+        if tag[0..4]=="attr_"
+          return @attributes[tag[5..-1]]
+        end
+        list = @element_children[tag]
+        return list[0] if list
+        return NilParsedXMLElement.instance
+    end
+
+    ##
+    # Returns the valid XML as a string
+    #
+    # return:: [String] XML string
+    def to_s
+      begin
+        result = "\n<#{@element_tag}"
+        @attributes.each {|key, value| result += (' '+key+'="'+value+'"') }
+        if @element_children.size>0 or @element_data
+          result += ">"
+        else
+          result += "/>"
+        end
+        result += @element_data if @element_data
+        @element_children.each_value {|array| array.each {|je| result += je.to_s} }
+        result += "\n" if @element_children.size>0
+        result += "</#{@element_tag}>" if @element_children.size>0 or @element_data
+        result
+      rescue => exception
+        puts exception.to_s
+      end
+    end
+  end
 end

data/lib/jabber4r/protocol/presence.rb

@@ -1,160 +1,160 @@
-# coding: utf-8
-
-# License: see LICENSE
-# Jabber4R - Jabber Instant Messaging Library for Ruby
-# Copyright (C) 2002  Rich Kilmer <rich@infoether.com>
-
-module Jabber::Protocol
-  ##
-  # The presence class is used to construct presence messages to
-  # send to the Jabber service.
-  #
-  class Presence
-    attr_accessor :to, :from, :id, :type
-
-    # The state to show (chat, xa, dnd, away)
-    attr_accessor :show
-
-    # The status message
-    attr_accessor :status
-    attr_accessor :priority
-
-    ##
-    # Constructs a Presence object w/the supplied id
-    #
-    # id:: [String] The message ID
-    # show:: [String] The state to show
-    # status:: [String] The status message
-    #
-    def initialize(id, show=nil, status=nil)
-      @id = id
-      @show = show if show
-      @status = status if status
-    end
-
-    ##
-    # Generate a presence object for initial presence notification
-    #
-    # id:: [String] The message ID
-    # show:: [String] The state to show
-    # status:: [String] The status message
-    # return:: [Jabber::Protocol::Presence] The newly created Presence object
-    #
-    def self.gen_initial(id, show=nil, status=nil)
-      Presence.new(id, show, status)
-    end
-
-    ##
-    # Generate a presence object w/show="normal" (normal availability)
-    #
-    # id:: [String] The message ID
-    # status:: [String=nil] The status message
-    # return:: [Jabber::Protocol::Presence] The newly created Presence object
-    #
-    def self.gen_normal(id, status=nil)
-      Presence.new(id, "normal", status)
-    end
-
-    ##
-    # Generate a presence object w/show="chat" (free for chat)
-    #
-    # id:: [String] The message ID
-    # status:: [String=nil] The status message
-    # return:: [Jabber::Protocol::Presence] The newly created Presence object
-    #
-    def self.gen_chat(id, status=nil)
-      Presence.new(id, "chat", status)
-    end
-
-    ##
-    # Generate a presence object w/show="xa" (extended away)
-    #
-    # id:: [String] The message ID
-    # status:: [String=nil] The status message
-    # return:: [Jabber::Protocol::Presence] The newly created Presence object
-    #
-    def self.gen_xa(id, status=nil)
-      Presence.new(id, "xa", status)
-    end
-
-    ##
-    # Generate a presence object w/show="dnd" (do not disturb)
-    #
-    # id:: [String] The message ID
-    # status:: [String=nil] The status message
-    # return:: [Jabber::Protocol::Presence] The newly created Presence object
-    #
-    def self.gen_dnd(id, status=nil)
-      Presence.new(id, "dnd", status)
-    end
-
-    ##
-    # Generate a presence object w/show="away" (away from resource)
-    #
-    # id:: [String] The message ID
-    # status:: [String=nil] The status message
-    # return:: [Jabber::Protocol::Presence] The newly created Presence object
-    #
-    def self.gen_away(id, status=nil)
-      Presence.new(id, "away", status)
-    end
-
-    ##
-    # Generate a presence object w/show="unavailable" (not free for chat)
-    #
-    # id:: [String] The message ID
-    # status:: [String=nil] The status message
-    # return:: [Jabber::Protocol::Presence] The newly created Presence object
-    #
-    def self.gen_unavailable(id, status=nil)
-      p = Presence.new(id)
-      p.type="unavailable"
-      p
-    end
-
-    def self.gen_new_subscription(to)
-      p = Presence.new(Jabber.gen_random_id)
-      p.type = "subscribe"
-      p.to = to
-      p
-    end
-
-    def self.gen_accept_subscription(id, jid)
-      p = Presence.new(id)
-      p.type = "subscribed"
-      p.to = jid
-      p
-    end
-
-    def self.gen_accept_unsubscription(id, jid)
-      p = Presence.new(id)
-      p.type = "unsubscribed"
-      p.to = jid
-      p
-    end
-
-    ##
-    # Generates the xml representation of this Presence object
-    #
-    # return:: [String] The presence XML message to send the Jabber service
-    #
-    def to_xml
-      e = XMLElement.new("presence")
-      e.add_attribute("id", @id) if @id
-      e.add_attribute("from", @from) if @from
-      e.add_attribute("to", @to) if @to
-      e.add_attribute("type", @type) if @type
-      e.add_child("show").add_data(@show) if @show
-      e.add_child("status").add_data(@status) if @status
-      e.add_child("priority") if @priority
-      e.to_s
-    end
-
-    ##
-    # see _to_xml
-    #
-    def to_s
-      to_xml
-    end
-  end
-end
+# coding: utf-8
+
+# License: see LICENSE
+# Jabber4R - Jabber Instant Messaging Library for Ruby
+# Copyright (C) 2002  Rich Kilmer <rich@infoether.com>
+
+module Jabber::Protocol
+  ##
+  # The presence class is used to construct presence messages to
+  # send to the Jabber service.
+  #
+  class Presence
+    attr_accessor :to, :from, :id, :type
+
+    # The state to show (chat, xa, dnd, away)
+    attr_accessor :show
+
+    # The status message
+    attr_accessor :status
+    attr_accessor :priority
+
+    ##
+    # Constructs a Presence object w/the supplied id
+    #
+    # id:: [String] The message ID
+    # show:: [String] The state to show
+    # status:: [String] The status message
+    #
+    def initialize(id, show=nil, status=nil)
+      @id = id
+      @show = show if show
+      @status = status if status
+    end
+
+    ##
+    # Generate a presence object for initial presence notification
+    #
+    # id:: [String] The message ID
+    # show:: [String] The state to show
+    # status:: [String] The status message
+    # return:: [Jabber::Protocol::Presence] The newly created Presence object
+    #
+    def self.gen_initial(id, show=nil, status=nil)
+      Presence.new(id, show, status)
+    end
+
+    ##
+    # Generate a presence object w/show="normal" (normal availability)
+    #
+    # id:: [String] The message ID
+    # status:: [String=nil] The status message
+    # return:: [Jabber::Protocol::Presence] The newly created Presence object
+    #
+    def self.gen_normal(id, status=nil)
+      Presence.new(id, "normal", status)
+    end
+
+    ##
+    # Generate a presence object w/show="chat" (free for chat)
+    #
+    # id:: [String] The message ID
+    # status:: [String=nil] The status message
+    # return:: [Jabber::Protocol::Presence] The newly created Presence object
+    #
+    def self.gen_chat(id, status=nil)
+      Presence.new(id, "chat", status)
+    end
+
+    ##
+    # Generate a presence object w/show="xa" (extended away)
+    #
+    # id:: [String] The message ID
+    # status:: [String=nil] The status message
+    # return:: [Jabber::Protocol::Presence] The newly created Presence object
+    #
+    def self.gen_xa(id, status=nil)
+      Presence.new(id, "xa", status)
+    end
+
+    ##
+    # Generate a presence object w/show="dnd" (do not disturb)
+    #
+    # id:: [String] The message ID
+    # status:: [String=nil] The status message
+    # return:: [Jabber::Protocol::Presence] The newly created Presence object
+    #
+    def self.gen_dnd(id, status=nil)
+      Presence.new(id, "dnd", status)
+    end
+
+    ##
+    # Generate a presence object w/show="away" (away from resource)
+    #
+    # id:: [String] The message ID
+    # status:: [String=nil] The status message
+    # return:: [Jabber::Protocol::Presence] The newly created Presence object
+    #
+    def self.gen_away(id, status=nil)
+      Presence.new(id, "away", status)
+    end
+
+    ##
+    # Generate a presence object w/show="unavailable" (not free for chat)
+    #
+    # id:: [String] The message ID
+    # status:: [String=nil] The status message
+    # return:: [Jabber::Protocol::Presence] The newly created Presence object
+    #
+    def self.gen_unavailable(id, status=nil)
+      p = Presence.new(id)
+      p.type="unavailable"
+      p
+    end
+
+    def self.gen_new_subscription(to)
+      p = Presence.new(Jabber.gen_random_id)
+      p.type = "subscribe"
+      p.to = to
+      p
+    end
+
+    def self.gen_accept_subscription(id, jid)
+      p = Presence.new(id)
+      p.type = "subscribed"
+      p.to = jid
+      p
+    end
+
+    def self.gen_accept_unsubscription(id, jid)
+      p = Presence.new(id)
+      p.type = "unsubscribed"
+      p.to = jid
+      p
+    end
+
+    ##
+    # Generates the xml representation of this Presence object
+    #
+    # return:: [String] The presence XML message to send the Jabber service
+    #
+    def to_xml
+      e = XMLElement.new("presence")
+      e.add_attribute("id", @id) if @id
+      e.add_attribute("from", @from) if @from
+      e.add_attribute("to", @to) if @to
+      e.add_attribute("type", @type) if @type
+      e.add_child("show").add_data(@show) if @show
+      e.add_child("status").add_data(@status) if @status
+      e.add_child("priority") if @priority
+      e.to_s
+    end
+
+    ##
+    # see _to_xml
+    #
+    def to_s
+      to_xml
+    end
+  end
+end