Docs/examples (#192)

* Example for fetching messages

* sync examples

Author: Sebastian Molenda

.github/workflows/run-tests.yml

@@ -23,6 +23,7 @@ jobs:
     runs-on:
       group: Default
     strategy:
+      max-parallel: 1
       fail-fast: true
       matrix:
         python: [3.8.18, 3.9.18, 3.10.13, 3.11.6]

examples/DEVELOPER.md

@@ -0,0 +1,61 @@
+from pubnub.pnconfiguration import PNConfiguration
+from pubnub.pubnub import PubNub
+
+
+# Fetch historical messages
+def fetch_history(pubnub: PubNub, channel_name: str, fetch_count: int):
+    envelope = pubnub.history() \
+        .channel(channel_name) \
+        .include_meta(True) \
+        .reverse(False) \
+        .include_timetoken(True) \
+        .count(fetch_count) \
+        .sync()
+
+    # Process and print messages
+    if envelope.status.is_error():
+        print("Error fetching history:", envelope.status.error_data.information)
+    else:
+        for message in envelope.result.messages:
+            print(f"Message: {message.entry}, Timetoken: {message.timetoken}")
+
+
+def populate_messages(pubnub: PubNub, channel_name: str, message_count: int):
+    for i in range(message_count):
+        pubnub.publish().channel(channel_name).message(f'demo message #{i + 1}').sync()
+
+
+def get_input_number(message: str, range_min: int, range_max: int):
+    while True:
+        try:
+            num = int(input(f"{message} [{range_min}-{range_max}]: "))
+            if range_min <= range_max <= 150:
+                return num
+            else:
+                print(f"Invalid input. Please enter a number between {range_min} and {range_max}.")
+        except ValueError:
+            print("Invalid input. Please enter a valid integer.")
+
+
+if __name__ == "__main__":
+    message_count = 0
+    channel_name = 'example_fetch_history'
+
+    # Initialize PubNub configuration
+    pnconfig = PNConfiguration()
+    pnconfig.subscribe_key = "demo"
+    pnconfig.publish_key = "demo"
+    pnconfig.user_id = "demo"
+
+    # Initialize PubNub
+    pubnub = PubNub(pnconfig)
+
+    # Get validated int input between 0 and 150
+    message_count = get_input_number("How many messages to populate?", 0, 150)
+
+    populate_messages(pubnub, channel_name, message_count)
+
+    fetch_count = get_input_number("How many messages to fetch?", 0, 100)
+
+    # Call the function to fetch and print history
+    fetch_history(pubnub, channel_name, fetch_count)

examples/fetch_history.py

@@ -0,0 +1,58 @@
+import os
+
+from pubnub.models.consumer.entities.user import User
+from pubnub.pnconfiguration import PNConfiguration
+from pubnub.pubnub import PubNub
+
+config = PNConfiguration()
+config.subscribe_key = os.getenv('PN_KEY_SUBSCRIBE')
+config.publish_key = os.getenv('PN_KEY_PUBLISH')
+config.user_id = 'example'
+
+pubnub = PubNub(config)
+
+pubnub.set_uuid_metadata().uuid('john').set_name('John Lorem').sync()
+pubnub.set_uuid_metadata().uuid('jim').set_name('Jim Ipsum').sync()
+
+john_metadata = pubnub.get_all_uuid_metadata().filter("name LIKE 'John*'").sync()
+
+if john_metadata.status.is_error():
+    print(f"Error fetching UUID metadata: {john_metadata.status.error_message}")
+else:
+    for uuid_data in john_metadata.result.data:
+        print(f"UUID: {uuid_data['id']}, Name: {uuid_data['name']}")
+
+pubnub.set_channel_metadata().channel('generalfailure').set_name('General Failure').sync()
+pubnub.set_channel_metadata().channel('majormistake').set_name('Major Mistake').sync()
+
+general_metadata = pubnub.get_all_channel_metadata() \
+    .filter("name LIKE '*general*' && updated >= '2023-01-01T00:00:00Z'") \
+    .sync()
+
+if general_metadata.status.is_error():
+    print(f"Error fetching channel metadata: {general_metadata.status.__dict__}")
+else:
+    for channel in general_metadata.result.data:
+        print(f"Channel ID: {channel['id']}, Name: {channel['name']}, Updated: {channel['updated']}")
+
+pubnub.set_channel_members().channel('example').uuids([User('user123'), User('user124')]).sync()
+
+memberships = pubnub.get_memberships() \
+    .uuid("user123") \
+    .filter("!(channel.id == 'Channel-001')") \
+    .sync()
+
+if memberships.status.is_error():
+    print(f"Error fetching memberships: {memberships.status}")
+else:
+    print(memberships.__dict__)
+    for membership in memberships.result.data:
+        print(f"Channel ID: {membership['channel']['id']}")
+
+
+members = pubnub.get_channel_members() \
+    .channel("specialEvents") \
+    .filter("uuid.updated < '2023-01-01T00:00:00Z'") \
+    .sync()
+
+print(members.result)

examples/metadata.py

@@ -0,0 +1,59 @@
+import os
+
+
+from pubnub.pubnub import PubNub
+from pubnub.pnconfiguration import PNConfiguration
+
+
+config = PNConfiguration()
+config.publish_key = os.environ.get('PUBLISH_KEY', 'demo')
+config.subscribe_request_timeout = 10
+config.subscribe_key = os.environ.get('PUBLISH_KEY', 'demo')
+config.enable_subscribe = False
+config.user_id = 'example'
+
+channel = 'file-channel'
+pubnub = PubNub(config)
+sample_path = f"{os.getcwd()}/examples/native_sync/sample.gif"
+
+with open(sample_path, 'rb') as sample_file:
+    response = pubnub.send_file() \
+        .channel(channel) \
+        .file_name("sample.gif") \
+        .message({"test_message": "test"}) \
+        .file_object(sample_file) \
+        .sync()
+
+    print(f"Sent file: {response.result.name} with id: {response.result.file_id},"
+          f" at timestamp: {response.result.timestamp}")
+
+file_list_response = pubnub.list_files().channel(channel).sync()
+print(f"Found {len(file_list_response.result.data)} files:")
+
+for file_data in file_list_response.result.data:
+    print(f"  {file_data['name']} with id: {file_data['id']}")
+    ext = file_data['name'].replace('sample', '')
+
+    download_url = pubnub.get_file_url() \
+        .channel(channel) \
+        .file_id(file_data['id']) \
+        .file_name(file_data['name']) \
+        .sync()
+    print(f'  Download url: {download_url.result.file_url}')
+
+    download_file = pubnub.download_file() \
+        .channel(channel) \
+        .file_id(file_data['id']) \
+        .file_name(file_data['name']) \
+        .sync()
+
+    fw = open(f"{os.getcwd()}/examples/native_sync/out-{file_data['id']}{ext}", 'wb')
+    fw.write(download_file.result.data)
+    print(f"  file saved as {os.getcwd()}/examples/native_sync/out-{file_data['id']}{ext}\n")
+
+    pubnub.delete_file() \
+        .channel(channel) \
+        .file_id(file_data['id']) \
+        .file_name(file_data['name']) \
+        .sync()
+    print(' File deleted from storage')

examples/native_sync/file_handling.py

@@ -0,0 +1,32 @@
+from os import getenv
+from pprint import pprint
+from time import sleep
+
+from pubnub.pnconfiguration import PNConfiguration
+from pubnub.pubnub import PubNub
+
+
+channel = 'example'
+
+config = config = PNConfiguration()
+config.publish_key = getenv('PUBLISH_KEY')
+config.subscribe_key = getenv('SUBSCRIBE_KEY')
+config.secret_key = getenv('SECRET_KEY')
+config.cipher_key = getenv('CIPHER_KEY')
+config.user_id = 'example'
+
+pn = PubNub(config)
+
+# let's build some message history
+
+pn.publish().channel(channel).message('message zero zero').sync()
+pn.publish().channel(channel).message('message zero one').sync()
+pn.publish().channel(channel).message('message one zero').sync()
+pn.publish().channel(channel).message('message one one').sync()
+
+# give some time to store messages
+sleep(3)
+
+# fetching messages
+messages = pn.fetch_messages().channels(channel).sync()
+pprint([message.__dict__ for message in messages.result.channels[channel]])