Qa (#26)

Support hrpws v3. Update copyright year, python version, action versions. Refactor to class.


Co-authored-by: Jim Laney <jlaney@uw.edu>

.github/workflows/cicd.yml

@@ -37,16 +37,16 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
 
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
-          python-version: 3.6
+          python-version: 3.8
 
       - name: Install Dependencies
         run: |
@@ -75,16 +75,16 @@ jobs:
 
     needs: test
 
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
 
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
-          python-version: '3.x'
+          python-version: 3.8
 
       - name: Publish to PyPi
         uses: uw-it-aca/actions/publish-pypi@main

uw_hrp/__init__.py

@@ -1,25 +1,112 @@
-# Copyright 2022 UW-IT, University of Washington
+# Copyright 2023 UW-IT, University of Washington
 # SPDX-License-Identifier: Apache-2.0
 
+
 """
-This is the interface for interacting with
-the hrp web service.
+This is the interface for interacting with the hrp web service.
 """
 
 import logging
+import json
+import re
+from urllib.parse import urlencode
 from uw_hrp.dao import HRP_DAO
-from restclients_core.exceptions import DataFailureException
-
+from restclients_core.exceptions import (
+    DataFailureException, InvalidRegID, InvalidNetID, InvalidEmployeeID)
+from uw_hrp.models import Person
 
 logger = logging.getLogger(__name__)
+re_netid = re.compile(r'^[a-z][a-z0-9\-\_\.]{,127}$', re.I)
+re_regid = re.compile(r'^[A-F0-9]{32}$', re.I)
+re_employee_id = re.compile(r'^\d{9}$')
+
+
+class HRP(object):
+    URL_PREFIX = "/hrp/v3/person"
+    SUFFIX = "future_worker=true"
+
+    def __init__(self):
+        self.DAO = HRP_DAO()
+        self.req_url = None
+
+    def get_resource(self, url):
+        self.req_url = url
+        response = self.DAO.getURL(url, {'Accept': 'application/json'})
+        logger.debug("{0} ==status==> {1}".format(url, response.status))
+        if response.status != 200:
+            raise DataFailureException(
+                url, response.status, response.data)
+        data = convert_bytes_str(response.data)
+        logger.debug("{0} ==data==> {1}".format(url, data))
+        return data
+
+    def get_person_by_employee_id(self, employee_id, include_future=False):
+        if not valid_employee_id(employee_id):
+            raise InvalidEmployeeID(employee_id)
+        return self._get_person(employee_id, include_future)
+
+    def get_person_by_netid(self, netid, include_future=False):
+        if not valid_uwnetid(netid):
+            raise InvalidNetID(netid)
+        return self._get_person(netid, include_future)
+
+    def get_person_by_regid(self, regid, include_future=False):
+        if not valid_uwregid(regid):
+            raise InvalidRegID(regid)
+        return self._get_person(regid, include_future)
+
+    def _get_person(self, id, include_future):
+        """
+        Return a restclients.models.hrp.WorkerDetails object
+        """
+        url = "{0}/{1}.json".format(self.URL_PREFIX, id)
+        if include_future:
+            url = "{0}?{1}".format(url, self.SUFFIX)
+        return Person(data=json.loads(self.get_resource(url)))
+
+    def person_search(self, **kwargs):
+        """
+        Returns a list of Person objects
+        Parameters can be:
+            active_appointment: true|false
+            changed_since_date: string
+            cost_center: string
+            current_faculty: true|false
+            future_worker: string
+            location: string
+            supervisory_organization: string
+            worker_wid: string
+        """
+        url = "{0}.json?{1}&page_size=200".format(
+            self.URL_PREFIX, urlencode(kwargs))
+        persons = []
+        while True:
+            data = json.loads(self.get_resource(url))
+            if "Persons" in data:
+                for person_record in data.get("Persons"):
+                    persons.append(Person(data=person_record))
+            if (data.get("Next") and data["Next"].get("Href") and
+                    len(data["Next"]["Href"]) > 0):
+                url = data["Next"]["Href"]
+            else:
+                break
+        return persons
+
+
+def valid_uwnetid(netid):
+    return (netid is not None and
+            re_netid.match(str(netid)) is not None)
+
+
+def valid_uwregid(regid):
+    return (regid is not None and
+            re_regid.match(str(regid)) is not None)
 
 
-def get_resource(url):
-    response = HRP_DAO().getURL(url, {'Accept': 'application/json'})
+def valid_employee_id(employee_id):
+    return (employee_id is not None and
+            re_employee_id.match(str(employee_id)) is not None)
 
-    logger.debug("{0} ==status==> {1}".format(url, response.status))
-    if response.status != 200:
-        raise DataFailureException(url, response.status, response.data)
 
-    logger.debug("{0} ==data==> {1}".format(url, response.data))
-    return response.data
+def convert_bytes_str(data):
+    return data.decode('utf-8') if type(data) is bytes else data

uw_hrp/dao.py

@@ -1,6 +1,7 @@
-# Copyright 2022 UW-IT, University of Washington
+# Copyright 2023 UW-IT, University of Washington
 # SPDX-License-Identifier: Apache-2.0
 
+
 import logging
 import os
 from os.path import abspath, dirname