cos 0.1.0 → 0.1.1

data/lib/cos/http.rb

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+require 'rest-client'
+require 'uri'
+
+module COS
+
+  class HTTP
+
+    # 默认content-type
+    DEFAULT_CONTENT_TYPE = 'application/json'
+
+    # 请求创建超时
+    OPEN_TIMEOUT = 15
+
+    # 响应读取超时
+    READ_TIMEOUT = 120
+
+    include Logging
+
+    attr_reader :config, :signature
+
+    def initialize(config)
+      @config    = config
+      @signature = Signature.new(config)
+    end
+
+    # GET请求
+    def get(path, headers, signature = nil)
+      do_request('GET', path, headers, signature)
+    end
+
+    # POST请求
+    def post(path, headers, signature, payload)
+      do_request('POST', path, headers, signature, payload)
+    end
+
+    private
+
+    # 发送请求
+    def do_request(method, path, headers, signature = nil, payload = nil)
+
+      # 整理头部信息
+      headers['content-type']  ||= DEFAULT_CONTENT_TYPE
+      headers['user-agent']    = get_user_agent
+      headers['authorization'] = signature
+      headers['accept']        = 'application/json'
+
+      # 请求地址
+      url = "#{config.api_base}#{path}"
+
+      logger.debug("Send HTTP request, method: #{method}, url: " \
+                      "#{url}, headers: #{headers}, payload: #{payload}")
+
+      response = RestClient::Request.execute(
+          :method       => method,
+          :url          => URI.encode(url),
+          :headers      => headers,
+          :payload      => payload,
+          :open_timeout => @config.open_timeout || OPEN_TIMEOUT,
+          :timeout      => @config.read_timeout || READ_TIMEOUT
+      ) do |resp, request, result, &blk|
+
+        # 捕获异常
+        if resp.code >= 300
+          e = ServerError.new(resp)
+          logger.warn(e.to_s)
+          raise e
+        else
+          resp.return!(request, result, &blk)
+        end
+
+      end
+
+      logger.debug("Received HTTP response, code: #{response.code}, headers: " \
+                      "#{response.headers}, body: #{response.body}")
+
+      # 解析JSON结果
+      parse_data(response)
+    end
+
+    # 解析结果json 取出data部分
+    def parse_data(response)
+      j = JSON.parse(response.body, symbolize_names: true)
+      j[:data]
+    end
+
+    # 获取user agent
+    def get_user_agent
+      "cos-ruby-sdk/#{VERSION} ruby-#{RUBY_VERSION}/#{RUBY_PLATFORM}"
+    end
+
+  end
+
+end

data/lib/cos/logging.rb

@@ -0,0 +1,47 @@
+# coding: utf-8
+
+require 'logger'
+
+module COS
+
+  module Logging
+
+    # 默认日志存储
+    DEFAULT_LOG_FILE = './cos-sdk.log'
+    # 日志最大数量
+    MAX_NUM_LOG = 100
+    # 日志覆盖大小
+    ROTATE_SIZE = 10 * 1024 * 1024
+
+    # 设置日志输出的文件
+    # level = Logger::DEBUG | Logger::INFO | Logger::ERROR | Logger::FATAL
+    def self.set_logger(file, level)
+      if file == STDOUT or file == STDERR
+        @logger = Logger.new(file)
+        @logger.level = level
+      else
+        @logger = Logger.new(file, MAX_NUM_LOG, ROTATE_SIZE)
+        @logger.level = level
+      end
+    end
+
+    # 获取logger
+    def logger
+      Logging.logger
+    end
+
+    private
+
+    # 实例方法使用logger
+    def self.logger
+      unless @logger
+        @logger = Logger.new(DEFAULT_LOG_FILE, MAX_NUM_LOG, ROTATE_SIZE)
+        @logger.level = Logger::INFO
+      end
+
+      @logger
+    end
+
+  end
+
+end

data/lib/cos/resource.rb

