brontes3d-xmpp4r 0.4

data/lib/xmpp4r/jid.rb

@@ -0,0 +1,167 @@
+# =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/
+
+module Jabber
+  ##
+  # The JID class represents a Jabber Identifier as described by
+  # RFC3920 section 3.1.
+  #
+  # Note that you can use JIDs also for Sorting, Hash keys, ...
+  class JID
+    include Comparable
+
+    PATTERN = /^(?:([^@]*)@)??([^@\/]*)(?:\/(.*?))?$/
+
+    begin
+      require 'idn'
+      USE_STRINGPREP = true
+    rescue LoadError
+      USE_STRINGPREP = false
+    end
+
+    ##
+    # Create a new JID. If called as new('a@b/c'), parse the string and
+    # split (node, domain, resource)
+    def initialize(node = "", domain = nil, resource = nil)
+      @resource = resource
+      @domain = domain
+      @node = node
+      if @domain.nil? and @resource.nil? and @node
+        @node, @domain, @resource = @node.to_s.scan(PATTERN).first
+      end
+
+      if USE_STRINGPREP
+        @node = IDN::Stringprep.nodeprep(@node) if @node
+        @domain = IDN::Stringprep.nameprep(@domain) if @domain
+        @resource = IDN::Stringprep.resourceprep(@resource) if @resource
+      else
+        @node.downcase! if @node
+        @domain.downcase! if @domain
+      end
+
+      raise ArgumentError, 'Node too long' if (@node || '').length > 1023
+      raise ArgumentError, 'Domain too long' if (@domain || '').length > 1023
+      raise ArgumentError, 'Resource too long' if (@resource || '').length > 1023
+    end
+
+    ##
+    # Returns a string representation of the JID
+    # * ""
+    # * "domain"
+    # * "node@domain"
+    # * "domain/resource"
+    # * "node@domain/resource"
+    def to_s
+      s = @domain
+      s = "#{@node}@#{s}" if @node
+      s += "/#{@resource}" if @resource
+      return s
+    end
+
+    ##
+    # Returns a new JID with resource removed.
+    # return:: [JID]
+    def strip
+      JID.new(@node, @domain)
+    end
+    alias_method :bare, :strip
+
+    ##
+    # Removes the resource (sets it to nil)
+    # return:: [JID] self
+    def strip!
+      @resource = nil
+      self
+    end
+    alias_method :bare!, :strip!
+
+    ##
+    # Returns a hash value of the String representation
+    # (see JID#to_s)
+    def hash
+      return to_s.hash
+    end
+
+    ##
+    # Ccompare to another JID
+    #
+    # String representations are compared, see JID#to_s
+    def eql?(o)
+      to_s.eql?(o.to_s)
+    end
+
+    ##
+    # Ccompare to another JID
+    #
+    # String representations are compared, see JID#to_s
+    def ==(o)
+      to_s == o.to_s
+    end
+
+    ##
+    # Compare two JIDs,
+    # helpful for sorting etc.
+    #
+    # String representations are compared, see JID#to_s
+    def <=>(o)
+      to_s <=> o.to_s
+    end
+
+    # Get the JID's node
+    def node
+      @node
+    end
+
+    # Set the JID's node
+    def node=(v)
+      @node = v.to_s
+      if USE_STRINGPREP
+        @node = IDN::Stringprep.nodeprep(@node) if @node
+      end
+    end
+
+    # Get the JID's domain
+    def domain
+      return nil if @domain.empty?
+      @domain
+    end
+
+    # Set the JID's domain
+    def domain=(v)
+      @domain = v.to_s
+      if USE_STRINGPREP
+        @domain = IDN::Stringprep.nodeprep(@domain)
+      end
+    end
+
+    # Get the JID's resource
+    def resource
+      @resource
+    end
+
+    # Set the JID's resource
+    def resource=(v)
+      @resource = v.to_s
+      if USE_STRINGPREP
+        @resource = IDN::Stringprep.nodeprep(@resource)
+      end
+    end
+
+    # Escape JID
+    def JID::escape(jid)
+      return jid.to_s.gsub('@', '%')
+    end
+
+    # Test if jid is empty
+    def empty?
+      to_s.empty?
+    end
+
+    # Test id jid is strepped
+    def stripped?
+      @resource.nil?
+    end
+    alias_method :bared?, :stripped?
+  end
+end

data/lib/xmpp4r/last.rb

@@ -0,0 +1,2 @@
+require 'xmpp4r/last/iq/last'
+require 'xmpp4r/last/helper/helper'

data/lib/xmpp4r/last/helper/helper.rb

@@ -0,0 +1,37 @@
+# =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'
+require 'xmpp4r/last'
+
+module Jabber
+  module LastActivity
+    ##
+    # A Helper to manage discovery of Last Activity.
+    class Helper
+      def initialize(client)
+        @stream = client
+      end
+
+      ##
+      # Gets the last activity from a JID.
+      # jid:: [JID]
+      # return:: [Jabber::LastActivity::IqQueryLastActivity]
+      def get_last_activity_from(jid)
+        iq = Jabber::Iq.new(:get, jid)
+        iq.from = @stream.jid
+        iq.add(Jabber::LastActivity::IqQueryLastActivity.new)
+
+        reply = @stream.send_with_id(iq)
+
+        if reply.query && reply.query.kind_of?(IqQueryLastActivity)
+          reply.query
+        else
+          nil
+        end
+      end
+
+    end
+  end
+end

