baidu-sdk 0.0.1

data/lib/baidu/session.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+
+module Baidu
+  class Session
+    # 用户身份验证和授权的凭证
+    # @return [String]
+    attr_accessor :access_token
+    # 用于刷新 Access Token 的 Refresh Token，并不是所有应用都会返回该参数（10年的有效期）
+    # @return [String]
+    attr_accessor :refresh_token
+    # Access Token 最终的访问范围，即用户实际授予的权限列表
+    # @return [String]
+    attr_accessor :scope
+    # 基于 http 调用 Open API 时所需要的 Session Key
+    # @return [String]
+    attr_accessor :session_key
+    # 基于 http 调用 Open API 时计算参数签名用的签名密钥
+    # @return [String]
+    attr_accessor :session_secret
+
+    class << self
+      # 根据 Hash 数据创建一个新的 +Session+ 实例
+      # @param [Hash] hash 包含 Session 所需数据的 Hash
+      # @return [Session]
+      def from(hash)
+        session = Session.new
+        session.access_token   = hash[:access_token]
+        session.refresh_token  = hash[:refresh_token]
+        session.scope          = hash[:scope]
+        session.session_key    = hash[:session_key]
+        session.session_secret = hash[:session_secret]
+        session
+      end
+    end
+  end
+end

data/lib/baidu/support/cacert.pem

@@ -0,0 +1,37 @@
+VeriSign Class 3 International Server CA - G3
+=============================================
+-----BEGIN CERTIFICATE-----
+MIIGKTCCBRGgAwIBAgIQZBvoIM4CCBPzLU0tldZ+ZzANBgkqhkiG9w0BAQUFADCB
+yjELMAkGA1UEBhMCVVMxFzAVBgNVBAoTDlZlcmlTaWduLCBJbmMuMR8wHQYDVQQL
+ExZWZXJpU2lnbiBUcnVzdCBOZXR3b3JrMTowOAYDVQQLEzEoYykgMjAwNiBWZXJp
+U2lnbiwgSW5jLiAtIEZvciBhdXRob3JpemVkIHVzZSBvbmx5MUUwQwYDVQQDEzxW
+ZXJpU2lnbiBDbGFzcyAzIFB1YmxpYyBQcmltYXJ5IENlcnRpZmljYXRpb24gQXV0
+aG9yaXR5IC0gRzUwHhcNMTAwMjA4MDAwMDAwWhcNMjAwMjA3MjM1OTU5WjCBvDEL
+MAkGA1UEBhMCVVMxFzAVBgNVBAoTDlZlcmlTaWduLCBJbmMuMR8wHQYDVQQLExZW
+ZXJpU2lnbiBUcnVzdCBOZXR3b3JrMTswOQYDVQQLEzJUZXJtcyBvZiB1c2UgYXQg
+aHR0cHM6Ly93d3cudmVyaXNpZ24uY29tL3JwYSAoYykxMDE2MDQGA1UEAxMtVmVy
+aVNpZ24gQ2xhc3MgMyBJbnRlcm5hdGlvbmFsIFNlcnZlciBDQSAtIEczMIIBIjAN
+BgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmdacYvAV9IGaQQhZjxOdF8mfUdza
+sVLv/+NB3eDfxCjG4615HycQmLi7IJfBKERBD+qpqFLPTU4bi7u1xHbZzFYG7rNV
+ICreFY1xy1TIbxfNiQDk3P/hwB9ocenHKS5+vDv85burJlSLZpDN9pK5MSSAvJ5s
+1fx+0uFLjNxC+kRLX/gYtS4w9D0SmNNiBXNUppyiHb5SgzoHRsQ7AlYhv/JRT9Cm
+mTnprqU/iZucff5NYAclIPe712mDK4KTQzfZg0EbawurSmaET0qO3n40mY5o1so5
+BptMs5pITRNGtFghBMT7oE2sLktiEuP7TfbJUQABH/weaoEqOOC5T9YtRQIDAQAB
+o4ICFTCCAhEwEgYDVR0TAQH/BAgwBgEB/wIBADBwBgNVHSAEaTBnMGUGC2CGSAGG
++EUBBxcDMFYwKAYIKwYBBQUHAgEWHGh0dHBzOi8vd3d3LnZlcmlzaWduLmNvbS9j
+cHMwKgYIKwYBBQUHAgIwHhocaHR0cHM6Ly93d3cudmVyaXNpZ24uY29tL3JwYTAO
+BgNVHQ8BAf8EBAMCAQYwbQYIKwYBBQUHAQwEYTBfoV2gWzBZMFcwVRYJaW1hZ2Uv
+Z2lmMCEwHzAHBgUrDgMCGgQUj+XTGoasjY5rw8+AatRIGCx7GS4wJRYjaHR0cDov
+L2xvZ28udmVyaXNpZ24uY29tL3ZzbG9nby5naWYwNAYDVR0lBC0wKwYIKwYBBQUH
+AwEGCCsGAQUFBwMCBglghkgBhvhCBAEGCmCGSAGG+EUBCAEwNAYIKwYBBQUHAQEE
+KDAmMCQGCCsGAQUFBzABhhhodHRwOi8vb2NzcC52ZXJpc2lnbi5jb20wNAYDVR0f
+BC0wKzApoCegJYYjaHR0cDovL2NybC52ZXJpc2lnbi5jb20vcGNhMy1nNS5jcmww
+KAYDVR0RBCEwH6QdMBsxGTAXBgNVBAMTEFZlcmlTaWduTVBLSS0yLTcwHQYDVR0O
+BBYEFNebfNgioBX33a1fzimbWMO8RgC1MB8GA1UdIwQYMBaAFH/TZafC3ey78DAJ
+80M5+gKvMzEzMA0GCSqGSIb3DQEBBQUAA4IBAQBxtX1zUkrd1000Ky6vlEalSVAC
+T/gvF3DyE9wfIYaqwk98NzzURniuXXhv0bpavBCrWDbFjGIVRWAXIeLVQqh3oVXY
+QwRR9m66SOZdTLdE0z6k1dYzmp8N5tdOlkSVWmzWoxZTDphDzqS4w2Z6BVxiEOgb
+Ett9LnZQ/9/XaxvMisxx+rNAVnwzeneUW/ULU/sOX7xo+68q7jA3eRaTJX9NEP9X
++79uOzMh3nnchhdZLUNkt6Zmh+q8lkYZGoaLb9e3SQBb26O/KZru99MzrqP0nkzK
+XmnUG623kHdq2FlveasB+lXwiiFm5WVu/XzT3x7rfj8GkPsZC9MGAht4Q5mo
+-----END CERTIFICATE-----

