Merge pull request #222 from dataiku/feature/dss100-sc-80908-per-user-last-activity

[sc-80908] new PAPI to retrieve a user's last activity

Author: NawreCode

dataikuapi/dss/admin.py

@@ -1,3 +1,5 @@
+import datetime
+
 from .future import DSSFuture
 import json, warnings
 
@@ -164,11 +166,22 @@ def delete(self):
     def get_settings(self):
         """
         Gets the settings of the user
+
         :rtype: :class:`DSSUserSettings`
         """
         raw = self.client._perform_json("GET", "/admin/users/%s" % self.login)
         return DSSUserSettings(self.client, self.login, raw)
 
+    def get_activity(self):
+        """
+        Gets the activity of the user
+
+        :return: the user's activity
+        :rtype: :class:`DSSUserActivity`
+        """
+        activity = self.client._perform_json("GET", "/admin/users/%s/activity" % self.login)
+        return DSSUserActivity(self.client, self.login, activity)
+
     ########################################################
     # Legacy
     ########################################################
@@ -224,6 +237,7 @@ def get_client_as(self):
         else:
             raise ValueError("Don't know how to proxy this client")
 
+
 class DSSOwnUser(object):
     """
     A handle to interact with your own user
@@ -250,8 +264,7 @@ def __init__(self, settings):
 
     def get_raw(self):
         """
-        :return: the raw settings of the user, as a dict. Modifications made to the returned object 
-        are reflected when saving
+        :return: the raw settings of the user, as a dict. Modifications made to the returned object are reflected when saving
         :rtype: dict
         """
         return self.settings
@@ -331,15 +344,15 @@ def admin_properties(self):
         """
         The user properties (not editable by the user) for this user. Do not set this property, modify the dict in place
 
-        :rtype dict
+        :rtype: dict
         """
         return self.settings["adminProperties"]
 
     @property
     def enabled(self):
         """
         Whether this user is enabled
-        :rtype boolean
+        :rtype: boolean
         """
         return self.settings["enabled"]
 
@@ -365,6 +378,67 @@ def save(self):
         self.client._perform_empty("PUT", "/current-user", body = self.settings)
 
 
+class DSSUserActivity(object):
+    """
+    Activity for a DSS user.
+    Do not call this directly, use :meth:`DSSUser.get_activity` or :meth:`DSSClient.list_users_activity`
+    """
+
+    def __init__(self, client, login, activity):
+        self.client = client
+        self.login = login
+        self.activity = activity
+
+    def get_raw(self):
+        """
+        Get the raw activity of the user as a dict.
+
+        :return: the raw activity
+        :rtype: dict
+        """
+        return self.activity
+
+    @property
+    def last_successful_login(self):
+        """
+        Get the last successful login of the user as a :class:`datetime.datetime`
+        
+        Returns None if there was no successful login for this user.
+
+        :return: the last successful login
+        :rtype: :class:`datetime.datetime` or None
+        """
+        timestamp = self.activity["lastSuccessfulLogin"]
+        return datetime.datetime.fromtimestamp(timestamp / 1000) if timestamp > 0 else None
+
+    @property
+    def last_failed_login(self):
+        """
+        Get the last failed login of the user as a :class:`datetime.datetime`
+
+        Returns None if there were no failed login for this user.
+
+        :return: the last failed login
+        :rtype: :class:`datetime.datetime` or None
+        """
+        timestamp = self.activity["lastFailedLogin"]
+        return datetime.datetime.fromtimestamp(timestamp / 1000) if timestamp > 0 else None
+
+    @property
+    def last_session_activity(self):
+        """
+        Get the last session activity of the user as a :class:`datetime.datetime`, i.e. the last time
+        the user opened a new DSS tab or refreshed his session.
+
+        Returns None if there is no session activity yet.
+
+        :return: the last session activity
+        :rtype: :class:`datetime.datetime` or None
+        """
+        timestamp = self.activity["lastSessionActivity"]
+        return datetime.datetime.fromtimestamp(timestamp / 1000) if timestamp > 0 else None
+
+
 class DSSGroup(object):
     """
     A group on the DSS instance.

dataikuapi/dss/scenario.py

@@ -134,15 +134,17 @@ def get_run(self, run_id):
     def get_status(self):
         """
         Returns the status of this scenario
-        :rtype :class:`DSSScenarioStatus`
+
+        :rtype: :class:`DSSScenarioStatus`
         """
         data = self.client._perform_json("GET", "/projects/%s/scenarios/%s/light" % (self.project_key, self.id))
         return DSSScenarioStatus(self, data)
 
     def get_settings(self):
         """
         Returns the settings of this scenario
-        :rtype :class:`StepBasedDSSScenarioSettings` or :class:`PythonScriptBasedScenarioSettings`
+
+        :rtype: :class:`StepBasedScenarioSettings` or :class:`PythonScriptBasedScenarioSettings`
         """
         data = self.client._perform_json("GET", "/projects/%s/scenarios/%s" % (self.project_key, self.id))
 

dataikuapi/dssclient.py

@@ -10,7 +10,7 @@
 from .dss.project import DSSProject
 from .dss.app import DSSApp
 from .dss.plugin import DSSPlugin
-from .dss.admin import DSSUser, DSSOwnUser, DSSGroup, DSSConnection, DSSGeneralSettings, DSSCodeEnv, DSSGlobalApiKey, DSSCluster, DSSGlobalUsageSummary, DSSInstanceVariables
+from .dss.admin import DSSUser, DSSUserActivity, DSSOwnUser, DSSGroup, DSSConnection, DSSGeneralSettings, DSSCodeEnv, DSSGlobalApiKey, DSSCluster, DSSGlobalUsageSummary, DSSInstanceVariables
 from .dss.meaning import DSSMeaning
 from .dss.sqlquery import DSSSQLQuery
 from .dss.discussion import DSSObjectDiscussions
@@ -329,17 +329,21 @@ def sql_query(self, query, connection=None, database=None, dataset_full_name=Non
     # Users
     ########################################################
 
-    def list_users(self):
+    def list_users(self, as_objects=False):
         """
         List all users setup on the DSS instance
 
         Note: this call requires an API key with admin rights
 
-        :return: A list of users, as a list of dicts
-        :rtype: list of dicts
+        :return: A list of users, as a list of :class:`dataikuapi.dss.admin.DSSUser` if as_objects is True, else as a list of dicts
+        :rtype: list of :class:`dataikuapi.dss.admin.DSSUser` or list of dicts
         """
-        return self._perform_json(
-            "GET", "/admin/users/")
+        users = self._perform_json("GET", "/admin/users/")
+
+        if as_objects:
+            return [DSSUser(self, user["login"]) for user in users]
+        else:
+            return users
 
     def get_user(self, login):
         """
@@ -382,6 +386,23 @@ def create_user(self, login, password, display_name='', source_type='LOCAL', gro
     def get_own_user(self):
         return DSSOwnUser(self)
 
+    def list_users_activity(self, enabled_users_only=False):
+        """
+        List all users activity
+
+        Note: this call requires an API key with admin rights
+
+        :return: A list of user activity logs, as a list of :class:`dataikuapi.dss.admin.DSSUserActivity` if as_objects is True, else as a list of dict
+        :rtype: list of :class:`dataikuapi.dss.admin.DSSUserActivity` or a list of dict
+        """
+        params = {
+            "enabledUsersOnly": enabled_users_only
+        }
+        all_activity = self._perform_json("GET", "/admin/users-activity", params=params)
+
+        return [DSSUserActivity(self, user_activity["login"], user_activity) for user_activity in all_activity]
+
+
     ########################################################
     # Groups
     ########################################################