xmpp4r 0.3.2 → 0.4

data/lib/xmpp4r/muc/helper/simplemucclient.rb

@@ -4,6 +4,7 @@
 
 require 'xmpp4r/delay/x/delay'
 require 'xmpp4r/muc/helper/mucclient'
+require 'xmpp4r/muc/iq/mucadminitem'
 
 module Jabber
   module MUC
@@ -101,7 +102,7 @@ module Jabber
           @subject = msg.subject
           @subject_block.call(time, sender_nick, @subject) if @subject_block
         end
-        
+
         if msg.body
           if sender_nick.nil?
             @room_message_block.call(time, msg.body) if @room_message_block
@@ -162,6 +163,111 @@ module Jabber
         send(msg)
       end
 
+      ##
+      # Administratively remove one or more users from the room.
+      #
+      # Will wait for response, possibly raising ServerError
+      #
+      # Sample usage:
+      #   my_muc.kick 'pistol', 'Avaunt, you cullion!'
+      #   my_muc.kick(['Bill', 'Linus'], 'Stop flaming')
+      #
+      # recipients:: [Array] of, or single [String]: Nicks
+      # reason:: [String] Kick reason
+      def kick(recipients, reason)
+        recipients = [recipients] unless recipients.kind_of? Array
+        items = recipients.collect { |recipient|
+          item = IqQueryMUCAdminItem.new
+          item.nick = recipient
+          item.role = :none
+          item.reason = reason
+          item
+        }
+        send_affiliations(items)
+      end
+
+      ##
+      # Administratively ban one or more user jids from the room.
+      #
+      # Will wait for response, possibly raising ServerError
+      #
+      # Sample usage:
+      #   my_muc.ban 'pistol@foobar.com', 'Avaunt, you cullion!'
+      #
+      # recipients:: [Array] of, or single [String]: JIDs
+      # reason:: [String] Ban reason
+      def ban(recipients, reason)
+        recipients = [recipients] unless recipients.kind_of? Array
+        items = recipients.collect { |recipient|
+          item = IqQueryMUCAdminItem.new
+          item.jid = recipient
+          item.affiliation = :outcast
+          item.reason = reason
+          item
+        }
+        send_affiliations(items)
+      end
+
+      ##
+      # Unban one or more user jids for the room.
+      #
+      # Will wait for response, possibly raising ServerError
+      #
+      # Sample usage:
+      #   my_muc.unban 'pistol@foobar.com'
+      #
+      # recipients:: [Array] of, or single [String]: JIDs
+      def unban(recipients)
+        recipients = [recipients] unless recipients.kind_of? Array
+        items = recipients.collect { |recipient|
+          item = IqQueryMUCAdminItem.new
+          item.jid = recipient
+          item.affiliation = :none
+          item
+        }
+        send_affiliations(items)
+      end
+
+      ##
+      # Promote one or more users in the room to moderator.
+      #
+      # Will wait for response, possibly raising ServerError
+      #
+      # Sample usage:
+      #   my_muc.promote 'pistol'
+      #
+      # recipients:: [Array] of, or single [String]: Nicks
+      def promote(recipients)
+        recipients = [recipients] unless recipients.kind_of? Array
+        items = recipients.collect { |recipient|
+          item = IqQueryMUCAdminItem.new
+          item.nick = recipient
+          item.role = :moderator
+          item
+        }
+        send_affiliations(items)
+      end
+
+      ##
+      # Demote one or more users in the room to participant.
+      #
+      # Will wait for response, possibly raising ServerError
+      #
+      # Sample usage:
+      #   my_muc.demote 'pistol'
+      #
+      # recipients:: [Array] of, or single [String]: Nicks
+      def demote(recipients)
+        recipients = [recipients] unless recipients.kind_of? Array
+        items = recipients.collect { |recipient|
+          item = IqQueryMUCAdminItem.new
+          item.nick = recipient
+          item.role = :participant
+          item
+        }
+        send_affiliations(items)
+      end
+
       ##
       # Block to be invoked when a message *from* the room arrives
       #

