qiniu 6.8.1 → 6.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82f51989fb126863f36c204186a0d3065d9d240e
-  data.tar.gz: d691e53432a0b3cdffc3407cbc4b1f0798b9f194
+  metadata.gz: 306d8a843360b13bd622e22467add2b392657a78
+  data.tar.gz: 5e15d490efd048e1f3f8b00c04658cf29d00e46d
 SHA512:
-  metadata.gz: 6457dd9d80b710e52fb52610af683f990460842f131937b477827791ffd202685361097d1126aa15382423d32e7b3037e622e3fb4db0efc2bf131a103dd1efae
-  data.tar.gz: bda38a85d3b1dd1f199018bc4c78baf40431027c850faff7e6330238487fa5360a20234d9d61e61a348caf05bc58936c4474394613158301dc2b5919191a6947
+  metadata.gz: d9937b7d424f62640fcdf7b2cd84648799c41c4e6d739f79df01f3bd94fc83f6a30ecd22fdca8602437e2c854b49459e607421057597b1d28893ba2adbe6bf83
+  data.tar.gz: fdc93590e8b774bc5ea732171189555daad50b6d4023e809a6e585b36b32a51959feeb17c33c3d0080bb827034c1f762c0f3e4ae97d896c68c8d2ed328c48732

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## CHANGE LOG
 
+### 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)

data/README.md

@@ -9,6 +9,7 @@
 * Ruby 2.1.x
 * Ruby 2.2.x
 * Ruby 2.3.x
+* Ruby 2.4.x
 * JRuby 9.x
 
 如果您的应用程序需要在 Ruby 1.9、2.0 或 JRuby 1.7 上运行，请使用此 Ruby SDK 的 6.6.0 版本。
@@ -24,7 +25,7 @@
 
 在您 Ruby 应用程序的 `Gemfile` 文件中，添加如下一行代码：
 
-    gem 'qiniu', '>= 6.8.0'
+    gem 'qiniu', '>= 6.9.0'
 
 然后，在应用程序所在的目录下，可以运行 `bundle` 安装依赖包：
 

data/lib/qiniu.rb

@@ -3,20 +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'
-  autoload :HostManager, 'qiniu/host_manager'
+  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
 
@@ -26,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
@@ -94,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
@@ -134,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
@@ -149,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
 
@@ -171,7 +164,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
@@ -184,7 +177,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,6 @@ 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      => nil,
-          :rsf_host        => "http://rsf.qbox.me",
-          :up_host         => nil,
-          :pub_host        => "http://pu.qbox.me:10200",
-          :eu_host         => "http://eu.qbox.me",
-          :uc_host         => "http://uc.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',
-          :multi_region    => true
-        }
-
-        REQUIRED_OPTION_KEYS = [:access_key, :secret_key]
-
         attr_reader :settings, :default_params, :host_manager
 
         def load config_file
@@ -52,14 +26,31 @@ 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
@@ -67,6 +58,54 @@ module Qiniu
         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

@@ -50,7 +50,7 @@ module Qiniu
     private
 
     def extract_protocol(opts)
-      opts[:protocol] || 'http'
+      (opts[:protocol] || @config[:protocol]).to_s
     end
 
     def multi_region_support?

data/lib/qiniu/management.rb

@@ -57,14 +57,6 @@ module Qiniu
           return HTTP.management_post(url)
         end # stat
 
-        def get(bucket, key, save_as = nil, expires_in = nil, version = nil)
-          url = Config.settings[:rs_host] + '/get/' + encode_entry_uri(bucket, key)
-          url += '/base/' + version unless version.nil?
-          url += '/attName/' + Utils.urlsafe_base64_encode(save_as) unless save_as.nil?
-          url += '/expires/' + expires_in.to_s if !expires_in.nil? && expires_in > 0
-          return HTTP.management_post(url)
-        end # get
-
         def copy(source_bucket, source_key, target_bucket, target_key)
           uri = _generate_cp_or_mv_opstr('copy', source_bucket, source_key, target_bucket, target_key)
           url = Config.settings[:rs_host] + uri
@@ -97,16 +89,12 @@ module Qiniu
           return HTTP.management_post(url, execs.join("&"))
         end # batch
 
-        def batch_get(bucket, keys)
-          batch("get", bucket, keys)
-        end # batch_get
-
         def batch_stat(bucket, keys)
           batch("stat", bucket, keys)
         end # batch_stat
 
         def batch_copy(*args)
-          _batch_cp_or_mv('copy', args)
+          _batch_cp_or_mv('copy', *args)
         end # batch_copy
 
         def batch_move(*args)
@@ -149,6 +137,11 @@ module Qiniu
           return resp_code, resp_body, resp_headers, has_more, new_list_policy
         end # list
 
