xmpp4r 0.3.2 → 0.4

data/lib/xmpp4r/framework/bot.rb

@@ -0,0 +1,148 @@
+require 'xmpp4r/framework/base'
+
+require 'xmpp4r'
+require 'xmpp4r/roster'
+require 'xmpp4r/caps/c'
+require 'xmpp4r/discovery'
+require 'xmpp4r/xhtml'
+
+module Jabber
+  module Framework
+    ##
+    # Abstract handler methods that *may* be implemented by a deriving class:
+    # * on_message(text)
+    # * on_message_xhtml(html_body, text)
+    class Bot < Base
+      helper :roster, Roster::Helper
+      helper(:disco_default) { |cl|
+        Discovery::Responder.new(cl,
+                                 nil,
+                                 [Jabber::Discovery::Identity.new('client', 'XMPP4R Bot', 'bot')]
+                                 )
+      }
+      helper(:disco_caps) { |cl|
+        Discovery::Responder.new(cl,
+                                 "http://home.gna.org/xmpp4r/#{Jabber::XMPP4R_VERSION}",
+                                 [Jabber::Discovery::Identity.new('client', 'XMPP4R Bot', 'bot')]
+                                 )
+      }
+
+      def initialize(jid, password)
+        cl = Jabber::Client.new(jid)
+        cl.connect
+        cl.auth(password)
+
+        super(cl)
+
+        roster.add_subscription_request_callback do |item,presence|
+          if accept_subscription_from?(presence.from.strip)
+            roster.accept_subscription(presence.from.strip)
+          else
+            roster.decline_subscription(presence.from.strip)
+          end
+        end
+
+        @pep_notifications = []
+        cl.add_message_callback do |msg|
+          if msg.type != :error and msg.body
+            if (html = msg.first_element('html')) and respond_to? :on_message_xhtml
+              on_message_xhtml(html.body, msg.body)
+            elsif respond_to? :on_message
+              on_message(msg.body)
+            end
+          elsif msg.type != :error and (event = msg.first_element('event'))
+            event.each_element('items') do |items|
+              node = items.attributes['node']
+              items.each_element('item') do |item|
+                @pep_notifications.each { |notification_node,callback|
+                  if node == notification_node
+                    callback.call(msg.from, item)
+                  end
+                }
+              end
+            end
+          else
+            false
+          end
+        end
+
+        add_cap('presence')
+        add_cap(Caps::NS_CAPS)
+        add_cap('message') if respond_to? :on_message
+        add_cap(XHTML::NS_XHTML_IM) if respond_to? :on_message_xhtml
+
+        @presence_show = nil
+        @presence_status = nil
+      end
+
+      ##
+      # Add feature namespace to Capabilities Discovery
+      def add_cap(capability)
+        disco_default.add_feature(capability)
+        disco_caps.add_feature(capability)
+      end
+
+      ##
+      # Front-end for Roster::Helper#add_subscription_request_callback
+      #
+      # Can be overwritten, must return true or false
+      def accept_subscription_from?(jid)
+        true
+      end
+
+      ##
+      # Send a simple text chat message
+      def send_message(to, text)
+        msg = Message.new
+        msg.type = :chat
+        msg.to = to
+        msg.body = text
+        @stream.send(msg)
+      end
+
+      ##
+      # Send an XHTML chat message
+      # text:: [String] alternate plain text body, generated from xhtml_contents if nil
+      def send_message_xhtml(to, xhtml_contents, text=nil)
+        msg = Message.new
+        msg.type = :chat
+        msg.to = to
+        html = msg.add(XHTML::HTML.new(xhtml_contents))
+        msg.body = text ? text : html.to_text
+        @stream.send(msg)
+      end
+
+      ##
+      # Set and send a Presence
+      def set_presence(show=nil, status=nil)
+        @presence_show = show
+        @presence_status = status
+        send_presence
+      end
+
+      private
+
+      def send_presence
+        roster.wait_for_roster
+
+        # TODO: vcard photo hash
+        if @presence_show == :unavailable
+          presence = Presence.new(nil, @presence_status)
+          presence.type = :unavailable
+        else
+          presence = Presence.new(@presence_show, @presence_status)
+        end
+        presence.add(disco_caps.generate_caps)
+        @stream.send(presence)
+      end
+
+      public
+
+      def add_pep_notification(node, &callback)
+        add_cap("#{node}+notify")
+        @pep_notifications << [node, callback]
+      end
+    end
+
+  end
+end

