pyGuardPoint 2.0.5__tar.gz → 2.0.7__tar.gz

{pyguardpoint-2.0.5 → pyguardpoint-2.0.7}/PKG-INFO

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

pyguardpoint-2.0.7/pyGuardPoint/_guardpoint_weeklyprograms.py

@@ -0,0 +1,67 @@
+
+from .guardpoint_dataclasses import WeeklyProgram
+from .guardpoint_utils import GuardPointResponse
+from .guardpoint_error import GuardPointError, GuardPointUnauthorized
+
+
+class WeeklyProgramsAPI:
+
+    def get_weekly_program(self, weekly_program_uid):
+        url = self.baseurl + "/odata/API_WeeklyPrograms"
+        url_query_params = f"({weekly_program_uid})"
+        headers = {
+            'Content-Type': 'application/json',
+            'Accept': 'application/json',
+        }
+        code, json_body = self.gp_json_query("GET", headers=headers, url=(url + url_query_params))
+
+        if code != 200:
+            error_msg = GuardPointResponse.extract_error_msg(json_body)
+
+            if code == 401:
+                raise GuardPointUnauthorized(f"Unauthorized - ({error_msg})")
+            elif code == 404:  # Not Found
+                return None
+            else:
+                raise GuardPointError(f"{error_msg}")
+
+        # Check response body is formatted as expected
+        if not isinstance(json_body, dict):
+            raise GuardPointError("Badly formatted response.")
+        if 'value' not in json_body:
+            raise GuardPointError("Badly formatted response.")
+        if not isinstance(json_body['value'], list):
+            raise GuardPointError("Badly formatted response.")
+
+        return WeeklyProgram(json_body['value'][0])
+
+    def get_weekly_programs(self):
+        url = self.baseurl + "/odata/API_WeeklyPrograms"
+
+        code, json_body = self.gp_json_query("GET", url=url)
+
+        if code != 200:
+            error_msg = GuardPointResponse.extract_error_msg(json_body)
+
+            if code == 401:
+                raise GuardPointUnauthorized(f"Unauthorized - ({error_msg})")
+            elif code == 404:  # Not Found
+                raise GuardPointError(f"No WeeklyPrograms Found")
+            else:
+                raise GuardPointError(f"{error_msg}")
+
+        # Check response body is formatted as expected
+        if not isinstance(json_body, dict):
+            raise GuardPointError("Badly formatted response.")
+        if 'value' not in json_body:
+            raise GuardPointError("Badly formatted response.")
+        if not isinstance(json_body['value'], list):
+            raise GuardPointError("Badly formatted response.")
+
+        # Compose list of inputs
+        weekly_programs = []
+        for entry in json_body['value']:
+            if isinstance(entry, dict):
+                wp = WeeklyProgram(entry)
+                weekly_programs.append(wp)
+        return weekly_programs

{pyguardpoint-2.0.5 → pyguardpoint-2.0.7}/pyGuardPoint/gp_asyncio/_async_guardpoint_accessgroups.py

@@ -7,7 +7,7 @@ from ..guardpoint_error import GuardPointError, GuardPointUnauthorized
 class AccessGroupsAPI:
 
     async def get_access_groups(self):
-        url = self.baseurl + "/odata/api_AccessGroups"
+        url = "/odata/api_AccessGroups"
         url_query_params = "?"
 
         if self.site_uid is not None:

{pyguardpoint-2.0.5 → pyguardpoint-2.0.7}/pyGuardPoint/gp_asyncio/_async_guardpoint_alarmzones.py

@@ -9,7 +9,7 @@ class AlarmZonesAPI:
 
     async def arm_alarm_zone(self, alarm_zone: AlarmZone, option=AlarmZoneOption.ReturnAlarmZoneToWeeklyProgram):
         if option == AlarmZoneOption.ReturnAlarmZoneToWeeklyProgram:
-            url = self.baseurl + "/odata/API_AlarmZones/ReturnAlarmZoneToWeeklyProgram"
+            url = "/odata/API_AlarmZones/ReturnAlarmZoneToWeeklyProgram"
         else:
             raise GuardPointError(f"Unsupported Arming Option")
 

pyguardpoint-2.0.7/pyGuardPoint/gp_asyncio/_async_guardpoint_weeklyprograms.py

@@ -0,0 +1,67 @@
+
+from ..guardpoint_dataclasses import WeeklyProgram
+from ..guardpoint_utils import GuardPointResponse
+from ..guardpoint_error import GuardPointError, GuardPointUnauthorized
+
+
+class WeeklyProgramsAPI:
+
+    async def get_weekly_program(self, weekly_program_uid):
+        url = "/odata/API_WeeklyPrograms"
+        url_query_params = f"({weekly_program_uid})"
+        headers = {
+            'Content-Type': 'application/json',
+            'Accept': 'application/json',
+        }
+        code, json_body = await self.gp_json_query("GET", headers=headers, url=(url + url_query_params))
+
+        if code != 200:
+            error_msg = GuardPointResponse.extract_error_msg(json_body)
+
+            if code == 401:
+                raise GuardPointUnauthorized(f"Unauthorized - ({error_msg})")
+            elif code == 404:  # Not Found
+                return None
+            else:
+                raise GuardPointError(f"{error_msg}")
+
+        # Check response body is formatted as expected
+        if not isinstance(json_body, dict):
+            raise GuardPointError("Badly formatted response.")
+        if 'value' not in json_body:
+            raise GuardPointError("Badly formatted response.")
+        if not isinstance(json_body['value'], list):
+            raise GuardPointError("Badly formatted response.")
+
+        return WeeklyProgram(json_body['value'][0])
+
+    async def get_weekly_programs(self):
+        url = "/odata/API_WeeklyPrograms"
+
+        code, json_body = await self.gp_json_query("GET", url=url)
+
+        if code != 200:
+            error_msg = GuardPointResponse.extract_error_msg(json_body)
+
+            if code == 401:
+                raise GuardPointUnauthorized(f"Unauthorized - ({error_msg})")
+            elif code == 404:  # Not Found
+                raise GuardPointError(f"No WeeklyPrograms Found")
+            else:
+                raise GuardPointError(f"{error_msg}")
+
+        # Check response body is formatted as expected
+        if not isinstance(json_body, dict):
+            raise GuardPointError("Badly formatted response.")
+        if 'value' not in json_body:
+            raise GuardPointError("Badly formatted response.")
+        if not isinstance(json_body['value'], list):
+            raise GuardPointError("Badly formatted response.")
+
+        # Compose list of inputs
+        weekly_programs = []
+        for entry in json_body['value']:
+            if isinstance(entry, dict):
+                wp = WeeklyProgram(entry)
+                weekly_programs.append(wp)
+        return weekly_programs

{pyguardpoint-2.0.5 → pyguardpoint-2.0.7}/pyGuardPoint/gp_asyncio/guardpoint_connection_asyncio.py

@@ -204,7 +204,8 @@ class GuardPointConnection:
             headers['Authorization'] = auth_str
 
         log.debug(f"Request data: host={self.baseurl}, {method}, {url}, {headers}, {raw_body}")
-        url = self.baseurl + url
+        if 'http' not in url:
+            url = self.baseurl + url
 
         if method.lower() == "get":
             try:

{pyguardpoint-2.0.5 → pyguardpoint-2.0.7}/pyGuardPoint/guardpoint.py

@@ -6,6 +6,7 @@ from pysignalr.client import SignalRClient
 
 from .CustomWebsocketTransport import CustomWebsocketTransport, DEFAULT_PING_INTERVAL, DEFAULT_CONNECTION_TIMEOUT, \
     DEFAULT_MAX_SIZE
+from ._guardpoint_weeklyprograms import WeeklyProgramsAPI
 from ._guardpoint_alarmstates import AlarmStatesAPI
 from ._guardpoint_alarmzones import AlarmZonesAPI
 from ._guardpoint_cardholdertypes import CardholderTypesAPI
@@ -44,7 +45,7 @@ def stop_listening(client: SignalRClient):
 class GuardPoint(GuardPointConnection, CardsAPI, CardholdersAPI, AreasAPI, SecurityGroupsAPI, CustomizedFieldsAPI,
                  PersonalDetailsAPI, ScheduledMagsAPI, CardholderTypesAPI, OutputsAPI, DiagnosticAPI, ReadersAPI,
                  ControllersAPI, AlarmStatesAPI, EventsAPI, DepartmentsAPI, SitesAPI, AccessGroupsAPI, GenericInfoAPI,
-                 AlarmZonesAPI, InputsAPI, ManualEventsAPI):
+                 AlarmZonesAPI, InputsAPI, ManualEventsAPI, WeeklyProgramsAPI):
     """
     A class to interface with the GuardPoint system, providing various APIs for managing cards, cardholders, areas,
     security groups, customized fields, personal details, scheduled mags, cardholder types, outputs, diagnostics,

{pyguardpoint-2.0.5 → pyguardpoint-2.0.7}/pyGuardPoint/guardpoint_asyncio.py

@@ -2,6 +2,7 @@
 import logging
 import validators
 
+from .gp_asyncio._async_guardpoint_weeklyprograms import WeeklyProgramsAPI
 from .gp_asyncio._async_guardpoint_accessgroups import AccessGroupsAPI
 from .gp_asyncio._async_guardpoint_manualevents import ManualEventsAPI
 from .gp_asyncio._async_guardpoint_alarmzones import AlarmZonesAPI
@@ -34,7 +35,7 @@ class GuardPointAsyncIO(GuardPointConnection, CardsAPI, CardholdersAPI, AreasAPI
                         CustomizedFieldsAPI, PersonalDetailsAPI, ScheduledMagsAPI, CardholderTypesAPI,
                         OutputsAPI, DiagnosticAPI, ReadersAPI, ControllersAPI, AlarmStatesAPI, EventsAPI,
                         DepartmentsAPI, SitesAPI, GenericInfoAPI, AlarmZonesAPI, ManualEventsAPI,
-                        AccessGroupsAPI):
+                        AccessGroupsAPI, WeeklyProgramsAPI):
     """
     Asynchronous interface for interacting with the GuardPoint system, providing various APIs for managing cards,
     cardholders, areas, security groups, customized fields, personal details, scheduled mags, cardholder types,

{pyguardpoint-2.0.5 → pyguardpoint-2.0.7}/pyGuardPoint/guardpoint_dataclasses.py

@@ -62,6 +62,7 @@ class CardholderOrderBy(Enum):
     fromDateValid_DESC = 0,
     lastPassDate_DESC = 1
 
+
 @dataclass
 class CustomizedField:
     customizedFieldType: str = ""
@@ -97,6 +98,32 @@ class CustomizedField:
             else:
                 cf_dict[k] = str(v)
 
+@dataclass
+class WeeklyProgram:
+    uid: str = ""
+    name: str = ""
+    apiKey: any = None
+    description: any = None
+
+    def __init__(self, *args, **kwargs):
+        super().__init__()
+        me_dict = sanitise_args(self, args, kwargs)
+
+        for property_name in me_dict:
+            if isinstance(me_dict[property_name], (str, type(None), bool, int, dict)):
+                setattr(self, property_name, me_dict[property_name])
+
+    def dict(self):
+        me_dict = {}
+        for k, v in asdict(self).items():
+            if isinstance(v, (list, dict, bool, int)):
+                me_dict[k] = v
+            elif isinstance(v, type(None)):
+                me_dict[k] = None
+            else:
+                me_dict[k] = str(v)
+
+
 @dataclass
 class ManualEvent:
     uid: str = ""
@@ -515,7 +542,7 @@ class AccessEvent:
     accessDeniedCode: str = ""
     cardCode: str = ""
     cardholderFirstName: any = None
-    cardholderIdNumber: any = None
+    cardholderIdNumber: str = None
     cardholderLastName: any = None
     cardholderTypeName: any = None
     cardholderTypeUID: any = None
@@ -1105,7 +1132,7 @@ class Cardholder(Observable):
     uid: str = ""
     lastName: str = ""
     firstName: str = ""
-    cardholderIdNumber: any = None
+    cardholderIdNumber: str = ""
     status: any = None
     fromDateValid: any = None
     isFromDateActive: any = None
@@ -1134,6 +1161,7 @@ class Cardholder(Observable):
     securityGroupUID: str = ""
     accessGroupUIDs: any = None
     liftAccessGroupUIDs: any = None
+    personalCrisisLevel: int = 0
     lastDownloadTime: any = None
     lastInOutArea: str = ""
     lastInOutReaderUID: any = None
@@ -1144,6 +1172,8 @@ class Cardholder(Observable):
     lastReaderPassUID: any = None
     insideAreaUID: str = ""
     cards: list = None
+    #resetAPBLevelWhenDownload: bool = False
+    noAntiPassback: bool = False
 
     def __init__(self, *args, **kwargs):
         super().__init__()
@@ -1184,7 +1214,16 @@ class Cardholder(Observable):
                     self.cardholderCustomizedField = CardholderCustomizedField(cardholder_dict[property_name])
 
             if isinstance(cardholder_dict[property_name], (str, type(None), bool, int)):
-                setattr(self, property_name, cardholder_dict[property_name])
+                value = cardholder_dict[property_name]
+
+                try:
+                    if isinstance(getattr(self, property_name), str):
+                        value = str(value)
+                except:
+                    pass
+
+
+                setattr(self, property_name, value)
 
         # Monitor Changes
         for k, v in asdict(self).items():

{pyguardpoint-2.0.5 → pyguardpoint-2.0.7}/pyGuardPoint.egg-info/PKG-INFO

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

{pyguardpoint-2.0.5 → pyguardpoint-2.0.7}/pyGuardPoint.egg-info/SOURCES.txt

@@ -25,6 +25,7 @@ pyGuardPoint/_guardpoint_readers.py
 pyGuardPoint/_guardpoint_scheduledmags.py
 pyGuardPoint/_guardpoint_securitygroups.py
 pyGuardPoint/_guardpoint_sites.py
+pyGuardPoint/_guardpoint_weeklyprograms.py
 pyGuardPoint/_odata_filter.py
 pyGuardPoint/_str_match_algo.py
 pyGuardPoint/guardpoint.py
@@ -61,4 +62,5 @@ pyGuardPoint/gp_asyncio/_async_guardpoint_readers.py
 pyGuardPoint/gp_asyncio/_async_guardpoint_scheduledmags.py
 pyGuardPoint/gp_asyncio/_async_guardpoint_securitygroups.py
 pyGuardPoint/gp_asyncio/_async_guardpoint_sites.py
+pyGuardPoint/gp_asyncio/_async_guardpoint_weeklyprograms.py
 pyGuardPoint/gp_asyncio/guardpoint_connection_asyncio.py

{pyguardpoint-2.0.5 → pyguardpoint-2.0.7}/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.0.5",
+      version="2.0.7",
       author="John Owen",
       description="Python wrapper for GuardPoint 10 Access Control System",
       long_description_content_type='text/markdown',