xmpp4r 0.3.2 → 0.4

data/lib/xmpp4r/delay/x/delay.rb

@@ -75,7 +75,7 @@ module Jabber
       # result:: [JID]
       def from
         if attributes['from']
-          JID::new(attributes['from'])
+          JID.new(attributes['from'])
         else
           nil
         end

data/lib/xmpp4r/discovery.rb

@@ -2,5 +2,6 @@
 # License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
 # Website::http://home.gna.org/xmpp4r/
 
-require 'xmpp4r/discovery/iq/discoinfo.rb'
-require 'xmpp4r/discovery/iq/discoitems.rb'
+require 'xmpp4r/discovery/iq/discoinfo'
+require 'xmpp4r/discovery/iq/discoitems'
+require 'xmpp4r/discovery/helper/responder'

data/lib/xmpp4r/discovery/helper/responder.rb

@@ -0,0 +1,165 @@
+# =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/iq'
+require 'xmpp4r/discovery/iq/discoinfo'
+require 'xmpp4r/discovery/iq/discoitems'
+require 'xmpp4r/caps/helper/generator'
+
+module Jabber
+  module Discovery
+    ##
+    # Responds to Service Discovery queries on a given node
+    #
+    # Modify returned elements by these attributes:
+    # * Responder#identities
+    # * Responder#features (Responder#add_features is a short-cut accepting an Array of Strings, too)
+    # * Responder#forms
+    # * Responder#items
+    class Responder
+      ##
+      # Service Discovery node this Responder is responsible for
+      # (will not answer queries for other nodes)
+      attr_reader :node
+
+      ##
+      # Identities returned on Discovery Info query
+      #
+      # Array of [Discovery::Identity]
+      attr_accessor :identities
+      ##
+      # Features returned on Discovery Info query,
+      #
+      # Array of [Discovery::Feature]
+      attr_accessor :features
+      ##
+      # Forms returned on Discovery Info query
+      # (such as Software Information)
+      #
+      # Array of [Dataforms::XData]
+      attr_accessor :forms
+
+      ##
+      # Children returned on Discovery Item query
+      #
+      # May contain other Discovery::Responder instances
+      # which will generate an item dynamically from their
+      # first identity
+      #
+      # Array of [Discovery::Item] or [Discovery::Responder] (mixed)
+      attr_accessor :items
+
+      ##
+      # Set the JID this helper feels responsible for
+      # (default: nil, responsible for any JID)
+      attr_accessor :my_jid
+
+      CALLBACK_PRIORITY = 180
+
+      ##
+      # Initialize responder for a specific node
+      # stream:: [Jabber::Stream]
+      # node:: [nil] or [String]
+      def initialize(stream, node=nil, identities=[], features=[], items=[])
+        @stream = stream
+        @my_jid = nil
+        @node = node
+        @identities = identities
+        @features = []
+        add_features(features)
+        @forms = []
+        @items = items
+
+        @stream.add_iq_callback(CALLBACK_PRIORITY, self) do |iq|
+          my_nodes = [@node, "#{@node}##{generate_ver}"]
+
+          if iq.type == :get and
+             iq.query.kind_of? IqQueryDiscoInfo and
+             my_nodes.include?(iq.query.node)
+
+            answer = iq.answer(false)
+            answer.type = :result
+            query = answer.add(IqQueryDiscoInfo.new)
+            query.node = iq.query.node
+            (@identities + @features + @forms).each do |element|
+              query.add(element)
+            end
+            @stream.send(answer)
+
+            true  # handled
+
+          elsif iq.type == :get and
+                iq.query.kind_of? IqQueryDiscoItems and
+                my_nodes.include?(iq.query.node)
+
+            answer = iq.answer(false)
+            answer.type = :result
+            query = answer.add(IqQueryDiscoItems.new)
+            query.node = iq.query.node
+            @items.each do |item|
+              if item.kind_of? Responder
+                query.add(item.generate_item)
+              else
+                query.add(item)
+              end
+            end
+            @stream.send(answer)
+
+            true  # handled
+
+          else
+            false # not handled
+          end
+        end
+      end
+
+      ##
+      # Add a feature
+      # feature:: [Jabber::Discovery::Feature] or [String]
+      def add_feature(feature)
+        if feature.kind_of? Feature
+          @features << feature
+        else
+          @features << Feature.new(feature.to_s)
+        end
+      end
+
+      ##
+      # Add a series of features
+      # features:: Array of [Jabber::Discovery::Feature] or [String]
+      def add_features(features)
+        features.each { |feature|
+          add_feature(feature)
+        }
+      end
+
+      ##
+      # Generate a XEP-0115: Entity Capabilities <c/> element
+      # for inclusion in Presence stanzas. This enables efficient
+      # caching of Service Discovery information.
+      def generate_caps
+        Caps::C.new(@node, generate_ver)
+      end
+
+      ##
+      # Generate an item for inclusion in items discovery in other
+      # responders
+      # return:: [Discovery::Item] or nil
+      def generate_item
+        i = @identities.first
+        if i
+          Item.new(@my_jid || @stream.jid, i.iname, @node)
+        else
+          nil
+        end
+      end
+
+      private
+
+      def generate_ver
+        Caps::generate_ver(@identities, @features, @forms)
+      end
+    end
+  end
+end