data/lib/xmpp4r/httpbinding/client.rb

@@ -231,7 +231,7 @@ module Jabber
               close; @exception_block.call(e, self, :parser)
             end
           else
-            puts "Exception caught when parsing HTTP response!"
+            Jabber::debuglog "Exception caught when parsing HTTP response!"
             close
             raise
           end

data/lib/xmpp4r/idgenerator.rb

@@ -30,7 +30,7 @@ module Jabber
     def generate_id
       @last_id += 1
       timefrac = Time.new.to_f.to_s.split(/\./, 2).last[-3..-1]
-      
+
       "#{@last_id}#{timefrac}"
     end
   end

data/lib/xmpp4r/iq.rb

@@ -79,7 +79,7 @@ module Jabber
     ##
     # Returns the iq's query child, or nil
     # result:: [IqQuery]
-    def query 
+    def query
       first_element('query')
     end
 
@@ -129,8 +129,8 @@ module Jabber
     # Create a new Iq stanza with an unspecified query child
     # (<query/> has no namespace)
     def Iq.new_query(type = nil, to = nil)
-      iq = Iq::new(type, to)
-      query = IqQuery::new
+      iq = Iq.new(type, to)
+      query = IqQuery.new
       iq.add(query)
       iq
     end
@@ -138,12 +138,12 @@ module Jabber
     ##
     # Create a new jabber:iq:auth set Stanza.
     def Iq.new_authset(jid, password)
-      iq = Iq::new(:set)
-      query = IqQuery::new
+      iq = Iq.new(:set)
+      query = IqQuery.new
       query.add_namespace('jabber:iq:auth')
-      query.add(REXML::Element::new('username').add_text(jid.node))
-      query.add(REXML::Element::new('password').add_text(password))
-      query.add(REXML::Element::new('resource').add_text(jid.resource)) if not jid.resource.nil?
+      query.add(REXML::Element.new('username').add_text(jid.node))
+      query.add(REXML::Element.new('password').add_text(password))
+      query.add(REXML::Element.new('resource').add_text(jid.resource)) if not jid.resource.nil?
       iq.add(query)
       iq
     end
@@ -151,12 +151,12 @@ module Jabber
     ##
     # Create a new jabber:iq:auth set Stanza for Digest authentication
     def Iq.new_authset_digest(jid, session_id, password)
-      iq = Iq::new(:set)
-      query = IqQuery::new
+      iq = Iq.new(:set)
+      query = IqQuery.new
       query.add_namespace('jabber:iq:auth')
-      query.add(REXML::Element::new('username').add_text(jid.node))
-      query.add(REXML::Element::new('digest').add_text(Digest::SHA1.hexdigest(session_id + password)))
-      query.add(REXML::Element::new('resource').add_text(jid.resource)) if not jid.resource.nil?
+      query.add(REXML::Element.new('username').add_text(jid.node))
+      query.add(REXML::Element.new('digest').add_text(Digest::SHA1.hexdigest(session_id + password)))
+      query.add(REXML::Element.new('resource').add_text(jid.resource)) if not jid.resource.nil?
       iq.add(query)
       iq
     end
@@ -166,11 +166,22 @@ module Jabber
     # username:: [String] (Element will be ommited if unset)
     # password:: [String] (Element will be ommited if unset)
     def Iq.new_register(username=nil, password=nil)
-      iq = Iq::new(:set)
-      query = IqQuery::new
+      iq = Iq.new(:set)
+      query = IqQuery.new
+      query.add_namespace('jabber:iq:register')
+      query.add(REXML::Element.new('username').add_text(username)) if username
+      query.add(REXML::Element.new('password').add_text(password)) if password
+      iq.add(query)
+      iq
+    end
+
+    ##
+    # Create a new jabber:iq:register get stanza for retrieval
+    # of accepted registration information
+    def Iq.new_registerget
+      iq = Iq.new(:get)
+      query = IqQuery.new
       query.add_namespace('jabber:iq:register')
