summaryrefslogtreecommitdiff
path: root/sleekxmpp/plugins/xep_0332/stanza
diff options
context:
space:
mode:
Diffstat (limited to 'sleekxmpp/plugins/xep_0332/stanza')
-rw-r--r--sleekxmpp/plugins/xep_0332/stanza/__init__.py3
-rw-r--r--sleekxmpp/plugins/xep_0332/stanza/request.py40
-rw-r--r--sleekxmpp/plugins/xep_0332/stanza/response.py37
3 files changed, 66 insertions, 14 deletions
diff --git a/sleekxmpp/plugins/xep_0332/stanza/__init__.py b/sleekxmpp/plugins/xep_0332/stanza/__init__.py
index 5d686710..5d9283c7 100644
--- a/sleekxmpp/plugins/xep_0332/stanza/__init__.py
+++ b/sleekxmpp/plugins/xep_0332/stanza/__init__.py
@@ -8,5 +8,4 @@
See the file LICENSE for copying permission.
"""
-from sleekxmpp.plugins.xep_0332.stanza.request import *
-from sleekxmpp.plugins.xep_0332.stanza.response import *
+NAMESPACE = 'urn:xmpp:http'
diff --git a/sleekxmpp/plugins/xep_0332/stanza/request.py b/sleekxmpp/plugins/xep_0332/stanza/request.py
index 3d75b534..ea2650c0 100644
--- a/sleekxmpp/plugins/xep_0332/stanza/request.py
+++ b/sleekxmpp/plugins/xep_0332/stanza/request.py
@@ -8,14 +8,42 @@
See the file LICENSE for copying permission.
"""
-from sleekxmpp import Iq
-from sleekxmpp.xmlstream import ElementBase, register_stanza_plugin
-from sleekxmpp.plugins.xep_0131.stanza import Headers
+from sleekxmpp.xmlstream import ElementBase
+from sleekxmpp.plugins.xep_0332.stanza import NAMESPACE
class Request(ElementBase):
- pass
+ """
+ All HTTP communication is done using the `Request`/`Response` paradigm.
+ Each HTTP Request is made sending an `iq` stanza containing a `req` element
+ to the server. Each `iq` stanza sent is of type `set`.
+
+ Examples:
+ <iq type='set' from='a@b.com/browser' to='x@y.com' id='1'>
+ <req xmlns='urn:xmpp:http' method='GET' resource='/api/user' version='1.1'>
+ <headers xmlns='http://jabber.org/protocol/shim'>
+ <header name='Host'>b.com</header>
+ </headers>
+ </req>
+ </iq>
+
+ <iq type='set' from='a@b.com/browser' to='x@y.com' id='2'>
+ <req xmlns='urn:xmpp:http' method='PUT' resource='/api/users' version='1.1'>
+ <headers xmlns='http://jabber.org/protocol/shim'>
+ <header name='Host'>b.com</header>
+ <header name='Content-Type'>text/html</header>
+ <header name='Content-Length'>...</header>
+ </headers>
+ <data>
+ <text>&lt;html&gt;&lt;header/&gt;&lt;body&gt;&lt;p&gt;Beautiful home page.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</text>
+ </data>
+ </req>
+ </iq>
+ """
+
+ name = 'request'
+ namespace = NAMESPACE
+ interfaces = set(('method', 'resource', 'version'))
+ plugin_attrib = 'req'
-register_stanza_plugin(Iq, Request)
-register_stanza_plugin(Request, Headers)
diff --git a/sleekxmpp/plugins/xep_0332/stanza/response.py b/sleekxmpp/plugins/xep_0332/stanza/response.py
index 7f8180bb..4dc14344 100644
--- a/sleekxmpp/plugins/xep_0332/stanza/response.py
+++ b/sleekxmpp/plugins/xep_0332/stanza/response.py
@@ -8,14 +8,39 @@
See the file LICENSE for copying permission.
"""
-from sleekxmpp import Iq
-from sleekxmpp.xmlstream import ElementBase, register_stanza_plugin
-from sleekxmpp.plugins.xep_0131.stanza import Headers
+from sleekxmpp.xmlstream import ElementBase
+from sleekxmpp.plugins.xep_0332.stanza import NAMESPACE
class Response(ElementBase):
- pass
+ """
+ When the HTTP Server responds, it does so by sending an `iq` stanza
+ response (type=`result`) back to the client containing the `resp` element.
+ Since response are asynchronous, and since multiple requests may be active
+ at the same time, responses may be returned in a different order than the
+ in which the original requests were made.
-register_stanza_plugin(Iq, Response)
-register_stanza_plugin(Response, Headers)
+ Examples:
+ <iq type='result' from='httpserver@clayster.com' to='httpclient@clayster.com/browser' id='2'>
+ <resp xmlns='urn:xmpp:http' version='1.1' statusCode='200' statusMessage='OK'>
+ <headers xmlns='http://jabber.org/protocol/shim'>
+ <header name='Date'>Fri, 03 May 2013 16:39:54GMT-4</header>
+ <header name='Server'>Clayster</header>
+ <header name='Content-Type'>text/turtle</header>
+ <header name='Content-Length'>...</header>
+ <header name='Connection'>Close</header>
+ </headers>
+ <data>
+ <text>
+ ...
+ </text>
+ </data>
+ </resp>
+ </iq>
+ """
+
+ name = 'response'
+ namespace = NAMESPACE
+ interfaces = set(('statusCode', 'statusMessage', 'version'))
+ plugin_attrib = 'resp'