carrierwave-qiniu 1.2.1 → 1.2.2

data/Rakefile

@@ -1,2 +1,6 @@
-#!/usr/bin/env rake
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "carrierwave-qiniu"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/carrierwave-qiniu.gemspec

@@ -1,22 +1,31 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/carrierwave-qiniu/version', __FILE__)
+require_relative 'lib/carrierwave/qiniu/version'
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Marble Wu"]
-  gem.email         = ["huobazi@gmail.com"]
-  gem.description   = %q{Qiniu Storage support for CarrierWave}
-  gem.summary       = %q{Qiniu Storage support for CarrierWave}
-  gem.homepage      = "https://github.com/huobazi/carrierwave-qiniu"
-  gem.license       = "MIT"
+Gem::Specification.new do |spec|
+  spec.name          = "carrierwave-qiniu"
+  spec.version       = Carrierwave::Qiniu::VERSION
+  spec.authors       = ["Marble Wu"]
+  spec.email         = ["huobazi@gmail.com"]
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "carrierwave-qiniu"
-  gem.require_paths = ["lib"]
-  gem.version       = Carrierwave::Qiniu::VERSION
+  spec.summary       = %q{Qiniu Storage support for CarrierWave}
+  spec.description   = %q{Qiniu Storage support for CarrierWave}
+  spec.homepage      = "https://github.com/huobazi/carrierwave-qiniu"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/huobazi/carrierwave-qiniu"
+  spec.metadata["changelog_uri"] = "https://github.com/huobazi/carrierwave-qiniu/blob/master/CHANGELOG.md.md"
 
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  gem.add_dependency "carrierwave" , ">= 1"
-  gem.add_dependency "qiniu", "~> 6.9", ">= 6.9.0"
+
+  spec.add_dependency "carrierwave" , ">= 1"
+  spec.add_dependency "qiniu", "~> 6.9", ">= 6.9.0"
 end

data/lib/carrierwave-qiniu.rb

@@ -1,10 +1,15 @@
 # encoding: utf-8
-require "carrierwave-qiniu/version"
-require "carrierwave/storage/qiniu"
+
+require "carrierwave"
+require "carrierwave/qiniu/version"
 require "carrierwave/qiniu/configuration"
+require "carrierwave/qiniu/connection"
 require "carrierwave/qiniu/style"
-require "carrierwave/uploader/base"
 require "carrierwave/qiniu/railtie" if defined?(Rails)
+require "carrierwave/storage/qiniu"
+require "carrierwave/storage/qiniu_file"
+require "qiniu"
+require "qiniu/http"
 
 ::CarrierWave.configure do |config|
   config.storage_engines[:qiniu] = "::CarrierWave::Storage::Qiniu".freeze

data/lib/carrierwave/qiniu/configuration.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
-
 module CarrierWave
   module Qiniu
     module Configuration
@@ -38,7 +37,8 @@ module CarrierWave
           configure do |config|
             config.qiniu_protocol = 'http'
             config.qiniu_bucket_private = false
-            config.qiniu_block_size = 1024*1024*4
+            config.qiniu_block_size = 1024 * 1024 * 4
+            config.qiniu_async_ops = []
             config.qiniu_persistent_ops = ''
             config.qiniu_persistent_notify_url = ''
             config.qiniu_persistent_pipeline = ''
@@ -46,10 +46,11 @@ module CarrierWave
             config.qiniu_private_url_expires_in = 3600
             config.qiniu_callback_url = ''
             config.qiniu_callback_body = ''
-            config.qiniu_persistent_notify_url = ''
             config.qiniu_style_separator = '-'
             config.qiniu_style_inline = false
             config.qiniu_delete_after_days = 0
+
+            # 使用 version 和 七牛的持久化参数需要文件从本地上传,而不能在云端缓存
             config.cache_storage = :file
           end
         end

data/lib/carrierwave/qiniu/connection.rb

