activestorage-tencent_cos 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 348b2ef87c38baa18adc32994643d32a16ca7d1394bd5b44cd164163eb8e2646
+  data.tar.gz: e36d6cd2d493beaea1dd58188ed252e33dd9473a9797a564a42b9326fa27ae3e
+SHA512:
+  metadata.gz: 0c8e24008019e8543bd391ec8eeff8d1ff2928c8b6ddf063751ce61757ed2dc5acbc1a0d5846ee70f7239b40cb64f8cab7c7e6cd85c8f43b96ab55053c68437f
+  data.tar.gz: 1043a7284e7d81856d0f1066a029fca8003b14fd0a84fa22bbbdf9badb26e51d1e095d2e8b4f24167d6390a50836e114a4add6e68d3ac1a15144ac00960154c6

data/README.md

@@ -0,0 +1,45 @@
+# ActiveStorage::Service::TencentCOSService
+Active Storage Serivce for [Tencent COS](https://cloud.tencent.com/product/cos)
+
+
+## Notes
+It is important to note that this library is still in early stages and is currently being implemented according to my needs
+- only public read bucket is support(HTTP caching purpose)
+- direct upload only
+- delete variants have not yet been implemented
+- download have not yet been implemented
+
+
+## Usage
+Enable CORS on your bucket(for direct upload)
+https://cloud.tencent.com/document/product/436/13318
+
+Add to your Gemfile
+```
+gem 'activestorage-tencent_cos'
+```
+
+Edit `config/storage.yml`
+```
+tencent:
+  service: TencentCOS
+  secret_id: your_secret_id
+  secret_key: your_secret_key
+  app_id: your_app_id
+  bucket: your_bucket
+  region: ap-guangzhou # https://cloud.tencent.com/document/product/436/6224
+  endpoint: https://assets.example.com # your cdn url
+  max_age: 3600 # http cache time
+```
+
+Edit `config/environments/production.rb`
+```
+config.active_storage.service = :tencent
+```
+
+
+## Tips
+Use cdn url directly
+```
+<%= image_tag book.cover.service_url %>
+```

data/lib/active_storage/service/tencent_cos_service.rb

@@ -0,0 +1,141 @@
+# tencent cos does not have sdk for ruby
+# https://cloud.tencent.com/document/product/436/6474
+# TODO wrap cos code as a client lib?
+require 'net/http'
+
+module ActiveStorage
+  class Service::TencentCOSService < Service
+    def initialize(**config)
+      @config = config
+    end
+
+    def upload(key, io, checksum: nil)
+      raise NotImplementedError
+    end
+
+    def download(key)
+      raise NotImplementedError
+    end
+
+    def download_chunk(key, range)
+      instrument :download_chunk, key: key, range: range do
+        uri  = URI(url_for(key))
+        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
+        uri  = URI(url_for(key))
+        Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |client|
+          res = client.delete(uri, Authorization: authorization_for(key, 'delete'))
+          # res.code == '204'
+          res.kind_of?(Net::HTTPSuccess)
+        end
+      end
+    end
+
+    def delete_prefixed(prefix)
+      # TODO
+      # https://cloud.tencent.com/document/product/436/7734
+      # https://cloud.tencent.com/document/product/436/14120
+
+      # prevent destory error
+      # raise NotImplementedError
+    end
+
+    def exist?(key)
+      instrument :exist, key: key do |payload|
+        uri = URI(url_for(key))
+        answer = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |client|
+          res = client.head(uri, Authorization: authorization_for(key, 'head'))
+          res.kind_of?(Net::HTTPSuccess)
+        end
+
+        payload[:exist] = answer
+        answer
+      end
+    end
+
+    def url(key, expires_in:, filename:, content_type:, disposition:)
+      instrument :url, key: key do |payload|
+        # TODO url?response-content-disposition=disposition
+        generated_url = endpoint_url_for(key)
+        payload[:url] = generated_url
+        generated_url
+      end
+    end
+
+    def url_for_direct_upload(key, **)
+      instrument :url, key: key do |payload|
+        generated_url = url_for(key)
+        payload[:url] = generated_url
+        generated_url
+      end
+    end
+
+    def headers_for_direct_upload(key, checksum:, content_type:, content_length:, **)
+      {
+        'Authorization': authorization_for(key, 'put'),
+        'Content-Type': content_type,
+        # 'Content-Length': content_length, # refused by browser
+        'Content-MD5': checksum,
+        'Cache-Control': "max-age=#{max_age}",
+      }
+    end
+
+    private
+      attr_reader :config
+
+      def max_age
+        config.fetch(:max_age, 60)
+      end
+
+      def path_for(key)
+        "/#{key}"
+      end
+
+      def host
+        bucket, app_id, region = config.fetch_values(:bucket, :app_id, :region)
+        "#{bucket}-#{app_id}.cos.#{region}.myqcloud.com"
+      end
+
+      def url_for(key)
+        "https://#{host}#{path_for(key)}"
+      end
+
+      def endpoint_url_for(key)
+        endpoint = config.fetch(:endpoint)
+        if endpoint.present?
+          "#{endpoint}#{path_for(key)}"
+        else
+          url_for(key)
+        end
+      end
+
+      # https://cloud.tencent.com/document/product/436/7778#signature
+      def authorization_for(key, method, expires_in=url_expires_in)
+        secret_id, secret_key = config.fetch_values(:secret_id, :secret_key)
+
+        time = "#{Time.now.to_i};#{expires_in.after.to_i}"
+        # URI.encode(HttpHeaders)?
+        sign_key = OpenSSL::HMAC.hexdigest('sha1', secret_key, time)
+        http_string =  "#{method}\n#{path_for(key)}\n\nhost=#{host}\n"
+        string_to_sign = "sha1\n#{time}\n#{OpenSSL::Digest::SHA1.hexdigest(http_string)}\n"
+        sign = OpenSSL::HMAC.hexdigest('sha1', sign_key, string_to_sign)
+
+        {
+          'q-sign-algorithm': 'sha1',
+          'q-ak': secret_id,
+          'q-sign-time': time,
+          'q-key-time': time,
+          'q-header-list': 'host',
+          'q-url-param-list': '',
+          'q-signature': sign,
+        }.map {|k, v| "#{k}=#{v}"}.join('&')
+        # value should not escaped, `to_query` is not working here
+      end
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: activestorage-tencent_cos
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ''
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activestorage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/active_storage/service/tencent_cos_service.rb
+homepage: 
+licenses: []
+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.7.6
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []