activestorage-aliyun 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49de212acae6a9c8e99b3ca01602eca84414955eafc1f965b6e1a35fcdbc3241
-  data.tar.gz: 8923a8b87a36f28d34ccac03369a13d1cb18c9db9da94843437c1ef8d281cb46
+  metadata.gz: 8e1d0cce28e49848d648e656a281dd9a0848b2e3f601fcce2813977501e9f321
+  data.tar.gz: ce8902fe4003bc87ebe1ae6a7f7f1b55af136a05fbabc44856eaaf0e9116d0c8
 SHA512:
-  metadata.gz: cf61f0de45f6c8e7ea1e8b495beeab96ef523cb3984075b1b4727adb6dfc3fd8f3b97e8712825640482f8f34f2dc3b5142a9d384bba4d4fec7940f10bf623c98
-  data.tar.gz: c35ecb00a20b765844b241fd8eda14a9eafab64de1894ba7ec5d4a885b1a188cb985590c5b7460ebe8794dca7ecd4b9df802fa0616f401d4afa3133b51bcad62
+  metadata.gz: 1d55c0ac4bfbe3dcf9ad29a37990cc843e3d3352a3b978c8ec2ca702e30d2207be7d3edad2e6f2b44f56c87bf330a79a00f5eb0a40b291fe24fa940d2d976b61
+  data.tar.gz: 11e6a67d777d4c07f2cd9edcfef2886d47ccc6f5561cebc43e9df95722bee051a7e19ee8986dec9ae05d3010756a06964be9a0aa7d40908c7ff518823f741c67

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+https://github.com/huacnlee/activestorage-aliyun/releases
+
+## 1.1.0
+
+- Add custo_metadata args in service method for Rails 7 supports.
+
 ## 1.0.0
 
 - Update for support Rals 6.1 permanent URL, and compatiable with Rails 6.0.

data/README.md

