aliyun-sdk 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8c0d1b86615b56e888dced9498d7e1e4a4a1e39
-  data.tar.gz: af031c11e58a4d25fc9eb6afba56d1d9a0982b34
+  metadata.gz: 5464cc7eae38bc5a03989a659ecebe5ad29b20c5
+  data.tar.gz: 7b700d86e7985b53227aee212ed097d9d68f9c83
 SHA512:
-  metadata.gz: 83fd2fb0d5344b83840456d1c128e5f7c3fcb78852f573551f208903547bbe324569ab0d1914856980ac7eab8389d1f58533fb569ca0b88354b08b0414b770ce
-  data.tar.gz: 89e4ff7882cde22a27c5271cd9989e03bd8217908fda2afda229a3544e8d8cfbea546cc0312f740141b0efd289a5d9d87a9e27a33ac9b5bdaac8b8263017ee0a
+  metadata.gz: 3a98134dfb618c8359e66d8914918d05fc1b20efe2589cf3d9f094b001a0aab38c3c0292465f6457ae07cc2941c65843ed960ad88e83bd18c9eeabfbbb6c35c2
+  data.tar.gz: 0c8d4c5b7aa671664c2f5f433d44c7307f2ad4b38387c839f2ca6b1d27c857fc106e6c2c03cf1d8be2ce7200a2de10c338f22665ac3e5e547729f73df0f81a71

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Change Log
 
+### v0.1.8
+
+- Fix StreamWriter string encoding problem
+- Add ruby version and os version in User-Agent
+- Some comments & examples refine
+
 ### v0.1.7
 
 - Fix StreamWriter#inspect bug

data/README.md

@@ -149,7 +149,7 @@ Object的common prefix，包含在`list_objects`的结果中。
 
     objs = bucket.list_objects(:prefix => '/foo/', :delimiter => '/')
     objs.each do |i|
-      if i.is_a?(Object) # a object
+      if i.is_a?(Aliyun::OSS::Object) # a object
         puts "object: #{i.key}"
       else
         puts "common prefix: #{i}"
@@ -330,13 +330,13 @@ Bucket的权限。
 
 SDK的examples/目录下有一些展示SDK功能的示例程序，用户稍加配置就可以直
 接运行。examples需要的权限信息和bucket信息从用户`HOME`目录下的配置文件
-`~/.oss.yml`中读取，其中应该包含以下字段：
+`~/.oss.yml`中读取，其中应该包含以下字段（**注意冒号后面需要有一个空格**）：
 
     endpoint: oss-cn-hangzhou.aliyuncs.com
     cname: false
-    id: ACCESS KEY ID
-    key: ACCESS KEY SECRET
-    bucket: BUCKET NAME
+    access_key_id: <ACCESS KEY ID>
+    access_key_secret: <ACCESS KEY SECRET>
+    bucket: <BUCKET NAME>
 
 用户需要创建（如果不存在）或者修改其中的内容，然后运行：
 

data/examples/aliyun/oss/bucket.rb

@@ -11,8 +11,8 @@ conf = YAML.load(File.read(File.expand_path(conf_file)))
 client = Aliyun::OSS::Client.new(
   :endpoint => conf['endpoint'],
   :cname => conf['cname'],
-  :access_key_id => conf['id'],
-  :access_key_secret => conf['key'])
+  :access_key_id => conf['access_key_id'],
+  :access_key_secret => conf['access_key_secret'])
 bucket = client.get_bucket(conf['bucket'])
 
 # 辅助打印函数

data/examples/aliyun/oss/object.rb

@@ -11,8 +11,8 @@ conf = YAML.load(File.read(File.expand_path(conf_file)))
 bucket = Aliyun::OSS::Client.new(
   :endpoint => conf['endpoint'],
   :cname => conf['cname'],
-  :access_key_id => conf['id'],
-  :access_key_secret => conf['key']).get_bucket(conf['bucket'])
+  :access_key_id => conf['access_key_id'],
+  :access_key_secret => conf['access_key_secret']).get_bucket(conf['bucket'])
 
 # 辅助打印函数
 def demo(msg)

data/examples/aliyun/oss/resumable_download.rb

@@ -11,8 +11,8 @@ conf = YAML.load(File.read(File.expand_path(conf_file)))
 bucket = Aliyun::OSS::Client.new(
   :endpoint => conf['endpoint'],
   :cname => conf['cname'],
-  :access_key_id => conf['id'],
-  :access_key_secret => conf['key']).get_bucket(conf['bucket'])
+  :access_key_id => conf['access_key_id'],
+  :access_key_secret => conf['access_key_secret']).get_bucket(conf['bucket'])
 
 # 辅助打印函数
 def demo(msg)

