gmcmillan-xmpp4r 0.5

data/lib/xmpp4r/muc/x/muc.rb

@@ -0,0 +1,70 @@
+# =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/muc/x/mucuseritem'
+require 'xmpp4r/muc/x/mucuserinvite'
+
+module Jabber
+  module MUC
+    ##
+    # Class for <x/> elements
+    # with namespace http://jabber.org/protocol/muc
+    #
+    # See JEP-0045 for details
+    class XMUC < X
+      name_xmlns 'x', 'http://jabber.org/protocol/muc'
+
+      ##
+      # Text content of the <tt><password/></tt> element
+      def password
+        first_element_text('password')
+      end
+
+      ##
+      # Set the password for joining a room
+      # (text content of the <tt><password/></tt> element)
+      def password=(s)
+        if s
+          replace_element_text('password', s)
+        else
+          delete_elements('password')
+        end
+      end
+    end
+
+    ##
+    # Class for <x/> elements
+    # with namespace http://jabber.org/protocol/muc#user
+    #
+    # See JEP-0058 for details
+    class XMUCUser < X
+      name_xmlns 'x', 'http://jabber.org/protocol/muc#user'
+
+      ##
+      # Retrieve the three-digit code in
+      # <tt><x xmlns='http://jabber.org/protocol/muc#user'><status code='...'/></x></tt>
+      # result:: [Fixnum] or nil
+      def status_code
+        e = nil
+        each_element('status') { |xe| e = xe }
+        if e and e.attributes['code'].size == 3 and e.attributes['code'].to_i != 0
+          e.attributes['code'].to_i
+        else
+          nil
+        end
+      end
+
+      ##
+      # Get all <item/> elements
+      # result:: [Array] of [XMUCUserItem]
+      def items
+        res = []
+        each_element('item') { |item|
+          res << item
+        }
+        res
+      end
+    end
+  end
+end

data/lib/xmpp4r/muc/x/mucuserinvite.rb

@@ -0,0 +1,60 @@
+# =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
+  module MUC
+    class XMUCUserInvite < XMPPElement
+      name_xmlns 'invite', 'http://jabber.org/protocol/muc#user'
+
+      def initialize(to=nil, reason=nil)
+        super()
+        set_to(to)
+        set_reason(reason)
+      end
+
+      def to
+        attributes['to'].nil? ? nil : JID.new(attributes['to'])
+      end
+
+      def to=(j)
+        attributes['to'] = j.nil? ? nil : j.to_s
+      end
+
+      def set_to(j)
+        self.to = j
+        self
+      end
+
+      def from
+        attributes['from'].nil? ? nil : JID.new(attributes['from'])
+      end
+
+      def from=(j)
+        attributes['from'] = (j.nil? ? nil : j.to_s)
+      end
+
+      def set_from(j)
+        self.from = j
+        self
+      end
+
+      def reason
+        first_element_text('reason')
+      end
+
+      def reason=(s)
+        if s
+          replace_element_text('reason', s)
+        else
+          delete_elements('reason')
+        end
+      end
+
+      def set_reason(s)
+        self.reason = s
+        self
+      end
+    end
+  end
+end

data/lib/xmpp4r/muc/x/mucuseritem.rb

@@ -0,0 +1,36 @@
+# =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/muc/item'
+
+module Jabber
+  module MUC
+    class XMUCUserItem < MUC::UserItem
+      name_xmlns 'item', 'http://jabber.org/protocol/muc#user'
+
+      def initialize(affiliation=nil, role=nil, jid=nil)
+        super()
+        set_affiliation(affiliation)
+        set_role(role)
+        set_jid(jid)
+      end
+
+      def continue
+        c = nil
+        each_element('continue') { |xe| c = xe }
+        c.nil?
+      end
+
+      def continue=(c)
+        delete_elements('continue')
+        add_element('continue') if c
+      end
+
+      def set_continue(c)
+        self.continue = c
+        self
+      end
+    end
+  end
+end

data/lib/xmpp4r/presence.rb

