paperclip-storage-aliyun 0.1.0 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8531e6601564efe368735f05147b68f4401c495
-  data.tar.gz: e2317360addbbce35acd8bf2947a532cdf11f8c2
+  metadata.gz: 54dcd2f097b32d6998ae9ea559f6b2e0ea5cb722
+  data.tar.gz: 608cf463dc92fd1eb2f2ce11948d34a0943ace91
 SHA512:
-  metadata.gz: 1f7ce3fda9227a3937a1d04e7acce987c60028187496261c493176f87e016fcaba3083fc7a9977b28af313ac9a92b0ffef6af5ba092a052f40baaac65f7b52e6
-  data.tar.gz: abef51e1bbeb91ac622f74ed61f17bde84026d91eba1ebf423b11833ff770b2a4912d385ec09de6728d16f4d5d0bfafb44517696f0b43e268d4cc6cd3b10753d
+  metadata.gz: 5ba28411b91204475eb8918bc39b4bd1ce95be879adcb7111b346da88b953f02662c787852d045eae0b1288c74e9c4cd8a7cad291e9eded84908eeea43ce2d5a
+  data.tar.gz: 72fc6dc869c817eb34159e7a0af899277df51d14cdba62920e4f3b80158ae95ddc230b9fee20ffa9a385445ee62d233eba57cec4ff802373926f4f2328c1fc5f

data/lib/aliyun/connection.rb

@@ -18,21 +18,29 @@ module Aliyun
     # 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. 'hangzhou'
+    # @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))}"
@@ -40,7 +48,7 @@ module Aliyun
       @aliyun_alias_host = options[:host_alias] || @aliyun_upload_host
     end
 
-    # Return the meta informations for the a file specified by the path
+    # 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
@@ -60,8 +68,16 @@ module Aliyun
     #    :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
+      RestClient.head(url, headers).headers
     rescue RestClient::ResourceNotFound
       {}
     end
@@ -93,7 +109,7 @@ module Aliyun
         'Host' => @aliyun_upload_host,
         'Expect' => '100-Continue'
       }
-      response = RestClient.put(URI.encode(url), file, headers)
+      response = RestClient.put(url, file, headers)
       response.code == 200 ? path_to_url(path) : nil
     end
 
@@ -113,7 +129,7 @@ module Aliyun
         'Authorization' => sign('DELETE', bucket_path, '', '', date)
       }
       url = path_to_url(path)
-      response = RestClient.delete(URI.encode(url), headers)
+      response = RestClient.delete(url, headers)
       response.code == 204 ? url : nil
     end
 
@@ -132,7 +148,7 @@ module Aliyun
         'Authorization' => sign('GET', bucket_path, '', '', date)
       }
       url = path_to_url(path)
-      response = RestClient.get(URI.encode(url), headers)
+      response = RestClient.get(url, headers)
       response.body
     end
 
@@ -176,7 +192,7 @@ module Aliyun
     # @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)
