RubyGems - ln-xmpp4r - Versions diffs - 0.5 - Mend

ln-xmpp4r 0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (215) hide show

data/CHANGELOG +91 -0
data/COPYING +340 -0
data/LICENSE +59 -0
data/README.rdoc +113 -0
data/README_ruby19.txt +43 -0
data/Rakefile +252 -0
data/data/doc/xmpp4r/examples/advanced/adventure/README +56 -0
data/data/doc/xmpp4r/examples/advanced/adventure/adventure.rb +23 -0
data/data/doc/xmpp4r/examples/advanced/adventure/adventuremuc.rb +136 -0
data/data/doc/xmpp4r/examples/advanced/adventure/cube.xml +15 -0
data/data/doc/xmpp4r/examples/advanced/adventure/tower.xml +69 -0
data/data/doc/xmpp4r/examples/advanced/adventure/world.rb +424 -0
data/data/doc/xmpp4r/examples/advanced/fileserve.conf +11 -0
data/data/doc/xmpp4r/examples/advanced/fileserve.rb +346 -0
data/data/doc/xmpp4r/examples/advanced/getonline.rb +56 -0
data/data/doc/xmpp4r/examples/advanced/gtkmucclient.rb +315 -0
data/data/doc/xmpp4r/examples/advanced/migrate.rb +88 -0
data/data/doc/xmpp4r/examples/advanced/minimuc.rb +266 -0
data/data/doc/xmpp4r/examples/advanced/pep-aggregator/index.xsl +235 -0
data/data/doc/xmpp4r/examples/advanced/pep-aggregator/pep-aggregator.rb +147 -0
data/data/doc/xmpp4r/examples/advanced/recvfile.rb +84 -0
data/data/doc/xmpp4r/examples/advanced/rosterdiscovery.rb +129 -0
data/data/doc/xmpp4r/examples/advanced/sendfile.conf +10 -0
data/data/doc/xmpp4r/examples/advanced/sendfile.rb +72 -0
data/data/doc/xmpp4r/examples/advanced/shellmgr/shellmgr.rb +51 -0
data/data/doc/xmpp4r/examples/advanced/shellmgr/shellmgr_jabber.rb +43 -0
data/data/doc/xmpp4r/examples/advanced/shellmgr/shellmgr_test.rb +10 -0
data/data/doc/xmpp4r/examples/advanced/versionpoll.rb +109 -0
data/data/doc/xmpp4r/examples/advanced/xmpping.rb +146 -0
data/data/doc/xmpp4r/examples/advanced/xmppingrc.sample +14 -0
data/data/doc/xmpp4r/examples/basic/change_password.rb +41 -0
data/data/doc/xmpp4r/examples/basic/client.rb +70 -0
data/data/doc/xmpp4r/examples/basic/component.rb +11 -0
data/data/doc/xmpp4r/examples/basic/echo.rb +37 -0
data/data/doc/xmpp4r/examples/basic/jabbersend.rb +41 -0
data/data/doc/xmpp4r/examples/basic/mass_sender.rb +68 -0
data/data/doc/xmpp4r/examples/basic/muc_owner_config.rb +12 -0
data/data/doc/xmpp4r/examples/basic/mucinfo.rb +41 -0
data/data/doc/xmpp4r/examples/basic/mucsimplebot.rb +82 -0
data/data/doc/xmpp4r/examples/basic/register.rb +42 -0
data/data/doc/xmpp4r/examples/basic/remove_registration.rb +18 -0
data/data/doc/xmpp4r/examples/basic/roster.rb +44 -0
data/data/doc/xmpp4r/examples/basic/rosterprint.rb +50 -0
data/data/doc/xmpp4r/examples/basic/rosterrename.rb +34 -0
data/data/doc/xmpp4r/examples/basic/rosterwatch.rb +171 -0
data/data/doc/xmpp4r/examples/basic/send_vcard.rb +67 -0
data/data/doc/xmpp4r/examples/basic/tune_client.rb +56 -0
data/data/doc/xmpp4r/examples/basic/tune_server.rb +58 -0
data/data/doc/xmpp4r/examples/basic/versionbot.rb +75 -0
data/lib/xmpp4r.rb +116 -0
data/lib/xmpp4r/base64.rb +32 -0
data/lib/xmpp4r/bytestreams.rb +15 -0
data/lib/xmpp4r/bytestreams/helper/filetransfer.rb +319 -0
data/lib/xmpp4r/bytestreams/helper/ibb/base.rb +257 -0
data/lib/xmpp4r/bytestreams/helper/ibb/initiator.rb +31 -0
data/lib/xmpp4r/bytestreams/helper/ibb/target.rb +54 -0
data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/base.rb +152 -0
data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/initiator.rb +86 -0
data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/server.rb +198 -0
data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/socks5.rb +65 -0
data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/target.rb +79 -0
data/lib/xmpp4r/bytestreams/iq/bytestreams.rb +170 -0
data/lib/xmpp4r/bytestreams/iq/si.rb +206 -0
data/lib/xmpp4r/callbacks.rb +133 -0
data/lib/xmpp4r/caps.rb +1 -0
data/lib/xmpp4r/caps/c.rb +67 -0
data/lib/xmpp4r/caps/helper/generator.rb +160 -0
data/lib/xmpp4r/caps/helper/helper.rb +84 -0
data/lib/xmpp4r/client.rb +344 -0
data/lib/xmpp4r/command/helper/responder.rb +53 -0
data/lib/xmpp4r/command/iq/command.rb +154 -0
data/lib/xmpp4r/component.rb +103 -0
data/lib/xmpp4r/connection.rb +223 -0
data/lib/xmpp4r/dataforms.rb +5 -0
data/lib/xmpp4r/dataforms/x/data.rb +297 -0
data/lib/xmpp4r/debuglog.rb +63 -0
data/lib/xmpp4r/delay.rb +5 -0
data/lib/xmpp4r/delay/x/delay.rb +99 -0
data/lib/xmpp4r/discovery.rb +8 -0
data/lib/xmpp4r/discovery/helper/helper.rb +58 -0
data/lib/xmpp4r/discovery/helper/responder.rb +165 -0
data/lib/xmpp4r/discovery/iq/discoinfo.rb +211 -0
data/lib/xmpp4r/discovery/iq/discoitems.rb +147 -0
data/lib/xmpp4r/errors.rb +284 -0
data/lib/xmpp4r/feature_negotiation.rb +5 -0
data/lib/xmpp4r/feature_negotiation/iq/feature.rb +28 -0
data/lib/xmpp4r/framework/base.rb +55 -0
data/lib/xmpp4r/framework/bot.rb +148 -0
data/lib/xmpp4r/httpbinding.rb +5 -0
data/lib/xmpp4r/httpbinding/client.rb +275 -0
data/lib/xmpp4r/idgenerator.rb +37 -0
data/lib/xmpp4r/iq.rb +221 -0
data/lib/xmpp4r/jid.rb +167 -0
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 +180 -0
data/lib/xmpp4r/muc.rb +14 -0
data/lib/xmpp4r/muc/helper/mucbrowser.rb +92 -0
data/lib/xmpp4r/muc/helper/mucclient.rb +462 -0
data/lib/xmpp4r/muc/helper/simplemucclient.rb +332 -0
data/lib/xmpp4r/muc/iq/mucadmin.rb +23 -0
data/lib/xmpp4r/muc/iq/mucadminitem.rb +20 -0
data/lib/xmpp4r/muc/iq/mucowner.rb +15 -0
data/lib/xmpp4r/muc/item.rb +143 -0
data/lib/xmpp4r/muc/x/muc.rb +70 -0
data/lib/xmpp4r/muc/x/mucuserinvite.rb +60 -0
data/lib/xmpp4r/muc/x/mucuseritem.rb +36 -0
data/lib/xmpp4r/presence.rb +232 -0
data/lib/xmpp4r/pubsub.rb +8 -0
data/lib/xmpp4r/pubsub/children/configuration.rb +86 -0
data/lib/xmpp4r/pubsub/children/event.rb +49 -0
data/lib/xmpp4r/pubsub/children/item.rb +35 -0
data/lib/xmpp4r/pubsub/children/items.rb +53 -0
data/lib/xmpp4r/pubsub/children/node_config.rb +48 -0
data/lib/xmpp4r/pubsub/children/publish.rb +38 -0
data/lib/xmpp4r/pubsub/children/retract.rb +41 -0
data/lib/xmpp4r/pubsub/children/subscription.rb +62 -0
data/lib/xmpp4r/pubsub/children/subscription_config.rb +67 -0
data/lib/xmpp4r/pubsub/children/unsubscribe.rb +48 -0
data/lib/xmpp4r/pubsub/helper/nodebrowser.rb +129 -0
data/lib/xmpp4r/pubsub/helper/nodehelper.rb +156 -0
data/lib/xmpp4r/pubsub/helper/oauth_service_helper.rb +90 -0
data/lib/xmpp4r/pubsub/helper/servicehelper.rb +456 -0
data/lib/xmpp4r/pubsub/iq/pubsub.rb +19 -0
data/lib/xmpp4r/query.rb +15 -0
data/lib/xmpp4r/reliable.rb +168 -0
data/lib/xmpp4r/rexmladdons.rb +157 -0
data/lib/xmpp4r/roster.rb +7 -0
data/lib/xmpp4r/roster/helper/roster.rb +522 -0
data/lib/xmpp4r/roster/iq/roster.rb +215 -0
data/lib/xmpp4r/roster/x/roster.rb +138 -0
data/lib/xmpp4r/rpc.rb +2 -0
data/lib/xmpp4r/rpc/helper/client.rb +123 -0
data/lib/xmpp4r/rpc/helper/server.rb +74 -0
data/lib/xmpp4r/rpc/helper/xmlrpcaddons.rb +67 -0
data/lib/xmpp4r/rpc/iq/rpc.rb +23 -0
data/lib/xmpp4r/sasl.rb +248 -0
data/lib/xmpp4r/semaphore.rb +38 -0
data/lib/xmpp4r/stream.rb +599 -0
data/lib/xmpp4r/streamparser.rb +85 -0
data/lib/xmpp4r/test/listener_mocker.rb +118 -0
data/lib/xmpp4r/tune.rb +2 -0
data/lib/xmpp4r/tune/helper/helper.rb +58 -0
data/lib/xmpp4r/tune/tune.rb +113 -0
data/lib/xmpp4r/vcard.rb +6 -0
data/lib/xmpp4r/vcard/helper/vcard.rb +84 -0
data/lib/xmpp4r/vcard/iq/vcard.rb +109 -0
data/lib/xmpp4r/version.rb +7 -0
data/lib/xmpp4r/version/helper/responder.rb +72 -0
data/lib/xmpp4r/version/helper/simpleresponder.rb +44 -0
data/lib/xmpp4r/version/iq/version.rb +105 -0
data/lib/xmpp4r/x.rb +37 -0
data/lib/xmpp4r/xhtml.rb +1 -0
data/lib/xmpp4r/xhtml/html.rb +115 -0
data/lib/xmpp4r/xmpp4r.rb +20 -0
data/lib/xmpp4r/xmppelement.rb +168 -0
data/lib/xmpp4r/xmppstanza.rb +162 -0
data/setup.rb +1586 -0
data/test/bytestreams/tc_ibb.rb +188 -0
data/test/bytestreams/tc_socks5bytestreams.rb +114 -0
data/test/caps/tc_helper.rb +158 -0
data/test/dataforms/tc_data.rb +81 -0
data/test/delay/tc_xdelay.rb +51 -0
data/test/discovery/tc_responder.rb +91 -0
data/test/last/tc_helper.rb +75 -0
data/test/lib/assert_equal_xml.rb +14 -0
data/test/lib/clienttester.rb +149 -0
data/test/muc/tc_muc_mucclient.rb +834 -0
data/test/muc/tc_muc_simplemucclient.rb +114 -0
data/test/muc/tc_mucowner.rb +50 -0
data/test/pubsub/tc_helper.rb +785 -0
data/test/pubsub/tc_nodeconfig.rb +61 -0
data/test/pubsub/tc_subscriptionconfig.rb +41 -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 +524 -0
data/test/roster/tc_iqqueryroster.rb +173 -0
data/test/roster/tc_xroster.rb +73 -0
data/test/rpc/tc_helper.rb +96 -0
data/test/tc_callbacks.rb +129 -0
data/test/tc_class_names.rb +146 -0
data/test/tc_client.rb +30 -0
data/test/tc_errors.rb +146 -0
data/test/tc_idgenerator.rb +30 -0
data/test/tc_iq.rb +113 -0
data/test/tc_iqquery.rb +31 -0
data/test/tc_jid.rb +204 -0
data/test/tc_message.rb +131 -0
data/test/tc_presence.rb +150 -0
data/test/tc_rexml.rb +139 -0
data/test/tc_stream.rb +167 -0
data/test/tc_streamComponent.rb +95 -0
data/test/tc_streamError.rb +129 -0
data/test/tc_streamSend.rb +59 -0
data/test/tc_streamparser.rb +125 -0
data/test/tc_xmppstanza.rb +135 -0
data/test/ts_xmpp4r.rb +44 -0
data/test/tune/tc_helper_recv.rb +82 -0
data/test/tune/tc_helper_send.rb +74 -0
data/test/tune/tc_tune.rb +79 -0
data/test/vcard/tc_helper.rb +49 -0
data/test/vcard/tc_iqvcard.rb +62 -0
data/test/version/tc_helper.rb +60 -0
data/test/version/tc_iqqueryversion.rb +97 -0
data/test/xhtml/tc_html.rb +41 -0
data/tools/gen_requires.bash +31 -0
data/tools/xmpp4r-gemspec-test.rb +11 -0
data/xmpp4r.gemspec +238 -0
metadata +280 -0