data/lib/baidu/support/request.rb

@@ -0,0 +1,127 @@
+# encoding: UTF-8
+
+module Baidu
+  module Support
+    module Request
+      include Baidu::Support
+
+      # 最多重定向次数
+      MAX_REDIRECT_LIMIT = 10
+
+      # 发送 GET 请求
+      #
+      # @param [String] path
+      # @param [Hash] query 自动清理 value 为 nil 的数据
+      # @option options [String] :site
+      # @option options [Boolean] :raw  直接返回 response.body
+      # @option options [Hash] :headers
+      # @yield [segment] 可选，如果提供 block，则以流的方式获取内容
+      def get(path, query={}, options={}, &block)
+        url  = build_url path, query, options[:site]
+        req = Net::HTTP::Get.new(url, options[:headers])
+        if block_given?
+          request(req) do |resp|
+            resp.read_body &block
+          end
+        else
+          request(req, nil, options[:raw])
+        end
+      end
+
+      # 发送 POST 请求
+      #
+      # @param [String] path
+      # @param [Hash] query 自动清理 value 为 nil 的数据
+      # @param [Hash] body  自动清理 value 为 nil 的数据，可以包含响应 +#read+ 的对象，如：+File+
+      # @option options [String] :site
+      def post(path, query={}, body={}, options={})
+        uri = build_url path, query, options[:site]
+        Util.clean_params(body)
+        if body.select{ |_, v| v.respond_to? :read }.empty?
+          req = Net::HTTP::Post.new uri
+          req.body = (body.empty? ? nil : Util.encode_params(body))
+        else
+          require 'net/http/post/multipart'
+          body.each { |k, v| body[k] = UploadIO.new v, 'application/octet-stream' if v.respond_to? :read }
+          req = Net::HTTP::Post::Multipart.new uri, body
+        end
+        request req
+      end
+
+      private
+
+      def request(req, body=nil, raw=false, limit=0, &block)
+        uri = URI(req.path)
+        http = Net::HTTP.new uri.host, uri.port
+        # trick for 1.9 support, just use req.uri for ruby version 2
+        path_uri = URI(uri.path)
+        path_uri.query = uri.query
+        req.instance_variable_set(:@path, path_uri.to_s)
+        # end trick
+        http.set_debug_output $stdout if Baidu.debug
+        http.use_ssl = uri.scheme == 'https'
+        if http.use_ssl?
+          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+          http.cert_store = OpenSSL::X509::Store.new
+          http.cert_store.set_default_paths
+          http.cert_store.add_file File.expand_path('../cacert.pem', __FILE__)
+        end
+
+        req['User-Agent'] = "UnofficialRubySDK/baidu-sdk/#{Baidu::VERSION}"
+
+        if block_given?
+          # To avoid read_body read called twice
+          return http.request req, body, &block
+        else
+          resp = http.request req, body
+          resp_body = resp.body
+
+          # when raw, return quickly without JSON parse
+          return resp_body if resp.is_a?(Net::HTTPSuccess) && raw
+
+          resp_hash = begin
+                        JSON.parse(resp_body, symbolize_names: true) unless resp_body.nil?
+                      rescue
+                        nil
+                      end || {}
+
+          case resp
+          when Net::HTTPSuccess
+            return resp_hash
+          when Net::HTTPRedirection
+            # Process redirection
+            limit += 1
+            return process_redirect resp['Location'], raw, limit
+          end
+
+          # error
+          err = case resp
+                when Net::HTTPUnauthorized then Baidu::Errors::AuthError
+                when Net::HTTPClientError  then Baidu::Errors::ClientError
+                when Net::HTTPServerError  then Baidu::Errors::ServerError
+                else Baidu::Errors::Error
+                end
+
+          code = resp_hash.nil? ? resp.code : (resp_hash[:error_code] || resp_hash[:error])
+          msg  = resp_hash.nil? ? resp.msg  : (resp_hash[:error_msg]  || resp_hash[:error_description])
+          raise err.new(msg, code, resp)
+        end
+      end
+
+      def build_url(path, query, site)
+        uri = URI(site || @site)
+        uri.path = path
+        unless Util.blank? query
+          Util.clean_params query
+          uri.query = Util.encode_params(query)
+        end
+        uri.to_s
+      end
+
+      def process_redirect(url, raw, limit)
+        raise Baidu::Errors::Error.new('Too many redirects') if limit > MAX_REDIRECT_LIMIT
+        request(Net::HTTP::Get.new(url), nil, raw, limit)
+      end
+    end
+  end
+end