@@ -0,0 +1,201 @@
+# coding: utf-8
+
+module COS
+
+  class Resource
+
+    attr_reader :bucket, :path, :dir_count, :file_count
+
+    # 实例化COS资源迭代器
+    def initialize(bucket, path, options = {})
+      @bucket      = bucket
+      @path        = path
+      @more        = options
+      @results     = Array.new
+      @dir_count   = 0
+      @file_count  = 0
+    end
+
+    # 实现迭代器
+    def next
+      loop do
+        # 从接口获取下一页结果
+        fetch_more if @results.empty?
+
+        # 取出结果
+        r = @results.shift
+        break unless r
+
+        yield r
+      end
+    end
+
+    # 返回迭代器
+    def to_enum
+      self.enum_for(:next)
+    end
+
+    # 获取列表
+    def fetch
+      client = bucket.client
+      resp = client.api.list(path, @more.merge({bucket: bucket.bucket_name}))
+
+      # 遍历结果转换为对应的对象
+      @results = resp[:infos].map do |r|
+        if r[:filesize].nil?
+          # 目录
+          COSDir.new(r.merge({
+                                 bucket: bucket,
+                                 path: Util.get_list_path(path, r[:name])
+                             }))
+        else
+          # 文件
+          COSFile.new(r.merge({
+                                  bucket: bucket,
+                                  path: Util.get_list_path(path, r[:name], true)
+                              }))
+        end
+      end || []
+
+      @dir_count  = resp[:dir_count]
+      @file_count = resp[:file_count]
+
+      @more[:context]  = resp[:context]
+      @more[:has_more] = resp[:has_more]
+    end
+
+    private
+
+    # 如果有更多页继续获取下一页
+    def fetch_more
+      return if @more[:has_more] == false
+      fetch
+    end
+
+  end
+
+  # COS资源,文件与目录的共有操作
+  class ResourceOperator < Struct::Base
+
+    required_attrs :bucket, :path, :name, :ctime, :mtime
+    optional_attrs :biz_attr, :filesize, :filelen, :sha, :access_url,
+                   # 根目录(bucket)参数
+                   :authority, :bucket_type, :migrate_source_domain,
+                   :need_preview, :refers, :blackrefers, :brower_exec,
+                   :cnames, :nugc_flag, :SKIP_EXTRA
+
+    # 资源类型
+    attr_reader :type
+
+    alias :file_size :filesize
+    alias :file_len :filelen
+
+    def initialize(attrs)
+      super(attrs)
+    end
+
+    # 创建时间Time类型
+    #
+    # @return [Time]
+    def created_at
+      Time.at(ctime.to_i)
+    end
+
+    # 更新时间Time类型
+    #
+    # @return [Time]
+    def updated_at
+      Time.at(mtime.to_i)
+    end
+
+    # 参数转化为Hash类型
+    #
+    # @return [Hash]
+    def to_hash
+      hash = {
+          type:   type,
+          bucket: bucket.bucket_name,
+          path:   path,
+          name:   name,
+          ctime:  ctime,
+          mtime:  mtime,
+      }
+
+      optional_attrs.each do |key|
+        hash[key] = send(key.to_s) if respond_to?(key) and send(key.to_s) != nil
+      end
+
+      hash
+    end
+
+    # 判断当前资源是否存在
+    #
+    # @raise [ServerError] 服务端异常返回
+    #
+    # @return [Boolean] 是否存在
+    #
+    # @example
+    #   puts resource.exist?
+    def exist?
+      bucket.exist?(path)
+    end
+
+    alias :exists? :exist?
+
+    # 获取(刷新)当前资源的状态
+    #
+    # @note 如查询根目录('/', '')可以获取到bucket信息, 返回COSDir
+    #
+    # @raise [ServerError] 服务端异常返回
+    #
+    # @return [COSFile|COSDir] 如果是目录则返回COSDir资源对象,是文件则返回COSFile资源对象
+    #
+    # @example
+    #   puts resource.stat.name
+    def stat
+      bucket.stat(path)
+    end
+
+    # 更新当前资源的属性
+    #
+    # @note 根目录('/') 不可更新, 否则会抛出异常
+    #
+    # @param biz_attr [String] 目录/文件属性，业务端维护
+    #
+    # @raise [ServerError] 服务端异常返回
+    #
+    # @example
+    #   resource.update('i am the attr')
+    def update(biz_attr)
+      bucket.update(path, biz_attr)
+      @mtime    = Time.now.to_i.to_s
+      @biz_attr = biz_attr
+      self
+    end
+
+    # 删除当前资源
+    #
+    # @note 非空目录及根目录不可删除,会抛出异常
+    #
+    # @raise [ServerError] 服务端异常返回
+    #
+    # @example
+    #   resource.delete
+    def delete
+      bucket.delete(path)
+      self
+    end
+
+    # 删除当前资源, 不会抛出异常而是返回布尔值
+    #
+    # @note 非空目录及根目录不可删除, 返回false
+    #
+    # @example
+    #   puts resource.delete!
+    def delete!
+      bucket.delete!(path)
+    end
+
+  end
+
+end

data/lib/cos/signature.rb