data/examples/aliyun/oss/resumable_upload.rb

@@ -11,8 +11,8 @@ conf = YAML.load(File.read(File.expand_path(conf_file)))
 bucket = Aliyun::OSS::Client.new(
   :endpoint => conf['endpoint'],
   :cname => conf['cname'],
-  :access_key_id => conf['id'],
-  :access_key_secret => conf['key']).get_bucket(conf['bucket'])
+  :access_key_id => conf['access_key_id'],
+  :access_key_secret => conf['access_key_secret']).get_bucket(conf['bucket'])
 
 # 辅助打印函数
 def demo(msg)

data/examples/aliyun/oss/streaming.rb

@@ -29,8 +29,8 @@ conf = YAML.load(File.read(File.expand_path(conf_file)))
 bucket = Aliyun::OSS::Client.new(
   :endpoint => conf['endpoint'],
   :cname => conf['cname'],
-  :access_key_id => conf['id'],
-  :access_key_secret => conf['key']).get_bucket(conf['bucket'])
+  :access_key_id => conf['access_key_id'],
+  :access_key_secret => conf['access_key_secret']).get_bucket(conf['bucket'])
 
 # 辅助打印函数
 def demo(msg)

data/lib/aliyun/oss/bucket.rb

@@ -178,8 +178,8 @@ module Aliyun
       # @option opts [Hash] :metas 设置object的meta，这是一些用户自定
       #  义的属性，它们会和object一起存储，在{#get_object}的时候会
       #  返回这些meta。属性的key不区分大小写。例如：{ 'year' => '2015' }
-      # @yield [HTTP::StreamWriter] 如果调
-      #  用的时候传递了block，则写入到object的数据由block指定
+      # @yield [HTTP::StreamWriter] 如果调用的时候传递了block，则写入
+      #  到object的数据由block指定
       # @example 流式上传数据
       #   put_object('x'){ |stream| 100.times { |i| stream << i.to_s } }
       #   put_object('x'){ |stream| stream << get_data }
@@ -188,9 +188,6 @@ module Aliyun
       # @example 指定Content-Type和metas
       #   put_object('x', :file => '/tmp/x', :content_type => 'text/html',
       #              :metas => {'year' => '2015', 'people' => 'mary'})
-      # @note 采用streaming的方式时，提供的数据必须是有结束标记的数据。
-      #  因为put_object会不断地从StreamWriter中读取数据上传到OSS，直到
-      #  它读到的数据为nil停止。
       # @note 如果opts中指定了:file，则block会被忽略
       def put_object(key, opts = {}, &block)
         args = opts.dup

data/lib/aliyun/oss/config.rb

@@ -14,6 +14,9 @@ module Aliyun
 
       def initialize(opts = {})
         super(opts)
+
+        @access_key_id.strip! if @access_key_id
+        @access_key_secret.strip! if @access_key_secret
         normalize_endpoint if endpoint
       end
 

data/lib/aliyun/oss/http.rb

@@ -41,18 +41,22 @@ module Aliyun
       #
       class StreamWriter
         def initialize
-          @chunks = []
+          @buffer = ""
           @producer = Fiber.new { yield self if block_given? }
           @producer.resume
         end
 
-        # FIXME: it may return more than bytes, not sure if that's a problem
         def read(bytes = nil, outbuf = nil)
           ret = ""
           loop do
-            c = @chunks.shift
-            ret << c if c && !c.empty?
-            break if bytes && ret.size >= bytes
+            if bytes
+              ret << @buffer.slice!(0, bytes)
+              break if ret.size >= bytes
+            else
+              ret << @buffer
+              @buffer.clear
+            end
+
             if @producer.alive?
               @producer.resume
             else
@@ -76,7 +80,7 @@ module Aliyun
         end
 
         def write(chunk)
-          @chunks << chunk
+          @buffer << chunk.to_s.force_encoding(Encoding::ASCII_8BIT)
           Fiber.yield
           self
         end
@@ -88,7 +92,7 @@ module Aliyun
         end
 
         def inspect
-          "@chunks: " + @chunks.map { |c| c[0, 100].inspect }.join(';')
+          "@buffer: " + @buffer[0, 32].inspect + "...#{@buffer.size} bytes"
         end
       end
 
@@ -275,7 +279,7 @@ module Aliyun
       end
 
       def get_user_agent
-        "aliyun-sdk-ruby/#{VERSION}"
+        "aliyun-sdk-ruby/#{VERSION} ruby-#{RUBY_VERSION}/#{RUBY_PLATFORM}"
       end
 
     end # HTTP

data/lib/aliyun/oss/version.rb

@@ -3,7 +3,7 @@
 module Aliyun
   module OSS
 
