carrierwave-aliyun 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d76d49aaf688f569f6ad24269872e9ff3a773590d63533c472e5fe570bc673ab
-  data.tar.gz: 4a6d40ae6c492edb56fd5804ee7b69ff89cddbc88143f95dc7b2aa5bd8a6a898
+  metadata.gz: 54c88d264e49631dd46a637080fc79b10cb73d487910a1608afd4ac67cf65561
+  data.tar.gz: 7362e2b9d48547d369994443b105af5f4d57f7a34b64a7c78b51b9ecf940aa8e
 SHA512:
-  metadata.gz: 478a675dbb9dd3eaea1049c6a33dd892c5ff1458c615c1dff4d0eb6c4eb6a61cb8227bb7fb8d327679fed4cc29c24890ee1fb59399e431b2d845d2afa9960170
-  data.tar.gz: 935fc2b025cb985d5133b198d7aa82e3baec7e7328bea7b33152b2dd90efc753df3c94a407fa102f9bb88465b41cd35e0b953728b49f0956ed24f8ab15ac1e0e
+  metadata.gz: 6589f76ad4cc466e3bd1acb690a0759786cb7ec2517fe2e51c2aeb0ad044053ff1b6d373bc04b51c75db6cb34551f0fe1a9d22c688bb66579a1d8f8303af37c7
+  data.tar.gz: '00487944ad9d21be007c4f1148ce676e376c621f9d1de6207347d1f621351fda81c48b2f8100801cb6cff18965923447ae1034a396406da93b012280bb34590e'

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## 1.2.0
+
+- 整理修复 OSS 文件访问 URL 的生成方式，去掉 img host，保持和最新 OSS API 一样的逻辑。
+- 生成 URL 的时候，不再强制替换为 https，保持 `aliyun_host` 的配置；
+
+## 1.1.2
+
+- 修正 aliyun-sdk 0.7.0 以上 Thumb URL 生成的支持；
+- Requirement aliyun-sdk >= 0.7.0;
+
+## 1.1.2
+
+- 修正废弃调用方式，避免在 Ruby 2.7 里面出现 warning.
+
+## 1.1.1
+
+- 对于 CarrierWave 的 cache 机制正确支持；
+
+## 1.1.0
+
+- 支持 CarrierWave 2.0;
+
 ## 1.0.0
 
 - 采用 Aliyun 官方的 SDK 来访问 OSS；

data/lib/carrierwave/aliyun/bucket.rb

@@ -3,12 +3,12 @@
 module CarrierWave
   module Aliyun
     class Bucket
-      PATH_PREFIX = %r{^/}
+      PATH_PREFIX = %r{^/}.freeze
       CHUNK_SIZE = 1024 * 1024
 
       attr_reader :access_key_id, :access_key_secret, :bucket, :region, :mode, :host
 
-      attr_reader :endpoint, :img_endpoint, :upload_endpoint
+      attr_reader :endpoint, :upload_endpoint, :get_endpoint
 
       def initialize(uploader)
         if uploader.aliyun_area.present?
@@ -16,7 +16,7 @@ module CarrierWave
           uploader.aliyun_region ||= uploader.aliyun_area
         end
 
-        if uploader.aliyun_private_read != nil
+        unless uploader.aliyun_private_read.nil?
           ActiveSupport::Deprecation.warn(%(config.aliyun_private_read will deprecation in carrierwave-aliyun 1.1.0, please use `aliyun_mode = :private` instead.))
           uploader.aliyun_mode ||= uploader.aliyun_private_read ? :private : :public
         end
@@ -38,15 +38,15 @@ module CarrierWave
         @mode              = (uploader.aliyun_mode || :public).to_sym
 
         # Host for get request
-        @host = uploader.aliyun_host || "https://#{self.bucket}.oss-#{self.region}.aliyuncs.com"
+        @endpoint = "https://#{bucket}.oss-#{region}.aliyuncs.com"
+        @host = uploader.aliyun_host || @endpoint
 
         unless @host.include?("//")
-          raise "config.aliyun_host requirement include // http:// or https://, but you give: #{self.host}"
+          raise "config.aliyun_host requirement include // http:// or https://, but you give: #{host}"
         end
 
-        @endpoint = "https://oss-#{self.region}.aliyuncs.com"
-        @upload_endpoint = uploader.aliyun_internal == true ? "https://oss-#{self.region}-internal.aliyuncs.com" : @endpoint
-        @img_endpoint = "https://img-#{self.region}.aliyuncs.com"
+        @get_endpoint = "https://oss-#{region}.aliyuncs.com"
+        @upload_endpoint = uploader.aliyun_internal == true ? "https://oss-#{region}-internal.aliyuncs.com" : "https://oss-#{region}.aliyuncs.com"
       end
 
       # 上传文件
