Add support for personal access tokens

#8

CHANGELOG.rst

@@ -1,3 +1,7 @@
+2.2.0
+'''''
+Support for personal access tokens and MFA Token.
+
 2.0.0
 '''''
 

README.rst

@@ -45,6 +45,8 @@ Usage
         'url': 'mattermost.server.com',
         'login_id': 'user.name',
         'password': 'verySecret',
+        # Instead of login/password you can also use a personal access token
+        'token': 'YourPersonalAccessToken',
         # Optional / defaults to
         'scheme': 'https',
         'port': 8065,
@@ -53,11 +55,15 @@ Usage
         'verify': True,
         # The interval the websocket will ping the server to keep the connection alive
         'timeout': 30,
+        'mfa_token': 'YourMFAToken'
     })
 
     # Most of the requests need you to be logged in, so calling login()
     # should be the first thing you do after you created your Driver instance.
     # login() returns the raw response
+    # If using a personal access token, you still need to run login().
+    # In this case, does not make a login request, but a `get_user('me')`
+    # and sets everything up in the client.
     foo.login()
 
     # You can make api calls by using api['yourendpointofchoice'].
@@ -108,21 +114,24 @@ Usage
 Available endpoints:
 ''''''''''''''''''''
 
--  users
--  teams
+-  base
+-  brand
 -  channels
--  posts
--  files
--  preferences
--  system
--  webhooks
+-  cluster
 -  commands
 -  compliance
--  cluster
--  brand
+-  elasticsearch
+-  emoji
+-  files
+-  ldap
 -  oauth
+-  posts
+-  preferences
 -  saml
--  ldap
+-  system
+-  teams
+-  users
+-  webhooks
 
 See https://api.mattermost.com/v4/ to see which api requests are
 available.

src/mattermostdriver/driver.py

@@ -40,18 +40,24 @@ class Driver:
 		'timeout': 30,
 		'login_id': None,
 		'password': None,
+		'token': None,
+		'mfa_token': None
 	}
 	"""
 	Required:
+		Either
 		- login_id
 		- password
-	
+		Or
+		- token (https://docs.mattermost.com/developer/personal-access-tokens.html)
+
 	Optional:
 		- scheme
 		- url (though it would be a good idea to change that)
 		- port
 		- verify
 		- timeout
+		- mfa_token
 	
 	Should not be changed:
 		- basepath - unlikeliy this would do any good
@@ -120,18 +126,26 @@ def login(self):
 
 		:return: The raw response from the request
 		"""
-		result = self.api['users'].login_user({
-			'login_id': self.options['login_id'],
-			'password': self.options['password'],
-		})
+		if self.options['token']:
+			self.client.token = self.options['token']
+			result = self.api['users'].get_user('me')
+		else:
+			result = self.api['users'].login_user({
+				'login_id': self.options['login_id'],
+				'password': self.options['password'],
+				'token': self.options['mfa_token']
+			})
+			if result.status_code == 200:
+				self.client.token = result.headers['Token']
+				self.client.cookies = result.cookies
+
 		log.debug(result)
-		if result.status_code == 200:
-			self.client.token = result.headers['Token']
-			self.client.cookies = result.cookies
-			if 'id' in result:
-				self.client.userid = result['id']
-			if 'username' in result:
-				self.client.username = result['username']
+
+		if 'id' in result:
+			self.client.userid = result['id']
+		if 'username' in result:
+			self.client.username = result['username']
+
 		return result
 
 	def logout(self):

src/mattermostdriver/version.py

@@ -1,2 +1,2 @@
-full_version = '2.1.4'
+full_version = '2.2.0'
 short_version = '.'.join(full_version.split('.', 2)[:2])