rong_cloud_server 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0a792a26e83b1a5420aa834459d44f62be0ec8c
+  data.tar.gz: 50b3157736cff25fa9937cd99a002d7fa5a62134
+SHA512:
+  metadata.gz: 9a77797344c9ad396fc0f8b8586d68c061944abac3932cac51445470c2f21d28d4e9544a4ec8524bf21899d2c50a24703b51005ac3b8257b7edf4bf61fdd1ad1
+  data.tar.gz: 72ae4a709051e62499d409c103feb9c106e6f4d1f49b4cbd30cde0f506c3f8ee4d10c4cde46b9495e9f9fe89386ecd99be40e1372b15d1d29c7c45e678cf88fa

data/.gitignore

@@ -0,0 +1,5 @@
+/config.yml
+.byebug_history
+rong_cloud.log
+/doc
+.yardoc/

data/README.md

@@ -0,0 +1,41 @@
+融云 Server SDK
+===
+
+此 gem 实现了[融云 Server API](http://www.rongcloud.cn/docs/server.html)的大部分接口的 Ruby 实现。
+
+### Getting Started
+1. 安装此 gem；
+2. 在项目中添加配置：
+
+  ```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
+  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
+1. 私聊与系统模板消息；
+2. 聊天室其他服务以及高级接口实现；
+3. 实时消息路由；
+4. 消息历史记录；
+5. 在线状态订阅。
+
+### How to contribute
+1. Fork this repo;
+2. Write your code and test;
+3. Open a new Pull Request.

data/config.example.yml

@@ -0,0 +1,3 @@
+app_key: APP_KEY
+app_secret: APP_SECRET
+host: https://api.cn.ronghub.com

data/lib/rong_cloud/configuration.rb

@@ -0,0 +1,30 @@
+require "logger"
+
+module RongCloud
+  # 管理融云 SDK 连接配置信息
+  #
+  module Configuration
+    # 默认 API 服务器，使用 https
+    DEFAULT_HOST = "https://api.cn.ronghub.com".freeze
+
+    module ModuleMethods
+      attr_accessor :app_key, :app_secret, :host, :logger
+
+      # 获取目标主机，默认为 https://api.cn.ronghub.com
+      #
+      def host
+        @host || DEFAULT_HOST
+      end
+
+      # 获取日志文件对象，默认日志文件为标准输出
+      def logger
+        @logger || default_logger
+      end
+
+      def default_logger
+        @default_logger ||= ::Logger.new(STDOUT)
+      end
+    end
+    extend ModuleMethods
+  end
+end

data/lib/rong_cloud/errors.rb

@@ -0,0 +1,39 @@
+module RongCloud
+  # 不支持的消息类型错误
+  class UnsupportedMessageChannelName < ::StandardError;end
+  # 与融云接口请求相关的基本错误类型，其他错误类型继承此类型
+  class RequestError < ::StandardError
+    # @!attribute [rw] business_code
+    #   接口错误时的业务返回码，详见：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
+  # 群上限
+  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,
+    "403" => RequestForbidden,
+    "404" => ResourceNotFound,
+    "405" => ExceedLimit,
+    "429" => TooManyRequests,
+    "500" => InternalServerError,
+    "504" => Timeout
+  }.freeze
+end

data/lib/rong_cloud/request.rb

@@ -0,0 +1,69 @@
+require 'net/http'
+require 'json'
+require 'rong_cloud/signature'
+
+module RongCloud
+  # 请求封装类，所有请求基于 Net::HTTP，自动支持 http 或者 https
+  #
+  module Request
+    include Signature
+
+    # 拼接请求的接口的路径
+    #
+    # @param path [String] 接口的相对路径，e.g. "/user/getToken" 或者 "user/getToken"，代码中自动处理开头的斜杠
+    # @return [URI] 请求全路径生成的 URI 对象，自动追加 .json 格式扩展名
+    #
+    def get_uri(path)
+      url = "#{RongCloud::Configuration.host}/#{path.gsub(/^\//, "")}"
+      URI(url.end_with?(".json") ? url : "#{url}.json")
+    end
+
+    # 实例化请求对象
+    #
+    # @param uri [URI] 请求路径对象
+    # @param params [Hash] 请求的参数，所有参数通过 form encoded data 方式发送
+    # @return [Net::HTTP::Post] 请求的实例
+    #
+    def initialize_request(uri, params)
+      req = Net::HTTP::Post.new(uri)
+      req.set_form_data(params) if params.respond_to?(:map)
+      signed_headers.each { |header, value| req[header] = value }
+
+      req
+    end
+
+    # 解析响应数据，包含错误检测
+    #
+    # @param res [HTTPResponse] 响应结果的实例
+    # @return [Hash] JSON 解析后的响应正文
+    # @raise [RongCloud::BadRequest] 请求参数有误，缺失或者不正确等，详见官方文档
+    #
+    def handle_response(res)
+      json = JSON.parse(res.body)
+      case res
+      when Net::HTTPOK
+        json
+      else
+        error = (HTTP_CODE_TO_ERRORS_MAP[res.code] || RequestError).new(json["errorMessage"])
+        error.business_code = json["code"]
+        raise error
+      end
+    end
+
+    # 执行请求
+    # @param path [String] 请求 API 的相对路径
+    # @param params [Hash] 请求的参数
+    # @return [Hash] JSON 解析后的响应数据
+    # @raise [RongCloud::BadRequest] 请求参数有误，缺失或者不正确等，详见官方文档
+    def request(path, params = nil)
+      uri = get_uri(path)
+      req = initialize_request(uri, params)
+      use_ssl = uri.scheme == 'https'
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: use_ssl) do |http|
+        http.request(req)
+      end
+
+      handle_response(res)
+    end
+  end
+end

data/lib/rong_cloud/service.rb

@@ -0,0 +1,17 @@
+require 'rong_cloud/request'
+require 'rong_cloud/services/user'
+require 'rong_cloud/services/message'
+require 'rong_cloud/services/wordfilter'
+require 'rong_cloud/services/group'
+
+module RongCloud
+  # 封装所有接口的 Service 类，所有业务接口通过 Service 的实例完成调用
+  #
+  class Service
+    include RongCloud::Request
+    include RongCloud::Services::User
+    include RongCloud::Services::Message
+    include RongCloud::Services::Wordfilter
+    include RongCloud::Services::Group
+  end
+end

data/lib/rong_cloud/services/group.rb

@@ -0,0 +1,73 @@
+module RongCloud
+  module Services
+    # 群组服务相关接口 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|
+          params["group[#{id}]"] = name
+        end
+
+        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
+    end
+  end
+end

data/lib/rong_cloud/services/message/message_channel.rb

@@ -0,0 +1,45 @@
+module RongCloud
+  module Services
+    module Message
+      # 消息发送渠道，区分私信、系统消息、群组消息、讨论组消息、聊天室消息以及广播消息
+      class MessageChannel
+        # 各消息渠道各自对应请求路径以及特殊参数名
+        #
+        CHANNEL_TO_REQUEST_DETAILS_MAP = {
+          'private': { target_param_name: "toUserId", api_path: "/message/private/publish" },
+          system: { target_param_name: "toUserId", api_path: "/message/system/publish" },
+          group: { target_param_name: 'toGroupId', api_path: "/message/group/publish" },
+          discussion: { target_param_name: "toDiscussionId", api_path: "/message/discussion/publish" },
+          chatroom: { target_param_name: "toChatroomId", api_path: "/message/chatroom/publish" },
+          broadcast: { api_path: "/message/broadcast" }
+        }.freeze
+        # 支持的消息渠道的列表
+        #
+        VALID_CHANNEL_NAMES = CHANNEL_TO_REQUEST_DETAILS_MAP.keys.map(&:to_s).freeze
+
+        # 实例化消息渠道对象
+        #
+        # @param channel_name [String] 渠道名称
+        # @return [RongCloud::Services::Message::MessageChannel] 消息渠道实例
+        # @raise [RongCloud::UnsupportedMessageChannelName] 消息渠道不支持
+        #
+        def initialize(channel_name)
+          if VALID_CHANNEL_NAMES.include?(channel_name.to_s)
+            @channel_name = channel_name.to_s.to_sym
+          else
+            raise UnsupportedMessageChannelName,
+              "support only channels: #{VALID_CHANNEL_NAMES}"
+          end
+        end
+
+        def target_param_name
+          CHANNEL_TO_REQUEST_DETAILS_MAP[@channel_name][:target_param_name]
+        end
+
+        def api_path
+          CHANNEL_TO_REQUEST_DETAILS_MAP[@channel_name][:api_path]
+        end
+      end
+    end
+  end
+end

data/lib/rong_cloud/services/message.rb

@@ -0,0 +1,58 @@
+require 'rong_cloud/services/message/message_channel'
+
+module RongCloud
+  module Services
+    # 消息发送相关接口 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 [Hash] options 额外选项，包含 pushContent 以及 pushData 等配置，所有支持选项根据各消息类型确定
+      # @option options [String] :pushContent 推送通知显示的 Push 内容
+      # @option options [Hash] :pushData 推送 payload
+      #
+      def send_message(from_user_id, target_id, channel_name, object_name, content, options = {})
+        message_channel = MessageChannel.new(channel_name)
+        params = { fromUserId: from_user_id, objectName: object_name, content: content.to_json }
+        if message_channel.target_param_name
+          params.merge!(message_channel.target_param_name => target_id)
+        end
+
+        params.merge!(options)
+        request(message_channel.api_path, params)
+      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_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_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
+    end
+  end
+end

data/lib/rong_cloud/services/user.rb

@@ -0,0 +1,70 @@
+module RongCloud
+  module Services
+    # 用户相关接口 http://www.rongcloud.cn/docs/server.html#用户服务
+    module User
+      # 获取 Token，即创建融云用户
+      #
+      # @param user_id [String] 用户 Id，最大长度 64 字节。是用户在 App 中的唯一标识码，必须保证在同一个 App 内不重复，重复的用户 Id 将被当作是同一用户
+      # @param name [String] 用户名称，最大长度 128 字节。用来在 Push 推送时显示用户的名称。
+      # @param portrait_uri [String] 用户头像 URI，最大长度 1024 字节。用来在 Push 推送时显示用户的头像。
+      # @return [Hash] 请求响应结果数据
+      #
+      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?}
+
+        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
+    end
+  end
+end

data/lib/rong_cloud/services/wordfilter.rb

@@ -0,0 +1,26 @@
+module RongCloud
+  module Services
+    # 敏感词相关接口 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
+    end
+  end
+end

data/lib/rong_cloud/signature.rb

@@ -0,0 +1,39 @@
+require 'digest/sha1'
+
+module RongCloud
+  # 签名算法相关模块
+  # http://www.rongcloud.cn/docs/server.html#通用_API_接口签名规则
+  #
+  module Signature
+    # 生成签名串
+    #
+    # @param nonce [String] 参与签名的随机字串，无长度限制
+    # @param timestamp [String] 时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数
+    # @return [String] 签名完成之后的结果字串
+    #
+    def signature(nonce, timestamp)
+      str = "#{RongCloud::Configuration.app_secret}#{nonce}#{timestamp}"
+      Digest::SHA1.hexdigest(str)
+    end
+
+    # API 调用签名所需的请求头，包含签名等
+    # @note 包含以下请求头：
+    #   App-Key
+    #   Nonce
+    #   Timestamp
+    #   Signature
+    # @return [Hash] 签名所需请求头
+    def signed_headers
+      nonce = rand(10**6)
+      timestamp = Time.now.to_i
+      signature = signature(nonce, timestamp)
+
+      {
+        'App-Key' => RongCloud::Configuration.app_key,
+        'Nonce' => nonce,
+        'Timestamp' => timestamp,
+        'Signature' => signature
+      }
+    end
+  end
+end

data/lib/rong_cloud.rb

@@ -0,0 +1,12 @@
+require 'rong_cloud/configuration'
+require 'rong_cloud/errors'
+require 'rong_cloud/service'
+
+# 融云 Ruby SDK 的全局命名空间
+module RongCloud
+  # 配置融云 Server 连接信息
+  #
+  def self.configure(&block)
+    yield RongCloud::Configuration
+  end
+end

data/rong_cloud.gemspec

@@ -0,0 +1,13 @@
+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.1'
+  s.files        = `git ls-files`.split("\n")
+  s.authors      = ['Martin Hong']
+  s.email        = 'hongzeqin@gmail.com'
+  s.homepage     = 'http://blog.hackerpie.com/rong_cloud/'
+  s.license      = 'MIT'
+end

data/run_tests.sh

@@ -0,0 +1 @@
+echo "Dir.glob('./test/**/*_test.rb').each { |file| require file}" | ruby -Itest -Ilib

data/test/rong_cloud/configuration_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+module RongCloud
+  class ConfigurationTest < Minitest::Test
+    def setup
+      RongCloud.configure do |config|
+        config.host = nil
+      end
+    end
+
+    def test_app_key_settings_and_reading
+      RongCloud::Configuration.app_key = "test_key"
+      assert_equal "test_key", RongCloud::Configuration.app_key
+    end
+
+    def test_app_secret_settings_and_reading
+      RongCloud::Configuration.app_secret = "test_secret"
+      assert_equal "test_secret", RongCloud::Configuration.app_secret
+    end
+
+    def test_logger_setting_and_reading
+      logger = ::Logger.new("rong_cloud.log")
+      RongCloud::Configuration.logger = logger
+      assert_equal logger, RongCloud::Configuration.logger
+    end
+
+    def test_default_host_and_setting_and_reading
+      assert_equal "https://api.cn.ronghub.com", RongCloud::Configuration.host
+      RongCloud::Configuration.host = "http://other.host.com"
+      assert_equal "http://other.host.com", RongCloud::Configuration.host
+    end
+  end
+end

data/test/rong_cloud/request_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+module RongCloud
+  class RequestTest < Minitest::Test
+    include RongCloud::Request
+
+    def setup
+      rong_cloud_configure_with_settings
+    end
+
+    def test_get_uri_path_end_with_json_format
+      uri = get_uri("users.json")
+      assert_equal "/users.json", uri.path
+      assert_equal "api.cn.ronghub.com", uri.host
+    end
+
+    def test_get_uri_path_not_end_with_json_format
+      uri = get_uri("users")
+      assert_equal "/users.json", uri.path
+      assert_equal "api.cn.ronghub.com", uri.host
+    end
+
+    def test_request_with_invalid_app_key
+      RongCloud::Configuration.app_key = "xxx"
+      error = assert_raises RongCloud::BadRequest do
+        request("/user/getToken", {userId: 'user', name: "User"})
+      end
+      assert_equal "invalid App-Key.", error.message
+      assert_equal 1002, error.business_code
+    end
+
+    def test_request_with_invalid_app_secret
+      RongCloud::Configuration.app_secret = "xxx"
+      error = assert_raises RongCloud::AuthenticationFailed do
+        request("/user/getToken", {userId: 'user', name: "User"})
+      end
+      assert_equal "签名错误，请检查。", error.message
+      assert_equal 1004, error.business_code
+    end
+
+    def test_request_with_missing_required_field
+      error = assert_raises RongCloud::BadRequest do
+        request("/user/getToken")
+      end
+      assert_equal "userId is required.", error.message
+      assert_equal 1002, error.business_code
+    end
+
+    def test_request_with_valid_params
+      response = request("/user/getToken", { userId: 'user', name: "User", portraitUri: "uri" })
+      assert_equal 200, response["code"]
+      assert_equal "user", response["userId"]
+      assert response["token"]
+    end
+  end
+end

data/test/rong_cloud/service_test.rb

@@ -0,0 +1,19 @@
+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'
+
+module RongCloud
+  class ServiceTest < Minitest::Test
+    include RongCloud::Services::UserTest
+    include RongCloud::Services::MessageTest
+    include RongCloud::Services::WordfilterTest
+    include RongCloud::Services::GroupTest
+
+    def setup
+      rong_cloud_configure_with_settings
+      @service = RongCloud::Service.new
+    end
+  end
+end

data/test/rong_cloud/services/group_test.rb

@@ -0,0 +1,102 @@
+module RongCloud
+  module Services
+    module GroupTest
+      def test_sync_group
+        response = @service.sync_group('user1', '1' => 'group1', '2' => 'group2')
+        assert_equal 200, response['code']
+      end
+
+      def test_create_group_with_single_user_id
+        response = @service.create_group('user1', '3', 'group3')
+        assert_equal 200, response['code']
+      end
+
+      def test_create_group_with_multiple_user_id
+        response = @service.create_group(%w(user1 user2 user3), '4', 'group4')
+        assert_equal 200, response['code']
+      end
+
+      def test_create_group_without_group_id
+        error = assert_raises RongCloud::BadRequest do
+          @service.create_group('user1', nil, 'group3')
+        end
+        assert_equal 'groupId is required.', error.message
+      end
+
+      def test_create_group_without_group_name
+        response = @service.create_group('user1', '5', nil)
+        assert_equal 200, response['code']
+      end
+
+      def test_join_group_with_single_user_id
+        response = @service.join_group('user1', '3', 'group3')
+        assert_equal 200, response['code']
+      end
+
+      def test_join_group_with_multiple_user_id
+        response = @service.join_group(%w(user1 user2 user3), '4', 'group4')
+        assert_equal 200, response['code']
+      end
+
+      def test_join_group_without_group_id
+        error = assert_raises RongCloud::BadRequest do
+          @service.join_group('user1', nil, 'group3')
+        end
+        assert_equal 'groupId is required.', error.message
+      end
+
+      def test_join_group_without_group_name
+        response = @service.join_group('user1', '5', nil)
+        assert_equal 200, response['code']
+      end
+
+      def test_quit_group
+        response = @service.quit_group('user', 'group1')
+        assert_equal 200, response['code']
+      end
+
+      def test_dismiss_group
+        response = @service.dismiss_group('user', 'group1')
+        assert_equal 200, response['code']
+      end
+
+      def test_refresh_group
+        response = @service.refresh_group('group1', "测试群组1")
+        assert_equal 200, response['code']
+      end
+
+      def test_group_members
+        @service.create_group("user1", "group6", "测试群组成员")
+        @service.join_group("user2", "group6", "测试群组成员")
+        response = @service.group_members("group6")
+        user_ids = response['users'].map{|user| user['id'] }
+
+        assert_equal 2, user_ids.count
+        assert_includes user_ids, 'user1'
+        assert_includes user_ids, 'user2'
+      end
+
+      def test_block_group_member
+        response = @service.block_group_member("user1", "group1", 600)
+        assert_equal 200, response['code']
+      end
+
+      def test_unblock_group_member
+        response = @service.unblock_group_member("user1", "group1")
+        assert_equal 200, response['code']
+      end
+
+      def test_blocked_group_members
+        @service.create_group("user1", "group1", "测试群组禁言服务")
+        @service.join_group("user2", "group1", "测试群组禁言服务")
+        @service.block_group_member("user2", "group1", 60000)
+
+        response = @service.blocked_group_members('group1')
+        user_ids = response['users'].map{|user| user['userId']}
+
+        assert_equal 1, user_ids.count
+        assert_includes user_ids, "user2"
+      end
+    end
+  end
+end

data/test/rong_cloud/services/message/message_channel_test.rb

@@ -0,0 +1,82 @@
+require 'rong_cloud/services/message/message_channel'
+
+module RongCloud
+  module Services
+    module Message
+      class MessageChannelTest < Minitest::Test
+        def test_initialize_with_supported_channel_name
+          channel = RongCloud::Services::Message::MessageChannel.new(:private)
+          assert channel
+        end
+
+        def test_initialize_with_unsupported_channel_name
+          error = assert_raises RongCloud::UnsupportedMessageChannelName do
+            RongCloud::Services::Message::MessageChannel.new(:nothing)
+          end
+          expected_error = "support only channels: [\"private\", \"system\", \"group\", \"discussion\", \"chatroom\", \"broadcast\"]"
+          assert_equal expected_error, error.message
+        end
+
+        def test_target_param_name_for_private
+          channel = RongCloud::Services::Message::MessageChannel.new(:private)
+          assert_equal "toUserId", channel.target_param_name
+        end
+
+        def test_target_param_name_for_system
+          channel = RongCloud::Services::Message::MessageChannel.new(:system)
+          assert_equal "toUserId", channel.target_param_name
+        end
+
+        def test_target_param_name_for_group
+          channel = RongCloud::Services::Message::MessageChannel.new(:group)
+          assert_equal "toGroupId", channel.target_param_name
+        end
+
+        def test_target_param_name_for_discussion
+          channel = RongCloud::Services::Message::MessageChannel.new(:discussion)
+          assert_equal "toDiscussionId", channel.target_param_name
+        end
+
+        def test_target_param_name_for_chatroom
+          channel = RongCloud::Services::Message::MessageChannel.new(:chatroom)
+          assert_equal "toChatroomId", channel.target_param_name
+        end
+
+        def test_target_param_name_for_broadcast
+          channel = RongCloud::Services::Message::MessageChannel.new(:broadcast)
+          assert_nil channel.target_param_name
+        end
+
+        def test_api_path_for_private
+          channel = RongCloud::Services::Message::MessageChannel.new(:private)
+          assert_equal "/message/private/publish", channel.api_path
+        end
+
+        def test_api_path_for_system
+          channel = RongCloud::Services::Message::MessageChannel.new(:system)
+          assert_equal "/message/system/publish", channel.api_path
+        end
+
+        def test_api_path_for_group
+          channel = RongCloud::Services::Message::MessageChannel.new(:group)
+          assert_equal "/message/group/publish", channel.api_path
+        end
+
+        def test_api_path_for_discussion
+          channel = RongCloud::Services::Message::MessageChannel.new(:discussion)
+          assert_equal "/message/discussion/publish", channel.api_path
+        end
+
+        def test_api_path_for_chatroom
+          channel = RongCloud::Services::Message::MessageChannel.new(:chatroom)
+          assert_equal "/message/chatroom/publish", channel.api_path
+        end
+
+        def test_api_path_for_broadcast
+          channel = RongCloud::Services::Message::MessageChannel.new(:broadcast)
+          assert_equal "/message/broadcast", channel.api_path
+        end
+      end
+    end
+  end
+end

data/test/rong_cloud/services/message_test.rb

@@ -0,0 +1,83 @@
+module RongCloud
+  module Services
+    module MessageTest
+      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"]
+      end
+
+      def test_send_private_message_with_multiple_to_user_ids
+        response = @service.send_private_message(1, [2, 3, 4], "RC:TxtMsg", { content: "hello world", extra: "nothing" })
+        assert_equal 200, response["code"]
+      end
+
+      def test_send_private_message_with_options
+        options = { pushContent: "hello", pushData: { shouldBeTrue: "true" } }
+        response = @service.send_private_message(1, [2, 3, 4], "RC:TxtMsg", { content: "hello world", extra: "nothing" }, options)
+        assert_equal 200, response["code"]
+      end
+
+      def test_send_system_message_with_single_to_user_id
+        response = @service.send_system_message(1, 2, "RC:TxtMsg", { content: "hello world", extra: "nothing" })
+        assert_equal 200, response["code"]
+      end
+
+      def test_send_system_message_with_multiple_to_user_ids
+        response = @service.send_system_message(1, [2, 3, 4], "RC:TxtMsg", { content: "hello world", extra: "nothing" })
+        assert_equal 200, response["code"]
+      end
+
+      def test_send_system_message_with_options
+        options = { pushContent: "hello", pushData: { shouldBeTrue: "true" } }
+        response = @service.send_system_message(1, [2, 3, 4], "RC:TxtMsg", { content: "hello world", extra: "nothing" }, options)
+        assert_equal 200, response["code"]
+      end
+
+      def test_send_group_message_with_single_to_group_id
+        response = @service.send_group_message(1, 2, "RC:TxtMsg", { content: "hello world", extra: "nothing" })
+        assert_equal 200, response["code"]
+      end
+
+      def test_send_group_message_with_multiple_to_group_ids
+        response = @service.send_group_message(1, [2, 3, 4], "RC:TxtMsg", { content: "hello world", extra: "nothing" })
+        assert_equal 200, response["code"]
+      end
+
+      def test_send_group_message_with_multiple_to_too_many_group_ids
+        error = assert_raises RongCloud::BadRequest do
+          @service.send_group_message(1, [2, 3, 4, 5], "RC:TxtMsg", { content: "hello world", extra: "nothing" })
+        end
+
+        assert_equal "the number of toUserId should less than 3.", error.message
+        assert_equal 1002, error.business_code
+      end
+
+      def test_send_group_message_with_options
+        options = { pushContent: "hello", pushData: { shouldBeTrue: "true" } }
+        response = @service.send_group_message(1, [2, 3, 4], "RC:TxtMsg", { content: "hello world", extra: "nothing" }, options)
+        assert_equal 200, response["code"]
+      end
+
+      def test_send_discussion_message_with_single_to_discussion_id
+        response = @service.send_discussion_message(1, 2, "RC:TxtMsg", { content: "hello world", extra: "nothing" })
+        assert_equal 200, response["code"]
+      end
+
+      def test_send_discussion_message_with_multiple_to_discussion_ids
+        response = @service.send_discussion_message(1, [2, 3, 4], "RC:TxtMsg", { content: "hello world", extra: "nothing" })
+        assert_equal 200, response["code"]
+      end
+
+      def test_send_discussion_message_with_options
+        options = { pushContent: "hello", pushData: { shouldBeTrue: "true" } }
+        response = @service.send_discussion_message(1, [2, 3, 4], "RC:TxtMsg", { content: "hello world", extra: "nothing" }, options)
+        assert_equal 200, response["code"]
+      end
+
+      def test_send_broadcast_message
+        response = @service.send_broadcast_message(1, "RC:TxtMsg", { content: "hello world", extra: "nothing" })
+        assert_equal 200, response["code"]
+      end
+    end
+  end
+end

data/test/rong_cloud/services/user_test.rb

@@ -0,0 +1,144 @@
+module RongCloud
+  module Services
+    module UserTest
+      def test_get_token_without_user_id
+        error = assert_raises RongCloud::BadRequest do
+          @service.get_token(nil, nil, nil)
+        end
+        assert_equal 1002, error.business_code
+        assert_equal "userId is required.", error.message
+      end
+
+      def test_get_token_without_name
+        response = @service.get_token("user", nil, nil)
+        assert response["token"]
+      end
+
+      def test_get_token_without_portrait_url
+        response = @service.get_token("user", "User", nil)
+        assert response["token"]
+      end
+
+      def test_get_token_with_all_params
+        response = @service.get_token("user", "User", "fake_url")
+        assert response["token"]
+      end
+
+      def test_get_token_with_chinese_name
+        response = @service.get_token("user", "王二狗", "fake_url")
+        assert response["token"]
+      end
+
+      def test_refresh_user_without_user_id
+        error = assert_raises RongCloud::BadRequest do
+          @service.refresh_user(nil, nil, nil)
+        end
+        assert_equal 1002, error.business_code
+        assert_equal "userId is required.", error.message
+      end
+
+      def test_refresh_user_with_unexisted_user_id
+        error = assert_raises RongCloud::BadRequest do
+          @service.refresh_user("unexistedUserId", nil, nil)
+        end
+        assert_equal "userIdunexistedUserId is not exist.", error.message
+        assert_equal 1002, error.business_code
+      end
+
+      def test_refresh_user_without_portrait_url
+        response = @service.refresh_user("user", "User", nil)
+        assert_equal 200, response["code"]
+      end
+
+      def test_refresh_user_with_all_params
+        response = @service.refresh_user("user", "User", "fake_url")
+        assert_equal 200, response["code"]
+      end
+
+      def test_refresh_user_with_chinese_name
+        response = @service.refresh_user("user", "小李子", nil)
+        assert_equal 200, response["code"]
+      end
+
+      def test_check_online_without_user_id
+        error = assert_raises RongCloud::BadRequest do
+          @service.check_online(nil)
+        end
+        assert_equal "userId is required.", error.message
+        assert_equal 1002, error.business_code
+      end
+
+      def test_check_online_with_unexisted_user_id
+        response = @service.check_online("unexistedUserId")
+        assert_equal "0", response["status"]
+      end
+
+      def test_check_online_with_existed_user_id
+        response = @service.check_online("user")
+        assert_equal "0", response["status"]
+      end
+
+      def test_block_user_without_user_id
+        error = assert_raises RongCloud::BadRequest do
+          @service.block_user(nil, nil)
+        end
+        assert_equal "userId is required.", error.message
+        assert_equal 1002, error.business_code
+      end
+
+      def test_block_user_without_minute
+        @service.get_token("blocked_user", "Blocked", "fake_url")
+        error = assert_raises RongCloud::BadRequest do
+          @service.block_user("blocked_user", nil)
+        end
+
+        assert_equal "minute is required.", error.message
+        assert_equal 1002, error.business_code
+      end
+
+      def test_block_user_without_unexisted_user_id
+        response = @service.block_user("unexistedUserId", 3)
+        assert_equal 200, response["code"]
+      end
+
+      def test_block_user_and_blocked_users_and_unblock_user
+        @service.get_token("blocked_user2", "Blocked", "fake_url")
+        response = @service.block_user("blocked_user2", 10)
+        assert_equal 200, response["code"]
+
+        users = @service.blocked_users["users"]
+        user = users.detect{|object| object["userId"] == "blocked_user2"}
+        assert user["blockEndTime"]
+
+        response = @service.unblock_user("blocked_user2")
+        assert 200, response["code"]
+      end
+
+      def test_blacklist_add_for_unexisted_user_id
+        response = @service.blacklist_add("unexisted", "blacklisted_user")
+        assert_equal 200, response["code"]
+      end
+
+      def test_blacklist_add_for_existed_user_with_multiple_black_user_id
+        response = @service.blacklist_add("user", %w(blu blu2 blu3))
+        assert_equal 200, response["code"]
+      end
+
+      def test_blacklist_remove_for_unexisted_user_id
+        response = @service.blacklist_remove("unexisted_user", "blacklisted_user")
+        assert_equal 200, response["code"]
+      end
+
+      def test_blacklist_remove_for_unblacklisted_user_id
+        response = @service.blacklist_remove("user", "unexisted_user")
+        assert_equal 200, response["code"]
+      end
+
+      def test_blacklisted_users
+        @service.blacklist_add("user", %w(user2 user3))
+        response = @service.blacklisted_users("user")
+        assert %w(user2 user3) & response["users"] == %w(user2 user3)
+      end
+    end
+  end
+end

data/test/rong_cloud/services/wordfilter_test.rb

@@ -0,0 +1,30 @@
+module RongCloud
+  module Services
+    module WordfilterTest
+      def test_add_wordfilter_with_single_word
+        response = @service.add_wordfilter("敏感词")
+        assert_equal 200, response["code"]
+      end
+
+      def test_delete_exist_wordfilter
+        @service.add_wordfilter("hello")
+        response = @service.delete_wordfilter("hello")
+        assert_equal 200, response["code"]
+      end
+
+      def test_delete_unexist_wordfilter
+        response = @service.delete_wordfilter("unexistedWord")
+        assert_equal 500, response["code"]  # TODO: 500 非期待，后边修复
+      end
+
+      def test_wordfilter_list
+        @service.add_wordfilter("乱")
+        response = @service.wordfilter_list
+        words = response["words"].map{|word| word["word"]}
+        assert_includes words, "乱"
+
+        @service.delete_wordfilter("乱")
+      end
+    end
+  end
+end

data/test/rong_cloud/signature_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+module RongCloud
+  class SignatureTest < Minitest::Test
+    include RongCloud::Signature
+
+    def setup
+      RongCloud.configure do |config|
+        config.app_key = "uwd1c0sxdlx2"
+        config.app_secret = "Y1W2MeFwwwRxa0"
+
+        @nonce = 14314
+        @timestamp = 1408706337
+        @expected_sign = "e107e3819638b81a00383951d1d871197910ffe6"
+      end
+    end
+
+    def test_signature
+      signature = signature(@nonce, @timestamp)
+      assert_equal @expected_sign, signature
+    end
+
+    def test_signed_headers
+      Time.stub :now, Time.at(@timestamp) do
+        def rand(args)
+          @nonce
+        end
+
+        expected_headers = {
+          'App-Key' => RongCloud::Configuration.app_key,
+          'Nonce' => @nonce,
+          'Timestamp' => @timestamp,
+          'Signature' => @expected_sign
+        }
+        assert_equal expected_headers, signed_headers
+      end
+    end
+  end
+end

data/test/rong_cloud_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+class RondCloudTest < Minitest::Test
+  def test_configure
+    RongCloud.configure do |app|
+      app.app_key = "KEY"
+      app.app_secret = "SECRET"
+      app.host = "HOST"
+    end
+
+    assert_equal "KEY", RongCloud::Configuration.app_key
+    assert_equal "SECRET", RongCloud::Configuration.app_secret
+    assert_equal "HOST", RongCloud::Configuration.host
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'minitest/autorun'
+require 'byebug'
+require 'rong_cloud'
+require 'yaml'
+
+$settings = YAML.load_file("./config.yml")
+
+def rong_cloud_configure_with_settings
+  RongCloud.configure do |config|
+    $settings.each do |setting, value|
+      config.send("#{setting}=", value)
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: rong_cloud_server
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Martin Hong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-09 00:00:00.000000000 Z
+dependencies: []
+description: 融云服务器端接口 API，http://www.rongcloud.cn/docs/server.html
+email: hongzeqin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- config.example.yml
+- lib/rong_cloud.rb
+- lib/rong_cloud/configuration.rb
+- lib/rong_cloud/errors.rb
+- lib/rong_cloud/request.rb
+- lib/rong_cloud/service.rb
+- lib/rong_cloud/services/group.rb
+- lib/rong_cloud/services/message.rb
+- lib/rong_cloud/services/message/message_channel.rb
+- lib/rong_cloud/services/user.rb
+- lib/rong_cloud/services/wordfilter.rb
+- lib/rong_cloud/signature.rb
+- rong_cloud.gemspec
+- run_tests.sh
+- test/rong_cloud/configuration_test.rb
+- test/rong_cloud/request_test.rb
+- test/rong_cloud/service_test.rb
+- test/rong_cloud/services/group_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
+- test/rong_cloud/services/wordfilter_test.rb
+- test/rong_cloud/signature_test.rb
+- test/rong_cloud_test.rb
+- test/test_helper.rb
+homepage: http://blog.hackerpie.com/rong_cloud/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: 融云 Server API SDK
+test_files: []