api4baidu 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e94a9e1c4b286e14c7fbc508616cb3fb96a32e14
-  data.tar.gz: 9594091884bdae4160429ab84f15920f8a38196b
+  metadata.gz: 4a4388823d9e24396b98e6ab7cc390ea7594a519
+  data.tar.gz: 86c4e553fe26308c79be269bda3e3d87d2ce3eb5
 SHA512:
-  metadata.gz: 99493a6e3d97ad17d2c527121310574a9d1678907d7a1996517e85cf31c8b7f2b8a3f8cd1a14a731b0a2e00aeca804c4943ac064e1f64176cf8767c64b89ed7f
-  data.tar.gz: c5aba91a6be557155574cbd5991f32d2df24cb84fc560b9429c088a1694e46b1977a7db977b9cb96949eb448978fa3bfce7e8c22dc0f5b9636714ff47d19b4ea
+  metadata.gz: 0f8d6419f90e284965beee02ab0401d4450eaf5b747fb4f67b4c06a929172104f42b7b29f034c645e9771ac9a6a857d82c6abe48c0839d8f0c16bbf1683d30dc
+  data.tar.gz: 233e09592d2b66d9178156c78ca81a9cb1469c029e64884b8297803674dbd83c6d1bb712e38432b56a09cd24539afb6882e4517a24f9f1b97067002a9713cd49

data/README.md

@@ -3,7 +3,7 @@
  Ruby gem for Baidu <http://developer.baidu.com> apis.
   **Developing**
 
- Rubygems: https://rubygems.org/gems/api4baidu
+ Rubygems: <https://rubygems.org/gems/api4baidu>
 
 ## Installation
 
@@ -26,7 +26,7 @@ Or install it yourself as:
 ```ruby
 
 $client = Baidu.configure do |config|
-  config.api_key = "you client id"
+  config.api_key    = "you client id"
   config.api_secret = "you client secert"
 end
 
@@ -45,12 +45,62 @@ $client.token!("515a268fd483ff4df85d2d458d34b43a")
 $client.get_loggedin_user
 
  => Result:
- {"uid"=>"1863251187",
- "uname"=>"0807515210",
- "portrait"=>"ba6f303830373531353231302c0a"}
+ {"uid"    => "1863251187",
+ "uname"   => "0807515210",
+ "portrait"=> "ba6f303830373531353231302c0a"}
 
 ```
 
+更多使用例子请查看 `spec`目录
+
+## 已完成API列表
+
+### 用户基础信息
+
+1. 获取当前登录用户的信息: get_loggedin_user
+
+2. 返回指定用户的用户资料: get_user_info
+
+3. 平台授权相关的权限: get_app_permission
+
+4. 判断用户是否为应用用户: is_app_user
+
+5. 返回用户好友资料: get_friends
+
+6. 获得指定用户之间好友关系: areFriends
+
+### PCS
+
+1. 获取当前用户空间配额信息: pcs_quota
+
+2. 上传单个文件: upload_single_file
+
+3. 下载单个文件: download_single_file
+
+4. 创建目录: create_directory
+
+5. 获取单个文件/目录的元信息: get_single_meta
+
+6. 删除单个文件/目录: delete_single_file
+
+7. 获取指定图片文件的缩略图: get_image_thumbnail
+
+### 翻译
+
+1. 翻译: translate
+
+### 工具
+
+1. 查询IP地址所在地区: query_with_ip
+
+## TODO
+
+1. 逐步完善所有API对接
+
+2. 重构oauth2，分离出独立的gem实现
+
+3. 添加Terminal命令控制
+
 ## Contributing
 
 1. Fork it

data/lib/baidu.rb

@@ -1,7 +1,7 @@
 require "active_support/core_ext/object/to_query"
 require 'active_support/concern'
 
-%w(api/pcs api/user version client).each do |fname|
+%w(api/pcs api/user api/tool api/translation version client).each do |fname|
   require File.expand_path("../baidu/#{fname}", __FILE__)
 end
 

data/lib/baidu/api/pcs.rb

@@ -17,12 +17,62 @@ module Baidu
       # 百度PCS服务目前支持最大2G的单个文件上传。
       # 如需支持超大文件（>2G）的断点续传，请参考下面的“分片文件上传”方法。
       def upload_single_file(yun_path, source_file_path="", opts={})