data/lib/xmpp4r/muc/iq/mucadmin.rb

@@ -0,0 +1,23 @@
+# =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/x'
+
+module Jabber
+  module MUC
+    class IqQueryMUCAdmin < IqQuery
+      name_xmlns 'query', 'http://jabber.org/protocol/muc#admin'
+
+      include XParent
+
+      def items
+        r = []
+        each_element('item') { |item|
+          r << item if item.kind_of? IqQueryMUCAdminItem
+        }
+        r
+      end
+    end
+  end
+end

data/lib/xmpp4r/muc/iq/mucadminitem.rb

@@ -0,0 +1,20 @@
+# =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 IqQueryMUCAdminItem < MUC::UserItem
+      name_xmlns 'item', 'http://jabber.org/protocol/muc#admin'
+
+      def initialize(affiliation=nil, role=nil, jid=nil)
+        super()
+        set_affiliation(affiliation)
+        set_role(role)
+        set_jid(jid)
+      end
+    end
+  end
+end

data/lib/xmpp4r/muc/iq/mucowner.rb

@@ -1,10 +1,14 @@
+# =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/x'
 
 module Jabber
   module MUC
     class IqQueryMUCOwner < IqQuery
       name_xmlns 'query', 'http://jabber.org/protocol/muc#owner'
-      
+
       include XParent
     end
   end

data/lib/xmpp4r/muc/item.rb

@@ -0,0 +1,143 @@
+# =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
+    ##
+    # Don't use this. It is the base class (unifying shared
+    # attributes) of XMUCUserItem and IqQueryMUCAdminItem
+    class UserItem < XMPPElement
+      def affiliation
+        case attributes['affiliation']
+          when 'admin' then :admin
+          when 'member' then :member
+          when 'none' then :none
+          when 'outcast' then :outcast
+          when 'owner' then :owner
+          else nil
+        end
+      end
+
+      def affiliation=(v)
+        case v
+          when :admin then attributes['affiliation'] = 'admin'
+          when :member then attributes['affiliation'] = 'member'
+          when :none then attributes['affiliation'] = 'none'
+          when :outcast then attributes['affiliation'] = 'outcast'
+          when :owner then attributes['affiliation'] = 'owner'
+          else attributes['affiliation'] = nil
+        end
+      end
+
+      def set_affiliation(v)
+        self.affiliation = v
+        self
+      end
+
+      def jid
+        attributes['jid'].nil? ? nil : JID.new(attributes['jid'])
+      end
+
+      def jid=(j)
+        attributes['jid'] = j.nil? ? nil : j.to_s
+      end
+
+      def set_jid(j)
+        self.jid = j
+        self
+      end
+
+      def nick
+        attributes['nick']
+      end
+
+      def nick=(n)
+        attributes['nick'] = n
+      end
+
+      def set_nick(n)
+        self.nick = n
+        self
+      end
+
+      def role
+        case attributes['role']
+          when 'moderator' then :moderator
+          when 'none' then :none
+          when 'participant' then :participant
+          when 'visitor' then :visitor
+          else nil
+        end
+      end
+
+      def role=(r)
+        case r
+          when :moderator then attributes['role'] = 'moderator'
+          when :none then attributes['role'] = 'none'
+          when :participant then attributes['role'] = 'participant'
+          when :visitor then attributes['role'] = 'visitor'
+          else attributes['role'] = nil
+        end
+      end
+
+      def set_role(r)
+        self.role = r
+        self
+      end
+
+      def reason
+        text = nil
+        each_element('reason') { |xe| text = xe.text }
+        text
+      end
+
+      def reason=(s)
+        delete_elements('reasion')
+        add_element('reason').text = s
+      end
+
+      def set_reason(s)
+        self.reason = s
+        self
+      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
+
+      def actors
+        a = []
+        each_element('actor') { |xe|
+          a.push(JID.new(xe.attributes['jid']))
+        }
+        a
+      end
+
+      def actors=(a)
+        delete_elements('actor')
+        a.each { |jid|
+          e = add_element('actor')
+          e.attributes['jid'] = jid.to_s
+        }
+      end
+
+      def set_actors(a)
+        self.actors = a
+        self
+      end
+    end
+  end
+end

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