@@ -2,16 +2,14 @@
 
 Wraps the Aliyun OSS as an Active Storage service, use [Aliyun official Ruby SDK](https://github.com/aliyun/aliyun-oss-ruby-sdk) for upload.
 
-
-[![Gem Version](https://badge.fury.io/rb/activestorage-aliyun.svg)](https://badge.fury.io/rb/activestorage-aliyun) [![Build Status](https://travis-ci.org/huacnlee/activestorage-aliyun.svg)](https://travis-ci.org/huacnlee/activestorage-aliyun) [![Code Climate](https://codeclimate.com/github/huacnlee/activestorage-aliyun/badges/gpa.svg)](https://codeclimate.com/github/huacnlee/activestorage-aliyun) [![codecov.io](https://codecov.io/github/huacnlee/activestorage-aliyun/coverage.svg?branch=master)](https://codecov.io/github/huacnlee/activestorage-aliyun?branch=master)
-
+[![Gem Version](https://badge.fury.io/rb/activestorage-aliyun.svg)](https://badge.fury.io/rb/activestorage-aliyun) [![build](https://github.com/huacnlee/activestorage-aliyun/workflows/build/badge.svg)](https://github.com/huacnlee/activestorage-aliyun/actions?query=workflow%3Abuild)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'activestorage-aliyun'
+gem "activestorage-aliyun"
 ```
 
 And then execute:
@@ -22,17 +20,20 @@ $ bundle
 
 ## Usage
 
+> NOTE! Current document work for Rails 6.1, if you are using Rails 6.0, please visit: https://github.com/huacnlee/activestorage-aliyun/tree/v0.6.4
+> You can also to use activestorage-aliyun 1.0.0 in Rails 6.0
+
 config/storage.yml
 
 ```yml
 aliyun:
   service: Aliyun
-  access_key_id: "your-oss-access-key-id"
-  access_key_secret: "your-oss-access-key-secret"
-  bucket: "bucket-name"
-  endpoint: "https://oss-cn-beijing.aliyuncs.com"
+  access_key_id: 'your-oss-access-key-id'
+  access_key_secret: 'your-oss-access-key-secret'
+  bucket: 'bucket-name'
+  endpoint: 'https://oss-cn-beijing.aliyuncs.com'
   # path prefix, default: /
-  path: "my-app-files"
+  path: 'my-app-files'
   # Bucket public: true/false, default: true, for generate public/private URL.
   public: true
 ```
@@ -42,13 +43,13 @@ aliyun:
 ```yml
 aliyun:
   service: Aliyun
-  access_key_id: "your-oss-access-key-id"
-  access_key_secret: "your-oss-access-key-secret"
-  bucket: "bucket-name"
-  endpoint: "https://file.myhost.com"
+  access_key_id: 'your-oss-access-key-id'
+  access_key_secret: 'your-oss-access-key-secret'
+  bucket: 'bucket-name'
+  endpoint: 'https://oss-cn-beijing.aliyuncs.com'
   public: false
-  # Enable cname to use custom domain
-  cname: true
+  # Custom host for get file url, if this present, upload still use `endpoint`, but download url will use this.
+  host: 'https://file.myhost.com'
 ```
 
 ### Use for image url
@@ -56,7 +57,7 @@ aliyun:
 ```erb
 Original File URL:
 
-<%= image_tag @photo.image.service_url %>
+<%= image_tag @photo.image.url %>
 ```
 
 Thumb with OSS image service:
@@ -64,7 +65,7 @@ Thumb with OSS image service:
 ```rb
 class Photo < ApplicationRecord
   def image_thumb_url(process)
-    self.image.service_url(params: { "x-oss-process" => process })
+    self.image.url(params: { "x-oss-process" => process })
   end
 end
 ```
@@ -72,7 +73,7 @@ end
 And then:
 
 ```erb
-<%= image_tag @photo.image.image_thumb_url("image/resize,h_100,w_100") %>
+<%= image_tag @photo.image_thumb_url("image/resize,h_100,w_100") %>
 ```
 
 ### Use for file download
@@ -81,7 +82,7 @@ If you want to get original filename (Include Chinese and other UTF-8 chars), fo
 
 ```erb
 #
-<%= image_tag @photo.image.service_url(disposition: :attachment) %>
+<%= image_tag @photo.image.url(disposition: :attachment) %>
 ```
 
 ## Contributing

data/lib/active_storage/service/aliyun_service.rb

@@ -19,17 +19,17 @@ module ActiveStorage
 
     CHUNK_SIZE = 1024 * 1024
 
-    def upload(key, io, checksum: nil, content_type: nil, disposition: nil, filename: nil)
+    def upload(key, io, checksum: nil, content_type: nil, disposition: nil, filename: nil, custom_metadata: {}, **)
       instrument :upload, key: key, checksum: checksum do
         content_type ||= Marcel::MimeType.for(io)
-        bucket.put_object(path_for(key), content_type: content_type) do |stream|
+        bucket.put_object(path_for(key), content_type: content_type, metas: custom_metadata) do |stream|
           stream << io.read(CHUNK_SIZE) until io.eof?
         end
       end
     end
 
     def download(key, &block)
-      if block_given?
+      if block
         instrument :streaming_download, key: key do
           bucket.get_object(path_for(key), &block)
         end
@@ -39,7 +39,7 @@ module ActiveStorage
           bucket.get_object(path_for(key)) do |chunk|
             chunk_buff << chunk
           end
-          chunk_buff.join("")
+          chunk_buff.join
         end
       end
     end
@@ -51,7 +51,7 @@ module ActiveStorage
         bucket.get_object(path_for(key), range: [range.begin, range_end]) do |chunk|
           chunk_buff << chunk
         end
-        chunk_buff.join("")
+        chunk_buff.join
       end
     end
 
@@ -65,14 +65,16 @@ module ActiveStorage
       instrument :delete_prefixed, prefix: prefix do
         files = bucket.list_objects(prefix: path_for(prefix))
         return if files.blank?
+
         keys = files.map(&:key)
         return if keys.blank?
+
         bucket.batch_delete_objects(keys, quiet: true)
       end
     end
 
     def exist?(key)
-      instrument :exist, key: key do |payload|
+      instrument :exist, key: key do |_payload|
         bucket.object_exists?(path_for(key))
       end
     end
@@ -83,7 +85,7 @@ module ActiveStorage
     # Source: *.your.host.com
     # Allowed Methods: POST, PUT, HEAD
     # Allowed Headers: *
-    def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
+    def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:, custom_metadata: {})
       instrument :url, key: key do |payload|
         generated_url = bucket.object_url(path_for(key), false)
         payload[:url] = generated_url
@@ -94,16 +96,21 @@ module ActiveStorage
     # Headers for Direct Upload
     # https://help.aliyun.com/document_detail/31951.html
     # headers["Date"] is required use x-oss-date instead
-    def headers_for_direct_upload(key, content_type:, checksum:, **)
+    def headers_for_direct_upload(key, content_type:, checksum:, custom_metadata: {}, **)
       date = Time.now.httpdate
       {
         "Content-Type" => content_type,
         "Content-MD5" => checksum,
         "Authorization" => authorization(key, content_type, checksum, date),
         "x-oss-date" => date,
+        **custom_metadata_headers(custom_metadata)
       }
     end
 
+    def custom_metadata_headers(metadata)
+      metadata.transform_keys { |key| "x-oss-meta-#{key}" }
+    end
+
     # Remove this in Rails 6.1, compatiable with Rails 6.0.0
     def url(key, **options)
       instrument :url, key: key do |payload|
@@ -121,91 +128,113 @@ module ActiveStorage
     end
 
     private
-      attr_reader :config
 
-      def private_url(key, expires_in: 60, filename: nil, content_type: nil, disposition: nil, params: {}, **)
-        filekey = path_for(key)
+    attr_reader :config
 
-        params["response-content-type"] = content_type unless content_type.blank?
+    def private_url(key, expires_in: 60, filename: nil, content_type: nil, disposition: nil, params: {}, **)
+      filekey = path_for(key)
 
-        if filename
-          filename = ActiveStorage::Filename.wrap(filename)
-          params["response-content-disposition"] = content_disposition_with(type: disposition, filename: filename)
-        end
+      params["response-content-type"] = content_type unless content_type.blank?
 
-        object_url(filekey, sign: true, expires_in: expires_in, params: params)
+      if filename
+        filename = ActiveStorage::Filename.wrap(filename)
+        params["response-content-disposition"] = content_disposition_with(type: disposition, filename: filename)
       end
 
-      def public_url(key, params: {}, **)
-        object_url(path_for(key), sign: false, params: params)
-      end
+      object_url(filekey, sign: true, expires_in: expires_in, params: params)
+    end
+
+    def public_url(key, params: {}, **)
+      object_url(path_for(key), sign: false, params: params)
+    end
 
-      # Remove this in Rails 6.1, compatiable with Rails 6.0.0
-      def public?
-        @public == true
+    # Remove this in Rails 6.1, compatiable with Rails 6.0.0
+    def public?
+      @public == true
+    end
+
+    def path_for(key)
+      root_path = config.fetch(:path, nil)
+      full_path = if root_path.blank? || root_path == "/"
+        key
+      else
+        File.join(root_path, key)
       end
 
-      def path_for(key)
-        root_path = config.fetch(:path, nil)
-        if root_path.blank? || root_path == "/"
-          full_path = key
-        else
-          full_path = File.join(root_path, key)
-        end
+      full_path.gsub(%r{^/}, "").squeeze("/")
+    end
+
+    def object_url(key, sign: false, expires_in: 60, params: {})
+      url = host_bucket.object_url(key, false)
+      unless sign
+        return url if params.blank?
 
-        full_path.gsub(/^\//, "").gsub(/[\/]+/, "/")
+        return "#{url}?#{params.to_query}"
       end
 
-      def object_url(key, sign: false, expires_in: 60, params: {})
-        url = bucket.object_url(key, false)
-        unless sign
-          return url if params.blank?
-          return url + "?" + params.to_query
-        end
+      resource = "/#{host_bucket.name}/#{key}"
+      expires = Time.now.to_i + expires_in
+      query = {
+        "Expires" => expires,
+        "OSSAccessKeyId" => config.fetch(:access_key_id)
+      }
+      query.merge!(params)
 
-        resource = "/#{bucket.name}/#{key}"
-        expires  = Time.now.to_i + expires_in
-        query    = {
-          "Expires" => expires,
-          "OSSAccessKeyId" => config.fetch(:access_key_id)
-        }
-        query.merge!(params)
+      resource += "?" + params.map { |k, v| "#{k}=#{v}" }.sort.join("&") if params.present?
 
-        if params.present?
-          resource += "?" + params.map { |k, v| "#{k}=#{v}" }.sort.join("&")
-        end
+      string_to_sign = ["GET", "", "", expires, resource].join("\n")
+      query["Signature"] = host_bucket.sign(string_to_sign)
 
-        string_to_sign = ["GET", "", "", expires, resource].join("\n")
-        query["Signature"] = bucket.sign(string_to_sign)
+      [url, query.to_query].join("?")
+    end
 
-        [url, query.to_query].join("?")
-      end
+    def bucket
+      return @bucket if defined? @bucket
 
-      def bucket
-        return @bucket if defined? @bucket
-        @bucket = client.get_bucket(config.fetch(:bucket))
-        @bucket
-      end
+      @bucket = client.get_bucket(config.fetch(:bucket))
+      @bucket
+    end
 
-      def authorization(key, content_type, checksum, date)
-        filename = File.expand_path("/#{bucket.name}/#{path_for(key)}")
-        addition_headers = "x-oss-date:#{date}"
-        sign = ["PUT", checksum, content_type, date, addition_headers, filename].join("\n")
-        signature = bucket.sign(sign)
-        "OSS " + config.fetch(:access_key_id) + ":" + signature
-      end
+    def host_bucket
+      return @host_bucket if defined? @host_bucket
 
-      def endpoint
-        config.fetch(:endpoint, "https://oss-cn-hangzhou.aliyuncs.com")
-      end
+      host_bucket_client = host ? host_client : client
+      @host_bucket = host_bucket_client.get_bucket(config.fetch(:bucket))
+      @host_bucket
+    end
 
-      def client
-        @client ||= Aliyun::OSS::Client.new(
-          endpoint: endpoint,
-          access_key_id: config.fetch(:access_key_id),
-          access_key_secret: config.fetch(:access_key_secret),
-          cname: config.fetch(:cname, false)
-        )
-      end
+    def authorization(key, content_type, checksum, date)
+      filename = File.expand_path("/#{bucket.name}/#{path_for(key)}")
+      addition_headers = "x-oss-date:#{date}"
+      sign = ["PUT", checksum, content_type, date, addition_headers, filename].join("\n")
+      signature = bucket.sign(sign)
+      "OSS #{config.fetch(:access_key_id)}:#{signature}"
+    end
+
+    def endpoint
+      config.fetch(:endpoint, "https://oss-cn-hangzhou.aliyuncs.com")
+    end
+
+    def host
+      config.fetch(:host, nil)
+    end
+
+    def client
+      @client ||= Aliyun::OSS::Client.new(
+        endpoint: endpoint,
+        access_key_id: config.fetch(:access_key_id),
+        access_key_secret: config.fetch(:access_key_secret),
+        cname: config.fetch(:cname, false)
+      )
+    end
+
+    def host_client
+      @host_client ||= Aliyun::OSS::Client.new(
+        endpoint: host,
+        access_key_id: config.fetch(:access_key_id),
+        access_key_secret: config.fetch(:access_key_secret),
+        cname: config.fetch(:cname, false)
+      )
+    end
   end
 end

data/lib/active_storage_aliyun/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveStorageAliyun
   class Railtie < ::Rails::Railtie
   end

data/lib/active_storage_aliyun/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveStorageAliyun
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

data/lib/activestorage-aliyun.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # require "active_storage_aliyun/railtie"
 
 module ActiveStorageAliyun

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: activestorage-aliyun
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jason Lee
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-01 00:00:00.000000000 Z
+date: 2023-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: aliyun-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: aliyun-sdk
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 6.0.0
 description: Wraps the Aliyun OSS as an Active Storage service.
 email: huacnlee@gmail.com
 executables: []
@@ -54,7 +54,7 @@ homepage: https://github.com/huacnlee/activestorage-aliyun
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -62,15 +62,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Wraps the Aliyun OSS as an Active Storage service
 test_files: []