-        require 'rest-client'
         source_file = File.open(source_file_path)
         response    = RestClient.post(upload_file_url(path: yun_path), file: source_file)
         JSON.parse(response)
       end
 
+      # 下载单个文件。
+      # Download接口支持HTTP协议标准range定义，通过指定range的取值可以实现断点下载功能。 例如：
+      # 如果在request消息中指定“Range:bytes=099”，那么响应消息中会返回该文件的前100个字节的内容；继续指定“Range: bytes=100-199”，那么响应消息中会返回该文件的第二个100字节内容。
+
+      # 注意: 此API不直接下载文件，而是直接返回下载链接
+      def download_single_file(file_path)
+        default = {method: "download", path: file_path}
+        "https://d.pcs.baidu.com/rest/2.0/pcs/file?#{query_params(default)}"
+      end
+
+      # 创建目录
+      # 为当前用户创建一个目录。
+      # 注意:这个是您使用的路径不正确，这个路径需要是您开启PCS权限的时候，填写的文件夹名称，而不能随便填写
+      def create_directory(dir_path)
+        default = {method: "mkdir"}
+        create_dir_url = pcs_base_url("file", default)
+        response       = RestClient.post(create_dir_url, path: dir_path)
+        JSON.parse(response)
+      end
+
+      # 获取单个文件/目录的元信息
+      def get_single_meta(path)
+        default  = {method: "meta", path: path}
+        meta_url = pcs_base_url("file", default)
+        get_response_json(meta_url)
+      end
+
+      # 批量获取文件/目录的元信息
+      # list value should be a json
+      # {"list":[{"path":"\/apps\/album\/a\/b\/c"},{"path":"\/apps\/album\/a\/b\/d"}]}
+      # def get_batch_metas(*paths)
+      #   path_list ={"list": paths}
+      #   default  = {method: "meta", param: paths}
+      #   batch_metas_url = pcs_base_url("file", default)
+      # end
+
+      # 删除单个文件/目录。
+      def delete_single_file(path)
+        default        = {method: "delete"}
+        create_dir_url = pcs_base_url("file", default)
+        response       = RestClient.post(create_dir_url, path: path)
+        JSON.parse(response)
+      end
+
+      # 获取指定图片文件的缩略图。
+      def get_image_thumbnail(image_path, height, width ,quality="100")
+        default = {method: "generate", path: image_path,
+                   width: width, height: height, quality: quality}
+        pcs_base_url("thumbnail", default)
+      end
+
       private
         def pcs_base_url(path, params={})
           "https://pcs.baidu.com/rest/2.0/pcs/#{path}?#{query_params(params)}"

data/lib/baidu/api/tool.rb

@@ -0,0 +1,19 @@
+module Baidu
+  module Tool
+    extend ActiveSupport::Concern
+
+    included do
+
+      # 查询IP地址所在地区
+      # 根据ip计算出用户对应的省份与城市。如果应用还没有开通平台授权权限，可以暂时使用用户token来调用此API。
+      # https://openapi.baidu.com/rest/2.0/iplib/query
+      # ip: 系统输入参数为编码为UTF-8格式编码。需要查询的ip地址，多个ip地址请用英文逗号隔开。
+      def query_with_ip(ip)
+        default = {ip: ip}
+        query_url = "https://openapi.baidu.com/rest/2.0/iplib/query?#{query_params(default)}"
+        get_response_json(query_url)
+      end
+
+    end
+  end
+end

data/lib/baidu/api/translation.rb

@@ -0,0 +1,22 @@
+module Baidu
+  module Translation
+    extend ActiveSupport::Concern
+
+    included do
+
+      # http://openapi.baidu.com/public/2.0/bmt/translate
+      # auto   auto  自动识别
+      # zh   en  中 -> 英
+      # zh   jp  中 -> 日
+      # en   zh  英 -> 中
+      # jp   zh  日 -> 中
+      # client_id=YourApiKey&q=today&from=auto&to=auto
+      def translate(from="auto", to="auto", q)
+        params = {from: from, to: to, q: q, client_id: api_key}.to_query
+        translate_url = "http://openapi.baidu.com/public/2.0/bmt/translate?#{params}"
+        get_response_json(translate_url)
+      end
+
+    end
+  end
+end