-      query.add(REXML::Element::new('username').add_text(username)) if username
-      query.add(REXML::Element::new('password').add_text(password)) if password
       iq.add(query)
       iq
     end
@@ -180,8 +191,8 @@ module Jabber
     #
     # IqQueryRoster is unused here because possibly not require'd
     def Iq.new_rosterget
-      iq = Iq::new(:get)
-      query = IqQuery::new
+      iq = Iq.new(:get)
+      query = IqQuery.new
       query.add_namespace('jabber:iq:roster')
       iq.add(query)
       iq
@@ -190,8 +201,8 @@ module Jabber
     ##
     # Create a new jabber:iq:roster get Stanza.
     def Iq.new_browseget
-      iq = Iq::new(:get)
-      query = IqQuery::new
+      iq = Iq.new(:get)
+      query = IqQuery.new
       query.add_namespace('jabber:iq:browse')
       iq.add(query)
       iq
@@ -200,8 +211,8 @@ module Jabber
     ##
     # Create a new jabber:iq:roster set Stanza.
     def Iq.new_rosterset
-      iq = Iq::new(:set)
-      query = IqQuery::new
+      iq = Iq.new(:set)
+      query = IqQuery.new
       query.add_namespace('jabber:iq:roster')
       iq.add(query)
       iq

data/lib/xmpp4r/jid.rb

@@ -4,7 +4,7 @@
 
 module Jabber
   ##
-  # The JID class represents a Jabber Identifier as described by 
+  # 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, ...
@@ -63,7 +63,7 @@ module Jabber
     # Returns a new JID with resource removed.
     # return:: [JID]
     def strip
-      JID::new(@node, @domain)
+      JID.new(@node, @domain)
     end
     alias_method :bare, :strip
 

data/lib/xmpp4r/message.rb

@@ -26,7 +26,7 @@ module Jabber
         set_to(to)
       end
       if !body.nil?
-        add_element(REXML::Element::new("body").add_text(body))
+        add_element(REXML::Element.new("body").add_text(body))
       end
     end
 

data/lib/xmpp4r/muc.rb

@@ -7,6 +7,8 @@ require 'xmpp4r/muc/x/muc'
 require 'xmpp4r/muc/x/mucuserinvite'
 require 'xmpp4r/muc/x/mucuseritem'
 require 'xmpp4r/muc/iq/mucowner'
+require 'xmpp4r/muc/iq/mucadmin'
+require 'xmpp4r/muc/iq/mucadminitem'
 require 'xmpp4r/muc/helper/mucbrowser'
 require 'xmpp4r/muc/helper/mucclient'
 require 'xmpp4r/muc/helper/simplemucclient'

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

@@ -30,7 +30,7 @@ module Jabber
       # does not exist or does not support Service Discovery!
       # nil just means that this is not a MUC-compliant service.
       #
-      # Throws an ErrorException when receiving
+      # Throws an ServerError when receiving
       # <tt><iq type='error'/></tt>
       # jid:: [JID] Target entity (set only domain!)
       # return:: [String] or [nil]
@@ -78,25 +78,11 @@ module Jabber
         iq.add(Discovery::IqQueryDiscoItems.new)
 
         rooms = {}
-        err = nil
 
         @stream.send_with_id(iq) do |answer|
-
-          if answer.type == :result
-            answer.query.each_element('item') { |item|
-              rooms[item.jid] = item.iname
-            }
-            true
-          elsif answer.type == :error
-            err = answer.error
-            true
-          else
-            false
-          end
-        end
-
-        if err
-          raise "Error getting MUC rooms: #{err.error}, #{err.text}"
+          answer.query.each_element('item') { |item|
+            rooms[item.jid] = item.iname
+          }
         end
 
         rooms
@@ -104,4 +90,3 @@ module Jabber
     end
   end
 end
-

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

@@ -3,6 +3,9 @@
 # Website::http://home.gna.org/xmpp4r/
 
 require 'xmpp4r/muc/x/muc'
+require 'xmpp4r/muc/iq/mucowner'
+require 'xmpp4r/muc/iq/mucadmin'
+require 'xmpp4r/dataforms'
 
 module Jabber
   module MUC