@@ -0,0 +1,152 @@
+# encoding: utf-8
+
+
+module CarrierWave
+  module Qiniu
+    class Connection
+      StatusOK = 200
+      @@connection_established = false
+
+      def initialize(options = {})
+        @qiniu_bucket_domain = options[:qiniu_bucket_domain]
+        @qiniu_bucket = options[:qiniu_bucket]
+        @qiniu_bucket_private = options[:qiniu_bucket_private] || false
+        @qiniu_access_key = options[:qiniu_access_key]
+        @qiniu_secret_key = options[:qiniu_secret_key]
+        @qiniu_block_size = options[:qiniu_block_size] || 1024 * 1024 * 4
+        @qiniu_protocol = options[:qiniu_protocol] || "http"
+        @qiniu_persistent_ops = options[:qiniu_persistent_ops] || options[:qiniu_async_ops] || ""
+        @qiniu_persistent_pipeline = options[:qiniu_persistent_pipeline] || ""
+        @qiniu_persistent_notify_url = options[:qiniu_persistent_notify_url] || ""
+        @qiniu_can_overwrite = options[:qiniu_can_overwrite] || false
+        @qiniu_expires_in = options[:qiniu_expires_in] || options[:expires_in] || 3600
+        @qiniu_up_host = options[:qiniu_up_host]
+        @qiniu_private_url_expires_in = options[:qiniu_private_url_expires_in] || 3600
+        @qiniu_callback_url = options[:qiniu_callback_url] || ""
+        @qiniu_callback_body = options[:qiniu_callback_body] || ""
+        @qiniu_style_separator = options[:qiniu_style_separator] || "-"
+        @qiniu_delete_after_days = options[:qiniu_delete_after_days] || 0
+        init
+      end
+
+      def upload_file(file_path, key)
+        overwrite_file = nil
+        overwrite_file = key if @qiniu_can_overwrite
+
+        put_policy = ::Qiniu::Auth::PutPolicy.new(
+            @qiniu_bucket,
+            overwrite_file,
+            @qiniu_expires_in,
+            nil
+        )
+
+        put_policy.callback_url = @qiniu_callback_url if @qiniu_callback_url.present?
+        put_policy.callback_body = @qiniu_callback_body if @qiniu_callback_body.present?
+        put_policy.persistent_ops = @qiniu_persistent_ops
+        put_policy.persistent_notify_url = @qiniu_persistent_notify_url if @qiniu_persistent_notify_url.present?
+        put_policy.persistent_pipeline = @qiniu_persistent_pipeline
+
+        resp_code, resp_body, resp_headers =
+            ::Qiniu::Storage.upload_with_put_policy(put_policy, file_path, key, nil, bucket: @qiniu_bucket)
+
+        raise ::Qiniu::UploadFailedError.new(resp_code, resp_body) if resp_code != StatusOK
+
+        resp_body
+      end
+
+      #
+      # 复制
+      # @param origin [String]
+      # @param target [String]
+      # @return [Boolean]
+      #
+      def copy(origin, target)
+        success = ::Qiniu.copy(
+            @qiniu_bucket,
+            origin,
+            @qiniu_bucket,
+            target
+        )
+        success
+      end
+
+      #
+      # 移动
+      # @param origin [String]
+      # @param target [String]
+      # @return [Boolean]
+      #
+      def move(origin, target)
+        success = ::Qiniu.move(
+            @qiniu_bucket,
+            origin, # 源资源名
+            @qiniu_bucket,
+            target # 目标资源名
+        )
+        success
+      end
+
+      #
+      # 删除
+      # @param  key [String]
+      # @return [Boolean]
+      #
+      def delete(key)
+        success = ::Qiniu.delete(
+            @qiniu_bucket,
+            key
+        )
+        success
+      end
+
+      #
+      # 获取文件信息
+      # @param  key [String]
+      # @return [Hash]
+      #
+      def stat(key)
+        info = ::Qiniu.stat(
+            @qiniu_bucket, # 存储空间
+            key # 资源名
+        )
+        info
+      end
+
+      def get(path)
+        code, result, _ = ::Qiniu::HTTP.get(download_url(path))
+        code == 200 ? result : nil
+      end
+
+      def download_url(path)
+        encode_path = path_escape(path)
+        primitive_url = "#{@qiniu_protocol}://#{@qiniu_bucket_domain}/#{encode_path}"
+        @qiniu_bucket_private ? ::Qiniu::Auth.authorize_download_url(primitive_url, :expires_in => @qiniu_private_url_expires_in) : primitive_url
+      end
+
+      private
+
+      def init
+        establish_connection! unless @@connection_established
+        @@connection_established = true
+      end
+
+      UserAgent = "CarrierWave-Qiniu/#{Carrierwave::Qiniu::VERSION} (#{RUBY_PLATFORM}) Ruby/#{RUBY_VERSION}".freeze
+
+      def establish_connection!
+        options = {
+            :access_key => @qiniu_access_key,
+            :secret_key => @qiniu_secret_key,
+            :user_agent => UserAgent,
+        }
+        options[:block_size] = @qiniu_block_size if @qiniu_block_size
+        options[:up_host] = @qiniu_up_host if @qiniu_up_host
+        ::Qiniu.establish_connection! options
+      end
+
+      #fix chinese file name, same as encodeURIComponent in js but preserve slash '/'
+      def path_escape(value)
+        ::URI::DEFAULT_PARSER.escape value
+      end
+    end
+  end
+end

