pushi 0.4.3__py3-none-any.whl

pushi/__init__.py

@@ -0,0 +1,42 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Hive Pushi System
+# Copyright (c) 2008-2024 Hive Solutions Lda.
+#
+# This file is part of Hive Pushi System.
+#
+# Hive Pushi System is free software: you can redistribute it and/or modify
+# it under the terms of the Apache License as published by the Apache
+# Foundation, either version 2.0 of the License, or (at your option) any
+# later version.
+#
+# Hive Pushi System 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
+# Apache License for more details.
+#
+# You should have received a copy of the Apache License along with
+# Hive Pushi System. If not, see <http://www.apache.org/licenses/>.
+
+__copyright__ = "Copyright (c) 2008-2024 Hive Solutions Lda."
+""" The copyright for the module """
+
+__license__ = "Apache License, Version 2.0"
+""" The license for the module """
+
+from . import apn
+from . import app
+from . import base
+from . import event
+from . import subscription
+from . import web
+from . import web_push
+
+from .apn import APNAPI
+from .app import AppAPI
+from .base import BASE_URL, BASE_WS_URL, API
+from .event import EventAPI
+from .subscription import SubscriptionAPI
+from .web import WebAPI
+from .web_push import WebPushAPI

pushi/apn.py

@@ -0,0 +1,57 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Hive Pushi System
+# Copyright (c) 2008-2024 Hive Solutions Lda.
+#
+# This file is part of Hive Pushi System.
+#
+# Hive Pushi System is free software: you can redistribute it and/or modify
+# it under the terms of the Apache License as published by the Apache
+# Foundation, either version 2.0 of the License, or (at your option) any
+# later version.
+#
+# Hive Pushi System 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
+# Apache License for more details.
+#
+# You should have received a copy of the Apache License along with
+# Hive Pushi System. If not, see <http://www.apache.org/licenses/>.
+
+__author__ = "João Magalhães <joamag@hive.pt>"
+""" The author(s) of the module """
+
+__copyright__ = "Copyright (c) 2008-2024 Hive Solutions Lda."
+""" The copyright for the module """
+
+__license__ = "Apache License, Version 2.0"
+""" The license for the module """
+
+
+class APNAPI(object):
+    def create_apn(self, token, event, auth=None, unsubscribe=True):
+        # runs the APN subscription operation for the provided
+        # token and event, this operation uses the currently
+        # defined app id for the operation, then returns the
+        # resulting dictionary to the caller method
+        result = self.post(
+            self.base_url + "apns",
+            params=dict(auth=auth, unsubscribe=unsubscribe),
+            data_j=dict(token=token, event=event),
+        )
+        return result
+
+    def delete_apn(self, token, event):
+        # runs the unsubscription operation for the provided
+        # user id and event, this operation uses the currently
+        # defined app id for the operation, then returns the
+        # resulting dictionary to the caller method
+        result = self.delete(self.base_url + "apns/%s/%s" % (token, event))
+        return result
+
+    def subscribe_apn(self, *args, **kwargs):
+        return self.create_apn(*args, **kwargs)
+
+    def unsubscribe_apn(self, *args, **kwargs):
+        return self.delete_apn(*args, **kwargs)

pushi/app.py

@@ -0,0 +1,49 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Hive Pushi System
+# Copyright (c) 2008-2024 Hive Solutions Lda.
+#
+# This file is part of Hive Pushi System.
+#
+# Hive Pushi System is free software: you can redistribute it and/or modify
+# it under the terms of the Apache License as published by the Apache
+# Foundation, either version 2.0 of the License, or (at your option) any
+# later version.
+#
+# Hive Pushi System 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
+# Apache License for more details.
+#
+# You should have received a copy of the Apache License along with
+# Hive Pushi System. If not, see <http://www.apache.org/licenses/>.
+
+__author__ = "João Magalhães <joamag@hive.pt>"
+""" The author(s) of the module """
+
+__copyright__ = "Copyright (c) 2008-2024 Hive Solutions Lda."
+""" The copyright for the module """
+
+__license__ = "Apache License, Version 2.0"
+""" The license for the module """
+
+
+class AppAPI(object):
+    def create_app(self, name):
+        # runs the post call that will create the app with the provided
+        # name then returns the returning map to the caller method, it
+        # should contain the generated information for the app
+        result = self.post(self.base_url + "apps", auth=False, data_j=dict(name=name))
+        return result
+
+    def update_app(self, app_id=None, **kwargs):
+        # retrieves the proper app id to be used defaulting to the current
+        # defined app id in case none is provided
+        app_id = app_id or self.app_id
+
+        # runs the pit call that will create the app with the provided
+        # name then returns the returning map to the caller method, it
+        # should contain the newly updated information for the app
+        result = self.put(self.base_url + "apps/%s" % app_id, data_j=kwargs)
+        return result

