RubyGems - xmpp4r - Versions diffs - 0.4 → 0.5 - Mend

xmpp4r 0.4 → 0.5

Files changed (68) hide show

data/CHANGELOG +8 -0
data/README.rdoc +4 -1
data/Rakefile +10 -20
data/data/doc/xmpp4r/examples/advanced/versionpoll.rb +20 -1
data/lib/xmpp4r/bytestreams/helper/ibb/target.rb +7 -0
data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/target.rb +7 -1
data/lib/xmpp4r/callbacks.rb +9 -0
data/lib/xmpp4r/caps/c.rb +14 -0
data/lib/xmpp4r/caps/helper/helper.rb +1 -4
data/lib/xmpp4r/client.rb +42 -15
data/lib/xmpp4r/connection.rb +7 -3
data/lib/xmpp4r/debuglog.rb +22 -1
data/lib/xmpp4r/discovery.rb +1 -0
data/lib/xmpp4r/discovery/helper/helper.rb +58 -0
data/lib/xmpp4r/discovery/iq/discoinfo.rb +2 -2
data/lib/xmpp4r/discovery/iq/discoitems.rb +2 -2
data/lib/xmpp4r/errors.rb +5 -2
data/lib/xmpp4r/httpbinding/client.rb +9 -19
data/lib/xmpp4r/last.rb +2 -0
data/lib/xmpp4r/last/helper/helper.rb +37 -0
data/lib/xmpp4r/last/iq/last.rb +67 -0
data/lib/xmpp4r/location.rb +2 -0
data/lib/xmpp4r/location/helper/helper.rb +56 -0
data/lib/xmpp4r/location/location.rb +179 -0
data/lib/xmpp4r/message.rb +32 -0
data/lib/xmpp4r/presence.rb +1 -1
data/lib/xmpp4r/pubsub/children/configuration.rb +1 -1
data/lib/xmpp4r/pubsub/children/items.rb +11 -2
data/lib/xmpp4r/pubsub/children/publish.rb +14 -0
data/lib/xmpp4r/pubsub/children/retract.rb +41 -0
data/lib/xmpp4r/pubsub/helper/nodebrowser.rb +2 -3
data/lib/xmpp4r/pubsub/helper/nodehelper.rb +4 -4
data/lib/xmpp4r/pubsub/helper/oauth_service_helper.rb +90 -0
data/lib/xmpp4r/pubsub/helper/servicehelper.rb +58 -19
data/lib/xmpp4r/reliable.rb +168 -0
data/lib/xmpp4r/rexmladdons.rb +6 -0
data/lib/xmpp4r/roster/helper/roster.rb +5 -2
data/lib/xmpp4r/sasl.rb +19 -8
data/lib/xmpp4r/stream.rb +133 -31
data/lib/xmpp4r/streamparser.rb +9 -1
data/lib/xmpp4r/test/listener_mocker.rb +118 -0
data/lib/xmpp4r/xmpp4r.rb +3 -1
data/test/bytestreams/tc_ibb.rb +6 -4
data/test/bytestreams/tc_socks5bytestreams.rb +3 -2
data/test/caps/tc_helper.rb +4 -2
data/test/dataforms/tc_data.rb +1 -1
data/test/last/tc_helper.rb +75 -0
data/test/lib/clienttester.rb +43 -14
data/test/muc/tc_muc_mucclient.rb +6 -2
data/test/pubsub/tc_helper.rb +131 -8
data/test/pubsub/tc_nodeconfig.rb +7 -0
data/test/reliable/tc_disconnect_cleanup.rb +334 -0
data/test/reliable/tc_disconnect_exception.rb +37 -0
data/test/reliable/tc_listener_mocked_test.rb +68 -0
data/test/reliable/tc_reliable_connection.rb +31 -0
data/test/roster/tc_helper.rb +21 -11
data/test/rpc/tc_helper.rb +2 -2
data/test/tc_callbacks.rb +3 -3
data/test/tc_message.rb +15 -0
data/test/tc_stream.rb +59 -121
data/test/tc_streamError.rb +2 -4
data/test/tc_streamparser.rb +26 -13
data/test/ts_xmpp4r.rb +0 -9
data/test/tune/tc_helper_recv.rb +0 -2
data/test/vcard/tc_helper.rb +1 -1
data/xmpp4r.gemspec +31 -84
metadata +116 -167
data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/target.rb.orig +0 -62

