imwukong 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f839e78ed7eb750f06fe3b23a20e9d2b2038b77
+  data.tar.gz: 2cb0f34fa327598e8e5f0da64b1829cf605b7bdf
+SHA512:
+  metadata.gz: fb6fff8bdd2c0c775db24fdfbbcd018c5616ab3fe29c8b87fa6a241edd4cdaaf42cf5ce5078b237001485e5e1541686933c0f9d4b2ed3594b55465b5c48f54f2
+  data.tar.gz: 4c197d257bc8ea4217c268dfdf7600503885c43b61387bf6f4cd7c74fd346de7ae459fbfb44a9fed31e015d9e80cf9aaeadacf81f88eb7100297d860afb5043d

data/.gitignore

@@ -0,0 +1,37 @@
+.idea/
+.DS_Store
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/secrets.yml
+
+## Environment normalisation:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalise the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    imwukong (0.1.4)
+      activesupport (~> 4.2.0)
+      httparty (~> 0.13.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    diff-lcs (1.2.5)
+    httparty (0.13.3)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.2)
+    multi_xml (0.5.5)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  imwukong!
+  rake (~> 10.0)
+  rspec
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 xh
+
+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,116 @@
+# Imwukong
+:sunny:server APIs for [阿里悟空](https://imwukong.com)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'imwukong', github: 'dannyxu2015/imwukong', branch: 'master'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install imwukong
+
+## Usage
+
+### Configuration
+
+```ruby
+ Imwukong.configure do |config|
+   config = {
+     env:     'development',
+     domain:  'your-domain',
+     android: {
+       app_key:    'android_app_key',
+       app_secret: 'android_app_secret'
+     },
+     ios:     {
+       app_key:    'ios_app_key',
+       app_secret: 'ios_app_secret'
+     },
+     web:     {
+       app_key:    'web_app_key',
+       app_secret: 'web_app_secret'
+     },
+     server:  {
+       app_token: 'server_app_token'
+     }
+   }
+ end
+```
+
+### API info
+
+```ruby
+wk = Imwukong::Base.new
+wk.wk_api_list
+=> [:wk_api_info, :wk_api_list, :wk_conversation_add_members, :wk_conversation_clear, :wk_conversation_create, :wk_conversation_disband, :wk_conversation_info, :wk_conversation_members, :wk_conversation_page_group_infos, :wk_conversation_page_infos, :wk_conversation_profiles, :wk_conversation_query, :wk_conversation_quit, :wk_conversation_quit_silent, :wk_conversation_remove_members, :wk_conversation_role_list, :wk_conversation_set_top, :wk_conversation_unlimit_infos, :wk_conversation_update_ext, :wk_conversation_update_exts, :wk_conversation_update_icon, :wk_conversation_update_member_limit, :wk_conversation_update_notification, :wk_conversation_update_owner, :wk_conversation_update_status, :wk_conversation_update_super, :wk_conversation_update_tag, :wk_conversation_update_title, :wk_conversations_infos, :wk_conversations_newest, :wk_conversations_unread, :wk_message_query, :wk_message_recall, :wk_message_remove, :wk_message_send, :wk_message_set_read, :wk_message_unread_members, :wk_message_update_ext, :wk_message_update_member, :wk_push_to_user, :wk_relation_bi_follow_list, :wk_relation_follow, :wk_relation_follow_by_list, :wk_relation_follow_list, :wk_relation_list, :wk_relation_query, :wk_relation_unfollow, :wk_user_profile, :wk_user_profiles, :wk_user_update_profile, :wk_user_update_tag]
+
+wk.wk_api_info(:wk_user_profile)
+=> ["wk_user_profile, GET v1/user/profile/get, [:openId] "] 
+```
+
+### Reserverd extend methods
+
+```ruby
+wk_post(api_group, api_url, api_prefix, params)
+wk_get(api_group, api_url, api_prefix, params)
+# default api_prefix is 'v1/im'
+
+wk.wk_get('user','profile/get','v1',openId:1)
+```
+
+### Sample
+
+```ruby
+# use default config
+wk = Imwukong::Base.new
+
+wk.wk_user_update_profile(avatar: "http://laiwang.wukong.com/tianpeng.png", birthday:651337200000,gender: 1, isActive: true, nick: "u1", nickPinyin: "testpinyin", openid: 1, ver: 1)
+
+wk.wk_user_profile(1)
+
+wk.wk_user_profiles([1,2,3,4])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/dannyxu2015/imwukong.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+# Todo
+
+## API
+
+- [x] user
+- [x] conversation
+- [x] message
+- [x] follow
+- [ ] upload
+- [x] push
+
+## Client
+
+- [x] client signature
+
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec "irb -r Imwukong -I ./lib"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "imwukong"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/imwukong.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'imwukong/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "imwukong"
+  spec.version       = Imwukong::VERSION
+  spec.authors       = ["Danny Xu"]
+  spec.email         = ["dannyxu@gmail.com"]
+
+  spec.summary       = %q{I am Wukong!}
+  spec.description   = %q{ruby server api for imwukong of alibaba}
+  spec.homepage      = "https://github.com/dannyxu2015/imwukong"
+  spec.license       = "MIT"
+
+  # # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "httparty", "~> 0.13.0"
+  spec.add_dependency "activesupport", "~> 4.2.0"
+end

data/lib/imwukong/api-obsolete/conversation.rb

@@ -0,0 +1,101 @@
+module Imwukong
+  module Api
+    module Conversation
+      # refer to: https://imwukong.com/#doc/doc/server/index.htm??聊天会话
+      CONVERSATION          = 'conversation'.freeze
+
+      创建会话
+      def create(params)
+        wk_post(CONVERSATION, 'create', params)
+      end
+
+      # 查询会话概要信息
+      def profiles(open_id, conversation_ids)
+        params = {
+          openId:          open_id,
+          conversationIds: conversation_ids
+        }
+        wk_post(CONVERSATION, 'profiles/get', params)
+      end
+
+      # 查询会话信息(包括会话最近的消息和消息状态)
+      def info(open_id, conversation_id)
+        params = {
+          openId:         open_id,
+          conversationId: conversation_id
+        }
+        wk_post(CONVERSATION, 'get', params)
+      end
+
+      # 批量查询会话信息(包括会话最近的消息和消息状态)
+      def infos(open_id, conversation_ids)
+        params = {
+          openId:          open_id,
+          conversationIds: conversation_ids
+        }
+        # what a weired thing ~
+        wk_post(CONVERSATION+'s', 'get', params)
+      end
+
+      # 无条件查询会话信息，首屏删除也可以取得(包括会话最近的消息和消息状态)
+      def unlimit_infos(open_id, conversation_id)
+        params = {
+          openId:         open_id,
+          conversationId: conversation_id
+        }
+        wk_post(CONVERSATION, 'unlimited/get', params)
+      end
+
+      # 分页查询群聊会话列表
+      # @param open_id, integer, 用户id
+      # @param cursor, integer, 会话时间戳起始时间，第一次取值为0,之后取最后一个会话的createAt值
+      # @oaram count, 每次拉取的会话个数
+      def page_group_infos(open_id, cursor, count)
+        params = {
+          openId: open_id,
+          cursor: cursor,
+          count:  count
+        }
+        wk_get(CONVERSATION, 'groups/get', params)
+      end
+
+      def page_infos(open_id, cursor, count)
+        params = {
+          openId: open_id,
+          cursor: cursor,
+          count:  count
+        }
+        wk_get(CONVERSATION+'s', 'list', params)
+      end
+
+      def add_member(open_id, cid, members, message)
+        params = {
+          openId:         open_id,
+          conversationId: cid,
+          members:        members,
+          message:        message
+        }
+        wk_post(CONVERSATION, 'member/add', params)
+      end
+
+      def remove_member(open_id, cid, members, message)
+        params = {
+          openId:         open_id,
+          conversationId: cid,
+          members:        members,
+          message:        message
+        }
+        wk_post(CONVERSATION, 'member/remove', params)
+      end
+
+      def update_tag(open_id, cid, tag)
+        params = {
+          openId:         open_id,
+          conversationId: cid,
+          tag:            tag
+        }
+        wk_post(CONVERSATION, 'tag/update', params)
+      end
+    end
+  end
+end

data/lib/imwukong/api-obsolete/follow.rb

@@ -0,0 +1,6 @@
+module Imwukong
+  module Api
+    module Follow
+    end
+  end
+end

data/lib/imwukong/api-obsolete/message.rb

@@ -0,0 +1,6 @@
+module Imwukong
+  module Api
+    module Message
+    end
+  end
+end

data/lib/imwukong/api-obsolete/push.rb

@@ -0,0 +1,6 @@
+module Imwukong
+  module Api
+    module Push
+    end
+  end
+end

data/lib/imwukong/api-obsolete/upload.rb

@@ -0,0 +1,6 @@
+module Imwukong
+  module Api
+    module Upload
+    end
+  end
+end

data/lib/imwukong/api-obsolete/user.rb

@@ -0,0 +1,40 @@
+module Imwukong
+  module Api
+    module User
+    	# wukong API documents: https://imwukong.com/#doc/doc/server/index.htm??用户
+
+    	# @param open_id, integer, unique user identifier of wukong
+    	# @return, i.e. {"birthday":651337200000,"nick":"tianpeng","gender":1,"openid":100078,
+    	#                "avatar":"http://laiwang.wukong.com/tianfeng.png"} 
+    	def profile(open_id)
+    		params = {openId: open_id.to_i}
+    		wk_get('user', 'profile/get', params)
+    	end
+
+    	# @param params, hash
+    	# i.e. avatar: "http://laiwang.wukong.com/tianpeng.png", birthday:651337200000,gender: 1, 
+    	#      isActive: true, nick: "u1", nickPinyin: "testpinyin", openid: 1, ver: 1
+    	def update_profile(params)
+    		wk_post('user', 'profile/update', params)
+    	end
+
+    	# @param open_ids, array, open ids array
+    	# @return user profiles in an array
+    	def profiles(open_ids)
+    		fail 'Invalid [profiles get] parameters' unless open_ids.is_a?(Array)
+    		params = {openIds: open_ids}
+    		wk_post('user', 'profiles/get', params)
+    	end
+
+    	def update_tag(open_id, tag, op)
+    		params = {
+    			openId: open_id,
+    			tag: tag,
+    			op: op
+    		}
+    		wk_post('user', 'tag/update', params)
+    	end
+
+    end
+  end
+end

data/lib/imwukong/api-obsolete.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/api/*.rb"].each do |path|
+  require path
+end

data/lib/imwukong/api.rb

@@ -0,0 +1,503 @@
+require 'active_support/core_ext/string'
+module Imwukong
+  class Base
+    STATUS_FOLLOW = 0 # 关注
+    STATUS_FOLLOW_BY = 1 # 被关注
+    STATUS_BI_FOLLOW = 2 # 双向关系
+
+    API_LIST = [
+      # 用户
+      {
+        method_group: 'user',
+        method_name:  'update_profile',
+        http_method:  :post,
+        prefix:       'v1',
+        url:          'profile/update'
+      },
+      {
+        method_group: 'user',
+        method_name:  'profile',
+        http_method:  :get,
+        prefix:       'v1',
+        url:          'profile/get',
+        args:       [:openId]
+      },
+      {
+        method_group: 'user',
+        method_name:  'profiles',
+        http_method:  :post,
+        prefix:       'v1',
+        url:          'profiles/get',
+        args:       [:openIds]
+      },
+      {
+        method_group: 'user',
+        method_name:  'update_tag',
+        http_method:  :post,
+        prefix:       'v1',
+        url:          'tag/update',
+        args:       [:openId, :tag, :op]
+      },
+
+      # 聊天会话
+      {
+        # 创建聊天会话
+        method_group:     'conversation',
+        method_name:      'create',
+        method_pluralize: false,
+        http_method:      :post,
+        url:              'create'
+      },
+      {
+        # 查询聊天会话的概要信息
+        method_group: 'conversation',
+        method_name:  'profiles',
+        http_method:  :post,
+        url:          'profiles/get',
+        args:         [:openId, :conversationIds]
+      },
+      {
+        # 查询会话信息(包括会话最近的消息和消息状态)
+        method_group: 'conversation',
+        method_name:  'info',
+        http_method:  :get,
+        url:          'get',
+        args:         [:openId, :conversationId]
+      },
+      {
+        # 批量查询会话信息(包括会话最近的消息和消息状态)
+        method_group:     'conversation',
+        method_name:      'infos',
+        method_pluralize: true,
+        http_method:      :post,
+        url:              'get',
+        args:             [:openId, :conversationIds]
+      },
+      {
+        # 无条件查询会话信息，首屏删除也可以取得(包括会话最近的消息和消息状态)
+        method_group: 'conversation',
+        method_name:  'unlimit_infos',
+        http_method:  :post,
+        url:          'unlimited/get',
+        args:         [:openId, :conversationId]
+      },
+      {
+        # 分页查询用户的群聊会话列表
+        method_group: 'conversation',
+        method_name:  'page_group_infos',
+        http_method:  :get,
+        url:          'groups/get',
+        args:         [:openId, :cursor, :count]
+      },
+      {
+        # 分页查询用户的会话列表
+        method_group: 'conversation',
+        method_name:  'page_infos',
+        http_method:  :get,
+        url:          'list',
+        args:         [:openId, :cursor, :count]
+      },
+      {
+        # 增加会话成员
+        method_group: 'conversation',
+        method_name:  'add_members',
+        http_method:  :post,
+        url:          'member/add',
+        args:         [:openId, :conversationId, :members, :message]
+      },
+      {
+        # 群主删除会话成员
+        method_group: 'conversation',
+        method_name:  'remove_members',
+        http_method:  :post,
+        url:          'member/remove',
+        args:         [:openId, :conversationId, :members, :message]
+      },
+      {
+        # 修改群聊会话tag,用于通知会话信息发生变化
+        method_group: 'conversation',
+        method_name:  'update_tag',
+        http_method:  :post,
+        url:          'tag/update',
+        args:         [:openId, :conversationId, :tag]
+      },
+      {
+        # 修改群聊会话自定义扩展字段extension
+        method_group: 'conversation',
+        method_name:  'update_ext',
+        http_method:  :post,
+        url:          'extension/update',
+        args:         [:openId, :conversationId, :extension]
+      },
+      {
+        # 修改会话名称
+        method_group: 'conversation',
+        method_name:  'update_title',
+        http_method:  :post,
+        url:          'title/update',
+        args:         [:openId, :conversationId, :extension]
+      },
+      {
+        # 修改会话头像
+        method_group: 'conversation',
+        method_name:  'update_icon',
+        http_method:  :post,
+        url:          'icon/update',
+        args:         [:openId, :conversationId, :newIcon, :message]
+      },
+      {
+        # 修改XPN状态
+        method_group: 'conversation',
+        method_name:  'update_notification',
+        http_method:  :post,
+        url:          'notification/update',
+        # status 0 接收通知, 1 不接收通知
+        args:         [:openId, :conversationId, :status]
+      },
+      {
+        # 解散群聊会话
+        method_group: 'conversation',
+        method_name:  'disband',
+        http_method:  :post,
+        url:          'disband',
+        args:         [:openId, :conversationId]
+      },
+      {
+        # 查询有未读消息的会话
+        method_group:     'conversation',
+        method_pluralize: true,
+        method_name:      'unread',
+        http_method:      :get,
+        url:              'unread',
+        args:             [:openId, :cursor, :count]
+      },
+      {
+        # 查询会话成员列表
+        method_group: 'conversation',
+        method_name:  'members',
+        http_method:  :get,
+        url:          'members/get',
+        args:         [:openId, :conversationId, :offset, :count]
+      },
+      {
+        # 修改会话最大人数
+        method_group: 'conversation',
+        method_name:  'update_member_limit',
+        http_method:  :post,
+        url:          'member/limit/update',
+        args:         [:openId, :conversationId, :memberLimit]
+      },
+      {
+        # 修改会话为大群
+        method_group: 'conversation',
+        method_name:  'update_super',
+        http_method:  :post,
+        url:          'member/super/update',
+        args:         [:openId, :conversationId, :superGroup]
+      },
+      {
+        # 成员主动退出会话
+        method_group: 'conversation',
+        method_name:  'quit',
+        http_method:  :post,
+        url:          'quit',
+        args:         [:openId, :conversationId, :message]
+      },
+      {
+        # 会话成员主动退出会话，只给群主发消息
+        method_group: 'conversation',
+        method_name:  'quit_silent',
+        http_method:  :post,
+        url:          'quit/silent',
+        args:         [:openId, :conversationId, :message]
+      },
+      {
+        # 查询会话成员角色。角色的取值 1是群主，3 普通用户。返回data为空表示不是群成员
+        method_group: 'conversation',
+        method_name:  'role_list',
+        http_method:  :post,
+        url:          'list/role',
+        args:         [:openId, :conversationId, :message]
+      },
+      {
+        # 修改会话群主
+        method_group: 'conversation',
+        method_name:  'update_owner',
+        http_method:  :post,
+        url:          'owner/update',
+        args:         [:openId, :conversationId, :message]
+      },
+      {
+        # 查询最新的会话列表
+        method_group: 'conversation',
+        method_pluralize: true,
+        method_name:  'newest',
+        http_method:  :get,
+        url:          'newest/get',
+        args:         [:openId, :count]
+      },
+      {
+        # 清空会话消息
+        method_group: 'conversation',
+        method_name:  'clear',
+        http_method:  :post,
+        url:          'message/clear',
+        args:         [:openId, :conversationId]
+      },
+      {
+        # 会话置顶
+        method_group: 'conversation',
+        method_name:  'set_top',
+        http_method:  :post,
+        url:          'top/set',
+        args:         [:openId, :conversationId, :toTop]
+      },
+      {
+        # 修改会话状态
+        method_group: 'conversation',
+        method_name:  'update_status',
+        http_method:  :post,
+        url:          'status/update',
+        args:         [:openId, :conversationIds, :status]
+      },
+      {
+        # 修改会话扩展信息的特定属性
+        method_group: 'conversation',
+        method_name:  'update_exts',
+        http_method:  :post,
+        url:          'extension/keys/update',
+        args:         [:openId, :conversationIds, :extension]
+      },
+
+      # 聊天消息
+      {
+        # 向会话中发送消息,目前支持文字消息、图片消息、语音消息、语音图片消息、 文件消息、自定义消息。
+        # 文本消息是直接发送
+        # 图片、语音、文件等多媒体类型消息则是先上传文件然后再发送message
+        method_group: 'message',
+        method_name:  'send',
+        http_method:  :post,
+        url:          'send',
+        # content封装不同的消息内容,具体json格式参阅 https://imwukong.com/#doc/doc/server/index.htm??聊天消息
+        args:         [:senderId, :conversationId, :receivers, :msgType, :content,
+                       :extension, :tag, :XpnParam, :priority]
+      },
+      {
+        # 查询单条消息
+        method_group: 'message',
+        method_name:  'query',
+        http_method:  :get,
+        url:          'query',
+        args:         [:openId, :messageId]
+      },
+      {
+        # 其实应该属于'聊天会话'分组, 悟空文档这样放, 就这样放吧 ~
+        # 查询会话的消息
+        method_group: 'conversation',
+        method_name:  'query',
+        http_method:  :get,
+        url:          'messages/query',
+        args:         [:openId, :conversationId, :cursor, :forward, :count]
+      },
+      {
+        # 设置消息为已读状态
+        method_group: 'message',
+        method_name:  'set_read',
+        http_method:  :post,
+        url:          'set/read',
+        args:         [:openId, :messageIds]
+      },
+      {
+        # 消息撤回
+        method_group: 'message',
+        method_name:  'recall',
+        http_method:  :post,
+        url:          'recall',
+        args:         [:openId, :messageId]
+      },
+      # 暂未开通
+      # {
+      #   # 短信邮件发送消息
+      #   # 会话好友没有安装应用时，可以通过短信邮件发送聊天消息
+      #   method_group: 'message',
+      #   method_name:  'sms',
+      #   http_method:  :post,
+      #   url:          'sms/notice',
+      #   args:         [:openId, :openIds, :contacts, :conversationId, :type]
+      # },
+      {
+        # 获取一条消息未读人的列表
+        method_group: 'message',
+        method_name:  'unread_members',
+        http_method:  :get,
+        url:          'member/unread',
+        args:         [:openId, :messageId]
+      },
+      {
+        # 删除消息
+        method_group: 'message',
+        method_name:  'remove',
+        http_method:  :post,
+        url:          'remove',
+        args:         [:openId, :messageIds]
+      },
+      {
+        # 修改用户消息的私有tag和扩展信息
+        method_group: 'message',
+        method_name:  'update_member',
+        http_method:  :post,
+        url:          'member/update',
+        args:         [:openId, :messageId, :receiverIds, :tag, :extension]
+      },
+      {
+        # 修改消息的扩展信息
+        method_group: 'message',
+        method_name:  'update_ext',
+        http_method:  :post,
+        url:          'ext/update',
+        args:         [:openId, :messageId, :extension]
+      },
+
+      # 关注
+      {
+        # 加关注
+        method_group: 'relation',
+        method_name:  'follow',
+        http_method:  :post,
+        url:          'status/follow',
+        args:         [:myOpenId, :tag, :openId]
+      },
+      {
+        # 取消关注
+        method_group: 'relation',
+        method_name:  'unfollow',
+        http_method:  :post,
+        url:          'status/unfollow',
+        args:         [:myOpenId, :tag, :openId]
+      },
+      {
+        # 分页获取自己的关注列表
+        method_group: 'relation',
+        method_name:  'follow_list',
+        http_method:  :get,
+        url:          'following/query',
+        # cursor, 第一次查询是0 ，后续查询取返回的nextCursor, nextCursor为-1表示无更多数据
+        args:         [:openId, :tag, :cursor,:count]
+      },
+      {
+        # 分页获取双向关注列表
+        method_group: 'relation',
+        method_name:  'bi_follow_list',
+        http_method:  :get,
+        url:          'binfollow/query',
+        args:         [:openId, :tag, :cursor,:count]
+      },
+      {
+        # 分页获取关注自己的人的列表
+        method_group: 'relation',
+        method_name:  'follow_by_list',
+        http_method:  :get,
+        url:          'followers/query',
+        args:         [:openId, :tag, :cursor,:count]
+      },
+      {
+        # 获取自己与其他用户的关系
+        method_group: 'relation',
+        method_name:  'query',
+        http_method:  :get,
+        url:          'status/query',
+        args:         [:myOpenId, :tag, :peerOpenId]
+      },
+      {
+        # 分页获取关注和被关注列表
+        method_group: 'relation',
+        method_name:  'list',
+        http_method:  :get,
+        url:          'all/query',
+        args:         [:openId, :tag, :cursor,:count]
+      },
+
+
+      # 推送
+      {
+        # 修改会话扩展信息的特定属性
+        method_group: 'push',
+        prefix: 'v1',
+        method_name:  'to_user',
+        http_method:  :post,
+        url:          'message/user',
+        # NotifyDataModel, 用户不在线的情况下，通过IOS APN、华为、小米通道下发的消息内容, 长度不超过256字节
+        # {
+        #   alertContent 可选，推送到APN的内容,适用于华为、小米、IOS设备。 string
+        #   badge 可选，app角标的增量数字，适用于IOS。 integer
+        #   params 可选, 自定义传输参数， key-value列表,key和value都为字符串类型，适用于IOS json map对象
+        #   sound 可选，推送消息提醒声音，应用中的音频资源名，支持aiff、wav、caf格式，适用于IOS。 string
+        #   timeToLive 可选，APN保持持续时间，单位秒，适用于IOS，建议不要设置，使用默认的值。 integer
+        # }
+        # PushDataModel, 通过悟空PUSH长连接发下去的消息
+        # {
+        #   content 消息内容。不能为空 string
+        #   toWeb 可选，是否只推送到web。默认是false,推送到所有终端，包括web。 boolean
+        #   type 用户定义的消息类型。 integer
+        #   persist 是否持久化存储,默认为持久化存储。 boolean
+        # }
+        args:         [:receiverId, :NotifyModel, :PushModel]
+      }
+        # 多个用户消息推送, 暂未开放
+    ]
+
+    instance_eval do
+      API_LIST.each do |api|
+        method_group = api[:method_pluralize] ? api[:method_group].pluralize : api[:method_group]
+        method_name  = "wk_#{method_group}_#{api[:method_name]}"
+        fail "Method #{method_name} already defined" if respond_to?(method_name)
+        define_method method_name do |params|
+          check_params(params, api[:args]||[])
+          self.send "wk_#{api[:http_method]}", method_group, api[:url], api[:prefix]||'v1/im', params
+        end
+      end
+    end
+
+    WK_API_FORMAT = /^wk_[a-zA-Z0-9]+_[a-zA-Z0-9]+/.freeze
+    # output all APIs, format: wk_group_action
+    def wk_api_list
+      methods.grep(WK_API_FORMAT).sort
+    end
+
+    # api detail info, include request url & arguments
+    # @param api_method, string, default output information of all api
+    # @return an array of match api info string, format: api_name, REQUEST url, arguments symbol array
+    def wk_api_info(api_method='')
+      api_method ||= ''
+      fail 'Invalid wukong api' unless api_method == '' || api_method =~ WK_API_FORMAT
+      if api_method.size > 0
+        m            = api_method.to_s.match(/^wk_([a-zA-Z0-9]+)_(.+)/)
+        method_group = m[1].singularize
+        method_name  = m[2]
+      end
+      apis = api_method.size > 0 ? API_LIST.select { |a| a[:method_group]==method_group && method_name==a[:method_name] } : API_LIST
+      fail 'api not found' unless apis.present?
+      apis.map do |api|
+        method_group = api[:method_pluralize] ? api[:method_group].pluralize : api[:method_group]
+        method_name  = "wk_#{method_group}_#{api[:method_name]}"
+        "#{method_name}, #{api_url(api)}, #{api[:args].inspect} "
+      end
+    end
+
+    private
+
+    def api_url(api)
+      http_method = api[:http_method].to_s.upcase
+      prefix      = api[:prefix] ? api[:prefix] : 'v1/im'
+      group       = api[:method_pluralize] ? api[:method_group].pluralize : api[:method_group]
+      url         = "#{prefix}/#{group}/#{api[:url]}"
+      "#{http_method} #{url}"
+    end
+
+    def check_params(params, check_list=[])
+      check_list.each do |key|
+        fail "argument required: #{key}" unless params.has_key?(key) || params.has_key?(key.to_sym)
+      end
+    end
+  end
+end

data/lib/imwukong/base.rb

@@ -0,0 +1,90 @@
+require 'httparty'
+require 'digest'
+
+module Imwukong
+  class Base
+    include HTTParty
+    # include Api::User
+    # include Api::Conversation
+    # include Api::Message
+    # include Api::Follow
+    # include Api::Upload
+    # include Api::Push
+
+    DEFAULT_OPTIONS = { api_version: 'v1' }
+    DEV_HOST        = 'https://sandbox-wkapi.laiwang.com'.freeze
+    PRODUCTION_HOST = "https://wkapi.laiwang.com"
+
+    def initialize(app_domain = Imwukong.config[:domain],
+                   app_token = Imwukong.config[:server][:app_token])
+      fail 'app domain/token is invalid' unless app_domain.present? && app_token.present?
+      @app_domain = app_domain.strip
+      @app_token  = app_token.strip
+      @options    = DEFAULT_OPTIONS
+    end
+
+    def wk_post(type, method, prefix='v1/im', params)
+      options = {
+        body:    params.to_json,
+        headers: wukong_header
+      }
+      prefix  ||= 'v1/im'
+      result = self.class.send(:post, get_request_url(type, method, prefix), options) rescue nil
+      handle_response(result)
+    end
+
+    def wk_get(type, method, prefix='v1/im', params)
+      options = {
+        query:   params,
+        headers: wukong_header
+      }
+      prefix  ||= 'v1/im'
+      result = self.class.send(:get, get_request_url(type, method, prefix), options) rescue nil
+      handle_response(result)
+    end
+
+    # def safe_json_parse(data)
+    #   warn data.inspect
+    #   JSON.parse(data)
+    #     # rescue TypeError which will cause 'no implicit conversion of HTTParty::Response into String'
+    # rescue JSON::ParserError, TypeError
+    #   {}
+    # end
+
+    private
+
+    def handle_response(result)
+      fail 'No respond from server' if result.nil?
+      warn ">>> Code: #{result.code}, " + result.inspect
+      r = result.parsed_response
+      fail result.inspect unless result.code == 200
+      fail "#{r['errorCode']}, #{r['errorMessage']}" if r['success'] == false
+      r['data']
+    end
+
+    def wukong_host
+      Imwukong.config[:env] == 'production' ? PRODUCTION_HOST : DEV_HOST
+    end
+
+    def get_request_url(type, method, prefix='v1/im')
+      warn "#{wukong_host}/#{prefix}/#{type}/#{method}"
+      "#{wukong_host}/#{prefix}/#{type}/#{method}"
+    end
+
+    def wukong_sign(token = @app_token)
+      @timestamp = Time.now.to_i.to_s
+      @nonce     = rand(100000..200000).to_s
+      array      = [token, @timestamp, @nonce].sort
+      sign       = Digest::SHA1.hexdigest(array.join)
+      warn "Sign: #{sign}"
+      sign
+    end
+
+    def wukong_header
+      {
+        'Authorization' => %Q(Wukong signature_method="sha1", domain="#{@app_domain}", signature="#{wukong_sign}", timestamp="#{@timestamp}", nonce="#{@nonce}", version="1.0"),
+        'Content-Type'  => 'application/json'
+      }
+    end
+  end
+end

data/lib/imwukong/client.rb

@@ -0,0 +1,35 @@
+require 'digest/sha2'
+module Imwukong
+  # implement 阿里悟空支持的免导入登录方式
+  # 根据客户端类型(ios, android, web)返回 signature、domain、appkey、timestamp 等数据给客户端
+  # 客户端调用阿里悟空的SDK接口完成登录鉴权
+  # 目前采用openid就是用户应用的userid, 其唯一性由用户应用系统保障
+  class Client
+    def signature(open_id, dev_type)
+      fail %Q(unknown device type "#{dev_type}") unless %w(ios android).include?(dev_type)
+      begin
+        app_token  = Imwukong.config[:server][:app_token]
+        app_key    = Imwukong.config[dev_type.to_sym][:app_key]
+        app_secret = Imwukong.config[dev_type.to_sym][:app_secret]
+      rescue
+        raise 'Please check you configuration of imwukong'
+      end
+      nonce     = rand(100000..200000)
+      timestamp = Time.now.to_i
+      {
+        signature: gen_signature(open_id, app_token, app_secret, nonce, timestamp),
+        domain:    Imwukong.config[:domain],
+        open_id:   open_id,
+        app_key:   app_key,
+        nonce:     nonce,
+        timestamp: timestamp
+      }
+    end
+
+    private
+
+    def gen_signature(open_id, app_token, app_secret, nonce, timestamp)
+      Digest::SHA256.hexdigest([app_token, app_secret, open_id.to_s, nonce.to_s, timestamp.to_s].sort.join(''))
+    end
+  end
+end

data/lib/imwukong/config.rb

@@ -0,0 +1,30 @@
+module Imwukong
+
+  @config = {
+    env:     'development',
+    domain:  'test-sjll',
+    android: {
+      app_key:    'c3a2bdb574663c955f5bceeb95ad4eec',
+      app_secret: 'Snnmp8aepflORdsWdTjuNLXHPv4FpJki'
+    },
+    ios:     {
+      app_key:    '1f49803aa33122c8ed11df493f8d843f',
+      app_secret: 'Sn0NwAYBIeUT8DPoR9IP9hhqTD1SBf0o'
+    },
+    web:     {
+      app_key:    'c26cf651de1ef9f583677e73271c7396',
+      app_secret: 'S0Iq3cBlJd91v0VvwiqziYmQx5hcsdIV'
+    },
+    server:  {
+      app_token: 'SpBzEmucvdmCYbzHJJ0js7MhVIlJsm00'
+    }
+  }
+
+  class << self
+    attr_accessor :config
+
+    def configure
+      yield @config if block_given?
+    end
+  end
+end

data/lib/imwukong/version.rb

@@ -0,0 +1,3 @@
+module Imwukong
+  VERSION = "0.1.4"
+end

data/lib/imwukong.rb

@@ -0,0 +1,7 @@
+require 'imwukong/version'
+require 'imwukong/config'
+require 'imwukong/base'
+require 'imwukong/api'
+require 'imwukong/client'
+module Imwukong
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: imwukong
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Danny Xu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: ruby server api for imwukong of alibaba
+email:
+- dannyxu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- imwukong.gemspec
+- lib/imwukong.rb
+- lib/imwukong/api-obsolete.rb
+- lib/imwukong/api-obsolete/conversation.rb
+- lib/imwukong/api-obsolete/follow.rb
+- lib/imwukong/api-obsolete/message.rb
+- lib/imwukong/api-obsolete/push.rb
+- lib/imwukong/api-obsolete/upload.rb
+- lib/imwukong/api-obsolete/user.rb
+- lib/imwukong/api.rb
+- lib/imwukong/base.rb
+- lib/imwukong/client.rb
+- lib/imwukong/config.rb
+- lib/imwukong/version.rb
+homepage: https://github.com/dannyxu2015/imwukong
+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.8
+signing_key: 
+specification_version: 4
+summary: I am Wukong!
+test_files: []