README.md in upyun-1.0.2 vs README.md in upyun-1.0.3

- old
+ new

@@ -11,11 +11,11 @@ ## 安装 在 `Gemfile` 中加入以下代码 ```ruby -gem 'upyun', '~> 1.0.1' +gem 'upyun', '~> 1.0.3' ``` 然后执行如下命令安装: ``` @@ -91,14 +91,18 @@ 其中, `/save/to/path` 和 `file or binary` 和默认上传方式中一致,`headers` 参数即为额外的可选 HTTP Header 参数,详情查阅 [Rest API](http://docs.upyun.com/api/rest_api/#_4) **返回** -上传成功返回 `true`,失败返回一个 `Hash` 结构: `{error: {code: code, message: message}}`, -其中 `code` 为又拍云返回的错误码, `message` 为错误信息。 +上传成功返回 `true`,失败返回一个 `Hash` 结构: `{request_id: request_id, error: {code: code, message: message}}`, +其中: +* `request_id` 为本次请求的请求码,由 UPYUN 本台返回,可用该值查询 UPYUN 日志; +* `code` 为又拍云返回的错误码; +* `message` 为错误信息; + #### 下载文件 ##### 获取文件内容 ```ruby @@ -108,13 +112,18 @@ **参数** * `'/path/to/file'`: 文件在 UPYUN 空间中的路径 **返回** -下载成功返回文件信息,失败返回一个 `Hash`: `{error: {code: code, message: message}}`, -其中 `code` 为又拍云返回的错误码, `message` 为错误信息。 +下载成功返回文件信息,失败返回一个 `Hash`: `{request_id: request_id, error: {code: code, message: message}}`, +其中: +* `request_id` 为本次请求的请求码,由 UPYUN 本台返回,可用该值查询 UPYUN 日志; +* `code` 为又拍云返回的错误码; +* `message` 为错误信息; + + ##### 保存文件至本地 ```ruby upyun.get('/path/to/file', 'saved/foo.png') ``` @@ -123,11 +132,11 @@ * `'/path/to/file'`: 文件在 UPYUN 空间中的路径 * `saved/foo.png`: 文件本地保存路径 **返回** -下载成功返回获取的文件长度。 +下载成功返回获取的文件长度, 失败返回内容和上例一致。 #### 获取文件信息 ```ruby @@ -149,11 +158,11 @@ * `:file_type` 说明是文件(`"file"`)还是目录(`"folder"`) * `:file_size` 是文件的大小 * `:file_date` 是文件最后的更改时间。 -失败返回一个 `Hash`: `{error: {code: code, message: message}}`。 +失败返回一个 `Hash`: `{request_id: request_id, error: {code: code, message: message}}`。 #### 删除文件或者目录 ```ruby @@ -165,11 +174,11 @@ **返回** 成功返回: `true`, -失败返回一个 `Hash`: `{error: {code: code, message: message}}`。 +失败返回一个 `Hash`: `{request_id: request_id, error: {code: code, message: message}}`。 #### 创建目录 ```ruby upyun.mkdir('/path/to/dir') @@ -181,11 +190,11 @@ **返回** 成功返回: `true`, -失败返回一个 `Hash`: `{error: {code: code, message: message}}`。 +失败返回一个 `Hash`: `{request_id: request_id, error: {code: code, message: message}}`。 #### 获取目录文件列表 ```ruby upyun.getlist('/path/to/dir') @@ -200,11 +209,11 @@ ```ruby [{:name=>"foo", :type=>:folder, :length=>0, :last_modified=>1416193624}, {:name=>"bar.txt", :type=>:file, :length=>25, :last_modified=>1415261057}] ``` -失败返回一个 `Hash`: `{error: {code: code, message: message}}`。 +失败返回一个 `Hash`: `{request_id: request_id, error: {code: code, message: message}}`。 #### 获取空间使用情况 ```ruby upyun.usage @@ -212,10 +221,10 @@ **返回** 成功返回空间使用量(单位为 `Byte`): `12400`, -失败返回一个 `Hash`: `{error: {code: code, message: message}}`。 +失败返回一个 `Hash`: `{request_id: request_id, error: {code: code, message: message}}`。 ### Form API 使用 #### 初始化一个实例