activestorage-aliyun-oss 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 846fe944de46bf6c077edbb456ff894aa1fb19ba
+  data.tar.gz: 88447903a5ad8b3b62e5c57212b9b7448f292bdf
+SHA512:
+  metadata.gz: eccccb84caac1bd05abc4ddc1da341efe0eeefb842d78736e377147c1e18c9a7df3f34f4fa05f40e55f159631dc2ef8bf9d5ef610fadfdb8381337b888715bb0
+  data.tar.gz: c471d3b5025a4e4ea4c22b71fcd549bcd34d9e435f8ac6301e779cdaac7422b5f6f6bcadabeda4fdfd9b709b36f44fbc0b27e8011b6fd4a2a65c02c134875303

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+## 0.4.0
+
+- Support present `params` to `service_url` to oss image url.
+
+for example:
+
+```rb
+@photo.image.service_url(params: { 'x-oss-process' => "image/resize,h_100,w_100" })
+```
+
+## 0.3.0
+
+- Add `mode` config for setup OSS ACL, `mode: "private"` will always output URL that have signature info.
+- Support `disposition: :attachment` option for `service_url` method for download original filename.
+
+## 0.2.0
+
+- Add url_for_direct_upload support.
+- Fix delete_prefixed error when path not exists.
+
+## 0.1.1
+
+- Fix streaming upload.
+- Fix delete by prefixed.
+- Add full test.
+
+## 0.1.0
+
+- First release.

data/README.md

