netease_im 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58207eff418789dea17cf18e585ba834a1354348
+  data.tar.gz: 2d0891776917fadd1e956157a30018c5902b7d52
+SHA512:
+  metadata.gz: 17473ad4a31ae3d38621949d6d96c1ca0246f5dea37edfd3f86469d960b5dd0a72ff205c0c55b4416c2f7812e315e0565f9e8365b0986d092d50049a62ab2698
+  data.tar.gz: 6ec0be8b06132f814c41be6ce691dc0c7e151f9e53e73effa12e881a3941b36afd130e89a6fd9668bb8be0c39f0f7bb73dc46a9adba16b81be5a9c162332b313

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at liuliang0817@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://gems.ruby-china.org'
+
+# Specify your gem's dependencies in netease_im.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 liuliang
+
+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,95 @@
+# NeteaseIm
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/netease_im`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+NeteaseIM Server SDK in Ruby.
+
+## API文档
+- 官方文档(http://dev.netease.im/docs?doc=server)
+
+## API接口
+
+### User
+- create  创建云信ID
+- update  云信ID更新
+- refresh_token  更新并获取新token
+- block  封禁云信ID
+- unblock  解禁云信ID
+- update_uinfo  更新用户名片
+- get_uinfos  获取用户名片
+- set_donnop  设置桌面端在线时，移动端是否需要推送
+
+### ChatRoom
+- create  创建聊天室
+- get  查询聊天室信息
+- update  更新聊天室信息
+- toggle_close_stat  修改聊天室开/关闭状态
+- set_member_role  设置聊天室内用户角色
+- request_addr  请求聊天室地址
+- send_msg  发送聊天室消息
+- add_robot  往聊天室内添加机器人
+- remove_robot  从聊天室内删除机器人
+- temporary_mute  设置临时禁言状态
+- queue_offer  往聊天室有序队列中新加或更新元素 
+- queue_poll  从队列中取出元素 
+- queue_list  排序列出队列中所有元素 
+- queue_drop  删除清理整个队列 
+- queue_init  初始化队列 
+- mute_room  将聊天室整体禁言 
+- topn  查询聊天室统计指标TopN 
+- members_by_page  分页获取成员列表
+- query_members  批量获取在线成员信息
+
+### Msg
+- send_msg  发送普通消息
+- send_batch_msg  批量发送点对点普通消息
+- send_attach_msg  发送自定义系统通知
+
+### 例子
+```ruby
+
+NeteaseIM.app_key = "abc"
+NeteaseIM.app_secret = "456"
+NeteaseIM.gateway = "https://api.netease.im"
+
+NeteaseIM::User.create(accid: 'test', name: 'test')
+NeteaseIM::ChatRoom.create(name: 'test')
+NeteaseIM::Msg.send_msg(from: 'test', ope: 0, to: 't2', type: 0, body: {msg: 'hello'})
+
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'netease_im'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install netease_im
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/liuliang/netease_im. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+task :default => :spec
+task :console do
+  exec "irb -r netease_im -I ./lib"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "netease_im"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/netease_im/chat_room.rb

@@ -0,0 +1,101 @@
+# encoding: utf-8
+module NeteaseIM
+  class ChatRoom
+    
+    def self.create(params)
+      Utils.check_required_params(params, %w(creator name))
+      Request.send_sync('chatroom/create.action', params)
+    end
+    
+    def self.get(params)
+      Utils.check_required_params(params, %w(roomid))
+      Request.send_sync('chatroom/get.action', params)
+    end
+    
+    def update(params)
+      Utils.check_required_params(params, %w(roomid))
+      Request.send_sync('chatroom/update.action', params)
+    end
+    
+    def toggle_close_stat(params)
+      Utils.check_required_params(params, %w(roomid operator valid))
+      Request.send_sync('chatroom/toggleCloseStat.action', params)
+    end
+    
+    def set_member_role(params)
+      Utils.check_required_params(params, %w(roomid operator target opt optvalue))
+      Request.send_sync('chatroom/setMemberRole.action', params)
+    end
+    
+    def request_addr(params)
+      Utils.check_required_params(params, %w(roomid accid))
+      Request.send_sync('chatroom/requestAddr.action', params)
+    end
+    
+    def send_msg(params)
+      Utils.check_required_params(params, %w(roomid msgId fromAccid msgType))
+      Request.send_sync('chatroom/sendMsg.action', params)
+    end
+    
+    def add_robot(params)
+      Utils.check_required_params(params, %w(roomid accids))
+      Request.send_sync('chatroom/addRobot.action', params)
+    end
+    
+    def remove_robot(params)
+      Utils.check_required_params(params, %w(roomid accids))
+      Request.send_sync('chatroom/removeRobot.action', params)
+    end
+    
+    def temporary_mute(params)
+      Utils.check_required_params(params, %w(roomid operator target muteDuration))
+      Request.send_sync('chatroom/temporaryMute.action', params)
+    end
+    
+    def queue_offer(params)
+      Utils.check_required_params(params, %w(roomid key value))
+      Request.send_sync('chatroom/queueOffer.action', params)
+    end
+    
+    def queue_poll(params)
+      Utils.check_required_params(params, %w(roomid))
+      Request.send_sync('chatroom/queueOffer.action', params)
+    end
+    
+    def queue_list(params)
+      Utils.check_required_params(params, %w(roomid))
+      Request.send_sync('chatroom/queueList.action', params)
+    end
+    
+    def queue_drop(params)
+      Utils.check_required_params(params, %w(roomid))
+      Request.send_sync('chatroom/queueDrop.action', params)
+    end
+    
+    def queue_init(params)
+      Utils.check_required_params(params, %w(roomid sizeLimit))
+      Request.send_sync('chatroom/queueInit.action', params)
+    end
+    
+    def mute_room(params)
+      Utils.check_required_params(params, %w(roomid operator mute))
+      Request.send_sync('chatroom/muteRoom.action', params)
+    end
+    
+    def topn(params)
+      Utils.check_required_params(params, %w(topn))
+      Request.send_sync('chatroom/topn.action', params)
+    end
+    
+    def members_by_page(params)
+      Utils.check_required_params(params, %w(roomid type endtime limit))
+      Request.send_sync('chatroom/membersByPage.action', params)
+    end
+    
+    def query_members(params)
+      Utils.check_required_params(params, %w(roomid accids))
+      Request.send_sync('chatroom/queryMembers.action', params)
+    end
+    
+  end
+end

