aliyunoss 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6d5f91f7798d9c53064203c5d72a04c316f4e4c
+  data.tar.gz: a984576bb7a203542fe326c7620482ee8f245346
+SHA512:
+  metadata.gz: 711cbd85c09bcef395be43cc99a65bdedf4435e44b1ac350e9a75c17835258d37f82b7a7e5b30204011779e62e27840f54e34f61dafe2a54873a6261f7e0d239
+  data.tar.gz: a384ed6fb2f98eaa46985b491df0a7369197e6ee26e7e037dc7bac821fa14b173088707da9b00dcbdb73716bfc69b6a9fd10aa931351d37cb8d9ea8faa20b17b

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*~
+aliyun-config.yml

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in aliyun-oss.gemspec
+gemspec
+
+gem 'nokogiri', '~> 1.6'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 yijiecc
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# Aliyun::Oss
+
+Ruby gem for [Aliyun Open Storage Service (OSS)][1]. This gem implemented API from [references of Aliyun OSS-API][2].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aliyunoss'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aliyunoss
+
+## Usage
+
+This gem provides high level interfaces which are built around class Bucket and low level interfaces which are wrappers for [OSS API][2].
+
+### Load Access Key ID and Access Key Secret
+
+Specify you access key and access secret before calling methods provided in this gem:
+
+	Aliyun::Oss::configure(:access_key_id => 'access key id from aliyun', :access_key_secret => 'access secret from aliyun')
+
+### Low Level Interfaces
+
+Low level interfaces are simple wrappers for [OSS API][2], you send requests with specified parameters and receive responses with a Net::HTTPResponse object. All parameters listed in [OSS API][2] are needed for every request, and context info between requests is maintained by yourself. In order to tell whether a a request is success, check code and body of returned Net::HTTPResponse object.
+
+All [OSS API][2] listed are implemented except [Post Object][3] and [CORS APIs][4].
+
+List all the buckets:
+
+	Aliyun::Oss::API.list_bucket
+
+Upload data to specified bucket:
+
+	bucket = Aliyun::Oss::Bucket.new(:name => 'bucket-name', :location => 'oss-cn-beijing')
+	path = '/test.dat'
+	data = Random.new.bytes(1024 * rand(100..300))
+	Aliyun::Oss::API.put_object(bucket, path, data)
+
+Download data from specified bucket:
+
+	bucket = Bucket.new(:name => 'bucket-name', :location => 'oss-cn-beijing')
+	path = '/test.dat'
+	Aliyun::Oss::API.get_object(bucket, path)
+
+For more usage, see API documentation generated by rdoc.
+
+### High Level Interfaces
+
+High level interface are built around class Bucket. You create a new bucket, and upload, download or delete files in it. When needed, responses are parsed to array, hash or object etc, thus more meaningful. Exceptions will be raised when request failed.
+
+	# Create a bucket in OSS server
+	bucket = Aliyun::Oss::Bucket.create('aliyun-oss-gem-api-test','oss-cn-hangzhou')
+	
+	# Upload a file
+	filename = '/some/file'
+	bucket.upload( IO.read(filename) )
+	
+	# List all files in this bucket, returns a Hash array containing files info
+	files = bucket.list_files
+	
+	# Download a file, returns raw data
+	data = bucket.download( '/some/path' )
+	
+For more usage, see API documentation generated by rdoc.	
+	
+## Testing
+
+This gem use rspec for testing. Most of testing needs a valid access key id and access key secret, you should get these info from Aliyun.
+
+Create a file named aliyun-config.yml in path rspec/aliyun/oss, fill in valid access key id and access key secret and cotinue to test.
+
+## Contributing
+
+1. Fork it ( https://github.com/yijiecc/aliyunoss/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[1]: http://www.aliyun.com/product/oss
+[2]: http://docs.aliyun.com/?spm=5176.383663.9.2.F8rxxr#/oss/api-reference/abstract
+[3]: http://docs.aliyun.com/?spm=5176.383663.9.2.F8rxxr#/oss/api-reference/object&PostObject
+[4]: http://docs.aliyun.com/?spm=5176.383663.9.2.F8rxxr#/oss/api-reference/cors&abstract

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+task default: %w[spec]
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color']
+end

data/aliyunoss.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aliyunoss/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aliyunoss"
+  spec.version       = Aliyun::Oss::VERSION
+  spec.authors       = ["yijiecc"]
+  spec.email         = ["yijiecc@hotmail.com"]
+  spec.summary       = %q{A gem for accessing Aliyun Open Storage Service.}
+  spec.description   = %q{Access Aliyun-OSS service easily in ruby.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

data/lib/aliyunoss/api.rb

@@ -0,0 +1,222 @@
+module Aliyun
+  module Oss
+
+    module API
+      extend self
+
+      # Reference
+      # http://docs-aliyun-com-cn-b.oss-cn-hangzhou.aliyuncs.com/oss/pdf/oss_api-reference.pdf
+
+      # List all buckets
+      def list_bucket(params = {})
+        Aliyun::Oss::OssRequest.new(nil, '/', params).get
+      end
+      alias :get_service :list_bucket
+
+      # Create a new bucket
+      def put_bucket(name, location = 'oss-cn-hangzhou')
+        bucket = Bucket.new(name: name, location: location)
+        request = Aliyun::Oss::OssRequest.new(bucket, '/')
+        request.body = <<HERE
+<?xml version="1.0" encoding="UTF-8"?>
+<CreateBucketConfiguration>
+<LocationConstraint>#{location}</LocationConstraint>
+</CreateBucketConfiguration>
+HERE
+        request.put
+      end
+      alias :create_bucket :put_bucket
+
+      # Delete a bucket
+      def delete_bucket(bucket)
+        Aliyun::Oss::OssRequest.new(bucket, '/').delete
+      end
+        
+      # Delete bucket logging
+      def delete_logging(bucket)
+        Aliyun::Oss::OssRequest.new(bucket, '/', 'logging'=>nil).delete
+      end
+
+      # Delete bucket website
+      def delete_website(bucket)
+        Aliyun::Oss::OssRequest.new(bucket, '/', 'website'=>nil).delete
+      end
+      alias :disable_website :delete_website
+
+      # List objects in bucket
+      def list_object(bucket, queries = {})
+        Aliyun::Oss::OssRequest.new(bucket, '/', queries).get
+      end
+
+      # Get bucket acl
+      def get_bucket_acl(bucket)
+        Aliyun::Oss::OssRequest.new(bucket, '/', 'acl'=>nil).get
+      end
+
+      # Get bucket location
+      def get_bucket_location(bucket)
+        Aliyun::Oss::OssRequest.new(bucket, '/', 'location'=>nil).get
+      end
+
+      # Query bucket logging status
+      def get_bucket_logging(bucket)
+        Aliyun::Oss::OssRequest.new(bucket, '/', 'logging'=>nil).get
+      end
+
+      # Query bucket website status
+      def get_bucket_website(bucket)
+        Aliyun::Oss::OssRequest.new(bucket, '/', 'website'=>nil).get
+      end
+
+      # Set bucket acl permission
+      def put_bucket_acl(bucket, permission)
+        Aliyun::Oss::OssRequest.new(bucket, '/', {}, 'x-oss-acl'=> permission).put
+      end
+      alias :set_bucket_acl :put_bucket_acl
+
+      # Enable or disable bucket logging
+      def enable_bucket_logging(bucket, bucket_name_for_logging, log_prefix)
+        request = Aliyun::Oss::OssRequest.new(bucket, '/', 'logging'=>nil)
+        request.body = <<HERE
+<?xml version="1.0" encoding="UTF-8"?>
+<BucketLoggingStatus>
+  <LoggingEnabled>
+    <TargetBucket>#{bucket_name_for_logging}</TargetBucket>
+    <TargetPrefix>#{log_prefix}</TargetPrefix>
+  </LoggingEnabled>
+</BucketLoggingStatus>
+HERE
+        request['Content-Type'] = 'application/xml'
+        request.put
+      end
+
+      def disable_bucket_logging(bucket)
+        request = Aliyun::Oss::OssRequest.new(bucket, '/', 'logging'=>nil)
+        request.body = <<HERE
+<?xml version="1.0" encoding="UTF-8"?>
+<BucketLoggingStatus>
+</BucketLoggingStatus>
+HERE
+        request['Content-Type'] = 'application/xml'
+        request.put        
+      end
+
+      # Set bucket website access
+      def put_bucket_website(bucket, index_page, error_page)
+        request = Aliyun::Oss::OssRequest.new(bucket, '/', 'website'=>nil)
+        request.body = <<HERE
+<?xml version="1.0" encoding="UTF-8"?>
+<WebsiteConfiguration>
+  <IndexDocument>
+    <Suffix>#{index_page}</Suffix>
+  </IndexDocument>
+  <ErrorDocument>
+    <Key>#{error_page}</Key>
+  </ErrorDocument>
+</WebsiteConfiguration>
+HERE
+        request['Content-Type'] = 'application/xml'
+        request.put
+      end
+      alias :set_bucket_website :put_bucket_website
+      
+      # Copy Object
+      def copy_object(source_bucket, source_path, target_bucket, target_path, headers = {})
+        headers = headers.merge({'x-oss-copy-source'=> "/" + source_bucket.name + source_path})
+        Aliyun::Oss::OssRequest.new(target_bucket, target_path, {}, headers).put
+      end
+
+      # Delete Object
+      def delete_object(bucket, path)
+        Aliyun::Oss::OssRequest.new(bucket, path).delete
+      end
+
+      # Delete Multiple Object
+      def delete_multiple_objects(bucket, objects, quiet_mode = false)
+        xml = '<?xml version="1.0" encoding="UTF-8"?>'
+        xml << '<Delete>'
+        xml << "<Quiet>#{quiet_mode}</Quiet>"
+        objects.each {|o| xml << "<Object><Key>#{o}</Key></Object>"}
+        xml << '</Delete>'
+        request = Aliyun::Oss::OssRequest.new(bucket, '/', 'delete'=>nil)
+        request.body = xml
+        request.post
+      end
+
+      # Get Object
+      def get_object(bucket, path, headers = {})
+        Aliyun::Oss::OssRequest.new(bucket, path, {}, headers).get
+      end
+
+      # Head Object
+      def head_object(bucket, path, headers = {})
+        Aliyun::Oss::OssRequest.new(bucket, path, {}, headers).head
+      end
+
+      # Put Object
+      def put_object(bucket, path, data, headers = {})
+        request = Aliyun::Oss::OssRequest.new(bucket, path, {}, headers)
+        request.body = data
+        request.put
+      end
+
+      
+
+      # Post Object
+      # Not implemented
+
+      # Post Policy
+      # Not implemented
+
+      # Post signature
+      # Not implemented
+
+      # Multipart Initiate
+      def multipart_upload_initiate(bucket, path)
+        Aliyun::Oss::OssRequest.new(bucket, path, 'uploads'=>nil).post
+      end
+
+      def multipart_upload_part(bucket, path, upload_id, data, part_number)
+        request = Aliyun::Oss::OssRequest.new(bucket, path, 'partNumber'=> part_number.to_s, 'uploadId'=> upload_id)
+        request.body = data
+        request.put
+      end
+
+      def multipart_upload_from_copy(upload_id, source_bucket, source_path, target_bucket, target_path, part_number, part_size, range = nil)
+        request = Aliyun::Oss::OssRequest.new(target_bucket, target_path, 'partNumber'=> part_number.to_s, 'uploadId'=> upload_id)
+        request['Content-Length'] = part_size
+        request['x-oss-copy-source'] = "/" + source_bucket.name + source_path
+        request['x-oss-copy-source-range'] = range if range        
+        request.put
+      end
+
+      def multipart_upload_complete(bucket, path, upload_id, part_list)
+        request = Aliyun::Oss::OssRequest.new(bucket, path, 'uploadId'=> upload_id)
+        xml = '<?xml version="1.0" encoding="UTF-8"?>'        
+        xml << '<CompleteMultipartUpload>'
+        part_list.each_pair {|k,v| xml << "<Part><PartNumber>#{k}</PartNumber><ETag>#{v}</ETag></Part>"}
+        xml << '</CompleteMultipartUpload>'
+        request.body = xml
+        request.post
+      end
+
+      def multipart_upload_abort(bucket, path, upload_id)
+        Aliyun::Oss::OssRequest.new(bucket, path, 'uploadId'=> upload_id).delete
+      end
+
+      def multipart_upload_finished_parts(bucket, path, upload_id)
+        Aliyun::Oss::OssRequest.new(bucket, path, 'uploadId'=> upload_id).get
+      end
+
+      def multipart_upload_unfinished_task(bucket)
+        Aliyun::Oss::OssRequest.new(bucket, '/', 'uploads'=>nil).get
+      end
+      
+    end
+      
+  end
+end
+
+
+
+

data/lib/aliyunoss/bucket.rb

@@ -0,0 +1,131 @@
+module Aliyun
+  module Oss
+
+    class Bucket
+      attr_accessor :location, :name, :creation_date
+
+      def initialize(params = {})
+        params.each_pair {|k,v| send("#{k.to_s}=", v) }
+        if String === @creation_date
+          @creation_date =~ /(\d+) ([a-zA-Z]+) (\d+) (\d\d):(\d\d):(\d\d)/
+          @creation_date = Time.gm($3, $2, $1, $4, $5, $6)
+        end
+      end
+
+      # Class methods
+      def self.all
+        Aliyun::Oss::API.list_bucket.to_buckets
+      end
+
+      def self.create(name, location = 'oss-cn-hangzhou')
+        if Aliyun::Oss::API.put_bucket(name, location).class == Net::HTTPOK
+          Bucket.new(:name => name,  :location=> location, :creation_date => Time.now)
+        else
+          nil
+        end
+      end
+
+      # Instance Methods -- object download and upload
+      def list_files(options = {})
+        Aliyun::Oss::API.list_object(self, options).to_objects
+      end
+
+      def upload(data, path, options = {})
+        Aliyun::Oss::API.put_object(self, path, data, options).raise_if_not(Net::HTTPOK)
+      end
+
+      def download(path, options = {})
+        response = Aliyun::Oss::API.get_object(self, path, options)
+        response.raise_if_not(Net::HTTPOK)
+        response.body
+      end
+
+      def delete(path)
+        Aliyun::Oss::API.delete_object(self, path).raise_if_not(Net::HTTPNoContent)
+      end
+
+      # Multipart upload and copy
+      def multipart_pending
+        Aliyun::Oss::API.multipart_upload_unfinished_task(self).to_mutlipart_task
+      end
+
+      def multipart_abort(path, upload_id)
+        Aliyun::Oss::API.multipart_upload_abort(self, path, upload_id).raise_if_not(Net::HTTPNoContent)
+      end
+
+      def multipart_upload(data)
+        raise 'You must call multipart_upload_initiate before upload data.' unless @multipart_path
+        response = Aliyun::Oss::API.multipart_upload_part(self, @multipart_path,
+                                               @multipart_id,
+                                               data, @multipart_sequence)
+        response.raise_if_not(Net::HTTPOK)
+        @multipart_list[@multipart_sequence] = response['ETag']
+        @multipart_sequence = @multipart_sequence + 1
+      end
+
+      def multipart_copy_from(source_bucket, source_path, size, range = nil)
+        response = Aliyun::Oss::API.multipart_upload_from_copy(@multipart_id,
+                                                               source_bucket, source_path,
+                                                               self, @multipart_path,
+                                                               @multipart_sequence,
+                                                               size, range)
+        response.raise_if_not(Net::HTTPOK)
+        @multipart_list[@multipart_sequence] = response['ETag']
+        @multipart_sequence = @multipart_sequence + 1        
+      end
+
+      def multipart_upload_initiate(path)
+        @multipart_path = path
+        @multipart_id = Aliyun::Oss::API.multipart_upload_initiate(self, path).to_multipart_id
+        @multipart_list = {}
+        @multipart_sequence = 1
+      end
+
+      def multipart_upload_complete
+        Aliyun::Oss::API.multipart_upload_complete(self, @multipart_path,
+                                                   @multipart_id,
+                                                   @multipart_list)
+          .raise_if_not(Net::HTTPOK)
+        @multipart_path = nil
+      end
+
+      # Instance Methods -- miscellaneous
+      def delete!
+        Aliyun::Oss::API.delete_bucket(self).raise_if_not(Net::HTTPNoContent)
+      end
+
+      def disable_logging
+        Aliyun::Oss::API.delete_logging(self).raise_if_not(Net::HTTPNoContent)
+      end
+
+      def enable_logging(target_bucket_name, log_prefix)
+        Aliyun::Oss::API.enable_bucket_logging(self, target_bucket_name, log_prefix).raise_if_not(Net::HTTPOK)
+      end
+
+      def logging_status
+        Aliyun::Oss::API.get_bucket_logging(self).to_logging_status
+      end
+
+      def disable_website_access
+        Aliyun::Oss::API.delete_website(self).raise_if_not(Net::HTTPNoContent)
+      end
+
+      def enable_website_access(index_page, error_page)
+        Aliyun::Oss::API.put_bucket_website(self, index_page, error_page).raise_if_not(Net::HTTPOK)
+      end
+
+      def website_access_status
+        Aliyun::Oss::API.get_bucket_website(self).to_website_status
+      end
+
+      def set_acl(permission)
+        Aliyun::Oss::API.put_bucket_acl(self, permission).raise_if_not(Net::HTTPOK)
+      end
+
+      def get_acl
+        Aliyun::Oss::API.get_bucket_acl(self).to_acl_status
+      end
+    end
+    
+  end
+end

data/lib/aliyunoss/config.rb

@@ -0,0 +1,47 @@
+require 'yaml'
+require 'logger'
+
+module Aliyun
+  module Oss
+
+    @config = {
+      :log_level => 'info',
+      :host => 'aliyuncs.com',
+      :access_key_id => nil,
+      :access_key_secret => nil
+    }
+
+    @_logger = nil
+
+    @valid_config_keys = @config.keys
+
+    def self.configure(opts = {})
+      @_logger = nil
+      opts.each {|k,v| @config[k.to_sym] = v if @valid_config_keys.include?(k.to_sym)}
+    end
+
+    def self.configure_with(yaml_file)
+      begin
+        config = YAML::load(IO.read(yaml_file))
+        configure(config)
+      rescue Errno::ENOENT
+        logger.warn("YAML configuration file couldn't be found. Using defaults.")
+      rescue Psych::SyntaxError
+        logger.warn("YAML configuration file contains invalid syntax. Using defaults.")
+      end
+    end
+
+    def self.config
+      @config
+    end
+
+    def self.logger
+      unless @_logger
+        @_logger ||= Logger.new(STDOUT)
+        @_logger.level = Logger.const_get(@config[:log_level].upcase) rescue Logger::INFO        
+      end
+      @_logger
+    end
+    
+  end
+end

data/lib/aliyunoss/extension.rb

@@ -0,0 +1,34 @@
+class Hash
+  # Convert hash to http query string
+  def to_query_string
+    array = Array.new
+    self.each_pair {|k,v| array << (if v then k+"="+v else k end)}
+    array.join('&')
+  end
+end
+
+class String
+  # Convert http query string to hash
+  def query_string_to_hash
+    hash = Hash.new
+    self.split('&').each do |q|
+      if q["="]
+        k,v = q.split('=')
+        hash[k] = v
+      else
+        hash[q] = nil
+      end
+    end
+    hash
+  end
+
+  # Convert CamelCase to ruby_case
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+
+end

data/lib/aliyunoss/helper.rb

@@ -0,0 +1,27 @@
+module Aliyun
+  module Oss
+
+    module ConfigHelper
+      def logger
+        Aliyun::Oss.logger
+      end
+
+      def config
+        Aliyun::Oss.config
+      end
+
+      def access_key_id
+        Aliyun::Oss.config[:access_key_id]
+      end
+
+      def access_key_secret
+        Aliyun::Oss.config[:access_key_secret]
+      end
+
+      def host
+        Aliyun::Oss.config[:host]
+      end
+
+    end
+  end
+end