aliyun-oss-ruby-sdk 0.4.1

data/examples/aliyun/oss/bucket.rb

@@ -0,0 +1,144 @@
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH.unshift(File.expand_path("../../../../lib", __FILE__))
+require 'yaml'
+require 'aliyun/oss'
+
+# 初始化OSS client
+AliyunSDK::Common::Logging.set_log_level(Logger::DEBUG)
+conf_file = '~/.oss.yml'
+conf = YAML.load(File.read(File.expand_path(conf_file)))
+client = AliyunSDK::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'])
+
+# 辅助打印函数
+def demo(msg)
+  puts "######### #{msg} ########"
+  puts
+  yield
+  puts "-------------------------"
+  puts
+end
+
+# 列出当前所有的bucket
+demo "List all buckets" do
+  buckets = client.list_buckets
+  buckets.each{ |b| puts "Bucket: #{b.name}"}
+end
+
+# 创建bucket，如果同名的bucket已经存在，则创建会失败
+demo "Create bucket" do
+  begin
+    bucket_name = 't-foo-bar'
+    client.create_bucket(bucket_name, :location => 'oss-cn-hangzhou')
+    puts "Create bucket success: #{bucket_name}"
+  rescue => e
+    puts "Create bucket failed: #{bucket_name}, #{e.message}"
+  end
+end
+
+# 向bucket中添加5个空的object:
+# foo/obj1, foo/bar/obj1, foo/bar/obj2, foo/xxx/obj1
+
+demo "Put objects before list" do
+  bucket.put_object('foo/obj1')
+  bucket.put_object('foo/bar/obj1')
+  bucket.put_object('foo/bar/obj2')
+  bucket.put_object('foo/xxx/obj1')
+  bucket.put_object('中国の')
+end
+
+# list bucket下所有objects
+demo "List first 10 objects" do
+  objects = bucket.list_objects
+
+  objects.take(10).each do |o|
+    puts "Object: #{o.key}, type: #{o.type}, size: #{o.size}"
+  end
+end
+
+# list bucket下所有前缀为foo/bar/的object
+demo "List first 10 objects with prefix 'foo/bar/'" do
+  objects = bucket.list_objects(:prefix => 'foo/bar/')
+
+  objects.take(10).each do |o|
+    puts "Object: #{o.key}, type: #{o.type}, size: #{o.size}"
+  end
+end
+
+# 获取object的common prefix，common prefix是指bucket下所有object（也可
+# 以指定特定的前缀）的公共前缀，这在object数量巨多的时候很有用，例如有
+# 如下的object：
+#     /foo/bar/obj1
+#     /foo/bar/obj2
+#     ...
+#     /foo/bar/obj9999999
+#     /foo/xx/
+# 指定foo/为prefix，/为delimiter，则返回的common prefix为
+# /foo/bar/, /foo/xxx/
+# 这可以表示/foo/目录下的子目录。如果没有common prefix，你可能要遍历所
+# 有的object来找公共的前缀
+
+demo "List first 10 objects/common prefixes" do
+  objects = bucket.list_objects(:prefix => 'foo/', :delimiter => '/')
+
+  objects.take(10).each do |o|
+    if o.is_a?(AliyunSDK::OSS::Object)
+      puts "Object: #{o.key}, type: #{o.type}, size: #{o.size}"
+    else
+      puts "Common prefix: #{o}"
+    end
+  end
+end
+
+# 获取/设置Bucket属性: ACL, Logging, Referer, Website, LifeCycle, CORS
+demo "Get/Set bucket properties: ACL/Logging/Referer/Website/Lifecycle/CORS" do
+  puts "Bucket acl before: #{bucket.acl}"
+  bucket.acl = AliyunSDK::OSS::ACL::PUBLIC_READ
+  puts "Bucket acl now: #{bucket.acl}"
+  puts
+
+  puts "Bucket logging before: #{bucket.logging.to_s}"
+  bucket.logging = AliyunSDK::OSS::BucketLogging.new(
+    :enable => true, :target_bucket => conf['bucket'], :target_prefix => 'foo/')
+  puts "Bucket logging now: #{bucket.logging.to_s}"
+  puts
+
+  puts "Bucket referer before: #{bucket.referer.to_s}"
+  bucket.referer = AliyunSDK::OSS::BucketReferer.new(
+    :allow_empty => true, :whitelist => ['baidu.com', 'aliyun.com'])
+  puts "Bucket referer now: #{bucket.referer.to_s}"
+  puts
+
+  puts "Bucket website before: #{bucket.website.to_s}"
+  bucket.website = AliyunSDK::OSS::BucketWebsite.new(
+    :enable => true, :index => 'default.html', :error => 'error.html')
+  puts "Bucket website now: #{bucket.website.to_s}"
+  puts
+
+  puts "Bucket lifecycle before: #{bucket.lifecycle.map(&:to_s)}"
+  bucket.lifecycle = [
+    AliyunSDK::OSS::LifeCycleRule.new(
+    :id => 'rule1', :enable => true, :prefix => 'foo/', :expiry => 1),
+    AliyunSDK::OSS::LifeCycleRule.new(
+      :id => 'rule2', :enable => false, :prefix => 'bar/', :expiry => Date.new(2016, 1, 1))
+  ]
+  puts "Bucket lifecycle now: #{bucket.lifecycle.map(&:to_s)}"
+  puts
+
+  puts "Bucket cors before: #{bucket.cors.map(&:to_s)}"
+  bucket.cors = [
+    AliyunSDK::OSS::CORSRule.new(
+    :allowed_origins => ['aliyun.com', 'http://www.taobao.com'],
+    :allowed_methods => ['PUT', 'POST', 'GET'],
+    :allowed_headers => ['Authorization'],
+    :expose_headers => ['x-oss-test'],
+    :max_age_seconds => 100)
+  ]
+  puts "Bucket cors now: #{bucket.cors.map(&:to_s)}"
+  puts
+end

