freenub 0.1.0__tar.gz

freenub-0.1.0/LICENSE

@@ -0,0 +1,27 @@
+PubNub Real-time Cloud-Hosted Push API and Push Notification Client Frameworks
+Copyright (c) 2013 PubNub Inc.
+http://www.pubnub.com/
+http://www.pubnub.com/terms
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+PubNub Real-time Cloud-Hosted Push API and Push Notification Client Frameworks
+Copyright (c) 2013 PubNub Inc.
+http://www.pubnub.com/
+http://www.pubnub.com/terms

freenub-0.1.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.1
+Name: freenub
+Version: 0.1.0
+Summary: This is a fork of pubnub when it still had an MIT license
+Home-page: https://github.com/bdraco/freenub
+License: MIT
+Author: J. Nick Koston
+Author-email: nick@koston.org
+Requires-Python: >=3.8,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: aiohttp (>=3.9.5,<4.0.0)
+Requires-Dist: cbor2 (>=5.6.4,<6.0.0)
+Requires-Dist: pycryptodomex (>=3.3)
+Requires-Dist: requests (>=2.4)
+Project-URL: Bug Tracker, https://github.com/bdraco/freenub/issues
+Project-URL: Changelog, https://github.com/bdraco/freenub/blob/main/CHANGELOG.md
+Project-URL: Repository, https://github.com/bdraco/freenub
+Description-Content-Type: text/markdown
+
+# freenub
+
+<p align="center">
+  <a href="https://github.com/bdraco/freenub/actions/workflows/ci.yml?query=branch%3Amain">
+    <img src="https://img.shields.io/github/actions/workflow/status/bdraco/freenub/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
+  </a>
+  <a href="https://codecov.io/gh/bdraco/freenub">
+    <img src="https://img.shields.io/codecov/c/github/bdraco/freenub.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
+  </a>
+</p>
+<p align="center">
+  <a href="https://python-poetry.org/">
+    <img src="https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json" alt="Poetry">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff">
+  </a>
+  <a href="https://github.com/pre-commit/pre-commit">
+    <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
+  </a>
+</p>
+<p align="center">
+  <a href="https://pypi.org/project/freenub/">
+    <img src="https://img.shields.io/pypi/v/freenub.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/freenub.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
+  <img src="https://img.shields.io/pypi/l/freenub.svg?style=flat-square" alt="License">
+</p>
+
+---
+
+**Source Code**: <a href="https://github.com/bdraco/freenub" target="_blank">https://github.com/bdraco/freenub </a>
+
+---
+
+This is a fork of pubnub when it still had an MIT license
+
+## Installation
+
+Install this via pip (or your favourite package manager):
+
+`pip install freenub`
+
+## Usage
+
+Start by importing it:
+
+```python
+import freenub
+```
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- prettier-ignore-start -->
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- markdownlint-disable -->
+<!-- markdownlint-enable -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- prettier-ignore-end -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+## Credits
+
+This package was created with
+[Copier](https://copier.readthedocs.io/) and the
+[browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template)
+project template.
+

freenub-0.1.0/README.md

@@ -0,0 +1,70 @@
+# freenub
+
+<p align="center">
+  <a href="https://github.com/bdraco/freenub/actions/workflows/ci.yml?query=branch%3Amain">
+    <img src="https://img.shields.io/github/actions/workflow/status/bdraco/freenub/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
+  </a>
+  <a href="https://codecov.io/gh/bdraco/freenub">
+    <img src="https://img.shields.io/codecov/c/github/bdraco/freenub.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
+  </a>
+</p>
+<p align="center">
+  <a href="https://python-poetry.org/">
+    <img src="https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json" alt="Poetry">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff">
+  </a>
+  <a href="https://github.com/pre-commit/pre-commit">
+    <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
+  </a>
+</p>
+<p align="center">
+  <a href="https://pypi.org/project/freenub/">
+    <img src="https://img.shields.io/pypi/v/freenub.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/freenub.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
+  <img src="https://img.shields.io/pypi/l/freenub.svg?style=flat-square" alt="License">
+</p>
+
+---
+
+**Source Code**: <a href="https://github.com/bdraco/freenub" target="_blank">https://github.com/bdraco/freenub </a>
+
+---
+
+This is a fork of pubnub when it still had an MIT license
+
+## Installation
+
+Install this via pip (or your favourite package manager):
+
+`pip install freenub`
+
+## Usage
+
+Start by importing it:
+
+```python
+import freenub
+```
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- prettier-ignore-start -->
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- markdownlint-disable -->
+<!-- markdownlint-enable -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- prettier-ignore-end -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+## Credits
+
+This package was created with
+[Copier](https://copier.readthedocs.io/) and the
+[browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template)
+project template.

freenub-0.1.0/pubnub/__init__.py

@@ -0,0 +1,21 @@
+import logging
+import os
+
+PUBNUB_ROOT = os.path.dirname(os.path.abspath(__file__))
+
+__version__ = "0.1.0"
+
+
+def set_stream_logger(
+    name="pubnub", level=logging.ERROR, format_string=None, stream=None
+):
+    if format_string is None:
+        format_string = "%(asctime)s %(name)s [%(levelname)s] %(message)s"
+
+    logger = logging.getLogger(name)
+    logger.setLevel(level)
+    handler = logging.StreamHandler(stream)
+    handler.setLevel(level)
+    formatter = logging.Formatter(format_string)
+    handler.setFormatter(formatter)
+    logger.addHandler(handler)

freenub-0.1.0/pubnub/builders.py

@@ -0,0 +1,69 @@
+from abc import ABCMeta, abstractmethod
+
+from . import utils
+from .dtos import SubscribeOperation, UnsubscribeOperation
+
+
+class PubSubBuilder:
+    __metaclass__ = ABCMeta
+
+    def __init__(self, subscription_manager):
+        self._subscription_manager = subscription_manager
+        self._channel_subscriptions = []
+        self._channel_group_subscriptions = []
+
+    # TODO: make the 'channel' alias
+    def channels(self, channels_list):
+        utils.extend_list(self._channel_subscriptions, channels_list)
+
+        return self
+
+    def channel_groups(self, channel_groups_list):
+        utils.extend_list(self._channel_group_subscriptions, channel_groups_list)
+
+        return self
+
+    @abstractmethod
+    def execute(self):
+        pass
+
+
+class SubscribeBuilder(PubSubBuilder):
+    def __init__(self, subscription_manager):
+        super().__init__(subscription_manager)
+        self._presence_enabled = False
+        self._timetoken = 0
+
+    def with_presence(self):
+        self._presence_enabled = True
+        return self
+
+    def with_timetoken(self, timetoken):
+        self._timetoken = timetoken
+        return self
+
+    def channel_subscriptions(self):
+        return self._channel_subscriptions
+
+    def channel_group_subscriptions(self):
+        return self._channel_group_subscriptions
+
+    def execute(self):
+        subscribe_operation = SubscribeOperation(
+            channels=self._channel_subscriptions,
+            channel_groups=self._channel_group_subscriptions,
+            timetoken=self._timetoken,
+            presence_enabled=self._presence_enabled,
+        )
+
+        self._subscription_manager.adapt_subscribe_builder(subscribe_operation)
+
+
+class UnsubscribeBuilder(PubSubBuilder):
+    def execute(self):
+        unsubscribe_operation = UnsubscribeOperation(
+            channels=self._channel_subscriptions,
+            channel_groups=self._channel_group_subscriptions,
+        )
+
+        self._subscription_manager.adapt_unsubscribe_builder(unsubscribe_operation)

freenub-0.1.0/pubnub/callbacks.py

@@ -0,0 +1,47 @@
+from abc import ABCMeta, abstractmethod
+
+
+class PNCallback:
+    @abstractmethod
+    def on_response(self, x, status):
+        pass
+
+
+class SubscribeCallback:
+    __metaclass__ = ABCMeta
+
+    @abstractmethod
+    def status(self, pubnub, status):
+        pass
+
+    @abstractmethod
+    def message(self, pubnub, message):
+        pass
+
+    @abstractmethod
+    def presence(self, pubnub, presence):
+        pass
+
+    def signal(self, pubnub, signal):
+        pass
+
+    def channel(self, pubnub, channel):
+        pass
+
+    def uuid(self, pubnub, uuid):
+        pass
+
+    def membership(self, pubnub, membership):
+        pass
+
+    def message_action(self, pubnub, message_action):
+        pass
+
+    def file(self, pubnub, file_message):
+        pass
+
+
+class ReconnectionCallback:
+    @abstractmethod
+    def on_reconnect(self):
+        pass

freenub-0.1.0/pubnub/crypto.py

@@ -0,0 +1,125 @@
+import hashlib
+import json
+import random
+from base64 import decodebytes, encodebytes
+
+from Cryptodome.Cipher import AES
+from Cryptodome.Util.Padding import pad, unpad
+
+from pubnub.crypto_core import PubNubCrypto
+
+Initial16bytes = "0123456789012345"
+
+
+class PubNubCryptodome(PubNubCrypto):
+    mode = AES.MODE_CBC
+    fallback_mode = None
+
+    def __init__(self, pubnub_config):
+        self.pubnub_configuration = pubnub_config
+        self.mode = pubnub_config.cipher_mode
+        self.fallback_mode = pubnub_config.fallback_cipher_mode
+
+    def encrypt(self, key, msg, use_random_iv=False):
+        secret = self.get_secret(key)
+        initialization_vector = self.get_initialization_vector(use_random_iv)
+
+        cipher = AES.new(
+            bytes(secret[0:32], "utf-8"),
+            self.mode,
+            bytes(initialization_vector, "utf-8"),
+        )
+        encrypted_message = cipher.encrypt(self.pad(msg.encode("utf-8")))
+        msg_with_iv = self.append_random_iv(
+            encrypted_message, use_random_iv, bytes(initialization_vector, "utf-8")
+        )
+
+        return encodebytes(msg_with_iv).decode("utf-8").replace("\n", "")
+
+    def decrypt(self, key, msg, use_random_iv=False):
+        secret = self.get_secret(key)
+
+        decoded_message = decodebytes(msg.encode("utf-8"))
+        initialization_vector, extracted_message = self.extract_random_iv(
+            decoded_message, use_random_iv
+        )
+        cipher = AES.new(bytes(secret[0:32], "utf-8"), self.mode, initialization_vector)
+        try:
+            plain = self.depad((cipher.decrypt(extracted_message)).decode("utf-8"))
+        except UnicodeDecodeError as e:
+            if not self.fallback_mode:
+                raise e
+
+            cipher = AES.new(
+                bytes(secret[0:32], "utf-8"), self.fallback_mode, initialization_vector
+            )
+            plain = self.depad((cipher.decrypt(extracted_message)).decode("utf-8"))
+
+        try:
+            return json.loads(plain)
+        except Exception:
+            return plain
+
+    def append_random_iv(self, message, use_random_iv, initialization_vector):
+        if self.pubnub_configuration.use_random_initialization_vector or use_random_iv:
+            return initialization_vector + message
+        else:
+            return message
+
+    def extract_random_iv(self, message, use_random_iv):
+        if self.pubnub_configuration.use_random_initialization_vector or use_random_iv:
+            return message[0:16], message[16:]
+        else:
+            return bytes(Initial16bytes, "utf-8"), message
+
+    def get_initialization_vector(self, use_random_iv):
+        if self.pubnub_configuration.use_random_initialization_vector or use_random_iv:
+            return f"{random.randint(0, 9999999999999999):016}"
+        else:
+            return Initial16bytes
+
+    def pad(self, msg, block_size=16):
+        padding = block_size - (len(msg) % block_size)
+        return msg + (chr(padding) * padding).encode("utf-8")
+
+    def depad(self, msg):
+        return msg[0 : -ord(msg[-1])]
+
+    def get_secret(self, key):
+        return hashlib.sha256(key.encode("utf-8")).hexdigest()
+
+
+class PubNubFileCrypto(PubNubCryptodome):
+    def encrypt(self, key, file):
+        secret = self.get_secret(key)
+        initialization_vector = self.get_initialization_vector(use_random_iv=True)
+        cipher = AES.new(
+            bytes(secret[0:32], "utf-8"),
+            self.mode,
+            bytes(initialization_vector, "utf-8"),
+        )
+        initialization_vector = bytes(initialization_vector, "utf-8")
+
+        return self.append_random_iv(
+            cipher.encrypt(pad(file, 16)),
+            use_random_iv=True,
+            initialization_vector=initialization_vector,
+        )
+
+    def decrypt(self, key, file):
+        secret = self.get_secret(key)
+        initialization_vector, extracted_file = self.extract_random_iv(
+            file, use_random_iv=True
+        )
+        try:
+            cipher = AES.new(
+                bytes(secret[0:32], "utf-8"), self.mode, initialization_vector
+            )
+            result = unpad(cipher.decrypt(extracted_file), 16)
+        except ValueError:
+            cipher = AES.new(
+                bytes(secret[0:32], "utf-8"), self.fallback_mode, initialization_vector
+            )
+            result = unpad(cipher.decrypt(extracted_file), 16)
+
+        return result

freenub-0.1.0/pubnub/crypto_core.py

@@ -0,0 +1,11 @@
+from abc import abstractmethod
+
+
+class PubNubCrypto:
+    @abstractmethod
+    def encrypt(self, key, msg):
+        pass
+
+    @abstractmethod
+    def decrypt(self, key, msg):
+        pass

freenub-0.1.0/pubnub/dtos.py

@@ -0,0 +1,29 @@
+class SubscribeOperation:
+    def __init__(
+        self, channels=None, channel_groups=None, presence_enabled=None, timetoken=None
+    ):
+        assert isinstance(channels, (list, tuple))
+        assert isinstance(channel_groups, (list, tuple))
+        assert isinstance(presence_enabled, bool)
+        assert isinstance(timetoken, int)
+
+        self.channels = channels
+        self.channel_groups = channel_groups
+        self.presence_enabled = presence_enabled
+        self.timetoken = timetoken
+
+
+class UnsubscribeOperation:
+    def __init__(self, channels=None, channel_groups=None):
+        assert isinstance(channels, (list, tuple))
+        assert isinstance(channel_groups, (list, tuple))
+
+        self.channels = channels
+        self.channel_groups = channel_groups
+
+
+class StateOperation:
+    def __init__(self, channels=None, channel_groups=None, state=None):
+        self.channels = channels
+        self.channel_groups = channel_groups
+        self.state = state

freenub-0.1.0/pubnub/endpoints/access/audit.py

@@ -0,0 +1,80 @@
+from pubnub import utils
+from pubnub.endpoints.endpoint import Endpoint
+from pubnub.enums import HttpMethod, PNOperationType
+from pubnub.models.consumer.access_manager import PNAccessManagerAuditResult
+
+
+class Audit(Endpoint):
+    AUDIT_PATH = "/v2/auth/audit/sub-key/%s"
+
+    def __init__(self, pubnub):
+        Endpoint.__init__(self, pubnub)
+        self._auth_keys = []
+        self._channels = []
+        self._groups = []
+        self._read = None
+        self._write = None
+        self._manage = None
+        self._ttl = None
+
+        self._sort_params = True
+
+    def auth_keys(self, auth_keys):
+        utils.extend_list(self._auth_keys, auth_keys)
+        return self
+
+    def channels(self, channels):
+        utils.extend_list(self._channels, channels)
+        return self
+
+    def channel_groups(self, channel_groups):
+        utils.extend_list(self._groups, channel_groups)
+        return self
+
+    def custom_params(self):
+        params = {}
+
+        if len(self._auth_keys) > 0:
+            params["auth"] = utils.join_items_and_encode(self._auth_keys)
+
+        if len(self._channels) > 0:
+            params["channel"] = utils.join_items_and_encode(self._channels)
+
+        if len(self._groups) > 0:
+            params["channel-group"] = utils.join_items_and_encode(self._groups)
+
+        return params
+
+    def build_path(self):
+        return Audit.AUDIT_PATH % self.pubnub.config.subscribe_key
+
+    def http_method(self):
+        return HttpMethod.GET
+
+    def validate_params(self):
+        self.validate_subscribe_key()
+        self.validate_secret_key()
+
+    def create_response(self, envelope):
+        return PNAccessManagerAuditResult.from_json(envelope["payload"])
+
+    def is_auth_required(self):
+        return False
+
+    def affected_channels(self):
+        return self._channels
+
+    def affected_channels_groups(self):
+        return self._groups
+
+    def request_timeout(self):
+        return self.pubnub.config.non_subscribe_request_timeout
+
+    def connect_timeout(self):
+        return self.pubnub.config.connect_timeout
+
+    def operation_type(self):
+        return PNOperationType.PNAccessManagerAudit
+
+    def name(self):
+        return "Grant"