qcloud_cos 0.1.0 → 0.3.0

data/lib/qcloud_cos/authorization.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+require 'base64'
+require 'openssl'
+require 'digest'
+
+module QcloudCos
+  class Authorization
+    attr_reader :config
+
+    # 用于对请求进行签名
+    # @param config [Configration] specify configuration for sign
+    #
+    def initialize(config)
+      @config = config
+    end
+
+    # 生成单次有效签名
+    #
+    # @param bucket [String] 指定 Bucket 名字
+    # @param fileid [String] 指定要签名的资源
+    def sign_once(bucket, fileid)
+      sign_base(bucket, fileid, 0)
+    end
+
+    # 生成多次有效签名
+    #
+    # @param bucket [String] 指定 Bucket 名字
+    # @param expired [Integer] (EXPIRED_SECONDS) 指定签名过期时间, 秒作为单位
+    def sign_more(bucket, expired = EXPIRED_SECONDS)
+      sign_base(bucket, nil, current_time + expired)
+    end
+    alias_method :sign, :sign_more
+
+    private
+
+    def sign_base(bucket, fileid, expired)
+      fileid = "/#{app_id}#{fileid}" if fileid
+
+      src_str = "a=#{app_id}&b=#{bucket}&k=#{secret_id}&e=#{expired}&t=#{current_time}&r=#{rdm}&f=#{fileid}"
+
+      Base64.encode64("#{OpenSSL::HMAC.digest('sha1', secret_key, src_str)}#{src_str}").delete("\n").strip
+    end
+
+    def app_id
+      config.app_id
+    end
+
+    def secret_id
+      config.secret_id
+    end
+
+    def secret_key
+      config.secret_key
+    end
+
+    def current_time
+      Time.now.to_i
+    end
+
+    def rdm
+      rand(10**9)
+    end
+  end
+end

data/lib/qcloud_cos/configuration.rb

@@ -0,0 +1,9 @@
+module QcloudCos
+  class Configuration
+    attr_accessor :app_id, :secret_id, :secret_key, :bucket, :endpoint, :ssl_ca_file, :max_retry_times
+
+    def max_retry_times
+      @max_retry_times || MAX_RETRY_TIMES
+    end
+  end
+end

data/lib/qcloud_cos/convenient_api.rb

@@ -0,0 +1,107 @@
+module QcloudCos
+  module ConvenientApi
+
+    # 获取 Bucket 信息
+    #
+    # @param bucket_name [String] :bucket (config.bucket) 指定当前 bucket, 默认是配置里面的 bucket
+    #
+    # @return [Hash] 返回 Bucket 信息
+    def bucket_info(bucket_name = config.bucket)
+      stat('/', bucket: bucket_name)['data']
+    rescue
+      {}
+    end
+
+    # 返回该路径下文件和文件夹的数目
+    #
+    # @param path [String] 指定路径
+    # @param options [Hash] 额外参数
+    # @option options [String] :bucket (config.bucket) 指定当前 bucket, 默认是配置里面的 bucket
+    #
+    # @return [Hash]
+    #
+    # @example
+    #  QcloudCos.count('/path/to/folder/') #=> { folder_count: 100, file_count: 1000 }
+    def count(path = '/', options = {})
+      result = list_folders(path, options.merge(num: 1))
+      {
+        folder_count: result.dircount || 0,
+        file_count: result.filecount || 0
+      }
+    end
+
+    # 判断该路径下是否为空
+    #
+    # @param path [String] 指定路径
+    # @param options [Hash] 额外参数
+    # @option options [String] :bucket (config.bucket) 指定当前 bucket, 默认是配置里面的 bucket
+    #
+    # @return [Boolean]
+    def empty?(path = '/', options = {})
+      count(path, options).values.uniq == 0
+    end
+
+    # 判断该路径下是否有文件
+    #
+    # @param path [String] 指定路径
+    # @param options [Hash] 额外参数
+    # @option options [String] :bucket (config.bucket) 指定当前 bucket, 默认是配置里面的 bucket
+    #
+    # @return [Boolean]
+    def contains_file?(path = '/', options = {})
+      !count(path, options)[:file_count].zero?
+    end
+
+    # 判断该路径下是否有文件夹
+    #
+    # @param path [String] 指定路径
+    # @param options [Hash] 额外参数
+    # @option options [String] :bucket (config.bucket) 指定当前 bucket, 默认是配置里面的 bucket
+    #
+    # @return [Boolean]
+    def contains_folder?(path = '/', options = {})
+      !count(path, options)[:folder_count].zero?
+    end
+
+    # 判断文件或者文件夹是否存在
+    #
+    # @param path [String] 指定文件路径
+    # @param options [Hash] 额外参数
+    # @option options [String] :bucket (config.bucket) 指定当前 bucket, 默认是配置里面的 bucket
+    #
+    # @return [Boolean]
+    def exists?(path = '/', options = {})
+      return true if path == '/' || path.to_s.empty?
+      result = stat(path, options)
+      result.key?('data') && result['data'].key?('name')
+    rescue
+      false
+    end
+    alias_method :exist?, :exists?
+
+    # 获取文件外网访问地址
+    #
+    # @param path [String] 指定文件路径
+    # @param options [Hash] 额外参数
+    # @option options [String] :bucket (config.bucket_name) 指定当前 bucket, 默认是配置里面的 bucket
+    # @option options [Integer] :expired (600) 指定有效期, 秒为单位
+    #
+    # @raise [FileNotExistError] 如果文件不存在
+    # @raise [InvalidFilePathError] 如果文件路径不合法
+    #
+    # @return [String] 下载地址
+    def public_url(path, options = {})
+      path = fixed_path(path)
+      bucket = validates(path, options)
+
+      result = stat(path, options)
+      if result.key?('data') && result['data'].key?('access_url')
+        expired = options['expired'] || PUBLIC_EXPIRED_SECONDS
+        sign = authorization.sign(bucket, expired)
+        "#{result['data']['access_url']}?sign=#{sign}"
+      else
+        fail FileNotExistError
+      end
+    end
+  end
+end

