qiniu 6.6.0 → 6.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6156890d8118959d78f316edf9c7de45fd66affe
-  data.tar.gz: b4750d7adf8b61b924af905c4fe91757e468cf97
+SHA256:
+  metadata.gz: 1a186af33928bfc26c7918fa28e2d3b747c3ee0917f75feaded835d778d61cdd
+  data.tar.gz: ed06c6e414c438b98ad98ed258c542ccca9d424541b9378a8a9426f83ba79ec3
 SHA512:
-  metadata.gz: 49ce22e5fdc92699eb5eed74f9c6c19db50896370c2704251bfb4aa8dd8dd65a575d6c64fe8dbcddbe37560cc29f7b8ba44697f5d531412767c5fec1c119acae
-  data.tar.gz: 5d2df9eb2a1533d9fbf07cc16339779699b9f24f6a00c9a0a2b598206082d9ec742b2eacaa42cb268380f22dd4b064201c9067c2c825588a1c73d41375862e6e
+  metadata.gz: 21ea48d66bb48632d71195d87a2be48eaa1ac492d2033203599f8c82850c8502d1d1a1af21e64f749b9398e7d5762047a91e7b3d83fe997b50d4ff393ad0f4b8
+  data.tar.gz: 8d6cd1a2fe505c41ec3937a0d918d44315721103c39f49293ad4e1600c342068d4b41a5288caf6a5c539d2a60d4b6f23ba9fd1a86abe75f5d97439cabf0e28ab

data/CHANGELOG.md

@@ -1,14 +1,42 @@
 ## CHANGE LOG
 
