Merge pull request #345 from sangeeths/xep_0332

XEP-0332: HTTP over XMPP transport

4 files changed, 169 insertions, 0 deletions

diff --git a/sleekxmpp/plugins/xep_0332/stanza/__init__.py b/sleekxmpp/plugins/xep_0332/stanza/__init__.py
new file mode 100644
index 00000000..eeab3f31
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0332/stanza/__init__.py
@@ -0,0 +1,13 @@
+"""
+    SleekXMPP: The Sleek XMPP Library
+    Implementation of HTTP over XMPP transport
+    http://xmpp.org/extensions/xep-0332.html
+    Copyright (C) 2015 Riptide IO, sangeeth@riptideio.com
+    This file is part of SleekXMPP.
+
+    See the file LICENSE for copying permission.
+"""
+
+from sleekxmpp.plugins.xep_0332.stanza.request import Request
+from sleekxmpp.plugins.xep_0332.stanza.response import Response
+from sleekxmpp.plugins.xep_0332.stanza.data import Data
diff --git a/sleekxmpp/plugins/xep_0332/stanza/data.py b/sleekxmpp/plugins/xep_0332/stanza/data.py
new file mode 100644
index 00000000..9a08426b
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0332/stanza/data.py
@@ -0,0 +1,30 @@
+"""
+    SleekXMPP: The Sleek XMPP Library
+    Implementation of HTTP over XMPP transport
+    http://xmpp.org/extensions/xep-0332.html
+    Copyright (C) 2015 Riptide IO, sangeeth@riptideio.com
+    This file is part of SleekXMPP.
+
+    See the file LICENSE for copying permission.
+"""
+
+from sleekxmpp.xmlstream import ElementBase
+
+
+class Data(ElementBase):
+    """
+    The data element.
+    """
+    name = 'data'
+    namespace = 'urn:xmpp:http'
+    interfaces = set(['data'])
+    plugin_attrib = 'data'
+    is_extension = True
+
+    def get_data(self, encoding='text'):
+        data = self._get_sub_text(encoding, None)
+        return str(data) if data is not None else data
+
+    def set_data(self, data, encoding='text'):
+        self._set_sub_text(encoding, text=data)
+
diff --git a/sleekxmpp/plugins/xep_0332/stanza/request.py b/sleekxmpp/plugins/xep_0332/stanza/request.py
new file mode 100644
index 00000000..07618727
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0332/stanza/request.py
@@ -0,0 +1,65 @@
+"""
+    SleekXMPP: The Sleek XMPP Library
+    Implementation of HTTP over XMPP transport
+    http://xmpp.org/extensions/xep-0332.html
+    Copyright (C) 2015 Riptide IO, sangeeth@riptideio.com
+    This file is part of SleekXMPP.
+
+    See the file LICENSE for copying permission.
+"""
+
+from sleekxmpp.xmlstream import ElementBase
+
+
+class Request(ElementBase):
+
+    """
+    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/users' 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>...</text>
+            </data>
+        </req>
+    </iq>
+    """
+
+    name = 'request'
+    namespace = 'urn:xmpp:http'
+    interfaces = set(['method', 'resource', 'version'])
+    plugin_attrib = 'req'
+
+    def get_method(self):
+        return self._get_attr('method', None)
+
+    def set_method(self, method):
+        self._set_attr('method', method)
+
+    def get_resource(self):
+        return self._get_attr('resource', None)
+
+    def set_resource(self, resource):
+        self._set_attr('resource', resource)
+
+    def get_version(self):
+        return self._get_attr('version', None)
+
+    def set_version(self, version='1.1'):
+        self._set_attr('version', version)
diff --git a/sleekxmpp/plugins/xep_0332/stanza/response.py b/sleekxmpp/plugins/xep_0332/stanza/response.py
new file mode 100644
index 00000000..0fc46de8
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0332/stanza/response.py
@@ -0,0 +1,61 @@
+"""
+    SleekXMPP: The Sleek XMPP Library
+    Implementation of HTTP over XMPP transport
+    http://xmpp.org/extensions/xep-0332.html
+    Copyright (C) 2015 Riptide IO, sangeeth@riptideio.com
+    This file is part of SleekXMPP.
+
+    See the file LICENSE for copying permission.
+"""
+
+from sleekxmpp.xmlstream import ElementBase
+
+
+class Response(ElementBase):
+
+    """
+    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.
+
+    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 = 'urn:xmpp:http'
+    interfaces = set(['code', 'message', 'version'])
+    plugin_attrib = 'resp'
+
+    def get_code(self):
+        code = self._get_attr('statusCode', None)
+        return int(code) if code is not None else code
+
+    def set_code(self, code):
+        self._set_attr('statusCode', str(code))
+
+    def get_message(self):
+        return self._get_attr('statusMessage', '')
+
+    def set_message(self, message):
+        self._set_attr('statusMessage', message)
+
+    def set_version(self, version='1.1'):
+        self._set_attr('version', version)