@@ -0,0 +1,232 @@
+# =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 presence class is used to construct presence messages to
+  # send to the Jabber service.
+  class Presence < XMPPStanza
+    name_xmlns 'presence', 'jabber:client'
+    force_xmlns true
+
+    include Comparable
+    include XParent
+
+    ##
+    # Create presence stanza
+    # show:: [Symbol] Initial Availability Status (see show)
+    # status:: [String] Initial status message
+    # priority:: [Fixnum] Initial priority value
+    def initialize(show=nil, status=nil, priority=nil)
+      super()
+      set_show(show) if show
+      set_status(status) if status
+      set_priority(priority) if priority
+    end
+
+    ##
+    # Get type of presence
+    #
+    # result:: [Symbol] or [Nil] Possible values are:
+    # * :error
+    # * :probe (Servers send this to request presence information)
+    # * :subscribe (Subscription request)
+    # * :subscribed (Subscription approval)
+    # * :unavailable (User has gone offline)
+    # * :unsubscribe (Unsubscription request)
+    # * :unsubscribed (Unsubscription approval)
+    # * [nil] (available)
+    # See RFC3921 - 2.2.1. for explanation.
+    def type
+      case super
+        when 'error' then :error
+        when 'probe' then :probe
+        when 'subscribe' then :subscribe
+        when 'subscribed' then :subscribed
+        when 'unavailable' then :unavailable
+        when 'unsubscribe' then :unsubscribe
+        when 'unsubscribed' then :unsubscribed
+        else nil
+      end
+    end
+
+    ##
+    # Set type of presence
+    # val:: [Symbol] See type for possible subscription types
+    def type=(val)
+      case val
+        when :error then super('error')
+        when :probe then super('probe')
+        when :subscribe then super('subscribe')
+        when :subscribed then super('subscribed')
+        when :unavailable then super('unavailable')
+        when :unsubscribe then super('unsubscribe')
+        when :unsubscribed then super('unsubscribed')
+        else super(nil)
+      end
+    end
+
+    ##
+    # Set type of presence (chaining-friendly)
+    # val:: [Symbol] See type for possible subscription types
+    def set_type(val)
+      self.type = val
+      self
+    end
+
+    ##
+    # Get Availability Status (RFC3921 - 5.2)
+    # result:: [Symbol] or [Nil] Valid values according to RFC3921:
+    # * nil (Available, no <show/> element)
+    # * :away
+    # * :chat (Free for chat)
+    # * :dnd (Do not disturb)
+    # * :xa (Extended away)
+    def show
+      e = first_element('show')
+      text = e ? e.text : nil
+      case text
+        when 'away' then :away
+        when 'chat' then :chat
+        when 'dnd' then :dnd
+        when 'xa' then :xa
+        else nil
+      end
+    end
+
+    ##
+    # Set Availability Status
+    # val:: [Symbol] or [Nil] See show for explanation
+    def show=(val)
+      xe = first_element('show')
+      if xe.nil?
+        xe = add_element('show')
+      end
+      case val
+        when String then raise "Invalid value for show."
+        when :away then text = 'away'
+        when :chat then text = 'chat'
+        when :dnd then text = 'dnd'
+        when :xa then text = 'xa'
+        when nil then text = nil
+        else raise "Invalid value for show."
+      end
+
+      if text.nil?
+        delete_element(xe)
+      else
+        xe.text = text
+      end
+    end
+
+    ##
+    # Set Availability Status (chaining-friendly)
+    # val:: [Symbol] or [Nil] See show for explanation
+    def set_show(val)
+      self.show = val
+      self
+    end
+
+    ##
+    # Get status message
+    # result:: [String] or nil
+    def status
+      first_element_text('status')
+    end
+
+    ##
+    # Set status message
+    # val:: [String] or nil
+    def status=(val)
+      if val.nil?
+        delete_element('status')
+      else
+        replace_element_text('status', val)
+      end
+    end
+
+    ##
+    # Set status message (chaining-friendly)
+    # val:: [String] or nil
+    def set_status(val)
+      self.status = val
+      self
+    end
+
+    ##
+    # Get presence priority, or nil if absent
+    # result:: [Integer]
+    def priority
+       e = first_element_text('priority')
+      if e
+        return e.to_i
+      else
+        return nil
+      end
+    end
+
+    ##
+    # Set presence priority
+    # val:: [Integer] Priority value between -128 and +127
+    #
+    # *Warning:* negative values make you receive no subscription requests etc.
+    # (RFC3921 - 2.2.2.3.)
+    def priority=(val)
+      if val.nil?
+        delete_element('priority')
+      else
+        replace_element_text('priority', val)
+      end
+    end
+
+    ##
+    # Set presence priority (chaining-friendly)
+    # val:: [Integer] Priority value between -128 and +127
+    def set_priority(val)
+      self.priority = val
+      self
+    end
+
+    ##
+    # Compare two presences using priority
+    # (with cmp_interest as fall-back).
+    def <=>(o)
+      if priority.to_i == o.priority.to_i
+        cmp_interest(o)
+      else
+        priority.to_i <=> o.priority.to_i
+      end
+    end
+
+    ##
+    # Compare two presences. The most suitable to talk with is the
+    # biggest.
+    PRESENCE_STATUS = { :chat => 4,
+                        nil => 3,
+                        :dnd => 2,
+                        :away => 1,
+                        :xa => 0,
+                        :unavailable => -1,
+                        :error => -2 }
+    def cmp_interest(o)
+      if type.nil?
+        if o.type.nil?
+          # both available.
+          PRESENCE_STATUS[show] <=> PRESENCE_STATUS[o.show]
+        else
+          return -1
+        end
+      elsif o.type.nil?
+        return 1
+      else
+        # both are non-nil. We consider this is equal.
+        return 0
+      end
+    end
+
+  end
+end

