baidu-sdk 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 989e658f22320158d197a3dcad2a2bb02fd2bae0
-  data.tar.gz: 386a4d15d1237e93b6081d90c678328b6728774f
+  metadata.gz: e7d739a156a7feec33727249033320452ff730d1
+  data.tar.gz: 1db71954fe27d31241176786cab6ec5dbd18ae09
 SHA512:
-  metadata.gz: d1a83fcbeb4bd8eba7ebf195f2f9a62742be6271187288fbd346ed7e6dae040c343658760cc2230da600dd019ec681c848b4482307ca684e7a80667ae6c04d1e
-  data.tar.gz: cd3a8c489b63b9796988fadf59187825fbdf0d6eff4c4ba20f62863de57c622e636f8efa684e513ff978af847c320902505374a2de892479887e34aacffb4f39
+  metadata.gz: 7ea790ba81dabc1968e53664a95e30b741ba1d9c282d4631edeac230b9b2c9e631d359add53badf7636e7acda6dfff7f924ccf98ceeced42b166627766d9afe7
+  data.tar.gz: 19e130371ed9e9d9f804b0fbf60e1e6a6e4dc5c9df7f1b50e715cd3152b404c942a1594202194a8dd1e1b775c16bf6e74d126cb55b40bbbfeeaf8e690eab4780

data/HISTORY.md

@@ -1,2 +1,7 @@
+## 0.0.2 (2013-12-06)
+* **OAuth** 添加 Implicit Grant 授权流程
+* **OAuth** 添加 Client Credentials 授权流程
+* **OAuth** API 修改：Client#code_flow => Client#authorization_code_flow
+
 ## 0.0.1 (2013-11-28)
 * 首个版本

data/README.md

@@ -1,6 +1,7 @@
 # Baidu SDK for Ruby [![Build Status](https://travis-ci.org/lonre/baidu-sdk-ruby.png?branch=master)](https://travis-ci.org/lonre/baidu-sdk-ruby)
 
 Unofficial Baidu REST API SDK for Ruby.
+
 非官方百度开放接口 Ruby 开发包。
 
 ## 安装
@@ -26,10 +27,14 @@ Unofficial Baidu REST API SDK for Ruby.
 
 `Hash` 必须使用 `symbol` key，无论是返回值或作为参数传递给方法。
 
-涉及到调用 Baidu REST API 并返回 Hash 时，除非特别说明，Hash 是在原始 API 返回的 JSON 结果之上 `parse(JSON.parse(resp.body, symbolize_names: true))` 而来，Hash 和 JSON 拥有相同的结构，返回的具体结构可以参考各个方法的 API Doc。如：
+涉及到调用 Baidu REST API 并返回 Hash 时，此 Hash 返回值是在原始 API 返回的 JSON 数据之上 `parse(JSON.parse(resp.body, symbolize_names: true))` 而来。（特别说明返回值的除外，如：`Baidu::OAuth::Flow::Code#get_token` 返回 `Baidu::Session`）。Hash 和 JSON 拥有相同的结构，返回的具体结构可以参考各个方法的 API Doc。如：
+
 ```ruby
 # 返回的原始 JSON
 #   {"quota":15000000000,"used":5221166,"request_id":4043312634}
+#
+# result 是转换 JSON 后得到的 Hash
+#   {:quota=>15000000000, :used=>5221166, :request_id=>4043312634}
 result = pcs_client.quota
 result[:quota]  # => 15000000000
 result[:used]   # => 5221166
@@ -39,6 +44,7 @@ result[:used]   # => 5221166
 首先确保已经在百度开发者中心创建了应用。如果还没有创建应用，请通过此链接 [百度开发者中心](http://developer.baidu.com/console) 创建一个新的应用，获取应用的 `API Key` 和 `Secret Key`。
 
 1. 使用全局配置方式：
+
     ```ruby
     Baidu.config do |c|
       c.client_id     = 'an_api_key'
@@ -48,31 +54,64 @@ result[:used]   # => 5221166
     此全局配置为可选方式，还可以在新建 `Baidu::OAuth::Client` 实例的时候指定 `API Key` 和 `Secret Key`。
 
 2. 创建 Baidu::OAuth::Client 实例