+        def domains(bucket)
+          url = Config.settings[:api_host] + '/v7/domain/list?tbl=' + bucket
+          return HTTP.management_post(url)
+        end
+
         private
 
         def _generate_cp_or_mv_opstr(command, source_bucket, source_key, target_bucket, target_key)

data/lib/qiniu/pfop.rb

@@ -72,11 +72,8 @@ module Qiniu
 
       class << self
 
-        API_HOST = 'http://api.qiniu.com'
-
-        PFOP_URL = API_HOST + '/pfop/'
-
         def pfop (args)
+          pfop_url = Config.settings[:api_host] + '/pfop/'
           ### 生成fop指令串
           if args.is_a?(PfopPolicy) then
             # PfopPolicy的各个字段按固定顺序组织
@@ -90,12 +87,12 @@ module Qiniu
           end
 
           ### 发送请求
-          return HTTP.management_post(PFOP_URL, body)
+          return HTTP.management_post(pfop_url, body)
         end # pfop
 
-        PREFOP_URL = API_HOST + '/status/get/prefop?id='
 
         def prefop (persistent_id)
+          prefop_url = Config.settings[:api_host] + '/status/get/prefop?id='
           ### 抽取persistentId
           if persistent_id.is_a?(Hash) then
             pid = persistent_id['persistentId']
@@ -104,7 +101,7 @@ module Qiniu
           end
 
           ### 发送请求
-          url = PREFOP_URL + pid
+          url = prefop_url + pid
           return HTTP.api_get(url)
         end # prefop
 

data/lib/qiniu/tokens/access_token.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 
-require 'hmac-sha1'
+require 'openssl'
 require 'qiniu/config'
 require 'qiniu/utils'
 
@@ -14,9 +14,8 @@ module Qiniu
         attr_accessor :access_key, :secret_key
 
         def generate_encoded_digest(signature)
-          hmac = HMAC::SHA1.new(@secret_key)
-          hmac.update(signature)
-          urlsafe_base64_encode(hmac.digest)
+          raw_hmac_digest = OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), @secret_key, signature)
+          urlsafe_base64_encode(raw_hmac_digest)
         end
 
       end # AccessToken

data/lib/qiniu/utils.rb

@@ -6,7 +6,6 @@ require 'json'
 require 'zlib'
 require 'base64'
 require 'rest_client'
-require 'hmac-sha1'
 require 'qiniu/exceptions'
 
 module Qiniu

data/lib/qiniu/version.rb

@@ -3,8 +3,8 @@
 module Qiniu
     module Version
       MAJOR = 6
-      MINOR = 8
-      PATCH = 1
+      MINOR = 9
+      PATCH = 0
       # Returns a version string by joining <tt>MAJOR</tt>, <tt>MINOR</tt>, and <tt>PATCH</tt> with <tt>'.'</tt>
       #
       # Example

data/spec/qiniu/auth_spec.rb

@@ -39,11 +39,10 @@ module Qiniu
           puts raw_headers.inspect
 
           ### 获取下载地址
-          code, data = Qiniu::Storage.get(@bucket, key)
-          code.should == 200
-          puts data.inspect
-
-          url = data['url']
+          code, domains, = Qiniu::Storage.domains(@bucket)
+          domains.should_not be_empty
+          domain = domains.first['domain']
+          url = "http://#{domain}/#{key}"
 
           ### 授权下载地址（不带参数）
           download_url = Qiniu::Auth.authorize_download_url(url)
@@ -54,12 +53,7 @@ module Qiniu
           result.body.should_not be_empty
 
           ### 授权下载地址（带参数）
-          download_url = Qiniu::Auth.authorize_download_url(
-            url,
-            {
-              :fop => 'download/a.m3u8'
-            }
-          )
+          download_url = Qiniu::Auth.authorize_download_url(url, fop: 'qhash/md5')
           puts "download_url=#{download_url}"
 
           result = RestClient.get(download_url)
@@ -68,8 +62,8 @@ module Qiniu
 
           ### 删除文件
           code, data = Qiniu::Storage.delete(@bucket, key)
-          code.should == 200
           puts data.inspect
+          code.should == 200
         end
 
         it "should generate uphosts and global for multi_region" do
@@ -83,7 +77,7 @@ module Qiniu
 
             ### 生成 PutPolicy
             pp = Auth::PutPolicy.new(@bucket, key)
-            expect(pp.instance_variable_get(:@uphosts)).to eq ["http://up.qiniu.com", "http://upload.qiniu.com", "-H up.qiniu.com http://183.136.139.16"]
+            expect(pp.instance_variable_get(:@uphosts)).to eq ["http://up.qiniu.com", "http://upload.qiniu.com", "-H up.qiniu.com http://183.131.7.18"]
             expect(pp.instance_variable_get(:@global)).to be false
           ensure
             Config.settings[:multi_region] = origin_multi_region