data/lib/xmpp4r/httpbinding.rb ADDED

@@ -0,0 +1,5 @@
+# =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/httpbinding/client'

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

@@ -0,0 +1,275 @@
+# =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/
+# TODO: eval  <body type='terminate' condition=
+require 'xmpp4r/client'
+require 'xmpp4r/semaphore'
+require 'net/http'
+module Jabber
+  module HTTPBinding
+    ##
+    # This class implements an alternative Client
+    # using HTTP Binding (JEP0124).
+    #
+    # This class is designed to be a drop-in replacement
+    # for Jabber::Client, except for the
+    # Jabber::HTTP::Client#connect method which takes an URI
+    # as argument.
+    #
+    # HTTP requests are buffered to not exceed the negotiated
+    # 'polling' and 'requests' parameters.
+    #
+    # Stanzas in HTTP resonses may be delayed to arrive in the
+    # order defined by 'rid' parameters.
+    #
+    # =Debugging
+    # Turning Jabber::debug to true will make debug output
+    # not only spit out stanzas but HTTP request/response
+    # bodies, too.
+    class Client < Jabber::Client
+      # Content-Type to be used for communication
+      # (you can set this to "text/html")
+      attr_accessor :http_content_type
+      # The server should wait this value seconds if
+      # there is no stanza to be received
+      attr_accessor :http_wait
+      # The server may hold this amount of stanzas
+      # to reduce number of HTTP requests
+      attr_accessor :http_hold
+      ##
+      # Initialize
+      # jid:: [JID or String]
+      def initialize(jid)
+        super
+        @lock = Mutex.new
+        @pending_requests = 0
+        @last_send = Time.at(0)
+        @send_buffer = ''
+        @http_requests = 1
+        @http_wait = 20
+        @http_hold = 1
+        @http_content_type = 'text/xml; charset=utf-8'
+      end
+      ##
+      # Set up the stream using uri as the HTTP Binding URI
+      #
+      # You may optionally pass host and port parameters
+      # to make use of the JEP0124 'route' feature.
+      #
+      # uri:: [URI::Generic or String]
+      # host:: [String] Optional host to route to
+      # port:: [Fixnum] Port for route feature
+      def connect(uri, host=nil, port=5222)
+        uri = URI::parse(uri) unless uri.kind_of? URI::Generic
+        @uri = uri
+        @allow_tls = false  # Shall be done at HTTP level
+        @stream_mechanisms = []
+        @stream_features = {}
+        @http_rid = IdGenerator.generate_id.to_i
+        @pending_rid = @http_rid
+        @pending_rid_lock = Semaphore.new
+        req_body = REXML::Element.new('body')
+        req_body.attributes['rid'] = @http_rid
+        req_body.attributes['content'] = @http_content_type
+        req_body.attributes['hold'] = @http_hold.to_s
+        req_body.attributes['wait'] = @http_wait.to_s
+        req_body.attributes['to'] = @jid.domain
+        if host
+          req_body.attributes['route'] = "xmpp:#{host}:#{port}"
+        end
+        req_body.attributes['secure'] = 'true'
+        req_body.attributes['xmlns'] = 'http://jabber.org/protocol/httpbind'
+        res_body = post(req_body)
+        unless res_body.name == 'body'
+          raise 'Response body is no <body/> element'
+        end
+        @streamid = res_body.attributes['authid']
+        @status = CONNECTED
+        @http_sid = res_body.attributes['sid']
+        @http_wait = res_body.attributes['wait'].to_i if res_body.attributes['wait']
+        @http_hold = res_body.attributes['hold'].to_i if res_body.attributes['hold']
+        @http_inactivity = res_body.attributes['inactivity'].to_i
+        @http_polling = res_body.attributes['polling'].to_i
+        @http_polling = 5 if @http_polling == 0
+        @http_requests = res_body.attributes['requests'].to_i
+        @http_requests = 1 if @http_requests == 0
+        receive_elements_with_rid(@http_rid, res_body.children)
+        @features_sem.run
+      end
+      ##
+      # Ensure that there is one pending request
+      #
+      # Will be automatically called if you've sent
+      # a stanza.
+      def ensure_one_pending_request
+        return if is_disconnected?
+        if @lock.synchronize { @pending_requests } < 1
+          send_data('')
+        end
+      end
+      ##
+      # Close the session by sending
+      # <presence type='unavailable'/>
+      def close
+        @status = DISCONNECTED
+        send(Jabber::Presence.new.set_type(:unavailable))
+      end
+      private
+      ##
+      # Receive stanzas ensuring that the 'rid' order is kept
+      # result:: [REXML::Element]
+      def receive_elements_with_rid(rid, elements)
+        while rid > @pending_rid
+          @pending_rid_lock.wait
+        end
+        @pending_rid = rid + 1
+        elements.each { |e|
+          receive(e)
+        }
+        @pending_rid_lock.run
+      end
+      ##
+      # Do a POST request
+      def post(body)
+        body = body.to_s
+        request = Net::HTTP::Post.new(@uri.path)
+        request.content_length = body.size
+        request.body = body
+        request['Content-Type'] = @http_content_type
+        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 + 1}/#{@http_requests}): #{response.class}\n#{response.body}")
+        unless response.kind_of? Net::HTTPSuccess
+          # Unfortunately, HTTPResponses aren't exceptions
+          # TODO: rescue'ing code should be able to distinguish
+          raise Net::HTTPBadResponse, "#{response.class}"
+        end
+        body = REXML::Document.new(response.body).root
+        if body.name != 'body' and body.namespace != 'http://jabber.org/protocol/httpbind'
+          raise REXML::ParseException.new('Malformed body')
+        end
+        body
+      end
+      ##
+      # Prepare data to POST and
+      # handle the result
+      def post_data(data)
+        req_body = nil
+        current_rid = nil
+        begin
+          begin
+            @lock.synchronize {
+              # Do not send unneeded requests
+              if data.size < 1 and @pending_requests > 0
+                return
+              end
+              req_body = "<body"
+              req_body += " rid='#{@http_rid += 1}'"
+              req_body += " sid='#{@http_sid}'"
+              req_body += " xmlns='http://jabber.org/protocol/httpbind'"
+              req_body += ">"
+              req_body += data
+              req_body += "</body>"
+              current_rid = @http_rid
+              @pending_requests += 1
+              @last_send = Time.now
+            }
+            res_body = post(req_body)
+          ensure
+            @lock.synchronize { @pending_requests -= 1 }
+          end
+          receive_elements_with_rid(current_rid, res_body.children)
+          ensure_one_pending_request
+        rescue REXML::ParseException
+          if @exception_block
+            Thread.new do
+              Thread.current.abort_on_exception = true
+              close; @exception_block.call(e, self, :parser)
+            end
+          else
+            Jabber::debuglog "Exception caught when parsing HTTP response!"
+            close
+            raise
+          end
+        rescue StandardError => e
+          Jabber::debuglog("POST error (will retry): #{e.class}: #{e}")
+          receive_elements_with_rid(current_rid, [])
+          # It's not good to resend on *any* exception,
+          # but there are too many cases (Timeout, 404, 502)
+          # where resending is appropriate
+          # TODO: recognize these conditions and act appropriate
+          send_data(data)
+        end
+      end
+      ##
+      # Send data,
+      # buffered and obeying 'polling' and 'requests' limits
+      def send_data(data)
+        @lock.synchronize do
+          @send_buffer += data
+          limited_by_polling = (@last_send + @http_polling >= Time.now)
+          limited_by_requests = (@pending_requests + 1 > @http_requests)
+          # Can we send?
+          if !limited_by_polling and !limited_by_requests
+            data = @send_buffer
+            @send_buffer = ''
+            Thread.new do
+              Thread.current.abort_on_exception = true
+              post_data(data)
+            end
+          elsif !limited_by_requests
+            Thread.new do
+              Thread.current.abort_on_exception = true
+              # Defer until @http_polling has expired
+              wait = @last_send + @http_polling - Time.now
+              sleep(wait) if wait > 0
+              # Ignore locking, it's already threaded ;-)
+              send_data('')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/xmpp4r/idgenerator.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 'singleton'
+module Jabber
+  ##
+  # The Jabber::IdGenerator class generates unique IDs for use
+  # in XMMP stanzas. Jabber::IdGenerator includes the Singleton
+  # Mixin, usage as following:
+  #  Jabber::IdGenerator.generate_id
+  #    => "23"
+  class IdGenerator
+    include Singleton
+    def initialize
+      @last_id = 0
+    end
+    ##
+    # Generate an unique ID.
+    #
+    # This is kind of boring this way, as it just counts up
+    # a number. Maybe something more random somewhen...
+    def IdGenerator.generate_id
+      IdGenerator.instance.generate_id
+    end
+    def generate_id
+      @last_id += 1
+      timefrac = Time.new.to_f.to_s.split(/\./, 2).last[-3..-1]
+      "#{@last_id}#{timefrac}"
+    end
+  end
+end

