webex-message-handler 0.1.0__tar.gz → 0.3.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (22) hide show
  1. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/PKG-INFO +47 -1
  2. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/README.md +187 -141
  3. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/pyproject.toml +1 -1
  4. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/src/webex_message_handler/__init__.py +13 -0
  5. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/src/webex_message_handler/device_manager.py +161 -147
  6. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/src/webex_message_handler/handler.py +421 -339
  7. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/src/webex_message_handler/kms_client.py +420 -416
  8. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/src/webex_message_handler/mercury_socket.py +401 -410
  9. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/src/webex_message_handler/types.py +250 -177
  10. webex_message_handler-0.3.0/tests/conftest.py +38 -0
  11. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/tests/test_device_manager.py +29 -14
  12. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/tests/test_handler.py +51 -0
  13. webex_message_handler-0.3.0/tests/test_integration.py +131 -0
  14. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/.gitignore +0 -0
  15. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/API.md +0 -0
  16. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/LICENSE +0 -0
  17. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/examples/basic_bot.py +0 -0
  18. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/src/webex_message_handler/errors.py +0 -0
  19. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/src/webex_message_handler/logger.py +0 -0
  20. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/src/webex_message_handler/message_decryptor.py +0 -0
  21. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/tests/__init__.py +0 -0
  22. {webex_message_handler-0.1.0 → webex_message_handler-0.3.0}/tests/test_message_decryptor.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: webex-message-handler
3
- Version: 0.1.0
3
+ Version: 0.3.0
4
4
  Summary: Lightweight Webex Mercury WebSocket + KMS decryption for receiving bot messages without the full Webex SDK
5
5
  Project-URL: Homepage, https://github.com/3rg0n/webex-message-handler
6
6
  Project-URL: Repository, https://github.com/3rg0n/webex-message-handler
@@ -99,6 +99,51 @@ asyncio.run(main())
99
99
 
100
100
  See `examples/basic_bot.py` for a complete working example.
101
101
 
102
+ ## Proxy Support (Enterprise)
103
+
104
+ For corporate environments behind a proxy, pass a configured connector:
105
+
106
+ ```python
107
+ import aiohttp
108
+ from aiohttp_socks import ProxyConnector
109
+
110
+ # Using HTTP/HTTPS proxy
111
+ connector = ProxyConnector.from_url(
112
+ "http://proxy.example.com:8080"
113
+ )
114
+
115
+ handler = WebexMessageHandler(
116
+ WebexMessageHandlerConfig(
117
+ token="YOUR_BOT_TOKEN",
118
+ connector=connector, # Pass configured connector
119
+ logger=console_logger,
120
+ )
121
+ )
122
+
123
+ await handler.connect()
124
+ ```
125
+
126
+ Or using environment variables:
127
+
128
+ ```python
129
+ import os
130
+ import aiohttp
131
+ from aiohttp_socks import ProxyConnector
132
+
133
+ proxy_url = os.getenv("HTTPS_PROXY") or os.getenv("HTTP_PROXY")
134
+ connector = ProxyConnector.from_url(proxy_url) if proxy_url else None
135
+
136
+ handler = WebexMessageHandler(
137
+ WebexMessageHandlerConfig(
138
+ token=os.getenv("WEBEX_BOT_TOKEN"),
139
+ connector=connector,
140
+ logger=console_logger,
141
+ )
142
+ )
143
+ ```
144
+
145
+ Requires: `pip install aiohttp-socks[asyncio]`
146
+
102
147
  ## API Reference
103
148
 
104
149
  ### `WebexMessageHandler`
@@ -117,6 +162,7 @@ WebexMessageHandler(config: WebexMessageHandlerConfig)
117
162
  |--------|------|---------|-------------|
118
163
  | `token` | `str` | required | Webex bot access token |
119
164
  | `logger` | `Logger` | noop | Custom logger (`console_logger` provided) |
165
+ | `connector` | `aiohttp.BaseConnector` | `None` | HTTP/HTTPS connector for proxy support |
120
166
  | `ping_interval` | `float` | `15.0` | Mercury ping interval (seconds) |
121
167
  | `pong_timeout` | `float` | `14.0` | Pong response timeout (seconds) |
122
168
  | `reconnect_backoff_max` | `float` | `32.0` | Max reconnect backoff (seconds) |