@@ -0,0 +1,119 @@
+# coding: utf-8
+
+require 'time'
+require 'base64'
+require 'openssl'
+require 'uri'
+
+module COS
+
+  class Signature
+
+    attr_reader :config, :expire_seconds, :file_id
+
+    # 初始化
+    #
+    # @example
+    #   COS::Signature.new(config)
+    #
+    # @param config [COS::Config] 客户端设置
+    #
+    # @see COS::Config
+    def initialize(config)
+      @config = config
+    end
+
+    # 单次有效签名
+    #
+    # @see http://www.qcloud.com/wiki/%E9%89%B4%E6%9D%83%E6%8A%80%E6%9C%AF%E6%9C%8D%E5%8A%A1%E6%96%B9%E6%A1%88#1_.E7.AD.BE.E5.90.8D.E4.B8.8E.E9.89.B4.E6.9D.83
+    #
+    # @note 用于删除目录、文件, 更新目录、文件
+    #
+    # @param bucket [String] bucket名称
+    # @param path [String] 文件或目录路径, 如 /path/, /path/file
+    #
+    # @return [String] 签名字符串
+    def once(bucket, path)
+      # 单次签名,需要指定资源存储的唯一标识
+      unless path.start_with?('/')
+        path = "/#{path}"
+      end
+
+      # 资源存储的唯一标识，格式为"/app_id/bucket/用户自定义路径或资源名"
+      @file_id = "/#{config.app_id}/#{bucket}#{path}"
+
+      sign(:once, bucket)
+    end
+
+
+    # 多次有效签名
+    #
+    # @see http://www.qcloud.com/wiki/%E9%89%B4%E6%9D%83%E6%8A%80%E6%9C%AF%E6%9C%8D%E5%8A%A1%E6%96%B9%E6%A1%88#1_.E7.AD.BE.E5.90.8D.E4.B8.8E.E9.89.B4.E6.9D.83
+    #
+    # @note 用于上传,查询目录、文件,查询目录、文件,创建目录,下载（开启token防盗链）
+    #
+    # @param bucket [String] bucket名称
+    # @param expire_seconds [Integer] 签名有效时间(单位秒)
+    #
+    # @return [String] 签名字符串
+    def multiple(bucket, expire_seconds = config.multiple_sign_expire)
+      # 多次签名时，过期时间应大于当前时间
+      if expire_seconds <= 0
+        raise AttrError, 'Multiple signature expire_seconds must greater than 0'
+      end
+
+      @expire_seconds = expire_seconds
+
+      sign(:multiple, bucket)
+    end
+
+    private
+
+    # 生成签名
+    #
+    # @see http://www.qcloud.com/wiki/%E9%89%B4%E6%9D%83%E6%8A%80%E6%9C%AF%E6%9C%8D%E5%8A%A1%E6%96%B9%E6%A1%88#2.3.09.E7.94.9F.E6.88.90.E7.AD.BE.E5.90.8D
+    def sign(sign_type, bucket)
+      # 准备待签名字符串
+      sign_string = string_to_sign(sign_type, bucket)
+
+      # HMAC-SHA1算法进行签名
+      hmac_sha1 = OpenSSL::HMAC.digest('sha1', config.secret_key, sign_string)
+
+      # 然后将原字符串附加到签名结果的末尾，再进行Base64编码
+      Base64.strict_encode64("#{hmac_sha1}#{sign_string}")
+    end
+
+    # 准备签名字符串
+    #
+    # @see http://www.qcloud.com/wiki/%E9%89%B4%E6%9D%83%E6%8A%80%E6%9C%AF%E6%9C%8D%E5%8A%A1%E6%96%B9%E6%A1%88#2_.E7.AD.BE.E5.90.8D.E7.AE.97.E6.B3.95
+    def string_to_sign(sign_type, bucket)
+      # 随机串，无符号10进制整数，最长10位
+      r = rand(99999)
+
+      # 当前时间戳，是一个符合UNIX Epoch时间戳规范的数值，单位为秒
+      t = Time.now.to_i
+
+      if sign_type == :once
+        # 单次签名时e为0
+        e = 0
+
+        # 需要对其中非'/'字符进行urlencode编码
+        f = URI.encode(file_id)
+
+      elsif sign_type == :multiple
+        e = t + expire_seconds
+
+        # 多次签名不需要提供file_id
+        f = nil
+
+      else
+        raise Exception, 'Unknown sign type when prepare sign string'
+      end
+
+      # 拼接待签名字符串
+      "a=#{config.app_id}&b=#{bucket}&k=#{config.secret_id}&e=#{e}&t=#{t}&r=#{r}&f=#{f}"
+    end
+
+  end
+
+end