@@ -4,4 +4,5 @@
 require 'xmpp4r/discovery/iq/discoinfo'
 require 'xmpp4r/discovery/iq/discoitems'
+require 'xmpp4r/discovery/helper/helper'
 require 'xmpp4r/discovery/helper/responder'

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

@@ -0,0 +1,58 @@
+# =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/discovery'
+module Jabber
+  module Discovery
+    ##
+    # A Helper to manage service and item discovery.
+    class Helper
+      def initialize(client)
+        @stream = client
+      end
+      ##
+      # Service discovery on a JID.
+      # jid:: [JID]
+      # return:: [Jabber::Discovery::IqQueryDiscoInfo]
+      def get_info_for(jid, node = nil)
+        iq = Jabber::Iq.new(:get, jid)
+        iq.from = @stream.jid
+        disco = Jabber::Discovery::IqQueryDiscoInfo.new
+        disco.node = node
+        iq.add(disco)
+        res = nil
+        @stream.send_with_id(iq) { |reply|
+          res = reply.query
+        }
+        res
+      end
+      ##
+      # Item discovery on a JID.
+      # jid:: [JID]
+      # return:: [Jabber::Discovery::IqQueryDiscoItems]
+      def get_items_for(jid, node = nil)
+        iq = Jabber::Iq.new(:get, jid)
+        iq.from = @stream.jid
+        disco = Jabber::Discovery::IqQueryDiscoItems.new
+        disco.node = node
+        iq.add(disco)
+        res = nil
+        @stream.send_with_id(iq) { |reply|
+          res = reply.query
+        }
+        res
+      end
+    end
+  end
+end

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

@@ -29,14 +29,14 @@ module Jabber
       end
       ##
-      # Get the queried Service Discovery node or nil
+      # Set the queried Service Discovery node or nil
       # val:: [String]
       def node=(val)
         attributes['node'] = val
       end
       ##
-      # Get the queried Service Discovery node or nil
+      # Set the queried Service Discovery node or nil
       # (chaining-friendly)
       # val:: [String]
       def set_node(val)

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

@@ -32,13 +32,13 @@ module Jabber
       end
       ##
-      # Get the queried Service Discovery node or nil
+      # Set the queried Service Discovery node or nil
       def node=(val)
         attributes['node'] = val
       end
       ##
-      # Get the queried Service Discovery node or nil
+      # Set the queried Service Discovery node or nil
       # (chaining-friendly)
       def set_node(val)
         self.node = val

data/lib/xmpp4r/errors.rb CHANGED

@@ -12,6 +12,9 @@ module Jabber
   # A client-side only argument error
   class ArgumentError < JabberError; end
+  # Server disconnected us
+  class ServerDisconnected < JabberError; end
   ##
   # An error returned from the server
   #
@@ -45,16 +48,16 @@ module Jabber
   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
+  class InvalidChatState < JabberError; end
   ##
   # A class used to build/parse <error/> elements.
   # Look at XEP-0086 for explanation:

data/lib/xmpp4r/httpbinding/client.rb CHANGED

@@ -2,8 +2,10 @@
 # License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
 # Website::http://home.gna.org/xmpp4r/
+# TODO: eval  <body type='terminate' condition=
 require 'xmpp4r/client'
+require 'xmpp4r/semaphore'
 require 'net/http'
 module Jabber
@@ -50,6 +52,7 @@ module Jabber
         @last_send = Time.at(0)
         @send_buffer = ''
+        @http_requests = 1
         @http_wait = 20
         @http_hold = 1
         @http_content_type = 'text/xml; charset=utf-8'
@@ -73,7 +76,7 @@ module Jabber
         @stream_features = {}
         @http_rid = IdGenerator.generate_id.to_i
         @pending_rid = @http_rid
-        @pending_rid_lock = Mutex.new
+        @pending_rid_lock = Semaphore.new
         req_body = REXML::Element.new('body')
         req_body.attributes['rid'] = @http_rid
@@ -82,7 +85,7 @@ module Jabber
         req_body.attributes['wait'] = @http_wait.to_s
         req_body.attributes['to'] = @jid.domain
         if host
-          req_body.attributes['route'] = 'xmpp:#{host}:#{port}'
+          req_body.attributes['route'] = "xmpp:#{host}:#{port}"
         end
         req_body.attributes['secure'] = 'true'
         req_body.attributes['xmlns'] = 'http://jabber.org/protocol/httpbind'