pushi/base.py

@@ -0,0 +1,154 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Hive Pushi System
+# Copyright (c) 2008-2024 Hive Solutions Lda.
+#
+# This file is part of Hive Pushi System.
+#
+# Hive Pushi System is free software: you can redistribute it and/or modify
+# it under the terms of the Apache License as published by the Apache
+# Foundation, either version 2.0 of the License, or (at your option) any
+# later version.
+#
+# Hive Pushi System 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
+# Apache License for more details.
+#
+# You should have received a copy of the Apache License along with
+# Hive Pushi System. If not, see <http://www.apache.org/licenses/>.
+
+__author__ = "João Magalhães <joamag@hive.pt>"
+""" The author(s) of the module """
+
+__copyright__ = "Copyright (c) 2008-2024 Hive Solutions Lda."
+""" The copyright for the module """
+
+__license__ = "Apache License, Version 2.0"
+""" The license for the module """
+
+import hmac
+import hashlib
+
+import appier
+
+from . import apn
+from . import app
+from . import web
+from . import web_push
+from . import event
+from . import subscription
+
+BASE_URL = "https://puxiapp.com:9090/"
+""" The base URL to be used by the API to access
+the remote endpoints, should not be changed """
+
+BASE_WS_URL = "wss://puxiapp.com/"
+""" The default base websockets url that is going
+to be used in case no other value is specified """
+
+
+class API(
+    appier.API,
+    apn.APNAPI,
+    app.AppAPI,
+    web.WebAPI,
+    web_push.WebPushAPI,
+    event.EventAPI,
+    subscription.SubscriptionAPI,
+):
+    """
+    Base class for the construction of the pushi
+    proxy object for interaction with the server
+    side of the pushi system.
+
+    Should provide the various methods that enable
+    the developer to make operations for both read
+    and write (create and read).
+    """
+
+    def __init__(self, *args, **kwargs):
+        appier.API.__init__(self, *args, **kwargs)
+        self.app_id = appier.conf("PUSHI_ID", None)
+        self.app_key = appier.conf("PUSHI_KEY", None)
+        self.app_secret = appier.conf("PUSHI_SECRET", None)
+        self.base_url = appier.conf("PUSHI_URL", BASE_URL)
+        self.app_id = kwargs.get("app_id", self.app_id)
+        self.app_key = kwargs.get("app_key", self.app_key)
+        self.app_secret = kwargs.get("app_secret", self.app_secret)
+        self.base_url = kwargs.get("base_url", self.base_url)
+        self.token = None
+
+    def build(
+        self,
+        method,
+        url,
+        data=None,
+        data_j=None,
+        data_m=None,
+        headers=None,
+        params=None,
+        mime=None,
+        kwargs=None,
+    ):
+        auth = kwargs.pop("auth", True)
+        if auth:
+            kwargs["sid"] = self.get_token()
+
+    def get_token(self):
+        if self.token:
+            return self.token
+        return self.login()
+
+    def auth_callback(self, params, headers):
+        token = self.login()
+        params["sid"] = token
+
+    def login(self):
+        # tries to login in the pushi infra-structure using the
+        # login route together with the full set of auth info
+        # retrieving the result map that should contain the
+        # session token, to be used in further calls
+        result = self.get(
+            self.base_url + "login",
+            callback=False,
+            auth=False,
+            app_id=self.app_id,
+            app_key=self.app_key,
+            app_secret=self.app_secret,
+        )
+
+        # unpacks the token value from the result map and then
+        # returns the token to the caller method
+        self.token = result["token"]
+        return self.token
+
+    def logout(self):
+        # runs the "simplistic" call to the logout operation so
+        # that the session is invalidated from the server side
+        self.get(self.base_url + "logout")
+
+        # invalidates the currently set token so that it's no longer
+        # going to be used for any kind of operation
+        self.token = None
+
+    def authenticate(self, channel, socket_id):
+        # in case the app key is not defined for the current
+        # instance an exception must be raised as it's not possible
+        # to run the authentication process without an app key
+        if not self.app_key:
+            raise RuntimeError("No app key defined")
+
+        # creates the string to hashed using both the provided
+        # socket id and channel (concatenation)
+        string = "%s:%s" % (socket_id, channel)
+        string = appier.legacy.bytes(string)
+
+        # runs the HMAC encryption in the provided secret and
+        # the constructed string and returns a string containing
+        # both the key and the hexadecimal digest
+        app_secret = appier.legacy.bytes(str(self.app_secret))
+        structure = hmac.new(app_secret, string, hashlib.sha256)
+        digest = structure.hexdigest()
+        return "%s:%s" % (self.app_key, digest)

