Merge branch 'testing' into build/python3-migration

1 files changed, 83 insertions, 35 deletions

diff --git a/wqflask/utility/redis_tools.py b/wqflask/utility/redis_tools.py
index 4aba2b70..d855a7fa 100644
--- a/wqflask/utility/redis_tools.py
+++ b/wqflask/utility/redis_tools.py
@@ -2,23 +2,21 @@ import uuid
 import simplejson as json
 import datetime
 
-import redis # used for collections
-
-import logging
-
-from flask import (render_template, flash)
-
-from utility import hmac
+import redis  # used for collections
 
+from utility.hmac import hmac_creation
 from utility.logger import getLogger
 logger = getLogger(__name__)
 
+
 def get_redis_conn():
     Redis = redis.StrictRedis(port=6379)
     return Redis
 
+
 Redis = get_redis_conn()
 
+
 def is_redis_available():
     try:
         Redis.ping()
@@ -26,6 +24,7 @@ def is_redis_available():
         return False
     return True
 
+
 def get_user_id(column_name, column_value):
     user_list = Redis.hgetall("users")
     key_list = []
@@ -36,6 +35,7 @@ def get_user_id(column_name, column_value):
 
     return None
 
+
 def get_user_by_unique_column(column_name, column_value):
     item_details = None
 
@@ -50,9 +50,11 @@ def get_user_by_unique_column(column_name, column_value):
 
     return item_details
 
+
 def get_users_like_unique_column(column_name, column_value):
-    """
-    Like previous function, but this only checks if the input is a subset of a field and can return multiple results
+    """Like previous function, but this only checks if the input is a
+    subset of a field and can return multiple results
+
     """
     matched_users = []
 
@@ -72,7 +74,6 @@ def get_users_like_unique_column(column_name, column_value):
 
     return matched_users
 
-# def search_users_by_unique_column(column_name, column_value):
 
 def set_user_attribute(user_id, column_name, column_value):
     user_info = json.loads(Redis.hget("users", user_id))
@@ -80,6 +81,7 @@ def set_user_attribute(user_id, column_name, column_value):
 
     Redis.hset("users", user_id, json.dumps(user_info))
 
+
 def get_user_collections(user_id):
     collections = None
     collections = Redis.hget("collections", user_id)
@@ -89,22 +91,27 @@ def get_user_collections(user_id):
     else:
         return []
 
+
 def save_user(user, user_id):
     Redis.hset("users", user_id, json.dumps(user))
 
+
 def save_collections(user_id, collections_ob):
     Redis.hset("collections", user_id, collections_ob)
 
+
 def save_verification_code(user_email, code):
     Redis.hset("verification_codes", code, user_email)
 
+
 def check_verification_code(code):
     email_address = None
     user_details = None
     email_address = Redis.hget("verification_codes", code)
 
     if email_address:
-        user_details = get_user_by_unique_column('email_address', email_address)
+        user_details = get_user_by_unique_column(
+            'email_address', email_address)
         if user_details:
             return user_details
         else:
@@ -112,10 +119,12 @@ def check_verification_code(code):
     else:
         return None
 
+
 def get_user_groups(user_id):
-    #ZS: Get the groups where a user is an admin or a member and return lists corresponding to those two sets of groups
-    admin_group_ids = []  #ZS: Group IDs where user is an admin
-    user_group_ids = []   #ZS: Group IDs where user is a regular user
+    # ZS: Get the groups where a user is an admin or a member and
+    # return lists corresponding to those two sets of groups
+    admin_group_ids = []  # ZS: Group IDs where user is an admin
+    user_group_ids = []  # ZS: Group IDs where user is a regular user
     groups_list = Redis.hgetall("groups")
     for key in groups_list:
         try:
@@ -140,6 +149,7 @@ def get_user_groups(user_id):
 
     return admin_groups, user_groups
 
+
 def get_group_info(group_id):
     group_json = Redis.hget("groups", group_id)
     group_info = None
@@ -148,6 +158,7 @@ def get_group_info(group_id):
 
     return group_info
 
+
 def get_group_by_unique_column(column_name, column_value):
     """ Get group by column; not sure if there's a faster way to do this """
 