data/lib/xmpp4r/pubsub.rb

@@ -0,0 +1,8 @@
+require 'xmpp4r/pubsub/iq/pubsub'
+require 'xmpp4r/pubsub/children/event'
+require 'xmpp4r/pubsub/children/item'
+require 'xmpp4r/pubsub/children/items'
+require 'xmpp4r/pubsub/children/publish'
+require 'xmpp4r/pubsub/children/subscription'
+require 'xmpp4r/pubsub/children/unsubscribe'
+require 'xmpp4r/pubsub/helper/servicehelper'

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

@@ -0,0 +1,86 @@
+# =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/iq/pubsub'
+
+module Jabber
+  module PubSub
+
+    class Configuration < XMPPElement
+      ##
+      # get the underlying XData form element
+      def form
+        children.each do |c|
+          return c if c.kind_of?(Jabber::Dataforms::XData)
+        end
+
+        nil
+      end
+
+      def form=(form)
+        children.each do |c|
+          delete_element(c)
+          if c.kind_of?(Jabber::Dataforms::XData)
+            delete(c)
+          end
+        end
+        add(form)
+      end
+
+      # Implemented by NodeConfig and SubscriptionConfig
+      def form_type
+        ''
+      end
+
+      def options=(options)
+        if options
+          self.form = form_for_options( form_type, options )
+        end
+      end
+
+      ##
+      # get a list of the configured options represented by this stanza
+      # return:: [Hash] the options and their values
+      def options
+        configured_options = {}
+
+        if !form.nil?
+          form.fields.each do |f|
+            f.values.size == 1 ? configured_options[f.var] = f.values.first : configured_options[f.var] = f.values
+          end
+        end
+
+        configured_options
+      end
+
+      def node=(node)
+        attributes['node'] = node
+      end
+
+      def node
+        attributes['node']
+      end
+
+      private
+
+      ##
+      # creates a Dataform for configuration
+      # config:: [Hash] the desired configuration options
+      def form_for_options(type, options)
+        form = Jabber::Dataforms::XData.new(:submit)
+        pubsub_config = Jabber::Dataforms::XDataField.new('FORM_TYPE', :hidden)
+        pubsub_config.values = [type]
+        form.add(pubsub_config)
+        options.each_pair do |key, value|
+          f = Jabber::Dataforms::XDataField.new(key)
+          f.values = value.is_a?(Array) ? value : [value]
+          form.add(f)
+        end
+
+        form
+      end
+    end
+  end
+end