rcloud 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56ce826f07b16ead28300941d10ec2301512d35e
+  data.tar.gz: da31518d2bb7110800e8682731e266dcd19fb5e4
+SHA512:
+  metadata.gz: 2d9e01f3e6dd5f6d18859f50345ec371a1443e0a2d25b976a6026f93949ebd561158b23d1ba0a21d5bb0a52c1b2e2d70e253e306f9dff5823084c3803e8b6a89
+  data.tar.gz: fa307cddcf4b92b0408c6390b4181cf64cff32f9679c937c7d1a778b564f6fd77e2b26db87eb53f5c5dcbe661e6d0759a85264f36669352180bf771c199a5fb2

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rcloud.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Linxiangyu
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# RCloud 
+
+融云 Ruby SDK
+
+<http://docs.rongcloud.cn/>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rcloud'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rcloud
+
+## 使用
+
+
+### 基本使用
+
+使用 `RCloud::Request` 类生成一个请求实例，调用它的方法进行请求。
+
+方法列表见下一个小节。
+
+```ruby
+request = RCloud::Request.new("mgb7ka1nb5dfg", "krO8vJkvpu1yj")
+p request.user_get_token("jjjj","","")
+```
+如果正常请求，会返回一个Hash对象，如
+
+```ruby
+{"code"=>200, "userId"=>"fkdskf", "token"=>"cSM+0tuXKeQ8x1DHvzI8uj1M2VmLzSGbhpswesn2LhvH6WoIIAXxUBoMXfPT/DVHIq0Sl9S2VhNgUSr2U3LF3g=="}
+```
+
+
+### 方法名和 url 映射规则, 以及http参数
+
+<http://docs.rongcloud.cn/server.html>
+
+所有 Server API 的 url 会被映射为 Ruby 的方法，规则：`method_name = url.downcase.gsub(/\//, '_')[1..-1].to_sym`
+
+比如： /user/getToken => user_gettoken
+
+而 HTTP 的参数会按照文档次序映射为方法的参数。
+
+如果融云API文档中允许传入多个参数，那么可以传入一个参数的值或者数组。
+
+**例外**
+
+'/chatroom/create' 和 '/group/sync' 两个 API 有的参数需要不定长度的键值对，所以实现上有一些例外。
+
+`/chatroom/create` 的参数是一个 Hash， key 是 groupId, value 是 groupName
+
+`/group/sync` 的第一个参数是 user， 第二个参数是一个 Hash， key 是 groupId, value 是 groupName
+
+它们对应的方法名称也支持自定义规则。
+
+### 自定义方法名和 url 映射规则
+
+支持自定义url和方法映射规则。Proc接收一个 '/user/getToken' 这样的字符串参数，返回一个方法名字的 symbol对象。
+
+```
+map = Proc.new do |url|
+	url.downcase.gsub(/\//, '')[0..-1].to_sym
+end
+
+request = RCloud::Request.new("mgb7ka1nb5dfg", "krO8vJkvpu1yj", map)
+
+request.usergettoken('fkdskf')
+
+```
+
+### 第三方依赖
+
+SDK 使用 rest-client 进行访问，如果认证错误或者其他问题，会触发  RestClient::Exception
+
+关于 rest-client:  <https://github.com/rest-client/rest-client>
+
+使用 <https://github.com/seattlerb/minitest> 作为测试框架
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rcloud/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## TODO
+
+1. 更好的错误控制和反馈与日志输出
+2. 产品级别的测试
+3. 联系发布到官方页面
+
+## Author
+
+Lin Xiangyu
+<lxyweb@gmail.com>

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end

data/lib/rcloud.rb

