aliyunoss-activestorage-adapter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be287d0880ab9d18c34e3368599676a18037c029a4e4c69a3988618e185bcb76
+  data.tar.gz: cd9d6c1011ea9033f41b3dc1e14acf879dabaa9d86b25c35847d6008c3fd6e61
+SHA512:
+  metadata.gz: 661502c6982f26960218e32091f61718d1a6b3990cb3627cdc531ceb0c8081329ba6677b9eefb2d90191c0f1f34d9ad9755c6964a312af71977d1b457593e095
+  data.tar.gz: c955f8cec05d2de4bf93c5aa43cd24e57ac703416ea170d9e04a6cb06617587ea2d642d3ed2d45fb5486f683ee1ff486715385552ca610993dc82c0022b08510

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-18
+
+- 完成基础功能
+- 未实现的Service函数：compose, rupload_metadata

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in activestorage-aliyunoss.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "activestorage", "~> 7.0"
+
+gem "aliyunoss", "~> 0.2"

data/Gemfile.lock

@@ -0,0 +1,121 @@
+PATH
+  remote: .
+  specs:
+    aliyunoss-activestorage-adapter (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.4)
+      actionview (= 7.0.4)
+      activesupport (= 7.0.4)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.4)
+      activesupport (= 7.0.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.4)
+      activesupport (= 7.0.4)
+      globalid (>= 0.3.6)
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activestorage (7.0.4)
+      actionpack (= 7.0.4)
+      activejob (= 7.0.4)
+      activerecord (= 7.0.4)
+      activesupport (= 7.0.4)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    aliyunoss (0.2.2)
+      nokogiri (~> 1.13)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    erubi (1.11.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    loofah (2.19.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    marcel (1.0.2)
+    mini_mime (1.1.2)
+    minitest (5.16.3)
+    nokogiri (1.13.10-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    racc (1.6.1)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.4)
+      loofah (~> 2.19, >= 2.19.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.40.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  activestorage (~> 7.0)
+  aliyunoss (~> 0.2)
+  aliyunoss-activestorage-adapter!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Your Name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# ActiveStorage的阿里云存储适配器
+
+该Gem是一个Aliyun OSS插件，可为Rails 7.0的Active Storage添加阿里云对象存储接口。
+
+## 安装方法
+
+在Rails工程中的Gemfile中添加以下代码：
+
+    gem "aliyunoss-activestorage-adapter", "~> 0.1"
+
+然后运行bundle install即可。
+
+## 使用方法
+
+### 配置文件
+
+Active Storage的配置文件在/config/storage.yml文件中，请添加以下配置信息：
+
+    aliyun:
+      service: "Aliyunoss"
+      
+      # 阿里云开发者信息
+      access_key_id: <%= ENV["ALI_ACCESS_KEY"] %>
+      access_key_secret: <%= ENV["ALI_ACCESS_SECRET"] %>
+      
+      # Bucket名称
+      bucket: "[Bucket_Name]"
+      
+      # Bucket位置
+      location: "oss-cn-beijing"
+      
+      # 根目录
+      path: "/"
+      
+      # 根据创建的Bucket访问类型选择
+      is_public: true
+
+### 调用方法
+
+配置完成后，可以按照[Active Storage](https://edgeguides.rubyonrails.org/active_storage_overview.html)手册调用。
+
+## 开发
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yijiecc/activestorage-aliyunoss. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/yijiecc/activestorage-aliyunoss/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/activestorage-aliyunoss.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/active_storage/service/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "aliyunoss-activestorage-adapter"
+  spec.version = ActiveStorage::AliyunossService::VERSION
+  spec.authors = ["yiiecc"]
+  spec.email = ["yijiecc@hotmail.com"]
+
+  spec.summary = "A plugin that enables Rails App using Aliyun OSS."
+  spec.description = "A plugin that enables Rails App using Aliyun OSS, this gem depends on aliyunoss gem."
+  spec.homepage = "https://rubygems.org/gems/aliyunoss-activestorage-adapter"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "https://github.com/yijiecc/activestorage-aliyunoss"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/yijiecc/activestorage-aliyunoss"
+  spec.metadata["changelog_uri"] = "https://github.com/yijiecc/activestorage-aliyunoss/blob/main/CHANGELOG.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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/active_storage/aliyunoss.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "service/version"
+require_relative "service/aliyunoss_service"
+
+

data/lib/active_storage/service/aliyunoss_service.rb

@@ -0,0 +1,152 @@
+require 'active_storage'
+require 'aliyunoss'
+
+module ActiveStorage
+  class Service::AliyunossService < Service
+
+    # 
+    # keyword arguments:
+    # { 
+    #    access_key_id: <%= ENV["ALI_ACCESS_KEY"] %>
+    #    access_key_secret: <%= ENV["ALI_ACCESS_SECRET"] %>
+    #    bucket: "[BUCKET_NAME]"
+    #    location: "oss-cn-beijing"
+    #    path: "[PATH]"
+    #    is_public: true
+    # }
+    # 
+    def initialize(bucket:, access_key_id:, access_key_secret:, location:, path:, is_public:)
+      
+      Aliyun::Oss::configure(
+        :access_key_id => access_key_id,
+        :access_key_secret => access_key_secret
+      )
+
+      @bucket = Aliyun::Oss::Bucket.new(name: bucket, location: location)
+      @base_path = path
+      @public = is_public
+
+    end
+
+    # Upload the +io+ to the +key+ specified. If a +checksum+ is provided, the service will
+    # ensure a match when the upload has completed or raise an ActiveStorage::IntegrityError.
+    # aliyunoss gem will calculate checksum again, so this is useless
+    def upload(key, io, checksum: nil, **options)
+      if checksum != nil
+        options_with_checksum = options.merge('Content-MD5': checksum)
+        @bucket.upload(io.read, path_for(key), options_with_checksum)
+      else
+        @bucket.upload(io.read, path_for(key), options)
+      end
+    end
+
+    # Update metadata for the file identified by +key+ in the service.
+    # Override in subclasses only if the service needs to store specific
+    # metadata that has to be updated upon identification.
+    def update_metadata(key, **metadata)
+      raise NotImplementedError
+    end
+
+    # Return the content of the file at the +key+.
+    def download(key)
+      @bucket.download(path_for(key))
+    end
+
+    # Return the partial content in the byte +range+ of the file at the +key+.
+    def download_chunk(key, range)
+      @bucket.download(path_for(key), Range: range)
+    end
+
+    # Concatenate multiple files into a single "composed" file.
+    def compose(source_keys, destination_key, filename: nil, content_type: nil, disposition: nil, custom_metadata: {})
+      raise NotImplementedError
+    end
+
+    # Delete the file at the +key+.
+    def delete(key)
+      @bucket.delete(path_for(key))
+    end
+
+    # Delete files at keys starting with the +prefix+.
+    def delete_prefixed(prefix)
+      @bucket.list_files.each do |obj|
+        file_name = obj.fetch('key', '')
+        file_name = '/' + file_name if file_name != ''
+        @bucket.delete(file_name) if file_name.start_with?(File.join(@base_path, prefix))
+      end
+    end
+
+    # Return +true+ if a file exists at the +key+.
+    def exist?(key)
+      @bucket.exist? path_for(key)
+    end
+
+    # Returns the URL for the file at the +key+. This returns a permanent URL for public files, and returns a
+    # short-lived URL for private files. For private files you can provide
+    # the amount of seconds the URL will be valid for, specified in +expires_in+.
+    def url(key, **options)
+      instrument :url, key: key do |payload|
+        generated_url =
+          if public?
+            public_url(key, **options)
+          else
+            private_url(key, **options)
+          end
+
+        payload[:url] = generated_url
+
+        generated_url
+      end
+    end
+
+    # Returns a signed, temporary URL that a direct upload file can be PUT to on the +key+.
+    # The URL will be valid for the amount of seconds specified in +expires_in+.
+    # You must also provide the +content_type+, +content_length+, and +checksum+ of the file
+    # that will be uploaded. All these attributes will be validated by the service upon upload.
+    def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:, custom_metadata: {})
+      raise NotImplementedError
+    end
+
+    # Returns a Hash of headers for +url_for_direct_upload+ requests.
+    def headers_for_direct_upload(key, filename:, content_type:, content_length:, checksum:, custom_metadata: {})
+      {}
+    end
+
+    def public?
+      @public
+    end
+
+    private
+    def path_for(key)
+      File.join(@base_path, key)
+    end
+
+    def private_url(key, expires_in:, **)
+      @bucket.share(path_for(key), expires_in)
+    end
+
+    def public_url(key, **)
+      "https://#{@bucket}.#{@location}.aliyuncs.com#{path_for(key)}"
+    end
+
+    def custom_metadata_headers(metadata)
+      raise NotImplementedError
+    end
+
+    def instrument(operation, payload = {}, &block)
+      ActiveSupport::Notifications.instrument(
+        "service_#{operation}.active_storage",
+        payload.merge(service: service_name), &block)
+    end
+
+    def service_name
+      "Aliyunoss"
+    end
+
+    def content_disposition_with(type: "inline", filename:)
+      disposition = (type.to_s.presence_in(%w( attachment inline )) || "inline")
+      ActionDispatch::Http::ContentDisposition.format(disposition: disposition, filename: filename.sanitized)
+    end
+
+  end
+end

data/lib/active_storage/service/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  module AliyunossService
+      VERSION = "0.1.0"
+  end
+end

data/sig/activestorage/aliyunoss.rbs

@@ -0,0 +1,6 @@
+module Activestorage
+  module Aliyunoss
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: aliyunoss-activestorage-adapter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yiiecc
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-18 00:00:00.000000000 Z
+dependencies: []
+description: A plugin that enables Rails App using Aliyun OSS, this gem depends on
+  aliyunoss gem.
+email:
+- yijiecc@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- activestorage-aliyunoss.gemspec
+- lib/active_storage/aliyunoss.rb
+- lib/active_storage/service/aliyunoss_service.rb
+- lib/active_storage/service/version.rb
+- sig/activestorage/aliyunoss.rbs
+homepage: https://rubygems.org/gems/aliyunoss-activestorage-adapter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/aliyunoss-activestorage-adapter
+  source_code_uri: https://github.com/yijiecc/activestorage-aliyunoss
+  changelog_uri: https://github.com/yijiecc/activestorage-aliyunoss/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A plugin that enables Rails App using Aliyun OSS.
+test_files: []