pushi/event.py

@@ -0,0 +1,47 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Hive Pushi System
+# Copyright (c) 2008-2024 Hive Solutions Lda.
+#
+# This file is part of Hive Pushi System.
+#
+# Hive Pushi System is free software: you can redistribute it and/or modify
+# it under the terms of the Apache License as published by the Apache
+# Foundation, either version 2.0 of the License, or (at your option) any
+# later version.
+#
+# Hive Pushi System 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
+# Apache License for more details.
+#
+# You should have received a copy of the Apache License along with
+# Hive Pushi System. If not, see <http://www.apache.org/licenses/>.
+
+__author__ = "João Magalhães <joamag@hive.pt>"
+""" The author(s) of the module """
+
+__copyright__ = "Copyright (c) 2008-2024 Hive Solutions Lda."
+""" The copyright for the module """
+
+__license__ = "Apache License, Version 2.0"
+""" The license for the module """
+
+
+class EventAPI(object):
+    def create_event(self, channel, data, event="message", persist=True, **kwargs):
+        # creates the initial JSON data structure to be used as the message
+        # and then "extends" it with the extra key word arguments passed
+        # to this methods as a method of extension
+        data_j = dict(data=data, event=event, channel=channel, persist=persist)
+        for key in kwargs:
+            data_j[key] = kwargs[key]
+
+        # performs the concrete event trigger operation creating an event
+        # with the provided information using a secure channel
+        result = self.post(self.base_url + "events", data_j=data_j)
+        return result
+
+    def trigger_event(self, *args, **kwargs):
+        return self.create_event(*args, **kwargs)

pushi/subscription.py

@@ -0,0 +1,55 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Hive Pushi System
+# Copyright (c) 2008-2024 Hive Solutions Lda.
+#
+# This file is part of Hive Pushi System.
+#
+# Hive Pushi System is free software: you can redistribute it and/or modify
+# it under the terms of the Apache License as published by the Apache
+# Foundation, either version 2.0 of the License, or (at your option) any
+# later version.
+#
+# Hive Pushi System 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
+# Apache License for more details.
+#
+# You should have received a copy of the Apache License along with
+# Hive Pushi System. If not, see <http://www.apache.org/licenses/>.
+
+__author__ = "João Magalhães <joamag@hive.pt>"
+""" The author(s) of the module """
+
+__copyright__ = "Copyright (c) 2008-2024 Hive Solutions Lda."
+""" The copyright for the module """
+
+__license__ = "Apache License, Version 2.0"
+""" The license for the module """
+
+
+class SubscriptionAPI(object):
+    def create_subscription(self, user_id, event):
+        # runs the subscription operation for the provided
+        # user id and event, this operation uses the currently
+        # defined app id for the operation, then returns the
+        # resulting dictionary to the caller method
+        result = self.post(
+            self.base_url + "subscriptions", data_j=dict(user_id=user_id, event=event)
+        )
+        return result
+
+    def delete_subscription(self, user_id, event):
+        # runs the unsubscription operation for the provided
+        # user id and event, this operation uses the currently
+        # defined app id for the operation, then returns the
+        # resulting dictionary to the caller method
+        result = self.delete(self.base_url + "subscriptions/%s/%s" % (user_id, event))
+        return result
+
+    def subscribe(self, *args, **kwargs):
+        return self.create_subscription(*args, **kwargs)
+
+    def unsubscribe(self, *args, **kwargs):
+        return self.delete_subscription(*args, **kwargs)