-    VERSION = "0.1.7"
+    VERSION = "0.1.8"
 
   end # OSS
 end # Aliyun

data/spec/aliyun/oss/client/client_spec.rb

@@ -10,11 +10,11 @@ module Aliyun
     describe Client do
 
       context "construct" do
-        it "should setup endpoint and a/k", :focus => true do
+        it "should setup endpoint and a/k" do
           endpoint = 'oss-cn-hangzhou.aliyuncs.com'
           client = Client.new(
             :endpoint => endpoint,
-            :access_key_id => 'xxx', :access_key_secret => 'yyy')
+            :access_key_id => 'xxx ', :access_key_secret => '  yyy ')
 
           config = client.instance_variable_get('@config')
           expect(config.endpoint.to_s).to eq("http://#{endpoint}")

data/spec/aliyun/oss/http_spec.rb

@@ -10,14 +10,53 @@ module Aliyun
       context HTTP::StreamWriter do
         it "should read out chunks that are written" do
           s = HTTP::StreamWriter.new do |sr|
-            10.times{ |i| sr << "hello, #{i}" }
+            100.times { sr << "x" }
           end
 
-          10.times do |i|
-            bytes, outbuf = "hello, 0".size, ""
+          10.times do
+            bytes, outbuf = 10, ''
             s.read(bytes, outbuf)
-            expect(outbuf).to eq("hello, #{i}")
+            expect(outbuf).to eq("x"*10)
           end
+
+          outbuf = 'xxx'
+          r = s.read(10, outbuf)
+          expect(outbuf).to eq('')
+          expect(r).to be nil
+
+          r = s.read
+          expect(outbuf.empty?).to be true
+          expect(r).to eq('')
+        end
+
+        it "should convert chunk to string" do
+          s = HTTP::StreamWriter.new do |sr|
+            sr << 100 << 200
+          end
+
+          r = s.read
+          expect(r).to eq("100200")
+        end
+
+        it "should encode string to bytes" do
+          s = HTTP::StreamWriter.new do |sr|
+            100.times { sr << "中" }
+          end
+
+          r = s.read(1)
+          expect(r).to eq('中'.force_encoding(Encoding::ASCII_8BIT)[0])
+          s.read(2)
+          r = s.read(3)
+          expect(r.force_encoding(Encoding::UTF_8)).to eq('中')
+
+          bytes = (100 - 2) * 3
+          outbuf = 'zzz'
+          r = s.read(bytes, outbuf)
+          expect(outbuf.size).to eq(bytes)
+          expect(r.size).to eq(bytes)
+
+          r = s.read
+          expect(r).to eq('')
         end
       end # StreamWriter
 

data/tests/test_content_type.rb

@@ -11,8 +11,8 @@ class TestContentType < Minitest::Test
     client = Aliyun::OSS::Client.new(
       :endpoint => conf['endpoint'],
       :cname => conf['cname'],
-      :access_key_id => conf['id'],
-      :access_key_secret => conf['key'])
+      :access_key_id => conf['access_key_id'],
+      :access_key_secret => conf['access_key_secret'])
     @bucket = client.get_bucket(conf['bucket'])
 
     @types = {

data/tests/test_encoding.rb

@@ -0,0 +1,81 @@
+# coding: utf-8
+require 'minitest/autorun'
+require 'yaml'
+$LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
+require 'aliyun/oss'
+
+class TestEncoding < Minitest::Test
+  def setup
+    Aliyun::OSS::Logging.set_log_level(Logger::DEBUG)
+    conf_file = '~/.oss.yml'
+    conf = YAML.load(File.read(File.expand_path(conf_file)))
+    client = Aliyun::OSS::Client.new(
+      :endpoint => conf['endpoint'],
+      :cname => conf['cname'],
+      :access_key_id => conf['access_key_id'],
+      :access_key_secret => conf['access_key_secret'])
+    @bucket = client.get_bucket(conf['bucket'])
+    @prefix = 'tests/encoding/'
+  end
+
+  def get_key(k)
+    @prefix + k
+  end
+
+  def test_utf_8
+    key = get_key('utf-8')
+    @bucket.put_object(key) do |stream|
+      stream << '中国' << 'Ruby'
+    end
+    put = '中国Ruby'.force_encoding(Encoding::ASCII_8BIT)
+    got = ''
+    @bucket.get_object(key) { |c| got << c }
+    assert_equal put, got
+
+    File.open('/tmp/x', 'w') { |f| f.write('中国Ruby') }
+    @bucket.put_object(key, :file => '/tmp/x')
+    got = ''
+    @bucket.get_object(key) { |c| got << c }
+    assert_equal put, got
+  end
+
+  def test_gbk
+    key = get_key('gbk')
+    @bucket.put_object(key) do |stream|
+      stream << '中国'.encode(Encoding::GBK) << 'Ruby'.encode(Encoding::GBK)
+    end
+    put = '中国Ruby'.encode(Encoding::GBK).force_encoding(Encoding::ASCII_8BIT)
+    got = ''
+    @bucket.get_object(key) { |c| got << c }
+    assert_equal put, got
+
+    File.open('/tmp/x', 'w') { |f| f.write('中国Ruby'.encode(Encoding::GBK)) }
+    @bucket.put_object(key, :file => '/tmp/x')
+    got = ''
+    @bucket.get_object(key) { |c| got << c }
+    assert_equal put, got
+  end
+
+  def encode_number(i)
+    [i].pack('N')
+  end
+
+  def test_binary
+    key = get_key('bin')
+    @bucket.put_object(key) do |stream|
+      (0..1024).each { |i| stream << encode_number(i) }
+    end
+    put = (0..1024).reduce('') { |s, i| s << encode_number(i) }
+    got = ''
+    @bucket.get_object(key) { |c| got << c }
+    assert_equal put, got
+
+    File.open('/tmp/x', 'w') { |f|
+      (0..1024).each { |i| f.write(encode_number(i)) }
+    }
+    @bucket.put_object(key, :file => '/tmp/x')
+    got = ''
+    @bucket.get_object(key) { |c| got << c }
+    assert_equal put, got
+  end
+end

data/tests/test_large_file.rb

@@ -12,8 +12,8 @@ class TestObjectKey < Minitest::Test
     client = Aliyun::OSS::Client.new(
       :endpoint => conf['endpoint'],
       :cname => conf['cname'],
-      :access_key_id => conf['id'],
-      :access_key_secret => conf['key'])
+      :access_key_id => conf['access_key_id'],
+      :access_key_secret => conf['access_key_secret'])
     @bucket = client.get_bucket(conf['bucket'])
     @prefix = 'tests/large_file/'
   end