@@ -107,19 +110,6 @@ module Jabber
         @features_sem.run
       end
-      ##
-      # Send a stanza, additionally with block
-      #
-      # This method ensures a 'jabber:client' namespace for
-      # the stanza
-      def send(xml, &block)
-        if xml.kind_of? REXML::Element
-          xml.add_namespace('jabber:client')
-        end
-        super
-      end
       ##
       # Ensure that there is one pending request
       #
@@ -148,7 +138,7 @@ module Jabber
       # result:: [REXML::Element]
       def receive_elements_with_rid(rid, elements)
         while rid > @pending_rid
-          @pending_rid_lock.lock
+          @pending_rid_lock.wait
         end
         @pending_rid = rid + 1
@@ -156,7 +146,7 @@ module Jabber
           receive(e)
         }
-        @pending_rid_lock.unlock
+        @pending_rid_lock.run
       end
       ##
@@ -167,12 +157,12 @@ module Jabber
         request.content_length = body.size
         request.body = body
         request['Content-Type'] = @http_content_type
-        Jabber::debuglog("HTTP REQUEST (#{@pending_requests}/#{@http_requests}):\n#{request.body}")
+        Jabber::debuglog("HTTP REQUEST (#{@pending_requests + 1}/#{@http_requests}):\n#{request.body}")
         response = Net::HTTP.start(@uri.host, @uri.port) { |http|
           http.use_ssl = true if @uri.kind_of? URI::HTTPS
           http.request(request)
         }
-        Jabber::debuglog("HTTP RESPONSE (#{@pending_requests}/#{@http_requests}):\n#{response.body}")
+        Jabber::debuglog("HTTP RESPONSE (#{@pending_requests + 1}/#{@http_requests}): #{response.class}\n#{response.body}")
         unless response.kind_of? Net::HTTPSuccess
           # Unfortunately, HTTPResponses aren't exceptions

data/lib/xmpp4r/last.rb ADDED

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

data/lib/xmpp4r/last/helper/helper.rb ADDED

@@ -0,0 +1,37 @@
+# =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/last'
+module Jabber
+  module LastActivity
+    ##
+    # A Helper to manage discovery of Last Activity.
+    class Helper
+      def initialize(client)
+        @stream = client
+      end
+      ##
+      # Gets the last activity from a JID.
+      # jid:: [JID]
+      # return:: [Jabber::LastActivity::IqQueryLastActivity]
+      def get_last_activity_from(jid)
+        iq = Jabber::Iq.new(:get, jid)
+        iq.from = @stream.jid
+        iq.add(Jabber::LastActivity::IqQueryLastActivity.new)
+        reply = @stream.send_with_id(iq)
+        if reply.query && reply.query.kind_of?(IqQueryLastActivity)
+          reply.query
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/xmpp4r/last/iq/last.rb ADDED

@@ -0,0 +1,67 @@
+# =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/query'
+module Jabber
+  module LastActivity
+    NS_LAST_ACTIVITY = 'jabber:iq:last'
+    ##
+    # Class for handling Last Activity queries
+    # (XEP-0012)
+    class IqQueryLastActivity < IqQuery
+      name_xmlns 'query', NS_LAST_ACTIVITY
+      ##
+      # Get the number of seconds since last activity.
+      #
+      # With a bare jid, this will return the number of seconds since the
+      # client was last seen (offline user query).
+      #
+      # With a full jid, this will return the number of seconds that the
+      # client has been idle (online user query).
+      #
+      # With a server, this will return the server or component's uptime in
+      # seconds (server / component query).
+      def seconds
+        attributes['seconds'] ? attributes['seconds'].to_i : nil
+      end
+      ##
+      # Set the number of seconds since last activity
+      def seconds=(val)
+        attributes['seconds'] = val.to_s
+      end
+      ##
+      # Set the number of seconds since last activity
+      # (chaining-friendly)
+      def set_second(val)
+        self.seconds = val
+        self
+      end
+      ##
+      # For an offline user query, get the last status.
+      def status
+        self.text
+      end
+      ##
+      # For an offline user query, set the last status.
+      def status=(val)
+        self.text = val
+      end
+      ##
+      # For an offline user query, set the last status.
+      # (chaining-friendly)
+      def set_status(val)
+        self.status = val
+        self
+      end
+    end
+  end
+end

data/lib/xmpp4r/location.rb ADDED

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

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

@@ -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 ADDED

@@ -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