@@ -0,0 +1,152 @@
+require "rcloud/version"
+require "rest-client"
+require 'digest/sha1'
+require 'json'
+
+
+module RCloud
+
+	class Request
+		BASE_URL = "https://api.cn.rong.io"
+
+		URLS = ["/user/getToken",
+				"/user/refresh",
+				"/user/checkOnline",	
+				"/user/block",
+				"/user/unblock",
+				"/user/block/query",
+				"/user/blacklist/add",
+				"/user/blacklist/remove",
+				"/user/blacklist/query",
+				"/message/private/publish", 
+				"/message/system/publish",
+				"/message/group/publish",
+				"/message/chatroom/publish",
+				"/message/broadcast",
+				"/message/history",
+				"/message/history/delete",
+				"/group/sync",
+				"/group/create",
+				"/group/join",
+				"/group/quit",
+				"/group/dismiss",
+				"/group/refresh",
+				"/chatroom/create",
+				"/chatroom/destroy",
+				"/chatroom/query",
+				"/chatroom/user/query"]
+
+		SUFFIX = ".json"
+
+		PARAMS = [ [:userId, :name, :portraitUri],  # user
+				   [:userId, :name, :portraitUri],
+				   [:userId], 
+				   [:userId, :minute], # block
+				   [:userId],
+				   [], 
+				   [:userId, :blackUserId], # blacklist
+				   [:userId, :blackUserId],
+				   [:userId],
+				   [:fromUserId, :toUserId, :objectName, :content, :pushContent, :pushData ], #message
+				   [:fromUserId, :toUserId, :objectName, :content, :pushContent, :pushData ], 
+				   [:fromUserId, :toGroupId, :objectName, :content, :pushContent, :pushData ],
+				   [:fromUserId, :toChatroomId, :objectName, :content, :pushContent, :pushData ],
+				   [:fromUserId, :objectName, :content, :pushContent, :pushData ],
+				   [:date], # message history
+				   [:date], 
+				   [:userId], # Group Sync redefine
+				   [:userId, :groupId, :groupName] ,
+				   [:userId, :groupId, :groupName] ,
+				   [:userId, :groupId],
+				   [:userId, :groupId],
+				   [:groupId, :groupName], 
+				   [:userId],# Chatroom redefine
+				   [:chatroomId],# 
+				   [:chatroomId],# 
+				   [:chatroomId]# 
+          ]
+
+
+		@@app_key = ""
+		@@app_sec = ""
+		@@mapping =  Proc.new do |url|
+						url.downcase.gsub(/\//, '_')[1..-1].to_sym
+  					 end
+
+		def self.creat_api_method(method_name, url, params)  
+        	self.send(:define_method, method_name) do  |*args|
+            	p = Hash.new
+				params.each_with_index  do |k, i|
+					p[k] = *args[i]
+					p[k] = p[k][0].to_s
+				end  
+				resp = nil
+				begin
+					resp = RestClient.post BASE_URL + url + SUFFIX , p , http_header
+				rescue => e
+					p e 
+				end
+				result = JSON.parse(resp)
+        	end  
+   		end
+
+
+
+		def initialize(app_key, app_sec, mapping = nil)
+			@@app_key = app_key
+			@@app_sec = app_sec
+			@@mapping = mapping if mapping
+
+			URLS.each_with_index do |url, index| 
+				Request.creat_api_method(@@mapping.call(url), url,  PARAMS[index])
+			end
+
+			self.class.send(:define_method, @@mapping.call("/chatroom/create") ) do  |hash|
+				p = {}
+				hash.each do |k,v| 
+					p["chatroom[#{k}]"] = v 
+				end
+				resp = RestClient.post BASE_URL + "/chatroom/create" + SUFFIX , p , http_header
+				result = JSON.parse(resp)
+			end
+
+			self.class.send(:define_method, @@mapping.call("/group/sync") ) do  |*args|
+				p = {}
+				p["userId"] = args[0].to_s
+				hash = *args[1]
+				hash.each do |k,v| 
+					p["group[#{k}]"] = v 
+				end
+				resp = RestClient.post BASE_URL +  "/group/sync" + SUFFIX , p , http_header
+				result = JSON.parse(resp)
+			end
+
+
+		end
+
+		
+
+		def http_header
+			time = Time.now.to_i
+			r = Random.new
+			random = r.rand(100000000)
+			sig_str = @@app_sec + random.to_s + time.to_s
+			sig = Digest::SHA1.hexdigest sig_str
+			header = {
+				"RC-App-Key" => @@app_key,
+				"RC-Nonce" => random,
+				"RC-Timestamp" => time,
+				"RC-Signature" => sig
+			}
+		end	
+	
+	end
+
+	Agent = Request
+	Client = Request
+
+	
+end
+
+
+

data/lib/rcloud/version.rb

@@ -0,0 +1,3 @@
+module Rcloud
+  VERSION = "0.0.1"
+end

data/rcloud.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rcloud/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rcloud"
+  spec.version       = Rcloud::VERSION
+  spec.authors       = ["Lin Xiangyu"]
+  spec.email         = ["lxyweb@gmail.com"]
+  spec.summary       = %q{RongCloud Ruby SDK}
+  spec.description   = %q{RongCloud Ruby SDK.}
+  spec.homepage      = "https://github.com/oa414/RCloud"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'rest_client', '~> 1.8.3' ,'>= 1.8.0'
+  spec.add_runtime_dependency 'json', '~> 1.8.2', '>= 1.8.0'
+
+  spec.add_development_dependency "minitest", '~> 5.6.0', '>= 5.6.0'
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/test/test_rcloud.rb

@@ -0,0 +1,188 @@
+require "./lib/rcloud.rb"
+
+
+require "minitest/autorun"
+
+class TestMeme < Minitest::Test
+
+
+  USERA = "mockuser"	
+  USERB = "mock_block"
+  GROUPA = "mock_group"
+  CHATROOMA = "1001"
+
+
+  def setup
+    @request = RCloud::Request.new("mgb7ka1nb5dfg", "krO8vJkvpu1yj")
+    @request.user_gettoken(USERB)
+    @user_id = nil
+    @user_token = nil
+  end
+
+  # user
+
+  def test_user_gettoken
+  	# {"code":200, "USERA":"jlk456j5", "token":"sfd9823ihufi"}
+  	resp = @request.user_gettoken(USERA)
+  	@user_id = resp["user_id"]
+  	@user_token = resp["token"]
+    assert_equal 200, resp["code"]
+  end
+
+  def test_user_refresh
+  	# {"code":200, "USERA":"jlk456j5", "token":"sfd9823ihufi"}
+  	resp = @request.user_gettoken(USERA)
+    assert_equal 200, resp["code"]
+  end
+
+  def test_user_checkonline
+  	resp = @request.user_checkonline(USERA)
+  	assert_equal 200, resp["code"]
+  end	
+
+  # block 
+
+  def test_user_block
+  	resp = @request.user_block(USERA, 1)
+  	assert_equal 200, resp["code"]
+  end
+
+  def test_user_unblock
+  	resp = @request.user_unblock(USERA)
+  	assert_equal 200, resp["code"]
+  end
+
+  def test_user_block_query
+  	resp = @request.user_block_query()
+  	assert_equal 200, resp["code"]
+  end
+
+  # blacklist
+  def test_user_blacklist_add
+  	resp = @request.user_blacklist_add(USERA, USERB)
+  	assert_equal 200, resp["code"]
+
+  end
+
+  def test_user_blacklist_remove
+  	resp = @request.user_blacklist_remove(USERA, USERB)
+  	assert_equal 200, resp["code"]
+  end
+
+  def test_user_blacklist_query
+  	resp = @request.user_blacklist_query
+  	assert_equal 200, resp["code"]
+  end
+
+  # Message
+
+  def test_message_private_publish
+  	resp = @request.message_private_publish(USERA, USERB, "RC:TxtMsg", JSON.generate({"content" => "hello", "extra" => "helloExtra"}))
+   	assert_equal 200, resp["code"]
+  end
+
+
+  def test_message_system_publish
+  	resp = @request.message_system_publish(USERA, USERB, "RC:TxtMsg", JSON.generate({"content" => "hello", "extra" => "helloExtra"}))
+   	assert_equal 200, resp["code"]
+  end
+
+  def test_message_group_publish
+    resp = @request.group_create(USERA, "1001", GROUPA)
+    resp = @request.group_join(USERA, GROUPA)
+    resp = @request.message_group_publish(USERA, "1001", "RC:TxtMsg", JSON.generate({"content" => "hello", "extra" => "helloExtra"}))
+    assert_equal 200, resp["code"]
+  end
+
+  def test_message_chatroom_publish
+    resp = @request.chatroom_create({CHATROOMA => GROUPA})
+    resp = @request.message_chatroom_publish(USERA, CHATROOMA, "RC:TxtMsg", JSON.generate({"content" => "hello", "extra" => "helloExtra"}))
+    assert_equal 200, resp["code"]
+  end
+
+  def test_message_broadcast
+    resp = @request.message_broadcast(USERA, "RC:TxtMsg", JSON.generate({"content" => "hello", "extra" => "helloExtra"}))
+    assert_equal 200, resp["code"]
+  end
+  # History
+
+  def test_message_history
+  	resp = @request.message_history(DateTime.now.strftime("%Y%m%d%H"))
+  	assert_equal 200, resp["code"]
+  end	
+
+  def test_message_history_delete
+  	resp = @request.message_history_delete("2015042523")
+  	assert_equal 200, resp["code"]
+  end
+
+  # Group
+
+  def test_group_sync #
+  	resp = @request.group_create(USERA, "1001", GROUPA)
+    assert_equal 200, resp["code"]
+
+    resp = @request.group_sync(USERA, {"1001" => GROUPA})
+    assert_equal 200, resp["code"]
+
+  	resp = @request.group_sync(USERA)
+    assert_equal 200, resp["code"]
+  end
+
+  def test_group_create
+  	resp = @request.group_create([USERA, USERB], GROUPA, GROUPA)
+   	assert_equal 200, resp["code"]
+  end
+
+  def test_group_join
+  	resp = @request.group_join([USERA,USERB], GROUPA)
+  	assert_equal 200, resp["code"]
+  end
+
+  def test_group_quit
+  	resp = @request.group_quit([USERA, USERB], GROUPA)
+    assert_equal 200, resp["code"]
+
+  end
+
+  def test_group_dismiss
+  	resp = @request.group_dismiss(USERA, USERB)
+    assert_equal 200, resp["code"]
+
+  end
+
+  def test_group_refresh #
+  	resp = @request.group_refresh(GROUPA, GROUPA)
+    assert_equal 200, resp["code"]
+
+  end
+
+  # ChatRoom
+
+  def test_chatroom_create
+    resp = @request.chatroom_create({CHATROOMA => GROUPA})
+    assert_equal 200, resp["code"]
+  end
+
+  def test_chatroom_destroy
+    resp = @request.chatroom_create({CHATROOMA => GROUPA})
+    resp = @request.chatroom_create({"123" => GROUPA})    
+    resp = @request.chatroom_destroy([CHATROOMA, "123"])
+    assert_equal 200, resp["code"]
+  end
+
+  def test_chatroom_query
+    resp = @request.chatroom_create({CHATROOMA => GROUPA})
+    resp = @request.chatroom_query(GROUPA)
+    assert_equal 200, resp["code"]
+  end
+
+  def test_chatroom_user_query
+    resp = @request.chatroom_query(CHATROOMA)
+    assert_equal 200, resp["code"]
+  end
+
+
+
+end
+

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: rcloud
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lin Xiangyu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.6.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.6.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: RongCloud Ruby SDK.
+email:
+- lxyweb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rcloud.rb
+- lib/rcloud/version.rb
+- rcloud.gemspec
+- test/test_rcloud.rb
+homepage: https://github.com/oa414/RCloud
+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.4.3
+signing_key: 
+specification_version: 4
+summary: RongCloud Ruby SDK
+test_files:
+- test/test_rcloud.rb