-      path =~ %r{^https?://} ? path : "http://#{aliyun_upload_host}/#{path}"
+      URI.encode(path =~ %r{^https?://} ? path : "http://#{aliyun_upload_host}/#{path}")
     end
 
     private

data/lib/aliyun/data_center.rb

@@ -2,33 +2,41 @@ require 'aliyun/errors'
 
 module Aliyun
   module DataCenter
-    # https://docs.aliyun.com/#/pub/oss/product-documentation/domain-region
+    # 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-hongkong
+      oss-cn-zhangjiakou
+      oss-cn-huhehaote
       oss-cn-shenzhen
-      oss-cn-shanghai
+      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-south-1
+      oss-eu-central-1
+      oss-eu-west-1
+      oss-me-east-1
     )
 
     def get_endpoint(options)
-      data_center = find_center(options[:data_center])
+      data_center = options[:data_center]
 
-      unless data_center && AVAILABLE_DATA_CENTERS.include?(data_center)
+      data_center = 'oss-' + data_center unless data_center.match(/^oss/)
+
+      unless AVAILABLE_DATA_CENTERS.include?(data_center)
         fail InvalildDataCenter, "Unsupported Data Center #{options[:data_center]} Detected"
       end
 
       "#{data_center}#{options[:internal] ? '-internal' : ''}.aliyuncs.com"
     end
-
-    def find_center(data_center)
-      return if /^(oss|cn|us|ap|oss-cn)$/.match(data_center)
-
-      regexp = Regexp.new(data_center)
-      AVAILABLE_DATA_CENTERS.find { |center| regexp.match(center) }
-    end
   end
 end

data/lib/paperclip/storage/aliyun.rb

@@ -16,20 +16,28 @@ module Paperclip
         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)
-        "http://#{oss_connection.aliyun_upload_host}/#{path(style).sub(%r{\A/}, '')}"
+        build_aliyun_object_url(oss_connection.aliyun_upload_host, style)
       end
 
       def aliyun_internal_url(style = default_style)
-        "http://#{oss_connection.aliyun_internal_host}/#{path(style).sub(%r{\A/}, '')}"
+        build_aliyun_object_url(oss_connection.aliyun_internal_host, style)
       end
 
       def aliyun_external_url(style = default_style)
-        "http://#{oss_connection.aliyun_external_host}/#{path(style).sub(%r{\A/}, '')}"
+        build_aliyun_object_url(oss_connection.aliyun_external_host, style)
       end
 
       def aliyun_alias_url(style = default_style)
-        "http://#{oss_connection.aliyun_alias_host}/#{path(style).sub(%r{\A/}, '')}"
+        build_aliyun_object_url(oss_connection.aliyun_alias_host, style)
       end
 
       def exists?(style = default_style)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paperclip-storage-aliyun
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.6
 platform: ruby
 authors:
 - Martin Hong
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-01 00:00:00.000000000 Z
+date: 2020-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paperclip
@@ -45,26 +45,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- Gemfile
-- README.md
 - lib/aliyun/connection.rb
 - lib/aliyun/data_center.rb
 - lib/aliyun/errors.rb
 - lib/paperclip-storage-aliyun.rb
 - lib/paperclip/storage/aliyun.rb
-- paperclip-storage-aliyun.gemspec
-- spec/aliyun_spec.rb
-- spec/attachments/girl.jpg
-- spec/attachments/masu.pdf
-- spec/fixtures/schema.rb
-- spec/lib/paperclip/storage/aliyun_spec.rb
-- spec/spec_helper.rb
-- spec/support/post.rb
-- spec/support/rails.rb
 homepage: https://github.com/Martin91/paperclip-storage-aliyun
 licenses:
 - MIT
@@ -85,9 +70,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Extend a Aliyun OSS storage for paperclip
 test_files: []
-has_rdoc: 

data/.editorconfig

@@ -1,13 +0,0 @@
-# EditorConfig is awesome: http://EditorConfig.org
-
-# top-most EditorConfig file
-root = true
-
-# Unix-style newlines with a newline ending every file
-[*]
-charset = utf-8
-indent_style = space
-indent_size = 2
-end_of_line = lf
-insert_final_newline = true
-trim_trailing_whitespace = true

data/.gitignore

@@ -1,3 +0,0 @@
-Gemfile.lock
-.yardoc/
-doc/

data/.rspec

@@ -1 +0,0 @@
---color

data/.rubocop.yml

@@ -1,11 +0,0 @@
-Style/Documentation:
-  Enabled: false
-
-Metrics/AbcSize:
-  Max: 18
-
-Metrics/LineLength:
-  Max: 120
-
-Metrics/MethodLength:
-  Enabled: false

data/Gemfile

@@ -1,16 +0,0 @@
-source 'https://ruby.taobao.org'
-
-gemspec
-
-group :test do
-  gem 'activerecord', '~> 4.0.0'
-  # A database backend that translates database interactions into no-ops. Using
-  # NullDB enables you to test your model business logic - including after_save
-  # hooks - without ever touching a real database.
-  gem 'activerecord-nulldb-adapter'
-  gem 'rspec', '~> 3.3.0'
-  # Use rubocop to lint our Ruby codes
-  gem 'rubocop', '~> 0.34.2'
-  gem 'pry'
-  gem 'pry-nav'
-end

data/README.md

@@ -1,47 +0,0 @@
-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).
-
-#### Installation
-```shell
-gem install paperclip-storage-aliyun
-```
-Or, if you are using a bundler, you can append the following line into your **Gemfile**:
-```ruby
-gem 'paperclip-storage-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: 'hangzhou',
-  internal: 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/paperclip-storage-aliyun.gemspec

@@ -1,16 +0,0 @@
-Gem::Specification.new do |s|
-  s.name         = 'paperclip-storage-aliyun'
-  s.platform     = Gem::Platform::RUBY
-  s.require_path = 'lib'
-  s.summary      = 'Extend a Aliyun OSS storage for paperclip'
-  s.description  = 'Extend a Aliyun OSS storage for paperclip'
-  s.version      = '0.1.0'
-  s.files        = `git ls-files`.split("\n")
-  s.authors      = ['Martin Hong', 'Aidi Stan']
-  s.email        = 'hongzeqin@gmail.com'
-  s.homepage     = 'https://github.com/Martin91/paperclip-storage-aliyun'
-  s.license      = 'MIT'
-
-  s.add_runtime_dependency 'paperclip', '>= 3.5.2'
-  s.add_runtime_dependency 'rest-client', '>= 1.6.7'
-end

data/spec/aliyun_spec.rb

@@ -1,59 +0,0 @@
-require 'spec_helper'
-
-require 'net/http'
-
-describe Aliyun::Connection do
-  before :all do
-    @connection = ::Aliyun::Connection.new OSS_CONNECTION_OPTIONS
-    @path = 'a/a.jpg'
-  end
-
-  describe '#initialize' do
-    it 'raise error when use invalid data center' do
-      expect do
-        ::Aliyun::Connection.new data_center: 'guangzhou'
-      end.to raise_error(Aliyun::InvalildDataCenter)
-    end
-  end
-
-  describe '#put' do
-    it 'upload the attachment' do
-      url = @connection.put @path, load_attachment('girl.jpg')
-      response_code = Net::HTTP.get_response(URI.parse(url)).code
-      expect(response_code).to eq('200')
-    end
-
-    it 'support setting content type' do
-      content_type = 'application/pdf'
-      path = 'pdfs/masu.pdf'
-      @connection.put path, load_attachment('masu.pdf'), content_type: content_type
-      file_meta = @connection.head(path)
-      expect(file_meta[:content_type]).to eq(content_type)
-
-      @connection.delete path
-    end
-  end
-
-  describe '#delete' do
-    it 'delete the attachment' do
-      url = @connection.delete @path
-      response_code = Net::HTTP.get_response(URI.parse(url)).code
-      expect(response_code).to eq('404')
-    end
-  end
-
-  describe '#exists?' do
-    before :all do
-      @connection.put @path, load_attachment('girl.jpg')
-    end
-
-    it 'return true if the file has been uploaded' do
-      expect(@connection.exists?(@path)).to be_truthy
-    end
-
-    it "return false if the specified file didn't exist" do
-      @connection.delete @path
-      expect(@connection.exists?(@path)).to be_falsey
-    end
-  end
-end

data/spec/fixtures/schema.rb

@@ -1,8 +0,0 @@
-require 'active_record'
-require 'paperclip'
-
-ActiveRecord::Schema.define do
-  create_table :posts, force: true do |t|
-    t.attachment :attachment
-  end
-end

data/spec/lib/paperclip/storage/aliyun_spec.rb

@@ -1,73 +0,0 @@
-require 'spec_helper'
-require 'open-uri'
-require 'net/http'
-require 'support/post'
-
-describe Paperclip::Storage::Aliyun do
-  before :all do
-    @file = load_attachment('girl.jpg')
-    @post = Post.create attachment: @file
-  end
-
-  after :all do
-    @post.destroy! if @post && @post.respond_to?(:id)
-    @file.close
-  end
-
-  describe '#flush_writes' do
-    it 'uploads the attachment to Aliyun' do
-      response = open(@post.attachment.url)
-      expect(response).to be_truthy
-    end
-
-    it 'get uploaded file from Aliyun' do
-      attachment = open @post.attachment.url
-      expect(attachment.size).to eq(@file.size)
-    end
-
-    it 'set content type according to the original file' do
-      attachment = load_attachment('masu.pdf')
-      post = Post.create attachment: attachment
-      headers = RestClient.head(post.attachment.url).headers
-      expect(headers[:content_type]).to eq('application/pdf')
-
-      post.destroy
-    end
-  end
-
-  describe '#exists?' do
-    it 'returns true if the file exists on Aliyun' do
-      expect(@post.attachment).to exist
-    end
-
-    it "returns false if the file doesn't exist on Aliyun" do
-      post = Post.new attachment: @file
-      expect(post.attachment).not_to exist
-    end
-
-    it 'not raise exception when attachment not saved' do
-      post = Post.create
-      expect { post.attachment.exists? }.not_to raise_error
-    end
-  end
-
-  describe '#copy_to_local_file' do
-    it 'copies file from Aliyun to a local file' do
-      destination = File.join(Bundler.root, 'tmp/photo.jpg')
-      @post.attachment.copy_to_local_file(:original, destination)
-      expect(File.exist?(destination)).to be_truthy
-
-      File.delete destination
-    end
-  end
-
-  describe '#flush_deletes' do
-    it 'deletes the attachment from Aliyun' do
-      attachment_url = @post.attachment.url
-      @post.destroy
-
-      response_code = Net::HTTP.get_response(URI.parse(attachment_url)).code
-      expect(response_code).to eq('404')
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,27 +0,0 @@
-require 'pry'
-require 'pry-nav'
-require 'paperclip-storage-aliyun'
-
-Paperclip.logger.level = ::Logger::UNKNOWN
-Dir[Bundler.root.join('spec/support/**/*.rb')].each(&method(:require))
-
-# Aliyun defaults
-OSS_CONNECTION_OPTIONS = {
-  access_id: '3VL9XMho8iCuslj8',
-  access_key: 'VAUI2q7Tc6yTf1jr3kBsEUzZ84gEa2',
-  bucket: 'martin-test',
-  data_center: 'hangzhou',
-  internal: false
-  # host_alias: nil
-}
-
-# Paperclip defaults
-Paperclip::Attachment.default_options[:storage] = :aliyun
-Paperclip::Attachment.default_options[:aliyun] = OSS_CONNECTION_OPTIONS
-Paperclip::Attachment.default_options[:path] = 'public/system/:class/:attachment/:id_partition/:style/:filename'
-Paperclip::Attachment.default_options[:url] = ':aliyun_upload_url'
-
-# Utility methods
-def load_attachment(file_name)
-  File.open(Bundler.root.join("spec/attachments/#{file_name}"), 'rb')
-end

data/spec/support/post.rb

@@ -1,24 +0,0 @@
-require 'active_record'
-require 'nulldb'
-require 'paperclip'
-
-class Post < ActiveRecord::Base
-  include Paperclip::Glue
-
-  has_attached_file :attachment
-  do_not_validate_attachment_file_type :attachment
-end
-
-RSpec.configure do |config|
-  config.before(:all) do
-    FileUtils.mkdir_p File.join(Bundler.root, 'tmp')
-    ActiveRecord::Base.establish_connection(
-      adapter: 'nulldb',
-      schema: File.join(Bundler.root, 'spec/fixtures/schema.rb')
-    )
-  end
-
-  config.after(:all) do
-    ActiveRecord::Base.remove_connection
-  end
-end

data/spec/support/rails.rb

@@ -1,10 +0,0 @@
-require 'paperclip'
-
-module Paperclip
-  module Interpolations
-    module Rails
-      def self.root
-      end
-    end
-  end
-end