data/lib/carrierwave/qiniu/railtie.rb

@@ -1,6 +1,5 @@
 module CarrierWave
   module Qiniu
-
     class Railtie < Rails::Railtie
       rake_tasks do
         load 'carrierwave/tasks/qiniu.rake'

data/lib/carrierwave/qiniu/url.rb

@@ -25,17 +25,16 @@ module CarrierWave
           version = args.first.to_sym
           if styles.has_key? version
             options = args.last
-
             # Usage: avatar.url(:version, inline: true)
             url_options = if options.present? && options.is_a?(Hash) && options[:inline] && styles[version]
-                            { style: styles[version] }
+                            {style: styles[version]}
                           else
                             # global inline mode
                             if self.class.qiniu_style_inline && styles[version]
-                              { style: styles[version] }
+                              {style: styles[version]}
                             else
                               # Usage: avatar.url(:version)
-                              { version: version }
+                              {version: version}
                             end
                           end
             return file.url(url_options) if url_options

data/lib/{carrierwave-qiniu → carrierwave/qiniu}/version.rb

@@ -1,6 +1,5 @@
-# encoding: utf-8
 module Carrierwave
   module Qiniu
-    VERSION = "1.2.1"
+    VERSION = "1.2.2"
   end
 end

data/lib/carrierwave/storage/qiniu.rb

@@ -1,288 +1,25 @@
 # encoding: utf-8
-require "carrierwave"
-require "qiniu"
-require "qiniu/http"
-
 module CarrierWave
   module Storage
     class Qiniu < Abstract