data/lib/xmpp4r/last/iq/last.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/query'
+
+module Jabber
+  module LastActivity
+    NS_LAST_ACTIVITY = 'jabber:iq:last'
+
+    ##
+    # Class for handling Last Activity queries
+    # (XEP-0012)
+    class IqQueryLastActivity < IqQuery
+      name_xmlns 'query', NS_LAST_ACTIVITY
+
+      ##
+      # Get the number of seconds since last activity.
+      #
+      # With a bare jid, this will return the number of seconds since the
+      # client was last seen (offline user query).
+      #
+      # With a full jid, this will return the number of seconds that the
+      # client has been idle (online user query).
+      #
+      # With a server, this will return the server or component's uptime in
+      # seconds (server / component query).
+      def seconds
+        attributes['seconds'] ? attributes['seconds'].to_i : nil
+      end
+
+      ##
+      # Set the number of seconds since last activity
+      def seconds=(val)
+        attributes['seconds'] = val.to_s
+      end
+
+      ##
+      # Set the number of seconds since last activity
+      # (chaining-friendly)
+      def set_second(val)
+        self.seconds = val
+        self
+      end
+
+      ##
+      # For an offline user query, get the last status.
+      def status
+        self.text
+      end
+
+      ##
+      # For an offline user query, set the last status.
+      def status=(val)
+        self.text = val
+      end
+
+      ##
+      # For an offline user query, set the last status.
+      # (chaining-friendly)
+      def set_status(val)
+        self.status = val
+        self
+      end
+    end
+  end
+end

data/lib/xmpp4r/message.rb

@@ -0,0 +1,180 @@
+# =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/xmppstanza'
+require 'xmpp4r/x'
+
+module Jabber
+  ##
+  # The Message class manages the <message/> stanzas,
+  # 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
+
+    include XParent
+
+    ##
+    # Create a new message
+    # >to:: a JID or a String object to send the message to.
+    # >body:: the message's body
+    def initialize(to = nil, body = nil)
+      super()
+      if not to.nil?
+        set_to(to)
+      end
+      if !body.nil?
+        add_element(REXML::Element.new("body").add_text(body))
+      end
+    end
+
+    ##
+    # Get the type of the Message stanza
+    #
+    # The following Symbols are allowed:
+    # * :chat
+    # * :error
+    # * :groupchat
+    # * :headline
+    # * :normal
+    # result:: [Symbol] or nil
+    def type
+      case super
+        when 'chat' then :chat
+        when 'error' then :error
+        when 'groupchat' then :groupchat
+        when 'headline' then :headline
+        when 'normal' then :normal
+        else nil
+      end
+    end
+
+    ##
+    # Set the type of the Message stanza (see Message#type for details)
+    # v:: [Symbol] or nil
+    def type=(v)
+      case v
+        when :chat then super('chat')
+        when :error then super('error')
+        when :groupchat then super('groupchat')
+        when :headline then super('headline')
+        when :normal then super('normal')
+        else super(nil)
+      end
+    end
+
+    ##
+    # Set the type of the Message stanza (chaining-friendly)
+    # v:: [Symbol] or nil
+    def set_type(v)
+      self.type = v
+      self
+    end
+
+    ##
+    # Returns the message's body, or nil.
+    # This is the message's plain-text content.
+    def body
+      first_element_text('body')
+    end
+
+    ##
+    # Sets the message's body
+    #
+    # b:: [String] body to set
+    def body=(b)
+      replace_element_text('body', b)
+    end
+
+    ##
+    # Sets the message's body
+    #
+    # b:: [String] body to set
+    # return:: [REXML::Element] self for chaining
+    def set_body(b)
+      self.body = b
+      self
+    end
+
+    ##
+    # sets the message's subject
+    #
+    # s:: [String] subject to set
+    def subject=(s)
+      replace_element_text('subject', s)
+    end
+
+    ##
+    # sets the message's subject
+    #
+    # s:: [String] subject to set
+    # return:: [REXML::Element] self for chaining
+    def set_subject(s)
+      self.subject = s
+      self
+    end
+
+    ##
+    # Returns the message's subject, or nil
+    def subject
+      first_element_text('subject')
+    end
+
+    ##
+    # sets the message's thread
+    # s:: [String] thread to set
+    def thread=(s)
+      delete_elements('thread')
+      replace_element_text('thread', s) unless s.nil?
+    end
+
+    ##
+    # gets the message's thread (chaining-friendly)
+    # Please note that this are not [Thread] but a [String]-Identifier to track conversations
+    # s:: [String] thread to set
+    def set_thread(s)
+      self.thread = s
+      self
+    end
+
+    ##
+    # Returns the message's thread, or nil
+    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