baidu-sdk 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7d739a156a7feec33727249033320452ff730d1
-  data.tar.gz: 1db71954fe27d31241176786cab6ec5dbd18ae09
+  metadata.gz: 3af6ada389f6a63f94e817ce4a13d344b73461f5
+  data.tar.gz: c769fddcdea66b5cb027fd123f7e366e17bae183
 SHA512:
-  metadata.gz: 7ea790ba81dabc1968e53664a95e30b741ba1d9c282d4631edeac230b9b2c9e631d359add53badf7636e7acda6dfff7f924ccf98ceeced42b166627766d9afe7
-  data.tar.gz: 19e130371ed9e9d9f804b0fbf60e1e6a6e4dc5c9df7f1b50e715cd3152b404c942a1594202194a8dd1e1b775c16bf6e74d126cb55b40bbbfeeaf8e690eab4780
+  metadata.gz: 3f354a1ae052d10dacc1160c23f94f90c2eeea602dd437e134383e4771d5bc43e1ece0e168445f7c9c6ce74518855e47175911e825bac7f45a1f157e1b078abb
+  data.tar.gz: 613e6c1f4b7ab7a2b0bdc5c72c9f8382cf26fdc0e2006922ac85cd9cedc02d920f57cfa1066df76b516154c5847d87bd34496810a9b22fb0b5c4ee085fe9ee14

data/.travis.yml

@@ -5,11 +5,13 @@ script: 'bundle exec rake spec'
 rvm:
   - 1.9.3
   - 2.0.0
-  - rbx-2.1.1
+  - 2.1.0
+  - rbx-2
   - jruby-19mode
   - ruby-head
 
 matrix:
   allow_failures:
-    - rvm: rbx-2.1.1
+    - rvm: rbx-2
     - rvm: jruby-19mode
+    - rvm: ruby-head

data/HISTORY.md

@@ -1,3 +1,16 @@
+## 0.0.3 (2013-12-30)
+* 添加部分 REST API, `Baidu::OAuth::RESTClient`
+  * get_logged_in_user
+  * get_info
+  * app_user?
+  * has_app_permission?
+  * has_app_permissions
+  * get_friends
+  * are_friends
+  * expire_session
+  * revoke_authorization
+  * query_ip
+
 ## 0.0.2 (2013-12-06)
 * **OAuth** 添加 Implicit Grant 授权流程
 * **OAuth** 添加 Client Credentials 授权流程

data/README.md

