webim 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 018cfb15bf5938d1909314a2797127959e8b7bea
+  data.tar.gz: 85b5d031659a78e7f6be1ea0906c4e25206d2057
+SHA512:
+  metadata.gz: ec27f9a54ffb5f8e0becc4387ba8ffd1b4e46a794091faf86164369dd52ca85013aa4dacc1a1175398c57742175265bd0937327128c2bf37baf67bacb9745f8f
+  data.tar.gz: 4720f02fb183d9dcb864de4ceb3b2ccbb97e62310c7aa07b86b454b689a3ce59b592c0b5a985253d223a8ba0a977b9d4b846bf542b84a4af1fa524da27e8d86a

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# 0.1 (2013-12-12)
+
+* first release
+

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 WebIM
+
+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,38 @@
+# webim
+
+A Ruby webim library for the [nextalk.im](http://nextal.im).
+
+## Getting started
+
+You can connect to NexTalk server by instantiating the `Webim::Client` class:
+
+    require "webim"
+
+    user = {:id => "vid:1", :nick => "user1", :show => "available", :status => 'Online'}
+    client = Webim::Client.new(user, "", {:domain => "localhost", :apikey => "public", :host => "localhost", :port => 8000}) 
+
+Once connected, you can forward requests or route messages to the server:
+
+	# 向消息服务器转发用户上线消息，同时发送用户的好友id列表、群组id列表
+    client.online(['uid2','uid3', 'uid4'], ['g1', 'g2', 'g3'])
+
+    # 向消息服务器转发聊天消息
+    client.message("uid2", "hahaha")
+
+    # 向消息服务器转发用户现场变化
+    client.presence('busy', "Busy")
+
+    # 向消息服务器转发用户状态，例如正在输入...
+    client.status("uid2", "typing", "I am typing")
+
+    # 从消息服务器读取当前群组在线用户
+    client.members('g1')
+
+    # 向消息服务器转发用户下线消息
+    client.offline
+
+## Gem build and install
+
+	gem build webim.gemspec
+
+	gem install webim-0.1.0.gem

data/TODO.md

@@ -0,0 +1 @@
+

data/lib/webim.rb

@@ -0,0 +1,270 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Webim
+
+  APIVSN = "v5"
+
+  VERSION = "0.1"
+
+  ##
+  # A Ruby webim client library for NexTalk.im.
+  #
+  class Client
+
+    ##
+    # Default port.
+
+    DEFAULT_PORT = 8000 
+
+    ##
+    # 用户Hash对象
+    # 
+    # 属性:
+    #   id: 用户id
+    #   nick: 用户昵称
+    #   show: 'available' | 'away' | 'chat' | 'dnd' | 'invisible' | 'unavailable'
+    #   status: 状态信息
+    #
+    attr_reader :user
+
+    ##
+    # 网站域名
+    #
+    attr_reader :domain
+
+    ##
+    # 通信APIKEY
+    #
+    attr_reader :apikey
+
+    ##
+    # 消息服务器地址
+    #
+    attr_reader :host
+
+    ##
+    # 消息服务器端口
+    #
+    attr_reader :port
+
+    ##
+    # 消息服务器通信令牌
+    #
+    attr_reader :ticket
+
+    ##
+    # 创建Client对象
+    #
+    # user: 用户Hash对象
+    # ticket: 通信令牌
+    #
+    # config配置参数:
+    #   domain: 域名
+    #   apikey: 通信APIKEY
+    #   host: 服务器地址
+    #   port: 服务器端口号
+    #   
+    def initialize(user, ticket = "", config = {})
+      @user = user
+      @ticket = ticket
+      @domain = config[:domain] || ""
+      @apikey = config[:apikey] || ""
+      @host = config[:host] || "127.0.0.1"
+      @port = (config[:port] || DEFAULT_PORT).to_i
+    end
+
+    ##
+    #  向消息服务器转发用户上线消息，同时发送用户的好友id列表、群组id列表
+    #
+    #  buddies: 好友id列表
+    #  groups: 群组id列表
+    #
+    def online(buddies, groups)
+      res = http_post('/presences/online', {
+        :version => APIVSN,
+        :buddies => buddies.join(','),
+        :groups => groups.join(','),
+        :domain => @domain,
+        :apikey => @apikey,
+        :name => @user[:id],
+        :nick => @user[:nick],
+        :show => @user[:show],
+        :status => @user[:status]
+      })
+      if res and 200 == res.code.to_i
+        data = JSON.parse(res.body)
+        @ticket = data["ticket"]
+        return data
+      end
+      return {
+        :success => false,
+        :error_code => res ? res.code : -1,
+        :error_msg => res ? res.body : ""
+      }
+    end
+
+    ##
+    #  向消息服务器转发用户下线消息
+    #
+    def offline
+      http_post('/presences/offline', {
+        :version => APIVSN,
+        :ticket => @ticket,
+        :apikey => @apikey,
+        :domain => @domain
+      })
+    end
+
+    ##
+    #  向消息服务器转发用户现场变化
+    #
+    #  show: 'away' | 'chat' | 'dnd' | 'invisible'
+    #  status: 状态信息
+    #  
+    def presence(show, status = "")
+      http_post('/presences/show', {
+        :version => APIVSN,
+        :ticket => @ticket,
+        :apikey => @apikey,
+        :domain => @domain,
+        :nick => @user[:nick],
+        :show => show,
+        :status => status
+      })
+    end
+
+    ##
+    #  向消息服务器转发聊天消息
+    #
+    #  to: 接收者 
+    #  body: 消息体
+    #  type: chat | grpchat
+    #  style: 消息CSS
+    #
+    def message(to, body, type = "chat", style = "")
+      http_post('/messages', {
+        :version => APIVSN,
+        :ticket => @ticket,
+        :apikey => @apikey,
+        :domain => @domain,
+        :nick => @user[:nick],
+        :type => type,
+        :to => to,
+        :body => body,
+        :style => style,
+        :timestamp => Time.now.to_f * 1000
+      })
+    end
+
+    ##
+    #  向消息服务器转发用户状态，例如正在输入...
+    #
+    #  to: 接受者
+    #  show: typing
+    #  status: 状态信息
+    #
+    def status(to, show, status="")
+      http_post('/statuses', {
+        :version => APIVSN,
+        :ticket => @ticket,
+        :apikey => @apikey,
+        :domain => @domain,
+        :nick => @user[:nick],
+        :to => to,
+        :show => show,
+        :status => status
+      })
+    end
+
+    ##
+    #  从消息服务器读取当前群组在线用户
+    #
+    #  gid: 群组id
+    #
+    def members(gid)
+      res = http_get('/group/members', {
+        :version => APIVSN,
+        :ticket => @ticket,
+        :apikey => @apikey,
+        :domain => @domain,
+        :group => gid
+      })
+      if res and (200 == res.code.to_i)
+        data = JSON.parse(res.body)
+        data[gid]
+    else
+     nil
+      end
+    end
+
+    ##
+    #  转发加入群组消息
+    #
+    #  gid: 群组id
+    #
+    def join(gid)
+      res = http_post('/group/join', {
+        :version => APIVSN,
+        :ticket => @ticket,
+        :apikey => @apikey,
+        :domain => @domain,
+        :nick => @user[:nick],
+        :group => gid 
+      })
+      if res and (200 == res.code.to_i)
+        data = JSON.parse(res.body)
+        {
+          :id => gid,
+          :count => data[gid]
+        }
+      else 
+        nil
+      end
+    end
+
+    ##
+    #  转发离开群组消息
+    #
+    #  gid: 群组id
+    #
+    def leave(gid)
+      http_post('/group/leave', {
+        :version => APIVSN,
+        :ticket => @ticket,
+        :apikey => @apikey,
+        :domain => @domain,
+        :nick => @user[:nick],
+        :group => gid 
+      })
+    end
+
+    ##
+    # Clien对象描述
+    def inspect
+      "<Webim::Client: ticket=%s, domain=%s, apikey=%s, host=%s , port=%p>" %
+        [@ticket, @domain, @apikey, @host, @port]
+    end
+
+    private
+
+    def http_get(path, params = {})
+      params = params.map {|k,v| "#{URI.escape(k.to_s)}=#{URI.escape(v.to_s)}" }.join("&")
+      http = Net::HTTP.new(@host, @port)
+      http.open_timeout = 10
+      http.read_timeout = 10
+      http.get('/' + APIVSN + path + "?" + params)
+    end
+
+    def http_post path, params = {}
+      params = params.map {|k,v| "#{URI.escape(k.to_s)}=#{URI.escape(v.to_s)}" }.join("&")
+      http = Net::HTTP.new(@host, @port)
+      http.open_timeout = 10
+      http.read_timeout = 10
+      http.post('/' + APIVSN + path, params)
+    end
+
+  end
+
+end

data/test/webim_test.rb

@@ -0,0 +1,49 @@
+require "../lib/webim"
+
+require 'test/unit'
+
+class WebimTest < Test::Unit::TestCase
+
+  def setup
+    user = {:id => "vid:1", :nick => "user1", :show => "available", :status => 'Online'}
+    @client = Webim::Client.new(user, "", {:domain => "localhost", :apikey => "public", :host => "localhost", :port => 8000}) 
+    @client.online(['uid2','uid3', 'uid4'], ['g1', 'g2', 'g3'])
+  end
+
+  def test_online
+    puts @client.online(['uid2','uid3', 'uid4'], ['g1', 'g2', 'g3'])
+  end
+
+  def test_message
+    puts @client.message("uid2", "hahaha")
+  end
+
+  def test_presence
+    puts @client.presence('busy', "Busy")
+  end
+
+  def test_status
+    puts @client.status("uid2", "typing", "I am typing")
+  end
+
+  def test_members
+    puts @client.members('g1')
+  end
+
+  def test_join
+    puts @client.join('g1')
+  end
+
+  def test_leave
+    puts @client.leave('g1')
+  end
+
+  def test_offline
+    puts @client.offline
+  end
+
+  def teardown
+    @client.offline
+  end
+
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: webim
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ery Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-12 00:00:00.000000000 Z
+dependencies: []
+description: Ruby webim client library for NexTalk.IM
+email: ery.lee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/webim.rb
+- test/webim_test.rb
+- LICENSE
+- README.md
+- TODO.md
+- CHANGELOG.md
+homepage: https://github.com/webim/webim-gem
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby webim client library for NexTalk.IM
+test_files: []