data/lib/qcloud_cos/error.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+module QcloudCos
+  class Error < StandardError; end
+
+  class RequestError < Error
+    attr_reader :code
+    attr_reader :message
+    attr_reader :origin_response
+
+    def initialize(response)
+      if response.parsed_response.key?('code')
+        @code = response.parsed_response['code']
+        @message = response.parsed_response['message']
+      end
+      @origin_response = response
+      super("ERROR Code: #{@code}, Message: #{@message}")
+    end
+  end
+
+  class InvalidFolderPathError < Error
+    def initialize(msg)
+      super(msg)
+    end
+  end
+
+  class InvalidFilePathError < Error
+    def initialize
+      super('文件名不能以 / 结尾')
+    end
+  end
+
+  class FileNotExistError < Error
+    def initialize
+      super('文件不存在')
+    end
+  end
+
+  class MissingBucketError < Error
+    def initialize
+      super('缺少 Bucket 参数或者 Bucket 不存在')
+    end
+  end
+
+  class MissingSessionIdError < Error
+    def initialize
+      super('分片上传不能缺少 Session ID')
+    end
+  end
+end

data/lib/qcloud_cos/http.rb

@@ -0,0 +1,81 @@
+require 'httparty'
+require 'httmultiparty'
+require 'addressable/uri'
+require 'qcloud_cos/error'
+
+module QcloudCos
+  class Http
+    include HTTParty
+    include HTTMultiParty
+
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def get(url, options = {})
+      request('GET', url, options)
+    end
+
+    def post(url, options = {})
+      request('POST', url, options)
+    end
+
+    private
+
+    def request(verb, url, options = {})
+      query = options.fetch(:query, {})
+      headers = options.fetch(:headers, {})
+      body = options.delete(:body)
+
+      append_headers!(headers, verb, body, options)
+      options = { headers: headers, query: query, body: body }
+      append_options!(options, url)
+
+      wrap(self.class.__send__(verb.downcase, url, options))
+    end
+
+    def wrap(response)
+      if response.code == 200 && response.parsed_response['code'] == 0
+        response
+      else
+        fail RequestError, response
+      end
+    end
+
+    def append_headers!(headers, _verb, body, _options)
+      append_default_headers!(headers)
+      append_body_headers!(headers, body)
+    end
+
+    def append_options!(options, url)
+      options.merge!(uri_adapter: Addressable::URI)
+      if config.ssl_ca_file
+        options.merge!(ssl_ca_file: config.ssl_ca_file)
+      elsif url.start_with?('https://')
+        options.merge!(verify_peer: true)
+      end
+    end
+
+    def append_default_headers!(headers)
+      headers.merge!(default_headers)
+    end
+
+    def append_body_headers!(headers, body)
+      headers.merge!('Content-Length' => Utils.content_size(body).to_s) if body
+    end
+
+    def default_headers
+      {
+        'User-Agent' => user_agent,
+        'Host' => 'web.file.myqcloud.com'
+      }
+    end
+
+    def user_agent
+      "qcloud-cos-sdk-ruby/#{QcloudCos::VERSION} " \
+      "(#{RbConfig::CONFIG['host_os']} ruby-#{RbConfig::CONFIG['ruby_version']})"
+    end
+  end
+end

data/lib/qcloud_cos/model/file_object.rb