data/lib/xmpp4r/iq.rb ADDED

@@ -0,0 +1,221 @@
+# =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/jid'
+require 'digest/sha1'
+require 'xmpp4r/query'
+require 'xmpp4r/vcard/iq/vcard'
+module Jabber
+  ##
+  # IQ: Information/Query
+  # (see RFC3920 - 9.2.3
+  #
+  # A class used to build/parse IQ requests/responses
+  class Iq < XMPPStanza
+    name_xmlns 'iq', 'jabber:client'
+    force_xmlns true
+    @@element_classes = {}
+    ##
+    # Build a new <iq/> stanza
+    # type:: [Symbol] or nil, see Iq#type
+    # to:: [JID] Recipient
+    def initialize(type = nil, to = nil)
+      super()
+      if not to.nil?
+        set_to(to)
+      end
+      if not type.nil?
+        set_type(type)
+      end
+    end
+    ##
+    # Get the type of the Iq stanza
+    #
+    # The following values are allowed:
+    # * :get
+    # * :set
+    # * :result
+    # * :error
+    # result:: [Symbol] or nil
+    def type
+      case super
+        when 'get' then :get
+        when 'set' then :set
+        when 'result' then :result
+        when 'error' then :error
+        else nil
+      end
+    end
+    ##
+    # Set the type of the Iq stanza (see Iq#type)
+    # v:: [Symbol] or nil
+    def type=(v)
+      case v
+        when :get then super('get')
+        when :set then super('set')
+        when :result then super('result')
+        when :error then super('error')
+        else super(nil)
+      end
+    end
+    ##
+    # Set the type of the Iq stanza (chaining-friendly)
+    # v:: [Symbol] or nil
+    def set_type(v)
+      self.type = v
+      self
+    end
+    ##
+    # Returns the iq's query child, or nil
+    # result:: [IqQuery]
+    def query
+      first_element('query')
+    end
+    ##
+    # Delete old elements named newquery.name
+    #
+    # newquery:: [REXML::Element] will be added
+    def query=(newquery)
+      delete_elements(newquery.name)
+      add(newquery)
+    end
+    ##
+    # Returns the iq's query's namespace, or nil
+    # result:: [String]
+    def queryns
+      e = first_element('query')
+      if e
+        return e.namespace
+      else
+        return nil
+      end
+    end
+    ##
+    # Returns the iq's <vCard/> child, or nil
+    # result:: [IqVcard]
+    def vcard
+      first_element('vCard')
+    end
+    ##
+    # Returns the iq's <pubsub/> child, or nil
+    # result:: [IqVcard]
+    def pubsub
+      first_element('pubsub')
+    end
+    ##
+    # Returns the iq's <command/> child, or nil
+    # resulte:: [IqCommand]
+    def command
+      first_element("command")
+    end
+    ##
+    # 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.add(query)
+      iq
+    end
+    ##
+    # Create a new jabber:iq:auth set Stanza.
+    def Iq.new_authset(jid, password)
+      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?
+      iq.add(query)
+      iq
+    end
+    ##
+    # 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
+      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?
+      iq.add(query)
+      iq
+    end
+    ##
+    # Create a new jabber:iq:register set stanza for service/server registration
+    # 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
+      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')
+      iq.add(query)
+      iq
+    end
+    ##
+    # Create a new jabber:iq:roster get Stanza.
+    #
+    # IqQueryRoster is unused here because possibly not require'd
+    def Iq.new_rosterget
+      iq = Iq.new(:get)
+      query = IqQuery.new
+      query.add_namespace('jabber:iq:roster')
+      iq.add(query)
+      iq
+    end
+    ##
+    # Create a new jabber:iq:roster get Stanza.
+    def Iq.new_browseget
+      iq = Iq.new(:get)
+      query = IqQuery.new
+      query.add_namespace('jabber:iq:browse')
+      iq.add(query)
+      iq
+    end
+    ##
+    # Create a new jabber:iq:roster set Stanza.
+    def Iq.new_rosterset
+      iq = Iq.new(:set)
+      query = IqQuery.new
+      query.add_namespace('jabber:iq:roster')
+      iq.add(query)
+      iq
+    end
+  end
+end