qiniu 6.0.1

data/lib/qiniu-rs.rb

@@ -0,0 +1,2 @@
+# More logical way to require 'qiniu-rs'
+require File.join(File.dirname(__FILE__), 'qiniu', 'qiniu')

data/lib/qiniu.rb

@@ -0,0 +1,229 @@
+# -*- encoding: utf-8 -*-
+
+module Qiniu
+  autoload :Version, 'qiniu/version'
+  autoload :Utils, 'qiniu/utils'
+  autoload :Auth, 'qiniu/auth'
+  autoload :Config, 'qiniu/config'
+  autoload :Log, 'qiniu/log'
+  autoload :Exception, 'qiniu/exceptions'
+  autoload :AccessToken, 'qiniu/tokens/access_token'
+  autoload :QboxToken, 'qiniu/tokens/qbox_token'
+  autoload :UploadToken, 'qiniu/tokens/upload_token'
+  autoload :DownloadToken, 'qiniu/tokens/download_token'
+  autoload :Abstract, 'qiniu/abstract'
+  autoload :Storage, 'qiniu/storage'
+  autoload :Fop, 'qiniu/fop'
+  autoload :Misc, 'qiniu/misc'
+
+    class << self
+
+      StatusOK = 200
+
+      def establish_connection!(opts = {})
+        Config.initialize_connect opts
+      end
+
+      def mkbucket(bucket_name)
+        code, data = Storage.mkbucket(bucket_name)
+        code == StatusOK
+      end
+
+      def buckets
+        code, data = Storage.buckets
+        code == StatusOK ? data : false
+      end
+
+      def set_protected(bucket, protected_mode)
+        code, data = Misc.set_protected(bucket, protected_mode)
+        code == StatusOK
+      end
+
+      def set_separator(bucket, separator)
+        code, data = Misc.set_separator(bucket, separator)
+        code == StatusOK
+      end
+
+      def set_style(bucket, name, style)
+        code, data = Misc.set_style(bucket, name, style)
+        code == StatusOK
+      end
+
+      def unset_style(bucket, name)
+        code, data = Misc.unset_style(bucket, name)
+        code == StatusOK
+      end
+
+      def put_file opts = {}
+        code, data = Storage.put_file(opts[:file],
+                                 opts[:bucket],
+                                 opts[:key],
+                                 opts[:mime_type],
+                                 opts[:note],
+                                 opts[:enable_crc32_check])
+        code == StatusOK
+      end
+
+      def upload_file opts = {}
+        uncontained_opts = [:uptoken, :file, :bucket, :key] - opts.keys
+        raise MissingArgsError, uncontained_opts unless uncontained_opts.empty?
+
+        source_file = opts[:file]
+        raise NoSuchFileError, source_file unless File.exist?(source_file)
+
+        opts[:enable_resumable_upload] = true unless opts.has_key?(:enable_resumable_upload)
+
+        if opts[:enable_resumable_upload] && File::size(source_file) > Config.settings[:block_size]
+          code, data = Storage.upload_with_token(opts[:uptoken],
+                                            opts[:file],
+                                            opts[:bucket],
+                                            opts[:key],
+                                            opts[:mime_type],
+                                            opts[:note],
+                                            opts[:customer],
+                                            opts[:callback_params],
+                                            opts[:rotate])
+        else
+          code, data = Storage.upload_with_token(opts[:uptoken],
+                                            opts[:file],
+                                            opts[:bucket],
+                                            opts[:key],
+                                            opts[:mime_type],
+                                            opts[:note],
+                                            opts[:callback_params],
+                                            opts[:enable_crc32_check],
+                                            opts[:rotate])
+        end
+        raise UploadFailedError.new(code, data) if code != StatusOK
+        return data
+      end
+
+      def stat(bucket, key)
+        code, data = Storage.stat(bucket, key)
+        code == StatusOK ? data : false
+      end
+
+      def get(bucket, key, save_as = nil, expires_in = nil, version = nil)
+        code, data = Storage.get(bucket, key, save_as, expires_in, version)
+        code == StatusOK ? data : false
+      end
+
+      def download(bucket, key, save_as = nil, expires_in = nil, version = nil)
+        code, data = Storage.get(bucket, key, save_as, expires_in, version)
+        code == StatusOK ? data["url"] : false
+      end
+
+      def copy(source_bucket, source_key, target_bucket, target_key)
+        code, data = Storage.copy(source_bucket, source_key, target_bucket, target_key)
+        code == StatusOK
+      end
+
+      def move(source_bucket, source_key, target_bucket, target_key)
+        code, data = Storage.move(source_bucket, source_key, target_bucket, target_key)
+        code == StatusOK
+      end
+
+      def delete(bucket, key)
+        code, data = Storage.delete(bucket, key)
+        code == StatusOK
+      end
+
+      def batch(command, bucket, keys)
+        code, data = Storage.batch(command, bucket, keys)
+        code == StatusOK ? data : false
+      end
+
+      def batch_stat(bucket, keys)
+        code, data = Storage.batch_stat(bucket, keys)
+        code == StatusOK ? data : false
+      end
+
+      def batch_get(bucket, keys)
+        code, data = Storage.batch_get(bucket, keys)
+        code == StatusOK ? data : false
+      end
+
+      def batch_copy(*args)
+        code, data = Storage.batch_copy(args)
+        code == StatusOK
+      end
+
+      def batch_move(*args)
+        code, data = Storage.batch_move(args)
+        code == StatusOK
+      end
+
+      def batch_download(bucket, keys)
+        code, data = Storage.batch_get(bucket, keys)
+        return false unless code == StatusOK
+        links = []
+        data.each { |e| links << e["data"]["url"] }
+        links
+      end
+
+      def batch_delete(bucket, keys)
+        code, data = Storage.batch_delete(bucket, keys)
+        code == StatusOK ? data : false
+      end
+
+      def publish(domain, bucket)
+        code, data = Storage.publish(domain, bucket)
+        code == StatusOK
+      end
+
+      def unpublish(domain)
+        code, data = Storage.unpublish(domain)
+        code == StatusOK
+      end
+
+      def drop(bucket)
+        code, data = Storage.drop(bucket)
+        code == StatusOK
+      end
+
+      def image_info(url)
+        code, data = Fop::Image.info(url)
+        code == StatusOK ? data : false
+      end
+
+      def image_exif(url)
+        code, data = Fop::Image.exif(url)
+        code == StatusOK ? data : false
+      end
+
+      def image_mogrify_preview_url(source_image_url, options)
+        Fop::Image.mogrify_preview_url(source_image_url, options)
+      end
+
+      def image_mogrify_save_as(bucket, key, source_image_url, options)
+        code, data = Storage.image_mogrify_save_as(bucket, key, source_image_url, options)
+        code == StatusOK ? data : false
+      end
+
+      def generate_upload_token(opts = {})
+        token_obj = UploadToken.new(opts)
+        token_obj.access_key = Config.settings[:access_key]
+        token_obj.secret_key = Config.settings[:secret_key]
+        #token_obj.scope = opts[:scope]
+        #token_obj.expires_in = opts[:expires_in]
+        #token_obj.callback_url = opts[:callback_url]
+        #token_obj.callback_body_type = opts[:callback_body_type]
+        #token_obj.customer = opts[:customer]
+        #token_obj.escape = opts[:escape]
+        #token_obj.async_options = opts[:async_options]
+        #token_obj.return_body = opts[:return_body]
+        token_obj.generate_token
+      end
+
+      def generate_download_token(opts = {})
+        token_obj = DownloadToken.new(opts)
+        token_obj.access_key = Config.settings[:access_key]
+        token_obj.secret_key = Config.settings[:secret_key]
+        #token_obj.expires_in = opts[:expires_in]
+        #token_obj.pattern = opts[:pattern]
+        token_obj.generate_token
+      end
+
+    end
+
+end # module Qiniu

