upyun-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5268c98f675b2fad464f99f0f9331b7158577f8
+  data.tar.gz: 54bf95dfc964ac8fe692825b12dff74d03cf1bae
+SHA512:
+  metadata.gz: c497f45995b56a78d73413617a2da708327009ff16b2c04c3292c84bd1fc118b026c10a134428ab79b7dbed3881e1d575113ad34257784cd0d7f10251215d32a
+  data.tar.gz: 56e8600c52dda8308f61eafcaeda70517905475782d271b47060695bb4533c2f08be1afaeb982b28fa08b22b18cffc67a445d454a07a421f642835727586324f

data/.gitignore

@@ -0,0 +1,13 @@
+nstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 calelelac
+
+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,112 @@
+# 又拍云 Ruby SDK
+
+又拍云存储 Ruby SDK，基于 [又拍云存储 HTTP REST API 接口](http://wiki.upyun.com/index.php?title=HTTP_REST_API%E6%8E%A5%E5%8F%A3) 开发。
+
+### 安装说明
+
+```
+gem install upyun-sdk
+```
+
+## 基本函数接口
+
+### 初始化 UpYun
+
+````
+require 'upyun-sdk'
+
+up = UpYun.new('bucket', 'username', 'password', 0)
+````
+
+其中，参数 `bucket` 为空间名称，`username` 和 `password` 分别为授权操作员帐号和密码，必选。
+
+根据国内的网络情况，又拍云存储 API 目前提供了电信、联通网通、移动铁通三个接入点，在初始化时可由参数 `endpoint` 进行设置，其可选的值有：
+
+````
+0      根据网络条件自动选择接入点，默认
+1  	   电信接入点
+2      联通网通接入点
+3      移动铁通接入点
+````
+
+默认设置为 `0` ， 但是我们推荐根据服务器网络状况，手动设置合理的接入点以获取最佳的访问速度。。同时，也可通过：
+
+````
+up.endpoint = 1
+````
+
+在对象使用过程中更改。
+
+
+### 上传文件
+
+#### 直接传递文件内容的形式上传
+
+````
+up.put('/upyun-sdk/ascii.txt', 'abcdefghijklmnopqrstuvwxyz\n')
+````
+
+其中，方法 `up.put` 默认已开启相应目录的自动创建。
+
+
+其中，参数 `auto_mkdir` 默认为 true，表示自动创建目录；`checksum`，默认 False，表示不进行 MD5 校验; `headers` ，可根据需求设置自定义 HTTP Header，例如作图参数 x-gmkerl-*, 具体请参考 [标准 API 上传文件](http://wiki.upyun.com/index.php?title=%E6%A0%87%E5%87%86API%E4%B8%8A%E4%BC%A0%E6%96%87%E4%BB%B6) 。
+
+上传成功，返回 true; 失败返回 false。
+
+### 下载文件
+
+#### 直接读取文件内容
+
+````
+res = up.get('/upyun-sdk/ascii.txt')
+````
+
+下载成功，返回文件内容; 失败则返回错误信息。
+
+### 获取文件信息
+
+````
+res = up.getinfo('/upyun-sdk/xinu.png')
+puts res['file-type']
+puts res['file-size']
+puts res['file-date']
+````
+
+获取成功，返回一个 Hash 对象; 失败则返回错误信息。
+
+### 创建目录
+
+````
+up.mkdir('/upyun-sdk/temp/')
+````
+
+其中，参数 `auto_mkdir` 默认为 true，表示自动创建目录；
+创建成功，返回 true; 失败，返回 false。
+
+### 删除目录或文件
+
+````
+up.delete('/upyun-sdk/xinu.png')
+up.delete('/upyun-sdk/temp/')
+````
+
+删除成功，返回 true; 失败返回 false。注意删除目录时，必须保证目录为空。
+
+### 获取目录文件列表
+
+````
+res = up.getlist('/upyun-sdk/')
+````
+
+获取成功，返回一个包含该目录下所有目录或文件条目信息的 Hash 对象。获取失败，则返回错误信息。
+该方法默认获取根目录列表信息。
+
+
+### 获取空间使用情况
+
+````
+res = up.usage()
+````
+
+获取成功，始终返回该空间当前使用的总容量，单位 Bytes; 失败则返回错误信息。
+该方法默认获取根目录空间使用情况。

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/upyun/version.rb

@@ -0,0 +1,3 @@
+module Upyun
+  VERSION = "0.1.0"
+end

data/lib/upyun-sdk.rb

@@ -0,0 +1,127 @@
+# 默认 upyun 签名
+require 'digest/md5'
+require 'net/http'
+require 'uri'
+
+class UpYun
+  attr_accessor :bucket, :username, :password
+  attr_reader :endpoint
+
+  def initialize(bucket, username, password, endpoint=nil)
+    @bucket = bucket
+    @username = username
+    @password = Digest::MD5.hexdigest(password)
+    self.endpoint = endpoint || 0
+  end
+
+  # public API
+
+  def endpoint=(value)
+    @endpoint = "v#{value}.api.upyun.com"
+  end
+
+  # 上传文件
+  def put(path, data, auto_mkdir=true, checksum=nil, headers=nil)
+    headers = headers || {}
+    headers['mkdir'] = !!auto_mkdir
+    headers['Content-MD5'] = checksum if checksum
+    headers['Content-Length'] = data.size.to_s
+    res = http_request('PUT', path, data, headers)
+    res_ok?(res)
+  end
+
+  # 下载文件
+  def get(path)
+    res = http_request('GET', path)
+    res_ok?(res) ? res.body : res_errmsg(res)
+  end
+
+  # 获取文件信息
+  def getinfo(path)
+    res = http_request('HEAD', path)
+    if res_ok?(res)
+      return {
+        :file_type => res['x-upyun-file-type'],
+        :file_size => res['x-upyun-file-size'],
+        :file_date => res['x-upyun-file-date']
+      }
+    end
+    res_errmsg(res)
+  end
+
+  # 创建目录
+  def mkdir(path, auto_mkdir=true)
+    headers = {'folder' => 'true'}
+    headers['mkdir'] = !!auto_mkdir
+    res = http_request('POST', path, nil, headers)
+    res_ok?(res)
+  end
+
+  # 删除目录或文件
+  def delete(path)
+    res = http_request('DELETE', path)
+    res_ok?(res)
+  end
+
+  # 获取目录文件列表
+  def getlist(path='/')
+    res = http_request('GET', path)
+    if res_ok?(res)
+      list = res.body.split("\n").map do |file|
+        name, type, size, time = file.split("\t")
+        {
+          :name => name,
+          :type => type,
+          :size => size,
+          :time => time
+        }
+      end
+      return list
+    end
+    res_errmsg(res)
+  end
+
+  # 获取空间使用情况
+  def usage(path='/')
+    res = http_request('GET', "#{path}?usage")
+    res_ok?(res) ? res.body : res_errmsg(res)
+  end
+
+  private
+
+  def res_ok?(res)
+    res.code.eql? '200'
+  end
+
+  def res_errmsg(res)
+    "#{res.code} #{res.message}"
+  end
+
+  def http_request(method, path, data=nil, headers=nil)
+    base = "http://#{@endpoint}/#{@bucket}"
+    url = File.join(base, path)
+    uri = URI.parse(URI.encode(url))
+
+    headers = headers || {}
+    date = Time.now.utc.strftime('%a, %d %b %Y %H:%M:%S GMT')
+    length = headers['Content-Length'] || 0
+    headers['Date'] = date
+    headers['Authorization'] = make_signature(method, uri.path, date, length)
+    Net::HTTP.start(uri.host, uri.port) do |http|
+      if method == 'HEAD'
+        return http.head(uri.request_uri, headers)
+      else
+        return http.send_request(method, uri.request_uri, data, headers)
+      end
+    end
+  end
+
+  def make_signature(method, uri, date, length)
+    signature = "#{method}&#{uri}&#{date}&#{length}&#{md5(@password)}"
+    "UpYun #{@username}:#{md5(signature)}"
+  end
+
+  def md5(data)
+    Digest::MD5.hexdigest(data)
+  end
+end

data/upyun-sdk.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'upyun/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "upyun-sdk"
+  spec.version       = Upyun::VERSION
+  spec.authors       = ["woo"]
+  spec.email         = ["kl.woohoo@gmail.com"]
+  spec.description   = %q{Upyun SDK for Ruby. }
+  spec.summary       = %q{Upyun SDK for Ruby. }
+  spec.homepage      = "https://github.com/klwoohoo/upyun-sdk"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($\)
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: upyun-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- woo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Upyun SDK for Ruby. '
+email:
+- kl.woohoo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- lib/upyun-sdk.rb
+- lib/upyun/version.rb
+- upyun-sdk.gemspec
+homepage: https://github.com/klwoohoo/upyun-sdk
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Upyun SDK for Ruby.
+test_files: []