@@ -70,11 +70,18 @@ module CarrierWave
             stream << file.read(CHUNK_SIZE) until file.eof?
           end
           path_to_url(path)
-        rescue => e
+        rescue StandardError => e
           raise "Put file failed: #{e}"
         end
       end
 
+      def copy_object(source, dest)
+        source = source.sub(PATH_PREFIX, "")
+        dest = dest.sub(PATH_PREFIX, "")
+
+        oss_upload_client.copy_object(source, dest)
+      end
+
       # 读取文件
       # params:
       # - path - remote 存储路径
@@ -88,7 +95,7 @@ module CarrierWave
         end
 
         [obj, chunk_buff.join("")]
-      rescue => e
+      rescue StandardError => e
         raise "Get content faild: #{e}"
       end
 
@@ -103,62 +110,60 @@ module CarrierWave
         path = path.sub(PATH_PREFIX, "")
         oss_upload_client.delete_object(path)
         path_to_url(path)
-      rescue => e
+      rescue StandardError => e
         raise "Delete failed: #{e}"
       end
 
       ##
       # 根据配置返回完整的上传文件的访问地址
       def path_to_url(path, thumb: nil)
-        path = path.sub(PATH_PREFIX, "")
-
-        if thumb
-          [self.host, [path, thumb].join("")].join("/")
-        else
-          [self.host, path].join("/")
-        end
+        get_url(path, thumb: thumb)
       end
 
       # 私有空间访问地址，会带上实时算出的 token 信息
       # 有效期 15 minutes
       def private_get_url(path, thumb: nil)
+        get_url(path, private: true, thumb: thumb)
+      end
+
+      def get_url(path, private: false, thumb: nil)
         path = path.sub(PATH_PREFIX, "")
 
-        url = if thumb
-                img_client.object_url([path, thumb].join(""), expiry: 15.minutes)
+        url = if thumb&.start_with?("?")
+                # foo.jpg?x-oss-process=image/resize,h_100
+                parameters = { "x-oss-process" => thumb.split("=").last }
+                oss_client.object_url(path, private, 15.minutes, parameters)
               else
-                oss_client.object_url(path, expiry: 15.minutes)
+                oss_client.object_url(path, private, 15.minutes)
               end
 
-        url.sub("http://", "https://")
+        unless private
+          url = [url, thumb].join("") unless thumb&.start_with?("?")
+        end
+
+        url.sub(endpoint, host)
       end
 
       def head(path)
-        oss_client.get_object_meta(path)
+        path = path.sub(PATH_PREFIX, "")
+        oss_upload_client.get_object(path)
       end
 
       private
 
-        def oss_client
-          return @oss_client if defined?(@oss_client)
-          client = ::Aliyun::OSS::Client.new(endpoint: self.endpoint,
-            access_key_id: self.access_key_id, access_key_secret: self.access_key_secret)
-          @oss_client = client.get_bucket(self.bucket)
-        end
+      def oss_client
+        return @oss_client if defined?(@oss_client)
 
-        def img_client
-          return @img_client if defined?(@img_client)
-          client = ::Aliyun::OSS::Client.new(endpoint: self.img_endpoint,
-            access_key_id: self.access_key_id, access_key_secret: self.access_key_secret)
-          @img_client = client.get_bucket(self.bucket)
-        end
+        client = ::Aliyun::OSS::Client.new(endpoint: get_endpoint, access_key_id: access_key_id, access_key_secret: access_key_secret)
+        @oss_client = client.get_bucket(bucket)
+      end
 
-        def oss_upload_client
-          return @oss_upload_client if defined?(@oss_upload_client)
-          client = ::Aliyun::OSS::Client.new(endpoint: self.upload_endpoint,
-            access_key_id: self.access_key_id, access_key_secret: self.access_key_secret)
-          @oss_upload_client = client.get_bucket(self.bucket)
-        end
+      def oss_upload_client
+        return @oss_upload_client if defined?(@oss_upload_client)
+
+        client = ::Aliyun::OSS::Client.new(endpoint: upload_endpoint, access_key_id: access_key_id, access_key_secret: access_key_secret)
+        @oss_upload_client = client.get_bucket(bucket)
+      end
     end
   end
 end

data/lib/carrierwave/aliyun/version.rb

@@ -2,6 +2,6 @@
 
 module CarrierWave
   module Aliyun
-    VERSION = "1.0.0"
+    VERSION = "1.2.0"
   end
 end

data/lib/carrierwave/storage/aliyun.rb

@@ -3,20 +3,56 @@
 module CarrierWave
   module Storage
     class Aliyun < Abstract
