carrierwave-aliyun 1.1.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83e7828d8abba5ebf25ae01f845bf0695e596c432b9b867a42034454f5862058
-  data.tar.gz: 106b6e3372acfe88f89cf0c00346ba5d8ec33f97deb10077d07ee943d7b514ee
+  metadata.gz: fd2862b19f1414efc11faf608fba6ecc0ac6a8048dd86d96cdf3ffa4b7ad3c7f
+  data.tar.gz: 031b8b1ad35539a5605abae8cebbb17b0b393d68cb4442d00ca1a3b2a97491c3
 SHA512:
-  metadata.gz: ed4defc5158003da256b08bf9c13d798abab8f684fa8ccec4363438840f2ba12ab603115103396634764a127acece35779ba18e6704525ce24f6a98bf81bc33d
-  data.tar.gz: d23cb3be191b8feb7e9906589bdbe3833a204402e7961fc9f14f672de3e52cf1273a1cff05fae5136339aff2ec1a40946354acce402cb1f828d803628e5b4b4a
+  metadata.gz: 6d115a0e6cc1a3262a40a9f5a0a525249fef749e690d5ab7d8aeace8cb9a084881b20d6b0541833ac4c0dc0c47868b0e3805432cd31ff04044763f2b2f084160
+  data.tar.gz: d5c5f5ebb6567b441a73412b8670d73f6e0e9a67f867caeabdeea430d14e990e3f3ef7c5644ead6ae892c45feb891f62ed24e5766868381d056444ee6ab2f055

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+## 1.2.3
+
+- 将 Aliyun::OSS 原本的异常原样抛出；
+- 验证对 [传输加速](https://help.aliyun.com/document_detail/131312.html) 的能力，并增加文档说明（实际上之前的版本就支持）。
+
+## 1.2.2
+
+- 修正 #79 某些场景中文文件名无法正确上传的问题；
+- 修正 #70 上传文件以后 tmp 目录依然还残留着 cache 文件的问题；
+
+## 1.2.1
+
+- 实现 `size` 方法，修正更新图片数组时，新上传的图片会取代旧图片的问题。(#73)
+
+## 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.

data/README.md

@@ -2,7 +2,7 @@
 
 This gem adds support for [Aliyun OSS](http://oss.aliyun.com) to [CarrierWave](https://github.com/jnicklas/carrierwave/)
 
-[![Gem Version](https://badge.fury.io/rb/carrierwave-aliyun.svg)](https://rubygems.org/gems/carrierwave-aliyun) [![Build Status](https://travis-ci.org/huacnlee/carrierwave-aliyun.svg?branch=master)](https://travis-ci.org/huacnlee/carrierwave-aliyun) [![Code Climate](https://codeclimate.com/github/huacnlee/carrierwave-aliyun/badges/gpa.svg)](https://codeclimate.com/github/huacnlee/carrierwave-aliyun)
+[![Gem Version](https://badge.fury.io/rb/carrierwave-aliyun.svg)](https://rubygems.org/gems/carrierwave-aliyun) [![build](https://github.com/huacnlee/carrierwave-aliyun/workflows/build/badge.svg)](https://github.com/huacnlee/carrierwave-aliyun/actions?query=workflow%3Abuild)
 
 > NOTE: 此 Gem 是一个 CarrierWave 的组件，你需要配合 CarrierWave 一起使用，如果你需要直接用 Aliyun OSS，可以尝试用 [aliyun-sdk](https://github.com/aliyun/aliyun-oss-ruby-sdk) 这个 Gem。
 
@@ -80,3 +80,20 @@ class AttachmentUploader < CarrierWave::Uploader::Base
   end
 end
 ```
+
+## 启用全球传输加速
+
+阿里云允许我们通过 `oss-accelerate.aliyuncs.com` 的节点来实现全球的传输加速，如果你的需要在境外的服务器传输到国内，或许需要开启这个功能。
+
+你只需要将 CarrierWave Aliyun 的 `aliyun_region` 配置为 `accelerate` 即可。
+
+```rb
+config.aliyun_region = "accelerate"
+```
+
+### 异常解析
+
+> 错误：OSS Transfer Acceleration is not configured on this bucket.
+> 确保有开启 [传输加速](https://help.aliyun.com/document_detail/131312.html)，进入 Bucket / 传输管理 / 传输加速 / 开启传输加速。
+
+额外注意：Aliyun OSS 开启传输加速后需要 **30 分钟内全网生效**

data/lib/carrierwave/aliyun/bucket.rb

@@ -3,12 +3,11 @@
 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 :access_key_id, :access_key_secret, :bucket, :region, :mode, :host, :endpoint, :upload_endpoint,
+                  :get_endpoint
 
       def initialize(uploader)
         if uploader.aliyun_area.present?
@@ -16,7 +15,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 +37,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
 
       # 上传文件
@@ -65,14 +64,10 @@ module CarrierWave
         headers["Content-Type"] = content_type
         headers["Content-Disposition"] = content_disposition if content_disposition
 
-        begin
-          oss_upload_client.put_object(path, headers: headers) do |stream|
-            stream << file.read(CHUNK_SIZE) until file.eof?
-          end
-          path_to_url(path)
-        rescue => e
-          raise "Put file failed: #{e}"
+        oss_upload_client.put_object(path, headers: headers) do |stream|
+          stream << file.read(CHUNK_SIZE) until file.eof?
         end
+        path_to_url(path)
       end
 
       def copy_object(source, dest)
@@ -95,8 +90,6 @@ module CarrierWave
         end
 
         [obj, chunk_buff.join("")]
-      rescue => e
-        raise "Get content faild: #{e}"
       end
 
       # 删除 Remote 的文件
@@ -110,34 +103,34 @@ module CarrierWave
         path = path.sub(PATH_PREFIX, "")
         oss_upload_client.delete_object(path)
         path_to_url(path)
-      rescue => 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://")
+        url = [url, thumb].join("") if !private && !thumb&.start_with?("?")
+
+        url.sub(endpoint, host)
       end
 
       def head(path)
@@ -145,28 +138,28 @@ module CarrierWave
         oss_upload_client.get_object(path)
       end
 
+      # list_objects for test
+      def list_objects(opts = {})
+        oss_client.list_objects(opts)
+      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.1.2"
+    VERSION = "1.2.3"
   end
 end

data/lib/carrierwave/storage/aliyun.rb

@@ -37,22 +37,11 @@ module CarrierWave
         # 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
+      def bucket
+        @bucket ||= CarrierWave::Aliyun::Bucket.new(uploader)
+      end
     end
   end
 end

data/lib/carrierwave/storage/aliyun_file.rb

@@ -3,17 +3,26 @@
 module CarrierWave
   module Storage
     class AliyunFile
+      attr_writer :file
       attr_reader :uploader, :path
 
-      alias_method :filename, :path
-      alias_method :identifier, :filename
+      alias filename path
+      alias identifier filename
 
       def initialize(uploader, base, path)
-        @uploader, @path, @base = uploader, escape(path), base
+        @uploader = uploader
+        @path = path
+        @base = base
       end
 
-      def escape(path)
-        CGI.escape(path).gsub("%2F", "/")
+      def file
+        @file ||= bucket.get(path).try(:first)
+      end
+
+      def size
+        file.headers[:content_length].to_i
+      rescue StandardError
+        nil
       end
 
       def read
@@ -25,7 +34,7 @@ module CarrierWave
       def delete
         bucket.delete(path)
         true
-      rescue => e
+      rescue StandardError => e
         # If the file's not there, don't panic
         puts "carrierwave-aliyun delete file failed: #{e}"
         nil
@@ -86,7 +95,8 @@ module CarrierWave
 
       def original_filename
         return @original_filename if @original_filename
-        if @file && @file.respond_to?(:original_filename)
+
+        if @file&.respond_to?(:original_filename)
           @file.original_filename
         elsif path
           ::File.basename(path)
@@ -95,9 +105,9 @@ module CarrierWave
 
       private
 
-        def bucket
-          @bucket ||= CarrierWave::Aliyun::Bucket.new(uploader)
-        end
+      def bucket
+        @bucket ||= CarrierWave::Aliyun::Bucket.new(uploader)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave-aliyun
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Jason Lee
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-27 00:00:00.000000000 Z
+date: 2021-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carrierwave
@@ -30,14 +30,14 @@ dependencies:
     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
@@ -57,7 +57,7 @@ homepage: https://github.com/huacnlee/carrierwave-aliyun
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -72,8 +72,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Aliyun OSS support for Carrierwave
 test_files: []