webim 2.0 → 5.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a9f61021da60564de9cbce023429446b0fed302
-  data.tar.gz: 48f3c2fb09648060614bc0057fc9ac21fce43e1c
+  metadata.gz: 51fa31548cf086f85ddf724170e3ffe8512703aa
+  data.tar.gz: 7c1fe4912d6d0559094ef58e1ff8471f8f2c63b5
 SHA512:
-  metadata.gz: 9b33a72d4a793eafdf946db5fa9aa85491e011dde0f341c850c8de1d567cd1f7c3cf28b853200e851f2f50457944d938091afbdd076e404cea49ff7ea9711eba
-  data.tar.gz: c3f9ddfb06fd001a3be88b1efc8e7eaa6c5b520d0a15bad44b2101764d3680a9052a1a599a97db086d0d84ec3b1f5d6e0496cb8ce9d886f7b0fc4d067fe955d4
+  metadata.gz: 5f2482e0ba0998cec7a6d81c1199713587643219e71042e482a548846be342f28f7b03850799cbb266bacc67eefcc574b6ed7c48b8fa06528f5633e9a3ffa798
+  data.tar.gz: 4b48d9ebf3acad34045e3c9587907e518e9c197eefbc68cbaefea0a4652b5bca09bf341268f1f0f771a3f68157c11ac14dee0932a992266ce8c47551fb0c650e

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 
+# 5.4.2 (2014-03-30)
+
+* version number synchronized with nextalk server
+* room api changed
+* http basic authentication
+
 # 0.1.2 (2013-12-13)
 
 * fix lib/webim.rb:146: syntax error, unexpected ')'

data/README.md