+
+    首先，加载 `oauth` 库
+
     ```ruby
     require 'baidu/oauth'
+    ```
+    其次，创建实例
+
+    ```ruby
     client = Baidu::OAuth::Client.new
-    # 或者
+    # 或如下，为实例指定 client_id, client_secret
     client = Baidu::OAuth::Client.new('a_client_id', 'a_client_secret')
     ```
     后者创建的实例受全局配置影响
-3. Baidu OAuth 有四种（当前实现两种）获取 Access Token 的方式，包括 `Authorization Code`, `Implicit Grant`, `Client Credentials`, `Device`以及一个刷新方式`Refresh Token`
+
+3. Baidu OAuth 有四种获取 Access Token 的方式，包括 `Authorization Code`, `Implicit Grant`, `Client Credentials`, `Device`以及一个刷新方式`Refresh Token`
 
     ```ruby
-    client.code_flow.authorize_url  # 使用 Authorization Code 授权流程
-    client.code_flow.get_token      # 使用 Authorization Code 授权流程
-    client.device_flow.user_and_device_code  # 使用 Device 授权流程
-    client.device_flow.get_token             # 使用 Device 授权流程
-    client.refresh                           # Access Token刷新方式
+    # 使用 Authorization Code 授权流程，获取 Authorization URL
+    client.authorization_code_flow.authorize_url('callback_uri')
+
+    # 使用 Authorization Code 授权流程，获取 Access Token（Baidu::Session）
+    client.authorization_code_flow.get_token('code', 'callback_uri')
+
+    # 使用 Device 授权流程，获取 User Code 和 Device Code
+    client.device_flow.user_and_device_code
+
+    # 使用 Device 授权流程，获取 Access Token（Baidu::Session）
+    client.device_flow.get_token('code')
+
+    # 使用 Implicit Grant 授权流程
+    client.implicit_grant_flow.authorize_url('callback_uri')
+
+    # 使用 Implicit Grant 授权流程授权后，
+    # 客户端解析 callback_uri 中 Fragment 所携带参数获取 Access Token
+    # http://localhost:4567/auth/callback#expires_in=2592000&access_token=3.c79b45...
+
+    # 使用 Client Credentials 授权流程获取 Access Token
+    client.client_credentials_flow.get_token
+
+    # 刷新并获取新的 Access Token（Baidu::Session），所有流程均适用
+    client.refresh('refresh_token')
     ```
-4. `Baidu::Session` 包含授权信息
+
+4. `Baidu::Session` 授权信息
+
+    所有 `get_token` 及 `refresh` 均返回 `Baidu::Session`，包含授权信息，如：
 
     ```ruby
-    session = client.code_flow.get_token
-    session = client.device_flow.get_token
-    ...
+    session = client.device_flow.get_token('code')
+    puts session.access_token
+    puts session.refresh_token
+    puts session.scope
+    puts session.session_key
+    puts session.session_secret
     ```
 
-### Authorization Code 授权流程示例：
+### Sinatra Authorization Code 授权简单示例
 
 ```ruby
 # 1. Edit and save this snippet as code.rb
@@ -96,13 +135,13 @@ end
 
 get '/auth' do
   client = Baidu::OAuth::Client.new
-  redirect client.code_flow.authorize_url(callback_uri, confirm_login: true)
+  redirect client.authorization_code_flow.authorize_url(callback_uri, confirm_login: true)
 end
 
 get '/auth/callback' do
   begin
     client = Baidu::OAuth::Client.new
-    session = client.code_flow.get_token params[:code], callback_uri
+    session = client.authorization_code_flow.get_token params[:code], callback_uri
     "auth success: #{session.access_token}"
   rescue => e
     e.to_s
@@ -113,9 +152,12 @@ end
 ## PCS
 要使用 PCS 必须到 [百度开发者中心](http://developer.baidu.com/console) 开启指定应用的 PCS API 权限，参考 [开通PCS API权限](http://developer.baidu.com/wiki/index.php?title=docs/pcs/guide/api_approve)，并获取所设置的文件目录。
 
-文件 API 已经完全实现。API 中涉及到的文件或目录路径，都是相对于开通 PCS API 权限时所设置的文件目录。比如：上传文件时需要指定文件保存路径，假设指定为 `/mydata/hi.png`，那么在 PCS 中实际的保存路径为 `/apps/文件目录/mydata/hi.png`。
+PCS 服务 API 包括文件 API 以及结构化数据 API，目前已经实现全部文件 API。
+
+**API 中涉及到的文件或目录路径，都是相对于开通 PCS API 权限时所设置的文件目录**。比如：上传文件时需要指定文件保存路径，假设指定为 `/mydata/hi.png`，那么在 PCS 中实际的保存路径为 `/apps/文件目录/mydata/hi.png`。
 
 1. 全局配置
+
     ```ruby
     Baidu.config do |c|
         # ...