pushi/web.py

@@ -0,0 +1,57 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Hive Pushi System
+# Copyright (c) 2008-2024 Hive Solutions Lda.
+#
+# This file is part of Hive Pushi System.
+#
+# Hive Pushi System is free software: you can redistribute it and/or modify
+# it under the terms of the Apache License as published by the Apache
+# Foundation, either version 2.0 of the License, or (at your option) any
+# later version.
+#
+# Hive Pushi System 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
+# Apache License for more details.
+#
+# You should have received a copy of the Apache License along with
+# Hive Pushi System. If not, see <http://www.apache.org/licenses/>.
+
+__author__ = "João Magalhães <joamag@hive.pt>"
+""" The author(s) of the module """
+
+__copyright__ = "Copyright (c) 2008-2024 Hive Solutions Lda."
+""" The copyright for the module """
+
+__license__ = "Apache License, Version 2.0"
+""" The license for the module """
+
+
+class WebAPI(object):
+    def create_web(self, url, event, auth=None, unsubscribe=True):
+        # runs the Web (Hook) subscription operation for the provided
+        # url and event, this operation uses the currently
+        # defined app id for the operation, then returns the
+        # resulting dictionary to the caller method
+        result = self.post(
+            self.base_url + "webs",
+            params=dict(auth=auth, unsubscribe=unsubscribe),
+            data_j=dict(url=url, event=event),
+        )
+        return result
+
+    def delete_web(self, url, event):
+        # runs the unsubscription operation for the provided
+        # user id and event, this operation uses the currently
+        # defined app id for the operation, then returns the
+        # resulting dictionary to the caller method
+        result = self.delete(self.base_url + "webs/%s/%s" % (url, event))
+        return result
+
+    def subscribe_web(self, *args, **kwargs):
+        return self.create_web(*args, **kwargs)
+
+    def unsubscribe_web(self, *args, **kwargs):
+        return self.delete_web(*args, **kwargs)

pushi/web_push.py