data/lib/baidu/api/user.rb

@@ -9,7 +9,7 @@ module Baidu
       # 获取当前登录用户的信息
       # passport/users/getLoggedInUser
       def get_loggedin_user
-        profile_url = "#{user_base_url('getLoggedInUser')}"
+        profile_url = "#{user_base_url('passport/users/getLoggedInUser')}"
         get_response_json(profile_url)
       end
 
@@ -18,7 +18,7 @@ module Baidu
       # uid default "", will return current user info
       # if you want to access other user info, you should have this permission
       def get_user_info(uid="")
-        user_info_url = "#{user_base_url('getInfo', uid: uid)}"
+        user_info_url = "#{user_base_url('passport/users/getInfo', uid: uid)}"
         get_response_json(user_info_url)
       end
 
@@ -31,19 +31,39 @@ module Baidu
       # public   可以访问公共的开放API。
       # hao123   可以访问Hao123 提供的开放API接口该权限需要申请开通，请将具体的理由和用途发邮件给tuangou@baidu.com。
       def get_app_permission(uid="", ext_perms)
-        app_permissions_url = "#{user_base_url('hasAppPermissions', {uid: uid, ext_perms: ext_perms})}"
+        app_permissions_url = "#{user_base_url('passport/users/hasAppPermissions', {uid: uid, ext_perms: ext_perms})}"
         get_response_json(app_permissions_url)
       end
 
       # refactor
+      # 判断用户是否为应用用户
       def is_app_user(uid="")
-        app_user_url = "#{user_base_url('isAppUser', uid: uid)}"
+        app_user_url = "#{user_base_url('passport/users/isAppUser', uid: uid)}"
         get_response_json(app_user_url)
       end
 
+      # 返回用户好友资料
+      # 根据用户id以及在百度的相应的操作权限(可以是多个权限半角逗号隔开)来判断用户是否可以进行此操作。
+      # https://openapi.baidu.com/rest/2.0/friends/getFriends
+
+      def get_friends(params={})
+        get_friends_url = "#{user_base_url('friends/getFriends', params)}"
+        get_response_json(get_friends_url)
+      end
+
+      # 获得指定用户之间好友关系
+      # 获得指定用户之间是否是好友关系。第一个数组指定一半用户，第二个数组指定另外一半，两个数组必须同样的个数，一次最多可以查20个。
+      # https://openapi.baidu.com/rest/2.0/friends/areFriends
+      # uids1、uids2每个uid都是以半角逗号隔开。二者个数必须相等: 402818250,2718323483"
+      def areFriends(uids1, uids2)
+        default = {uids1: uids1, uids2: uids2}
+        are_friends_url = "#{user_base_url('friends/areFriends', default)}"
+        get_response_json(are_friends_url)
+      end
+
       private
         def user_base_url(path, params={})
-          "https://openapi.baidu.com/rest/2.0/passport/users/#{path}?#{query_params(params)}"
+          "https://openapi.baidu.com/rest/2.0/#{path}?#{query_params(params)}"
         end
     end
   end

data/lib/baidu/client.rb

@@ -1,11 +1,14 @@
 require 'oauth2'
 require "json"
+require 'rest-client'
 
 module Baidu
   class Client
 
     include Pcs
     include User
+    include Tool
+    include Translation
 
     attr_accessor :api_key, :api_secret
     ##

data/lib/baidu/version.rb

@@ -1,3 +1,3 @@
 module Baidu
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/spec/feature_spec.rb

@@ -1,5 +1,6 @@
 require "spec_helper"
 
+# if you want to run test, please instead 'backup_baidu' with you application name
 describe "Bidu" do
   describe "Feature" do
     before :all do
@@ -10,6 +11,10 @@ describe "Bidu" do
       auth_code = $stdin.gets.chomp.split("\n").first
       $client.token!(auth_code)
       puts "access_token = %s" % $client.access_token.token
+
+      @application_name = "backup_baidu"
+      @app_dir = "/apps/#{@application_name}"
+      @new_dir_path = "#{@app_dir}/gem_test_#{Time.now.to_i}"
     end
 
     describe "#User personal info" do
