Python 3 support

README.rst

@@ -5,7 +5,7 @@ Matrix Client SDK for Python
   :target: https://pypi.python.org/pypi/matrix-client/
   :alt: Latest Version
 
-This is a Matrix client-server SDK for Python 2.x.
+This is a Matrix client-server SDK for Python 2.x and 3.x.
 
 Usage
 =====
@@ -49,3 +49,12 @@ transaction ID (``txn_id``) which will be incremented for each request.
 Client
 ------
 This encapsulates the API module and provides object models such as ``Room``. 
+
+Samples
+=======
+A collection of samples are included, written in Python 3.
+
+To start a sample without having to install the sdk run:
+
+    startSample.sh samplefilename.py
+

matrix_client/api.py

@@ -16,10 +16,12 @@
 import json
 import re
 import requests
-import urllib
+
 try:
     import urlparse
+    from urllib import quote
 except ImportError:
+    from urllib.parse import quote
     import urllib.parse as urlparse  # For python 3
 
 class MatrixError(Exception):
@@ -130,7 +132,7 @@ def join_room(self, room_id_or_alias):
         if not room_id_or_alias:
             raise MatrixError("No alias or room ID to join.")
 
-        path = "/join/%s" % urllib.quote(room_id_or_alias)
+        path = "/join/%s" % quote(room_id_or_alias)
 
         return self._send("POST", path)
 
@@ -159,10 +161,10 @@ def send_state_event(self, room_id, event_type, content, state_key=""):
             state_key(str): Optional. The state key for the event.
         """
         path = ("/rooms/%s/state/%s" %
-            (urllib.quote(room_id), urllib.quote(event_type))
+            (urlparse.quote(room_id), urlparse.quote(event_type))
         )
         if state_key:
-            path += "/%s" % (urllib.quote(state_key))
+            path += "/%s" % (quote(state_key))
         return self._send("PUT", path, content)
 
     def send_message_event(self, room_id, event_type, content, txn_id=None):
@@ -180,11 +182,24 @@ def send_message_event(self, room_id, event_type, content, txn_id=None):
         self.txn_id = self.txn_id + 1
 
         path = ("/rooms/%s/send/%s/%s" %
-            (urllib.quote(room_id), urllib.quote(event_type),
-             urllib.quote(unicode(txn_id)))
+            (quote(room_id), quote(event_type), quote(str(txn_id)))
         )
         return self._send("PUT", path, content)
 
+    # content_type can be a image,audio or video
+    # extra information should be supplied, see https://matrix.org/docs/spec/r0.0.1/client_server.html
+    def send_content(self,room_id, item_url,item_name,item_type,extra_information=None):
+        if extra_information == None:
+            extra_information = {}
+
+        content_pack = {
+            "url":item_url,
+            "msgtype":"m."+item_type,
+            "body":item_name,
+            "info":extra_information
+        }
+        return self.send_message_event(room_id,"m.room.message",content_pack)
+
     def send_message(self, room_id, text_content, msgtype="m.text"):
         """Perform /rooms/$room_id/send/m.room.message
 
@@ -302,7 +317,7 @@ def get_emote_body(self, text):
             "body": text
         }
 
-    def _send(self, method, path, content=None, query_params={}, headers={}):
+    def _send(self, method, path, content=None, query_params={}, headers={},content_type="application/json"):
         method = method.upper()
         if method not in ["GET", "PUT", "DELETE", "POST"]:
             raise MatrixError("Unsupported HTTP method: %s" % method)
@@ -323,3 +338,21 @@ def _send(self, method, path, content=None, query_params={}, headers={}):
             )
 
         return response.json()
+
+    def media_upload(self,content,content_type):
+        query_params = {"access_token":self.token}
+        headers = {"Content-Type":content_type}
+        endpoint = self.url.replace( "/_matrix/client/api/v1","/_matrix/media/r0/upload")
+
+        response = requests.request(
+            "POST", endpoint, params=query_params,
+            data=content, headers=headers
+            , verify=self.validate_cert  #if you want to use SSL without verifying the Cert
+        )
+
+        if response.status_code < 200 or response.status_code >= 300:
+            raise MatrixRequestError(
+                code=response.status_code, content=response.text
+            )
+
+        return response.json()

matrix_client/client.py

@@ -127,6 +127,10 @@ def start_listener_thread(self, timeout=30000):
             e = sys.exc_info()[0]
             print("Error: unable to start thread. " + str(e))
 
+    def upload(self,content,content_type):
+        response = self.api.media_upload(content,content_type)["content_uri"]
+        return response
+
     def _mkroom(self, room_id):
         self.rooms[room_id] = Room(self, room_id)
         return self.rooms[room_id]
@@ -171,6 +175,15 @@ def send_text(self, text):
     def send_emote(self, text):
         return self.client.api.send_emote(self.room_id, text)
 
+    def send_image(self,url,name,size,mimetype,width=500,height=500):
+        extra_info = {
+            'size':size,
+            'mimetype':mimetype,
+            'width':width,
+            'height':height
+        }
+        return self.client.api.send_content(self.room_id, url,name,"image",extra_info)
+
     def add_listener(self, callback):
         self.listeners.append(callback)
 
@@ -256,4 +269,3 @@ def update_aliases(self):
                         return False
         except MatrixRequestError:
             return False
-

samples/SimpleChatClient.py

@@ -0,0 +1,75 @@
+#!/bin/env python3
+from matrix_client.client import MatrixClient
+from matrix_client.api import MatrixRequestError
+from requests.exceptions import MissingSchema
+
+from getpass import getpass
+
+import sys
+
+def on_message(event):
+    if event['type'] == "m.room.member":
+        if event['membership'] == "join":
+            print("{0} joined".format(event['content']['displayname']))
+    elif event['type'] == "m.room.message":
+        if event['content']['msgtype'] == "m.text":
+            print("{0}: {1}".format(event['sender'],event['content']['body']))
+    else:
+        print(event['type'])
+
+host = "";
+username = "";
+room = "";
+
+if len(sys.argv) > 1:
+    host = sys.argv[1]
+else:
+    host = input("Host (ex: http://localhost:8008 ): ")
+
+client = MatrixClient(host)
+
+if len(sys.argv) > 2:
+    username = sys.argv[2]
+else:
+    username = input("Username: ")
+
+password = getpass() #Hide user input
+
+try:
+    client.login_with_password(username,password)
+except MatrixRequestError as e:
+    if e.code == 403:
+        print("Bad username or password.")
+    else:
+        print("Check your sever details are correct.")
+    sys.exit(e.code)
+except MissingSchema:
+    print("Bad URL format.")
+    sys.exit(1)
+
+room = None
+if len(sys.argv) > 3:
+    room = sys.argv[3]
+else:
+    room = input("Room ID/Alias: ")
+
+try:
+    room = client.join_room(room)
+except MatrixRequestError as e:
+    if e.code == 400:
+        print("Room ID/Alias in the wrong format")
+    else:
+        print("Couldn't find room.")
+    sys.exit(2)
+
+room.add_listener(on_message)
+client.start_listener_thread()
+
+
+shouldRun = True
+while shouldRun:
+    msg = input()
+    if msg == "/quit":
+        shouldRun = False
+    else:
+        room.send_text(msg)

samples/startSample.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+if [ "$1" == "-h" ] || [ $# -lt 1 ]; then
+  echo "Usage: `basename $0` scriptname [OPTIONS] "
+  exit 0
+fi
+
+# Will run a sample without requiring an install of the library.
+PYTHONPATH="$(dirname $( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd ))"
+export PYTHONPATH=$PYTHONPATH
+python "$@"