data/examples/aliyun/oss/callback.rb

@@ -0,0 +1,61 @@
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH.unshift(File.expand_path("../../../../lib", __FILE__))
+require 'yaml'
+require 'json'
+require 'aliyun/oss'
+
+##
+# 用户在上传文件时可以指定“上传回调”，这样在文件上传成功后OSS会向用户
+# 提供的服务器地址发起一个HTTP POST请求，相当于一个通知机制。用户可以
+# 在收到回调的时候做相应的动作。
+# 1. 如何接受OSS的回调可以参考代码目录下的
+#    rails/aliyun_oss_callback_server.rb
+# 2. 只有put_object和resumable_upload支持上传回调
+
+# 初始化OSS client
+AliyunSDK::Common::Logging.set_log_level(Logger::DEBUG)
+conf_file = '~/.oss.yml'
+conf = YAML.load(File.read(File.expand_path(conf_file)))
+bucket = AliyunSDK::OSS::Client.new(
+  :endpoint => conf['endpoint'],
+  :cname => conf['cname'],
+  :access_key_id => conf['access_key_id'],
+  :access_key_secret => conf['access_key_secret']).get_bucket(conf['bucket'])
+
+# 辅助打印函数
+def demo(msg)
+  puts "######### #{msg} ########"
+  puts
+  yield
+  puts "-------------------------"
+  puts
+end
+
+demo "put object with callback" do
+  callback = AliyunSDK::OSS::Callback.new(
+    url: 'http://10.101.168.94:1234/callback',
+    query: {user: 'put_object'},
+    body: 'bucket=${bucket}&object=${object}'
+  )
+
+  begin
+    bucket.put_object('files/hello', callback: callback)
+  rescue AliyunSDK::OSS::CallbackError => e
+    puts "Callback failed: #{e.message}"
+  end
+end
+
+demo "resumable upload with callback" do
+  callback = AliyunSDK::OSS::Callback.new(
+    url: 'http://10.101.168.94:1234/callback',
+    query: {user: 'resumable_upload'},
+    body: 'bucket=${bucket}&object=${object}'
+  )
+
+  begin
+    bucket.resumable_upload('files/world', '/tmp/x', callback: callback)
+  rescue AliyunSDK::OSS::CallbackError => e
+    puts "Callback failed: #{e.message}"
+  end
+end

data/examples/aliyun/oss/object.rb

@@ -0,0 +1,182 @@
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH.unshift(File.expand_path("../../../../lib", __FILE__))
+require 'yaml'
+require 'aliyun/oss'
+
+# 初始化OSS client
+AliyunSDK::Common::Logging.set_log_level(Logger::DEBUG)
+conf_file = '~/.oss.yml'
+conf = YAML.load(File.read(File.expand_path(conf_file)))
+bucket = AliyunSDK::OSS::Client.new(
+  :endpoint => conf['endpoint'],
+  :cname => conf['cname'],
+  :access_key_id => conf['access_key_id'],
+  :access_key_secret => conf['access_key_secret']).get_bucket(conf['bucket'])
+
+# 辅助打印函数
+def demo(msg)
+  puts "######### #{msg} ########"
+  puts
+  yield
+  puts "-------------------------"
+  puts
+end
+
+# 上传一个object
+# 流式上传请参考：examples/streaming.rb
+demo "Put object from input" do
+  bucket.put_object('files/hello') do |content|
+    content << 'hello world.'
+  end
+  puts "Put object: files/hello"
+end
+
+# 上传一个文件
+# 断点续传请参考：examples/resumable_upload.rb
+demo "Put object from local file" do
+  File.open('/tmp/x', 'w'){ |f| f.write("hello world\n") }
+  bucket.put_object('files/world', :file => '/tmp/x')
+  puts "Put object: files/world"
+end
+
+# 创建一个Appendable object
+demo "Create appendable object" do
+size = bucket.get_object('files/appendable').size rescue 0
+  bucket.append_object('files/appendable', size) do |content|
+    content << 'hello appendable.'
+  end
+  puts "Append object: files/appendable"
+end
+
+# 向files/appendable中追加内容
+# 首先要获取object当前的长度
+demo "Append to object" do
+  size = bucket.get_object('files/appendable').size
+  bucket.append_object('files/appendable', size) do |content|
+    content << 'again appendable.'
+  end
+  puts "Append object: files/appendable"
+end
+
+# 使用错误的position进行追加会失败
+demo "Append with wrong pos" do
+  begin
+    bucket.append_object('files/appendable', 0) do |content|
+      content << 'again appendable.'
+    end
+  rescue => e
+    puts "Append failed: #{e.message}"
+  end
+end
+
+# 向一个normal object中追加内容会失败
+demo "Append to normal object(fail)" do
+  begin
+    bucket.append_object('files/hello', 0) do |content|
+      content << 'hello appendable.'
+    end
+  rescue => e
+    puts "Append object failed: #{e.message}"
+  end
+end
+
+# 拷贝一个object
+demo "Copy object" do
+  bucket.copy_object('files/hello', 'files/copy')
+  puts "Copy object files/hello => files/copy"
+end
+
+# 拷贝一个appendable object会失败
+demo "Copy appendable object(fail)" do
+  begin
+    bucket.copy_object('files/appendable', 'files/copy')
+  rescue => e
+    puts "Copy object failed: #{e.message}"
+  end
+end
+
+# 下载一个object：流式处理
+# 流式下载请参考：examples/streaming.rb
+demo "Get object: handle content" do
+  total_size = 0
+  bucket.get_object('files/hello') do |chunk|
+    total_size += chunk.size
+  end
+  puts "Total size: #{total_size}"
+end
+
+# 下载一个object：下载到文件中
+demo "Get object to local file" do
+  bucket.get_object('files/hello', :file => '/tmp/hello')
+  puts "Get object: files/hello => /tmp/hello"
+end
+
+# 删除一个object
+demo "Delete object" do
+  bucket.delete_object('files/world')
+  puts "Delete object: files/world"
+end
+
+# 删除一个不存在的object返回OK
+# 这意味着delete_object是幂等的，在删除失败的时候可以不断重试，直到成
+# 功，成功意味着object已经不存在
+demo "Delete a non-existent object(OK)" do
+  bucket.delete_object('non-existent-object')
+  puts "Delete object: non-existent-object"
+end
+
+# 设置Object metas
+demo "Put objec with metas" do
+  bucket.put_object(
+    'files/hello',
+    :metas => {'year' => '2015', 'people' => 'mary'}
+  ) do |content|
+    content << 'hello world.'
+  end
+
+  o = bucket.get_object('files/hello', :file => '/tmp/x')
+  puts "Object metas: #{o.metas}"
+end
+
+# 修改Object metas
+demo "Update object metas" do
+  bucket.update_object_metas(
+    'files/hello', {'year' => '2016', 'people' => 'jack'})
+  o = bucket.get_object('files/hello')
+  puts "Meta changed: #{o.metas}"
+end
+
+# 设置Object的ACL
+
+demo "Set object ACL" do
+  puts "Object acl before: #{bucket.get_object_acl('files/hello')}"
+  bucket.set_object_acl('files/hello', AliyunSDK::OSS::ACL::PUBLIC_READ)
+  puts "Object acl now: #{bucket.get_object_acl('files/hello')}"
+end
+
+# 指定条件get_object
+demo "Get object with conditions" do
+  o = bucket.get_object('files/hello')
+
+  begin
+    o = bucket.get_object(
+      'files/hello',
+      :condition => {:if_match_etag => o.etag + 'x'})
+  rescue AliyunSDK::OSS::ServerError => e
+    puts "Get object failed: #{e.message}"
+  end
+
+  begin
+    o = bucket.get_object(
+      'files/hello',
+      :condition => {:if_unmodified_since => o.last_modified - 60})
+  rescue AliyunSDK::OSS::ServerError => e
+    puts "Get object failed: #{e.message}"
+  end
+
+  o = bucket.get_object(
+    'files/hello',
+    :condition => {:if_match_etag => o.etag, :if_unmodified_since => Time.now})
+  puts "Get object: #{o.to_s}"
+end

