imbot-sdk-python 0.1.1__py3-none-any.whl → 0.1.2__py3-none-any.whl

imbot_sdk/__init__.py

@@ -35,7 +35,7 @@ from .models import (
     UserInfo,
 )
 
-__version__ = "0.1.1"
+__version__ = "0.1.2"
 
 __all__ = [
     "ImBotClient",

{imbot_sdk_python-0.1.1.dist-info → imbot_sdk_python-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: imbot-sdk-python
-Version: 0.1.1
+Version: 0.1.2
 Summary: JuggleIM Python Bot SDK — WebSocket long-connection IM client for bots and server-side agents
 Author-email: Tyler <tyler@juggle.im>
 Maintainer-email: Tyler <tyler@juggle.im>
@@ -78,6 +78,37 @@ pip install .
 > + AppSecret via the Server API. The SDK itself only establishes the
 > connection and sends/receives messages.
 
+## Obtaining a token
+
+`connect(token)` needs a per-user token. Tokens are minted by your app server
+through the JuggleIM Server API using your AppKey + AppSecret. Registering a bot
+(or a user) returns a token:
+
+- Endpoint: `POST {ServerAPI}/bots/register` (or `/users/register`)
+- Auth headers: `appkey`, `nonce` (random 0-9999), `timestamp` (epoch ms),
+  `signature = lowercase_hex( SHA1(AppSecret + nonce + timestamp) )`,
+  `Content-Type: application/json`
+- Response: `{"code":0,"msg":"success","data":{"user_id":"...","token":"..."}}`
+
+A ready-to-use helper (standard library only, no hard-coded credentials) is
+[`examples/register_bot.py`](examples/register_bot.py):
+
+```bash
+export IMBOT_API_URL="https://api.juggleim.com/apigateway"
+export IMBOT_APPKEY="<your-appkey>"
+export IMBOT_APPSECRET="<your-appsecret>"
+
+# register a bot and print its token
+python examples/register_bot.py --bot-id my-bot --nickname "My Bot"
+
+# or register a normal user
+python examples/register_bot.py --user --user-id u1 --nickname "User 1"
+```
+
+> Keep your AppSecret on the server side — never ship it inside client apps.
+> If the Server API host presents an expired/invalid TLS certificate, pass
+> `--insecure` to bypass verification (use only against endpoints you trust).
+
 ## Feature overview
 
 - Connection management: `connect`, `disconnect`, `logout`, heartbeat keep-alive,

{imbot_sdk_python-0.1.1.dist-info → imbot_sdk_python-0.1.2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-imbot_sdk/__init__.py,sha256=k6zcvfWBE9b8tXSPlC9B9hGRV0_It6erzEgeqFxQR60,1456
+imbot_sdk/__init__.py,sha256=NFKl861qKklXQpKq1aiLm4sq_pN8P0IzshwUKErxC7k,1456
 imbot_sdk/client.py,sha256=qOG3BZOBZH_JA_0iDpxrFVQGgfwdyRJ2NZzWNop2Y2M,46357
 imbot_sdk/consts.py,sha256=EQhnWoc0RFDMIpZl7posvVwFDblnpQ0VJaW-bgAC6IQ,754
 imbot_sdk/data_accessor.py,sha256=om_UzAAgCGtNqWZbLcpU0VFq_Tmi-Xi3lkwv-E-unHw,1018
@@ -13,8 +13,8 @@ imbot_sdk/pb/appmessages_pb2.py,sha256=7yyt_KqDs7rO8TtYO88AJIqfB5yLfoPV3PwRSpidu
 imbot_sdk/pb/chatroom_pb2.py,sha256=2SD6pyFKZuFhOvvZbDffX591OrYqv8q7eNm4SA-7s9o,9452
 imbot_sdk/pb/connect_pb2.py,sha256=k3QU7PAaYL_umjV5WXloxgWlYvKrM7CSV6Fj0eBxhzo,4777
 imbot_sdk/pb/rtcroom_pb2.py,sha256=v9uuWxbEvsmwHHt9OLuDvE4w1v0wQX7e1Xxv0mKFQPo,8037
-imbot_sdk_python-0.1.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-imbot_sdk_python-0.1.1.dist-info/METADATA,sha256=Ien770JAC4tE9ZTFWzo6I9LrSiw4UmbNGHkL0-jUmxo,11529
-imbot_sdk_python-0.1.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-imbot_sdk_python-0.1.1.dist-info/top_level.txt,sha256=Q636V3MNhiMZGfV2FfiBcNaYh4bHlVB0iXVMQgVuoeo,10
-imbot_sdk_python-0.1.1.dist-info/RECORD,,
+imbot_sdk_python-0.1.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+imbot_sdk_python-0.1.2.dist-info/METADATA,sha256=IeEszLrZnszijy28ns-IH2783qO5f5DFFRb-T1uXLmE,12792
+imbot_sdk_python-0.1.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+imbot_sdk_python-0.1.2.dist-info/top_level.txt,sha256=Q636V3MNhiMZGfV2FfiBcNaYh4bHlVB0iXVMQgVuoeo,10
+imbot_sdk_python-0.1.2.dist-info/RECORD,,