@@ -14,7 +14,7 @@ module Jabber
       end
 
       def to
-        attributes['to'].nil? ? nil : JID::new(attributes['to'])
+        attributes['to'].nil? ? nil : JID.new(attributes['to'])
       end
 
       def to=(j)
@@ -27,7 +27,7 @@ module Jabber
       end
 
       def from
-        attributes['from'].nil? ? nil : JID::new(attributes['from'])
+        attributes['from'].nil? ? nil : JID.new(attributes['from'])
       end
 
       def from=(j)

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

@@ -2,9 +2,11 @@
 # 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 < XMPPElement
+    class XMUCUserItem < MUC::UserItem
       name_xmlns 'item', 'http://jabber.org/protocol/muc#user'
 
       def initialize(affiliation=nil, role=nil, jid=nil)
@@ -14,100 +16,6 @@ module Jabber
         set_jid(jid)
       end
 
-      def affiliation
-        case attributes['affiliation']
-          when 'admin' then :admin
-          when 'member' then :member
-          when 'none' then :none
-          when 'outcast' then :outcast
-          when 'owner' then :owner
-          else nil
-        end
-      end
-
-      def affiliation=(v)
-        case v
-          when :admin then attributes['affiliation'] = 'admin'
-          when :member then attributes['affiliation'] = 'member'
-          when :none then attributes['affiliation'] = 'none'
-          when :outcast then attributes['affiliation'] = 'outcast'
-          when :owner then attributes['affiliation'] = 'owner'
-          else attributes['affiliation'] = nil
-        end
-      end
-
-      def set_affiliation(v)
-        self.affiliation = v
-        self
-      end
-
-      def jid
-        attributes['jid'].nil? ? nil : JID::new(attributes['jid'])
-      end
-
-      def jid=(j)
-        attributes['jid'] = j.nil? ? nil : j.to_s
-      end
-
-      def set_jid(j)
-        self.jid = j
-        self
-      end
-
-      def nick
-        attributes['nick']
-      end
-
-      def nick=(n)
-        attributes['nick'] = n
-      end
-
-      def set_nick(n)
-        self.nick = n
-        self
-      end
-      
-      def role
-        case attributes['role']
-          when 'moderator' then :moderator
-          when 'none' then :none
-          when 'participant' then :participant
-          when 'visitor' then :visitor
-          else nil
-        end
-      end
-
-      def role=(r)
-        case r
-          when :moderator then attributes['role'] = 'moderator'
-          when :none then attributes['role'] = 'none'
-          when :participant then attributes['role'] = 'participant'
-          when :visitor then attributes['role'] = 'visitor'
-          else attributes['role'] = nil
-        end
-      end
-
-      def set_role(r)
-        self.role = r
-        self
-      end
-
-      def reason
-        text = nil
-        each_element('reason') { |xe| text = xe.text }
-        text
-      end
-
-      def reason=(s)
-        delete_elements('reasion')
-        add_element('reason').text = s
-      end
-
-      def set_reason(s)
-        self.reason = s
-        self
-      end
-
       def continue
         c = nil
         each_element('continue') { |xe| c = xe }
@@ -123,28 +31,6 @@ module Jabber
         self.continue = c
         self
       end
-
-      def actors
-        a = []
-        each_element('actor') { |xe|
-          a.push(JID::new(xe.attributes['jid']))
-        }
-        a
-      end
-
-      def actors=(a)
-        delete_elements('actor')
-        a.each { |jid|
-          e = add_element('actor')
-          e.attributes['jid'] = jid.to_s
-        }
-      end
-
-      def set_actors(a)
-        self.actors = a
-        self
-      end
     end
   end
 end
-