@@ -27,6 +32,19 @@ describe "Bidu" do
         result_json = $client.get_user_info
         result_json.keys.should =~ ["userid", "username", "birthday", "marriage", "sex", "blood", "constellation", "figure", "trade", "job", "portrait", "education"]
       end
+
+      it "should get friends" do
+        result_json = $client.get_friends
+        result_json.first.keys.should =~ ["uid", "uname", "portrait"]
+      end
+
+      it "should return some friends relations" do
+        uids1 = "2718323483,402818250,2819457800"
+        uids2 = "1527552252,3289658540,1694714450"
+        result_json = $client.areFriends(uids1, uids2)
+        result_json.size.should == 3
+      end
+
     end
 
     describe "#User netdisk" do
@@ -37,9 +55,73 @@ describe "Bidu" do
 
       it "should upload a image file to baidu yun" do
         @source_path = File.expand_path("../fixtures/avater.jpg", __FILE__)
-        result_json = $client.upload_single_file("/apps/backup_baidu/avater.jpg", @source_path)
+        result_json  = $client.upload_single_file("#{@app_dir}/avater.jpg", @source_path)
         result_json.keys.should =~ ["path", "size", "ctime", "mtime", "md5", "fs_id", "request_id"]
       end
+
+      it "should download a image named avater.jpg" do
+        download_url = $client.download_single_file("#{@app_dir}/avater.jpg")
+        response     = $client.access_token.get(download_url)
+
+        response.status.should == 200
+        response.headers["content-type"].should == "image/jpeg"
+      end
+
+      it "should create a directory" do
+        response = $client.create_directory(@new_dir_path)
+        response.keys.should =~ ["request_id", "ctime", "fs_id", "mtime", "path"]
+      end
+
+      it "should delete a dir" do
+        response = $client.delete_single_file(@new_dir_path)
+        response.keys.should =~ ["request_id"]
+      end
+
+      it "should get a image named avater.jpg meta" do
+        response = $client.get_single_meta("#{@app_dir}/avater.jpg")
+        response.keys.should               =~ ["list", "request_id"]
+        response["list"].first.keys.should =~ ["block_list", "ctime", "filenum", "fs_id",
+                                               "ifhassubdir", "isdir", "mtime", "path", "size"]
+        response["list"].first["path"].should  == "#{@app_dir}/avater.jpg"
+        response["list"].first["isdir"].should == 0
+      end
+
+      it "should get a dir meta" do
+        response = $client.get_single_meta(@app_dir)
+        response.keys.should =~ ["list", "request_id"]
+        response["list"].first["path"].should  == @app_dir
+        response["list"].first["isdir"].should == 1
+      end
+
+      it "should get a thumbnail image" do
+        thumbnail_url = $client.get_image_thumbnail("#{@app_dir}/avater.jpg", 50, 50)
+        response      = $client.access_token.get(thumbnail_url)
+        response.status.should == 200
+        response.headers["content-type"].should == "image/jpeg"
+      end
+
+      it "should delete a file" do
+        response = $client.delete_single_file("#{@app_dir}/avater.jpg")
+        response.keys.should =~ ["request_id"]
+      end
+
+    end
+
+    describe "#Tool" do
+      it "query with your ip " do
+        ip = "163.179.238.216"
+        result_json = $client.query_with_ip(ip)
+        result_json[ip]["province"].should == "广东"
+        result_json[ip]["city"].should     == "惠州"
+      end
+    end
+
+    describe "#Translate" do
+      it "should translate 'Today' to '今天'" do
+        result_json = $client.translate("en", "zh", "Today")
+        result_json["trans_result"][0]["src"].should == "Today"
+        result_json["trans_result"][0]["dst"].should == "今天"
+      end
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api4baidu
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Dylan Deng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-15 00:00:00.000000000 Z
+date: 2013-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -83,6 +83,8 @@ files:
 - baidu.gemspec
 - lib/baidu.rb
 - lib/baidu/api/pcs.rb
+- lib/baidu/api/tool.rb
+- lib/baidu/api/translation.rb
 - lib/baidu/api/user.rb
 - lib/baidu/client.rb
 - lib/baidu/version.rb