@@ -1,141 +1,187 @@
1
- # webex-message-handler
2
-
3
- Lightweight Webex Mercury WebSocket + KMS decryption for receiving bot messages — no Webex SDK required.
4
-
5
- Python port of the [TypeScript webex-message-handler](https://github.com/ecopelan/webex-message-handler).
6
-
7
- ## Why?
8
-
9
- - **The Webex Python SDK has heavy dependencies and limited WebSocket support**
10
- - **Bots behind corporate firewalls need persistent connections, not webhooks**
11
- - **This package extracts only the essential Mercury + KMS logic (~2 dependencies)**
12
-
13
- ## Install
14
-
15
- ```bash
16
- pip install webex-message-handler
17
- ```
18
-
19
- ## Quick Start
20
-
21
- ```python
22
- import asyncio
23
- from webex_message_handler import WebexMessageHandler, WebexMessageHandlerConfig, console_logger
24
-
25
- handler = WebexMessageHandler(
26
- WebexMessageHandlerConfig(
27
- token="YOUR_BOT_TOKEN",
28
- logger=console_logger,
29
- )
30
- )
31
-
32
- @handler.on("message:created")
33
- async def on_message(msg):
34
- print(f"[{msg.person_email}] {msg.text}")
35
- if msg.html:
36
- print(f" HTML: {msg.html}")
37
-
38
- @handler.on("message:deleted")
39
- def on_deleted(data):
40
- print(f"Message {data.message_id} deleted by {data.person_id}")
41
-
42
- @handler.on("connected")
43
- def on_connected():
44
- print("Connected to Webex")
45
-
46
- @handler.on("disconnected")
47
- def on_disconnected(reason):
48
- print(f"Disconnected: {reason}")
49
-
50
- @handler.on("reconnecting")
51
- def on_reconnecting(attempt):
52
- print(f"Reconnecting (attempt {attempt})...")
53
-
54
- @handler.on("error")
55
- def on_error(err):
56
- print(f"Error: {err}")
57
-
58
- async def main():
59
- await handler.connect()
60
- # Keep running until interrupted
61
- try:
62
- await asyncio.Event().wait()
63
- finally:
64
- await handler.disconnect()
65
-
66
- asyncio.run(main())
67
- ```
68
-
69
- See `examples/basic_bot.py` for a complete working example.
70
-
71
- ## API Reference
72
-
73
- ### `WebexMessageHandler`
74
-
75
- Main class for receiving and decrypting Webex messages.
76
-
77
- #### Constructor
78
-
79
- ```python
80
- WebexMessageHandler(config: WebexMessageHandlerConfig)
81
- ```
82
-
83
- **Configuration options:**
84
-
85
- | Option | Type | Default | Description |
86
- |--------|------|---------|-------------|
87
- | `token` | `str` | required | Webex bot access token |
88
- | `logger` | `Logger` | noop | Custom logger (`console_logger` provided) |
89
- | `ping_interval` | `float` | `15.0` | Mercury ping interval (seconds) |
90
- | `pong_timeout` | `float` | `14.0` | Pong response timeout (seconds) |
91
- | `reconnect_backoff_max` | `float` | `32.0` | Max reconnect backoff (seconds) |
92
- | `max_reconnect_attempts` | `int` | `10` | Max reconnect attempts |
93
-
94
- #### Methods
95
-
96
- - **`await connect()`** — Connects to Webex (registers device, initializes KMS, opens Mercury WebSocket)
97
- - **`await disconnect()`** — Gracefully disconnects (closes WebSocket, unregisters device)
98
- - **`await reconnect(new_token)`** — Update token and re-establish connection
99
- - **`status()`** — Returns `HandlerStatus` health check
100
- - **`connected`** `bool` property: whether currently connected
101
-
102
- #### Events
103
-
104
- | Event | Payload | Description |
105
- |-------|---------|-------------|
106
- | `message:created` | `DecryptedMessage` | New message received and decrypted |
107
- | `message:deleted` | `DeletedMessage` | Message was deleted |
108
- | `connected` | — | Connected/reconnected to Mercury |
109
- | `disconnected` | `reason: str` | Disconnected from Mercury |
110
- | `reconnecting` | `attempt: int` | Attempting to reconnect |
111
- | `error` | `Exception` | Error occurred |
112
-
113
- ### `DecryptedMessage`
114
-
115
- ```python
116
- @dataclass
117
- class DecryptedMessage:
118
- id: str
119
- room_id: str
120
- person_id: str
121
- person_email: str
122
- text: str
123
- created: str
124
- html: str | None
125
- room_type: str | None # "direct" | "group"
126
- raw: MercuryActivity | None
127
- ```
128
-
129
- ## Architecture
130
-
131
- ```
132
- WebexMessageHandler (orchestrator)
133
- ├── DeviceManager — WDM registration
134
- ├── MercurySocket — WebSocket + ping/pong + reconnect
135
- ├── KmsClient — ECDH handshake + key retrieval
136
- └── MessageDecryptor JWE decryption
137
- ```
138
-
139
- ## License
140
-
141
- MIT
1
+ # webex-message-handler
2
+
3
+ Lightweight Webex Mercury WebSocket + KMS decryption for receiving bot messages — no Webex SDK required.
4
+
5
+ Python port of the [TypeScript webex-message-handler](https://github.com/ecopelan/webex-message-handler).
6
+
7
+ ## Why?
8
+
9
+ - **The Webex Python SDK has heavy dependencies and limited WebSocket support**
10
+ - **Bots behind corporate firewalls need persistent connections, not webhooks**
11
+ - **This package extracts only the essential Mercury + KMS logic (~2 dependencies)**
12
+
13
+ ## Install
14
+
15
+ ```bash
16
+ pip install webex-message-handler
17
+ ```
18
+
19
+ ## Quick Start
20
+
21
+ ```python
22
+ import asyncio
23
+ from webex_message_handler import WebexMessageHandler, WebexMessageHandlerConfig, console_logger
24
+
25
+ handler = WebexMessageHandler(
26
+ WebexMessageHandlerConfig(
27
+ token="YOUR_BOT_TOKEN",
28
+ logger=console_logger,
29
+ )
30
+ )
31
+
32
+ @handler.on("message:created")
33
+ async def on_message(msg):
34
+ print(f"[{msg.person_email}] {msg.text}")
35
+ if msg.html:
36
+ print(f" HTML: {msg.html}")
37
+
38
+ @handler.on("message:deleted")
39
+ def on_deleted(data):
40
+ print(f"Message {data.message_id} deleted by {data.person_id}")
41
+
42
+ @handler.on("connected")
43
+ def on_connected():
44
+ print("Connected to Webex")
45
+
46
+ @handler.on("disconnected")
47
+ def on_disconnected(reason):
48
+ print(f"Disconnected: {reason}")
49
+
50
+ @handler.on("reconnecting")
51
+ def on_reconnecting(attempt):
52
+ print(f"Reconnecting (attempt {attempt})...")
53
+
54
+ @handler.on("error")
55
+ def on_error(err):
56
+ print(f"Error: {err}")
57
+
58
+ async def main():
59
+ await handler.connect()
60
+ # Keep running until interrupted
61
+ try:
62
+ await asyncio.Event().wait()
63
+ finally:
64
+ await handler.disconnect()
65
+
66
+ asyncio.run(main())
67
+ ```
68
+
69
+ See `examples/basic_bot.py` for a complete working example.
70
+
71
+ ## Proxy Support (Enterprise)
72
+
73
+ For corporate environments behind a proxy, pass a configured connector:
74
+
75
+ ```python
76
+ import aiohttp
77
+ from aiohttp_socks import ProxyConnector
78
+
79
+ # Using HTTP/HTTPS proxy
80
+ connector = ProxyConnector.from_url(
81
+ "http://proxy.example.com:8080"
82
+ )
83
+
84
+ handler = WebexMessageHandler(
85
+ WebexMessageHandlerConfig(
86
+ token="YOUR_BOT_TOKEN",
87
+ connector=connector, # Pass configured connector
88
+ logger=console_logger,
89
+ )
90
+ )
91
+
92
+ await handler.connect()
93
+ ```
94
+
95
+ Or using environment variables:
96
+
97
+ ```python
98
+ import os
99
+ import aiohttp
100
+ from aiohttp_socks import ProxyConnector
101
+
102
+ proxy_url = os.getenv("HTTPS_PROXY") or os.getenv("HTTP_PROXY")
103
+ connector = ProxyConnector.from_url(proxy_url) if proxy_url else None
104
+
105
+ handler = WebexMessageHandler(
106
+ WebexMessageHandlerConfig(
107
+ token=os.getenv("WEBEX_BOT_TOKEN"),
108
+ connector=connector,
109
+ logger=console_logger,
110
+ )
111
+ )
112
+ ```
113
+
114
+ Requires: `pip install aiohttp-socks[asyncio]`
115
+
116
+ ## API Reference
117
+
118
+ ### `WebexMessageHandler`
119
+
120
+ Main class for receiving and decrypting Webex messages.
121
+
122
+ #### Constructor
123
+
124
+ ```python
125
+ WebexMessageHandler(config: WebexMessageHandlerConfig)
126
+ ```
127
+
128
+ **Configuration options:**
129
+
130
+ | Option | Type | Default | Description |
131
+ |--------|------|---------|-------------|
132
+ | `token` | `str` | required | Webex bot access token |
133
+ | `logger` | `Logger` | noop | Custom logger (`console_logger` provided) |
134
+ | `connector` | `aiohttp.BaseConnector` | `None` | HTTP/HTTPS connector for proxy support |
135
+ | `ping_interval` | `float` | `15.0` | Mercury ping interval (seconds) |
136
+ | `pong_timeout` | `float` | `14.0` | Pong response timeout (seconds) |
137
+ | `reconnect_backoff_max` | `float` | `32.0` | Max reconnect backoff (seconds) |
138
+ | `max_reconnect_attempts` | `int` | `10` | Max reconnect attempts |
139
+
140
+ #### Methods
141
+
142
+ - **`await connect()`** — Connects to Webex (registers device, initializes KMS, opens Mercury WebSocket)
143
+ - **`await disconnect()`** — Gracefully disconnects (closes WebSocket, unregisters device)
144
+ - **`await reconnect(new_token)`** — Update token and re-establish connection
145
+ - **`status()`** — Returns `HandlerStatus` health check
146
+ - **`connected`** — `bool` property: whether currently connected
147
+
148
+ #### Events
149
+
150
+ | Event | Payload | Description |
151
+ |-------|---------|-------------|
152
+ | `message:created` | `DecryptedMessage` | New message received and decrypted |
153
+ | `message:deleted` | `DeletedMessage` | Message was deleted |
154
+ | `connected` | — | Connected/reconnected to Mercury |
155
+ | `disconnected` | `reason: str` | Disconnected from Mercury |
156
+ | `reconnecting` | `attempt: int` | Attempting to reconnect |
157
+ | `error` | `Exception` | Error occurred |
158
+
159
+ ### `DecryptedMessage`
160
+
161
+ ```python
162
+ @dataclass
163
+ class DecryptedMessage:
164
+ id: str
165
+ room_id: str
166
+ person_id: str
167
+ person_email: str
168
+ text: str
169
+ created: str
170
+ html: str | None
171
+ room_type: str | None # "direct" | "group"
172
+ raw: MercuryActivity | None
173
+ ```
174
+
175
+ ## Architecture
176
+
177
+ ```
178
+ WebexMessageHandler (orchestrator)
179
+ ├── DeviceManager — WDM registration
180
+ ├── MercurySocket — WebSocket + ping/pong + reconnect
181
+ ├── KmsClient — ECDH handshake + key retrieval
182
+ └── MessageDecryptor — JWE decryption
183
+ ```
184
+
185
+ ## License
186
+
187
+ MIT
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name = "webex-message-handler"
7
- version = "0.1.0"
7
+ version = "0.3.0"
8
8
  description = "Lightweight Webex Mercury WebSocket + KMS decryption for receiving bot messages without the full Webex SDK"
9
9
  readme = "README.md"
10
10
  license = "MIT"
@@ -19,13 +19,19 @@ from .types import (
19
19
  DecryptedMessage,
20
20
  DeletedMessage,
21
21
  DeviceRegistration,
22
+ FetchFunction,
23
+ FetchRequest,
24
+ FetchResponse,
22
25
  HandlerStatus,
26
+ InjectedWebSocket,
23
27
  MercuryActivity,
24
28
  MercuryActor,
25
29
  MercuryEnvelope,
26
30
  MercuryObject,
27
31
  MercuryTarget,
32
+ NetworkMode,
28
33
  WebexMessageHandlerConfig,
34
+ WebSocketFactory,
29
35
  )
30
36
 
31
37
  __all__ = [
@@ -59,4 +65,11 @@ __all__ = [
59
65
  "DeletedMessage",
60
66
  "HandlerStatus",
61
67
  "ConnectionStatus",
68
+ # Networking types
69
+ "NetworkMode",
70
+ "FetchRequest",
71
+ "FetchResponse",
72
+ "FetchFunction",
73
+ "InjectedWebSocket",
74
+ "WebSocketFactory",
62
75
  ]