@@ -149,6 +149,19 @@ get '/auth/callback' do
 end
 ```
 
+### REST API
+通过百度开放平台提供的 REST API，第三方应用可以获取到百度用户的用户资料、好友关系等基本信息，以及今后百度开放的其他任何数据，但前提是应用必须获得到百度开放平台和百度用户的授权。
+
+当前实现了用户信息类接口、好友关系类接口、用户授权类接口和工具类接口。
+
+```ruby
+rest_client = Baidu::OAuth::RESTClient.new('my_token...')
+puts rest_client.get_logged_in_user
+puts rest_client.get_info
+puts rest_client.expire_session
+# puts rest_client.revoke_authorization
+```
+
 ## PCS
 要使用 PCS 必须到 [百度开发者中心](http://developer.baidu.com/console) 开启指定应用的 PCS API 权限，参考 [开通PCS API权限](http://developer.baidu.com/wiki/index.php?title=docs/pcs/guide/api_approve)，并获取所设置的文件目录。
 

data/lib/baidu/oauth.rb

@@ -1,9 +1,11 @@
 require 'baidu/core'
 require 'baidu/oauth/client'
+require 'baidu/oauth/rest_client'
 
 module Baidu
   module OAuth
     SITE                   = 'https://openapi.baidu.com'
+    BASE_PATH              = '/rest/2.0'
     AUTHORIZATION_ENDPOINT = '/oauth/2.0/authorize'
     TOKEN_ENDPOINT         = '/oauth/2.0/token'
     TOKEN_INFO_ENDPOINT    = '/oauth/2.0/tokeninfo'

data/lib/baidu/oauth/rest_client.rb

@@ -0,0 +1,334 @@
+# encoding: UTF-8
+
+module Baidu
+  module OAuth
+    # 通过百度开放平台提供的REST API，第三方应用可以获取到百度用户的用户资料、
+    # 好友关系等基本信息，以及今后百度开放的其他任何数据，
+    # 但前提是应用必须获得到百度开放平台和百度用户的授权。
+    class RESTClient
+      include Baidu::Support::Request
+
+      # 创建一个 REST API Client 实例
+      #
+      # @example
+      #   rest_client = Baidu::OAuth::RESTClient.new('my_token...')
+      #
+      # @overload initialize(access_token)
+      #   @param [String] access_token
+      #
+      # @overload initialize(session)
+      #   @param [Baidu::Session] session
+      def initialize(access_token_or_session)
+        @access_token = case access_token_or_session
+                        when String then access_token_or_session
+                        when Baidu::Session then access_token_or_session.access_token
+                        else
+                          raise ArgumentError, 'need a String or Baidu::Session'
+                        end
+        @site = Baidu::OAuth::SITE
+      end
+
+      # 获取当前登录用户的简单信息
+      #
+      # 获取当前登录用户的用户uid、用户名和头像。
+      # @note 如果存储用户信息的话，请大家以百度用户uid为主键
+      #
+      # @example 返回的原始 JSON
+      #   {
+      #     "uid": "256758493",
+      #     "uname": "XiaoLu",
+      #     "portrait": "b4994c6849380284916e67af0c"
+      #   }
+      #
+      #   :uid      当前登录用户的数字ID
+      #   :uname    当前登录用户的用户名。只用于显示，可能会发生变化，不保证全局唯一
+      #   :portrait 当前登录用户的头像
+      #
+      #   头像的地址具体如下：
+      #   small image: http://tb.himg.baidu.com/sys/portraitn/item/{$portrait}
+      #   large image: http://tb.himg.baidu.com/sys/portrait/item/{$portrait}
+      #
+      # @return [Hash]
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/rest/file_data_apis_list#.E8.8E.B7.E5.8F.96.E5.BD.93.E5.89.8D.E7.99.BB.E5.BD.95.E7.94.A8.E6.88.B7.E7.9A.84.E7.AE.80.E5.8D.95.E4.BF.A1.E6.81.AF 获取当前登录用户的信息
+      def get_logged_in_user
+        api_request '/passport/users/getLoggedInUser'
+      end
+
+      # 返回用户详细资料
+      # @note 如果存储用户信息的话，请大家以百度用户uid为主键
+      #
+      # @example 返回的原始 JSON
+      #   {
+      #       "userid":"2097322476",
+      #       "username":"wl19871011",
+      #       "realname":"阳光",
+      #       "userdetail":"喜欢自由",
+      #       "birthday":"1987-01-01",
+      #       "marriage":"恋爱",
+      #       "sex":"男",
+      #       "blood":"O",
+      #       "constellation":"射手",
+      #       "figure":"小巧",
+      #       "education":"大学/专科",
+      #       "trade":"计算机/电子产品",
+      #       "job":"未知",
+      #       "birthday_year":"1987",
+      #       "birthday_month":"01",
+      #       "birthday_day":"01"
+      #   }
+      #
+      #   :userid        当前登录用户的数字ID
+      #   :username      当前登录用户的用户名，值可能为空。
+      #   :realname      用户真实姓名，可能为空。
+      #   :portrait      当前登录用户的头像
+      #   :userdetail    自我简介，可能为空。
+      #   :birthday      生日，以yyyy-mm-dd格式显示。
+      #   :marriage      婚姻状况
+      #   :sex           性别
+      #   :blood         血型
+      #   :figure        体型
+      #   :constellation 星座
+      #   :education     学历
+      #   :trade         当前职业
+      #   :job           职位
+      #
+      #   头像的地址具体如下：
+      #   small image: http://tb.himg.baidu.com/sys/portraitn/item/{$portrait}
+      #   large image: http://tb.himg.baidu.com/sys/portrait/item/{$portrait}
+      #
+      # @return [Hash]
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/rest/file_data_apis_list#.E8.BF.94.E5.9B.9E.E7.94.A8.E6.88.B7.E8.AF.A6.E7.BB.86.E8.B5.84.E6.96.99 返回用户详细资料
+      def get_info
+        api_request '/passport/users/getInfo'
+      end
+
+      # 判定当前用户是否已经为应用授权
+      #
+      # @option options [String] :uid   用户uid,为空则默认是当前用户
+      # @option options [String] :appid 应用的appid,为空则默认是当前应用
+      #
+      # @return [Boolean]
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/rest/file_data_apis_list#.E5.88.A4.E5.AE.9A.E5.BD.93.E5.89.8D.E7.94.A8.E6.88.B7.E6.98.AF.E5.90.A6.E5.B7.B2.E7.BB.8F.E4.B8.BA.E5.BA.94.E7.94.A8.E6.8E.88.E6.9D.83 判定当前用户是否已经为应用授权
+      def app_user?(options={})
+        rest = api_request '/passport/users/isAppUser', options
+        rest[:result] == '1'
+      end
+
+      # 判断指定用户是否具有某个数据操作权限
+      #
+      # 根据用户id以及在百度的相应的操作权限(单个权限，例如接收email等)来判断用户是否可以进行此操作。
+      #
+      # @param [String] ext_perm 单个权限，例如接收email等，具体权限请查看权限列表
+      # @param [String] uid      用户uid，为空则默认是当前用户
+      #
+      # @return [Boolean]
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/rest/file_data_apis_list#.E5.88.A4.E6.96.AD.E6.8C.87.E5.AE.9A.E7.94.A8.E6.88.B7.E6.98.AF.E5.90.A6.E5.85.B7.E6.9C.89.E6.9F.90.E4.B8.AA.E6.95.B0.E6.8D.AE.E6.93.8D.E4.BD.9C.E6.9D.83.E9.99.90 判断指定用户是否具有某个数据操作权限
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth#.E6.8E.88.E6.9D.83.E6.9D.83.E9.99.90.E5.88.97.E8.A1.A8 权限列表
+      def has_app_permission?(ext_perm, uid=nil)
+        body = { ext_perm: ext_perm, uid: uid }
+        rest = api_request '/passport/users/hasAppPermission', body
+        rest[:result] == '1'
+      end
+
+      # 判断指定用户是否具有某一批数据操作权限
+      #
+      # 根据用户id以及在百度的相应的操作权限(可以是多个权限半角逗号隔开)来判断用户是否可以进行此操作
+      #
+      # @example 返回的原始 JSON
+      #   {"basic":"1","email":"0"}
+      #
+      # @overload has_app_permissions(ext_perm, uid=nil)
+      #   @param [String] ext_perm 多个权限半角逗号隔开，例如basic,email等，具体权限请查看权限列表
+      #   @param [String] uid      用户uid，为空则默认是当前用户
+      #
+      # @overload has_app_permissions(ext_perms, uid=nil)
+      #   @param [Array<String>] ext_perms 权限字符串数组，具体权限请查看权限列表
+      #   @param [String]        uid       用户uid，为空则默认是当前用户
+      #
+      # @return [Hash]
+      #            各个值在原始 JSON 基础之上转换为 true 或者 false
+      #              如：{:basic=>true, :email=>false}
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/rest/file_data_apis_list#.E5.88.A4.E6.96.AD.E6.8C.87.E5.AE.9A.E7.94.A8.E6.88.B7.E6.98.AF.E5.90.A6.E5.85.B7.E6.9C.89.E6.9F.90.E4.B8.80.E6.89.B9.E6.95.B0.E6.8D.AE.E6.93.8D.E4.BD.9C.E6.9D.83.E9.99.90 判断指定用户是否具有某一批数据操作权限
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth#.E6.8E.88.E6.9D.83.E6.9D.83.E9.99.90.E5.88.97.E8.A1.A8 权限列表
+      def has_app_permissions(ext_perms, uid=nil)
+        body = { ext_perms: ext_perms, uid: uid }
+        if ext_perms.is_a? Array
+          body[:ext_perms] = ext_perms.join ','
+        end
+
+        rest = api_request '/passport/users/hasAppPermissions', body
+        rest.each { |k, v| rest[k] = v == '1' }
+      end
+
+      # 返回用户好友资料
+      #
+      # 根据用户id以及在百度的相应的操作权限(可以是多个权限半角逗号隔开)来判断用户是否可以进行此操作
+      # @todo TODO: check return value
+      #
+      # @example 返回的原始 JSON
+      #   [
+      #     {
+      #       "uname": "spacebj009",
+      #       "uid": "2013411308",
+      #       "portrait": "79787370616365626a3030393306"
+      #     },
+      #     {
+      #       "uname": "spacebj003",
+      #       "uid": "2013412844",
+      #       "portrait": "73787370616365626a3030333306"
+      #     }
+      #   ]
+      #
+      #   :uname    好友的用户名
+      #   :uid      当前登录用户的数字ID
+      #   :portrait 好友的用户头像加密串
+      #
+      # @option options [Fixnum] :page_no   用于支持分页的API，0表示第1页，默认为0
+      # @option options [Fixnum] :page_size 用于支持分页的API，表示每页返回多少条数据，默认值500
+      # @option options [String] :sort_type 0: 按照添加时间排序，1：登陆时间排序，默认为0
+      #
+      # @return [Array]
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/rest/file_data_apis_list#.E8.BF.94.E5.9B.9E.E7.94.A8.E6.88.B7.E5.A5.BD.E5.8F.8B.E8.B5.84.E6.96.99 返回用户好友资料
+      def get_friends(options={})
+        api_request '/friends/getFriends', options
+      end
+
+      # 获得指定用户之间好友关系
+      #
+      # 获得指定用户之间是否是好友关系。第一个数组指定一半用户，第二个数组指定另外一半，
+      # 两个数组必须同样的个数，一次最多可以查20个
+      #
+      # @example 返回的原始 JSON
+      #   [
+      #     {
+      #       "uid1": "2222",
+      #       "uid2": "1111",
+      #       "are_friends": "1",
+      #       "are_friends_reverse": "0"
+      #     },
+      #     {
+      #       "uid1": "3333",
+      #       "uid2": "2222",
+      #       "are_friends": "0",
+      #       "are_friends_reverse": "1"
+      #     }
+      #   ]
+      #
+      #   :are_friends         uid2是否是uid1的好友
+      #   :are_friends_reverse uid1是否是uid2的好友
+      #
+      # @overload are_friends(uid1, uid2)
+      #   @param [String] uid1
+      #   @param [String] uid2
+      #
+      # @overload are_friends(uids1, uids2)
+      #   @param [Array<String>] uids1
+      #   @param [Array<String>] uids2
+      #
+      # @return [Array]
+      #            are_friends 和 are_friends_reverse 值在原始 JSON 基础之上转换为 true 或者 false
+      #              如：[{:uid1=>"22", :uid2=>"33", :are_friends=>false, :are_friends_reverse=>true}]
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/rest/file_data_apis_list#.E8.8E.B7.E5.BE.97.E6.8C.87.E5.AE.9A.E7.94.A8.E6.88.B7.E4.B9.8B.E9.97.B4.E5.A5.BD.E5.8F.8B.E5.85.B3.E7.B3.BB 获得指定用户之间好友关系
+      def are_friends(uids1, uids2)
+        body = {}
+        case
+        when uids1.is_a?(String) && uids2.is_a?(String)
+          body[:uids1], body[:uids2] = uids1, uids2
+        when uids1.is_a?(Array)  && uids2.is_a?(Array)
+          raise ArgumentError, 'not the same size of array' unless uids1.size == uids2.size
+          body[:uids1], body[:uids2] = uids1.join(','), uids2.join(',')
+        else
+          raise ArgumentError, 'not the same types'
+        end
+
+        rest = api_request '/friends/areFriends', body
+        rest.each do |h|
+          h[:are_friends] = h[:are_friends] == '1'
+          h[:are_friends_reverse] = h[:are_friends_reverse] == '1'
+        end
+      end
+
+      # 使access_token,session_key过期
+      #
+      # 使用户授予的access_token和session_key过期
+      #
+      # @return [Boolean] true: 成功 false: 失败
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/rest/file_data_apis_list#.E4.BD.BFaccess_token.2Csession_key.E8.BF.87.E6.9C.9F 使access_token,session_key过期
+      def expire_session
+        rest = api_request '/passport/auth/expireSession'
+        rest[:result] == '1'
+      end
+
+      # 撤销用户授予第三方应用的权限
+      #
+      # @param [String] uid 用户的ID,空则默认为当前用户
+      #
+      # @return [Boolean] true: 成功 false: 失败
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/rest/file_data_apis_list#.E6.92.A4.E9.94.80.E7.94.A8.E6.88.B7.E6.8E.88.E4.BA.88.E7.AC.AC.E4.B8.89.E6.96.B9.E5.BA.94.E7.94.A8.E7.9A.84.E6.9D.83.E9.99.90 撤销用户授予第三方应用的权限
+      def revoke_authorization(uid=nil)
+        rest = api_request('/passport/auth/revokeAuthorization', {uid: uid})
+        rest[:result] == '1'
+      end
+
+      # 查询IP地址所在地区
+      #
+      # @example
+      #   rest_client.query_ip '111.222.111.222', '114.114.114.114'
+      #
+      # @example 返回的原始 JSON
+      #   {
+      #     "111.222.111.222": {
+      #       "province": "\u5e7f\u4e1c",
+      #       "city": "\u6df1\u5733"
+      #     },
+      #     "111.222.111.222": {
+      #       "province": ""\u6c5f\u82cf",
+      #       "city": ""
+      #     }
+      #   }
+      #
+      # @param [*String] ips 需要查询的ip地址
+      #
+      # @return [Hash]
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/rest/file_data_apis_list#.E6.9F.A5.E8.AF.A2IP.E5.9C.B0.E5.9D.80.E6.89.80.E5.9C.A8.E5.9C.B0.E5.8C.BA 查询IP地址所在地区
+      def query_ip(*ips)
+        api_request('/iplib/query', { ip: ips.join(',') }, :get)
+      end
+
+      private
+
+      def base_query
+        { access_token: @access_token }
+      end
+
+      def api_request(path, params={}, method=:post)
+        body = base_query.update params
+        rest =
+          case method
+          when :post
+            post "#{BASE_PATH}#{path}", nil, body
+          when :get
+            get "#{BASE_PATH}#{path}", body
+          end
+        process_error rest
+        rest
+      end
+
+      # NOTE: Baidu api sucks, it may return error info with 200 status
+      # http://developer.baidu.com/wiki/index.php?title=%E7%99%BE%E5%BA%A6Open_API%E9%94%99%E8%AF%AF%E7%A0%81%E5%AE%9A%E4%B9%89
+      def process_error(data)
+        if data.is_a?(Hash) && data.has_key?(:error_code)
+          code = data[:error_code].to_s.strip
+          msg  = data[:error_msg]
+          unless code == '0'
+            if %w[102 110 111 112].include? code
+              raise Baidu::Errors::AuthError.new(msg, code)
+            else
+              raise Baidu::Errors::Error.new(msg, code)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/baidu/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module Baidu
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/baidu/oauth/client_spec.rb

@@ -82,26 +82,24 @@ describe Baidu::OAuth::Client do
   context '#user_and_device_code' do
 
     it 'requests user and device code' do
-      stub_get(:oauth, '/oauth/2.0/device/code', client_id: 'ci', response_type: 'device_code').
-        to_return(status: 200, body: ft('user_and_device_code.json'))
+      stub = stub_get(:oauth, '/oauth/2.0/device/code', client_id: 'ci', response_type: 'device_code')
+      stub.to_return(status: 200, body: ft('user_and_device_code.json'))
       @client.device_flow.user_and_device_code
-      a_get(:oauth, '/oauth/2.0/device/code', client_id: 'ci', response_type: 'device_code').
-        should have_been_made
+      stub.should have_been_requested
     end
 
     it 'requests user and device code with scope' do
-      stub_get(:oauth, '/oauth/2.0/device/code', client_id: 'ci',
-               response_type: 'device_code', scope: 'basic netdisk').
-        to_return(status: 200, body: ft('user_and_device_code.json'))
+      stub = stub_get(:oauth, '/oauth/2.0/device/code', client_id: 'ci',
+                                                        response_type: 'device_code',
+                                                        scope: 'basic netdisk')
+      stub.to_return(status: 200, body: ft('user_and_device_code.json'))
       @client.device_flow.user_and_device_code 'basic netdisk'
-      a_get(:oauth, '/oauth/2.0/device/code', client_id: 'ci',
-            response_type: 'device_code', scope: 'basic netdisk').
-        should have_been_made
+      stub.should have_been_requested
     end
 
     it 'responses user and device code' do
-      stub_get(:oauth, '/oauth/2.0/device/code', client_id: 'ci', response_type: 'device_code').
-        to_return(status: 200, body: ft('user_and_device_code.json'))
+      stub = stub_get(:oauth, '/oauth/2.0/device/code', client_id: 'ci', response_type: 'device_code')
+      stub.to_return(status: 200, body: ft('user_and_device_code.json'))
       result = @client.device_flow.user_and_device_code
       expect(result).to be_instance_of(Hash)
       expect(result).to have_key(:device_code)
@@ -114,29 +112,26 @@ describe Baidu::OAuth::Client do
   end
 
   context '#get_token' do
-    context 'with code flow' do
-      before do
-        stub_post(:oauth, '/oauth/2.0/token',
-                  grant_type: 'authorization_code',
-                  code: 'ANXxSNjwQDugOnqeikRMu2bKaXCdlLxn',
-                  client_id: 'ci', client_secret: 'cs',
-                  redirect_uri: 'http://www.example.com/oauth_redirect').
-          to_return(status: 200, body: ft('get_token_code.json'))
-      end
-
+    context 'with authorization code flow' do
       it 'requests access tokey' do
+        stub = stub_post(:oauth, '/oauth/2.0/token', grant_type: 'authorization_code',
+                                                     client_id: 'ci', client_secret: 'cs',
+                                                     redirect_uri: 'http://www.example.com/oauth_redirect',
+                                                     code: 'ANXxSNjwQDugOnqeikRMu2bKaXCdlLxn')
+        stub.to_return(status: 200, body: ft('get_token_code.json'))
         @client.authorization_code_flow.get_token 'ANXxSNjwQDugOnqeikRMu2bKaXCdlLxn',
-                                     'http://www.example.com/oauth_redirect'
-        a_post(:oauth, '/oauth/2.0/token',
-                grant_type: 'authorization_code',
-                code: 'ANXxSNjwQDugOnqeikRMu2bKaXCdlLxn',
-                client_id: 'ci', client_secret: 'cs',
-                redirect_uri: 'http://www.example.com/oauth_redirect').should have_been_made
+                                                  'http://www.example.com/oauth_redirect'
+        stub.should have_been_requested
       end
 
       it 'responses access token' do
+        stub = stub_post(:oauth, '/oauth/2.0/token', grant_type: 'authorization_code',
+                                                     client_id: 'ci', client_secret: 'cs',
+                                                     redirect_uri: 'http://www.example.com/oauth_redirect',
+                                                     code: 'ANXxSNjwQDugOnqeikRMu2bKaXCdlLxn')
+        stub.to_return(status: 200, body: ft('get_token_code.json'))
         result = @client.authorization_code_flow.get_token 'ANXxSNjwQDugOnqeikRMu2bKaXCdlLxn',
-                                              'http://www.example.com/oauth_redirect'
+                                                           'http://www.example.com/oauth_redirect'
         expect(result).to be_instance_of(Baidu::Session)
         expect(result).to respond_to(:access_token)
         expect(result).to respond_to(:refresh_token)
@@ -147,20 +142,20 @@ describe Baidu::OAuth::Client do
     end
 
     context 'with device flow' do
-      before do
-        stub_post(:oauth, '/oauth/2.0/token', grant_type: 'device_token',
-                  code: 'a82hjs723h72h3a82hjs723h72h3vb', client_id: 'ci', client_secret: 'cs').
-          to_return(status: 200, body: ft('get_token_device.json'))
-      end
-
       it 'requests access token' do
+        stub = stub_post(:oauth, '/oauth/2.0/token', grant_type: 'device_token',
+                                                     client_id: 'ci', client_secret: 'cs',
+                                                     code: 'a82hjs723h72h3a82hjs723h72h3vb')
+        stub.to_return(status: 200, body: ft('get_token_device.json'))
         @client.device_flow.get_token 'a82hjs723h72h3a82hjs723h72h3vb'
-        a_post(:oauth, '/oauth/2.0/token', grant_type: 'device_token',
-               code: 'a82hjs723h72h3a82hjs723h72h3vb',
-               client_id: 'ci', client_secret: 'cs').should have_been_made
+        stub.should have_been_requested
       end
 
       it 'responses access token' do
+        stub = stub_post(:oauth, '/oauth/2.0/token', grant_type: 'device_token',
+                                                     client_id: 'ci', client_secret: 'cs',
+                                                     code: 'a82hjs723h72h3a82hjs723h72h3vb')
+        stub.to_return(status: 200, body: ft('get_token_device.json'))
         result = @client.device_flow.get_token 'a82hjs723h72h3a82hjs723h72h3vb'
         expect(result).to be_instance_of(Baidu::Session)
         expect(result).to respond_to(:access_token)
@@ -184,14 +179,16 @@ describe Baidu::OAuth::Client do
     end
 
     it 'requests access token with scope' do
-      stub = stub_post(:oauth, '/oauth/2.0/token', base_params.update({ scope: 'basic hao123' }))
+      params = { grant_type: 'client_credentials', scope: 'basic hao123',
+                 client_id: 'ci', client_secret: 'cs' }
+      stub = stub_post(:oauth, '/oauth/2.0/token', params)
       @client.client_credentials_flow.get_token('basic hao123')
       stub.should have_been_requested
     end
 
     it 'responses access token' do
-      stub = stub_post(:oauth, '/oauth/2.0/token', base_params).
-        to_return(status: 200, body: ft('get_token_client_credentials.json'))
+      stub = stub_post(:oauth, '/oauth/2.0/token', base_params)
+      stub.to_return(status: 200, body: ft('get_token_client_credentials.json'))
       result = @client.client_credentials_flow.get_token
       expect(result).to be_instance_of(Baidu::Session)
       expect(result).to respond_to(:access_token)
@@ -203,34 +200,31 @@ describe Baidu::OAuth::Client do
   end
 
   context '#refresh_token' do
-    before do
-      stub_post(:oauth, '/oauth/2.0/token', grant_type: 'refresh_token',
-                refresh_token: '2.af3d55f8615fdfd9edb7c4b5ebdc3e32.604800.1293440400-2346678-124328',
-                client_id: 'ci', client_secret: 'cs').
-        to_return(status: 200, body: ft('refresh_token.json'))
-    end
-
     it 'requests access token by refresh token' do
-      @client.refresh('2.af3d55f8615fdfd9edb7c4b5ebdc3e32.604800.1293440400-2346678-124328')
-      a_post(:oauth, '/oauth/2.0/token', grant_type: 'refresh_token',
-             refresh_token: '2.af3d55f8615fdfd9edb7c4b5ebdc3e32.604800.1293440400-2346678-124328',
-             client_id: 'ci', client_secret: 'cs').should have_been_made
+      stub = stub_post(:oauth, '/oauth/2.0/token', grant_type: 'refresh_token',
+                                                   refresh_token: '2.af3d55f',
+                                                   client_id: 'ci', client_secret: 'cs')
+      stub.to_return(status: 200, body: ft('refresh_token.json'))
+      @client.refresh('2.af3d55f')
+      stub.should have_been_requested
     end
 
-    it 'requests access token by  refresh token with params' do
-      stub_post(:oauth, '/oauth/2.0/token', grant_type: 'refresh_token',
-                refresh_token: '2.af3d55f8615fdfd9edb7c4b5ebdc3e32.604800.1293440400-2346678-124328',
-                scope: 'basic netdisk', client_id: 'ci', client_secret: 'cs').
-        to_return(status: 200, body: ft('refresh_token.json'))
-      @client.refresh('2.af3d55f8615fdfd9edb7c4b5ebdc3e32.604800.1293440400-2346678-124328',
-                      scope: 'basic netdisk')
-      a_post(:oauth, '/oauth/2.0/token', grant_type: 'refresh_token',
-             refresh_token: '2.af3d55f8615fdfd9edb7c4b5ebdc3e32.604800.1293440400-2346678-124328',
-             scope: 'basic netdisk', client_id: 'ci', client_secret: 'cs').should have_been_made
+    it 'requests access token by refresh token with params' do
+      stub = stub_post(:oauth, '/oauth/2.0/token', grant_type: 'refresh_token',
+                                            refresh_token: '2.af3d55f8',
+                                            client_id: 'ci', client_secret: 'cs',
+                                            scope: 'basic netdisk')
+      stub.to_return(status: 200, body: ft('refresh_token.json'))
+      @client.refresh('2.af3d55f8', scope: 'basic netdisk')
+      stub.should have_been_requested
     end
 
     it 'responses access token by refresh token' do
-      result = @client.refresh('2.af3d55f8615fdfd9edb7c4b5ebdc3e32.604800.1293440400-2346678-124328')
+      stub = stub_post(:oauth, '/oauth/2.0/token', grant_type: 'refresh_token',
+                                            refresh_token: '2.af3d55f86',
+                                            client_id: 'ci', client_secret: 'cs')
+      stub.to_return(status: 200, body: ft('refresh_token.json'))
+      result = @client.refresh('2.af3d55f86')
       expect(result).to be_instance_of(Baidu::Session)
       expect(result).to respond_to(:access_token)
       expect(result).to respond_to(:refresh_token)

data/spec/baidu/oauth/rest_client_spec.rb

@@ -0,0 +1,313 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+require 'baidu/oauth'
+
+module Baidu
+  describe OAuth::RESTClient do
+    let(:base_query) { { access_token: '3.xxx.yyy' } }
+
+    before do
+      @client = OAuth::RESTClient.new(base_query[:access_token])
+    end
+
+    describe '#initialize' do
+      it 'inits with access token string' do
+        client = OAuth::RESTClient.new('xyz_at')
+        expect(client).to be_a(OAuth::RESTClient)
+        expect(client.instance_variable_get(:@access_token)).to eq('xyz_at')
+      end
+
+      it 'inits with Baidu::Session' do
+        session = Baidu::Session.new
+        session.access_token = 'zyx_at'
+        client = OAuth::RESTClient.new(session)
+        expect(client).to be_a(OAuth::RESTClient)
+        expect(client.instance_variable_get(:@access_token)).to eq('zyx_at')
+      end
+
+      it 'provides base uri' do
+        client = OAuth::RESTClient.new('xyz_at')
+        expect(client.instance_variable_get(:@site)).to eq('https://openapi.baidu.com')
+      end
+
+      it 'raises error with other params' do
+        expect {
+          OAuth::RESTClient.new({})
+        }.to raise_error(ArgumentError, 'need a String or Baidu::Session')
+      end
+    end
+
+    describe '#get_logged_in_user' do
+      it 'requests with params' do
+        stub = stub_post(:oauth_rest, '/passport/users/getLoggedInUser', base_query)
+        @client.get_logged_in_user
+        stub.should have_been_requested
+      end
+    end
+
+    describe '#get_info' do
+      it 'requests current user info' do
+        stub = stub_post(:oauth_rest, '/passport/users/getInfo', base_query)
+        @client.get_info
+        stub.should have_been_requested
+      end
+    end
+
+    describe '#app_user?' do
+      it 'requests "isAppUser" api' do
+        stub = stub_post(:oauth_rest, '/passport/users/isAppUser', base_query)
+        @client.app_user?
+        stub.should have_been_requested
+      end
+
+      it 'requests "isAppUser" for specified user' do
+        stub = stub_post(:oauth_rest,
+                         '/passport/users/isAppUser',
+                         base_query.update({ uid: '456123' }))
+        stub.to_return(body: '{"result":"1"}')
+        rest = @client.app_user?(uid: '456123')
+        stub.should have_been_requested
+        expect(rest).to eq(true)
+      end
+
+      it 'requests "isAppUser" for specified appid' do
+        stub = stub_post(:oauth_rest,
+                         '/passport/users/isAppUser',
+                         base_query.update({ appid: '341256' }))
+        stub.to_return(body: '{"result":"0"}')
+        rest = @client.app_user?(appid: '341256')
+        stub.should have_been_requested
+        expect(rest).to eq(false)
+      end
+    end
+
+    describe '#has_app_permission?' do
+      it 'requests "hasAppPermission" api' do
+        stub = stub_post(:oauth_rest,
+                         '/passport/users/hasAppPermission',
+                         base_query.update({ ext_perm: 'netdisk' }))
+        stub.to_return(body: '{"result":"1"}')
+        rest = @client.has_app_permission? 'netdisk'
+        stub.should have_been_requested
+        expect(rest).to eq(true)
+      end
+
+      it 'requests "hasAppPermission" for specified user' do
+        stub = stub_post(:oauth_rest,
+                         '/passport/users/hasAppPermission',
+                         base_query.update({ ext_perm: 'super_msg', uid: '456123' }))
+        stub.to_return(body: '{"result":"0"}')
+        rest = @client.has_app_permission?('super_msg', '456123')
+        stub.should have_been_requested
+        expect(rest).to eq(false)
+      end
+    end
+
+    describe '#has_app_permissions' do
+      it 'requests "hasAppPermissions" api' do
+        stub = stub_post(:oauth_rest,
+                         '/passport/users/hasAppPermissions',
+                         base_query.update({ ext_perms: 'netdisk,basic' }))
+        stub.to_return(body: '{"basic":"1", "netdisk":"0"}')
+        rest = @client.has_app_permissions 'netdisk,basic'
+        stub.should have_been_requested
+        expect(rest[:basic]).to   eq(true)
+        expect(rest[:netdisk]).to eq(false)
+      end
+
+      it 'requests "hasAppPermissions" api with array of perms' do
+        stub = stub_post(:oauth_rest,
+                         '/passport/users/hasAppPermissions',
+                         base_query.update({ ext_perms: 'netdisk,basic' }))
+        stub.to_return(body: '{"basic":"1", "netdisk":"0"}')
+        rest = @client.has_app_permissions %w[netdisk basic]
+        stub.should have_been_requested
+        expect(rest[:basic]).to   eq(true)
+        expect(rest[:netdisk]).to eq(false)
+      end
+
+      it 'requests "hasAppPermissions" for specified user' do
+        stub = stub_post(:oauth_rest,
+                         '/passport/users/hasAppPermissions',
+                         base_query.update({ ext_perms: 'super_msg', uid: '456123' }))
+        stub.to_return(body: '{"super_msg":"0"}')
+        rest = @client.has_app_permissions('super_msg', '456123')
+        stub.should have_been_requested
+        expect(rest[:super_msg]).to eq(false)
+      end
+    end
+
+    describe '#get_friends' do
+      it 'requests with default params' do
+        stub = stub_post(:oauth_rest, '/friends/getFriends', base_query)
+        @client.get_friends
+        stub.should have_been_requested
+      end
+
+      it 'requests with custom params' do
+        stub = stub_post(:oauth_rest,
+                         '/friends/getFriends',
+                         base_query.update({ page_no: 3, page_size: 10, sort_type: 1 }))
+        @client.get_friends page_no: 3, page_size: 10, sort_type: 1
+        stub.should have_been_requested
+      end
+
+      it 'returns result of an array' do
+        stub = stub_post(:oauth_rest, '/friends/getFriends', base_query.update(page_size: 2))
+        stub.to_return(body: ft('get_friends.json'))
+        rest = @client.get_friends page_size: 2
+        stub.should have_been_requested
+        expect(rest).to be_a Array
+        expect(rest.size).to be(2)
+      end
+    end
+
+    describe '#are_friends' do
+      it 'requests with both string params' do
+        stub = stub_post(:oauth_rest,
+                         '/friends/areFriends',
+                         base_query.update(uids1: '111', uids2: '222'))
+        @client.are_friends '111', '222'
+        stub.should have_been_requested
+      end
+
+      it 'requests with both array params' do
+        stub = stub_post(:oauth_rest,
+                         '/friends/areFriends',
+                         base_query.update(uids1: '111,333', uids2: '222,444'))
+        @client.are_friends %w[111 333], %w[222 444]
+        stub.should have_been_requested
+      end
+
+      it 'requests with different param type' do
+        expect {
+          @client.are_friends '111', %w[222]
+        }.to raise_error ArgumentError, 'not the same types'
+      end
+
+      it 'requests with different size of array params' do
+        expect {
+          @client.are_friends %w[111], %w[222, 333]
+        }.to raise_error ArgumentError, 'not the same size of array'
+      end
+
+      it 'changes result with true or false' do
+        stub = stub_post(:oauth_rest,
+                         '/friends/areFriends',
+                         base_query.update(uids1: '111,333', uids2: '222,444'))
+        stub.to_return(body: ft('are_friends.json'))
+        rest = @client.are_friends %w[111 333], %w[222 444]
+        stub.should have_been_requested
+        expect(rest.first[:are_friends]).to eq(true)
+        expect(rest.first[:are_friends_reverse]).to eq(false)
+        expect(rest.last[:are_friends]).to eq(false)
+        expect(rest.last[:are_friends_reverse]).to eq(true)
+      end
+    end
+
+    describe '#expire_session' do
+      it 'requests "expireSession" api successfully' do
+        stub = stub_post(:oauth_rest,
+                         '/passport/auth/expireSession',
+                         base_query)
+        stub.to_return(body: '{"result":"1"}')
+        rest = @client.expire_session
+        stub.should have_been_requested
+        expect(rest).to eq(true)
+      end
+
+      it 'requests "expireSession" api unsuccessfully' do
+        stub = stub_post(:oauth_rest,
+                         '/passport/auth/expireSession',
+                         base_query)
+        stub.to_return(body: '{"result":"0"}')
+        rest = @client.expire_session
+        stub.should have_been_requested
+        expect(rest).to eq(false)
+      end
+    end
+
+    describe '#revoke_authorization' do
+      it 'requests "revokeAuthorization" api successfully' do
+        stub = stub_post(:oauth_rest,
+                         '/passport/auth/revokeAuthorization',
+                         base_query)
+        stub.to_return(body: '{"result":"1"}')
+        rest = @client.revoke_authorization
+        stub.should have_been_requested
+        expect(rest).to eq(true)
+      end
+
+      it 'requests "revokeAuthorization" api with uid successfully' do
+        stub = stub_post(:oauth_rest,
+                         '/passport/auth/revokeAuthorization',
+                         base_query.update({ uid: 123654 }))
+        stub.to_return(body: '{"result":"1"}')
+        rest = @client.revoke_authorization '123654'
+        stub.should have_been_requested
+        expect(rest).to eq(true)
+      end
+
+      it 'requests "revokeAuthorization" api unsuccessfully' do
+        stub = stub_post(:oauth_rest,
+                         '/passport/auth/revokeAuthorization',
+                         base_query)
+        stub.to_return(body: '{"result":"0"}')
+        rest = @client.revoke_authorization
+        stub.should have_been_requested
+        expect(rest).to eq(false)
+      end
+    end
+
+    describe '#query_ip' do
+      it 'requests single ip' do
+        stub = stub_get(:oauth_rest,
+                         '/iplib/query',
+                         base_query.update({ ip: '111.222.111.222' }))
+        stub.to_return(body: '{"111.222.111.222":{"province":"\u5e7f\u4e1c","city":"\u6df1\u5733"}}')
+        rest = @client.query_ip '111.222.111.222'
+        stub.should have_been_requested
+        expect(rest).to have_key(:'111.222.111.222')
+      end
+
+      it 'requests multiple ips' do
+        stub = stub_get(:oauth_rest,
+                         '/iplib/query',
+                         base_query.update({ ip: '111.222.111.222,8.8.8.8' }))
+        @client.query_ip '111.222.111.222', '8.8.8.8'
+        stub.should have_been_requested
+      end
+
+      it 'requests multiple ips as array' do
+        stub = stub_get(:oauth_rest,
+                         '/iplib/query',
+                         base_query.update({ ip: '111.222.111.222,8.8.8.8,8.8.4.4' }))
+        @client.query_ip ['111.222.111.222', '8.8.8.8', '8.8.4.4']
+        stub.should have_been_requested
+      end
+    end
+
+    describe 'when process error' do
+      it 'does not raise error' do
+        expect {
+          @client.send(:process_error, ['hi'])
+          @client.send(:process_error, {num: 0})
+          @client.send(:process_error, {error_code: 0})
+        }.not_to raise_error
+      end
+
+      it 'raises Baidu::Errors::Error' do
+        expect {
+          @client.send(:process_error, {error_code: 1})
+        }.to raise_error Baidu::Errors::Error
+      end
+
+      it 'raises Baidu::Errors::AuthError' do
+        expect {
+          @client.send(:process_error, {error_code: 110})
+        }.to raise_error Baidu::Errors::AuthError
+      end
+    end
+  end
+end

data/spec/fixtures/are_friends.json

@@ -0,0 +1,14 @@
+[
+  {
+    "uid1": "111",
+    "uid2": "222",
+    "are_friends": "1",
+    "are_friends_reverse": "0"
+  },
+  {
+    "uid1": " 333",
+    "uid2": "444",
+    "are_friends": "0",
+    "are_friends_reverse": "1"
+  }
+]

data/spec/fixtures/get_friends.json

@@ -0,0 +1,12 @@
+[
+  {
+    "uname": "spacebj009",
+    "uid": "2013411308",
+    "portrait": "79787370616365626a3030393306"
+  },
+  {
+    "uname": "spacebj003",
+    "uid": "2013412844",
+    "portrait": "73787370616365626a3030333306"
+  }
+]

data/spec/spec_helper.rb

@@ -35,6 +35,7 @@ end
 def webmock_url(mod, path)
   case mod
   when :oauth        then "https://openapi.baidu.com#{path}"
+  when :oauth_rest   then "https://openapi.baidu.com/rest/2.0#{path}"
   when :pcs          then "https://pcs.baidu.com/rest/2.0/pcs#{path}"
   when :pcs_upload   then "https://c.pcs.baidu.com/rest/2.0/pcs#{path}"
   when :pcs_download then "https://d.pcs.baidu.com/rest/2.0/pcs#{path}"
@@ -43,24 +44,35 @@ end
 
 def stub_get(mod, path, params={})
   req = stub_request :get, webmock_url(mod, path)
-  req.with(query: params) unless params.empty?
+  set_req_params :query, req, params
   req
 end
 
 def stub_post(mod, path, params={})
   req = stub_request :post, webmock_url(mod, path)
-  req.with(body: params) unless params.empty?
+  set_req_params :body, req, params
   req
 end
 
 def a_get(mod, path, params={})
   req = a_request :get, webmock_url(mod, path)
-  req.with(query: params) unless params.empty?
+  set_req_params :query, req, params
   req
 end
 
 def a_post(mod, path, params={})
   req = a_request :post, webmock_url(mod, path)
-  req.with(body: params) unless params.empty?
+  set_req_params :body, req, params
   req
 end
+
+private
+
+def set_req_params(type, req, params)
+  unless params.empty?
+    if params.is_a?(Hash)
+      params = URI.encode_www_form(params)
+    end
+    req.with(Hash[type, params])
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: baidu-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Lonre Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-05 00:00:00.000000000 Z
+date: 2013-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -66,6 +66,7 @@ files:
 - lib/baidu/oauth/flow/client_credentials.rb
 - lib/baidu/oauth/flow/device.rb
 - lib/baidu/oauth/flow/implicit_grant.rb
+- lib/baidu/oauth/rest_client.rb
 - lib/baidu/pcs.rb
 - lib/baidu/pcs/client.rb
 - lib/baidu/session.rb
@@ -75,16 +76,19 @@ files:
 - lib/baidu/version.rb
 - spec/baidu/core_spec.rb
 - spec/baidu/oauth/client_spec.rb
+- spec/baidu/oauth/rest_client_spec.rb
 - spec/baidu/pcs/client_spec.rb
 - spec/baidu/session_spec.rb
 - spec/baidu/support/request_spec.rb
 - spec/baidu/support/util_spec.rb
 - spec/fixtures/add_task.json
+- spec/fixtures/are_friends.json
 - spec/fixtures/cancel_task.json
 - spec/fixtures/copy.json
 - spec/fixtures/delete.json
 - spec/fixtures/diff.json
 - spec/fixtures/empty.json
+- spec/fixtures/get_friends.json
 - spec/fixtures/get_token_client_credentials.json
 - spec/fixtures/get_token_code.json
 - spec/fixtures/get_token_device.json
@@ -130,23 +134,26 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Unofficial Baidu REST API SDK for Ruby.
 test_files:
 - spec/baidu/core_spec.rb
 - spec/baidu/oauth/client_spec.rb
+- spec/baidu/oauth/rest_client_spec.rb
 - spec/baidu/pcs/client_spec.rb
 - spec/baidu/session_spec.rb
 - spec/baidu/support/request_spec.rb
 - spec/baidu/support/util_spec.rb
 - spec/fixtures/add_task.json
+- spec/fixtures/are_friends.json
 - spec/fixtures/cancel_task.json
 - spec/fixtures/copy.json
 - spec/fixtures/delete.json
 - spec/fixtures/diff.json
 - spec/fixtures/empty.json
+- spec/fixtures/get_friends.json
 - spec/fixtures/get_token_client_credentials.json
 - spec/fixtures/get_token_code.json
 - spec/fixtures/get_token_device.json