data/lib/qiniu/abstract.rb

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+
+module Qiniu
+    module Abstract
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def abstract_methods(*args)
+          args.each do |name|
+            class_eval <<-END
+              def #{name}(*args)
+                errmsg = %Q(class \#{self.class.name} must implement abstract method #{self.name}##{name}().)
+                raise NotImplementedError.new(errmsg)
+              end
+            END
+          end
+        end
+      end
+    end # module Abstract
+end # module Qiniu

data/lib/qiniu/auth.rb

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+
+require 'qiniu/exceptions'
+
+module Qiniu
+    module Auth
+
+      class << self
+
+        include Utils
+
+        def call_with_signature(url, data, retry_times = 0, options = {})
+          code, data = http_request url, data, options.merge({:qbox_signature_token => generate_qbox_signature(url, data, options[:mime])})
+          [code, data]
+        end
+
+        def request(url, data = nil, options = {})
+          code, data = Auth.call_with_signature(url, data, 0, options)
+          [code, data]
+        end
+
+      end
+
+    end # module Auth
+end # module Qiniu

data/lib/qiniu/config.rb

@@ -0,0 +1,61 @@
+# -*- encoding: utf-8 -*-
+#
+# USAGE WAY 1:
+# Qbox::Config.initialize_connect :client_id => "<ClientID>",
+#                                 :client_secret => "<ClientSecret>"
+#
+# USAGE WAY 2:
+# Qbox::Config.load "path/to/your_project/config/qiniu.yml"
+#
+
+require 'tmpdir'
+
+module Qiniu
+    module Config
+      class << self
+
+        DEFAULT_OPTIONS = {
+          :user_agent      => 'Qiniu-RS-Ruby-SDK-' + Version.to_s + '()',
+          :method          => :post,
+          :content_type    => 'application/x-www-form-urlencoded',
+          :auth_url        => "https://acc.qbox.me/oauth2/token",
+          :rs_host         => "http://rs.qiniu.com",
+          :io_host         => "http://iovip.qbox.me",
+          :up_host         => "http://up.qiniu.com",
+          :pub_host        => "http://pu.qbox.me:10200",
+          :eu_host         => "http://eu.qbox.me",
+          :client_id       => "a75604760c4da4caaa456c0c5895c061c3065c5a",
+          :client_secret   => "75df554a39f58accb7eb293b550fa59618674b7d",
+          :access_key      => "",
+          :secret_key      => "",
+          :auto_reconnect  => true,
+          :max_retry_times => 3,
+          :block_size      => 1024*1024*4,
+          :chunk_size      => 1024*256,
+          :enable_debug    => true,
+          :tmpdir          => Dir.tmpdir + File::SEPARATOR + 'Qiniu-RS-Ruby-SDK'
+        }
+
+        REQUIRED_OPTION_KEYS = [:access_key, :secret_key]
+
+        attr_reader :settings, :default_params
+
+        def load config_file
+          if File.exist?(config_file)
+            config_options = YAML.load_file(config_file)
+            initialize_connect(config_options)
+          else
+            raise MissingConfError, config_file
+          end
+        end
+
+        def initialize_connect options = {}
+          @settings = DEFAULT_OPTIONS.merge(options)
+          REQUIRED_OPTION_KEYS.each do |opt|
+            raise MissingArgsError, [opt] unless @settings.has_key?(opt)
+          end
+        end
+
+      end
+    end # module Config
+end # module Qiniu

data/lib/qiniu/exceptions.rb

@@ -0,0 +1,120 @@
+# -*- encoding: utf-8 -*-
+
+module Qiniu
+
+    class Exception < RuntimeError
+    end
+
+    class ResponseError < Exception
+      attr_reader :response
+
+      def initialize(message, response = nil)
+        @response = response
+        super(message)
+      end
+
+      def http_code
+        @response.code.to_i if @response
+      end
+
+      def http_body
+        @response.body if @response
+      end
+
+      def inspect
+        "#{message}: #{http_body}"
+      end
+    end
+
+    class RequestFailed < ResponseError
+      def message
+        "HTTP status code: #{http_code}. Response body: #{http_body}"
+      end
+
+      def to_s
+        message
+      end
+    end
+
+    class UploadFailedError < Exception
+      def initialize(status_code, response_data)
+        data_string = response_data.map { |key, value| %Q(:#{key.to_s} => #{value.to_s}) }
+        msg = %Q(Uploading Failed. HTTP Status Code: #{status_code}. HTTP response body: #{data_string.join(', ')}.)
+        super(msg)
+      end
+    end
+
+    class FileSeekReadError < Exception
+      def initialize(fpath, block_index, seek_pos, read_length, result_length)
+        msg =  "Reading file: #{fpath}, "
+        msg += "at block index: #{block_index}. "
+        msg += "Expected seek_pos:#{seek_pos} and read_length:#{read_length}, "
+        msg += "but got result_length: #{result_length}."
+        super(msg)
+      end
+    end
+
+    class BlockSizeNotMathchError < Exception
+      def initialize(fpath, block_index, offset, restsize, block_size)
+        msg  = "Reading file: #{fpath}, "
+        msg += "at block index: #{block_index}. "
+        msg += "Expected offset: #{offset}, restsize: #{restsize} and block_size: #{block_size}, "
+        msg += "but got offset+restsize=#{offset+restsize}."
+        super(msg)
+      end
+    end
+
+    class BlockCountNotMathchError < Exception
+      def initialize(fpath, block_count, checksum_count, progress_count)
+        msg  = "Reading file: #{fpath}, "
+        msg += "Expected block_count, checksum_count, progress_count is: #{block_count}, "
+        msg += "but got checksum_count: #{checksum_count}, progress_count: #{progress_count}."
+        super(msg)
+      end
+    end
+
+    class MissingArgsError < Exception
+      def initialize(missing_keys)
+        key_list = missing_keys.map {|key| key.to_s}.join(' and the ')
+        super("You did not provide both required args. Please provide the #{key_list}.")
+      end
+    end
+
+    class MissingAccessToken < MissingArgsError
+      def initialize
+        super([:access_token])
+      end
+    end
+
+    class MissingRefreshToken < MissingArgsError
+      def initialize
+        super([:refresh_token])
+      end
+    end
+
+    class MissingUsernameOrPassword < MissingArgsError
+      def initialize
+        super([:username, :password])
+      end
+    end
+
+    class InvalidArgsError < Exception
+      def initialize(invalid_keys)
+        key_list = invalid_keys.map {|key| key.to_s}.join(' and the ')
+        super("#{key_list} should not be empty.")
+      end
+    end
+
+    class MissingConfError < Exception
+      def initialize(missing_conf_file)
+        super("Error, missing #{missing_conf_file}. You must have #{missing_conf_file} to configure your client id and secret.")
+      end
+    end
+
+    class NoSuchFileError < Exception
+      def initialize(missing_file)
+        super("Error, no such file #{missing_file}.")
+      end
+    end
+
+end # module Qiniu