2016-8-1 版本升级

README.md

@@ -3,69 +3,81 @@ server-sdk-python
 
 Rong Cloud Server SDK in Python.
 
-# 更新说明
-
-* 20150206
-* 去掉可能会导致SSL验证失败的代码
-* 更改环境变量名称，老的环境变量名称在某些操作系统中无法被识别
-
+# python 版本
+server-sdk-python supports Python 2.7 and Python 3.3+
 
 # 依赖说明
-* 本sdk 依赖于requests
+- 本sdk 依赖于requests
 
-# 使用说明
-
-```
-import os
-import json
-import unittest
-import logging
+# API文档
+- 官方文档(http://www.rongcloud.cn/docs/server.html)
 
-from rong import ApiClient
+# 使用教程
 
-app_key = ""
-app_secret = ""
-
-#您应该将key 和 secret 保存在服务器的环境变量中    
-os.environ.setdefault('rongcloud_app_key', app_key)
-os.environ.setdefault('rongcloud_app_secret', app_secret)
-    
-logging.basicConfig(level=logging.INFO)
-    
-api = ApiClient()
+## 示例
 ```
-
-##通用方法
-
-* 对于单值参数调用
-
-```
-token = api.call_api(
-	action="/user/getToken",
-    params={
-    	"userId": "user-id1",
-    	"name":"username1",
-   		"portraitUri":"p1"
-   	}
-)
+>>> import os
+>>> from rong import ApiClient
+>>> app_key = os.environ['APP_KEY']
+>>> app_secret = os.environ['APP_SECRET']
+>>> api = ApiClient(app_key, app_secret)
+>>>
+>>> r = api.getToken(userId='userid1', name='username', portraitUri='http://www.rongcloud.cn/images/logo.png')
+>>> print(r)
+{'token': 'P9YNVZ2cMQwwaADiNDVrtRZKF+J2pVPOWSNlYMA1yA1g49pxjZs58n4FEufsH9XMCHTk6nHR6unQTuRgD8ZS/nlbkcv6ll4x', 'userId': 'userid1', 'code': 200}
+>>> 
+>>> r = api.publishMessage(
+...     pushContent='userid1',
+...     toUserId='userid1',
+...     content=json.dumps({"content":"hello","extra":"helloExtra"}),
+...     pushData='userid1',
+...     fromUserId='userid1',
+...     objectName='RC:TxtMsg')
+>>> print(r)
+{'code': 200}
 ```
 
-* 对于多值参数调用
+## 更多示例
+* 请参考单元测试test.py
 
+## 返回结果
 ```
-addblack = api.call_api(
-    action="/user/blacklist/add",
-    params={
-        "userId": "user-id1",
-        "blackUserId":["user-id1","user-id2","user-id3"]
-    }
-)
+Help on Response in module rong object:
+
+class Response(builtins.object)
+|  Methods defined here:
+|  
+|  __init__(self, response, desc)
+|      Initialize self.  See help(type(self)) for accurate signature.
+|  
+|  __str__(self)
+|      打印字符串
+|  
+|  get(self)
+|      返回调用结果
+|  
+|  ----------------------------------------------------------------------
+|  Data descriptors defined here:
+|  
+|  __dict__
+|      dictionary for instance variables (if defined)
+|  
+|  __weakref__
+|      list of weak references to the object (if defined)
+|  
+|  ok
+|      调用成功返回True，其它返回False
+|  
+|  result
+|      调用结果
+|  
+|  status
+|      Http 返回码
 ```
-如果一个参数需要传递多个值， 可以直接传递list 类型
-
 
-* 对于json类型参数
+# 实现功能
 
+## 底层API调用方法
 ```
 publish = api.call_api(
     action="/message/private/publish",
@@ -94,8 +106,59 @@ publish = api.call_api(
 )
 ```
 
-## 封装方法
+## 高级API接口
+- getToken        获取 Token 
+- refreshUser        刷新用户信息
+- checkOnlineUser        检查用户在线状态 
+- blockUser        封禁用户
+- unBlockUser        解除用户封禁
+- queryBlockUser        获取被封禁用户
+- addUserBlacklist        添加用户到黑名单
+- removeBlacklistUser        从黑名单中移除用户
+- queryBlacklistUser        获取某用户的黑名单列表
+- publishMessage    发送单聊消息
+- publishTemplateMessage    发送单聊模板消息
+- systemPublishMessage  发送系统消息
+- systemPublishTemplateMessage  发送系统模板消息
+- publishGroupMessage   发送群组消息
+- publishDiscussionMessage  发送讨论组消息
+- publishChatroomMessage    发送聊天室消息
+- broadcastMessage  发送广播消息
+- addWordFilter        添加敏感词
+- deleteWordfilter        移除敏感词
+- listWordfilter        查询敏感词列表
+- historyMessage        消息历史记录下载地址获取
+- HistoryMessageDelete        消息历史记录删除
+- groupSync        同步用户所属群组
+- groupCreate        创建群组
+- groupjoin        将用户加入指定群组
+- groupQuit        退出群组
+- groupDismiss        解散群组
+- groupRefresh        刷新群组信息
+- groupUserQuery        查询群成员
+- addGagGroupUser        添加禁言群成员
+- rooBackGagGroupUser        移除禁言群成员
+- listGagGroupUser        查询被禁言群成员
+- chatroomCreate        创建聊天室
+- chatroomJoin        加入聊天室
+- chatroomDestroy        销毁聊天室
+- chatroomQuery        查询聊天室信息
+- chatroomUserQuery        查询聊天室内用户
+- stopDistributionChatroomMessage        聊天室消息停止分发
+- resumeDistributionChatroomMessage        聊天室消息恢复分发
+- addGagChatroomUser        添加禁言聊天室成员
+- rollbackGagChatroomUser        移除禁言聊天室成员
+- listGagChatroomUser        查询被禁言聊天室成员
+- addChatroomBlockUser        添加封禁聊天室成员
+- rollbackBlockChatroomUser        移除封禁聊天室成员
+- listBlockChatroomUser        查询被封禁聊天室成员
 
-如果您觉得通过 call_api 方法调用不够方便，可参阅 test.py 中的单元测试代码。
-
-我们对 call_api 进行了更进一步的封装，但是不建议您在生产环境中使用。
+# 更新说明
+### 20160801
+- 返回结果结构变更
+- 按官方文档(http://www.rongcloud.cn/docs/server.html) 补全Server API接口
+- 为每个接口添加参数及返回值说明信息
+
+### 20150206
+- 去掉可能会导致SSL验证失败的代码
+- 更改环境变量名称，老的环境变量名称在某些操作系统中无法被识别

requirements.txt

@@ -1 +1 @@
-requests>==2.1.0
+requests>==2.10.0