-      class Connection
-        def initialize(options = {})
-          @qiniu_bucket_domain          = options[:qiniu_bucket_domain]
-          @qiniu_bucket                 = options[:qiniu_bucket]
-          @qiniu_bucket_private         = options[:qiniu_bucket_private] || false
-          @qiniu_access_key             = options[:qiniu_access_key]
-          @qiniu_secret_key             = options[:qiniu_secret_key]
-          @qiniu_block_size             = options[:qiniu_block_size] || 1024 * 1024 * 4
-          @qiniu_protocol               = options[:qiniu_protocol] || "http"
-          @qiniu_persistent_ops         = options[:qiniu_persistent_ops] || options[:qiniu_async_ops] || ""
-          @qiniu_persistent_pipeline    = options[:qiniu_persistent_pipeline] || ""
-          @qiniu_persistent_notify_url  = options[:qiniu_persistent_notify_url] || ""
-          @qiniu_can_overwrite          = options[:qiniu_can_overwrite] || false
-          @qiniu_expires_in             = options[:qiniu_expires_in] || options[:expires_in] || 3600
-          @qiniu_up_host                = options[:qiniu_up_host]
-          @qiniu_private_url_expires_in = options[:qiniu_private_url_expires_in] || 3600
-          @qiniu_callback_url           = options[:qiniu_callback_url] || ""
-          @qiniu_callback_body          = options[:qiniu_callback_body] || ""
-          @qiniu_style_separator        = options[:qiniu_style_separator] || "-"
-          @qiniu_delete_after_days      = options[:qiniu_delete_after_days] || 0
-          init
-        end
-
-        def store(file, key)
-          overwrite_file = nil
-          overwrite_file = key if @qiniu_can_overwrite
-
-          put_policy = ::Qiniu::Auth::PutPolicy.new(
-            @qiniu_bucket,
-            overwrite_file,
-            @qiniu_expires_in,
-            nil
-          )
-
-          put_policy.callback_url = @qiniu_callback_url if @qiniu_callback_url.present?
-          put_policy.callback_body = @qiniu_callback_body if @qiniu_callback_body.present?
-          put_policy.persistent_ops = @qiniu_persistent_ops || @qiniu_async_ops
-          put_policy.persistent_notify_url = @qiniu_persistent_notify_url if @qiniu_persistent_notify_url.present?
-          put_policy.persistent_pipeline = @persistent_pipeline
-
-          resp_code, resp_body, resp_headers =
-            ::Qiniu::Storage.upload_with_put_policy(
-              put_policy,
-              file.path,
-              key,
-              nil,
-              bucket: @qiniu_bucket,
-            )
-
-          if resp_code < 200 or resp_code >= 300
-            raise ::CarrierWave::UploadError, "Upload failed, status code: #{resp_code}, response: #{resp_body}"
-          end
-        end
-
-        #
-        # @note 复制
-        # @param origin [String]
-        # @param target [String]
-        # @return [Boolean]
-        #
-        def copy(origin, target)
-          resp_code, resp_body, _ = ::Qiniu::Storage.copy(@qiniu_bucket, origin, @qiniu_bucket, target)
-          if resp_code < 200 or resp_code >= 300
-            raise ::CarrierWave::IntegrityError, "Copy failed, status code: #{resp_code}, response: #{resp_body}"
-          end
-        end
-
-        def delete(key)
-          ::Qiniu::Storage.delete(@qiniu_bucket, key) rescue nil
-        end
-
-        def stat(key)
-          code, result, _ = ::Qiniu::Storage.stat(@qiniu_bucket, key)
-          code == 200 ? result : {}
-        end
-
-        def get(path)
-          code, result, _ = ::Qiniu::HTTP.get(download_url(path))
-          code == 200 ? result : nil
-        end
-
-        def download_url(path)
-          encode_path = path_escape(path)
-          primitive_url = "#{@qiniu_protocol}://#{@qiniu_bucket_domain}/#{encode_path}"
-          @qiniu_bucket_private ? ::Qiniu::Auth.authorize_download_url(primitive_url, :expires_in => @qiniu_private_url_expires_in) : primitive_url
-        end
-
-        def clean_cache!(seconds)
-          code, result, response_headers, s, d = Qiniu::Storage.list(Qiniu::Storage::ListPolicy.new(
-              @qiniu_bucket,# 存储空间
-              1000,# 列举的条目数
-              '', # 指定前缀
-              ''# 指定目录分隔符
-          )).items.each do |file|
-            # generate_cache_id returns key formated TIMEINT-PID(-COUNTER)-RND
-            time = file.key.scan(/(\d+)-\d+-\d+(?:-\d+)?/).first.map { |t| t.to_i }
-            time = Time.at(*time)
-            delete(file.key) if time < (Time.now.utc - seconds)
-          end
-        end
-
-        private
-
-        def init
-          init_qiniu_rs_connection
-        end
-
-        UserAgent = "CarrierWave-Qiniu/#{Carrierwave::Qiniu::VERSION} (#{RUBY_PLATFORM}) Ruby/#{RUBY_VERSION}".freeze
-
-        def init_qiniu_rs_connection
-          options = {
-            :access_key => @qiniu_access_key,
-            :secret_key => @qiniu_secret_key,
-            :user_agent => UserAgent,
-          }
-          options[:block_size] = @qiniu_block_size if @qiniu_block_size
-          options[:up_host] = @qiniu_up_host if @qiniu_up_host
-
-          ::Qiniu.establish_connection! options
-        end
-
-        #fix chinese file name, same as encodeURIComponent in js but preserve slash '/'
-        def path_escape(value)
-          ::URI::DEFAULT_PARSER.escape value
-        end
-      end
-
-      class File
-        def initialize(uploader, path)
-          @uploader, @path = uploader, path
-        end
-
-        def path
-          @path
-        end
-
-        ##
-        # Return qiniu URl, maybe with style
-        #
-        # === Parameters
-        # [options (Hash)] optional options hash, 图片样式 { version: :thumb } 或者 { style: "imageView2/1/w/200" }
-        #
-        # === Returns
-        #
-        # [String]
-        #
-        def url(options = {})
-          path = options.present? ? path_with_style(options) : @path
-          qiniu_connection.download_url(path)
-        end
-
-        def store(file)
-          qiniu_connection.store(file, @path)
-        end
-
-        def delete
-          qiniu_connection.delete(@path)
-        end
-
-        def exists?
-          return true if qiniu_connection.stat(path).present?
-          false
-        end
-
-        #
-        # @note 从指定路径复制图片
-        # @param origin_path [String] 原图片路径
-        # @return [Boolean]
-        #
-        def copy_from(origin_path)
-
-          # 先删除目标图片，避免出现0字节文件，无法复制
-          qiniu_connection.delete(@path)
-
-          qiniu_connection.copy(origin_path, @path)
-        end
-
-        ##
-        # Reads the contents of the file from Cloud Files
-        #
-        # === Returns
-        #
-        # [String] contents of the file
-        #
-        def read
-          qiniu_connection.get(@path) if self.size > 0
-        end
-
-        def content_type
-          file_info["mimeType"] || "application/octet-stream".freeze
-        end
-
-        def size
-          file_info["fsize"] || 0
-        end
-
-        def extension
-          path.split(".").last
-        end
-
-        def filename
-          ::File.basename(path)
-        end
-
-        def clean_cache!(seconds)
-          qiniu_connection.clean_cache!(seconds)
-        end
-
-        private
-
-        def qiniu_connection
-          @qiniu_connection ||= begin
-            config = {
-              :qiniu_access_key             => @uploader.qiniu_access_key,
-              :qiniu_secret_key             => @uploader.qiniu_secret_key,
-              :qiniu_bucket                 => @uploader.qiniu_bucket,
-              :qiniu_bucket_domain          => @uploader.qiniu_bucket_domain,
-              :qiniu_bucket_private         => @uploader.qiniu_bucket_private,
-              :qiniu_block_size             => @uploader.qiniu_block_size,
-              :qiniu_protocol               => @uploader.qiniu_protocol,
-              :qiniu_expires_in             => @uploader.qiniu_expires_in,
-              :qiniu_up_host                => @uploader.qiniu_up_host,
-              :qiniu_private_url_expires_in => @uploader.qiniu_private_url_expires_in,
-              :qiniu_callback_url           => @uploader.qiniu_callback_url,
-              :qiniu_callback_body          => @uploader.qiniu_callback_body,
-              :qiniu_persistent_notify_url  => @uploader.qiniu_persistent_notify_url,
-              :qiniu_persistent_pipeline    => @uploader.qiniu_persistent_pipeline,
-              :qiniu_style_separator        => @uploader.qiniu_style_separator,
-              :qiniu_delete_after_days      => @uploader.qiniu_delete_after_days,
-            }
-
-            config[:qiniu_persistent_ops]    = Array(@uploader.qiniu_persistent_ops || @uploader.qiniu_async_ops).join(";") rescue ""
-            config[:qiniu_can_overwrite]     = @uploader.try :qiniu_can_overwrite rescue false
-
-            Connection.new config
-          end
-        end
-
-        def file_info
-          @file_info ||= qiniu_connection.stat(@path)
-        end
-
-        def path_with_style(options)
-          return @path unless options
-
-          if version = options[:version]
-            "#{@path}#{@uploader.class.qiniu_style_separator}#{version}"
-          elsif style = options[:style]
-            "#{@path}?#{style}"
-          else
-            @path
-          end
-        end
-      end
-
       def store!(file)