data/lib/baidu/support/util.rb

@@ -0,0 +1,67 @@
+# encoding: UTF-8
+
+module Baidu
+  module Support
+    module Util
+      class << self
+        # Check whether +obj+ is blank or not
+        # @example
+        #   blank?('  ')  #true
+        #   blank?('i ')  #false
+        #   blank?(nil)   #true
+        #   blank?(true)  #false
+        #   blank?(false) #true
+        #   blank?({})    #true
+        #
+        # @param [Object] obj
+        def blank?(obj)
+          case obj
+          when String     then /[^[:space:]]/ !~ obj
+          when NilClass   then true
+          when TrueClass  then false
+          when FalseClass then true
+          else obj.respond_to?(:empty?) ? obj.empty? : !obj
+          end
+        end
+
+        # Encode params to www form style
+        # @example
+        #   encode_params({first: 'Lonre', last: 'Wang'})
+        #   => 'first=Lonre&last=Wang'
+        # @param [Hash] params
+        # @return [String]
+        def encode_params(params)
+          raise ArgumentError, 'require Hash instance' unless params.is_a? Hash
+          URI::encode_www_form params
+        end
+
+        # Delete object which value is +nil+ from params
+        # @example
+        #   clean_params({first: 'Lonre', middle: nil, last: 'Wang'})
+        #   => {first: 'Lonre', last: 'Wang'}
+        # @param [Hash] params
+        # @return [Hash]
+        def clean_params(params)
+          raise ArgumentError, 'require Hash instance' unless params.is_a? Hash
+          unless blank? params
+            params.delete_if { |k, v| v.nil? }
+          end
+        end
+
+        # Change +"\\ ? | " > < : "*+ to +"_"+, multi "/" to one "/"
+        # @example
+        #   edit_path(" .hello///path<f:aa/go.zip. ")
+        #   => "hello/path_f_aa/go.zip"
+        # @return [String]
+        def edit_path(path)
+          return nil if path.nil?
+          path = path.gsub(/\/+/, '/')
+          path = path.gsub(/\A[\s\.]*/, '')
+          path = path.gsub(/[\s\.]*\z/, '')
+          path = path.gsub(/[\\\|\?"><:\*]/, '_')
+          path
+        end
+      end
+    end
+  end
+end

data/lib/baidu/version.rb

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

data/spec/baidu/core_spec.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe Baidu do
+  describe '.config' do
+    before do
+      Baidu.config {}
+    end
+
+    it 'has default debug config' do
+      expect(Baidu.debug).to be_false
+    end
+
+    it 'sets debug config to true' do
+      Baidu.config { |c| c.debug = true }
+      expect(Baidu.debug).to be_true
+    end
+  end
+end

data/spec/baidu/oauth/client_spec.rb

@@ -0,0 +1,199 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+require 'baidu/oauth'
+
+describe Baidu::OAuth::Client do
+  let(:authorization_endpoint) { 'https://openapi.baidu.com/oauth/2.0/authorize' }
+  let(:device_endpoint) { 'https://openapi.baidu.com/oauth/2.0/device/code' }
+
+  before(:all) do
+    Baidu.config do |c|
+      c.client_id     = 'ci'
+      c.client_secret = 'cs'
+    end
+  end
+
+  before(:each) do
+    @client = Baidu::OAuth::Client.new do |config|
+      config.access_token   = 'at'
+      config.refresh_token  = 'rt'
+      config.session_key    = 'sk'
+      config.session_secret = 'ss'
+    end
+  end
+
+  context '.initialize' do
+    it 'assigns right config' do
+      expect(@client.client_id).to     eq('ci')
+      expect(@client.client_secret).to eq('cs')
+    end
+
+    it 'overwrites client_id and client_secret' do
+      @client = Baidu::OAuth::Client.new('ci2', 'cs2')
+      expect(@client.client_id).to     eq('ci2')
+      expect(@client.client_secret).to eq('cs2')
+    end
+
+    it 'does not touch endpoint' do
+      expect(Baidu::OAuth::SITE).to eq('https://openapi.baidu.com')
+      expect(Baidu::OAuth::AUTHORIZATION_ENDPOINT).to eq('/oauth/2.0/authorize')
+      expect(Baidu::OAuth::TOKEN_ENDPOINT).to eq('/oauth/2.0/token')
+      expect(@client.instance_variable_get('@site')).to eq('https://openapi.baidu.com')
+    end
+  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
+
+    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")
+    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')
+    end
+  end
+
+  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'))
+      @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
+    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'))
+      @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
+    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'))
+      result = @client.device_flow.user_and_device_code
+      expect(result).to be_instance_of(Hash)
+      expect(result).to have_key(:device_code)
+      expect(result).to have_key(:user_code)
+      expect(result).to have_key(:verification_url)
+      expect(result).to have_key(:qrcode_url)
+      expect(result).to have_key(:expires_in)
+      expect(result).to have_key(:interval)
+    end
+  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
+
+      it 'requests access tokey' do
+        @client.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
+      end
+
+      it 'responses access token' do
+        result = @client.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)
+        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 '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 tokey' do
+        @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
+      end
+
+      it 'responses access token' do
+        result = @client.device_flow.get_token 'a82hjs723h72h3a82hjs723h72h3vb'
+        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
+  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
+    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
+    end
+
+    it 'responses access token by refresh token' do
+      result = @client.refresh('2.af3d55f8615fdfd9edb7c4b5ebdc3e32.604800.1293440400-2346678-124328')
+      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
+end