data/examples/aliyun/oss/resumable_download.rb

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH.unshift(File.expand_path("../../../../lib", __FILE__))
+require 'yaml'
+require 'aliyun/oss'
+
+# 初始化OSS Bucket
+AliyunSDK::Common::Logging.set_log_level(Logger::DEBUG)
+conf_file = '~/.oss.yml'
+conf = YAML.load(File.read(File.expand_path(conf_file)))
+bucket = AliyunSDK::OSS::Client.new(
+  :endpoint => conf['endpoint'],
+  :cname => conf['cname'],
+  :access_key_id => conf['access_key_id'],
+  :access_key_secret => conf['access_key_secret']).get_bucket(conf['bucket'])
+
+# 辅助打印函数
+def demo(msg)
+  puts "######### #{msg} ########"
+  puts
+  yield
+  puts "-------------------------"
+  puts
+end
+
+demo "Resumable download" do
+  # 下载一个100M的文件
+  cpt_file = '/tmp/y.cpt'
+  File.delete(cpt_file) if File.exist?(cpt_file)
+  start = Time.now
+  puts "Start download: resumable => /tmp/y"
+  bucket.resumable_download(
+    'resumable', '/tmp/y', :cpt_file => cpt_file) do |progress|
+    puts "Progress: #{(progress * 100).round(2)} %"
+  end
+  puts "Download complete. Cost: #{Time.now - start} seconds."
+
+  # 测试方法：
+  # 1. ruby examples/resumable_download.rb
+  # 2. 过几秒后用Ctrl-C中断下载
+  # 3. ruby examples/resumable_download.rb恢复下载
+end

data/examples/aliyun/oss/resumable_upload.rb

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH.unshift(File.expand_path("../../../../lib", __FILE__))
+require 'yaml'
+require 'aliyun/oss'
+
+# 初始化OSS Bucket
+AliyunSDK::Common::Logging.set_log_level(Logger::DEBUG)
+conf_file = '~/.oss.yml'
+conf = YAML.load(File.read(File.expand_path(conf_file)))
+bucket = AliyunSDK::OSS::Client.new(
+  :endpoint => conf['endpoint'],
+  :cname => conf['cname'],
+  :access_key_id => conf['access_key_id'],
+  :access_key_secret => conf['access_key_secret']).get_bucket(conf['bucket'])
+
+# 辅助打印函数
+def demo(msg)
+  puts "######### #{msg} ########"
+  puts
+  yield
+  puts "-------------------------"
+  puts
+end
+
+demo "Resumable upload" do
+  puts "Generate file: /tmp/x, size: 100MB"
+  # 生成一个100M的文件
+  File.open('/tmp/x', 'w') do |f|
+    (1..1024*1024).each{ |i| f.puts i.to_s.rjust(99, '0') }
+  end
+
+  cpt_file = '/tmp/x.cpt'
+  File.delete(cpt_file) if File.exist?(cpt_file)
+
+  # 上传一个100M的文件
+  start = Time.now
+  puts "Start upload: /tmp/x => resumable"
+  bucket.resumable_upload(
+    'resumable', '/tmp/x', :cpt_file => cpt_file) do |progress|
+    puts "Progress: #{(progress * 100).round(2)} %"
+  end
+  puts "Upload complete. Cost: #{Time.now - start} seconds."
+
+  # 测试方法：
+  # 1. ruby examples/resumable_upload.rb
+  # 2. 过几秒后用Ctrl-C中断上传
+  # 3. ruby examples/resumable_upload.rb恢复上传
+end