staplus-client 0.3.3__py3-none-any.whl

staplus_client/query/query.py

@@ -0,0 +1,109 @@
+# Copyright (C) 2023-2024 Secure Dimensions GmbH, Munich, Germany.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+
+import staplus_client.utils
+import staplus_client.model.ext.entity_list
+from frost_sta_client.query import query
+
+import logging
+import requests
+from requests.exceptions import JSONDecodeError
+
+
+class Query(query.Query):
+    def __init__(self, service, entity, entitytype_plural, entity_class, parent):
+        super().__init__(service, entity, entitytype_plural, entity_class, parent)
+
+    @property
+    def service(self):
+        return self._service
+
+    @service.setter
+    def service(self, service):
+        if service is None:
+            self._service = service
+            return
+        if not isinstance(service, staplus_client.service.staplusservice.STAplusService):
+            raise ValueError('service should be of type STAplusService')
+        self._service = service
+
+    # exception: similar functions in basedao
+    def list(self, callback=None, step_size=None):
+        """
+        Get an entity collection as a dictionary
+        callbacks so far only work in combination with step_size. If step_size is set, then the callback function
+        is called at every iteration of the step_size
+        """
+        url = self.service.get_full_path(self.parent, self.entitytype_plural)
+        #slash = "" if str(furl.path).endswith('/') else "/"
+        #if self.parent is None:
+            #url = self.service.url.url + slash + self.entitytype_plural
+        #else:
+            #url = self.service.url.url + slash + self.entitytype_plural + '(' + str(self.parent.id) + ')/' + self.entity
+
+        #url = furl(url)
+        url.args = self.params
+        try:
+            response = self.service.execute('get', url)
+        except requests.exceptions.HTTPError as e:
+            error_json = e.response.json()
+            error_message = error_json['message']
+            logging.error("Query failed with status-code {}, {}".format(e.response.status_code, error_message))
+            raise e
+        logging.debug('Received response: {} from {}'.format(response.status_code, url))
+        try:
+            json_response = response.json()
+        except JSONDecodeError:
+            raise ValueError('Cannot find json in http response')
+        entity_list = staplus_client.utils.transform_json_to_entity_list(json_response, self.entity_class)
+        entity_list.set_service(self.service)
+
+        entity_list.callback = callback
+        entity_list.step_size = step_size
+
+        return entity_list
+    def item(self, callback=None, step_size=None):
+        """
+        Get an entity as a dictionary
+        callbacks so far only work in combination with step_size. If step_size is set, then the callback function
+        is called at every iteration of the step_size
+        """
+        url = self.service.get_full_path(self.parent, self.entity)
+        #slash = "" if str(furl.path).endswith('/') else "/"
+        #if self.parent is None:
+            #url = self.service.url.url + slash + self.entitytype_plural
+        #else:
+            #url = self.service.url.url + slash + self.entitytype_plural + '(' + str(self.parent.id) + ')/' + self.entity
+
+        #url = furl(url)
+        url.args = self.params
+        try:
+            response = self.service.execute('get', url)
+        except requests.exceptions.HTTPError as e:
+            error_json = e.response.json()
+            error_message = error_json['message']
+            logging.error("Query failed with status-code {}, {}".format(e.response.status_code, error_message))
+            raise e
+        logging.debug('Received response: {} from {}'.format(response.status_code, url))
+        try:
+            json_response = response.json()
+        except JSONDecodeError:
+            raise ValueError('Cannot find json in http response')
+        entity = staplus_client.utils.transform_json_to_entity(json_response, self.entity_class)
+        entity.set_service(self.service)
+
+        return entity

staplus_client/service/BearerAuth.py

@@ -0,0 +1,23 @@
+# Copyright (C) 2023-2024 Secure Dimensions GmbH, Munich, Germany.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import requests
+
+class BearerAuth(requests.auth.AuthBase):
+    def __init__(self, token):
+        self.token = token
+    def __call__(self, r):
+        r.headers["authorization"] = "Bearer " + self.token
+        return r

staplus_client/service/__init__.py

@@ -0,0 +1,17 @@
+# Copyright (C) 2023-2024 Secure Dimensions GmbH, Munich, Germany.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from staplus_client.service import staplusservice
+from staplus_client.service import auth_handler

staplus_client/service/auth_handler.py

@@ -0,0 +1,23 @@
+# Copyright (C) 2023-2024 Secure Dimensions GmbH, Munich, Germany.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from staplus_client.service.BearerAuth import BearerAuth
+class AuthHandler:
+    def __init__(self, token=""):
+        self.token  = token
+
+    def add_auth_header(self):
+        if not (self.token is None):
+            return BearerAuth(self.token)

staplus_client/service/staplusservice.py

@@ -0,0 +1,162 @@
+# Copyright (C) 2023-2024 Secure Dimensions GmbH, Munich, Germany.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import requests
+
+from staplus_client.service.auth_handler import AuthHandler as STAplusAuthHandler
+from frost_sta_client.service.auth_handler import AuthHandler as STAAuthHandler
+from frost_sta_client.service import sensorthingsservice
+
+from staplus_client.dao import observedproperty
+from staplus_client.dao import historical_location
+from staplus_client.dao import location
+from staplus_client.dao import features_of_interest
+from staplus_client.dao import datastream
+from staplus_client.dao import observation_group
+from staplus_client.dao import license
+from staplus_client.dao import multi_datastream
+from staplus_client.dao import observation
+from staplus_client.dao import party
+from staplus_client.dao import campaign
+from staplus_client.dao import relation
+from staplus_client.dao import thing
+from staplus_client.dao import sensor
+import staplus_client.model.ext.entity_type as staplus_entity_type
+
+class STAplusService(sensorthingsservice.SensorThingsService):
+    def __init__(self, url, auth_handler=None):
+        super().__init__(url, auth_handler)
+
+    def create(self, entity):
+        return entity.get_dao(self).create(entity)
+
+    def update(self, entity):
+        entity.get_dao(self).update(entity)
+
+    def patch(self, entity, patches):
+        entity.get_dao(self).patch(entity, patches)
+
+    def delete(self, entity):
+        entity.get_dao(self).delete(entity)
+
+    @property
+    def auth_handler(self):
+        return self._auth_handler
+
+    @auth_handler.setter
+    def auth_handler(self, value):
+        if value is None:
+            self._auth_handler = None
+            return
+        if (not isinstance(value, STAplusAuthHandler) and ( not isinstance(value, STAAuthHandler))):
+            raise ValueError('auth should be of type AuthHandler!')
+        self._auth_handler = value
+
+    def execute(self, method, url, **kwargs):
+        if self.auth_handler is not None:
+            response = requests.request(method, url, auth=self.auth_handler.add_auth_header(), **kwargs)
+        else:
+            response = requests.request(method, url, **kwargs)
+        try:
+            response.raise_for_status()
+        except requests.exceptions.HTTPError as e:
+            raise e
+
+        return response
+
+    def get_path(self, parent, relation):
+        if parent is None:
+            return relation
+        this_entity_type = staplus_entity_type.get_list_for_class(type(parent))
+        #this_entity_type = staplus_entity_type.EntityTypes[relation]['plural'] if relation in staplus_entity_type.EntityTypes.keys() else staplus_entity_type.get_list_for_class(type(parent))
+        if type(parent.id) == str:
+            return "{entity_type}('{id}')/{relation}".format(entity_type=this_entity_type, id=parent.id, relation=relation)
+        else:
+            return "{entity_type}({id})/{relation}".format(entity_type=this_entity_type, id=parent.id, relation=relation)
+
+    def party(self):
+        return party.PartyDao(self)
+
+    def parties(self):
+        return party.PartyDao(self)
+
+    def license(self):
+        return license.LicenseDao(self)
+
+    def licenses(self):
+        return license.LicenseDao(self)
+
+    def thing(self):
+        return thing.ThingDao(self)
+
+    def things(self):
+        return thing.ThingDao(self)
+
+    def sensor(self):
+        return sensor.SensorDao(self)
+
+    def sensors(self):
+        return sensor.SensorDao(self)
+
+    def datastream(self):
+        return datastream.DatastreamDao(self)
+
+    def datastreams(self):
+        return datastream.DatastreamDao(self)
+
+    def multi_datastream(self):
+        return multi_datastream.MultiDatastreamDao(self)
+
+    def multi_datastreams(self):
+        return multi_datastream.MultiDatastreamDao(self)
+
+    def observed_property(self):
+        return observedproperty.ObservedPropertyDao(self)
+
+    def observed_properties(self):
+        return observedproperty.ObservedPropertyDao(self)
+
+    def features_of_interest(self):
+        return features_of_interest.FeaturesOfInterestDao(self)
+
+    def historical_locations(self):
+        return historical_location.HistoricalLocationDao(self)
+
+    def locations(self):
+        return location.LocationDao(self)
+
+    def observations(self):
+        return observation.ObservationDao(self)
+
+    def campaigns(self):
+        return campaign.CampaignDao(self)
+
+    def relations(self):
+        return relation.RelationDao(self)
+
+    def subjects(self):
+        return relation.SubjectsDao(self)
+
+    def subject(self):
+        return observation.SubjectDao(self)
+
+    def objects(self):
+        return relation.ObjectsDao(self)
+
+    def object(self):
+        return observation.ObjectDao(self)
+
+    def observation_groups(self):
+        return observation_group.ObservationGroupDao(self)

staplus_client/utils.py

@@ -0,0 +1,64 @@
+# Copyright (C) 2023-2024 Secure Dimensions GmbH, Munich, Germany.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+import json
+
+import geojson
+import jsonpickle, sys
+
+from staplus_client.model.ext.entity_list import EntityList
+from staplus_client.model.thing import Thing
+from frost_sta_client import utils
+
+
+def transform_json_to_entity_list(json_response, entity_class):
+    entity_list = EntityList(entity_class)
+    response_list = []
+    if isinstance(json_response, dict):
+        try:
+            response_list = json_response['value']
+            entity_list.next_link = json_response.get("@iot.nextLink", None)
+            entity_list.count = json_response.get("@iot.count", None)
+        except AttributeError as e:
+            raise e
+    elif isinstance(json_response, list):
+        response_list = json_response
+    else:
+        raise ValueError("expected json as a dict or list to transform into entity list")
+    entity_list.entities = [transform_json_to_entity(item, entity_list.entity_class) for item in response_list]
+    return entity_list
+
+
+def transform_json_to_entity(json_response, entity_class):
+    return utils.transform_json_to_entity(json_response, entity_class)
+
+def transform_entity_to_json_dict(entity):
+    data = utils.transform_entity_to_json_dict(entity)
+    if 'feature' in data and type(data['feature']) != dict:
+        data['feature'] = json.loads(geojson.dumps(entity.feature))
+    if 'location' in data and type(data['location']) != dict:
+        data['location'] = json.loads(geojson.dumps(entity.location))
+    if type(entity) == Thing and entity.locations is not None and type(entity.locations) != dict:
+        locations = []
+        for l in entity.locations:
+            location = transform_entity_to_json_dict(l)
+            #location['location'] = json.loads(geojson.dumps(l.location))
+            locations.append(location)
+
+        data['Locations'] = locations
+
+    return data
+
+def class_from_string(string):
+    return utils.class_from_string(string)

staplus_client-0.3.3.dist-info/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.