Merge pull request #99 from ComputerScienceHouse/develop

Packet version 3.1.0

Author: JoelEager

.pylintrc

@@ -14,7 +14,8 @@ disable =
 	global-statement,
 	cyclic-import,
 	locally-disabled,
-	file-ignored
+	file-ignored,
+	no-else-return
 
 [REPORTS]
 output-format = text

config.env.py

@@ -8,15 +8,12 @@
 SECRET_KEY = environ.get("PACKET_SECRET_KEY", "PLEASE_REPLACE_ME")
 
 # OpenID Connect SSO config
-REALM = environ.get("PACKET_REALM", "intro")
+REALM = environ.get("PACKET_REALM", "csh")
 
 OIDC_ISSUER = environ.get("PACKET_OIDC_ISSUER", "https://sso.csh.rit.edu/auth/realms/csh")
 OIDC_CLIENT_ID = environ.get("PACKET_OIDC_CLIENT_ID", "packet")
 OIDC_CLIENT_SECRET = environ.get("PACKET_OIDC_CLIENT_SECRET", "PLEASE_REPLACE_ME")
 
-# SAML config
-SAML_METADATA_URL = environ.get("PACKET_SAML_METADATA_URL", "https://shibboleth.main.ad.rit.edu/rit-metadata.xml")
-
 # SQLAlchemy config
 SQLALCHEMY_DATABASE_URI = environ.get("PACKET_DATABASE_URI", None)
 SQLALCHEMY_TRACK_MODIFICATIONS = False

package.json

