upyun 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfbd5be64ea11f088fedd5b5923496458ca543a9
-  data.tar.gz: b269595a497748ecc3c744aa43595aa84d03ac69
+  metadata.gz: 8c53c29e162493c788f931b0eab39850a404fe70
+  data.tar.gz: 04a51ddba3f0eff2d3862ee4d3ede5d15f948a96
 SHA512:
-  metadata.gz: 53fa5fce2ac4c9886659f080026136c8d2213724ac9904f2a77864d2c8045b57e9cc1bc9e7349ad51bd175dfa93c0bc2baa9f0985d04f29ce0d39db42c1822cf
-  data.tar.gz: ec874df8d90f96dde3b8ace8d47bb9498120192221c032b9618bd457e516785d9d3ae6a9d9075733b6336a328efe495ec62a309496f6057e3dc342a63f12116b
+  metadata.gz: d26b50b05d5ed484d3b308676772fc84a9f6b2885baef919b421dd4d57dc8632c680510827aae5ef92f7cbabb221f45d328d02c5bd1cb7f91bf3129f83c848f9
+  data.tar.gz: 5f01e1b9c185217cca77b94ac433f2bd379632ee169caf17b74cf0f199044dcbc466fd1f272258b7481816d7c545a3619de251d0852723ff0085149aab5da069

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## CHANGE LOG
 
+### v1.0.3
+- 请求失败时返回的 Hash 中增加 `:request_id` 字段；
+- 对于图片空间，上传时返回的 Hash 中包含图片详情信息；
+- 删除不必要的 gem 依赖；
+
 ### v1.0.2
 - 初始化实例的时候增加选项，特别地将连接超时时间设为 60s；
 - URL `encode`, `decode` 使用 `open-uri` 代替 `uri`；

data/README.md

@@ -13,7 +13,7 @@
 在 `Gemfile` 中加入以下代码
 
 ```ruby
-gem 'upyun', '~> 1.0.1'
+gem 'upyun', '~> 1.0.3'
 ```
 
 然后执行如下命令安装:
@@ -93,8 +93,12 @@ upyun.put('/save/to/path', 'file or binary', headers)
 
 **返回**
 
-上传成功返回 `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` 为错误信息；
 
 
 #### 下载文件
@@ -110,8 +114,13 @@ file = upyun.get('/path/to/file')
 * `'/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` 为错误信息；
+
 
 ##### 保存文件至本地
 
@@ -125,7 +134,7 @@ upyun.get('/path/to/file', 'saved/foo.png')
 * `saved/foo.png`: 文件本地保存路径
 
 **返回**
-下载成功返回获取的文件长度。
+下载成功返回获取的文件长度, 失败返回内容和上例一致。
 
 
 #### 获取文件信息
@@ -151,7 +160,7 @@ upyun.getinfo('/path/to/file')
   * `:file_size` 是文件的大小
   * `:file_date` 是文件最后的更改时间。
 
-失败返回一个 `Hash`: `{error: {code: code, message: message}}`。
+失败返回一个 `Hash`: `{request_id: request_id, error: {code: code, message: message}}`。
 
 
 #### 删除文件或者目录
@@ -167,7 +176,7 @@ upyun.delete('/path/to/file')
 
 成功返回: `true`,
 
-失败返回一个 `Hash`: `{error: {code: code, message: message}}`。
+失败返回一个 `Hash`: `{request_id: request_id, error: {code: code, message: message}}`。
 
 #### 创建目录
 
@@ -183,7 +192,7 @@ upyun.mkdir('/path/to/dir')
 
 成功返回: `true`,
 
-失败返回一个 `Hash`: `{error: {code: code, message: message}}`。
+失败返回一个 `Hash`: `{request_id: request_id, error: {code: code, message: message}}`。
 
 #### 获取目录文件列表
 
