gmcmillan-xmpp4r 0.5

data/lib/xmpp4r/location.rb

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

data/lib/xmpp4r/location/helper/helper.rb

@@ -0,0 +1,56 @@
+# =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/pubsub'
+require 'xmpp4r/location/location'
+
+module Jabber
+  module UserLocation
+    ##
+    # A Helper for XEP-0080 User Location
+    #
+    # Use this helper to send a user's location, or receive them from a
+    # specified jid. Described at http://www.xmpp.org/extensions/xep-0080.html
+    #
+    # For example:
+    # <pre>
+    # h = UserLocation::Helper( @client, 'radio1@hug.hellomatty.com' )
+    # h.add_userlocation_callback do |location|
+    #   puts "Now in: #{location.locality}"
+    # end
+    # </pre>
+    class Helper < PubSub::ServiceHelper
+      ##
+      # Send out the current location.
+      #
+      # location:: [Jabber::UserLocation::Location] current_location
+      def current_location(location)
+        item = Jabber::PubSub::Item.new()
+        item.add(location)
+
+        publish_item_to(NS_USERLOCATION, item)
+      end
+
+      ##
+      # Use this method to indicate that you wish to stop publishing
+      # a location.
+      def stop_publishing
+        current_location(Jabber::UserLocation::Location.new())
+      end
+
+      ##
+      # Add a callback that will be invoked when a location is received
+      # from the jid specified when you constructed the Helper.
+      def add_userlocation_callback(prio = 200, ref = nil, &block)
+        add_event_callback(prio, ref) do |event|
+          location = event.first_element('items/item/location')
+          if location
+            block.call(location)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/xmpp4r/location/location.rb

@@ -0,0 +1,179 @@
+# =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 'time'
+require 'xmpp4r/xmppelement'
+require 'rexml/element'
+
+module Jabber
+  module UserLocation
+    NS_USERLOCATION = 'http://jabber.org/protocol/geoloc'
+    ALLOWABLE_ATTRIBUTES = %w(accuracy alt area bearing building country
+      datum description floor lat locality lon postalcode region room
+      speed street text timestamp uri)
+
+    ##
+    # The <geoloc> XMPP element, as defined in XEP-0080 User Location
+    #
+    # See http://xmpp.org/extensions/xep-0080.html - this element
+    # encapsulates data about a user's current location. These are
+    # expressed as child elements such as <locality>, <lat>, etc.
+    # which are also managed by this class.
+    #
+    # If the element has no children then it indicates that the user
+    # has stopped publishing their location.
+    class Location < XMPPElement
+      name_xmlns 'geoloc', NS_USERLOCATION
+      force_xmlns true
+
+      ##
+      # Construct a new <location> element.
+      #
+      # Supply no arguments to make an empty element to indicate that
+      # location is no longer being published.
+      #
+      # attributes:: [Hash] location attributes
+      def initialize(attributes = {})
+        super()
+
+        # validate attributes
+        attributes = attributes.select do |k,v|
+          ALLOWABLE_ATTRIBUTES.include?(k) && !v.nil?
+        end
+
+        attributes.each do |k,v|
+          v = x.xmlschema if v.is_a?(Time)
+          add_element(REXML::Element.new(k)).text = v.to_s
+        end
+      end
+
+
+      ##
+      # Returns true if a location is currently being published, otherwise false.
+      def published?
+        (elements.size > 0)
+      end
+
+      ##
+      # Get the accuracy attribute of this location.
+      def accuracy
+        first_element('accuracy').text if first_element('accuracy')
+      end
+
+      ##
+      # Get the alt attribute of this location.
+      def alt
+        first_element('alt').text if first_element('alt')
+      end
+
+      ##
+      # Get the area attribute of this location.
+      def area
+        first_element('area').text if first_element('area')
+      end
+
+      ##
+      # Get the bearing attribute of this location.
+      def bearing
+        first_element('bearing').text if first_element('bearing')
+      end
+
+      ##
+      # Get the building attribute of this location.
+      def building
+        first_element('building').text if first_element('building')
+      end
+
+      ##
+      # Get the country attribute of this location.
+      def country
+        first_element('country').text if first_element('country')
+      end
+
+      ##
+      # Get the datum attribute of this location.
+      def datum
+        first_element('datum').text if first_element('datum')
+      end
+
+      ##
+      # Get the description attribute of this location.
+      def description
+        first_element('description').text if first_element('description')
+      end
+
+      ##
+      # Get the floor attribute of this location.
+      def floor
+        first_element('floor').text if first_element('floor')
+      end
+
+      ##
+      # Get the lat attribute of this location.
+      def lat
+        first_element('lat').text if first_element('lat')
+      end
+
+      ##
+      # Get the locality attribute of this location.
+      def locality
+        first_element('locality').text if first_element('locality')
+      end
+
+      ##
+      # Get the lon attribute of this location.
+      def lon
+        first_element('lon').text if first_element('lon')
+      end
+
+      ##
+      # Get the postalcode attribute of this location.
+      def postalcode
+        first_element('postalcode').text if first_element('postalcode')
+      end
+
+      ##
+      # Get the region attribute of this location.
+      def region
+        first_element('region').text if first_element('region')
+      end
+
+      ##
+      # Get the room attribute of this location.
+      def room
+        first_element('room').text if first_element('room')
+      end
+
+      ##
+      # Get the speed attribute of this location.
+      def speed
+        first_element('speed').text if first_element('speed')
+      end
+
+      ##
+      # Get the street attribute of this location.
+      def street
+        first_element('street').text if first_element('street')
+      end
+
+      ##
+      # Get the text attribute of this location.
+      def text
+        first_element('text').text if first_element('text')
+      end
+
+      ##
+      # Get the timestamp attribute of this location.
+      def timestamp
+        first_element('timestamp').text if first_element('timestamp')
+      end
+
+      ##
+      # Get the uri attribute of this location.
+      def uri
+        first_element('uri').text if first_element('uri')
+      end
+    end
+  end
+end

data/lib/xmpp4r/message.rb

@@ -0,0 +1,226 @@
+# =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
+
+    ##
+    # Returns the message's xhtml body, or nil.
+    # This is the message's xhtml-text content.
+    def xhtml_body
+      html = first_element('html', 'http://jabber.org/protocol/xhtml-im')
+
+      if html
+        html.first_element_content('body', 'http://www.w3.org/1999/xhtml')
+      else
+        first_element_content('body', 'http://www.w3.org/1999/xhtml')
+      end
+    end
+
+    ##
+    # Sets the message's xhtml body
+    #
+    # b:: [String] xhtml body to set (Note: must be a valid xhtml)
+    def xhtml_body=(b)
+      begin
+        b = REXML::Document.new("<root>#{b}</root>")
+      rescue REXML::ParseException
+        raise ArgumentError, "Body is not a valid xhtml. Have you forgot to close some tag?"
+      end
+      
+      html = first_element('html', 'http://jabber.org/protocol/xhtml-im')
+      
+      if html
+        html.replace_element_content('body', b, 'http://www.w3.org/1999/xhtml')
+      else
+        el = REXML::Element.new('html')
+        el.add_namespace('http://jabber.org/protocol/xhtml-im')
+        el.replace_element_content('body', b, 'http://www.w3.org/1999/xhtml')
+        add_element(el)
+      end
+    end
+
+    ##
+    # Sets the message's xhtml body
+    #
+    # b:: [String] xhtml body to set (Note: must be a valid xhtml)
+    # return:: [REXML::Element] self for chaining
+    def set_xhtml_body(b)
+      self.xhtml_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