data/lib/netease_im/msg.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module NeteaseIM
+  class Msg
+    
+    def self.send_msg(params)
+      Utils.check_required_params(params, %w(from ope to type body))
+      Request.send_sync('msg/sendMsg.action', params)
+    end
+    
+    def self.send_batch_msg(params)
+      Utils.check_required_params(params, %w(fromAccid toAccids type body))
+      Request.send_sync('msg/sendBatchMsg.action', params)
+    end
+    
+    def self.send_attach_msg(params)
+      Utils.check_required_params(params, %w(from msgtype to attach))
+      Request.send_sync('msg/sendAttachMsg.action', params)
+    end
+    
+  end
+end

data/lib/netease_im/request.rb

@@ -0,0 +1,16 @@
+module NeteaseIM
+  class Request
+
+    def self.send_sync(action, params)
+      headers = {
+        AppKey: NeteaseIM.app_key,
+        Nonce: SecureRandom.hex,
+        CurTime: Time.now.to_i,
+        content_type: 'Content-Type: application/x-www-form-urlencoded'
+      }
+      headers[:CheckSum] = Digest::SHA1.hexdigest "#{NeteaseIM.app_secret}#{headers[:Nonce]}#{headers[:CurTime]}"
+      JSON.parse RestClient.post("#{NeteaseIM.gateway}/nimserver/#{action}", params, headers)
+    end
+
+  end
+end

data/lib/netease_im/user.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+module NeteaseIM
+  class User
+    
+    def self.create(params)
+      Utils.check_required_params(params, %w(accid))
+      Request.send_sync('user/create.action', params)
+    end
+    
+    def self.update(params)
+      Utils.check_required_params(params, %w(accid))
+      Request.send_sync('user/update.action', params)
+    end
+    
+    def refresh_token(params)
+      Utils.check_required_params(params, %w(accid))
+      Request.send_sync('user/refreshToken.action', params)
+    end
+    
+    def block(params)
+      Utils.check_required_params(params, %w(accid))
+      Request.send_sync('user/block.action', params)
+    end
+    
+    def unblock(params)
+      Utils.check_required_params(params, %w(accid))
+      Request.send_sync('user/unblock.action', params)
+    end
+    
+    def update_uinfo(params)
+      Utils.check_required_params(params, %w(accid))
+      Request.send_sync('user/updateUinfo.action', params)
+    end
+    
+    def get_uinfos(params)
+      Utils.check_required_params(params, %w(accids))
+      Request.send_sync('user/getUinfos.action', params)
+    end
+    
+    def set_donnop(params)
+      Utils.check_required_params(params, %w(accid))
+      Request.send_sync('user/setDonnop.action', params)
+    end
+    
+  end
+end

data/lib/netease_im/utils.rb

@@ -0,0 +1,8 @@
+module NeteaseIM
+  module Utils
+    def self.check_required_params(params, names)
+      missing_params = names.map(&:to_s) - params.keys.map(&:to_s)
+      warn("Warn: missing required option: #{missing_params.join(',')}") if missing_params.size > 0
+    end
+  end
+end

data/lib/netease_im/version.rb

@@ -0,0 +1,3 @@
+module NeteaseIM
+  VERSION = "0.1.0"
+end

data/lib/netease_im.rb

@@ -0,0 +1,15 @@
+require 'rest-client'
+require 'digest/sha1'
+require 'securerandom'
+require "netease_im/version"
+require 'netease_im/utils'
+require 'netease_im/request'
+require 'netease_im/user'
+require 'netease_im/chat_room'
+require 'netease_im/msg'
+
+module NeteaseIM
+  class << self
+    attr_accessor :app_key, :app_secret, :gateway
+  end
+end

data/netease_im.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'netease_im/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "netease_im"
+  spec.version       = NeteaseIM::VERSION
+  spec.authors       = ["liuliang"]
+  spec.email         = ["liuliang0817@gmail.com"]
+
+  spec.summary       = %q{网易IM服务端接口.}
+  spec.description   = %q{网易IM服务端接口.}
+  spec.homepage      = "https://github.com/liuliang/netease_im"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "rest-client", "~> 1.8"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: netease_im
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- liuliang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: 网易IM服务端接口.
+email:
+- liuliang0817@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/netease_im.rb
+- lib/netease_im/chat_room.rb
+- lib/netease_im/msg.rb
+- lib/netease_im/request.rb
+- lib/netease_im/user.rb
+- lib/netease_im/utils.rb
+- lib/netease_im/version.rb
+- netease_im.gemspec
+homepage: https://github.com/liuliang/netease_im
+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.5.1
+signing_key: 
+specification_version: 4
+summary: 网易IM服务端接口.
+test_files: []