rong_cloud_server 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f18dffa1673ff35d013c644ec931c44af2f5931
-  data.tar.gz: 7d63b3bee76e8106091e92753f4ad8f2ec48ea05
+  metadata.gz: 82f88e70a08efe992ba2736c8db0ab8b4425589a
+  data.tar.gz: d9efa695a5402e686f0d942836dcd4d6c027874e
 SHA512:
-  metadata.gz: 2366fd2761501b3e14a03b5c8e27c0f31c8086a749d5409bae58704f7d2c998578ed1759aed4ce45875e2a266ba3efebaa792a96959153bbb7dbcc440b41a700
-  data.tar.gz: d6822867ea92aff168a5641df355deb9bc461d71c8f6af4280c7aacba4761742c837891b910b936774ec6576c0128d1e671dc889c09d0fc50405191f31dc2d6c
+  metadata.gz: 964d72d2a924d9e8b5c11328fd67fc4a90fae37cede3640c3b18ebd6bef3a241d5fece396b802aeb1c35fb82e10dad66c72ceff003595b95277723467ea4e888
+  data.tar.gz: 4ab2768d2e86928f927ef3b5da23bbe1d82aaf36240f73703599d9e0cb294b91ddbabc003ae2926e02cdbfd8e162e1d5a35bc709cf92f797c26646a02b22b9dd

data/README.md