@@ -0,0 +1,16 @@
+require 'qcloud_cos/model/objectable'
+
+module QcloudCos
+  class FileObject
+    include Objectable
+    attr_accessor :access_url
+    attr_accessor :source_url
+    attr_accessor :biz_attr
+    attr_accessor :ctime
+    attr_accessor :filelen
+    attr_accessor :filesize
+    attr_accessor :mtime
+    attr_accessor :name
+    attr_accessor :sha
+  end
+end

data/lib/qcloud_cos/model/folder_object.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+require 'qcloud_cos/model/objectable'
+
+module QcloudCos
+  class FolderObject
+    include Objectable
+    MAXLENGTH = 20
+    RETAINED_SYMBOLS = %w(/ ? * : | \ < > ")
+    RETAINED_FIELDS = %w(con aux nul prn com0 com1 com2 com3 com4 com5 com6 com7 com8 com9 lpt0 lpt1 lpt2 lpt3 lpt4 lpt5 lpt6 lpt7 lpt8 lpt9)
+
+    attr_accessor :biz_attr
+    attr_accessor :ctime
+    attr_accessor :mtime
+    attr_accessor :name
+
+    # 校验文件夹路径
+    #
+    # @param path [String] 文件夹路径
+    #
+    # @raise InvalidFolderPathError 如果文件夹路径不合法
+    def self.validate(path)
+      if !path.end_with?('/')
+        fail InvalidFolderPathError, '文件夹路径必须以 / 结尾'
+      elsif !(names = path.split('/')).empty?
+        if names.detect { |name| RETAINED_FIELDS.include?(name.downcase) }
+          fail InvalidFolderPathError, %(文件夹名字不能是保留字段: '#{RETAINED_FIELDS.join("', '")}')
+        elsif names.detect { |name| name.match(/[\/?*:|\\<>"]/) }
+          fail InvalidFolderPathError, %(文件夹名字不能包含保留字符: '#{RETAINED_SYMBOLS.join("', '")}')
+        elsif names.detect { |name| name.length > MAXLENGTH }
+          fail InvalidFolderPathError, %(文件夹名字不能超过#{MAXLENGTH}个字符)
+        end
+      end
+    end
+  end
+end

data/lib/qcloud_cos/model/list.rb

@@ -0,0 +1,34 @@
+require 'qcloud_cos/model/file_object'
+require 'qcloud_cos/model/folder_object'
+require 'forwardable'
+
+module QcloudCos
+  class List
+    include Enumerable
+    extend Forwardable
+
+    attr_reader :context, :dircount, :filecount, :has_more
+    def_delegators :@objects, :[], :each, :size, :inspect
+
+    # 自动将 Hash 构建成对象
+    def initialize(result)
+      @context = result['context']
+      @dircount = result['dircount']
+      @filecount = result['filecount']
+      @has_more = result['has_more']
+      @objects = build_objects(result['infos'])
+    end
+
+    private
+
+    def build_objects(objects)
+      objects.map do |obj|
+        if obj.key?('access_url')
+          QcloudCos::FileObject.new(obj)
+        else
+          QcloudCos::FolderObject.new(obj)
+        end
+      end
+    end
+  end
+end

data/lib/qcloud_cos/model/objectable.rb

@@ -0,0 +1,9 @@
+module QcloudCos
+  module Objectable
+    def initialize(hash)
+      hash.each do |k, v|
+        send("#{k}=", v)
+      end
+    end
+  end
+end

data/lib/qcloud_cos/utils.rb

@@ -0,0 +1,47 @@
+module QcloudCos
+  class Utils
+    class << self
+      # 对 path 进行 url_encode
+      def url_encode(path)
+        ERB::Util.url_encode(path).gsub('%2F', '/')
+      end
+
+      # 计算 content 的大小
+      def content_size(content)
+        if content.respond_to?(:size)
+          content.size
+        elsif content.is_a?(IO)
+          content.stat.size
+        end
+      end
+
+      # 生成 content 的 sha
+      def generate_sha(content)
+        Digest::SHA1.hexdigest content
+      end
+
+      # 生成文件的 sha1 值
+      def generate_file_sha(file_path)
+        Digest::SHA1.file(file_path).hexdigest
+      end
+
+      # 将 hash 的 key 统一转化为 string
+      def stringify_keys!(hash)
+        hash.keys.each do |key|
+          hash[key.to_s] = hash.delete(key)
+        end
+      end
+
+      # @example
+      #
+      #   Utils.hash_slice({ 'a' => 1, 'b' => 2, 'c' => 3 }, 'a', 'c') # { 'a' => 1, 'c' => 3 }
+      #
+      # 获取 Hash 中的一部分键值对
+      def hash_slice(hash, *selected_keys)
+        new_hash = {}
+        selected_keys.each { |k| new_hash[k] = hash[k] if hash.key?(k) }
+        new_hash
+      end
+    end
+  end
+end