@@ -0,0 +1,91 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Hive Pushi System
+# Copyright (c) 2008-2024 Hive Solutions Lda.
+#
+# This file is part of Hive Pushi System.
+#
+# Hive Pushi System is free software: you can redistribute it and/or modify
+# it under the terms of the Apache License as published by the Apache
+# Foundation, either version 2.0 of the License, or (at your option) any
+# later version.
+#
+# Hive Pushi System 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
+# Apache License for more details.
+#
+# You should have received a copy of the Apache License along with
+# Hive Pushi System. If not, see <http://www.apache.org/licenses/>.
+
+__author__ = "João Magalhães <joamag@hive.pt>"
+""" The author(s) of the module """
+
+__copyright__ = "Copyright (c) 2008-2024 Hive Solutions Lda."
+""" The copyright for the module """
+
+__license__ = "Apache License, Version 2.0"
+""" The license for the module """
+
+import appier
+
+
+class WebPushAPI(object):
+    def create_web_push(
+        self, endpoint, p256dh, auth, event, auth_token=None, unsubscribe=True
+    ):
+        # runs the Web Push subscription operation for the provided
+        # endpoint and event, this operation uses the currently
+        # defined app id for the operation, then returns the
+        # resulting dictionary to the caller method
+        result = self.post(
+            self.base_url + "web_pushes",
+            params=dict(auth=auth_token, unsubscribe=unsubscribe),
+            data_j=dict(endpoint=endpoint, p256dh=p256dh, auth=auth, event=event),
+        )
+        return result
+
+    def delete_web_push(self, endpoint, event=None):
+        # runs the unsubscription operation for the provided
+        # endpoint, optionally filtered by event; this operation
+        # uses the currently defined app id for the operation,
+        # then returns the resulting dictionary to the caller method
+        endpoint_encoded = appier.legacy.quote(endpoint, safe="")
+        params = dict()
+        if event:
+            params["event"] = event
+        result = self.delete(
+            self.base_url + "web_pushes/%s" % endpoint_encoded, params=params
+        )
+        return result
+
+    def delete_web_pushes(self, endpoint):
+        # runs the unsubscription operation for all subscriptions
+        # associated with the provided endpoint, this is an alias
+        # for delete_web_push without an event filter
+        return self.delete_web_push(endpoint)
+
+    def list_web_pushes(self, endpoint=None, event=None):
+        # runs the list operation for the Web Push subscriptions
+        # with optional filtering by endpoint and/or event
+        params = dict()
+        if endpoint:
+            params["endpoint"] = endpoint
+        if event:
+            params["event"] = event
+        result = self.get(self.base_url + "web_pushes", params=params)
+        return result
+
+    def get_vapid_public_key(self):
+        # retrieves the VAPID public key for the current app,
+        # this key is needed by browsers to subscribe to push
+        # notifications using the Web Push API
+        result = self.get(self.base_url + "apps/vapid_key")
+        return result
+
+    def subscribe_web_push(self, *args, **kwargs):
+        return self.create_web_push(*args, **kwargs)
+
+    def unsubscribe_web_push(self, *args, **kwargs):
+        return self.delete_web_push(*args, **kwargs)

pushi-0.4.3.dist-info/METADATA

@@ -0,0 +1,38 @@
+Metadata-Version: 2.4
+Name: pushi
+Version: 0.4.3
+Summary: Pushi System API
+Home-page: http://pushi.hive.pt
+Author: Hive Solutions Lda.
+Author-email: development@hive.pt
+License: Apache License, Version 2.0
+Keywords: pushi websocket
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Topic :: Utilities
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.6
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.0
+Classifier: Programming Language :: Python :: 3.1
+Classifier: Programming Language :: Python :: 3.2
+Classifier: Programming Language :: Python :: 3.3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: appier
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary

pushi-0.4.3.dist-info/RECORD

@@ -0,0 +1,12 @@
+pushi/__init__.py,sha256=IQvc_g5jNMIhk4zVKriXmkiX1KDFPeEgbKLbVALLs4k,1351
+pushi/apn.py,sha256=4puKNSPelGYiJx1FFTdvXgYXD-WNS4RPeyXWu3R3CDs,2193
+pushi/app.py,sha256=QYED1UOjEV0wTeXUb65-Or8VgQKBCMJ4Md98DU1NeiQ,1973
+pushi/base.py,sha256=jcSRW50x6eryJ94aYNGQgBrv5eVskCryT9hL3cMWnAA,5111
+pushi/event.py,sha256=NGwyofq6aYpCWDPQUrnkcu6jUz5pL3aVprOORbBavIc,1857
+pushi/subscription.py,sha256=eEWeVPcEKKIkKWPxquriTuSL0nhtjgrAl70OR1jcmPA,2151
+pushi/web.py,sha256=KHGky4uea2IrfrLejYodYMrfw2KUN1sSm_YLgI4c6mw,2188
+pushi/web_push.py,sha256=jTQfQFfLfs8_Z8wYMQiTiifEBN7kpfWpkYr761zauoQ,3563
+pushi-0.4.3.dist-info/METADATA,sha256=ZjoXhR7rhNjJ38Rv_3VzcD0SLvnz6YRRgVXNhDalwx0,1399
+pushi-0.4.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pushi-0.4.3.dist-info/top_level.txt,sha256=EuDOnv7scnscLwsRnfhIJQcAP48nyBdbzYbrGNFT-3w,6
+pushi-0.4.3.dist-info/RECORD,,

pushi-0.4.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pushi-0.4.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+pushi