@@ -202,7 +211,7 @@ upyun.getlist('/path/to/dir')
  {: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}}`。
 
 #### 获取空间使用情况
 
@@ -214,7 +223,7 @@ upyun.usage
 
 成功返回空间使用量（单位为 `Byte`）: `12400`,
 
-失败返回一个 `Hash`: `{error: {code: code, message: message}}`。
+失败返回一个 `Hash`: `{request_id: request_id, error: {code: code, message: message}}`。
 
 ### Form API 使用
 

data/lib/upyun/rest.rb

@@ -25,7 +25,20 @@ module Upyun
                   {body: file, length: file.length, headers: headers}
                 end
 
-      request(:put, path, options)
+      # If the type of current bucket is Picture,
+      # put an image maybe return a set of headers
+      # represent the image's metadata
+      # x-upyun-width
+      # x-upyun-height
+      # x-upyun-frames
+      # x-upyun-file-type
+      res = request(:put, path, options) do |hds|
+        hds.select { |k| k.to_s.match(/^x_upyun_/i) }.reduce({}) do |memo, (k, v)|
+          memo.merge!({k[8..-1].to_sym => /^\d+$/.match(v) ? v.to_i : v})
+        end
+      end
+
+      res == {} ? true : res
     end
 
     def get(path, savepath=nil)
@@ -38,10 +51,19 @@ module Upyun
     end
 
     def getinfo(path)
-      hds = request(:head, path)
-      hds = hds.key?(:error) ? hds : format_info(hds)
+      request(:head, path) do |hds|
+        #  File info:
+        #  x-upyun-file-type
+        #  x-upyun-file-size
+        #  x-upyun-file-date
+        hds.select { |k| k.to_s.match(/^x_upyun_file/i) }.reduce({}) do |memo, (k, v)|
+          memo.merge!({k[8..-1].to_sym => /^\d+$/.match(v) ? v.to_i : v})
+        end
+      end
     end
 
+    alias :head :getinfo
+
     def delete(path)
       request(:delete, path)
     end
@@ -54,8 +76,8 @@ module Upyun
       res = request(:get, path)
       return res if res.is_a?(Hash)
 
-      res.split('\n').map do |f|
-        attrs = f.split('\t')
+      res.split("\n").map do |f|
+        attrs = f.split("\t")
         {
           name: attrs[0],
           type: attrs[1] == 'N' ? :file : :folder,
@@ -76,19 +98,12 @@ module Upyun
 
     private
 
-      def format_info(hds)
-        selected = hds.select { |k| k.to_s.match(/^x_upyun/i) }
-        selected.reduce({}) do |memo, (k, v)|
-          memo.merge!({k[8..-1].to_sym => /^\d+$/.match(v) ? v.to_i : v})
-        end
-      end
-
       def fullpath(path)
-        decoded = URI::encode(URI::decode(path.force_encoding('utf-8')))
+        decoded = URI::encode(URI::decode(path.to_s.force_encoding('utf-8')))
         "/#{@bucket}#{decoded.start_with?('/') ? decoded : '/' + decoded}"
       end
 
-      def request(method, path, options={})
+      def request(method, path, options={}, &block)
         fullpath = fullpath(path)
         query = options[:query]
         fullpath_query = "#{fullpath}#{query.nil? ? '' : '?' + query}"
@@ -104,21 +119,32 @@ module Upyun
         if [:post, :patch, :put].include? method
           body = options[:body].nil? ? '' : options[:body]
           rest_client[fullpath_query].send(method, body, headers) do |res|
-            res.code == 200 ? true : {error: {code: res.code, message: res.body}}
+            if res.code / 100 == 2
+              block_given? ? yield(res.headers) : true
+            else
+              {
+                request_id: res.headers[:x_request_id],
+                error: {code: res.code, message: res.body}
+              }
+            end
           end
+
         else
           rest_client[fullpath_query].send(method, headers) do |res|
-            if res.code == 200
+            if res.code / 100 == 2
               case method
               when :get
                 res.body
               when :head
-                res.headers
+                yield(res.headers)
               else
                 true
               end
             else
-              {error: {code: res.code, message: res.body}}
+            {
+              request_id: res.headers[:x_request_id],
+              error: {code: res.code, message: res.body}
+            }
             end
           end
         end

data/lib/upyun/version.rb

@@ -1,3 +1,3 @@
 module Upyun
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/spec/upyun_spec.rb

@@ -1,9 +1,11 @@
+# encoding: utf-8
+
 require File.dirname(__FILE__) + '/spec_helper'
 require 'uri'
 
 describe "Upyun Restful API Basic testing" do
   before :all do
-    @upyun = Upyun::Rest.new('sdkfile', 'tester', 'grjxv2mxELR3')
+    @upyun = Upyun::Rest.new('sdkfile', 'tester', 'grjxv2mxELR3', {}, Upyun::ED_TELECOM)
     @file = File.expand_path('../upyun.jpg', __FILE__)
     @str = 'This is a binary string, not a file'
   end
@@ -61,6 +63,16 @@ describe "Upyun Restful API Basic testing" do
       after(:all) { @upyun.delete(@path_cn) }
     end
 
+    it "put a file to Picture bucket should return the image's metadata" do
+      upyunp = Upyun::Rest.new('sdkimg', 'tester', 'grjxv2mxELR3', {}, Upyun::ED_TELECOM)
+      metas = upyunp.put(@path, @file, content_type: 'image/jpeg')
+      expect(metas).to include(:width, :height, :frames, :file_type)
+      expect(metas[:width].is_a?(Integer))
+      expect(metas[:height].is_a?(Integer))
+      expect(metas[:frames].is_a?(Integer))
+      expect(metas[:file_type].is_a?(String))
+    end
+
     after { @upyun.delete(@path) }
   end
 
@@ -121,7 +133,7 @@ describe "Upyun Restful API Basic testing" do
   end
 
   describe ".mkdir" do
-    before(:all) { @path = '/ruby-skd/foo/dir' }
+    before(:all) { @path = '/ruby-sdk/foo/dir' }
 
     it "should success" do
       expect(@upyun.mkdir(@path)).to be true
@@ -131,9 +143,22 @@ describe "Upyun Restful API Basic testing" do
   end
 
   describe ".getlist" do
+    before :all do
+      @dir = '/ruby-sdk/foo'
+      10.times { |i| @upyun.put("#@dir/#{i}", @file) }
+    end
+
     it "should get a list of file record" do
       expect(@upyun.getlist("/")).to be_instance_of(Array)
     end
+
+    it "should return the correct number of records" do
+      expect(@upyun.getlist(@dir).length).to eq(10)
+    end
+
+    after :all do
+      10.times { |i| @upyun.delete("#@dir/#{i}") }
+    end
   end
 
   describe ".usage" do

data/upyun.gemspec

@@ -19,10 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rest-client", ">= 1.6.7"
-  spec.add_dependency "activesupport", "~> 4.1.0"
+  spec.add_dependency "activesupport"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_development_dependency "rspec", "~> 2.6"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upyun
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - jsvisa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-19 00:00:00.000000000 Z
+date: 2014-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -28,58 +28,30 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 4.1.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '2.6'
 description: UPYUN Rest API and Form API SDK
 email:
 - delweng@gmail.com
@@ -133,3 +105,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/upyun.jpg
 - spec/upyun_spec.rb
+has_rdoc: