oss 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3b2ed6f0211cebe848128e657d3d2de6c9de0ff
+  data.tar.gz: bd5887255606c389a5831a4b7bf1b3c24b8a07fa
+SHA512:
+  metadata.gz: af7a50af242a892367eea47d2781171153543b56dae24dad9718fe7fdf6f1b311e66df5d1c002e74884b2f31b20a57c0f6bf29b72a3079301bc540e683c05316
+  data.tar.gz: 1da0ae248563da50cb0c3a3d8b491187f67cbfdb5b11f0aefe51c04e2ad0f811daa4e08b10fa8cd91d06268b43fb65249b77a91d1935ecfe30368154d32c2584

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+.DS_Store
+Thumbs.db
+.cache
+.project
+.settings
+.tmproj
+*.esproj
+nbproject
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# dependencies in oss-ruby-sdk.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 1999-2015 RaymondChou
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,113 @@
+# OSS Ruby SDK
+
+Aliyun Open Storage Service Ruby SDK.
+
+Being Aliyun-launched cloud storage service for users, the Open Storage Service (OSS for short) features mass capacity, security, high cost-effectiveness and reliability. It enables users to upload or download data to or from any device on the Internet at any time and place, and manage data on the WEB page by using the simple REST interface.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oss'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oss
+
+## Usage
+
+### Create Account
+
+Go to OSS website, create a new account for new user.
+
+After account created, you can create the OSS instance and get the `accessKeyId` and `accessKeySecret`.
+
+### Quick Start
+
+#### 1. Initialize OSS API
+
+```ruby
+# require the gem if you not set in Gemfile
+require 'oss'
+
+endpoint = 'oss-cn-hangzhou.aliyuncs.com'
+@api = Oss::Api.new(endpoint, access_key_id, access_key_secret)
+```
+
+Rails Application Config:
+
+create `oss.yml` file in your rails application `config` path:
+
+```yml
+default: &default
+  access_key_id: ""
+  access_key_secret: ""
+  endpoint: ""
+  bucket: ""
+
+production:
+  <<: *default
+
+staging:
+  <<: *default
+
+development:
+  <<: *default
+
+test:
+  <<: *default
+```
+
+#### 2. Create New Bucket
+
+```ruby
+# set bucket name
+bucket_name = 'bucket_name'
+# set bucket acl
+acl = 'public-read'
+
+puts 'create bucket success' if @api.put_bucket(bucket_name, acl)
+```
+you can find more api options in API Doc `OSS::Bucket`
+
+#### 3. Upload Object
+
+```ruby
+file = File.read('/path/to/your/file')
+puts 'create object success' if @api.put_object('bucket_name', 'object_name', file)
+```
+
+you can find more api options in API Doc `OSS::Object`
+
+#### 4. List All Objects
+
+```ruby
+bucket = @api.get_bucket('bucket_name')
+p bucket.contents
+```
+you can find more api options in API Doc `OSS::Bucket`
+
+#### 5. Get(download) A Object
+
+```ruby
+object = @api.get_object('bucket_name', 'object_name')
+# show all file headers
+p object.headers
+
+# save file
+file = File.new('/path/to/save', 'w')
+file.puts object.body
+file.close
+```
+you can find more api options in API Doc `OSS::Object`
+
+## License
+
+The gem is available as open source under the terms of the [Apache 2.0 License](http://opensource.org/licenses/Apache-2.0).
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "oss"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/oss.rb

@@ -0,0 +1,43 @@
+require 'oss/version'
+require 'oss/api'
+require 'oss/client'
+require 'oss/service'
+require 'oss/bucket'
+require 'oss/object'
+require 'oss/multipart'
+require 'oss/cors'
+
+module Oss
+
+  attr_reader :config
+
+  # load configs for Rails app
+  def self.config
+    @config ||= begin
+      if defined? Rails
+        config_file = Rails.root.join('config/oss.yml')
+        config = YAML.load(ERB.new(File.new(config_file).read).result)[Rails.env] if File.exist?(config_file)
+      end
+
+      config ||= config_from_environment
+      config.symbolize_keys!
+      config[:endpoint] ||= 'oss-cn-hangzhou.aliyuncs.com'
+      OpenStruct.new(config)
+    end
+  end
+
+  def self.api
+    @api ||= Api.new(config.endpoint, config.access_key_id, config.access_key_secret, config.bucket)
+  end
+
+  # load configs from environment
+  def self.config_from_environment
+    {
+        access_key_id: ENV['OSS_ID'],
+        access_key_secret: ENV['OSS_SECRET'],
+        endpoint: ENV['ENDPOINT'],
+        bucket: ENV['BUCKET'],
+    }
+  end
+
+end

data/lib/oss/api.rb

@@ -0,0 +1,342 @@
+require 'oss/service'
+require 'oss/bucket'
+require 'oss/object'
+require 'oss/multipart'
+require 'oss/cors'
+
+module Oss
+
+  class Api
+
+    attr_accessor :client, :bucket
+
+    def initialize(endpoint, access_key_id, access_key_secret, bucket = nil)
+      @bucket = bucket
+      @client = Client.new(endpoint, access_key_id, access_key_secret)
+    end
+
+
+    #######################
+    # Service
+    #######################
+
+    # params:
+    # - options:
+    #   - prefix
+    #   - marker
+    #   - max_keys
+    def get_service(options = {})
+      Service.new(@client).get_service(options)
+    end
+
+    alias_method :list_bucket, :get_service
+
+
+    #######################
+    # Bucket
+    #######################
+
+    # params:
+    # - bucket_name
+    # - acl
+    def put_bucket(bucket_name, acl)
+      Bucket.new(@client).put_bucket(bucket_name, acl)
+    end
+
+    # params:
+    # - bucket_name
+    # - acl
+    def put_bucket_acl(bucket_name, acl)
+      Bucket.new(@client).put_bucket_acl(bucket_name, acl)
+    end
+
+    # params:
+    # - bucket_name
+    # - target_bucket
+    # - enable
+    # - target_prefix
+    def put_bucket_logging(bucket_name, target_bucket, enable = true, target_prefix = nil)
+      Bucket.new(@client).put_bucket_logging(bucket_name, target_bucket, enable, target_prefix)
+    end
+
+    # params:
+    # - bucket_name
+    # - index_doc
+    # - error_doc
+    def put_bucket_website(bucket_name, index_doc, error_doc)
+      Bucket.new(@client).put_bucket_website(bucket_name, index_doc, error_doc)
+    end
+
+    # params:
+    # - bucket_name
+    # - allow_empty
+    # - referer_list
+    def put_bucket_referer(bucket_name, allow_empty, referer_list = [])
+      Bucket.new(@client).put_bucket_referer(bucket_name, allow_empty, referer_list)
+    end
+
+    # params:
+    # - bucket_name
+    # - allow_empty
+    # - referer_list
+    def put_bucket_lifecycle(bucket_name, rules = [])
+      Bucket.new(@client).put_bucket_lifecycle(bucket_name, rules)
+    end
+
+    # params:
+    # - bucket_name
+    # - options:
+    #   - delimiter
+    #   - prefix
+    #   - marker
+    #   - max_keys
+    #   - encoding_type
+    def get_bucket(bucket_name, options = {})
+      Bucket.new(@client).get_bucket(bucket_name, options)
+    end
+
+    # params:
+    # - bucket_name
+    def get_bucket_acl(bucket_name)
+      Bucket.new(@client).get_bucket_acl(bucket_name)
+    end
+
+    # params:
+    # - bucket_name
+    def get_bucket_location(bucket_name)
+      Bucket.new(@client).get_bucket_location(bucket_name)
+    end
+
+    # params:
+    # - bucket_name
+    def get_bucket_logging(bucket_name)
+      Bucket.new(@client).get_bucket_logging(bucket_name)
+    end
+
+    # params:
+    # - bucket_name
+    def get_bucket_website(bucket_name)
+      Bucket.new(@client).get_bucket_website(bucket_name)
+    end
+
+    # params:
+    # - bucket_name
+    def get_bucket_referer(bucket_name)
+      Bucket.new(@client).get_bucket_referer(bucket_name)
+    end
+
+    # params:
+    # - bucket_name
+    def get_bucket_lifecycle(bucket_name)
+      Bucket.new(@client).get_bucket_lifecycle(bucket_name)
+    end
+
+    # params:
+    # - bucket_name
+    def delete_bucket(bucket_name)
+      Bucket.new(@client).delete_bucket(bucket_name)
+    end
+
+    # params:
+    # - bucket_name
+    def delete_bucket_logging(bucket_name)
+      Bucket.new(@client).delete_bucket_logging(bucket_name)
+    end
+
+    # params:
+    # - bucket_name
+    def delete_bucket_website(bucket_name)
+      Bucket.new(@client).delete_bucket_website(bucket_name)
+    end
+
+    # params:
+    # - bucket_name
+    def delete_bucket_lifecycle(bucket_name)
+      Bucket.new(@client).delete_bucket_lifecycle(bucket_name)
+    end
+
+
+    #######################
+    # Object
+    #######################
+
+    # params:
+    # - bucket_name
+    # - object_name
+    # - file
+    # - options
+    def put_object(bucket_name, object_name, file, options = {})
+      Object.new(@client).put_object(bucket_name, object_name, file, options)
+    end
+
+    # params:
+    # - bucket_name
+    # - object_name
+    # - file
+    # - options
+    def copy_object(bucket_name, object, old_bucket, old_object, options = {})
+      Object.new(@client).copy_object(bucket_name, object, old_bucket, old_object, options)
+    end
+
+    # params:
+    # - bucket_name
+    # - object
+    # - options
+    def get_object(bucket_name, object, options = {})
+      Object.new(@client).get_object(bucket_name, object, options)
+    end
+
+    # params:
+    # - bucket_name
+    # - object_name
+    # - file
+    # - options
+    def append_object(bucket_name, object_name, file, position, options = {})
+      Object.new(@client).append_object(bucket_name, object_name, file, position, options)
+    end
+
+    # params:
+    # - bucket_name
+    # - object_name
+    def delete_object(bucket_name, object_name)
+      Object.new(@client).delete_object(bucket_name, object_name)
+    end
+
+    # params:
+    # - bucket_name
+    # - objects
+    def delete_multiple_objects(bucket_name, objects)
+      Object.new(@client).delete_multiple_objects(bucket_name, objects)
+    end
+
+    # params:
+    # - bucket_name
+    # - object_name
+    # - options
+    def head_object(bucket_name, object_name)
+      Object.new(@client).head_object(bucket_name, object_name)
+    end
+
+    # params:
+    # - bucket_name
+    # - object_name
+    # - acl
+    def put_object_acl(bucket_name, object_name, acl)
+      Object.new(@client).put_object_acl(bucket_name, object_name, acl)
+    end
+
+    # params:
+    # - bucket_name
+    # - object_name
+    # - acl
+    def post_object(bucket_name, key, options = {})
+      Object.new(@client).post_object(bucket_name, key, options)
+    end
+
+
+    #######################
+    # Multipart
+    #######################
+
+    # params:
+    # - bucket_name
+    # - object_name
+    # - options
+    def initiate_multipart_upload(bucket_name, object_name, options = {})
+      Multipart.new(@client).initiate_multipart_upload(bucket_name, object_name, options)
+    end
+
+    # params:
+    # - bucket_name
+    # - object_name
+    # - upload_id
+    # - file
+    # - part_number
+    # - options
+    def upload_part(bucket_name, object_name, upload_id, file, part_number = 1, options = {})
+      Multipart.new(@client).upload_part(bucket_name, object_name, upload_id, file, part_number, options)
+    end
+
+    # params:
+    # - bucket_name
+    # - object_name
+    # - upload_id
+    # - old_bucket
+    # - old_object
+    # - part_number
+    # - options
+    def upload_part_copy(bucket_name, object_name, upload_id, old_bucket, old_object, part_number = 1, options = {})
+      Multipart.new(@client).upload_part_copy(bucket_name, object_name, upload_id, old_bucket, old_object, part_number, options)
+    end
+
+    # params:
+    # - bucket_name
+    # - object_name
+    # - upload_id
+    # - parts
+    def complete_multipart_upload(bucket_name, object_name, upload_id, parts)
+      Multipart.new(@client).complete_multipart_upload(bucket_name, object_name, upload_id, parts)
+    end
+
+    # params:
+    # - bucket_name
+    # - object_name
+    # - upload_id
+    def abort_multipart_upload(bucket_name, object_name, upload_id)
+      Multipart.new(@client).abort_multipart_upload(bucket_name, object_name, upload_id)
+    end
+
+    # params:
+    # - bucket_name
+    # - options
+    def list_multipart_upload(bucket_name, options = {})
+      Multipart.new(@client).list_multipart_upload(bucket_name, options)
+    end
+
+    # params:
+    # - bucket_name
+    # - object_name
+    # - options
+    def list_parts(bucket_name, object_name, options = {})
+      Multipart.new(@client).list_parts(bucket_name, object_name, options)
+    end
+
+
+    #######################
+    # Cors
+    #######################
+
+    # params:
+    # - bucket_name
+    # - rules
+    def put_bucket_cors(bucket_name, rules)
+      Cors.new(@client).put_bucket_cors(bucket_name, rules)
+    end
+
+    # params:
+    # - bucket_name
+    # - rules
+    def get_bucket_cors(bucket_name)
+      Cors.new(@client).get_bucket_cors(bucket_name)
+    end
+
+    # params:
+    # - bucket_name
+    # - rules
+    def delete_bucket_cors(bucket_name)
+      Cors.new(@client).delete_bucket_cors(bucket_name)
+    end
+
+    # params:
+    # - bucket_name
+    # - object_name
+    # - origin
+    # - request_method
+    # - request_headers
+    def option_object(bucket_name, object_name, origin, request_method, request_headers)
+      Cors.new(@client).option_object(bucket_name, object_name, origin, request_method, request_headers)
+    end
+
+  end
+
+end