pyGuardPoint 2.1.0__tar.gz → 2.1.2__tar.gz

{pyguardpoint-2.1.0 → pyguardpoint-2.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyGuardPoint
-Version: 2.1.0
+Version: 2.1.2
 Summary: Python wrapper for GuardPoint 10 Access Control System
 Author: John Owen
 Maintainer-email: sales@sensoraccess.co.uk

{pyguardpoint-2.1.0 → pyguardpoint-2.1.2}/pyGuardPoint/CustomWebsocketTransport.py

@@ -8,10 +8,22 @@ from typing import TYPE_CHECKING
 from aiohttp import ClientSession, TCPConnector
 from aiohttp import ClientTimeout
 from aiohttp import ServerConnectionError
-from websockets.asyncio.client import ClientConnection
-from websockets.asyncio.client import connect
+
+# Handle websockets version compatibility
+try:
+    from websockets.asyncio.client import ClientConnection, connect
+except ImportError:
+    # websockets<13.0 compatibility
+    from websockets.client import WebSocketClientProtocol as ClientConnection
+    from websockets.client import connect
+
 from websockets.exceptions import ConnectionClosed
-from websockets.protocol import State
+
+try:
+    from websockets.protocol import State
+except ImportError:
+    # websockets<13.0 compatibility
+    State = None
 
 import pysignalr.exceptions as exceptions
 from pysignalr.messages import CompletionMessage

{pyguardpoint-2.1.0 → pyguardpoint-2.1.2}/pyGuardPoint/_guardpoint_cardholders.py

@@ -298,9 +298,6 @@ class CardholdersAPI:
                     return None
             else:
                 return None
-            # Part of the Cards_API
-            # (Broken API Call)
-            #return self.get_cardholder_by_card_code(card_code)
         else:
             return self._get_card_holder(uid)
 
@@ -355,12 +352,6 @@ class CardholdersAPI:
                                        "securityGroup," \
                                        "insideArea"
 
-        # Do not apply site filter, when looking for individuals
-        #if self.site_uid is not None:
-        #    match_args = {'ownerSiteUID': self.site_uid}
-        #    filter_str = _compose_filter(exact_match=match_args)
-        #    url_query_params += ("&" + filter_str)
-
         code, json_body = self.gp_json_query("GET", url=(url + url_query_params))
 
         if code == 404:  # Not Found
@@ -428,14 +419,14 @@ class CardholdersAPI:
             return []
         if limit > 50 and count is False:
             i_offset = offset
-            offset = 0
+            current_offset = 0
             batch_limit = 50
             card_holders = []
-            while len(card_holders) == offset:
-                if offset + batch_limit > limit:
-                    batch_limit = limit - offset
+            while len(card_holders) < limit:
+                if current_offset + batch_limit > limit:
+                    batch_limit = limit - current_offset
                 if batch_limit > 0:
-                    batch = self._split_get_card_holders_query(offset=offset + i_offset, limit=batch_limit,
+                    batch = self._split_get_card_holders_query(offset=current_offset + i_offset, limit=batch_limit,
                                                                search_terms=search_terms,
                                                                areas=areas,
                                                                filter_expired=filter_expired,
@@ -447,11 +438,11 @@ class CardholdersAPI:
                                                                **cardholder_kwargs)
                     if isinstance(batch, list):
                         card_holders.extend(batch)
-
-                if (offset + batch_limit) >= limit:
-                    break
-                elif len(card_holders) > offset:
-                    offset = len(card_holders)
+                        if len(batch) < batch_limit:
+                            break
+                    else:
+                        break
+                    current_offset = len(card_holders)
                 else:
                     break
 
@@ -571,9 +562,6 @@ class CardholdersAPI:
             url_query_params += "$top=" + str(limit) + "&$skip=" + str(offset)
 
         code, json_body = self.gp_json_query("GET", url=(url + url_query_params))
-        # Check response body is formatted correctly
-        # if json_body:
-        #    GuardPointResponse.check_odata_body_structure(json_body)
 
         if code != 200:
             error_msg = GuardPointResponse.extract_error_msg(json_body)

{pyguardpoint-2.1.0 → pyguardpoint-2.1.2}/pyGuardPoint/_guardpoint_cards.py

@@ -72,7 +72,7 @@ class CardsAPI:
             if code == 401:
                 raise GuardPointUnauthorized(f"Unauthorized - ({error_msg})")
             elif code == 404:  # Not Found
-                raise GuardPointError(f"Cardholder Not Found")
+                raise GuardPointError(f"Cards Not Found")
             else:
                 raise GuardPointError(f"{error_msg}")
 
@@ -244,7 +244,10 @@ class CardsAPI:
         if 'value' not in json_body:
             raise GuardPointError("Badly formatted response.")
 
-        return Card(json_body['value'])
+        value = json_body['value']
+        if isinstance(value, list):
+            return Card(value[0]) if value else None
+        return Card(value)
 
     def get_cardholder_by_card_code(self, card_code):
         """

{pyguardpoint-2.1.0 → pyguardpoint-2.1.2}/pyGuardPoint/_guardpoint_departments.py

@@ -33,7 +33,10 @@ class DepartmentsAPI:
         if 'value' not in json_body:
             raise GuardPointError("Badly formatted response.")
 
-        return Department(json_body['value'])
+        value = json_body['value']
+        if isinstance(value, list):
+            return Department(value[0]) if value else None
+        return Department(value)
 
     def get_departments(self):
         url = "/odata/API_Departments"

{pyguardpoint-2.1.0 → pyguardpoint-2.1.2}/pyGuardPoint/_guardpoint_readers.py

@@ -141,5 +141,8 @@ class ReadersAPI:
         if 'value' not in json_body:
             raise GuardPointError("Badly formatted response.")
 
-        return Reader(json_body['value'])
+        value = json_body['value']
+        if isinstance(value, list):
+            return Reader(value[0]) if value else None
+        return Reader(value)
 

{pyguardpoint-2.1.0 → pyguardpoint-2.1.2}/pyGuardPoint/_odata_filter.py

@@ -93,29 +93,36 @@ def _compose_filter(search_words=None,
                 if isinstance(v, str):
                     v = v.replace("'", "''")
                     if validators.uuid(v):
-                        filter_phrases.append(f"({k}%20eq%20{quote(v)})")
+                        filter_phrases.append(f"({k}%20eq%20{v})")
                     else:
                         filter_phrases.append(f"({k}%20eq%20'{quote(v)}')")
                 if isinstance(v, (bool, int)):
-                    filter_phrases.append(f"({k}%20eq%20{quote(v)})")
+                    filter_phrases.append(f"({k}%20eq%20{v})")
                 if k == "cardholderPersonalDetail" and v.__class__.__name__ == "CardholderPersonalDetail":
                     details = v.dict(changed_only=True)
                     for dk, dv in details.items():
                         if isinstance(dv, str):
                             dv = dv.replace("'", "''")
-                        filter_phrases.append(f"(CardholderPersonalDetail/{dk}%20eq%20'{quote(dv)}')")
+                            filter_phrases.append(f"(CardholderPersonalDetail/{dk}%20eq%20'{quote(dv)}')")
+                        elif isinstance(dv, (bool, int)):
+                            filter_phrases.append(f"(CardholderPersonalDetail/{dk}%20eq%20{dv})")
+                        elif isinstance(dv, type(None)):
+                            filter_phrases.append(f"(CardholderPersonalDetail/{dk}%20eq%20null)")
+                        else:
+                            dv_str = str(dv).replace("'", "''")
+                            filter_phrases.append(f"(CardholderPersonalDetail/{dk}%20eq%20'{quote(dv_str)}')")
                 if k == "cardholderCustomizedField" and v.__class__.__name__ == "CardholderCustomizedField":
                     details = v.dict(changed_only=True)
                     for dk, dv in details.items():
                         if isinstance(dv, type(None)):
-                            filter_phrases.append(f"(CardholderCustomizedField/{dk}%20eq%20{quote('null')})")
+                            filter_phrases.append(f"(CardholderCustomizedField/{dk}%20eq%20null)")
                         elif isinstance(dv, (bool, int)):
                             filter_phrases.append(f"(CardholderCustomizedField/{dk}%20eq%20{str(dv).lower()})")
                         elif isinstance(dv, str):
                             dv = dv.replace("'", "''")
                             filter_phrases.append(f"(CardholderCustomizedField/{dk}%20eq%20'{quote(dv)}')")
                         else:
-                            filter_phrases.append(f"(CardholderCustomizedField/{dk}%20eq%20'{quote(dv)}')")
+                            filter_phrases.append(f"(CardholderCustomizedField/{dk}%20eq%20'{str(dv)}')")
 
     if earliest_last_pass:
         if isinstance(earliest_last_pass, datetime):
@@ -136,7 +143,7 @@ def _compose_filter(search_words=None,
     if areas:
         if isinstance(areas, Area):
             filter_phrases.append(f"(insideAreaUID%20eq%20{areas.uid})")
-        if isinstance(areas, list):
+        elif isinstance(areas, list):
             if len(areas) > 0:
                 area_phrases = []
                 for area in areas:

{pyguardpoint-2.1.0 → pyguardpoint-2.1.2}/pyGuardPoint/_str_match_algo.py

@@ -12,11 +12,20 @@ def fuzzy_match(search_words: str, cardholders: list, threshold: int = 75):
 
     match_ratios = process.extract(search_words, cardholder_patterns, scorer=fuzz.WRatio, limit=20)
 
+    pattern_to_indices = {}
+    for idx, pattern in enumerate(cardholder_patterns):
+        if pattern not in pattern_to_indices:
+            pattern_to_indices[pattern] = []
+        pattern_to_indices[pattern].append(idx)
+
     sorted_cardholders = []
+    seen = set()
     for match in match_ratios:
         if match[1] >= threshold:
-            pos = cardholder_patterns.index(match[0])
-            sorted_cardholders.append(cardholders[pos])
+            for pos in pattern_to_indices.get(match[0], []):
+                if pos not in seen:
+                    sorted_cardholders.append(cardholders[pos])
+                    seen.add(pos)
 
     return sorted_cardholders
 

{pyguardpoint-2.1.0 → pyguardpoint-2.1.2}/pyGuardPoint/gp_asyncio/guardpoint_connection_asyncio.py

@@ -59,9 +59,10 @@ class GuardPointConnection:
         if self.session:
             await self.session.close()
 
-    async def reopen(self):
+    def reopen(self):
         conn = aiohttp.TCPConnector(ssl_context=self.ssl_context)
         self.session = aiohttp.ClientSession(connector=conn)
+
     def open(self, url_components, auth, user, pwd, key, token=None,
              cert_file=None, key_file=None, key_pwd="", ca_file=None, p12_file=None, p12_pwd="", timeout=5):
         self.ssl_context = None
@@ -116,7 +117,8 @@ class GuardPointConnection:
 
         if cert_file and key_file:
             # Loading of client certificate
-            self.ssl_context.load_cert_chain(certfile=cert_file, keyfile=key_file, password=key_pwd)
+            pwd_bytes = key_pwd.encode() if isinstance(key_pwd, str) else key_pwd
+            self.ssl_context.load_cert_chain(certfile=cert_file, keyfile=key_file, password=pwd_bytes if pwd_bytes else None)
 
         if ca_file:
             # Loading of CA certificate.
@@ -172,11 +174,11 @@ class GuardPointConnection:
                 if code != 200:
                     return code, auth_body
             if self.auto_renew:
-                if self.token_expiry < (time.time() - (20 * 60)):  # If Token will expire within 20 minutes
+                if self.token_expiry < (time.time() + (20 * 60)) and self.token_expiry > time.time():
                     code, auth_body = await self._renew_token()
                     if code != 200:
                         return code, auth_body
-                if self.token_expiry < time.time():
+                elif self.token_expiry < time.time():
                     code, auth_body = await self._new_token()
                     if code != 200:
                         return code, auth_body
@@ -220,54 +222,70 @@ class GuardPointConnection:
                         json_body = None
             except InvalidURL as e:
                 log.error(str(e))
-                return
+                return 400, {"error": str(e)}
             except Exception as e:
                 log.error(str(e))
-                return
+                return 500, {"error": str(e)}
 
         elif method.lower() == "post":
-            async with self.session.post(url, data=raw_body, headers=headers) as response:
-                body = await response.text()
-                try:
-                    json_body = json.loads(body)
-                except JSONDecodeError:
-                    json_body = None
-                except Exception as e:
-                    log.error(e)
-                    json_body = None
+            try:
+                async with self.session.post(url, data=raw_body, headers=headers) as response:
+                    body = await response.text()
+                    try:
+                        json_body = json.loads(body)
+                    except JSONDecodeError:
+                        json_body = None
+                    except Exception as e:
+                        log.error(e)
+                        json_body = None
+            except Exception as e:
+                log.error(str(e))
+                return 500, {"error": str(e)}
 
         elif method.lower() == "patch":
-            async with self.session.patch(url, data=raw_body, headers=headers) as response:
-                body = await response.text()
-                try:
-                    json_body = json.loads(body)
-                except JSONDecodeError:
-                    json_body = None
-                except Exception as e:
-                    log.error(e)
-                    json_body = None
+            try:
+                async with self.session.patch(url, data=raw_body, headers=headers) as response:
+                    body = await response.text()
+                    try:
+                        json_body = json.loads(body)
+                    except JSONDecodeError:
+                        json_body = None
+                    except Exception as e:
+                        log.error(e)
+                        json_body = None
+            except Exception as e:
+                log.error(str(e))
+                return 500, {"error": str(e)}
 
         elif method.lower() == "delete":
-            async with self.session.delete(url, data=raw_body, headers=headers) as response:
-                body = await response.text()
-                try:
-                    json_body = json.loads(body)
-                except JSONDecodeError:
-                    json_body = None
-                except Exception as e:
-                    log.error(e)
-                    json_body = None
+            try:
+                async with self.session.delete(url, data=raw_body, headers=headers) as response:
+                    body = await response.text()
+                    try:
+                        json_body = json.loads(body)
+                    except JSONDecodeError:
+                        json_body = None
+                    except Exception as e:
+                        log.error(e)
+                        json_body = None
+            except Exception as e:
+                log.error(str(e))
+                return 500, {"error": str(e)}
 
         elif method.lower() == "put":
-            async with self.session.put(url, data=raw_body, headers=headers) as response:
-                body = await response.text()
-                try:
-                    json_body = json.loads(body)
-                except JSONDecodeError:
-                    json_body = None
-                except Exception as e:
-                    log.error(e)
-                    json_body = None
+            try:
+                async with self.session.put(url, data=raw_body, headers=headers) as response:
+                    body = await response.text()
+                    try:
+                        json_body = json.loads(body)
+                    except JSONDecodeError:
+                        json_body = None
+                    except Exception as e:
+                        log.error(e)
+                        json_body = None
+            except Exception as e:
+                log.error(str(e))
+                return 500, {"error": str(e)}
 
         else:
             raise ValueError("Method Not Supported")

{pyguardpoint-2.1.0 → pyguardpoint-2.1.2}/pyGuardPoint/guardpoint_connection.py

@@ -108,7 +108,8 @@ class GuardPointConnection:
 
             if cert_file and key_file:
                 # Loading of client certificate
-                self.ssl_context.load_cert_chain(certfile=cert_file, keyfile=key_file, password=p12_pwd)
+                pwd_bytes = p12_pwd.encode() if isinstance(p12_pwd, str) else p12_pwd
+                self.ssl_context.load_cert_chain(certfile=cert_file, keyfile=key_file, password=pwd_bytes if pwd_bytes else None)
 
             if ca_file:
                 # Loading of CA certificate.
@@ -185,11 +186,11 @@ class GuardPointConnection:
                 if code != 200:
                     return code, auth_body
             if self.auto_renew:
-                if self.token_expiry < (time.time() - (20 * 60)):  # If Token will expire within 20 minutes
+                if self.token_expiry < (time.time() + (20 * 60)) and self.token_expiry > time.time():
                     code, auth_body = self._renew_token()
                     if code != 200:
                         return code, auth_body
-                if self.token_expiry < time.time():
+                elif self.token_expiry < time.time():
                     code, auth_body = self._new_token()
                     if code != 200:
                         return code, auth_body

{pyguardpoint-2.1.0 → pyguardpoint-2.1.2}/pyGuardPoint/guardpoint_dataclasses.py

@@ -1,4 +1,5 @@
 import logging
+import threading
 from collections import defaultdict
 from dataclasses import dataclass, asdict, field
 from enum import Enum
@@ -18,20 +19,21 @@ class EventOrder(Enum):
 
 
 class Observable:
-    # A set of all attributes which get changed
-    changed_attributes = set()
-
     def __init__(self):
-        self.observed = defaultdict(list)
+        super().__setattr__('changed_attributes', set())
+        super().__setattr__('observed', defaultdict(list))
+        super().__setattr__('_observer_lock', threading.RLock())
 
     def __setattr__(self, name, value):
         super().__setattr__(name, value)
 
-        for observer in self.observed.get(name, []):
-            observer(name)
+        with self._observer_lock:
+            for observer in self.observed.get(name, []):
+                observer(name)
 
     def add_observer(self, name):
-        self.observed[name].append(lambda name: self.changed_attributes.add(name))
+        with self._observer_lock:
+            self.observed[name].append(lambda attr_name: self.changed_attributes.add(attr_name))
 
 
 def sanitise_args(obj: Observable, args, kwargs):
@@ -54,12 +56,12 @@ def sanitise_args(obj: Observable, args, kwargs):
 
 
 class SortAlgorithm(Enum):
-    SERVER_DEFAULT = 0,
+    SERVER_DEFAULT = 0
     FUZZY_MATCH = 1
 
 
 class CardholderOrderBy(Enum):
-    fromDateValid_DESC = 0,
+    fromDateValid_DESC = 0
     lastPassDate_DESC = 1
 
 
@@ -97,6 +99,7 @@ class CustomizedField:
                 cf_dict[k] = None
             else:
                 cf_dict[k] = str(v)
+        return cf_dict
 
 @dataclass
 class WeeklyProgram:
@@ -122,6 +125,7 @@ class WeeklyProgram:
                 me_dict[k] = None
             else:
                 me_dict[k] = str(v)
+        return me_dict
 
 
 @dataclass
@@ -148,6 +152,7 @@ class ManualEvent:
                 me_dict[k] = None
             else:
                 me_dict[k] = str(v)
+        return me_dict
 
 
 @dataclass
@@ -156,12 +161,12 @@ class Input:
     logicalStatus: str = ""
     isUnderAlarm: bool = False
     uid: str = ""
-    number: int = 0,
+    number: int = 0
     name: str = ""
     descriprion: any = None
     weeklyProgramUID: any = None
     delayType: str = ""
-    delayTime: int = 0,
+    delayTime: int = 0
     inputType: str = ""
     statusType: str = ""
     controllerUID: str = ""
@@ -170,12 +175,12 @@ class Input:
     lastEventType: any = None
     latestAction: any = None
     inputGroupUID: any = None
-    alarmPriority: int = 0,
+    alarmPriority: int = 0
     isArm: bool = False
     isBypassed: bool = False
     instructions: any = None
     isGalaxy: bool = False
-    omitted: int = 0,
+    omitted: int = 0
     apiKey: any = None
 
     def __init__(self, *args, **kwargs):
@@ -195,6 +200,7 @@ class Input:
                 input_dict[k] = None
             else:
                 input_dict[k] = str(v)
+        return input_dict
 
 
 @dataclass
@@ -231,6 +237,7 @@ class AlarmState:
                 alarm_state_dict[k] = None
             else:
                 alarm_state_dict[k] = str(v)
+        return alarm_state_dict
 
 
 @dataclass
@@ -542,7 +549,7 @@ class AccessEvent:
     accessDeniedCode: str = ""
     cardCode: str = ""
     cardholderFirstName: any = None
-    cardholderIdNumber: str = None
+    cardholderIdNumber: any = None
     cardholderLastName: any = None
     cardholderTypeName: any = None
     cardholderTypeUID: any = None
@@ -866,7 +873,7 @@ class ScheduledMag(Observable):
 @dataclass
 class CardholderCustomizedField(Observable):
     uid: str = ""
-    cF_BoolField_1: bool = False,
+    cF_BoolField_1: bool = False
     cF_BoolField_2: bool = False
     cF_BoolField_3: bool = False
     cF_BoolField_4: bool = False
@@ -1181,8 +1188,8 @@ class Cardholder(Observable):
 
         for property_name in cardholder_dict:
             if isinstance(cardholder_dict[property_name], list):
-                if property_name == "accessGroupUIDs":
-                    setattr(self, property_name, ";".join(cardholder_dict[property_name]))
+                if property_name == "accessGroupUIDs" or property_name == "liftAccessGroupUIDs":
+                    setattr(self, property_name, cardholder_dict[property_name])
                 elif property_name == "cards":
                     setattr(self, property_name, [])
                     for card_entry in cardholder_dict[property_name]:
@@ -1219,7 +1226,7 @@ class Cardholder(Observable):
                 try:
                     if isinstance(getattr(self, property_name), str):
                         value = str(value)
-                except:
+                except AttributeError:
                     pass
 
 

{pyguardpoint-2.1.0 → pyguardpoint-2.1.2}/pyGuardPoint/guardpoint_utils.py

@@ -6,19 +6,29 @@ from .guardpoint_error import GuardPointError
 
 
 def url_parser(url):
+    if not url or not isinstance(url, str):
+        raise GuardPointError("Invalid URL: must be a non-empty string")
+
     parts = urlparse(url)
-    directories = parts.path.strip('/').split('/')
-    queries = parts.query.strip('&').split('&')
+
+    if not parts.netloc:
+        raise GuardPointError("Invalid URL: missing host")
+
+    directories = parts.path.strip('/').split('/') if parts.path else ['']
+    queries = parts.query.strip('&').split('&') if parts.query else []
     host = parts.netloc.strip(':').split(':')[0]
 
+    if not host:
+        raise GuardPointError("Invalid URL: empty host")
+
     elements = {
-        'scheme': parts.scheme,
+        'scheme': parts.scheme or '',
         'host': host,
-        'path': parts.path,
-        'params': parts.params,
-        'query': parts.query,
+        'path': parts.path or '',
+        'params': parts.params or '',
+        'query': parts.query or '',
         'port': parts.port,
-        'fragment': parts.fragment,
+        'fragment': parts.fragment or '',
         'directories': directories,
         'queries': queries,
     }

{pyguardpoint-2.1.0 → pyguardpoint-2.1.2}/pyGuardPoint.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyGuardPoint
-Version: 2.1.0
+Version: 2.1.2
 Summary: Python wrapper for GuardPoint 10 Access Control System
 Author: John Owen
 Maintainer-email: sales@sensoraccess.co.uk

{pyguardpoint-2.1.0 → pyguardpoint-2.1.2}/setup.py

@@ -5,7 +5,7 @@ long_description = open('README.rst').read()
 setup(name="pyGuardPoint",
       python_requires='>3.9.0',
       packages=find_packages(),
-      version="2.1.0",
+      version="2.1.2",
       author="John Owen",
       description="Python wrapper for GuardPoint 10 Access Control System",
       long_description_content_type='text/markdown',