-        f = ::CarrierWave::Storage::Qiniu::File.new(uploader, uploader.store_path(uploader.filename))
-        if file && file.respond_to?(:copy_from_path) and file.copy_from_path
-          f.copy_from file.copy_from_path
-        else
-          f.store(file)
+        QiniuFile.new(uploader, uploader.store_path).tap do |qiniu_file|
+          qiniu_file.store(file)
         end
-        f
       end
 
       def cache!(file)
-        f = ::CarrierWave::Storage::Qiniu::File.new(uploader, uploader.cache_path(uploader.filename))
-        f.store(file)
-        f
+        QiniuFile.new(uploader, uploader.cache_path).tap do |qiniu_file|
+          qiniu_file.store(file)
+        end
       end
 
       def retrieve!(identifier)
-        ::CarrierWave::Storage::Qiniu::File.new(uploader, uploader.store_path(identifier))
+        QiniuFile.new(uploader, uploader.store_path(identifier))
       end
 
       def retrieve_from_cache!(identifier)
-        ::CarrierWave::Storage::Qiniu::File.new(uploader, uploader.cache_path(identifier))
+        QiniuFile.new(uploader, uploader.cache_path(identifier))
       end
 
       ##
@@ -293,9 +30,9 @@ module CarrierWave
       end
 
       def clean_cache!(seconds)
-        ::CarrierWave::Storage::Qiniu::File.new(uploader, nil).clean_cache!(seconds)
+        # 如果缓存目录在云端,建议使用七牛云存储的生命周期设置, 以减少主动 API 调用次数
+        raise 'Use Qiniu Object Lifecycle Management to clean the cache'
       end
-
     end
   end
 end