@@ -156,7 +167,8 @@ def get_group_by_unique_column(column_name, column_value):
     all_group_list = Redis.hgetall("groups")
     for key in all_group_list:
         group_info = json.loads(all_group_list[key])
-        if column_name == "admins" or column_name == "members": #ZS: Since these fields are lists, search in the list
+        # ZS: Since these fields are lists, search in the list
+        if column_name == "admins" or column_name == "members":
             if column_value in group_info[column_name]:
                 matched_groups.append(group_info)
         else:
@@ -165,9 +177,11 @@ def get_group_by_unique_column(column_name, column_value):
 
     return matched_groups
 
+
 def get_groups_like_unique_column(column_name, column_value):
-    """
-    Like previous function, but this only checks if the input is a subset of a field and can return multiple results
+    """Like previous function, but this only checks if the input is a
+    subset of a field and can return multiple results
+
     """
     matched_groups = []
 
@@ -176,7 +190,8 @@ def get_groups_like_unique_column(column_name, column_value):
         if column_name != "group_id":
             for key in group_list:
                 group_info = json.loads(group_list[key])
-                if column_name == "admins" or column_name == "members": #ZS: Since these fields are lists, search in the list
+                # ZS: Since these fields are lists, search in the list
+                if column_name == "admins" or column_name == "members":
                     if column_value in group_info[column_name]:
                         matched_groups.append(group_info)
                 else:
@@ -188,13 +203,15 @@ def get_groups_like_unique_column(column_name, column_value):
 
     return matched_groups
 
-def create_group(admin_user_ids, member_user_ids = [], group_name = "Default Group Name"):
+
+def create_group(admin_user_ids, member_user_ids=[],
+                 group_name="Default Group Name"):
     group_id = str(uuid.uuid4())
     new_group = {
-        "id"    : group_id,
+        "id": group_id,
         "admins": admin_user_ids,
-        "members" : member_user_ids,
-        "name"  : group_name,
+        "members": member_user_ids,
+        "name": group_name,
         "created_timestamp": datetime.datetime.utcnow().strftime('%b %d %Y %I:%M%p'),
         "changed_timestamp": datetime.datetime.utcnow().strftime('%b %d %Y %I:%M%p')
     }
@@ -203,8 +220,9 @@ def create_group(admin_user_ids, member_user_ids = [], group_name = "Default Gro
 
     return new_group
 
+
 def delete_group(user_id, group_id):
-    #ZS: If user is an admin of a group, remove it from the groups hash
+    # ZS: If user is an admin of a group, remove it from the groups hash
     group_info = get_group_info(group_id)
     if user_id in group_info["admins"]:
         Redis.hdel("groups", group_id)
@@ -212,9 +230,15 @@ def delete_group(user_id, group_id):
     else:
         None
 
-def add_users_to_group(user_id, group_id, user_emails = [], admins = False): #ZS "admins" is just to indicate whether the users should be added to the groups admins or regular users set
+
+# ZS "admins" is just to indicate whether the users should be added to
+# the groups admins or regular users set
+def add_users_to_group(user_id, group_id, user_emails=[], admins=False):
     group_info = get_group_info(group_id)
-    if user_id in group_info["admins"]: #ZS: Just to make sure that the user is an admin for the group, even though they shouldn't be able to reach this point unless they are
+    # ZS: Just to make sure that the user is an admin for the group,
+    # even though they shouldn't be able to reach this point unless
+    # they are
+    if user_id in group_info["admins"]:
         if admins:
             group_users = set(group_info["admins"])
         else:
@@ -229,25 +253,36 @@ def add_users_to_group(user_id, group_id, user_emails = [], admins = False): #ZS
         else:
             group_info["members"] = list(group_users)
 
-        group_info["changed_timestamp"] = datetime.datetime.utcnow().strftime('%b %d %Y %I:%M%p')
+        group_info["changed_timestamp"] = datetime.datetime.utcnow().strftime(
+            '%b %d %Y %I:%M%p')
         Redis.hset("groups", group_id, json.dumps(group_info))
         return group_info
     else:
         return None
 
-def remove_users_from_group(user_id, users_to_remove_ids, group_id, user_type = "members"): #ZS: User type is because I assume admins can remove other admins
+
+# ZS: User type is because I assume admins can remove other admins
+def remove_users_from_group(user_id,
+                            users_to_remove_ids,
+                            group_id,
+                            user_type="members"):
     group_info = get_group_info(group_id)
 
     if user_id in group_info["admins"]:
         users_to_remove_set = set(users_to_remove_ids)
-        if user_type == "admins" and user_id in users_to_remove_set: #ZS: Make sure an admin can't remove themselves from a group, since I imagine we don't want groups to be able to become admin-less
+        # ZS: Make sure an admin can't remove themselves from a group,
+        # since I imagine we don't want groups to be able to become
+        # admin-less
+        if user_type == "admins" and user_id in users_to_remove_set:
             users_to_remove_set.remove(user_id)
         group_users = set(group_info[user_type])
         group_users -= users_to_remove_set
         group_info[user_type] = list(group_users)
-        group_info["changed_timestamp"] = datetime.datetime.utcnow().strftime('%b %d %Y %I:%M%p')
+        group_info["changed_timestamp"] = datetime.datetime.utcnow().strftime(
+            '%b %d %Y %I:%M%p')
         Redis.hset("groups", group_id, json.dumps(group_info))
 
+
 def change_group_name(user_id, group_id, new_name):
     group_info = get_group_info(group_id)
     if user_id in group_info["admins"]:
@@ -257,22 +292,28 @@ def change_group_name(user_id, group_id, new_name):
     else:
         return None
 
+
 def get_resources():
     resource_list = Redis.hgetall("resources")
     return resource_list
 
+
 def get_resource_id(dataset, trait_id=None):
     resource_id = False
     if dataset.type == "Publish":
         if trait_id:
-            resource_id = hmac.hmac_creation("{}:{}:{}".format('dataset-publish', dataset.id, trait_id))
+            resource_id = hmac_creation("{}:{}:{}".format(
+                'dataset-publish', dataset.id, trait_id))
     elif dataset.type == "ProbeSet":
-        resource_id = hmac.hmac_creation("{}:{}".format('dataset-probeset', dataset.id))
+        resource_id = hmac_creation(
+            "{}:{}".format('dataset-probeset', dataset.id))
     elif dataset.type == "Geno":
-        resource_id = hmac.hmac_creation("{}:{}".format('dataset-geno', dataset.id))
+        resource_id = hmac_creation(
+            "{}:{}".format('dataset-geno', dataset.id))
 
     return resource_id
 
+
 def get_resource_info(resource_id):
     resource_info = Redis.hget("resources", resource_id)
     if resource_info:
@@ -280,17 +321,23 @@ def get_resource_info(resource_id):
     else:
         return None
 
+
 def add_resource(resource_info, update=True):
     if 'trait' in resource_info['data']:
-        resource_id = hmac.hmac_creation('{}:{}:{}'.format(str(resource_info['type']), str(resource_info['data']['dataset']), str(resource_info['data']['trait'])))
+        resource_id = hmac_creation('{}:{}:{}'.format(
+            str(resource_info['type']), str(
+                resource_info['data']['dataset']),
+            str(resource_info['data']['trait'])))
     else:
-        resource_id = hmac.hmac_creation('{}:{}'.format(str(resource_info['type']), str(resource_info['data']['dataset'])))
+        resource_id = hmac_creation('{}:{}'.format(
+            str(resource_info['type']), str(resource_info['data']['dataset'])))
 
     if update or not Redis.hexists("resources", resource_id):
         Redis.hset("resources", resource_id, json.dumps(resource_info))
 
     return resource_info
 
+
 def add_access_mask(resource_id, group_id, access_mask):
     the_resource = get_resource_info(resource_id)
     the_resource['group_masks'][group_id] = access_mask
@@ -299,8 +346,9 @@ def add_access_mask(resource_id, group_id, access_mask):
 
     return the_resource
 
+
 def change_resource_owner(resource_id, new_owner_id):
-    the_resource= get_resource_info(resource_id)
+    the_resource = get_resource_info(resource_id)
     the_resource['owner_id'] = new_owner_id
 
     Redis.delete("resource")