data/lib/xmpp4r/discovery/iq/discoinfo.rb

@@ -6,6 +6,8 @@ require 'xmpp4r/query'
 
 module Jabber
   module Discovery
+    NS_DISCO_INFO = 'http://jabber.org/protocol/disco#info'
+
     ##
     # Class for handling Service Discovery queries,
     # info
@@ -15,7 +17,7 @@ module Jabber
     # elements, describing the type and the supported namespaces of
     # the service.
     class IqQueryDiscoInfo < IqQuery
-      name_xmlns 'query', 'http://jabber.org/protocol/disco#info'
+      name_xmlns 'query', NS_DISCO_INFO
 
       ##
       # Get the queried Service Discovery node or nil
@@ -53,11 +55,7 @@ module Jabber
       # Get list of identities
       # result:: [Array] of [Identity]
       def identities
-        res = []
-        each_element('identity') { |id|
-          res.push(id)
-        }
-        res        
+        get_elements('identity')
       end
 
       ##
@@ -76,9 +74,10 @@ module Jabber
     ##
     # Service Discovery identity to add() to IqQueryDiscoInfo
     #
-    # Please note that JEP 0030 requires both category and type to occur
+    # Please note that XEP 0030 requires both category and type to occur,
+    # for a reference see: http://www.xmpp.org/registrar/disco-categories.html
     class Identity < XMPPElement
-      name_xmlns 'identity', 'http://jabber.org/protocol/disco#info'
+      name_xmlns 'identity', NS_DISCO_INFO
 
       ##
       # Initialize a new Identity
@@ -171,9 +170,10 @@ module Jabber
     ##
     # Service Discovery feature to add() to IqQueryDiscoInfo
     #
-    # Please note that JEP 0030 requires var to be set
+    # Please note that JEP 0030 requires var to be set,
+    # for a reference see: http://www.xmpp.org/registrar/disco-features.html
     class Feature < XMPPElement
-      name_xmlns 'feature', 'http://jabber.org/protocol/disco#info'
+      name_xmlns 'feature', NS_DISCO_INFO
 
       ##
       # Create a new <feature/> element
@@ -192,7 +192,7 @@ module Jabber
 
       ##
       # Set the feature's var
-      # 
+      #
       # This is a namespace the identity supports.
       # val:: [String]
       def var=(val)
@@ -209,4 +209,3 @@ module Jabber
     end
   end
 end
-

data/lib/xmpp4r/discovery/iq/discoitems.rb

@@ -6,6 +6,8 @@ require 'xmpp4r/query'
 
 module Jabber
   module Discovery
+    NS_DISCO_ITEMS = 'http://jabber.org/protocol/disco#items'
+
     ##
     # Class for handling Service Discovery queries,
     # items
@@ -17,7 +19,7 @@ module Jabber
     # querying IqQueryDiscoInfo and further sub-items by querying
     # IqQueryDiscoItems.
     class IqQueryDiscoItems < IqQuery
-      name_xmlns 'query', 'http://jabber.org/protocol/disco#items'
+      name_xmlns 'query', NS_DISCO_ITEMS
 
       ##
       # Get the queried Service Discovery node or nil
@@ -42,6 +44,13 @@ module Jabber
         self.node = val
         self
       end
+
+      ##
+      # Get all item children
+      # result:: Array of [Discovery::Item]
+      def items
+        get_elements('item')
+      end
     end
 
 
@@ -50,7 +59,7 @@ module Jabber
     #
     # Please note that JEP 0030 requires the jid to occur
     class Item < XMPPElement
-      name_xmlns 'item', 'http://jabber.org/protocol/disco#items'
+      name_xmlns 'item', NS_DISCO_ITEMS
 
       ##
       # Initialize a new Service Discovery <item/>
@@ -69,7 +78,7 @@ module Jabber
       # Get the item's jid or nil
       # result:: [String]
       def jid
-        JID::new(attributes['jid'])
+        JID.new(attributes['jid'])
       end
 
       ##
@@ -136,4 +145,3 @@ module Jabber
     end
   end
 end
-

data/lib/xmpp4r/{error.rb → errors.rb}

@@ -3,10 +3,66 @@
 # Website::http://home.gna.org/xmpp4r/
 
 module Jabber