@@ -126,14 +168,22 @@ end
     全局配置非强制性的，可以在创建 `Baidu::PCS::Client` 实例时设置
 
 2. 创建 Baidu::PCS::Client 实例
+
+    首先，加载 `pcs` 库
+
     ```ruby
     require 'baidu/pcs'
+    ```
+    其次，创建实例
+
+    ```ruby
     client = Baidu::PCS::Client.new('token_or_session')
-    # 或者
+    # 或如下，为实例指定文件目录
     client = Baidu::PCS::Client.new('token_or_session', 'notes')
     ```
 
 3. API 调用
+
     ```ruby
     File.open('/opt/ubuntu-12.04.3-server-amd64.iso', 'r') do |f|
         client.upload(f, block_upload: true)
@@ -143,11 +193,14 @@ end
 ## 异常处理
 API 的异常被封装为 `Baidu::Errors::Error`，包含三个子类：
 
-1. `Baidu::Errors::AuthError`    # Access Token 过期或未授权
-2. `Baidu::Errors::ClientError`  # API 返回 `400+` 错误
-3. `Baidu::Errors::ServerError`  # API 返回 `500+` 错误
+```
+1. Baidu::Errors::AuthError    # 未授权或 Access Token 过期
+2. Baidu::Errors::ClientError  # API 返回 400+ 错误
+3. Baidu::Errors::ServerError  # API 返回 500+ 错误
+```
 
 `Baidu::Errors::Error => e`，异常的具体信息可以通过如下方式获取到：
+
 ```ruby
 begin
     client.list('apitest/movies')

data/lib/baidu/oauth.rb

@@ -6,6 +6,7 @@ module Baidu
     SITE                   = 'https://openapi.baidu.com'
     AUTHORIZATION_ENDPOINT = '/oauth/2.0/authorize'
     TOKEN_ENDPOINT         = '/oauth/2.0/token'
+    TOKEN_INFO_ENDPOINT    = '/oauth/2.0/tokeninfo'
     DEVICE_ENDPOINT        = '/oauth/2.0/device/code'
   end
 end

data/lib/baidu/oauth/client.rb

@@ -1,7 +1,9 @@
 # encoding: UTF-8
 
-require 'baidu/oauth/flow/code'
+require 'baidu/oauth/flow/authorization_code'
 require 'baidu/oauth/flow/device'
+require 'baidu/oauth/flow/implicit_grant'
+require 'baidu/oauth/flow/client_credentials'
 
 module Baidu
   module OAuth
@@ -27,17 +29,30 @@ module Baidu
         @site          = Baidu::OAuth::SITE
       end
 
-      # @!method code_flow
+      # @!method authorization_code_flow
       #   采用 Authorization Code 获取 Access Token 的授权验证流程
-      #   @return [Flow::Code]
+      #   @return [Flow::AuthorizationCode]
+      #
       # @!method device_flow
       #   采用 Device Code 获取 Access Token 的授权验证流程
       #   @return [Flow::Device]
-      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/authorization Authorization Code
-      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/device Device
-      [:code, :device].each do |flow|
+      #
+      # @!method implicit_grant_flow
+      #   采用 Implicit Grant 方式获取 Access Token 的授权验证流程
+      #   @return [Flow::ImplicitGrant]
+      #
+      # @!method client_credentials_flow
+      #   使用 Client Credentials 获取 Access Token 的授权验证流程
+      #   @return [Flow::ClientCredentials]
+      #
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/authorization Authorization Code 授权
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/device Device 授权
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/implicit Implicit Grant 授权
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/client Client Credentials 授权
+      [:authorization_code, :device, :implicit_grant, :client_credentials].each do |flow|
         define_method("#{flow}_flow".to_sym) do