@@ -1,37 +1,50 @@
-融云 Server SDK
+[RongCloud](http://rongcloud.cn/) Server API SDK in Ruby
 ===
 
-此 gem 实现了[融云 Server API](http://www.rongcloud.cn/docs/server.html)的大部分接口的 Ruby 实现。
+To view the README in Chinese, visit [README.zh-CN.md](./README.zh-CN.md)
+
+This repository implements most essential apis for [RongCloud Server API](http://www.rongcloud.cn/docs/server.html) in Ruby programming language.
 
 ### Getting Started
-1. 安装此 gem；
-2. 在项目中添加配置：
+1. Install the gem:
+
+  ```sh
+  $ gem install rong_cloud_server
+  ```
+
+  or, install it in Gemfile:
+
+  ```ruby
+  gem 'rong_cloud_server', '~> 0.0.2'
+  ```
+
+2. Append the following configurations in a initializer file:
 
   ```ruby
   RongCloud.configure do |config|
     config.app_key = "APP_KEY"
     config.secret_key = "SECRET_KEY"
-    config.host = "http://api.cn.ronghub.com"   # default: https://api.cn.ronghub.com, use http is convenient for debugging
+    config.host = "http://api.cn.ronghub.com"   # default: https://api.cn.ronghub.com, use http here is just convenient for debugging
   end
   ```
-3. 通过 service 对象使用：
+3. Use the instance of `RongCloud::Service` to talk to RongCloud Server:
 
   ```ruby
   service = RongCloud::Service.new
 
-  # 更多方法，请查看测试用例 https://github.com/Martin91/rong_cloud/tree/master/test/rong_cloud/services
+  # Find more usage from test files under https://github.com/Martin91/rong_cloud/tree/master/test/rong_cloud/services
   service.get_token(..., ..., ...)
   ```
 
-### 特点
-1. **轻量**：无其他依赖；
-2. **简洁**：不过分封装，仅做必要的请求实现，使用方自行处理响应的 JSON 解析后的 Hash 对象，各字段释义请自行查阅融云文档；
-3. **丰富的异常类型**：针对不同的 HTTP 状态码，抛出相对应的异常类型，同时可以通过异常对象的 `business_code` 方法获取错误业务码，可以参考[request test 的代码](https://github.com/Martin91/rong_cloud/blob/master/test/rong_cloud/request_test.rb)。
+### Features
+1. **Lightweight**:No other third-party gems dependences;
+2. **Straight and Simple**:Just wrap api connections in Ruby, no any DSL and so that you do not learn too many new syntax, no any process on response；
+3. **Detailed Exceptions**:Detailed and different exceptions according to the http status code，and you can get the [detailed error code](http://www.rongcloud.cn/docs/server.html#业务返回码), officially defined by RongCloud, through calling the extended method `business_code` on a exception, please refer to [request test](https://github.com/Martin91/rong_cloud/blob/master/test/rong_cloud/request_test.rb).
+
+### How to work with Realtime Message Forward or Online Status Subscription
+Just include `RongCloud::Signature` in your codes to validate api signature and then parse params.
 
-### TODOs for v0.1.0
-1. 实时消息路由；
-2. 消息历史记录；
-3. 在线状态订阅。
+More infos about parameters, refer to the [official documents](http://www.rongcloud.cn/docs/server.html#服务端实时消息路由).
 
 ### How to contribute
 1. Fork this repo;

data/README.zh-CN.md

@@ -0,0 +1,50 @@
+融云 Server SDK
+===
+
+此 gem 实现了[融云 Server API](http://www.rongcloud.cn/docs/server.html)的大部分接口的 Ruby 实现。
+
+### Getting Started
+1. 安装此 gem：
+  
+  ```ruby
+  $ gem install rong_cloud_server
+  ```
+  
+  or, install in Gemfile:
+  
+  ```ruby
+  gem 'rong_cloud_server', '~> 0.0.2'
+  ```
+
+2. 在项目中添加配置：
+
+  ```ruby
+  RongCloud.configure do |config|
+    config.app_key = "APP_KEY"
+    config.app_secret = "SECRET_KEY"
+    config.host = "http://api.cn.ronghub.com"   # default: https://api.cn.ronghub.com, use http is convenient for debugging
+  end
+  ```
+3. 通过 service 对象使用：
+
+  ```ruby
+  service = RongCloud::Service.new
+
+  # 更多方法，请查看测试用例 https://github.com/Martin91/rong_cloud/tree/master/test/rong_cloud/services
+  service.get_token(..., ..., ...)
+  ```
+
+### 特点
+1. **轻量**：无其他依赖；
+2. **简洁**：不过分封装，仅做必要的请求实现，使用方自行处理响应的 JSON 解析后的 Hash 对象，各字段释义请自行查阅融云文档；
+3. **丰富的异常类型**：针对不同的 HTTP 状态码，抛出相对应的异常类型，同时可以通过异常对象的 `business_code` 方法获取错误业务码，可以参考[request test 的代码](https://github.com/Martin91/rong_cloud/blob/master/test/rong_cloud/request_test.rb)。
+
+### TODOs for v0.1.0
+1. 实时消息路由；
+2. 消息历史记录；
+3. 在线状态订阅。
+
+### How to contribute
+1. Fork this repo;
+2. Write your code and test;
+3. Open a new Pull Request.

data/lib/rong_cloud.rb

@@ -3,9 +3,9 @@ require 'rong_cloud/errors'
 require 'rong_cloud/service'
 require 'core_ext/array'
 
-# 融云 Ruby SDK 的全局命名空间
+# global namespace for this SDK
 module RongCloud
-  # 配置融云 Server 连接信息
+  # Use this method for connection settings
   #
   def self.configure(&block)
     yield RongCloud::Configuration

data/lib/rong_cloud/configuration.rb

@@ -1,22 +1,22 @@
 require "logger"
 
 module RongCloud
-  # 管理融云 SDK 连接配置信息
+  # The main class to maintain connection settings
   #
   module Configuration
-    # 默认 API 服务器，使用 https
+    # The default host to accept connections, use a https protocol
     DEFAULT_HOST = "https://api.cn.ronghub.com".freeze
 
     module ModuleMethods
       attr_accessor :app_key, :app_secret, :host, :logger
 
-      # 获取目标主机，默认为 https://api.cn.ronghub.com
+      # Fetch the api host, the default is: https://api.cn.ronghub.com
       #
       def host
         @host || DEFAULT_HOST
       end
 
-      # 获取日志文件对象，默认日志文件为标准输出
+      # Fetch the logger, the default is STDOUT
       def logger
         @logger || default_logger
       end

data/lib/rong_cloud/errors.rb

@@ -1,33 +1,25 @@
 module RongCloud
-  # 不支持的消息类型错误
   class UnsupportedMessageChannelName < ::StandardError;end
-  # 缺少必传参数
+  # Missing required settings for setup this gem
   class MissingOptionError < ::StandardError;end
-  # 与融云接口请求相关的基本错误类型，其他错误类型继承此类型
+  # The root exception for those related to RongCloud API
   class RequestError < ::StandardError
     # @!attribute [rw] business_code
-    #   接口错误时的业务返回码，详见：http://www.rongcloud.cn/docs/server.html#API_方法返回值说明
+    #   extended attribute, recording the return codes defined by RongCloud,
+    #   View http://www.rongcloud.cn/docs/server.html#API_方法返回值说明
     attr_accessor :business_code
   end
 
-  # 错误请求
   class BadRequest < RequestError;end
-  # 验证错误
   class AuthenticationFailed < RequestError;end
-  # 被拒绝
   class RequestForbidden < RequestError;end
-  # 资源不存在
   class ResourceNotFound < RequestError;end
-  # 群上限
+  # Exceed group members limit
   class ExceedLimit < RequestError;end
-  # 过多的请求
   class TooManyRequests < RequestError;end
-  # 内部服务器错误
   class InternalServerError < RequestError;end
-  # 内部服务器响应超时
   class Timeout < RequestError;end
 
-  # 融云服务器响应状态码到 Ruby 错误类型的映射
   HTTP_CODE_TO_ERRORS_MAP = {
     "400" => BadRequest,
     "401" => AuthenticationFailed,

data/lib/rong_cloud/request.rb

@@ -3,17 +3,17 @@ require 'json'
 require 'rong_cloud/signature'
 
 module RongCloud
-  # 请求封装类，所有请求基于 Net::HTTP，自动支持 http 或者 https
+  # Handle api request, based on Ruby's built-in Net::HTTP,
+  # support both HTTP and HTTPS
   #
   module Request
     include Signature
 
-    # 执行请求
-    # @param path [String] 请求 API 的相对路径
-    # @param params [Hash] 请求的参数
-    # @param content_type [Symbol] 请求数据编码格式，:form_data 或者 :json，默认 :form_data
-    # @return [Hash] JSON 解析后的响应数据
-    # @raise [RongCloud::BadRequest] 请求参数有误，缺失或者不正确等，详见官方文档
+    # @param path [String] The api endpoint
+    # @param params [Hash] api params
+    # @param content_type [Symbol] required formatting for request data, :form_data or :json
+    # @return [Hash] the parsed response represented by JSON
+    # @raise [RongCloud::BadRequest] when request params is invalid or other situations
     def request(path, params = nil, content_type = :form_data)
       uri = get_uri(path)
       req = initialize_request(uri, params, content_type)
@@ -26,22 +26,22 @@ module RongCloud
     end
 
     private
-    # 拼接请求的接口的路径
+    # construct the api endpoint url
     #
-    # @param path [String] 接口的相对路径，e.g. "/user/getToken" 或者 "user/getToken"，代码中自动处理开头的斜杠
-    # @return [URI] 请求全路径生成的 URI 对象，自动追加 .json 格式扩展名
+    # @param path [String] the relative path for api endpoint，e.g. "/user/getToken" or "user/getToken"
+    # @return [URI] full url for the endpoint
     #
     def get_uri(path)
       url = "#{RongCloud::Configuration.host}/#{path.gsub(/^\//, "")}"
       URI(url.end_with?(".json") ? url : "#{url}.json")
     end
 
-    # 实例化请求对象
+    # construct a new request
     #
-    # @param uri [URI] 请求路径对象
-    # @param params [Hash] 请求的参数，所有参数通过 form encoded data 方式发送
-    # @param content_type [Symbol] 请求数据编码格式，:form_data 或者 :json
-    # @return [Net::HTTP::Post] 请求的实例
+    # @param uri [URI] the relative path for api endpoint
+    # @param params [Hash] the request params
+    # @param content_type [Symbol] required formatting for request data, :form_data or :json
+    # @return [Net::HTTP::Post] the request object
     #
     def initialize_request(uri, params, content_type)
       req = Net::HTTP::Post.new(uri)
@@ -58,11 +58,11 @@ module RongCloud
       req
     end
 
-    # 解析响应数据，包含错误检测
+    # parse the raw response
     #
-    # @param res [HTTPResponse] 响应结果的实例
-    # @return [Hash] JSON 解析后的响应正文
-    # @raise [RongCloud::BadRequest] 请求参数有误，缺失或者不正确等，详见官方文档
+    # @param res [HTTPResponse] the response
+    # @return [Hash] response data parsed as JSON
+    # @raise [RongCloud::BadRequest] when params are invalid or other situations
     #
     def handle_response(res)
       json = JSON.parse(res.body)

data/lib/rong_cloud/service.rb

@@ -4,14 +4,14 @@ require 'rong_cloud/services/message'
 require 'rong_cloud/services/wordfilter'
 require 'rong_cloud/services/group'
 require 'rong_cloud/services/chatroom'
+require 'rong_cloud/services/history_message'
 
 module RongCloud
-  # 封装所有接口的 Service 类，所有业务接口通过 Service 的实例完成调用
-  #
   class Service
     include RongCloud::Request
     include RongCloud::Services::User
     include RongCloud::Services::Message
+    include RongCloud::Services::HistoryMessage
     include RongCloud::Services::Wordfilter
     include RongCloud::Services::Group
     include RongCloud::Services::Chatroom

data/lib/rong_cloud/services/chatroom.rb

@@ -1,10 +1,11 @@
 module RongCloud
   module Services
-    # 聊天室服务相关接口 http://www.rongcloud.cn/docs/server.html#聊天室服务
+    # apis for chatroom http://www.rongcloud.cn/docs/server.html#聊天室服务
     module Chatroom
-      # 创建聊天室，支持同时创建多个聊天室 http://www.rongcloud.cn/docs/server.html#创建聊天室_方法
+      # create a new chatroom，support creating multiple ones
+      #   http://www.rongcloud.cn/docs/server.html#创建聊天室_方法
       #
-      # @param chatrooms [Hash] id 为 key，聊天室名称为 value 的 Hash 实例，多个 key-value 表示多个聊天室
+      # @param chatrooms [Hash] created chatrooms
       #
       def create_chatroom(chatrooms)
         params = {}
@@ -13,66 +14,67 @@ module RongCloud
         request("/chatroom/create", params)
       end
 
-      # 加入聊天室 http://www.rongcloud.cn/docs/server.html#加入聊天室_方法
+      # join a chatroom http://www.rongcloud.cn/docs/server.html#加入聊天室_方法
       #
-      # @param user_id [String, Array] 一个或多个用户 id
-      # @param chatroom_id [String] 聊天室 id
+      # @param user_id [String, Array] one or more user ids
+      # @param chatroom_id [String] the id of the chatroom
       #
       def join_chatroom(user_id, chatroom_id)
         request("/chatroom/join", userId: user_id, chatroomId: chatroom_id)
       end
 
-      # 销毁聊天室 http://www.rongcloud.cn/docs/server.html#销毁聊天室_方法
+      # dismiss a chatroom http://www.rongcloud.cn/docs/server.html#销毁聊天室_方法
       #
-      # @param chatroom_ids [String, Array] 一个或多个聊天室 id
+      # @param chatroom_ids [String, Array] one or more chatroom ids
       #
       def destroy_chatroom(chatroom_ids)
         request("/chatroom/destroy", chatroomId: chatroom_ids)
       end
 
-      # 查询聊天室信息 http://www.rongcloud.cn/docs/server.html#查询聊天室信息_方法
+      # Query one or more chatroom details http://www.rongcloud.cn/docs/server.html#查询聊天室信息_方法
       #
-      # @param chatroom_ids [String, Array] 一个或多个聊天室 id
+      # @param chatroom_ids [String, Array] one or more chatroom ids
       #
       def query_chatroom(chatroom_ids)
         request("/chatroom/query", chatroomId: chatroom_ids)
       end
 
-      # 添加禁言聊天室成员 http://www.rongcloud.cn/docs/server.html#添加禁言聊天室成员_方法
+      # http://www.rongcloud.cn/docs/server.html#添加禁言聊天室成员_方法
       #
       def block_chatroom_user(chatroom_id, user_id, minute)
         request("/chatroom/user/gag/add", chatroomId: chatroom_id, userId: user_id, minute: minute)
       end
 
-      # 移除封禁聊天室成员 http://www.rongcloud.cn/docs/server.html#移除封禁聊天室成员_方法
+      # http://www.rongcloud.cn/docs/server.html#移除封禁聊天室成员_方法
       #
       def unblock_chatroom_user(chatroom_id, user_id)
         request("/chatroom/user/block/rollback", chatroomId: chatroom_id, userId: user_id)
       end
 
-      # 查询被封禁聊天室成员 http://www.rongcloud.cn/docs/server.html#查询被封禁聊天室成员_方法
+      # http://www.rongcloud.cn/docs/server.html#查询被封禁聊天室成员_方法
       #
       def blocked_chatroom_users(chatroom_id)
         request("/chatroom/user/block/list", chatroomId: chatroom_id)
       end
 
-      # 查询聊天室内用户
+      # Fetch members list in a specified chatroom
       #
-      # @param chatroom_id [String] 聊天室 id
-      # @param count [String, Fixnum] 要获取的聊天室成员数，上限为 500
-      # @param order [String] 加入聊天室的先后顺序， 1 为加入时间正序， 2 为加入时间倒序
+      # @param chatroom_id [String] chatroom id
+      # @param count [String, Fixnum] the number of members to fetch, the maximum number is 500
+      # @param order [String] order direction based on the time when users join the chatroom,
+      #   1 for asc ordering, while 2 for desc ordering
       #
       def query_chatroom_users(chatroom_id, count, order = "1")
         request("chatroom/user/query", chatroomId: chatroom_id, count: count, order: order)
       end
 
-      # 聊天室消息停止分发 http://www.rongcloud.cn/docs/server.html#聊天室消息停止分发_方法
+      # http://www.rongcloud.cn/docs/server.html#聊天室消息停止分发_方法
       #
       def stop_chatroom_distribution(chatroom_id)
         request("/chatroom/message/stopDistribution", chatroomId: chatroom_id)
       end
 
-      # 聊天室消息恢复分发 http://www.rongcloud.cn/docs/server.html#聊天室消息恢复分发_方法
+      # http://www.rongcloud.cn/docs/server.html#聊天室消息恢复分发_方法
       #
       def resume_chatroom_distribution(chatroom_id)
         request("/chatroom/message/resumeDistribution", chatroomId: chatroom_id)
@@ -84,12 +86,12 @@ module RongCloud
         request("/chatroom/user/whitelist/add", chatroomId: chatroom_id, userId: user_id)
       end
 
-      # 移除聊天室白名单成员 http://www.rongcloud.cn/docs/server.html#移除聊天室白名单成员_方法
+      # http://www.rongcloud.cn/docs/server.html#移除聊天室白名单成员_方法
       def remove_chatroom_whitelist(chatroom_id, user_id)
         request("/chatroom/user/whitelist/remove", chatroomId: chatroom_id, userId: user_id)
       end
 
-      # 查询聊天室白名单成员 http://www.rongcloud.cn/docs/server.html#查询聊天室白名单成员_方法
+      # http://www.rongcloud.cn/docs/server.html#查询聊天室白名单成员_方法
       def whitelisted_chatroom_users(chatroom_id)
         request("/chatroom/user/whitelist/query", chatroomId: chatroom_id)
       end

data/lib/rong_cloud/services/group.rb

@@ -1,12 +1,7 @@
 module RongCloud
   module Services
-    # 群组服务相关接口 http://www.rongcloud.cn/docs/server.html#群组服务
+    # http://www.rongcloud.cn/docs/server.html#群组服务
     module Group
-      # 同步用户所属群组
-      #
-      # @param user_id [String] 用户在融云的 id
-      # @param groups [Hash] 用户需要同步的群组信息，以群组 id 为键，以群组名称为值
-      #
       def sync_group(user_id, groups)
         params = {userId: user_id}
         groups.each do |id, name|
@@ -16,55 +11,38 @@ module RongCloud
         request("/group/sync", params)
       end
 
-      # 创建群组
-      #
       def create_group(user_id, group_id, group_name)
         request("/group/create", userId: user_id, groupId: group_id, groupName: group_name)
       end
 
-      # 加入群组
-      #
       def join_group(user_id, group_id, group_name)
         request("/group/join", userId: user_id, groupId: group_id, groupName: group_name)
       end
 
-      # 退出群组
-      #
       def quit_group(user_id, group_id)
         request("/group/quit", userId: user_id, groupId: group_id)
       end
 
-      # 解散群组
-      #
       def dismiss_group(user_id, group_id)
         request("/group/dismiss", userId: user_id, groupId: group_id)
       end
 
-      # 刷新群组信息
       def refresh_group(group_id, group_name)
         request("/group/refresh", groupId: group_id, groupName: group_name)
       end
 
-      # 查询群成员
-      #
       def group_members(group_id)
         request("/group/user/query", groupId: group_id)
       end
 
-      # 添加禁言群成员
-      #
       def block_group_member(user_id, group_id, minute)
         request("/group/user/gag/add", userId: user_id, groupId: group_id, minute: minute)
       end
 
-      # 移除禁言群成员
-      #
       def unblock_group_member(user_id, group_id)
         request("/group/user/gag/rollback", userId: user_id, groupId: group_id)
       end
 
-      # 查询被禁言群成员
-      #
       def blocked_group_members(group_id)
         request("/group/user/gag/list", groupId: group_id)
       end

data/lib/rong_cloud/services/history_message.rb

@@ -0,0 +1,22 @@
+module RongCloud
+  module Services
+    # http://www.rongcloud.cn/docs/server.html#消息历史记录服务
+    module HistoryMessage
+      # Get the download url for history messages within specified hour
+      #
+      # @param date [String] the date and hour represented in format "YYYYmmddHH"
+      #
+      def get_history(date)
+        request "/message/history", { date: date }
+      end
+
+      # Delete all history message whithin specified date and hour
+      #
+      # @param date [String] the date and hour represented in format "YYYYmmddHH"
+      #
+      def delete_history(date)
+        request "/message/history/delete", { date: date }
+      end
+    end
+  end
+end

data/lib/rong_cloud/services/message.rb

@@ -2,20 +2,25 @@ require 'rong_cloud/services/message/message_channel'
 
 module RongCloud
   module Services
-    # 消息发送相关接口 http://www.rongcloud.cn/docs/server.html#消息发送服务
+    # http://www.rongcloud.cn/docs/server.html#消息发送服务
     module Message
-      # 通用的发送消息方法
-      # @param from_user_id [String] 消息发起人 id
-      # @param target_id [String, Integer] 消息接收方，用户 id、群组 id、讨论组 id、聊天室 id 等
-      # @param channel_name [String] 消息通道，表示单聊、系统、群组、讨论组、聊天室或者广播消息
-      # @param object_name [String] 消息类型名称，内置消息类型或者自定义消息类型名称
-      # @param [Hash] content 消息体，更多消息请看 http://www.rongcloud.cn/docs/server.html#内置消息类型表
-      # @option content [Object] :content 消息体中的正文，如果为自定义消息，由消息消费方自行解析
-      # @option content [Object] :extra 消息体中的附加信息，传递时为字符串，由消息消费方自行解析
-      # @param args [Array] 额外的 1 到 2 个参数，1 个参数时，表示 options 参数；2 个参数时，第一个参数表示模板消息的 values，第二个参数为 options 参数
-      # @param [Hash] options 额外选项，包含 pushContent 以及 pushData 等配置，所有支持选项根据各消息类型确定
-      # @option options [String] :pushContent 推送通知显示的 Push 内容
-      # @option options [Hash] :pushData 推送 payload
+      # General method to send messages
+      # @param from_user_id [String] sender id
+      # @param target_id [String, Integer] receiver id，might be a user id,
+      #   group id, discussion group id or chatroom id
+      # @param channel_name [String] the message channel
+      # @param object_name [String] message type name, could be built-in or custome names
+      # @param [Hash] content Message object，view http://www.rongcloud.cn/docs/server.html#内置消息类型表 to learn more
+      # @option content [Object] :content the body of message
+      # @option content [Object] :extra the extras of message，passed as a string
+      #   and should be parsed by the message consumer
+      # @param args [Array] additional params，when it includes only one param,
+      #   the args is a options; when 2 params, the first one is the `values` of
+      #   a template message, the the last one is a options
+      # @param [Hash] options options includes pushContent and pushData and so on,
+      #   total supported options determined by the message type
+      # @option options [String] :pushContent push content
+      # @option options [Hash] :pushData push data as payload
       #
       def send_message(from_user_id, target_id, channel_name, object_name, content, *args)
         options = args.extract_options!
@@ -38,38 +43,30 @@ module RongCloud
         request(message_channel.api_path, params, content_type)
       end
 
-      # 发送单聊消息 http://www.rongcloud.cn/docs/server.html#发送单聊消息_方法
-      #
       def send_private_message(from_user_id, to_user_id, object_name, content, options = {})
         send_message(from_user_id, to_user_id, :private, object_name, content, options)
       end
 
-      # 发送单聊模板消息 http://www.rongcloud.cn/docs/server.html#发送单聊模板消息_方法
       def send_private_template_message(from_user_id, to_user_id, object_name, content, values, options = {})
         send_message(from_user_id, to_user_id, :private_template, object_name, content, values, options)
       end
 
-      # 发送系统消息 http://www.rongcloud.cn/docs/server.html#发送系统消息_方法
       def send_system_message(from_user_id, to_user_id, object_name, content, options = {})
         send_message(from_user_id, to_user_id, :system, object_name, content, options)
       end
 
-      # 发送系统模板消息 http://www.rongcloud.cn/docs/server.html#发送系统模板消息_方法
       def send_system_template_message(from_user_id, to_user_id, object_name, content, values, options = {})
         send_message(from_user_id, to_user_id, :system_template, object_name, content, values, options)
       end
 
-      # 发送群组消息 http://www.rongcloud.cn/docs/server.html#发送群组消息_方法
       def send_group_message(from_user_id, to_group_id, object_name, content, options = {})
         send_message(from_user_id, to_group_id, :group, object_name, content, options)
       end
 
-      # 发送讨论组消息 http://www.rongcloud.cn/docs/server.html#发送讨论组消息_方法
       def send_discussion_message(from_user_id, to_discussion_id, object_name, content, options = {})
         send_message(from_user_id, to_discussion_id, :discussion, object_name, content, options)
       end
 
-      # 发送广播消息 http://www.rongcloud.cn/docs/server.html#发送广播消息_方法
       def send_broadcast_message(from_user_id, object_name, content, options = {})
         send_message(from_user_id, nil, :broadcast, object_name, content, options)
       end

data/lib/rong_cloud/services/user.rb

@@ -1,20 +1,18 @@
 module RongCloud
   module Services
-    # 用户相关接口 http://www.rongcloud.cn/docs/server.html#用户服务
+    # http://www.rongcloud.cn/docs/server.html#用户服务
     module User
-      # 获取 Token，即创建融云用户
+      # Generate a new token to create a new RongCloud user
       #
-      # @param user_id [String] 用户 Id，最大长度 64 字节。是用户在 App 中的唯一标识码，必须保证在同一个 App 内不重复，重复的用户 Id 将被当作是同一用户
-      # @param name [String] 用户名称，最大长度 128 字节。用来在 Push 推送时显示用户的名称。
-      # @param portrait_uri [String] 用户头像 URI，最大长度 1024 字节。用来在 Push 推送时显示用户的头像。
-      # @return [Hash] 请求响应结果数据
+      # @param user_id [String] user id
+      # @param name [String] user name
+      # @param portrait_uri [String] the url of user's avatar
+      # @return [Hash] the response data
       #
       def get_token(user_id, name, portrait_uri)
         request("/user/getToken", {userId: user_id, name: name, portraitUri: portrait_uri})
       end
 
-      # 刷新用户信息
-      #
       def refresh_user(user_id, name = nil, portrait_uri = nil)
         params = { userId: user_id, name: name, portraitUri: portrait_uri }
         params.reject!{|key, value| value.nil?}
@@ -22,46 +20,30 @@ module RongCloud
         request("/user/refresh", params)
       end
 
-      # 检查用户在线状态
-      #
       def check_online(user_id)
         request("/user/checkOnline", { userId: user_id })
       end
 
-      # 封禁用户
-      # @param user_id [String] 用户在融云的用户 id
-      # @param minute [Integer] 封禁时长
-      #
       def block_user(user_id, minute)
         request("/user/block", { userId: user_id, minute: minute })
       end
 
-      # 解除用户封禁
-      #
       def unblock_user(user_id)
         request("/user/unblock", userId: user_id)
       end
 
-      # 查询被封禁用户列表
-      #
       def blocked_users
         request("/user/block/query")
       end
 
-      # 添加用户到黑名单
-      #
       def blacklist_add(user_id, black_user_id)
         request("/user/blacklist/add", userId: user_id, blackUserId: black_user_id)
       end
 
-      # 从黑名单中移除用户
-      #
       def blacklist_remove(user_id, black_user_id)
         request("/user/blacklist/remove", userId: user_id, blackUserId: black_user_id)
       end
 
-      # 获取某用户的黑名单列表
-      #
       def blacklisted_users(user_id)
         request("/user/blacklist/query", userId: user_id)
       end

data/lib/rong_cloud/services/wordfilter.rb

@@ -1,23 +1,15 @@
 module RongCloud
   module Services
-    # 敏感词相关接口 http://www.rongcloud.cn/docs/server.html#敏感词服务
+    # http://www.rongcloud.cn/docs/server.html#敏感词服务
     module Wordfilter
-      # 添加敏感词
-      #
-      # @param word [String] 敏感词
-      #
       def add_wordfilter(word)
         request("/wordfilter/add", { word: word })
       end
 
-      # 移除敏感词
-      #
       def delete_wordfilter(word)
         request("/wordfilter/delete", { word: word })
       end
 
-      # 查询已有敏感词的列表
-      #
       def wordfilter_list
         request("/wordfilter/list")
       end

data/lib/rong_cloud/signature.rb

@@ -1,28 +1,28 @@
 require 'digest/sha1'
 
 module RongCloud
-  # 签名算法相关模块
+  # a seperate module to perform api signature
   # http://www.rongcloud.cn/docs/server.html#通用_API_接口签名规则
   #
   module Signature
-    # 生成签名串
+    # generate the final signature
     #
-    # @param nonce [String] 参与签名的随机字串，无长度限制
-    # @param timestamp [String] 时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数
-    # @return [String] 签名完成之后的结果字串
+    # @param nonce [String] a random string with a whatever length
+    # @param timestamp [String] timestamp, the elapsed seconds from 1970-01-01 00:00:00 UTC
+    # @return [String] the final signature
     #
     def signature(nonce, timestamp)
       str = "#{RongCloud::Configuration.app_secret}#{nonce}#{timestamp}"
       Digest::SHA1.hexdigest(str)
     end
 
-    # API 调用签名所需的请求头，包含签名等
-    # @note 包含以下请求头：
+    # get required request headers
+    # @note consist of the following request headers：
     #   App-Key
     #   Nonce
     #   Timestamp
     #   Signature
-    # @return [Hash] 签名所需请求头
+    # @return [Hash] headers represented as a Ruby hash
     def signed_headers
       nonce = rand(10**6)
       timestamp = Time.now.to_i

data/rong_cloud.gemspec

@@ -2,9 +2,9 @@ Gem::Specification.new do |s|
   s.name         = 'rong_cloud_server'
   s.platform     = Gem::Platform::RUBY
   s.require_path = 'lib'
-  s.summary      = '融云 Server API SDK'
-  s.description  = '融云服务器端接口 API，http://www.rongcloud.cn/docs/server.html'
-  s.version      = '0.0.2'
+  s.summary      = 'RongCloud Server API SDK'
+  s.description  = 'RongCloud Server API in Ruby，http://www.rongcloud.cn/docs/server.html'
+  s.version      = '0.1.0'
   s.files        = `git ls-files`.split("\n")
   s.authors      = ['Martin Hong']
   s.email        = 'hongzeqin@gmail.com'

data/test/rong_cloud/service_test_setup.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+
+module RongCloud
+  module ServiceTestSetup
+    def setup
+      rong_cloud_configure_with_settings
+      @service = RongCloud::Service.new
+    end
+  end
+end

data/test/rong_cloud/services/chatroom_test.rb

@@ -1,6 +1,10 @@
+require 'rong_cloud/service_test_setup'
+
 module RongCloud
   module Services
-    module ChatroomTest
+    class ChatroomTest < Minitest::Test
+      include RongCloud::ServiceTestSetup
+
       def test_create_chatroom
         chatrooms = { 10001 => "name1", 10002 => "name2" }
         response = @service.create_chatroom(chatrooms)

data/test/rong_cloud/services/group_test.rb

@@ -1,6 +1,10 @@
+require 'rong_cloud/service_test_setup'
+
 module RongCloud
   module Services
-    module GroupTest
+    class GroupTest < Minitest::Test
+      include RongCloud::ServiceTestSetup
+
       def test_sync_group
         response = @service.sync_group('user1', '1' => 'group1', '2' => 'group2')
         assert_equal 200, response['code']

data/test/rong_cloud/services/history_message_test.rb

@@ -0,0 +1,23 @@
+require 'rong_cloud/service_test_setup'
+
+module RongCloud
+  module Services
+    class HistoryMessageTest < Minitest::Test
+      include RongCloud::ServiceTestSetup
+
+      def test_get_history
+        date = "2014010101"
+        response = @service.get_history(date)
+        assert_equal 200, response['code']
+        assert_equal date, response['date']
+        assert_includes response, 'url'
+      end
+
+      def test_delete_history
+        date = "2014010101"
+        response = @service.delete_history(date)
+        assert_equal 200, response['code']
+      end
+    end
+  end
+end

data/test/rong_cloud/services/message_test.rb

@@ -1,6 +1,10 @@
+require 'rong_cloud/service_test_setup'
+
 module RongCloud
   module Services
-    module MessageTest
+    class MessageTest < Minitest::Test
+      include RongCloud::ServiceTestSetup
+
       def test_send_private_message_with_single_to_user_id
         response = @service.send_private_message(1, 2, "RC:TxtMsg", { content: "hello world", extra: "nothing" })
         assert_equal 200, response["code"]

data/test/rong_cloud/services/user_test.rb

@@ -1,6 +1,10 @@
+require 'rong_cloud/service_test_setup'
+
 module RongCloud
   module Services
-    module UserTest
+    class UserTest < Minitest::Test
+      include RongCloud::ServiceTestSetup
+
       def test_get_token_without_user_id
         error = assert_raises RongCloud::BadRequest do
           @service.get_token(nil, nil, nil)

data/test/rong_cloud/services/wordfilter_test.rb

@@ -1,6 +1,10 @@
+require 'rong_cloud/service_test_setup'
+
 module RongCloud
   module Services
-    module WordfilterTest
+    class WordfilterTest < Minitest::Test
+      include RongCloud::ServiceTestSetup
+
       def test_add_wordfilter_with_single_word
         response = @service.add_wordfilter("敏感词")
         assert_equal 200, response["code"]

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rong_cloud_server
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Martin Hong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2017-02-25 00:00:00.000000000 Z
 dependencies: []
-description: 融云服务器端接口 API，http://www.rongcloud.cn/docs/server.html
+description: RongCloud Server API in Ruby，http://www.rongcloud.cn/docs/server.html
 email: hongzeqin@gmail.com
 executables: []
 extensions: []
@@ -18,6 +18,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - README.md
+- README.zh-CN.md
 - config.example.yml
 - lib/core_ext/array.rb
 - lib/rong_cloud.rb
@@ -27,6 +28,7 @@ files:
 - lib/rong_cloud/service.rb
 - lib/rong_cloud/services/chatroom.rb
 - lib/rong_cloud/services/group.rb
+- lib/rong_cloud/services/history_message.rb
 - lib/rong_cloud/services/message.rb
 - lib/rong_cloud/services/message/message_channel.rb
 - lib/rong_cloud/services/user.rb
@@ -36,9 +38,10 @@ files:
 - run_tests.sh
 - test/rong_cloud/configuration_test.rb
 - test/rong_cloud/request_test.rb
-- test/rong_cloud/service_test.rb
+- test/rong_cloud/service_test_setup.rb
 - test/rong_cloud/services/chatroom_test.rb
 - test/rong_cloud/services/group_test.rb
+- test/rong_cloud/services/history_message_test.rb
 - test/rong_cloud/services/message/message_channel_test.rb
 - test/rong_cloud/services/message_test.rb
 - test/rong_cloud/services/user_test.rb
@@ -69,5 +72,5 @@ rubyforge_project:
 rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
-summary: 融云 Server API SDK
+summary: RongCloud Server API SDK
 test_files: []

data/test/rong_cloud/service_test.rb

@@ -1,21 +0,0 @@
-require 'test_helper'
-require 'rong_cloud/services/user_test'
-require 'rong_cloud/services/message_test'
-require 'rong_cloud/services/wordfilter_test'
-require 'rong_cloud/services/group_test'
-require 'rong_cloud/services/chatroom_test'
-
-module RongCloud
-  class ServiceTest < Minitest::Test
-    include RongCloud::Services::UserTest
-    include RongCloud::Services::MessageTest
-    include RongCloud::Services::WordfilterTest
-    include RongCloud::Services::GroupTest
-    include RongCloud::Services::ChatroomTest
-
-    def setup
-      rong_cloud_configure_with_settings
-      @service = RongCloud::Service.new
-    end
-  end
-end