@@ -1,23 +1,29 @@
-# webim
+# WebIM
 
 A Ruby webim library for the [nextalk.im](http://nextal.im).
 
+## Require
+
+Ruby2.0+
+
 ## 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}) 
+    endpoint = {:id => "uid1", :nick => "user1", :show => "available", :status => 'Online'}
+    client = WebIM::Client.new(endpoint, "domain", "apikey", "localhost", 8000) 
 
 Once connected, you can forward requests or route messages to the server:
 
+    ```ruby
+
 	# 向消息服务器转发用户上线消息，同时发送用户的好友id列表、群组id列表
-    client.online(['uid2','uid3', 'uid4'], ['g1', 'g2', 'g3'])
+    client.online(['uid2','uid3', 'uid4'], ['room1', 'room2', 'room3'])
 
     # 向消息服务器转发聊天消息
-    client.message("uid2", "hahaha")
+    client.message({:to => "uid2", :body => "hahaha"})
 
     # 向消息服务器转发用户现场变化
     client.presence('busy', "Busy")
@@ -26,19 +32,23 @@ Once connected, you can forward requests or route messages to the server:
     client.status("uid2", "typing", "I am typing")
 
 	# 向消息服务器push即时消息
-	client.push("uid1", "uid2", "hahaha")
+	client.message({:from => "uid1", :to => "uid2", :body => "ahbh"})
 
 	# 从消息服务器读取用户现场信息
 	client.presences(["uid1", "uid2"])
 
     # 从消息服务器读取当前群组在线用户
-    client.members('g1')
+    client.members('room1')
 
     # 向消息服务器转发用户下线消息
     client.offline
 
+    ```
+
 ## Gem build and install
 
 	gem build webim.gemspec
 
-	gem install webim-0.1.0.gem
+	gem install webim-5.4.2.gem
+
+

data/lib/webim.rb

@@ -1,12 +1,19 @@
+
 require 'net/http'
 require 'uri'
 require 'json'
 
-module Webim
+module WebIM
 
   APIVSN = "v5"
 
-  VERSION = "0.2"
+  VERSION = "5.4.2"
+
+  ##
+  # A Ruby webim error
+  #
+  class Error < StandardError 
+  end
 
   ##
   # A Ruby webim client library for NexTalk.im.
@@ -27,7 +34,7 @@ module Webim
     #   show: 'available' | 'away' | 'chat' | 'dnd' | 'invisible' | 'unavailable'
     #   status: 状态信息
     #
-    attr_reader :user
+    attr_reader :endpoint
 
     ##
     # 网站域名
@@ -61,52 +68,52 @@ module Webim
     ##
     # 创建Client对象
     #
-    # user: 用户Hash对象
+    # endpoint: 用户Hash对象
+    # domain: 域名
+    # apikey: 通信APIKEY
+    # host: 服务器地址
+    # port: 服务器端口号
     # ticket: 通信令牌
-    #
-    # config配置参数:
-    #   domain: 域名
-    #   apikey: 通信APIKEY
-    #   host: 服务器地址
-    #   port: 服务器端口号
+    # timeout: HTTP超时时间
     #   
-    def initialize(user, ticket = "", config = {})
-      @user = user
+    def initialize(endpoint, domain, apikey, host = 'localhost', port = 8000, ticket = nil, timeout = 15)
+      @endpoint = endpoint
+      @domain = domain
+      @apikey = apikey
+      @host = host
+      @port = port
       @ticket = ticket
-      @domain = config[:domain] || ""
-      @apikey = config[:apikey] || ""
-      @host = config[:host] || "127.0.0.1"
-      @port = (config[:port] || DEFAULT_PORT).to_i
-	  @timeout = (config[:timeout] || 10 ).to_i
+	  @timeout = timeout
     end
 
     ##
     #  向消息服务器转发用户上线消息，同时发送用户的好友id列表、群组id列表
     #
     #  buddies: 好友id列表
-    #  groups: 群组id列表
+    #  rooms: 群组id列表
     #
-    def online(buddies, groups)
-      res = http_post('/presences/online', {
-        :version => APIVSN,
+    def online(buddies, rooms)
+      resp = httpost('/presences/online', reqdata().merge({
         :buddies => buddies.join(','),
-        :groups => groups.join(','),
+        :rooms => rooms.join(','),
+        :name => @endpoint[:id],
+        :nick => @endpoint[:nick],
+        :show => @endpoint[:show],
+        :status => @endpoint[:status]
+      }))
+      @ticket = resp["ticket"]
+      connection = {
+        :ticket => @ticket,
         :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 : ""
+        :server => resp['server'],
+        :jsonpd => resp['jsonpd']
+      }
+      connection[:websocket] = resp['websocket'] if resp['websocket']
+      connection[:mqtt] = resp['mqtt'] if resp['mqtt']
+      {
+          :success => true,
+          :connection => connection,
+          :presences => resp['presences']
       }
     end
 
@@ -114,12 +121,7 @@ module Webim
     #  向消息服务器转发用户下线消息
     #
     def offline
-      http_post('/presences/offline', {
-        :version => APIVSN,
-        :ticket => @ticket,
-        :apikey => @apikey,
-        :domain => @domain
-      })
+      httpost('/presences/offline', reqdata())
     end
 
     ##
@@ -129,15 +131,11 @@ module Webim
     #  status: 状态信息
     #  
     def presence(show, status = "")
-      http_post('/presences/show', {
-        :version => APIVSN,
-        :ticket => @ticket,
-        :apikey => @apikey,
-        :domain => @domain,
-        :nick => @user[:nick],
+      httpost('/presences/show', reqdata().merge({
+        :nick => @endpoint[:nick],
         :show => show,
         :status => status
-      })
+      }))
     end
 
     ##
@@ -149,43 +147,16 @@ module Webim
     #  type: chat | grpchat
     #  style: 消息CSS
     #
-    def message(to, body, timestamp = nil, 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 => timestamp ? timestamp : Time.now.to_f * 1000
-      })
-    end
-
-	##
-	# 向消息服务器推送消息
-	#  from: 发送者
-    #  to: 接收者 
-    #  body: 消息体
-	#  timestam: 时间戳
-    #  type: chat | grpchat
-    #  style: 消息CSS
-    #
-	def push(from, to, body, timestamp = nil, type = "chat", style = "")
-      http_post('/messages', {
-        :version => APIVSN,
-        :apikey => @apikey,
-        :domain => @domain,
-        :nick => @user[:nick],
-        :type => type,
-		:from => from,
-        :to => to,
-        :body => body,
-        :style => style,
-        :timestamp => timestamp ? timestamp : Time.now.to_f * 1000
+    def message(message)
+      reqdata = reqdata()
+      reqdata.merge!({
+        :nick => @endpoint[:nick],
+        :type => "chat",
+        :style => "",
+        :timestamp => Time.now.to_f * 1000
       })
+      reqdata.merge!(message)
+      httpost('/messages', reqdata)
     end
 
     ##
@@ -196,16 +167,12 @@ module Webim
     #  status: 状态信息
     #
     def status(to, show, status="")
-      http_post('/statuses', {
-        :version => APIVSN,
-        :ticket => @ticket,
-        :apikey => @apikey,
-        :domain => @domain,
-        :nick => @user[:nick],
+      httpost('/statuses', reqdata().merge({
+        :nick => @endpoint[:nick],
         :to => to,
         :show => show,
         :status => status
-      })
+      }))
     end
 
     ##
@@ -214,100 +181,91 @@ module Webim
     #  ids: 用户id列表
     #
 	def presences(ids)
-      res = http_get('/presences', {
-        :version => APIVSN,
-        :ticket => @ticket,
-        :apikey => @apikey,
-        :domain => @domain,
+      httpget('/presences', reqdata().merge({
         :ids => ids.join(",")
-      })
-      if res and (200 == res.code.to_i)
-        JSON.parse(res.body)
-	  else
-		nil
-	  end
+      }))
 	end
 
     ##
     #  从消息服务器读取当前群组在线用户
     #
-    #  gid: 群组id
+    #  room: 群组room
     #
-    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)
-        JSON.parse(res.body)
-    else
-     nil
-      end
+    def members(room)
+      httpget("/rooms/#{room}/members", reqdata().merge({
+          :room => room
+      })) 
     end
 
     ##
     #  转发加入群组消息
     #
-    #  gid: 群组id
+    #  room: 群组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)
-        JSON.parse(res.body)
-      else 
-        nil
-      end
+    def join(room)
+      httpost("/rooms/#{room}/join", reqdata().merge({
+        :nick => @endpoint[:nick],
+        :room => room
+      }))
     end
 
     ##
     #  转发离开群组消息
     #
-    #  gid: 群组id
+    #  room: 群组id
     #
-    def leave(gid)
-      http_post('/group/leave', {
-        :version => APIVSN,
-        :ticket => @ticket,
-        :apikey => @apikey,
-        :domain => @domain,
-        :nick => @user[:nick],
-        :group => gid 
-      })
+    def leave(room)
+      httpost("/rooms/#{room}/leave", reqdata().merge({
+        :nick => @endpoint[:nick],
+        :room => room
+      }))
     end
 
     ##
     # Clien对象描述
     def inspect
-      "<Webim::Client: ticket=%s, domain=%s, apikey=%s, host=%s , port=%p>" %
+      "<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 = @timeout
-      http.read_timeout = @timeout
-      http.get('/' + APIVSN + path + "?" + params)
+    def httpget(api, params = {})
+      uri = URI("http://#{@host}:#{@port}/#{APIVSN}#{api}")
+      uri.query = URI.encode_www_form(params)
+      req = Net::HTTP::Get.new(uri)
+      req.basic_auth @domain, @apikey
+      resp = Net::HTTP.start(@host, @port) {|http|
+          http.open_timeout = @timeout
+          http.read_timeout = @timeout
+          http.request(req)
+      }
+      return JSON.parse(resp.body) if resp and resp.code == '200'
+      raise Error, "#{resp.code} #{resp.message} #{resp.body}"
     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 = @timeout
-      http.read_timeout = @timeout
-      http.post('/' + APIVSN + path, params)
+    def httpost(api, params = {})
+      uri = URI("http://#{@host}:#{@port}/#{APIVSN}#{api}")
+      req = Net::HTTP::Post.new(uri)
+      req.basic_auth @domain, @apikey
+      req.set_form_data(params)
+      resp = Net::HTTP.start(@host, @port) {|http|
+          http.open_timeout = @timeout
+          http.read_timeout = @timeout
+          http.request(req)
+      }
+      return JSON.parse(resp.body) if resp and resp.code == '200'
+      raise Error, "#{resp.code} #{resp.message} #{resp.body}"
+    end
+
+    def reqdata()
+      data = {
+        :version => VERSION,
+        :ticket => @ticket,
+        :domain => @domain
+      }
+      data[:ticket] = @ticket if @ticket
+      data
     end
 
   end

data/test/webim_test.rb

@@ -5,21 +5,21 @@ 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'])
+    endpoint = {:id => "uid1", :nick => "user1", :show => "available", :status => 'Online'}
+    @client = WebIM::Client.new(endpoint, "localhost", "public", "localhost", 8000) 
+    @client.online(['uid2','uid3', 'uid4'], ['room1', 'room2', 'room3'])
   end
 
   def test_online
-    puts @client.online(['uid2','uid3', 'uid4'], ['g1', 'g2', 'g3'])
+    puts @client.online(['uid2','uid3', 'uid4'], ['room1', 'room2', 'room3'])
   end
 
   def test_message
-    puts @client.message("uid2", "hahaha")
+    puts @client.message({:to => "uid2", :body => "hahaha"})
   end
 
   def test_push
-	puts @client.push("uid1", "uid2", "ahbh")
+	puts @client.message({:from => "uid1", :to => "uid2", :body => "ahbh"})
   end
 
   def test_presence
@@ -31,19 +31,20 @@ class WebimTest < Test::Unit::TestCase
   end
 
   def test_presences
-	puts @client.presences(['uid1', 'ui2'])
+	puts @client.presences(['uid1', 'uid2'])
   end
 
   def test_members
-    puts @client.members('g1')
+    @client.join('room1')
+    puts @client.members('room1')
   end
 
   def test_join
-    puts @client.join('g1')
+    puts @client.join('room1')
   end
 
   def test_leave
-    puts @client.leave('g1')
+    puts @client.leave('room1')
   end
 
   def test_offline

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webim
 version: !ruby/object:Gem::Version
-  version: '2.0'
+  version: 5.4.2
 platform: ruby
 authors:
 - Ery Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-10 00:00:00.000000000 Z
+date: 2014-03-30 00:00:00.000000000 Z
 dependencies: []
 description: Ruby webim client library for NexTalk.IM
 email: ery.lee@gmail.com