-          Baidu::OAuth::Flow.const_get(flow.capitalize).new self
+          klass_name = flow.to_s.split('_').map { |s| s.capitalize }.join
+          Baidu::OAuth::Flow.const_get(klass_name).new self
         end
       end
 
@@ -61,6 +76,34 @@ module Baidu
         return nil if rest.nil?
         Baidu::Session.from rest
       end
+
+      # 查询Access Token对应的授权信息
+      #
+      # 该接口用于查询Access Token对应的授权相关信息，
+      # 包括授权对象(应用)、授权用户、授权的权限、授权时间，过期时间。
+      # @example 返回的原始 JSON
+      #   {
+      #       "client_id": "ZLycGmiUcCkrSb3t7zSD8uV6",
+      #       "userid": 689911016,
+      #       "scope": "basic super_msg",
+      #       "create_time": 1364555477,
+      #       "expire_in": 2591980
+      #   }
+      #
+      #   :client_id   Access Token对应应用的Api Key
+      #   :userid      授权用户的唯一id。如果Access Token是通过Client Credentials授权方式 获取的，则该字段值为0
+      #   :scope       Access Token最终的访问范围，即用户实际授予的权限列表（用户在授权页面时，有可能会取消掉某些请求的权限）
+      #   :create_time Access Token的生成时间(Unix时间戳)，以秒为单位
+      #   :expires_in  Access Token剩余的有效时间，以秒为单位
+      #
+      # @param [String] access_token 授权之后应用得到的Access Token
+      # @return [Hash]
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/tokeninfo 校验Access Token
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/list 权限列表
+      def token_info(access_token)
+        body = { access_token: access_token }
+        return post Baidu::OAuth::TOKEN_INFO_ENDPOINT, nil, body
+      end
     end
   end
 end

data/lib/baidu/oauth/flow/{code.rb → authorization_code.rb}

@@ -10,20 +10,21 @@ module Baidu
       # 适用于所有有Server端的应用，如Web/Wap站点、有Server端的手机/桌面客户端应用等。
       #
       # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/authorization Authorization Code授权
-      class Code
-        include Base
+      class AuthorizationCode < Base
+        include Authable
+        include Tokenable
 
-        # 通过 Device Code 来获取 Access Token
+        # 通过获得的 Authorization Code，换取一个 Access Token
         #
         # @note 每一个 Authorization Code 的有效期为10分钟，并且只能使用一次，再次使用将无效。
         #
         # 如果用户在此页面同意授权，授权服务则将重定向用户浏览器到应用所指定的“redirect_uri”，
         # 并附带上表示授权服务所分配的 Authorization Code 的 +code+ 参数，以及 state 参数（如果请求authorization code时带了这个参数）。
         #
-        # @param [String] code 所获得的 Authorization Code (redirect_uri 附带的 {code} 参数)
+        # @param [String] code 所获得的 Authorization Code (redirect_uri 附带的 code 参数)
+        # @param [String] redirect_uri 该值必须与获取 Authorization Code 时传递的 “redirect_uri” 保持一致
         # @return [Baidu::Session]
-        # @see #user_and_device_code
-        # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/device 通过Device Code获取Access Token
+        # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/authorization Authorization Code授权
         # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/overview Access Token生命周期
         def get_token(code, redirect_uri); super end
 
@@ -44,15 +45,11 @@ module Baidu
         # @option params [Boolean] :force_login +true+ 表示加载登录页时强制用户输入用户名和口令，不会从cookie中读取百度用户的登陆状态
         # @option params [Boolean] :confirm_login +true+ 表示且百度用户已处于登陆状态，会提示是否使用已当前登陆用户对应用授权
         # @return [String]
+        # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/authorization Authorization Code授权
         # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/list 权限列表
         # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/set 页面设置
         # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/redirect 授权回调地址
-        def authorize_url(redirect_uri, params={})
-          opts = {}.update(params)
-          opts.update({ force_login: 1 })   if params[:force_login]
-          opts.update({ confirm_login: 1 }) if params[:confirm_login]
-          super redirect_uri, opts
-        end
+        def authorize_url(redirect_uri, params={}); super end
 
         private
 

data/lib/baidu/oauth/flow/base.rb

@@ -3,26 +3,41 @@
 module Baidu
   module OAuth
     module Flow
