kt-paperclip-aliyun 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c378e96208b951136a4aa554ea68e7e17c0763bdb9ce60f085047cf2bead67d5
+  data.tar.gz: 026302ed6206ca9f4c2b380ec5512bfc6fedb0e493a38e9057f8fcea54b624ba
+SHA512:
+  metadata.gz: dff31b7e8579232688b134c1dd5445b112130eba06d551f1f85447d19e170d6505ffb2fa77c11357f0653922b333cce689304d17b8861c43165ff7e2acea18e0
+  data.tar.gz: 5e45e9e02e5ba491ed8e20856837e7b20e1cf521ad273f71ac941ea01b3494ae42b040a175dfe29b3f5858873d3c7eb870913914778de815ff856ea87863d318

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2025-12-09
+
+### BREAKING CHANGES
+- **Gem renamed from `paperclip-storage-aliyun` to `kt-paperclip-aliyun`**
+  - Main require file changed from `paperclip-storage-aliyun` to `kt-paperclip-aliyun`
+  - Update your Gemfile: `gem 'kt-paperclip-aliyun'` instead of `gem 'paperclip-storage-aliyun'`
+  - Update your requires: `require 'kt-paperclip-aliyun'` instead of `require 'paperclip-storage-aliyun'`
+- **Repository ownership transferred to 7a6163**
+
+### Added
+- Ruby 3.0+ support (tested on Ruby 2.7, 3.0, 3.1, 3.2, 3.3)
+- GitHub Actions CI/CD workflow replacing Travis CI
+- CodeCov integration for code coverage tracking
+- WebMock integration for testing without real Aliyun credentials
+- Comprehensive test suite improvements
+- Gem metadata for better RubyGems.org integration
+
+### Changed
+- **BREAKING**: Minimum Ruby version is now 2.7.0 (was 2.6.0)
+- Updated `rest-client` dependency from `>= 1.6.7` to `>= 2.0.0` for Ruby 3 compatibility
+- Updated test dependencies:
+  - `activerecord` from `~> 4.0.0` to `>= 5.0`
+  - `rspec` from `~> 3.3.0` to `~> 3.10`
+  - `rubocop` from `~> 0.34.2` to `~> 1.0`
+- Gem source changed from `gems.ruby-china.com` to `rubygems.org`
+- Replaced deprecated `URI.encode` with `URI::DEFAULT_PARSER.escape` for Ruby 3.0+ compatibility
+
+### Fixed
+- Fixed Ruby 3.0+ compatibility issues with URI encoding
+- Fixed all test failures by improving test isolation and mock setup
+- Renamed test fixture file from Chinese characters to `chinese-name.jpg` for better compatibility
+
+### Deprecated
+- Travis CI configuration (replaced with GitHub Actions)
+
+## [0.1.6] - 2020-04-20
+
+### Fixed
+- Fixed argument pollution in #get_endpoint
+
+## Previous versions
+
+See git history for changes in versions prior to 1.0.0.
+
+[1.0.0]: https://github.com/7a6163/kt-paperclip-aliyun/compare/v0.1.6...v1.0.0
+[0.1.6]: https://github.com/Martin91/paperclip-storage-aliyun/compare/v0.1.5...v0.1.6

data/README.md

