rong_cloud_server 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 467c538f9677d96d1d2c508ffb43d5ff0861196e
-  data.tar.gz: c61c622482007dd0a7ad00a5bebe6b10b8751180
+  metadata.gz: a8851d724f0063d44b4baec6498e55dbcb584ce2
+  data.tar.gz: 46cbca45d889185c5e3a2062c17d99f9d8a7df83
 SHA512:
-  metadata.gz: 8862213ffc65c7189e48e4d7fd3a6cd482fb740b928f829c1db81afddfed30549d8e05364a616eed4ea6a13ad7cbb32c6d0c8dbc7d46089f8f794c1bc690b09c
-  data.tar.gz: 5d7bf432889a2ec4084e7862d422fb4c539f4820b4a1d1a5282e89f15554bb9c24215d882b8be56f559f174ca83e59e6cffe12910b2dc42b46fbda81aa3c2e6e
+  metadata.gz: f8f62f13ef18c5c4541c34fae5df6969c73855f9955b910ebc1c3955d2688e0892dabe8d2a077bb8685bf9f7d805f082c1a0f214539448a81b2835415d5cfe97
+  data.tar.gz: 994b4805135d4b3113cf2638ad072f28fd9293be0329f3c61d5d048830f32e6e6f9f4f8a4f22bbcca330f8e60d978a142d7becf41f08baec84b9b39a9c5d9b09

data/README.md