-      module Base
-        include Baidu::Support
+
+      # 所有授权流程基类
+      class Base
 
         # 此授权流程对应的 OAuth Client 实例
+        # @return [Baidu::OAuth::Client]
         attr_reader :client
 
         def initialize(client)
           @client = client
         end
+      end
+
+      # @private
+      module Authable
+        include Baidu::Support
 
+        # Sub class must implement +authorize_query+ method
         def authorize_url(redirect_uri, params={})
           query = authorize_query.update params
           query.update({ client_id: self.client.client_id, redirect_uri: redirect_uri })
+          query.update({ force_login: 1 })   if params[:force_login]
+          query.update({ confirm_login: 1 }) if params[:confirm_login]
           Util.clean_params query
           uri = URI(self.client.site)
-          uri.path  = authorize_endpoint
+          uri.path  = Baidu::OAuth::AUTHORIZATION_ENDPOINT
           uri.query = Util.encode_params(query) unless Util.blank? query
           uri.to_s
         end
+      end
+
+      # @private
+      module Tokenable
 
+        # Sub class must implement +token_body+ method
         def get_token(code, redirect_uri=nil, params={})
           body = token_body.update params
           body.update({ client_id: self.client.client_id,
@@ -32,12 +47,6 @@ module Baidu
           return nil if rest.nil?
           Baidu::Session.from rest
         end
-
-        private
-
-        def authorize_endpoint
-          Baidu::OAuth::AUTHORIZATION_ENDPOINT
-        end
       end
     end
   end

data/lib/baidu/oauth/flow/client_credentials.rb

@@ -0,0 +1,37 @@
+# encoding: UTF-8
+
+require 'baidu/oauth/flow/base'
+
+module Baidu
+  module OAuth
+    module Flow
+
+      # 采用Client Credentials方式，即应用公钥、密钥方式获取Access Token，
+      # 适用于任何类型应用，但通过它所获取的Access Token只能用于访问与用户无关的Open API，
+      # 并且需要开发者提前向百度开放平台申请，成功对接后方能使用。
+      # 对于应用而言，其流程只有一步，即直接获取Access Token。
+      #
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/client Client Credentials授权
+      class ClientCredentials < Base
+        include Tokenable
+
+        # 使用 Client Credentials 获取 Access Token
+        #
+        # @param [String] scope Access Token最终的访问范围，即用户实际授予的权限列表
+        # @return [Baidu::Session]
+        # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/client Client Credentials授权
+        # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/list 权限列表
+        # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/overview Access Token生命周期
+        def get_token(scope=nil)
+          super(nil, nil, scope: scope)
+        end
+
+        private
+
+        def token_body
+          { grant_type: 'client_credentials' }
+        end
+      end
+    end
+  end
+end

data/lib/baidu/oauth/flow/device.rb

@@ -10,9 +10,10 @@ module Baidu
       # 填写User Code并授权、以及通过Device Code获取Access Token这3步组成。
       #
       # @note 使用此授权流程，对于终端类型的应用也非常方便，同时还可以获取 Refresh Token
+      #
       # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/device Device授权
-      class Device
-        include Base
+      class Device < Base
+        include Tokenable
 
         # 获取 User Code 和 Device Code
         # @example 返回的原始 JSON
@@ -35,11 +36,12 @@ module Baidu
         #
         # @param [String] scope 非必须参数，以空格分隔的权限列表
         # @return [Hash]
+        # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/device Device授权
         # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/list 权限列表
         def user_and_device_code(scope=nil)
           query = authorize_query.update({ client_id: self.client.client_id })
           query[:scope] = scope unless scope.nil?
-          self.client.get(authorize_endpoint, query)
+          self.client.get(Baidu::OAuth::DEVICE_ENDPOINT, query)
         end
 
         # 通过 Device Code 来获取 Access Token
@@ -47,15 +49,10 @@ module Baidu
         # @param [String] code {#user_and_device_code} 所获得的 Device Code
         # @return [Baidu::Session]
         # @see #user_and_device_code
-        # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/device 通过Device Code获取Access Token
+        # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/device Device授权
         # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/overview Access Token生命周期
         def get_token(code); super end
 
-        # @private
-        def authorize_url
-          raise NoMethodError, 'no such method in device flow'
-        end
-
         private
 
         def authorize_query
@@ -65,10 +62,6 @@ module Baidu
         def token_body
           { grant_type: 'device_token' }
         end
-
-        def authorize_endpoint
-          Baidu::OAuth::DEVICE_ENDPOINT
-        end
       end
     end
   end

data/lib/baidu/oauth/flow/implicit_grant.rb

@@ -0,0 +1,57 @@
+# encoding: UTF-8
+
+require 'baidu/oauth/flow/base'
+
+module Baidu
+  module OAuth
+    module Flow
+
+      # 采用Implicit Grant方式获取Access Token的授权验证流程又被称为User-Agent Flow，
+      # 适用于所有无Server端配合的应用（由于应用往往位于一个User Agent里，如浏览器里面，
+      # 因此这类应用在某些平台下又被称为Client-Side Application），如手机/桌面客户端程序、浏览器插件等，
+      # 以及基于JavaScript等脚本客户端脚本语言实现的应用，他们的一个共同特点是，
+      # 应用无法妥善保管其应用密钥（App Secret Key）
+      #
+      # @note 采用Implicit Grant方式获取Access Token时，不会返回Refresh Token。
+      # @note
+      #   为了保证安全性，建议应用从授权回调地址接收到Access Token之后，
+      #   调用Access Token验证接口判断该Access Token是否对应自身的Api Key。
+      #
+      # @see Client#token_info
+      # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/implicit Implicit Grant授权
+      class ImplicitGrant < Base
+        include Authable
+
+        # 获取 Authorization URL
+        #
+        # @note
+        #   为了加强安全性，会对跳转到该授权页面的Referer进行检测，
+        #   要求Referer必须与开发者创建应用时注册的"网站地址"或者在“OAuth安全设置”中所填写的"根域名绑定"同域。
+        #
+        # @param [String] redirect_uri
+        #   授权后要回调的URI，即接受Access Token的URI。
+        #   如果用户在授权过程中取消授权，会回调该URI，并在URI末尾附上error=access_denied参数。
+        #   对于无Web Server的应用，其值可以是“oob”，授权后会回调OAuth提供的一个默认页面。
+        #   如果redirect_uri不为"oob"，则redirect_uri指向的页面必须与开发者在“OAuth安全设置”中所填写的"授权回调地址"相匹配。
+        # @option params [String] :scope 以空格分隔的权限列表，若不传递此参数，代表请求用户的默认权限
+        # @option params [String] :state
+        #   用于保持请求和回调的状态，授权服务器在回调时（重定向用户浏览器到“redirect_uri”时），会在Fragment中原样回传该参数。
+        # @option params [String] :display 登录和授权页面的展现样式，默认为“page”
+        # @option params [Boolean] :force_login +true+ 表示加载登录页时强制用户输入用户名和口令，不会从cookie中读取百度用户的登陆状态
+        # @option params [Boolean] :confirm_login +true+ 表示且百度用户已处于登陆状态，会提示是否使用已当前登陆用户对应用授权
+        # @return [String]
+        # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/implicit Implicit Grant授权
+        # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/list 权限列表
+        # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/set 页面设置
+        # @see http://developer.baidu.com/wiki/index.php?title=docs/oauth/redirect 授权回调地址
+        def authorize_url(redirect_uri, params={}); super end
+
+        private
+
+        def authorize_query
+          { response_type: 'token', display: 'page' }
+        end
+      end
+    end
+  end
+end

data/lib/baidu/version.rb

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

data/spec/baidu/oauth/client_spec.rb

@@ -44,25 +44,38 @@ describe Baidu::OAuth::Client do
   end
 
   context '#authorize_url' do
-    it 'generates "Authorization Code" authorize url' do
-      url = @client.code_flow.authorize_url('oob')
-      expect(url).to eq("#{authorization_endpoint}?response_type=code&display=page&" \
-                        "client_id=ci&redirect_uri=oob")
-    end
+    context 'with code flow' do
+      it 'generates "Authorization Code" authorize url' do
+        url = @client.authorization_code_flow.authorize_url('oob')
+        expect(url).to eq("#{authorization_endpoint}?response_type=code&display=page&" \
+                          "client_id=ci&redirect_uri=oob")
+      end
 
-    it 'generates "Authorization Code" authorize url with params' do
-      url = @client.code_flow.authorize_url('http://www.example.com/oauth_redirect',
-                                              scope: 'email', state: 'xyz', display: 'tv',
-                                              force_login: 1, confirm_login: 1)
-      expect(url).to eq("#{authorization_endpoint}?response_type=code&display=tv&" \
-                        "scope=email&state=xyz&force_login=1&confirm_login=1&client_id=ci&" \
-                        "redirect_uri=http%3A%2F%2Fwww.example.com%2Foauth_redirect")
+      it 'generates "Authorization Code" authorize url with params' do
+        url = @client.authorization_code_flow.authorize_url('http://www.example.com/oauth_redirect',
+                                                scope: 'email', state: 'xyz', display: 'tv',
+                                                force_login: true, confirm_login: true)
+        expect(url).to eq("#{authorization_endpoint}?response_type=code&display=tv&" \
+                          "scope=email&state=xyz&force_login=1&confirm_login=1&client_id=ci&" \
+                          "redirect_uri=http%3A%2F%2Fwww.example.com%2Foauth_redirect")
+      end
     end
 
-    it 'raises error when using device flow' do
-      expect {
-        @client.device_flow.authorize_url
-      }.to raise_error(NoMethodError, 'no such method in device flow')
+    context 'with implicit flow' do
+      it 'generates "Implicit Grant" authorize url' do
+        url = @client.implicit_grant_flow.authorize_url('oob')
+        expect(url).to eq("#{authorization_endpoint}?response_type=token&display=page&" \
+                          "client_id=ci&redirect_uri=oob")
+      end
+
+      it 'generates "Implicit Grant" authorize url with params' do
+        url = @client.implicit_grant_flow.authorize_url('http://www.example.com/oauth_redirect',
+                                                scope: 'basic email', state: 'xyz', display: 'mobile',
+                                                force_login: true, confirm_login: true)
+        expect(url).to eq("#{authorization_endpoint}?response_type=token&display=mobile&" \
+                          "scope=basic+email&state=xyz&force_login=1&confirm_login=1&client_id=ci&" \
+                          "redirect_uri=http%3A%2F%2Fwww.example.com%2Foauth_redirect")
+      end
     end
   end
 
@@ -112,7 +125,7 @@ describe Baidu::OAuth::Client do
       end
 
       it 'requests access tokey' do
-        @client.code_flow.get_token 'ANXxSNjwQDugOnqeikRMu2bKaXCdlLxn',
+        @client.authorization_code_flow.get_token 'ANXxSNjwQDugOnqeikRMu2bKaXCdlLxn',
                                      'http://www.example.com/oauth_redirect'
         a_post(:oauth, '/oauth/2.0/token',
                 grant_type: 'authorization_code',
@@ -122,7 +135,7 @@ describe Baidu::OAuth::Client do
       end
 
       it 'responses access token' do
-        result = @client.code_flow.get_token 'ANXxSNjwQDugOnqeikRMu2bKaXCdlLxn',
+        result = @client.authorization_code_flow.get_token 'ANXxSNjwQDugOnqeikRMu2bKaXCdlLxn',
                                               'http://www.example.com/oauth_redirect'
         expect(result).to be_instance_of(Baidu::Session)
         expect(result).to respond_to(:access_token)
@@ -140,7 +153,7 @@ describe Baidu::OAuth::Client do
           to_return(status: 200, body: ft('get_token_device.json'))
       end
 
-      it 'requests access tokey' do
+      it 'requests access token' do
         @client.device_flow.get_token 'a82hjs723h72h3a82hjs723h72h3vb'
         a_post(:oauth, '/oauth/2.0/token', grant_type: 'device_token',
                code: 'a82hjs723h72h3a82hjs723h72h3vb',
@@ -159,6 +172,36 @@ describe Baidu::OAuth::Client do
     end
   end
 
+  context 'with client credentials' do
+    let(:base_params) do
+      { grant_type: 'client_credentials', client_id: 'ci', client_secret: 'cs' }
+    end
+
+    it 'requests access token' do
+      stub = stub_post(:oauth, '/oauth/2.0/token', base_params)
+      @client.client_credentials_flow.get_token
+      stub.should have_been_requested
+    end
+
+    it 'requests access token with scope' do
+      stub = stub_post(:oauth, '/oauth/2.0/token', base_params.update({ scope: 'basic hao123' }))
+      @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'))
+      result = @client.client_credentials_flow.get_token
+      expect(result).to be_instance_of(Baidu::Session)
+      expect(result).to respond_to(:access_token)
+      expect(result).to respond_to(:refresh_token)
+      expect(result).to respond_to(:scope)
+      expect(result).to respond_to(:session_key)
+      expect(result).to respond_to(:session_secret)
+    end
+  end
+
   context '#refresh_token' do
     before do
       stub_post(:oauth, '/oauth/2.0/token', grant_type: 'refresh_token',
@@ -196,4 +239,14 @@ describe Baidu::OAuth::Client do
       expect(result).to respond_to(:session_secret)
     end
   end
+
+  context '#token_info' do
+    it 'requests token info' do
+      stub = stub_post(:oauth, '/oauth/2.0/tokeninfo', access_token: 'xxxx').
+          to_return(status: 200, body: ft('token_info.json'))
+      rest = @client.token_info('xxxx')
+      stub.should have_been_requested
+      expect(rest).to be_instance_of(Hash)
+    end
+  end
 end

data/spec/fixtures/get_token_client_credentials.json

@@ -0,0 +1,8 @@
+{
+  "access_token": "1.a6b7dbd428f731035f771b8d15063f61.86400.1292922000-2346678-124328",
+  "expires_in": 86400,
+  "refresh_token": "2.385d55f8615fdfd9edb7c4b5ebdc3e39.604800.1293440400-2346678-124328",
+  "scope": "public",
+  "session_key": "ANXxSNjwQDugf8615OnqeikRMu2bKaXCdlLxn",
+  "session_secret": "248APxvxjCZ0VEC43EYrvxqaK4oZExMB"
+}

data/spec/fixtures/token_info.json

@@ -0,0 +1,7 @@
+{
+    "client_id": "ZLycGmiUcCkrSb3t7zSD8uV6",
+    "userid": 689911016,
+    "scope": "basic super_msg",
+    "create_time": 1364555477,
+    "expire_in": 2591980
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: baidu-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Lonre Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-27 00:00:00.000000000 Z
+date: 2013-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -61,9 +61,11 @@ files:
 - lib/baidu/errors/error.rb
 - lib/baidu/oauth.rb
 - lib/baidu/oauth/client.rb
+- lib/baidu/oauth/flow/authorization_code.rb
 - lib/baidu/oauth/flow/base.rb
-- lib/baidu/oauth/flow/code.rb
+- lib/baidu/oauth/flow/client_credentials.rb
 - lib/baidu/oauth/flow/device.rb
+- lib/baidu/oauth/flow/implicit_grant.rb
 - lib/baidu/pcs.rb
 - lib/baidu/pcs/client.rb
 - lib/baidu/session.rb
@@ -83,6 +85,7 @@ files:
 - spec/fixtures/delete.json
 - spec/fixtures/diff.json
 - spec/fixtures/empty.json
+- spec/fixtures/get_token_client_credentials.json
 - spec/fixtures/get_token_code.json
 - spec/fixtures/get_token_device.json
 - spec/fixtures/list.json
@@ -102,6 +105,7 @@ files:
 - spec/fixtures/search.json
 - spec/fixtures/stream_list.json
 - spec/fixtures/streaming.m3u8
+- spec/fixtures/token_info.json
 - spec/fixtures/upload.json
 - spec/fixtures/upload_block.json
 - spec/fixtures/user_and_device_code.json
@@ -143,6 +147,7 @@ test_files:
 - spec/fixtures/delete.json
 - spec/fixtures/diff.json
 - spec/fixtures/empty.json
+- spec/fixtures/get_token_client_credentials.json
 - spec/fixtures/get_token_code.json
 - spec/fixtures/get_token_device.json
 - spec/fixtures/list.json
@@ -162,6 +167,7 @@ test_files:
 - spec/fixtures/search.json
 - spec/fixtures/stream_list.json
 - spec/fixtures/streaming.m3u8
+- spec/fixtures/token_info.json
 - spec/fixtures/upload.json
 - spec/fixtures/upload_block.json
 - spec/fixtures/user_and_device_code.json