-### V6.6.0
+### v6.9.0
+
+- 增加 `Qiniu.establish_https_connection!` 方法，使所有七牛请求都使用 HTTPS 协议，保证连接的安全性。
+
+- 重构随 gem 附带的 example 中的代码，使用更简洁易用的 API。
+
+- 移除 `Qiniu::Config::DEFAULT_OPTIONS`，用户可以调用 `Qiniu::Config.settings` 获取七牛配置。
+
+- 移除 `Qiniu.get`，`Qiniu.download` 和 `Qiniu::Storage.get` 方法以及它们的 `batch` 版本。
+
+- 移除对于 Fixnum 的使用，支持 Ruby 2.4.x
+
+### v6.8.1
+
+- 增加delafterdays 策略。[https://github.com/qiniu/ruby-sdk/pull/162](https://github.com/qiniu/ruby-sdk/pull/162)
+
+- 调整依赖。[https://github.com/qiniu/ruby-sdk/pull/167](https://github.com/qiniu/ruby-sdk/pull/167)
+
+### v6.8.0
+
+- 支持多存储区域，部分 API 需要额外的 bucket 参数。[https://github.com/qiniu/ruby-sdk/pull/161](https://github.com/qiniu/ruby-sdk/pull/161)
+
+### v6.7.0
+
+- 放弃支持过时的 Ruby 1.9、Ruby 2.0 和 JRuby 1.7。[https://github.com/qiniu/ruby-sdk/pull/149](https://github.com/qiniu/ruby-sdk/pull/149)
+- 更好地支持 Rails 4。
+- 确保自动化测试在 CI 上完全通过，为下一步开发做准备。
+
+### v6.6.0
 
 - 添加 upload_buffer_with_put_policy() 方法，直接上传一块数据作为文件内容。[https://github.com/qiniu/ruby-sdk/pull/146](https://github.com/qiniu/ruby-sdk/pull/146)
 
-### V6.5.2
+### v6.5.2
 
 - 修正无法触发加载异常类的问题；修正 batch_move 参数未正确打包的问题。[https://github.com/qiniu/ruby-sdk/pull/142](https://github.com/qiniu/ruby-sdk/pull/142)
 
-### V6.5.1
+### v6.5.1
 
 - 为 Qiniu::Auth 添加验证七牛回调请求签名合法性的函数。[https://github.com/qiniu/ruby-sdk/pull/133](https://github.com/qiniu/ruby-sdk/pull/133)
 

data/README.md

@@ -1,21 +1,35 @@
 # Qiniu Resource (Cloud) Storage SDK for Ruby
 
+[![LICENSE](https://img.shields.io/github/license/qiniu/ruby-sdk.svg)](https://github.com/qiniu/ruby-sdk/blob/master/LICENSE)
+[![Build Status](https://travis-ci.org/qiniu/ruby-sdk.svg?branch=develop)](https://travis-ci.org/qiniu/ruby-sdk)
+[![GitHub release](https://img.shields.io/github/v/tag/qiniu/ruby-sdk.svg?label=release)](https://github.com/qiniu/ruby-sdk/releases)
+[![Coverage Status](https://codecov.io/gh/qiniu/ruby-sdk/branch/develop/graph/badge.svg)](https://codecov.io/gh/qiniu/ruby-sdk)
+[![Gem Version](https://badge.fury.io/rb/qiniu.svg)](http://badge.fury.io/rb/qiniu)
+[![Dependency Status](https://gemnasium.com/qiniu/ruby-sdk.svg)](https://gemnasium.com/qiniu/ruby-sdk)
+[![Code Climate](https://codeclimate.com/github/qiniu/ruby-sdk.svg)](https://codeclimate.com/github/qiniu/ruby-sdk)
+
 ## 关于
 
-此 Ruby SDK 适用于 Ruby 1.9.x, 2.0.x, 2.1.x, jruby版本，基于 [七牛云存储官方API](http://developer.qiniu.com/docs/v6/index.html) 构建。使用此 SDK 构建您的网络应用程序，能让您以非常便捷地方式将数据安全地存储到七牛云存储上。无论您的网络应用是一个网站程序，还是包括从云端（服务端程序）到终端（手持设备应用）的架构的服务或应用，通过七牛云存储及其 SDK，都能让您应用程序的终端用户高速上传和下载，同时也让您的服务端更加轻盈。
+此 Ruby SDK 基于 [七牛云存储官方API](http://developer.qiniu.com/docs/v6/index.html) 构建。使用此 SDK 构建您的网络应用程序，能让您以非常便捷地方式将数据安全地存储到七牛云存储上。无论您的网络应用是一个网站程序，还是包括从云端（服务端程序）到终端（手持设备应用）的架构的服务或应用，通过七牛云存储及其 SDK，都能让您应用程序的终端用户高速上传和下载，同时也让您的服务端更加轻盈。
+
+支持的 Ruby 版本：
 
-## 状态
+* Ruby 2.1.x
+* Ruby 2.2.x
+* Ruby 2.3.x
+* Ruby 2.4.x
+* Ruby 2.5.x
+* Ruby 2.6.x
+* Ruby 2.7.x
+* JRuby 9.x
 
-[![Build Status](https://api.travis-ci.org/qiniu/ruby-sdk.png?branch=master)](https://travis-ci.org/qiniu/ruby-sdk)
-[![Gem Version](https://badge.fury.io/rb/qiniu.png)](http://badge.fury.io/rb/qiniu)
-[![Dependency Status](https://gemnasium.com/qiniu/ruby-sdk.png)](https://gemnasium.com/qiniu/ruby-sdk)
-[![Code Climate](https://codeclimate.com/github/qiniu/ruby-sdk.png)](https://codeclimate.com/github/qiniu/ruby-sdk)
+如果您的应用程序需要在 Ruby 1.9、2.0 或 JRuby 1.7 上运行，请使用此 Ruby SDK 的 6.6.0 版本。
 
 ## 安装
 
 在您 Ruby 应用程序的 `Gemfile` 文件中，添加如下一行代码：
 
-    gem 'qiniu', '=> 6.4.1', '<= 6.6.0'
+    gem 'qiniu', '>= 6.9.1'
 
 然后，在应用程序所在的目录下，可以运行 `bundle` 安装依赖包：
 
@@ -25,14 +39,6 @@
 
     $ gem install qiniu
 
-## Rails 4 项目安装
-
-在 Rails 4 项目的 `Gemfile` 里添加 `qiniu` 后执行 `bundle` 命令可能会失败，这是因为 Rails 4 项目默认会使用 `mime-types` 3.x 版本。需要使用以下命令将 `mime-types` 降级为满足 Qiniu Ruby SDK 的 2.6.x 版本。
-
-    bundle update mime-types
-
-由于 `mime-types` 3.0 要求的最低 Ruby 版本是 2.0，而 Qiniu Ruby SDK 支持 Ruby 1.9，因此我们不能通过简单修改对 `mime-types` 的版本依赖来解决此问题。
-
 ## 使用
 
 参考文档：[七牛云存储 Ruby SDK 使用指南](http://developer.qiniu.com/docs/v6/sdk/ruby-sdk.html)

data/lib/qiniu.rb

@@ -3,19 +3,21 @@
 require 'qiniu/exceptions'
 
 module Qiniu
-  autoload :Version, 'qiniu/version'
-  autoload :Utils, 'qiniu/utils'
-  autoload :Auth, 'qiniu/auth'
-  autoload :Config, 'qiniu/config'
-  autoload :Log, 'qiniu/log'
-  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'
+  require_relative 'qiniu/version'
+  require_relative 'qiniu/utils'
+  require_relative 'qiniu/auth'
+  require_relative 'qiniu/config'
+  require_relative 'qiniu/log'
+  require_relative 'qiniu/tokens/access_token'
+  require_relative 'qiniu/tokens/qbox_token'
+  require_relative 'qiniu/tokens/upload_token'
+  require_relative 'qiniu/tokens/download_token'
+  require_relative 'qiniu/abstract'
+  require_relative 'qiniu/storage'
+  require_relative 'qiniu/fop'
+  require_relative 'qiniu/misc'
+  require_relative 'qiniu/host_manager'
+  require_relative 'qiniu/http'
 
     class << self
 
@@ -25,6 +27,18 @@ module Qiniu
         Config.initialize_connect opts
       end
 
+      def establish_https_connection!(opts = {})
+        Config.initialize_connect_https opts
+      end
+
+      def switch_to_http!
+        Config.switch_to_http
+      end
+
+      def switch_to_https!
+        Config.switch_to_https
+      end
+
       def mkbucket(bucket_name)
         code, data = Storage.mkbucket(bucket_name)
         code == StatusOK
@@ -93,16 +107,6 @@ module Qiniu
         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
@@ -133,11 +137,6 @@ module Qiniu
         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
@@ -148,14 +147,6 @@ module Qiniu
         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

data/lib/qiniu/auth.rb

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 # vim: sw=2 ts=2
 
-require 'hmac-sha1'
+require 'openssl'
 require 'uri'
 require 'cgi'
 
@@ -27,15 +27,8 @@ module Qiniu
         end # calculate_deadline
 
         def calculate_hmac_sha1_digest(sk, str)
-          begin
-            sign = HMAC::SHA1.new(sk).update(str).digest
-          rescue RuntimeError => e
-            raise RuntimeError, "Please set Qiniu's access_key and secret_key before authorize any tokens."
-          rescue
-            raise
-          else
-            return sign
-          end
+          raise ArgumentError, "Please set Qiniu's access_key and secret_key before authorize any tokens." if sk.nil?
+          OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), sk, str)
         end
       end # class << self
 
@@ -56,6 +49,7 @@ module Qiniu
         PARAMS = {
           # 字符串类型参数
           :scope                  => "scope"               ,
+          :is_prefixal_scope      => "isPrefixalScope"     ,
           :save_key               => "saveKey"             ,
           :end_user               => "endUser"             ,
           :return_url             => "returnUrl"           ,
@@ -71,10 +65,14 @@ module Qiniu
           # 数值类型参数
           :deadline               => "deadline"            ,
           :insert_only            => "insertOnly"          ,
+          :fsize_min              => "fsizeMin"            ,
           :fsize_limit            => "fsizeLimit"          ,
-          :callback_fetch_key     => "callbackFetchKey"    ,
           :detect_mime            => "detectMime"          ,
-          :mime_limit             => "mimeLimit"
+          :mime_limit             => "mimeLimit"           ,
+          :uphosts                => "uphosts"             ,
+          :global                 => "global"              ,
+          :delete_after_days      => "deleteAfterDays"     ,
+          :file_type              => "fileType"
         } # PARAMS
 
         public
@@ -91,6 +89,15 @@ module Qiniu
             # 覆盖语义，文件已存在则直接覆盖
             @scope = "#{bucket}:#{key}"
           end
+
+          if Config.settings[:multi_region]
+            begin
+              @uphosts = Config.host_manager.up_hosts(bucket)
+              @global = Config.host_manager.global(bucket)
+            rescue
+              # Do nothing
+            end
+          end
         end # scope!
 
         def expires_in!(seconds)
@@ -159,7 +166,7 @@ module Qiniu
 
           ### URL变换：追加FOP指令
           if args[:fop].is_a?(String) && args[:fop] != '' then
-            if download_url.index('?').is_a?(Fixnum) then
+            if download_url.include?('?')
               # 已有参数
               download_url = "#{download_url}&#{args[:fop]}"
             else
@@ -172,7 +179,7 @@ module Qiniu
           e = Auth.calculate_deadline(args[:expires_in], args[:deadline])
 
           ### URL变换：追加授权期参数
-          if download_url.index('?').is_a?(Fixnum) then
+          if download_url.include?('?')
             # 已有参数
             download_url = "#{download_url}&e=#{e}"
           else

data/lib/qiniu/config.rb

@@ -13,32 +13,7 @@ require 'tmpdir'
 module Qiniu
     module Config
       class << self
-
-        DEFAULT_OPTIONS = {
-          :user_agent      => 'QiniuRuby/' + Version.to_s + ' ('+RUBY_PLATFORM+')' + ' Ruby/'+ RUBY_VERSION,
-          :method          => :post,
-          :content_type    => 'application/x-www-form-urlencoded',
-          :auth_url        => "https://acc.qbox.me/oauth2/token",
-          :rs_host         => "http://rs.qiniu.com",
-          :fetch_host      => "http://iovip.qbox.me",
-          :rsf_host        => "http://rsf.qbox.me",
-          :up_host         => "http://up.qiniu.com",
-          :pub_host        => "http://pu.qbox.me:10200",
-          :eu_host         => "http://eu.qbox.me",
-          :iovip_host         => "http://iovip.qbox.me",
-          :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 + 'QiniuRuby'
-        }
-
-        REQUIRED_OPTION_KEYS = [:access_key, :secret_key, :up_host]
-
-        attr_reader :settings, :default_params
+        attr_reader :settings, :default_params, :host_manager
 
         def load config_file
           if File.exist?(config_file)
@@ -51,12 +26,86 @@ module Qiniu
         end
 
         def initialize_connect options = {}
-          @settings = DEFAULT_OPTIONS.merge!(options)
-          REQUIRED_OPTION_KEYS.each do |opt|
+          options = if options[:protocol] == :https
+                      https_options.merge(options)
+                    else
+                      http_options.merge(options)
+                    end
+          @settings = default_options.merge(options)
+          required_options_keys.each do |opt|
             raise MissingArgsError, [opt] unless @settings.has_key?(opt)
           end
+          @host_manager = HostManager.new(@settings)
+          nil
+        end
+
+        def initialize_connect_https options = {}
+          initialize_connect(options.merge(:protocol => :https))
+        end
+
+        def switch_to_http
+          @settings.merge!(http_options)
         end
 
+        def switch_to_https
+          @settings.merge!(https_options)
+        end
+
+        def up_host(bucket, opts = {})
+          @settings[:up_host] || @host_manager.up_host(bucket, opts)
+        end
+
+        def fetch_host(bucket, opts = {})
+          @settings[:fetch_host] || @host_manager.fetch_host(bucket, opts)
+        end
+
+        private
+
+        def default_options
+          {
+            :user_agent      => 'QiniuRuby/' + Version.to_s + ' ('+RUBY_PLATFORM+')' + ' Ruby/'+ RUBY_VERSION,
+            :method          => :post,
+            :content_type    => 'application/x-www-form-urlencoded',
+            :auth_url        => "https://acc.qbox.me/oauth2/token",
+            :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 + 'QiniuRuby',
+            :multi_region    => true
+          }.freeze
+        end
+
+        def http_options
+          {
+            :rs_host          => "http://rs.qiniu.com",
+            :rsf_host         => "http://rsf.qbox.me",
+            :pub_host         => "http://pu.qbox.me:10200",
+            :eu_host          => "http://eu.qbox.me",
+            :uc_host          => "http://uc.qbox.me",
+            :api_host         => "http://api.qiniu.com",
+            :protocol => :http
+          }.freeze
+        end
+
+        def https_options
+          {
+            :rs_host         => "https://rs.qbox.me",
+            :rsf_host        => "https://rsf.qbox.me",
+            :pub_host        => "https://pu.qbox.me",
+            :eu_host         => "https://eu.qbox.me",
+            :uc_host         => "https://uc.qbox.me",
+            :api_host        => "https://api.qiniu.com",
+            :protocol => :https
+          }.freeze
+        end
+
+        def required_options_keys
+          [:access_key, :secret_key].freeze
+        end
       end
     end # module Config
 end # module Qiniu

data/lib/qiniu/host_manager.rb

@@ -0,0 +1,104 @@
+require 'thread'
+require 'cgi'
+
+module Qiniu
+  class BucketIsMissing < RuntimeError; end
+
+  class HostManager
+    def initialize(config)
+      @config = config
+      @mutex = Mutex.new
+      @hosts = {}
+    end
+
+    def up_host(bucket, opts = {})
+      if !multi_region_support?
+        "#{extract_protocol(opts)}://up.qiniu.com"
+      elsif bucket
+        hosts(bucket)[extract_protocol(opts)]['up'][0] rescue "#{extract_protocol(opts)}://up.qiniu.com"
+      else
+        raise BucketIsMissing, 'HostManager#up_host: bucket is required when multi_region is enabled'
+      end
+    end
+
+    def fetch_host(bucket, opts = {})
+      if !multi_region_support?
+        "#{extract_protocol(opts)}://iovip.qbox.me"
+      elsif bucket
+        hosts(bucket)[extract_protocol(opts)]['io'][0] rescue "#{extract_protocol(opts)}://iovip.qbox.me"
+      else
+        raise BucketIsMissing, 'HostManager#fetch_host: bucket is required when multi_region is enabled'
+      end
+    end
+
+    def up_hosts(bucket, opts = {})
+      if multi_region_support?
+        hosts(bucket)[extract_protocol(opts)]['up']
+      else
+        raise 'HostManager#up_hosts: multi_region must be enabled'
+      end
+    end
+
+    def global(bucket, opts = {})
+      if multi_region_support?
+        !!hosts(bucket)['global']
+      else
+        raise 'HostManager#global: multi_region must be enabled'
+      end
+    end
+
+    private
+
+    def extract_protocol(opts)
+      (opts[:protocol] || @config[:protocol]).to_s
+    end
+
+    def multi_region_support?
+      @config[:multi_region]
+    end
+
+    def hosts(bucket)
+      host = read_host(bucket)
+      if host
+        if host_expired?(host)
+          delete_host(bucket)
+        else
+          return host
+        end
+      end
+      url = @config[:uc_host] + '/v1/query?' + HTTP.generate_query_string(ak: @config[:access_key], bucket: bucket)
+      status, body = HTTP.api_get(url)
+      if HTTP.is_response_ok?(status)
+        Utils.debug("Query #{bucket} hosts Success: #{body}")
+        host = body.merge(:time => Time.now)
+        write_host(bucket, host)
+        host
+      else
+        Utils.debug("Query #{bucket} hosts Error: #{body}")
+        raise "Host query is failed"
+      end
+    end
+
+    def host_expired?(host)
+      host[:time] + host['ttl'] < Time.now
+    end
+
+    def read_host(bucket)
+      @mutex.synchronize do
+        @hosts[bucket]
+      end
+    end
+
+    def write_host(bucket, host)
+      @mutex.synchronize do
+        @hosts[bucket] = host
+      end
+    end
+
+    def delete_host(bucket)
+      @mutex.synchronize do
+        @hosts.delete(bucket)
+      end
+    end
+  end
+end