@@ -2,8 +2,7 @@
 ===
 [![Build Status](https://travis-ci.org/Martin91/rong_cloud.svg?branch=master)](https://travis-ci.org/Martin91/rong_cloud)
 [![Coverage Status](https://coveralls.io/repos/github/Martin91/rong_cloud/badge.svg?branch=master)](https://coveralls.io/github/Martin91/rong_cloud?branch=master)
-
-To view the README in Chinese, visit [README.zh-CN.md](./README.zh-CN.md)
+[![Code Climate](https://codeclimate.com/github/Martin91/rong_cloud/badges/gpa.svg)](https://codeclimate.com/github/Martin91/rong_cloud)
 
 This repository implements most essential apis for [RongCloud Server API](http://www.rongcloud.cn/docs/server.html) in Ruby programming language.
 
@@ -50,7 +49,15 @@ Just include `RongCloud::Signature` in your codes to validate api signature and
 
 More infos about parameters, refer to the [official documents](http://www.rongcloud.cn/docs/server.html#服务端实时消息路由).
 
+### Run tests
+```sh
+ruby -Ilib -Itest -e 'ARGV.each { |f| require f }' ./test/**/*_test.rb
+```
+
 ### How to contribute
 1. Fork this repo;
 2. Write your code and test;
-3. Open a new Pull Request.
+3. Open a new Pull Request.
+
+### TODO
+1. Logger support

data/lib/rong_cloud/configuration.rb

@@ -6,16 +6,21 @@ module RongCloud
   module Configuration
     # The default host to accept connections, use a https protocol
     DEFAULT_HOST = "https://api.cn.ronghub.com".freeze
+    DEFAULT_TIMEOUT = 2
 
     module ModuleMethods
       attr_accessor :app_key, :app_secret
-      attr_writer :host
+      attr_writer :host, :timeout
 
       # Fetch the api host, the default is: https://api.cn.ronghub.com
       #
       def host
         @host || DEFAULT_HOST
       end
+
+      def timeout
+        @timeout || DEFAULT_TIMEOUT
+      end
     end
     extend ModuleMethods
   end

data/lib/rong_cloud/errors.rb

@@ -6,7 +6,7 @@ module RongCloud
   class RequestError < ::StandardError
     # @!attribute [rw] business_code
     #   extended attribute, recording the return codes defined by RongCloud,
-    #   View http://www.rongcloud.cn/docs/server.html#API_方法返回值说明
+    #   refer to: http://www.rongcloud.cn/docs/server.html#api_code
     attr_accessor :business_code
   end
 
@@ -20,6 +20,8 @@ module RongCloud
   class InternalServerError < RequestError;end
   class Timeout < RequestError;end
 
+  # http://www.rongcloud.cn/docs/server.html#api
+  # API 返回值
   HTTP_CODE_TO_ERRORS_MAP = {
     "400" => BadRequest,
     "401" => AuthenticationFailed,

data/lib/rong_cloud/request.rb

@@ -17,8 +17,12 @@ module RongCloud
     def request(path, params = nil, content_type = :form_data)
       uri = get_uri(path)
       req = initialize_request(uri, params, content_type)
+
       use_ssl = uri.scheme == 'https'
-      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: use_ssl) do |http|
+      timeout = RongCloud::Configuration.timeout
+      request_options = { use_ssl: use_ssl, open_timeout: timeout, read_timeout: timeout }
+
+      res = Net::HTTP.start(uri.hostname, uri.port, request_options) do |http|
         http.request(req)
       end
 

data/lib/rong_cloud/service.rb

@@ -1,7 +1,10 @@
 require 'rong_cloud/request'
 require 'rong_cloud/services/user'
+require 'rong_cloud/services/conversation_notification'
 require 'rong_cloud/services/message'
-require 'rong_cloud/services/wordfilter'
+require 'rong_cloud/services/message_recall'
+require 'rong_cloud/services/message_priority'
+require 'rong_cloud/services/sensitive_word'
 require 'rong_cloud/services/group'
 require 'rong_cloud/services/chatroom'
 require 'rong_cloud/services/history_message'
@@ -10,9 +13,12 @@ module RongCloud
   class Service
     include RongCloud::Request
     include RongCloud::Services::User
+    include RongCloud::Services::ConversationNotification
     include RongCloud::Services::Message
+    include RongCloud::Services::MessageRecall
+    include RongCloud::Services::MessagePriority
     include RongCloud::Services::HistoryMessage
-    include RongCloud::Services::Wordfilter
+    include RongCloud::Services::SensitiveWord
     include RongCloud::Services::Group
     include RongCloud::Services::Chatroom
   end

data/lib/rong_cloud/services/chatroom.rb

@@ -39,22 +39,30 @@ module RongCloud
         request("/chatroom/query", chatroomId: chatroom_ids)
       end
 
-      # http://www.rongcloud.cn/docs/server.html#添加禁言聊天室成员_方法
+      def query_chatroom_user_existence(chatroom_id, user_id)
+        request("/chatroom/user/exist", chatroomId: chatroom_id, userId: user_id)
+      end
+
+      def query_chatroom_users_existence(chatroom_id, user_id)
+        request("/chatroom/users/exist", chatroomId: chatroom_id, userId: user_id)
+      end
+
+      # http://www.rongcloud.cn/docs/server.html#chatroom_user_gag_add
       #
-      def block_chatroom_user(chatroom_id, user_id, minute)
+      def add_chatroom_gag_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#chatroom_user_gag_rollback
       #
-      def unblock_chatroom_user(chatroom_id, user_id)
-        request("/chatroom/user/block/rollback", chatroomId: chatroom_id, userId: user_id)
+      def rollback_chatroom_gag_user(chatroom_id, user_id)
+        request("/chatroom/user/gag/rollback", chatroomId: chatroom_id, userId: user_id)
       end
 
-      # http://www.rongcloud.cn/docs/server.html#查询被封禁聊天室成员_方法
+      # http://www.rongcloud.cn/docs/server.html#chatroom_user_gag_list
       #
-      def blocked_chatroom_users(chatroom_id)
-        request("/chatroom/user/block/list", chatroomId: chatroom_id)
+      def chatroom_gag_users(chatroom_id)
+        request("/chatroom/user/gag/list", chatroomId: chatroom_id)
       end
 
       # Fetch members list in a specified chatroom
@@ -95,6 +103,54 @@ module RongCloud
       def whitelisted_chatroom_users(chatroom_id)
         request("/chatroom/user/whitelist/query", chatroomId: chatroom_id)
       end
+
+      # http://www.rongcloud.cn/docs/server.html#chatroom_user_ban
+      def ban_chatroom_user(user_id, minute)
+        request("/chatroom/user/ban/add", userId: user_id, minute: minute)
+      end
+
+      # http://www.rongcloud.cn/docs/server.html#chatroom_user_ban_remove
+      def unban_chatroom_user(user_id)
+        request("/chatroom/user/ban/remove", userId: user_id)
+      end
+
+      # http://www.rongcloud.cn/docs/server.html#chatroom_user_ban_query
+      def banned_chatroom_users
+        request("/chatroom/user/ban/query")
+      end
+
+      # http://www.rongcloud.cn/docs/server.html#chatroom_user_block_add
+      #
+      def block_chatroom_user(chatroom_id, user_id, minute)
+        request("/chatroom/user/block/add", chatroomId: chatroom_id, userId: user_id, minute: minute)
+      end
+
+      # http://www.rongcloud.cn/docs/server.html#chatroom_user_block_rollback
+      #
+      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#chatroom_user_block_list
+      #
+      def blocked_chatroom_users(chatroom_id)
+        request("/chatroom/user/block/list", chatroomId: chatroom_id)
+      end
+
+      # http://www.rongcloud.cn/docs/server.html#chatroom_keepalive_add
+      def add_keepalive_chatroom(chatroom_id)
+        request("/chatroom/keepalive/add", chatroomId: chatroom_id)
+      end
+
+      # http://www.rongcloud.cn/docs/server.html#chatroom_keepalive_remove
+      def remove_keepalive_chatroom(chatroom_id)
+        request("/chatroom/keepalive/remove", chatroomId: chatroom_id)
+      end
+
+      # http://www.rongcloud.cn/docs/server.html#chatroom_keepalive_query
+      def keepalive_chatrooms
+        request("/chatroom/keepalive/query")
+      end
     end
   end
 end

data/lib/rong_cloud/services/conversation_notification.rb

@@ -0,0 +1,23 @@
+module RongCloud
+  module Services
+    # http://www.rongcloud.cn/docs/server.html#conversation_notification
+    module ConversationNotification
+      def set_conversation_notification(conversation_type, request_id, target_id, is_muted)
+        request("/conversation/notification/set", {
+          conversationType: conversation_type,
+          requestId: request_id,
+          targetId: target_id,
+          isMuted: is_muted
+        })
+      end
+
+      def get_conversation_notification(conversation_type, request_id, target_id)
+        request("/conversation/notification/get", {
+          conversationType: conversation_type,
+          requestId: request_id,
+          targetId: target_id
+        })
+      end
+    end
+  end
+end

data/lib/rong_cloud/services/group.rb

@@ -1,7 +1,9 @@
 module RongCloud
   module Services
-    # http://www.rongcloud.cn/docs/server.html#群组服务
+    # http://www.rongcloud.cn/docs/server.html#group
     module Group
+      # @param user_id [String] user id
+      # @param groups [Hash] store group id as hash key, while group name as value, e.g. { 132 => "欢天喜地一家亲" }
       def sync_group(user_id, groups)
         params = {userId: user_id}
         groups.each do |id, name|

data/lib/rong_cloud/services/history_message.rb

@@ -1,6 +1,6 @@
 module RongCloud
   module Services
-    # http://www.rongcloud.cn/docs/server.html#消息历史记录服务
+    # http://www.rongcloud.cn/docs/server.html#history_message
     module HistoryMessage
       # Get the download url for history messages within specified hour
       #

data/lib/rong_cloud/services/message.rb

@@ -2,7 +2,7 @@ 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#message
     module Message
       # General method to send messages
       # @param from_user_id [String] sender id
@@ -14,6 +14,7 @@ module RongCloud
       # @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
+      # @option content [Object] :user the informations for user, see: http://www.rongcloud.cn/docs/server.html#user_info
       # @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
@@ -21,6 +22,8 @@ module RongCloud
       #   total supported options determined by the message type
       # @option options [String] :pushContent push content
       # @option options [Hash] :pushData push data as payload
+      # @option options [Hash] :verifyBlacklist verify sender's blacklist
+      # @option options [Hash] :contentAvailable for iOS devices, see docs for more details
       #
       def send_message(from_user_id, target_id, channel_name, object_name, content, *args)
         options = args.extract_options!
@@ -67,6 +70,14 @@ module RongCloud
         send_message(from_user_id, to_discussion_id, :discussion, object_name, content, options)
       end
 
+      def send_chatroom_message(from_user_id, to_chatroom_id, object_name, content, options = {})
+        send_message(from_user_id, to_chatroom_id, :chatroom, object_name, content, options)
+      end
+
+      def send_chatroom_broadcast_message(from_user_id, object_name, content, options = {})
+        send_message(from_user_id, nil, :chatroom_broadcast, object_name, content, options)
+      end
+
       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/message/message_channel.rb

@@ -6,13 +6,14 @@ module RongCloud
         # 各消息渠道各自对应请求路径以及特殊参数名
         #
         CHANNEL_TO_REQUEST_DETAILS_MAP = {
-          'private': { target_param_name: "toUserId", api_path: "/message/private/publish" },
+          private: { target_param_name: "toUserId", api_path: "/message/private/publish" },
           private_template: { target_param_name: "toUserId", api_path: "/message/private/publish_template" },
           system: { target_param_name: "toUserId", api_path: "/message/system/publish" },
           system_template: { target_param_name: "toUserId", api_path: "/message/system/publish_template" },
           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" },
+          chatroom_broadcast: { api_path: "/message/chatroom/broadcast" },
           broadcast: { api_path: "/message/broadcast" }
         }.freeze
         # 支持的消息渠道的列表

data/lib/rong_cloud/services/message_priority.rb

@@ -0,0 +1,32 @@
+require 'rong_cloud/services/message/message_channel'
+
+module RongCloud
+  module Services
+    # http://www.rongcloud.cn/docs/server.html#chatroom_message_priority
+    module MessagePriority
+      def add_chatroom_message_priority(object_name)
+        request("/chatroom/message/priority/add", objectName: object_name)
+      end
+
+      def remove_chatroom_message_priority(object_name)
+        request("/chatroom/message/priority/remove", objectName: object_name)
+      end
+
+      def chatroom_message_priorities
+        request("/chatroom/message/priority/query")
+      end
+
+      def add_chatroom_message_whitelist(object_names)
+        request("/chatroom/whitelist/add", objectnames: object_names)
+      end
+
+      def remove_chatroom_message_whitelist(object_names)
+        request("/chatroom/whitelist/delete", objectnames: object_names)
+      end
+
+      def chatroom_message_whitelist
+        request("/chatroom/whitelist/query")
+      end
+    end
+  end
+end

data/lib/rong_cloud/services/message_recall.rb

@@ -0,0 +1,18 @@
+require 'rong_cloud/services/message/message_channel'
+
+module RongCloud
+  module Services
+    # http://www.rongcloud.cn/docs/server.html#message_recall
+    module MessageRecall
+      def message_recall(from_user_id, conversation_type, target_id, message_uid, sent_time)
+        request("/message/recall", {
+          fromUserId: from_user_id,
+          conversationType: conversation_type,
+          targetId: target_id,
+          messageUID: message_uid,
+          sentTime: sent_time
+        })
+      end
+    end
+  end
+end

data/lib/rong_cloud/services/sensitive_word.rb

@@ -0,0 +1,30 @@
+module RongCloud
+  module Services
+    # http://www.rongcloud.cn/docs/server.html#sensitiveword
+    module SensitiveWord
+      def add_sensitive_word(word, replace_word = nil)
+        arguments = { word: word }
+        if replace_word.is_a?(String) && replace_word.length > 0
+          arguments.merge!(replaceWord: replace_word)
+        end
+
+        request("/sensitiveword/add", arguments)
+      end
+      alias_method :add_wordfilter, :add_sensitive_word
+
+      def delete_sensitive_word(word)
+        request("/sensitiveword/delete", { word: word })
+      end
+      alias_method :delete_wordfilter, :delete_sensitive_word
+
+      def batch_delete_sensitive_word(words)
+        request("/sensitiveword/batch/delete", words: [*words])
+      end
+
+      def sensitive_word_list
+        request("/sensitiveword/list")
+      end
+      alias_method :wordfilter_list, :sensitive_word_list
+    end
+  end
+end

data/rong_cloud.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
   s.summary      = 'RongCloud Server API SDK'
   s.description  = 'RongCloud Server API in Ruby，http://www.rongcloud.cn/docs/server.html'
-  s.version      = '0.1.1'
+  s.version      = '0.2.0'
   s.files        = `git ls-files`.split("\n")
   s.authors      = ['Martin Hong']
   s.email        = 'hongzeqin@gmail.com'

data/test/rong_cloud/request_test.rb

@@ -52,5 +52,17 @@ module RongCloud
       assert_equal "user", response["userId"]
       assert response["token"]
     end
+
+    def test_request_with_timeout_set
+      original_timeout = RongCloud::Configuration.timeout
+      RongCloud::Configuration.timeout = 0.001
+
+      service = RongCloud::Service.new
+      assert_raises Net::OpenTimeout do
+        response = request("/user/getToken", { userId: 'user', name: "User", portraitUri: "uri" })
+      end
+
+      RongCloud::Configuration.timeout = original_timeout
+    end
   end
 end

data/test/rong_cloud/services/chatroom_test.rb

@@ -86,18 +86,48 @@ module RongCloud
         assert_equal 2, users.count
       end
 
-      def test_block_chatroom_user_flow
+      def test_query_chatroom_user_existence_for_existed_user
+        create_chatrooms({10009 => "room9"})
+        @service.join_chatroom("user3", 10009)
+
+        response = @service.query_chatroom_user_existence("10009", "user3")
+        assert response["isInChrm"]
+      end
+
+      def test_query_chatroom_user_existence_for_unexisted_user
+        create_chatrooms({10009 => "room9"})
+        @service.join_chatroom("user3", 10009)
+
+        response = @service.query_chatroom_user_existence("10009", "unexisted_user_id")
+        refute response["isInChrm"]
+      end
+
+      def test_query_chatroom_users_existence
+        create_chatrooms({10009 => "room9"})
+        @service.join_chatroom("user3", 10009)
+
+        response = @service.query_chatroom_users_existence("10009", ["user3", "unexisted_user_id"])
+        result = response["result"]
+
+        user3_result = result.detect{ |r| r["userId"] == "user3" }
+        assert_equal 1, user3_result["isInChrm"]
+
+        unexisted_user_result = result.detect{ |r| r["userId"] == "unexisted_user_id" }
+        assert_equal 0, unexisted_user_result["isInChrm"]
+      end
+
+      def test_gag_chatroom_user_flow
         create_chatrooms({10010 => "room10"})
         @service.join_chatroom("user5", 10010)
 
-        response = @service.block_chatroom_user(10010, "user5", 60)
+        response = @service.add_chatroom_gag_user(10010, "user5", 60)
         assert_equal 200, response["code"]
 
-        response = @service.blocked_chatroom_users(10010)
+        response = @service.chatroom_gag_users(10010)
         assert_equal 200, response["code"]
         assert response["users"]
 
-        response = @service.unblock_chatroom_user(10010, "user5")
+        response = @service.rollback_chatroom_gag_user(10010, "user5")
         assert_equal 200, response["code"]
       end
 
@@ -130,6 +160,77 @@ module RongCloud
         assert_equal 200, response["code"]
       end
 
+      def test_ban_chatroom_user
+        error = assert_raises RongCloud::RequestError do
+          @service.ban_chatroom_user(1, 60)
+        end
+
+        # 聊天室全局禁言功能未开通。
+        assert_equal 1009, error.business_code
+      end
+
+      def test_unban_chatroom_user
+        error = assert_raises RongCloud::RequestError do
+          @service.unban_chatroom_user(1)
+        end
+
+        # 聊天室全局禁言功能未开通。
+        assert_equal 1009, error.business_code
+      end
+
+      def test_banned_chatroom_users
+        error = assert_raises RongCloud::RequestError do
+          @service.banned_chatroom_users
+        end
+
+        # 聊天室全局禁言功能未开通。
+        assert_equal 1009, error.business_code
+      end
+
+      def test_block_chatroom_user_flow
+        create_chatrooms({10010 => "room10"})
+        @service.join_chatroom("user5", 10010)
+
+        response = @service.block_chatroom_user(10010, "user5", 60)
+        assert_equal 200, response["code"]
+
+        response = @service.blocked_chatroom_users(10010)
+        assert response["users"].detect{ |u| u["userId"] == "user5" }
+
+        response = @service.unblock_chatroom_user(10010, "user5")
+        assert_equal 200, response["code"]
+
+        response = @service.blocked_chatroom_users(10010)
+        refute response["users"].detect{ |u| u["userId"] == "user5" }
+      end
+
+      def test_add_keepalive_chatroom
+        error = assert_raises RongCloud::RequestError do
+          @service.add_keepalive_chatroom(10011)
+        end
+
+        assert_equal "聊天室保活服务未开通。", error.message
+        assert_equal 1009, error.business_code
+      end
+
+      def test_remove_keepalive_chatroom
+        error = assert_raises RongCloud::RequestError do
+          @service.remove_keepalive_chatroom(10011)
+        end
+
+        assert_equal "聊天室保活服务未开通。", error.message
+        assert_equal 1009, error.business_code
+      end
+
+      def test_keepalive_chatrooms
+        error = assert_raises RongCloud::RequestError do
+          @service.keepalive_chatrooms
+        end
+
+        assert_equal "聊天室保活服务未开通。", error.message
+        assert_equal 1009, error.business_code
+      end
+
       private
       def create_chatrooms(chatrooms = { 10000001 => "super chatroom"})
         @service.create_chatroom(chatrooms)

data/test/rong_cloud/services/conversation_notification_test.rb

@@ -0,0 +1,27 @@
+require 'rong_cloud/service_test_setup'
+
+module RongCloud
+  module Services
+    class ConversationNotificationTest < Minitest::Test
+      include RongCloud::ServiceTestSetup
+
+      def test_set_conversation_notification
+        response = @service.set_conversation_notification(1, 2, 99, 1)
+        assert_equal 200, response["code"]
+      end
+
+      def test_get_conversation_notification
+        @service.set_conversation_notification(1, 2, 99, 1)
+        response = @service.get_conversation_notification(1, 2, 99)
+        assert_equal 1, response["isMuted"]
+
+        @service.set_conversation_notification(1, 2, 99, 0)
+        response = @service.get_conversation_notification(1, 2, 99)
+        assert_equal 0, response["isMuted"]
+
+        response = @service.get_conversation_notification(1, 2, "unexisted_id")
+        assert_equal 0, response["isMuted"]
+      end
+    end
+  end
+end

data/test/rong_cloud/services/history_message_test.rb

@@ -16,7 +16,7 @@ module RongCloud
       def test_delete_history
         date = "2014010101"
         response = @service.delete_history(date)
-        assert_equal 200, response['code']
+        assert_equal 1015, response['code']
       end
     end
   end

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

@@ -13,8 +13,7 @@ module RongCloud
           error = assert_raises RongCloud::UnsupportedMessageChannelName do
             RongCloud::Services::Message::MessageChannel.new(:nothing)
           end
-          expected_error = "support only channels: [\"private\", \"private_template\", \"system\", \"system_template\", \"group\", \"discussion\", \"chatroom\", \"broadcast\"]"
-          assert_equal expected_error, error.message
+          assert error.message =~ /^support\sonly\schannels:/
         end
 
         def test_target_param_name_for_private

data/test/rong_cloud/services/message_priority_test.rb

@@ -0,0 +1,50 @@
+require 'rong_cloud/service_test_setup'
+
+module RongCloud
+  module Services
+    class MessagePriorityTest < Minitest::Test
+      include RongCloud::ServiceTestSetup
+
+      def test_chatroom_message_priority_flow
+        response = @service.add_chatroom_message_priority("RC:CmdMsg")
+        assert_equal 200, response["code"]
+
+        response = @service.add_chatroom_message_priority(["RC:DizNtf", "RC:CmdNtf"])
+        assert_equal 200, response["code"]
+
+        response = @service.chatroom_message_priorities
+        assert_equal ["RC:CmdMsg", "RC:DizNtf", "RC:CmdNtf"].sort, response["objectNames"].sort
+
+        response = @service.remove_chatroom_message_priority(["RC:DizNtf", "RC:CmdNtf"])
+        assert_equal 200, response["code"]
+
+        response = @service.remove_chatroom_message_priority("RC:CmdMsg")
+        assert_equal 200, response["code"]
+
+        response = @service.chatroom_message_priorities
+        assert_empty response["objectNames"]
+      end
+
+      def test_chatroom_message_whitelist_flow
+        response = @service.add_chatroom_message_whitelist("RC:TxtMsg")
+        assert_equal 200, response["code"]
+
+        response = @service.add_chatroom_message_whitelist(["RC:ImgMsg", "RC:LBSMsg"])
+        assert_equal 200, response["code"]
+
+        response = @service.chatroom_message_whitelist
+        whitelist = response["whitlistMsgType"].sort.select{ |i| !i.empty? }
+        assert_equal ["RC:TxtMsg", "RC:ImgMsg", "RC:LBSMsg"].sort, whitelist
+
+        response = @service.remove_chatroom_message_whitelist(["RC:ImgMsg", "RC:LBSMsg"])
+        assert_equal 200, response["code"]
+
+        response = @service.remove_chatroom_message_whitelist("RC:TxtMsg")
+        assert_equal 200, response["code"]
+
+        response = @service.chatroom_message_whitelist
+        assert_equal [""], response["whitlistMsgType"]
+      end
+    end
+  end
+end

data/test/rong_cloud/services/message_recall_test.rb

@@ -0,0 +1,27 @@
+require 'rong_cloud/service_test_setup'
+
+module RongCloud
+  module Services
+    class MessageRecallTest < Minitest::Test
+      include RongCloud::ServiceTestSetup
+
+      # conversationType = 1
+      def test_message_recall_for_private_session
+        response = @service.message_recall(1, 1, 2, "MESSAGE_UUID", (Time.now.to_f * 1000).to_i)
+        assert_equal 200, response["code"]
+      end
+
+      # conversationType = 2
+      def test_message_recall_for_discussion_session
+        response = @service.message_recall(1, 2, 2, "MESSAGE_UUID", (Time.now.to_f * 1000).to_i)
+        assert_equal 200, response["code"]
+      end
+
+      # conversationType = 3
+      def test_message_recall_for_group_session
+        response = @service.message_recall(1, 3, 2, "MESSAGE_UUID", (Time.now.to_f * 1000).to_i)
+        assert_equal 200, response["code"]
+      end
+  	end
+  end
+end

data/test/rong_cloud/services/message_test.rb

@@ -118,6 +118,24 @@ module RongCloud
         assert_equal 200, response["code"]
       end
 
+      def test_send_chatroom_message_with_single_to_chatroom_id
+        response = @service.send_chatroom_message(1, 2, "RC:TxtMsg", { content: "hello world", extra: "nothing" })
+        assert_equal 200, response["code"]
+      end
+
+      def test_send_chatroom_message_with_multiple_to_chatroom_ids
+        response = @service.send_chatroom_message(1, [2, 3, 4], "RC:TxtMsg", { content: "hello world", extra: "nothing" })
+        assert_equal 200, response["code"]
+      end
+
+      def test_send_chatroom_broadcast_message
+        error = assert_raises RongCloud::RequestError do
+          @service.send_chatroom_broadcast_message(1, "RC:TxtMsg", { content: "hello world", extra: "nothing" })
+        end
+        # 未开通该服务，请到开发者管理后台开通或提交工单申请。
+        assert_equal 1009, error.business_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"]

data/test/rong_cloud/services/sensitive_word_test.rb

@@ -0,0 +1,44 @@
+require 'rong_cloud/service_test_setup'
+
+module RongCloud
+  module Services
+    class SensitiveWordTest < Minitest::Test
+      include RongCloud::ServiceTestSetup
+
+      def test_add_sensitive_word_with_single_word
+        response = @service.add_sensitive_word("敏感词")
+        assert_equal 200, response["code"]
+      end
+
+      def test_add_sensitive_word_with_single_word_and_replace_word
+        response = @service.add_sensitive_word("敏感词", "***")
+        assert_equal 200, response["code"]
+      end
+
+      def test_delete_exist_sensitive_word
+        @service.add_sensitive_word("hello")
+        response = @service.delete_sensitive_word("hello")
+        assert_equal 200, response["code"]
+      end
+
+      def test_delete_unexist_sensitive_word
+        response = @service.delete_sensitive_word("unexistedWord")
+        assert_equal 200, response["code"]
+      end
+
+      def test_batch_delete_sensitive_word
+        response = @service.batch_delete_sensitive_word(["hello", "敏感词"])
+        assert_equal 200, response["code"]
+      end
+
+      def test_sensitive_word_list
+        @service.add_sensitive_word("乱")
+        response = @service.sensitive_word_list
+        words = response["words"].map{|word| word["word"]}
+        assert_includes words, "乱"
+
+        @service.delete_sensitive_word("乱")
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -20,5 +20,6 @@ def rong_cloud_configure_with_settings
     config.app_key = ENV["RONGCLOUD_APP_KEY"]
     config.app_secret = ENV["RONGCLOUD_APP_SECRET"]
     config.host = ENV["RONGCLOUD_API_HOST"] || "https://api.cn.ronghub.com"
+    config.timeout = 10
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rong_cloud_server
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Martin Hong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-19 00:00:00.000000000 Z
+date: 2018-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -62,7 +62,6 @@ files:
 - ".travis.yml"
 - Gemfile
 - README.md
-- README.zh-CN.md
 - Rakefile
 - lib/core_ext/array.rb
 - lib/rong_cloud.rb
@@ -71,24 +70,30 @@ files:
 - lib/rong_cloud/request.rb
 - lib/rong_cloud/service.rb
 - lib/rong_cloud/services/chatroom.rb
+- lib/rong_cloud/services/conversation_notification.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/message_priority.rb
+- lib/rong_cloud/services/message_recall.rb
+- lib/rong_cloud/services/sensitive_word.rb
 - lib/rong_cloud/services/user.rb
-- lib/rong_cloud/services/wordfilter.rb
 - lib/rong_cloud/signature.rb
 - rong_cloud.gemspec
 - test/rong_cloud/configuration_test.rb
 - test/rong_cloud/request_test.rb
 - test/rong_cloud/service_test_setup.rb
 - test/rong_cloud/services/chatroom_test.rb
+- test/rong_cloud/services/conversation_notification_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_priority_test.rb
+- test/rong_cloud/services/message_recall_test.rb
 - test/rong_cloud/services/message_test.rb
+- test/rong_cloud/services/sensitive_word_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

data/README.zh-CN.md

@@ -1,50 +0,0 @@
-融云 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/services/wordfilter.rb

@@ -1,18 +0,0 @@
-module RongCloud
-  module Services
-    # http://www.rongcloud.cn/docs/server.html#敏感词服务
-    module Wordfilter
-      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/test/rong_cloud/services/wordfilter_test.rb

@@ -1,34 +0,0 @@
-require 'rong_cloud/service_test_setup'
-
-module RongCloud
-  module Services
-    class WordfilterTest < Minitest::Test
-      include RongCloud::ServiceTestSetup
-
-      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