-      def store!(file)
+      def store!(new_file)
         f = AliyunFile.new(uploader, self, uploader.store_path)
         headers = {
-          content_type: file.content_type,
+          content_type: new_file.content_type,
           content_disposition: uploader.try(:content_disposition)
         }
 
-        f.store(::File.open(file.file), headers)
+        f.store(new_file, headers)
         f
       end
 
       def retrieve!(identifier)
         AliyunFile.new(uploader, self, uploader.store_path(identifier))
       end
+
+      def cache!(new_file)
+        f = AliyunFile.new(uploader, self, uploader.cache_path)
+        headers = {
+          content_type: new_file.content_type,
+          content_disposition: uploader.try(:content_disposition)
+        }
+
+        f.store(new_file, headers)
+        f
+      end
+
+      def retrieve_from_cache!(identifier)
+        AliyunFile.new(uploader, self, uploader.cache_path(identifier))
+      end
+
+      def delete_dir!(path)
+        # do nothing, because there's no such things as 'empty directory'
+      end
+
+      def clean_cache!(_seconds)
+        will_remove_keys = []
+        bucket.list_objects(prefix: uploader.cache_path).each do |file|
+          next unless file.is_a?(Object)
+          time = file.key.scan(/(\d+)-\d+-\d+(?:-\d+)?/).first.map { |t| t.to_i }
+          time = Time.at(*time)
+          will_remove_keys << item.key if time < (Time.now.utc - seconds)
+        end
+        bucket.batch_delete_objects(will_remove_keys)
+      end
+
+      private
+
+        def bucket
+          @bucket ||= CarrierWave::Aliyun::Bucket.new(uploader)
+        end
     end
   end
 end

data/lib/carrierwave/storage/aliyun_file.rb

@@ -2,23 +2,28 @@
 
 module CarrierWave
   module Storage
-    class AliyunFile < CarrierWave::SanitizedFile
-      attr_reader :path
+    class AliyunFile
+      attr_reader :uploader, :path
+
+      alias_method :filename, :path
+      alias_method :identifier, :filename
 
       def initialize(uploader, base, path)
-        @uploader = uploader
-        @path     = URI.encode(path)
-        @base     = base
+        @uploader, @path, @base = uploader, escape(path), base
+      end
+
+      def escape(path)
+        CGI.escape(path).gsub("%2F", "/")
       end
 
       def read
-        object, body = bucket.get(@path)
+        object, body = bucket.get(path)
         @headers = object.headers
         body
       end
 
       def delete
-        bucket.delete(@path)
+        bucket.delete(path)
         true
       rescue => e
         # If the file's not there, don't panic
@@ -33,9 +38,9 @@ module CarrierWave
       #
       def url(opts = {})
         if bucket.mode == :private
-          bucket.private_get_url(@path, opts)
+          bucket.private_get_url(path, **opts)
         else
-          bucket.path_to_url(@path, opts)
+          bucket.path_to_url(path, **opts)
         end
       end
 
@@ -47,20 +52,51 @@ module CarrierWave
         headers[:content_type] = new_content_type
       end
 
-      def store(file, headers = {})
-        bucket.put(@path, file, headers)
+      def store(new_file, headers = {})
+        if new_file.is_a?(self.class)
+          new_file.copy_to(path)
+        else
+          fog_file = new_file.to_file
+          bucket.put(path, fog_file, **headers)
+          fog_file.close if fog_file && !fog_file.closed?
+        end
+        true
       end
 
       def headers
-        @headers ||= {}
+        @headers ||= begin
+          obj = bucket.head(path)
+          obj.headers
+        end
+      end
+
+      def exists?
+        !!headers
+      end
+
+      def copy_to(new_path)
+        bucket.copy_object(path, new_path)
+        self.class.new(uploader, @base, new_path)
+      end
+
+      def extension
+        path_elements = path.split(".")
+        path_elements.last if path_elements.size > 1
+      end
+
+      def original_filename
+        return @original_filename if @original_filename
+        if @file && @file.respond_to?(:original_filename)
+          @file.original_filename
+        elsif path
+          ::File.basename(path)
+        end
       end
 
       private
 
         def bucket
-          return @bucket if defined? @bucket
-
-          @bucket = CarrierWave::Aliyun::Bucket.new(@uploader)
+          @bucket ||= CarrierWave::Aliyun::Bucket.new(uploader)
         end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave-aliyun
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-23 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carrierwave
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.7
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.7
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: aliyun-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
 description: Aliyun OSS support for Carrierwave
 email:
 - huacnlee@gmail.com
@@ -72,8 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Aliyun OSS support for Carrierwave