@@ -0,0 +1,91 @@
+[![Ruby](https://github.com/7a6163/kt-paperclip-aliyun/actions/workflows/ruby.yml/badge.svg)](https://github.com/7a6163/kt-paperclip-aliyun/actions/workflows/ruby.yml)
+[![codecov](https://codecov.io/gh/7a6163/kt-paperclip-aliyun/branch/master/graph/badge.svg)](https://codecov.io/gh/7a6163/kt-paperclip-aliyun)
+[![Gem Version](https://badge.fury.io/rb/kt-paperclip-aliyun.svg)](https://badge.fury.io/rb/kt-paperclip-aliyun)
+
+Aliyun Open Storage Service for Paperclip
+===
+This gem implement the support for [Aliyun open storage service(OSS)](http://oss.aliyun.com) to [Paperclip](https://github.com/thoughtbot/paperclip).
+
+#### Ruby Version Support
+- Ruby 2.7+
+- Ruby 3.0+
+- Ruby 3.1+
+- Ruby 3.2+
+- Ruby 3.3+
+
+#### Installation
+```shell
+gem install kt-paperclip-aliyun
+```
+Or, if you are using a bundler, you can append the following line into your **Gemfile**:
+```ruby
+gem 'kt-paperclip-aliyun'
+```
+
+#### Configuration
+In order to make all the things work, you should do some important configurations through a initializer:
+
+If you are developing a Rails application, you can append a new initializer like:
+```ruby
+# [rails_root]/config/initializers/paperclip-aliyun-configuration.rb
+Paperclip::Attachment.default_options[:aliyun] = {
+  access_id: '3VL9XMho8iCushj8',
+  access_key: 'VAUI2q7Tc6yTh1jr3kBsEUzZ84gEa2',
+  bucket: 'xx-test',
+  data_center: 'cn-hangzhou',
+  internal: false,
+  protocol: 'https',
+  protocol_relative_url: false
+}
+```
+
+Then, in the model which defines the attachment, specify your storage and other options, for example:
+```ruby
+# [rails_root]/app/models/image.rb
+class Image < ActiveRecord::Base
+  has_attached_file :attachment, {
+    storage: :aliyun,
+    styles: { thumbnail: "60x60#"},
+    path: 'public/system/:class/:attachment/:id_partition/:style/:filename',
+    url: ':aliyun_upload_url'
+  }
+end
+```
+
+Similar to Paperclip::Storage::S3, there are four options for the url by now:
+- `:aliyun_upload_url` : the url based on the options you give
+- `:aliyun_internal_url` : the internal url, no matter what `options[:aliyun][:internal]` is
+- `:aliyun_external_url` : the external url, no matter what `options[:aliyun][:internal]` is
+- `:aliyun_alias_url` : the alias url based on the `host_alias` you give, typically used together with CDN
+
+Please note the values above are all strings, not symbols. You could still make your own url if only you know what you are doing.
+
+#### Data Centers
+A list of available regions can be found at [https://intl.aliyun.com/help/doc-detail/31837.htm](https://intl.aliyun.com/help/doc-detail/31837.htm).
+You can use the "Region Expression" column value as it is for the data center, or you can remove the "oss-" prefix. For example: `oss-cn-hangzhou` and `cn-hangzhou` are both valid options.
+
+#### Development & Testing
+
+Run tests with:
+```shell
+bundle exec rspec
+```
+
+By default, tests run with mocked Aliyun OSS requests (using WebMock). No real credentials are required.
+
+If you want to run tests against real Aliyun OSS:
+```shell
+export OSS_ACCESS_ID='your_access_key_id'
+export OSS_ACCESS_KEY='your_access_key_secret'
+bundle exec rspec
+```
+
+#### Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Make your changes and add tests
+4. Run the test suite (`bundle exec rspec`)
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create a Pull Request

data/lib/aliyun/connection.rb

@@ -0,0 +1,222 @@
+require 'openssl'
+require 'digest/md5'
+require 'rest-client'
+require 'base64'
+require 'uri'
+require 'aliyun/data_center'
+
+module Aliyun
+  class Connection
+    include DataCenter
+
+    # The upload host according to the connection configurations
+    attr_reader :aliyun_upload_host
+    # The internal host
+    attr_reader :aliyun_internal_host
+    # The external host
+    attr_reader :aliyun_external_host
+    # The alias host
+    attr_reader :aliyun_alias_host
+
+    attr_reader :aliyun_protocol
+
+    attr_reader :aliyun_protocol_relative_url
+
+    # Initialize the OSS connection
+    #
+    # @param [Hash] An options to specify connection details
+    # @option access_id [String] used to set "Authorization" request header
+    # @option access_key [String] the access key
+    # @option bucket [String] bucket used to access
+    # @option data_center [String] available data center name, e.g. 'cn-hangzhou'
+    # @option internal [true, false] if the service should be accessed through internal network
+    # @option host_alias [String] the alias of the host, such as the CDN domain name
+    # @option protocol [String] 'http' or 'https', default to 'http'
+    # @option protocol_relative_url [true, false] if to use protocol relative url, https://en.wikipedia.org/wiki/Wikipedia:Protocol-relative_URL
+    # @note both access_id and acces_key are related to authorization algorithm:
+    #   https://docs.aliyun.com/#/pub/oss/api-reference/access-control&signature-header
+    def initialize(options = {})
+      @aliyun_access_id = options[:access_id]
+      @aliyun_access_key = options[:access_key]
+      @aliyun_bucket = options[:bucket]
+      @aliyun_protocol_relative_url = !!options[:protocol_relative_url]
+      @aliyun_protocol = options[:protocol] || 'http'
+
+      @aliyun_upload_host = "#{@aliyun_bucket}.#{get_endpoint(options)}"
+      @aliyun_internal_host = "#{@aliyun_bucket}.#{get_endpoint(options.merge(internal: true))}"
+      @aliyun_external_host = "#{@aliyun_bucket}.#{get_endpoint(options.merge(internal: false))}"
+      @aliyun_alias_host = options[:host_alias] || @aliyun_upload_host
+    end
+
+    # Return the meta informations for a file specified by the path
+    # https://docs.aliyun.com/#/pub/oss/api-reference/object&HeadObject
+    #
+    # @param path [String] the path of file storaged in Aliyun OSS
+    # @return [Hash] the meta data of the file
+    # @note the example headers will be like:
+    #
+    #   {
+    #    {:date=>"Sun, 02 Aug 2015 02:42:45 GMT",
+    #    :content_type=>"image/jpg",
+    #    :content_length=>"125198",
+    #    :connection=>"close",
+    #    :accept_ranges=>"bytes",
+    #    :etag=>"\"336262A42E5B99AFF5B8BC66611FC156\"",
+    #    :last_modified=>"Sun, 01 Dec 2013 16:39:57 GMT",
+    #    :server=>"AliyunOSS",
+    #    :x_oss_object_type=>"Normal",
+    #    :x_oss_request_id=>"55BD83A5D4C05BDFF4A329E0"}}
+    #
+    def head(path)
+      path = format_path(path)
+      bucket_path = get_bucket_path(path)
+      date = gmtdate
+      headers = {
+        'Host' => @aliyun_upload_host,
+        'Date' => date,
+        'Authorization' => sign('HEAD', bucket_path, '', '', date)
+      }
+      url = path_to_url(path)
+      RestClient.head(url, headers).headers
+    rescue RestClient::ResourceNotFound
+      {}
+    end
+
+    # Upload File to Aliyun OSS
+    # https://docs.aliyun.com/#/pub/oss/api-reference/object&PutObject
+    #
+    # @param path [String] the target storing path on the oss
+    # @param file [File] an instance of File represents a file to be uploaded
+    # @param options [Hash]
+    #   - content_type - MimeType value for the file, default is "image/jpg"
+    #
+    # @return [String] The downloadable url of the uploaded file
+    # @return [nil] if the uploading failed
+    def put(path, file, options = {})
+      path = format_path(path)
+      bucket_path = get_bucket_path(path)
+      content_md5 = Digest::MD5.file(file).base64digest
+      content_type = options[:content_type] || 'image/jpg'
+      date = gmtdate
+      url = path_to_url(path)
+      auth_sign = sign('PUT', bucket_path, content_md5, content_type, date)
+      headers = {
+        'Authorization' => auth_sign,
+        'Content-Md5' => content_md5,
+        'Content-Type' => content_type,
+        'Content-Length' => file.size,
+        'Date' => date,
+        'Host' => @aliyun_upload_host,
+        'Expect' => '100-Continue'
+      }
+      response = RestClient.put(url, file, headers)
+      response.code == 200 ? path_to_url(path) : nil
+    end
+
+    # Delete a file from the OSS
+    # https://docs.aliyun.com/#/pub/oss/api-reference/object&DeleteObject
+    #
+    # @param path [String] the path to retrieve the file on remote storage
+    # @return [String] the expired url to the file, if the file deleted successfully
+    # @return [nil] if the delete operation failed
+    def delete(path)
+      path = format_path(path)
+      bucket_path = get_bucket_path(path)
+      date = gmtdate
+      headers = {
+        'Host' => @aliyun_upload_host,
+        'Date' => date,
+        'Authorization' => sign('DELETE', bucket_path, '', '', date)
+      }
+      url = path_to_url(path)
+      response = RestClient.delete(url, headers)
+      response.code == 204 ? url : nil
+    end
+
+    # Download the file from OSS
+    # https://docs.aliyun.com/#/pub/oss/api-reference/object&GetObject
+    #
+    # @param path [String] the path to retrieve the file on remote storage
+    # @return [?] the file content consist of bytes
+    def get(path)
+      path = format_path(path)
+      bucket_path = get_bucket_path(path)
+      date = gmtdate
+      headers = {
+        'Host' => @aliyun_upload_host,
+        'Date' => date,
+        'Authorization' => sign('GET', bucket_path, '', '', date)
+      }
+      url = path_to_url(path)
+      response = RestClient.get(url, headers)
+      response.body
+    end
+
+    # Determine if the file exists on the OSS
+    # https://docs.aliyun.com/#/pub/oss/api-reference/object&HeadObject
+    #
+    # @param path [String] the path to retrieve the file on remote storage
+    # @return [true] if file exists
+    # @return [false] if file could not be found
+    def exists?(path)
+      head(path).empty? ? false : true
+    end
+
+    # The GMT format time referenced from HTTP 1.1
+    # https://docs.aliyun.com/#/pub/oss/api-reference/public-header
+    #
+    # @return [String] a string represents the formated time, e.g. "Wed, 05 Sep. 2012 23:00:00 GMT"
+    def gmtdate
+      Time.now.gmtime.strftime('%a, %d %b %Y %H:%M:%S GMT')
+    end
+
+    # remove leading slashes in the path
+    #
+    # @param path [String] the path to retrieve the file on remote storage
+    # @return [String] the new string after removing leading slashed
+    def format_path(path)
+      path.blank? ? '' : path.gsub(%r{^/+}, '')
+    end
+
+    # A path consis of the bucket name and file name
+    # https://docs.aliyun.com/#/pub/oss/api-reference/access-control&signature-header
+    #
+    # @param path [String] the path to retrieve the file on remote storage
+    # @return [String] the expected bucket path, e.g. "test-bucket/oss-api.pdf"
+    def get_bucket_path(path)
+      [@aliyun_bucket, path].join('/')
+    end
+
+    # The full path contains host name to the file
+    #
+    # @param path [String] the path to retrieve the file on remote storage
+    # @return [String] the expected full path, e.g. "http://martin-test.oss-cn-hangzhou.aliyuncs.com/oss-api.pdf"
+    def path_to_url(path)
+      url = path =~ %r{^https?://} ? path : "http://#{aliyun_upload_host}/#{path}"
+      # URI.encode is deprecated in Ruby 2.7 and removed in Ruby 3.0
+      # Use URI::DEFAULT_PARSER.escape for Ruby 3 compatibility
+      URI::DEFAULT_PARSER.escape(url)
+    end
+
+    private
+
+    # The signature algorithm
+    # https://docs.aliyun.com/#/pub/oss/api-reference/access-control&signature-header
+    #
+    # @param verb [String] the request verb, e.g. "GET" or "DELETE"
+    # @param content_md5 [String] the md5 value for the content to be uploaded
+    # @param content_type [String] the content type of the file, e.g. "application/pdf"
+    # @param date [String] the GMT formatted date string
+    def sign(verb, path, content_md5, content_type, date)
+      canonicalized_oss_headers = ''
+      canonicalized_resource = "/#{path}"
+      string_to_sign = [
+        verb, content_md5, content_type, date,
+        canonicalized_oss_headers + canonicalized_resource
+      ].join("\n")
+      digest = OpenSSL::Digest.new('sha1')
+      h = OpenSSL::HMAC.digest(digest, @aliyun_access_key, string_to_sign)
+      "OSS #{@aliyun_access_id}:#{Base64.encode64(h)}"
+    end
+  end
+end

data/lib/aliyun/data_center.rb

@@ -0,0 +1,43 @@
+require 'aliyun/errors'
+
+module Aliyun
+  module DataCenter
+    # https://help.aliyun.com/document_detail/31837.html
+    AVAILABLE_DATA_CENTERS = %w[
+      oss-cn-hangzhou
+      oss-cn-shanghai
+      oss-cn-qingdao
+      oss-cn-beijing
+      oss-cn-zhangjiakou
+      oss-cn-huhehaote
+      oss-cn-shenzhen
+      oss-cn-heyuan
+      oss-cn-chengdu
+      oss-cn-hongkong
+      oss-us-west-1
+      oss-us-east-1
+      oss-ap-southeast-1
+      oss-ap-southeast-2
+      oss-ap-southeast-3
+      oss-ap-southeast-5
+      oss-ap-northeast-1
+      oss-ap-northeast-2
+      oss-ap-south-1
+      oss-eu-central-1
+      oss-eu-west-1
+      oss-me-east-1
+    ]
+
+    def get_endpoint(options)
+      data_center = options[:data_center]
+
+      data_center = 'oss-' + data_center unless data_center.match(/^oss/)
+
+      unless AVAILABLE_DATA_CENTERS.include?(data_center)
+        raise InvalildDataCenter, "Unsupported Data Center #{options[:data_center]} Detected"
+      end
+
+      "#{data_center}#{options[:internal] ? '-internal' : ''}.aliyuncs.com"
+    end
+  end
+end

data/lib/aliyun/errors.rb

@@ -0,0 +1,4 @@
+module Aliyun
+  class InvalildDataCenter < StandardError
+  end
+end

data/lib/kt-paperclip-aliyun.rb

@@ -0,0 +1,4 @@
+require 'paperclip'
+
+require 'paperclip/storage/aliyun'
+require 'aliyun/connection'

data/lib/paperclip/storage/aliyun.rb

@@ -0,0 +1,80 @@
+module Paperclip
+  module Storage
+    module Aliyun
+      def self.extended(base)
+        base.instance_eval do
+          @aliyun_options = @options[:aliyun]
+        end
+
+        [
+          :aliyun_upload_url,   :aliyun_internal_url,
+          :aliyun_external_url, :aliyun_alias_url
+        ].each do |url_style|
+          Paperclip.interpolates(url_style) do |attachment, style|
+            attachment.send(url_style, style)
+          end unless Paperclip::Interpolations.respond_to? url_style
+        end
+      end
+
+      def build_aliyun_object_url(host, style)
+        if oss_connection.aliyun_protocol_relative_url
+          "//#{host}/#{path(style).sub(%r{\A/}, '')}"
+        else
+          "#{oss_connection.aliyun_protocol}://#{host}/#{path(style).sub(%r{\A/}, '')}"
+        end
+      end
+
+      def aliyun_upload_url(style = default_style)
+        build_aliyun_object_url(oss_connection.aliyun_upload_host, style)
+      end
+
+      def aliyun_internal_url(style = default_style)
+        build_aliyun_object_url(oss_connection.aliyun_internal_host, style)
+      end
+
+      def aliyun_external_url(style = default_style)
+        build_aliyun_object_url(oss_connection.aliyun_external_host, style)
+      end
+
+      def aliyun_alias_url(style = default_style)
+        build_aliyun_object_url(oss_connection.aliyun_alias_host, style)
+      end
+
+      def exists?(style = default_style)
+        path(style) ? oss_connection.exists?(path(style)) : false
+      end
+
+      def flush_writes #:nodoc:
+        @queued_for_write.each do |style_name, file|
+          oss_connection.put path(style_name), (File.new file.path), content_type: file.content_type
+        end
+
+        after_flush_writes
+
+        @queued_for_write = {}
+      end
+
+      def flush_deletes #:nodoc:
+        @queued_for_delete.each do |path|
+          oss_connection.delete path
+        end
+
+        @queued_for_delete = []
+      end
+
+      def copy_to_local_file(style, local_dest_path)
+        log("copying #{path(style)} to local file #{local_dest_path}")
+        local_file = ::File.open(local_dest_path, 'wb')
+        remote_file_str = oss_connection.get path(style)
+        local_file.write(remote_file_str)
+        local_file.close
+      end
+
+      def oss_connection
+        @oss_connection ||= ::Aliyun::Connection.new(
+          Paperclip::Attachment.default_options[:aliyun].merge(@aliyun_options)
+        )
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: kt-paperclip-aliyun
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Martin Hong
+- Aidi Stan
+- 7a6163
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kt-paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Provides Aliyun OSS (Object Storage Service) storage backend for kt-paperclip
+  gem
+email: hongzeqin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/aliyun/connection.rb
+- lib/aliyun/data_center.rb
+- lib/aliyun/errors.rb
+- lib/kt-paperclip-aliyun.rb
+- lib/paperclip/storage/aliyun.rb
+homepage: https://github.com/7a6163/kt-paperclip-aliyun
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/7a6163/kt-paperclip-aliyun/issues
+  changelog_uri: https://github.com/7a6163/kt-paperclip-aliyun/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/7a6163/kt-paperclip-aliyun
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Aliyun OSS storage adapter for kt-paperclip
+test_files: []