+
+  # CUSTOM ERROR CLASSES
+
+  # All of our custom errors are superclassed by JabberError < StandardError
+  class JabberError < StandardError; end
+
+  # A client-side only argument error
+  class ArgumentError < JabberError; end
+
+  ##
+  # An error returned from the server
+  #
+  # e.g. This exception can be raised by helpers when they
+  # receive a server reply with <tt>type='error'</tt>
+  #
+  # The ServerError carries a Jabber::ErrorResponse element
+  #
+  class ServerError < JabberError #:nodoc:
+
+    ##
+    # The error element which caused this exception
+    attr_reader :error
+
+    ##
+    # Initialize a ServerError by passing an ErrorResponse instance
+    # error:: [Error]
+    def initialize(error)
+      @error = error
+    end
+
+    ##
+    # Sample output:
+    # 'subscription-required: Please subscribe first'
+    def to_s
+      "#{@error.error}: #{@error.text}"
+    end
+  end
+
+  class ClientAuthenticationFailure < JabberError; end
+
+  class ComponentAuthenticationFailure < JabberError; end
+
+  # TODO : Give this a better name
+  class NoNameXmlnsRegistered < JabberError
+    def initialize(klass)
+      super "Class #{klass} has not set name and xmlns"
+    end
+  end
+
+  # TODO : Give this a better name
+  class SOCKS5Error < JabberError; end
+
   ##
   # A class used to build/parse <error/> elements.
-  # Look at JEP 0086 for explanation.
-  class Error < XMPPElement
+  # Look at XEP-0086 for explanation:
+  # http://www.xmpp.org/extensions/xep-0086.html
+  #
+  # FIXME : XEP-0086 is officially deprecated.  What effect does that have on this class? Any?
+  #
+  class ErrorResponse < XMPPElement
     name_xmlns 'error'
 
     ##
@@ -35,9 +91,9 @@ module Jabber
     # * "unexpected-request"
     # Will raise an [Exception] if not [nil] and none of the above
     #
-    # Does also set type and code to appropriate values according to errorcondition
+    # Also sets type and code to appropriate values according to errorcondition
     #
-    # text: [nil] or [String] Error text
+    # text: [nil] or [String] ErrorResponse text
     def initialize(errorcondition=nil, text=nil)
       if errorcondition.nil?
         super()
@@ -53,9 +109,9 @@ module Jabber
         }
 
         if errortype.nil? || errorcode.nil?
-          raise("Unknown error condition when initializing Error")
+          raise ArgumentError, "Unknown error condition when initializing ErrorReponse"
         end
-        
+
         super()
         set_error(errorcondition)
         set_type(errortype)
@@ -155,7 +211,7 @@ module Jabber
       self.text = s
       self
     end
-    
+
     ##
     # Get the type of error
     # (meaning how to proceed)
@@ -177,7 +233,7 @@ module Jabber
     end
 
     ##
-    # Set the type of error (see Error#type)
+    # Set the type of error (see ErrorResponse#type)
     def type=(t)
       case t
         when :auth then attributes['type'] = 'auth'
@@ -197,8 +253,7 @@ module Jabber
     end
 
     ##
-    # Possible XMPP error conditions, types and codes
-    # (JEP 0086)
+    # Possible XMPP error conditions, types and codes (XEP-0086)
     @@Errors = [['bad-request', :modify, 400],
                 ['conflict', :cancel, 409],
                 ['feature-not-implemented', :cancel, 501],
@@ -222,4 +277,5 @@ module Jabber
                 ['undefined-condition', nil, 500],
                 ['unexpected-request', :wait, 400]]
   end
+
 end

data/lib/xmpp4r/framework/base.rb

@@ -0,0 +1,55 @@
+require 'thread'
+
+module Jabber
+  module Framework
+    class Base
+
+      def self.helper(name, klass=nil, &factory)
+        if klass.nil? and factory.nil?
+          raise "helper #{name} needs a class or factory"
+        end
+
+        define_method(name) do
+          @helpers_lock.synchronize do
+            if @helpers[name]
+              @helpers[name]
+            else
+              if factory
+                @helpers[name] = instance_eval { factory.call(@stream) }
+              elsif klass
+                @helpers[name] = klass.new(@stream)
+              else
+                raise
+                end
+            end
+          end
+        end
+      end
+
+      attr_accessor :stream
+
+      def initialize(stream)
+        @stream = stream
+        @helpers = {}
+        @helpers_lock = Mutex.new
+
+        # Catch all unhandled iq stanzas (lowest priority)
+        @stream.add_iq_callback(-1000, self, &method(:on_unhandled_iq))
+      end
+
+      def on_unhandled_iq(iq)
+        if iq.type == :get or iq.type == :set
+          answer = iq.answer(true)
+          answer.type = :error
+          answer.add(ErrorResponse.new('feature-not-implemented'))
+          @stream.send(answer)
+
+          true
+        else
+          false
+        end
+      end
+
+    end
+  end
+end