@@ -0,0 +1,79 @@
+# ActiveStorage Aliyun Service
+
+Wraps the Aliyun OSS as an Active Storage service.
+
+
+[![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)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activestorage-aliyun'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Usage
+
+config/storage.yml
+
+```rb
+production:
+  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"
+  # path prefix, default: /
+  path: "my-app-files"
+  # Bucket mode: [public, private], default: public
+  mode: "public"
+```
+
+### Use for image url
+
+```erb
+Orignial File URL:
+
+<%= image_tag @photo.image.service_url %>
+```
+
+Thumb with OSS image service:
+
+```rb
+class Photo < ApplicationRecord
+  def image_thumb_url(process)
+    self.image.service_url(params: { "x-oss-process" => process })
+  end
+end
+```
+
+And then:
+
+```erb
+<%= image_tag @photo.image.image_thumb_url("image/resize,h_100,w_100") %>
+```
+
+### Use for file download
+
+If you want to get original filename (Include Chinese and other UTF-8 chars), for example: `演示文件 download.zip`, you need present `disposition: :attachment` option.
+
+```erb
+#
+<%= image_tag @photo.image.service_url(disposition: :attachment) %>
+```
+
+## Contributing
+
+Contribution directions go here.
+
+## 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,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveStorage Aliyun Service'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/active_storage/service/aliyun_service.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+require "aliyun/oss"
+
+module ActiveStorage
+  class Service::AliyunService < Service
+    def initialize(**config)
+      Aliyun::Common::Logging.set_log_file("/dev/null")
+      @config = config
+    end
+
+    def upload(key, io, checksum: nil)
+      instrument :upload, key: key, checksum: checksum do
+        bucket.put_object(path_for(key)) do |stream|
+          stream << io.read
+        end
+      end
+    end
+
+    def download(key)
+      instrument :download, key: key do
+        chunk_buff = []
+        bucket.get_object(path_for(key)) do |chunk|
+          if block_given?
+            yield chunk
+          else
+            chunk_buff << chunk
+          end
+        end
+        chunk_buff.join("")
+      end
+    end
+
+    def download_chunk(key, range)
+      instrument :download_chunk, key: key, range: range do
+        uri = URI(url(key, expires_in: 30.seconds, filename: ActiveStorage::Filename.new(""), content_type: "application/octet-stream", disposition: "inline"))
+
+        Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |client|
+          client.get(uri, "Range" => "bytes=#{range.begin}-#{range.exclude_end? ? range.end - 1 : range.end}").body
+        end
+      end
+    end
+
+    def delete(key)
+      instrument :delete, key: key do
+        bucket.delete_object(path_for(key))
+      end
+    end
+
+    def delete_prefixed(prefix)
+      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|
+        bucket.object_exists?(path_for(key))
+      end
+    end
+
+    def url(key, expires_in:, filename: nil, content_type:, disposition:, params: {})
+      instrument :url, key: key do |payload|
+        sign    = private_mode? || disposition == :attachment
+        filekey = path_for(filename.to_s)
+
+        if disposition == :attachment
+          params["response-content-type"] = content_type if content_type
+          unless filename.is_a?(ActiveStorage::Filename)
+            filename = ActiveStorage::Filename.new(filename)
+          end
+
+          params["response-content-disposition"] = content_disposition_with(type: disposition, filename: filename)
+        end
+
+        generated_url = object_url(filekey, sign: sign, expires_in: expires_in, params: params)
+        payload[:url] = generated_url
+        generated_url
+      end
+    end
+
+    # You must setup CORS on OSS control panel to allow JavaScript request from your site domain.
+    # https://www.alibabacloud.com/help/zh/doc-detail/31988.htm
+    # https://help.aliyun.com/document_detail/31925.html
+    # Source: *.your.host.com
+    # Allowed Methods: POST, PUT, HEAD
+    # Allowed Headers: *
+    def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
+      instrument :url, key: key do |payload|
+        generated_url = bucket.object_url(path_for(key), false)
+        payload[:url] = generated_url
+        generated_url
+      end
+    end
+
+    # 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:, **)
+      date = Time.now.httpdate
+      {
+        "Content-Type" => content_type,
+        "Content-MD5" => checksum,
+        "Authorization" => authorization(key, content_type, checksum, date),
+        "x-oss-date" => date,
+      }
+    end
+
+    private
+      attr_reader :config
+
+      def path_for(key)
+        return key unless config.fetch(:path, nil)
+        File.join(config.fetch(:path), key)
+      end
+
+      def object_url(key, sign:, expires_in: 60, params: {})
+        url = bucket.object_url(key, false)
+        unless sign
+          return url if params.blank?
+          return url + "?" + params.to_query
+        end
+
+        resource = "/#{bucket.name}/#{key}"
+        expires  = Time.now.to_i + expires_in
+        query    = {
+          "Expires" => expires,
+          "OSSAccessKeyId" => config.fetch(:access_key_id)
+        }
+        query.merge!(params)
+
+        if params.present?
+          resource += "?" + params.map { |k, v| "#{k}=#{v}" }.sort.join("&")
+        end
+
+        string_to_sign = ["GET", "", "", expires, resource].join("\n")
+        query["Signature"] = bucket.sign(string_to_sign)
+
+        [url, query.to_query].join('?')
+      end
+
+      def bucket
+        return @bucket if defined? @bucket
+        @bucket = client.get_bucket(config.fetch(:bucket))
+        @bucket
+      end
+
+      # Bucket mode :public | :private
+      def private_mode?
+        @private_mode ||= config.fetch(:mode, "public").to_s == "private"
+      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 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
+
+  end
+end

data/lib/active_storage_aliyun/railtie.rb

@@ -0,0 +1,4 @@
+module ActiveStorageAliyun
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/active_storage_aliyun/version.rb

@@ -0,0 +1,3 @@
+module ActiveStorageAliyun
+  VERSION = '0.1.0'
+end

data/lib/activestorage-aliyun.rb

@@ -0,0 +1,5 @@
+# require "active_storage_aliyun/railtie"
+
+module ActiveStorageAliyun
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: activestorage-aliyun-oss
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zhou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: aliyun-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+description: Wraps the Aliyun OSS as an Active Storage service.
+email: zhouchunyu20xx@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/active_storage/service/aliyun_service.rb
+- lib/active_storage_aliyun/railtie.rb
+- lib/active_storage_aliyun/version.rb
+- lib/activestorage-aliyun.rb
+homepage: https://github.com/huacnlee/activestorage-aliyun
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Wraps the Aliyun OSS as an Active Storage service
+test_files: []