@@ -1,7 +1,7 @@
 {
   "title": "CSH Packet",
   "name": "csh-packet",
-  "version": "3.0.5",
+  "version": "3.1.0",
   "description": "A webpacket for CSH",
   "bugs": {
     "url": "https://github.com/ComputerScienceHouse/packet/issues",

packet/__init__.py

@@ -29,18 +29,20 @@
 
 auth = OIDCAuthentication(app, issuer=app.config["OIDC_ISSUER"], client_registration_info={
     "client_id": app.config["OIDC_CLIENT_ID"],
-    "client_secret": app.config["OIDC_CLIENT_SECRET"]
+    "client_secret": app.config["OIDC_CLIENT_SECRET"],
+    "post_logout_redirect_uris": "/logout/"
 })
 
 # LDAP
-_ldap = csh_ldap.CSHLDAP(app.config['LDAP_BIND_DN'], app.config['LDAP_BIND_PASS'])
+_ldap = csh_ldap.CSHLDAP(app.config["LDAP_BIND_DN"], app.config["LDAP_BIND_PASS"])
 
 # pylint: disable=wrong-import-position
+from . import models
+from . import context_processors
+from . import commands
+from .routes import api, shared
+
 if app.config["REALM"] == "csh":
     from .routes import upperclassmen
 else:
     from .routes import freshmen
-
-from .routes import api, shared
-from . import commands
-from . import models

packet/_version.py

@@ -1 +1 @@
-__version__ = "3.0.6"
+__version__ = "3.1.0"

packet/commands.py

@@ -11,6 +11,7 @@
 from .models import Freshman, Packet, FreshSignature, UpperSignature, MiscSignature
 from .ldap import ldap_get_eboard, ldap_get_live_onfloor
 
+
 @app.cli.command("create-secret")
 def create_secret():
     """
@@ -19,15 +20,18 @@ def create_secret():
     print("Here's your random secure token:")
     print(token_hex())
 
+
 packet_start_time = time(hour=19)
 packet_end_time = time(hour=21)
 
+
 class CSVFreshman:
     def __init__(self, row):
         self.name = row[0]
         self.rit_username = row[3]
         self.onfloor = row[1] == "TRUE"
 
+
 def parse_csv(freshmen_csv):
     print("Parsing file...")
     try:
@@ -37,6 +41,7 @@ def parse_csv(freshmen_csv):
         print("Failure while parsing CSV")
         raise e
 
+
 @app.cli.command("sync-freshmen")
 @click.argument("freshmen_csv")
 def sync_freshmen(freshmen_csv):
@@ -82,6 +87,7 @@ def sync_freshmen(freshmen_csv):
     db.session.commit()
     print("Done!")
 
+
 @app.cli.command("create-packets")
 @click.argument("freshmen_csv")
 def create_packets(freshmen_csv):
@@ -126,6 +132,7 @@ def create_packets(freshmen_csv):
     db.session.commit()
     print("Done!")
 
+
 @app.cli.command("ldap-sync")
 def ldap_sync():
     """
@@ -162,6 +169,7 @@ def ldap_sync():
     db.session.commit()
     print("Done!")
 
+
 @app.cli.command("fetch-results")
 def fetch_results():
     """
@@ -186,20 +194,14 @@ def fetch_results():
         received = packet.signatures_received()
         required = packet.signatures_required()
 
-        upper_ratio = sum((received["eboard"], received["upperclassmen"], received["miscellaneous"])) / \
-                      sum((required["eboard"], required["upperclassmen"], required["miscellaneous"]))
-        print("\tUpperclassmen score: {}%".format(round(upper_ratio * 100, 2)))
-
-        total_ratio = sum(received.values()) / sum(required.values())
-        print("\tTotal score: {}%".format(round(total_ratio * 100, 2)))
-
+        print("\tUpperclassmen score: {:0.2f}%".format(received.member_total / required.member_total * 100))
+        print("\tTotal score: {:0.2f}%".format(received.total / required.total * 100))
         print()
 
-        print("\tEboard: {}/{}".format(received["eboard"], required["eboard"]))
-        print("\tUpperclassmen: {}/{}".format(received["upperclassmen"], required["upperclassmen"]))
-        print("\tFreshmen: {}/{}".format(received["freshmen"], required["freshmen"]))
-        print("\tMiscellaneous: {}/{}".format(len(packet.misc_signatures), required["miscellaneous"]))
-
+        print("\tEboard: {}/{}".format(received.eboard, required.eboard))
+        print("\tUpperclassmen: {}/{}".format(received.upper, required.upper))
+        print("\tFreshmen: {}/{}".format(received.fresh, required.fresh))
+        print("\tMiscellaneous: {}/{}".format(received.misc, required.misc))
         print()
 
-        print("\tTotal missed:", sum(required.values()) - sum(received.values()))
+        print("\tTotal missed:", required.total - received.total)

packet/context_processors.py

@@ -0,0 +1,42 @@
+"""
+Context processors used by the jinja templates
+"""
+
+from functools import lru_cache
+from datetime import datetime
+
+from packet.ldap import ldap_get_member
+from packet.models import Freshman
+from packet import app
+
+
+# pylint: disable=bare-except
+@lru_cache(maxsize=128)
+def get_csh_name(username):
+    try:
+        member = ldap_get_member(username)
+        return member.cn + " (" + member.uid + ")"
+    except:
+        return username
+
+
+# pylint: disable=bare-except
+@lru_cache(maxsize=128)
+def get_rit_name(username):
+    try:
+        freshman = Freshman.query.filter_by(rit_username=username).first()
+        return freshman.name + " (" + username + ")"
+    except:
+        return username
+
+
+def log_time(label):
+    """
+    Used during debugging to log timestamps while rendering templates
+    """
+    print(label, datetime.now())
+
+
+@app.context_processor
+def utility_processor():
+    return dict(get_csh_name=get_csh_name, get_rit_name=get_rit_name, log_time=log_time)

packet/debug_utils.py

@@ -0,0 +1,34 @@
+"""
+General utilities for use when debugging
+"""
+
+from functools import wraps
+from datetime import datetime
+
+from packet import context_processors
+
+
+def log_time(func):
+    """
+    Decorator for logging the execution time of a function
+    """
+    @wraps(func)
+    def wrapped_function(*args, **kwargs):
+        start = datetime.now()
+
+        result = func(*args, **kwargs)
+
+        seconds = (datetime.now() - start).total_seconds()
+        print("{}.{}() returned after {} seconds".format(func.__module__, func.__name__, seconds))
+
+        return result
+
+    return wrapped_function
+
+
+def log_cache():
+    """
+    Utility call for logging cache info
+    """
+    print("get_csh_name():", context_processors.get_csh_name.cache_info())
+    print("get_rit_name():", context_processors.get_rit_name.cache_info())