@@ -61,7 +64,7 @@ module Jabber
       #
       # This registers its own callbacks on the stream
       # provided to initialize and sends initial presence
-      # to the room. May throw ErrorException if joining
+      # to the room. May throw ServerError if joining
       # fails.
       # jid:: [JID] room@component/nick
       # password:: [String] Optional password
@@ -70,7 +73,7 @@ module Jabber
         if active?
           raise "MUCClient already active"
         end
-        
+
         @jid = (jid.kind_of?(JID) ? jid : JID.new(jid))
         activate
 
@@ -109,7 +112,7 @@ module Jabber
 
         if error
           deactivate
-          raise ErrorException.new(error)
+          raise ServerError.new(error)
         end
 
         self
@@ -175,12 +178,12 @@ module Jabber
       # transient JID, one indicating availability of the new
       # transient JID.
       #
-      # If the service denies nick-change, ErrorException will be raisen.
+      # If the service denies nick-change, ServerError will be raised.
       def nick=(new_nick)
         unless active?
           raise "MUCClient not active"
         end
-        
+
         new_jid = JID.new(@jid.node, @jid.domain, new_nick)
 
         # Joining
@@ -219,7 +222,7 @@ module Jabber
         }
 
         if error
-          raise ErrorException.new(error)
+          raise ServerError.new(error)
         end
 
         # Apply new JID
@@ -247,7 +250,7 @@ module Jabber
           stanza.type = to ? :chat : :groupchat
         end
         stanza.from = @my_jid
-        stanza.to = JID::new(jid.node, jid.domain, to)
+        stanza.to = JID.new(jid.node, jid.domain, to)
         @stream.send(stanza)
       end
 
@@ -388,30 +391,42 @@ module Jabber
         @affiliation == :owner
       end
 
+      ##
+      # Use this method to configure a MUC room of which you are the owner.
+      #
+      # options:: [Hash] where keys are the features of the room you wish
+      # to configure. See http://www.xmpp.org/extensions/xep-0045.html#registrar-formtype-owner
       def configure(options={})
+        get_room_configuration
+        submit_room_configuration(options)
+      end
+
+      def get_room_configuration
         raise 'You are not the owner' unless owner?
-        
-        iq = Iq.new(:get, jid)
-        iq.to = @jid
-        iq.from = @my_jid
+
+        iq = Iq.new(:get, jid.strip)
+        iq.from = my_jid
         iq.add(IqQueryMUCOwner.new)
 
         fields = []
-        
-        answer = @stream.send_with_id(iq)
-        raise "Configuration not possible for this room" unless answer.query && answer.query.x(XData)
 
-        answer.query.x(XData).fields.each { |field|
-          if (var = field.attributes['var'])
-            fields << var
+        @stream.send_with_id(iq) do |answer|
+          raise "Configuration not possible for this room" unless answer.query && answer.query.x(Dataforms::XData)
+
+          answer.query.x(Dataforms::XData).fields.each do |field|
+            if (var = field.attributes['var'])
+              fields << var
+            end
           end
-        }
+        end
+
+        fields
+      end
 
-        
+      def submit_room_configuration(options)
         # fill out the reply form
-        iq = Iq.new(:set, jid)
-        iq.to = @jid
-        iq.from = @my_jid
+        iq = Iq.new(:set, jid.strip)
+        iq.from = my_jid
         query = IqQueryMUCOwner.new
         form = Dataforms::XData.new
         form.type = :submit
@@ -422,7 +437,23 @@ module Jabber
           form.add(field)
         end
         query.add(form)
-        iq.add(query)   
+        iq.add(query)
+
+        @stream.send_with_id(iq)
+      end
+
+      ##
+      # Push a list of new affiliations to the room
+      # items:: [Array] of, or single [IqQueryMUCAdminItem]
+      def send_affiliations(items)
+        iq = Iq.new(:set, jid.strip)
+        iq.from = my_jid
+        iq.add(IqQueryMUCAdmin.new)
+
+        items = [item] unless items.kind_of? Array
+        items.each { |item|
+          iq.query.add(item)
+        }
 
         @stream.send_with_id(iq)
       end