data/tests/test_multipart.rb

@@ -4,15 +4,15 @@ require 'yaml'
 $LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
 require 'aliyun/oss'
 
-class TestMultipart < Minitest::Unit::TestCase
+class TestMultipart < Minitest::Test
   def setup
     conf_file = '~/.oss.yml'
     conf = YAML.load(File.read(File.expand_path(conf_file)))
     opts = {
       endpoint: conf['endpoint'],
       cname: conf['cname'],
-      access_key_id: conf['id'],
-      access_key_secret: conf['key'],
+      access_key_id: conf['access_key_id'],
+      access_key_secret: conf['access_key_secret'],
     }
     client = Aliyun::OSS::Client.new(opts)
     @bucket_name = conf['bucket']

data/tests/test_object_key.rb

@@ -12,8 +12,8 @@ class TestObjectKey < Minitest::Test
     client = Aliyun::OSS::Client.new(
       :endpoint => conf['endpoint'],
       :cname => conf['cname'],
-      :access_key_id => conf['id'],
-      :access_key_secret => conf['key'])
+      :access_key_id => conf['access_key_id'],
+      :access_key_secret => conf['access_key_secret'])
     @bucket = client.get_bucket(conf['bucket'])
     @prefix = 'tests/object_key/'
     @keys = {

data/tests/test_resumable.rb

@@ -11,8 +11,8 @@ class TestResumable < Minitest::Test
     client = Aliyun::OSS::Client.new(
       :endpoint => conf['endpoint'],
       :cname => conf['cname'],
-      :access_key_id => conf['id'],
-      :access_key_secret => conf['key'])
+      :access_key_id => conf['access_key_id'],
+      :access_key_secret => conf['access_key_secret'])
     @bucket = client.get_bucket(conf['bucket'])
     @prefix = 'tests/resumable/'
   end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: aliyun-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Tianlong Wu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-29 00:00:00.000000000 Z
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.22'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
 description: A Ruby program to facilitate accessing Aliyun Object Storage Service
@@ -151,6 +151,7 @@ files:
 - spec/aliyun/oss/service_spec.rb
 - spec/aliyun/oss/util_spec.rb
 - tests/test_content_type.rb
+- tests/test_encoding.rb
 - tests/test_large_file.rb
 - tests/test_multipart.rb
 - tests/test_object_key.rb
@@ -165,17 +166,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Aliyun OSS SDK for Ruby
@@ -191,8 +192,8 @@ test_files:
 - spec/aliyun/oss/service_spec.rb
 - spec/aliyun/oss/util_spec.rb
 - tests/test_content_type.rb
+- tests/test_encoding.rb
 - tests/test_large_file.rb
 - tests/test_multipart.rb
 - tests/test_object_key.rb
 - tests/test_resumable.rb
-has_rdoc: