carrierwave-nos 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 000f41ba6262a1b8f1f6438c92d255e17c37e2f1
+  data.tar.gz: 3087f1ff574e799c82dbc14484d0748b3a6efb0d
+SHA512:
+  metadata.gz: cede556d8880b5e2a7baaab1b3bdaf48909998e46c36ca21bb4308055f7195eb86fc18fefc46d1b25abe2101adc421c3a7a5a1c383371bc42801bb6183f838db
+  data.tar.gz: b316520742ed789297a55c1c4fd6ccf695dc8b1e8caa5cc63d36a2ebdc7ce83034c47fd88d440f6b62809d8ffcb7f6de2fe3a9977328f3cae4b6e5a9976e26fc

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,53 @@
+Style/Documentation:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/MutableConstant:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 1200
+
+Metrics/ClassLength:
+  Max: 1200
+
+Metrics/MethodLength:
+  Max: 1200
+
+Metrics/ModuleLength:
+  Max: 1200
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false
+
+Style/GlobalVars:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Rails/FindBy:
+  Enabled: false
+
+Rails/HasAndBelongsToMany:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in carrierwave-nos.gemspec
+gemspec
+
+# use rubocop as static code analyzer
+# gem 'rubocop', '~> 0.49.1', require: false

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    carrierwave-nos (0.1.0)
+      carrierwave (~> 1.0)
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.0.3)
+      activesupport (= 5.0.3)
+    activerecord (5.0.3)
+      activemodel (= 5.0.3)
+      activesupport (= 5.0.3)
+      arel (~> 7.0)
+    activesupport (5.0.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.1.4)
+    carrierwave (1.1.0)
+      activemodel (>= 4.0.0)
+      activesupport (>= 4.0.0)
+      mime-types (>= 1.16)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.2.5)
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (0.8.4)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    minitest (5.10.2)
+    netrc (0.11.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    sqlite3 (1.3.13)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  carrierwave-nos!
+  rspec (~> 3.0)
+  sqlite3
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Shurui Yang
+
+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,37 @@
+# CarrierWave for Netease Object Storage Service(NOS)
+
+This gem adds support for [Netease Object Storage Service](https://c.163.com/product/nos) to [CarrierWave](https://github.com/jnicklas/carrierwave/)
+
+> NOTE: 此 Gem 是一个 CarrierWave 的组件，你需要配合 CarrierWave 一起使用
+>
+> PS: 更多关于网易云对象存储服务的介绍请去[网易蜂巢官网](https://c.163.com/)查看
+
+
+## Installation
+
+```ruby
+gem 'carrierwave-nos'
+```
+
+## Configuration
+
+在Rails工程目录下创建文件 `config/initializers/carrierwave.rb` 并填入下面的代码，修改对应的配置：
+
+```ruby
+CarrierWave.configure do |config|
+  config.storage        = :nos
+  config.nos_access_key = ''
+  config.nos_secret_key = ''
+  # 你需要在 NOS 上面提前创建一个 Bucket
+  config.nos_bucket     = ''
+  config.nos_endpoint   = 'nos-eastchina1.126.net'
+end
+```
+
+## Usage
+
+参照单元测试`nos_spec.rb`
+
+## License
+
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/carrierwave-nos.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+require File.expand_path('lib/carrierwave/nos/version')
+
+Gem::Specification.new do |spec|
+  spec.name          = 'carrierwave-nos'
+  spec.version       = CarrierWave::Nos::VERSION
+  spec.authors       = ['Shurui Yang']
+  spec.email         = ['yangshurui1023@gmail.com']
+  spec.summary       = 'NOS support for CarrierWave.'
+  spec.description   = 'NOS support for CarrierWave.'
+  spec.homepage      = 'https://github.com/yangsr/carrierwave-nos'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'carrierwave', ['~> 1.0']
+  spec.add_dependency 'rest-client'
+
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/carrierwave-nos.rb

@@ -0,0 +1,8 @@
+require 'carrierwave/nos/bucket'
+require 'carrierwave/nos/configuration'
+require 'carrierwave/nos/nos_client'
+require 'carrierwave/nos/version'
+require 'carrierwave/storage/nos'
+require 'carrierwave/storage/nos_file'
+
+CarrierWave::Uploader::Base.send(:include, CarrierWave::Nos::Configuration)

data/lib/carrierwave/nos/bucket.rb

@@ -0,0 +1,44 @@
+module CarrierWave
+  module Nos
+    class Bucket
+      PATH_PREFIX = %r{^/}
+
+      def initialize(uploader)
+        @nos_access_key = uploader.nos_access_key
+        @nos_secret_key = uploader.nos_secret_key
+        @nos_endpoint = uploader.nos_endpoint
+        @nos_bucket = uploader.nos_bucket
+      end
+
+      # 上传文件
+      # params:
+      # - path - remote 存储路径
+      # - file - 需要上传文件的 File 对象
+      # returns:
+      # 图片的下载地址
+      def put(path, file)
+        path.sub!(PATH_PREFIX, '')
+
+        res = oss_upload_client.put_file(file, path)
+
+        if res.code == 200
+          path_to_url(path)
+        else
+          raise 'Put file failed'
+        end
+      end
+
+      # 根据配置返回完整的上传文件的访问地址
+      def path_to_url(path)
+        "https://#{@nos_bucket}.#{@nos_endpoint}/#{path}"
+      end
+
+      private
+
+      def oss_upload_client
+        return @oss_upload_client if defined?(@oss_upload_client)
+        @oss_upload_client = NosClient.new(@nos_access_key, @nos_secret_key, @nos_bucket, @nos_endpoint)
+      end
+    end
+  end
+end

data/lib/carrierwave/nos/configuration.rb

@@ -0,0 +1,18 @@
+module CarrierWave
+  module Nos
+    module Configuration
+      extend ActiveSupport::Concern
+
+      included do
+        add_config :nos_access_key
+        add_config :nos_secret_key
+        add_config :nos_endpoint
+        add_config :nos_bucket
+
+        configure do |config|
+          config.storage_engines[:nos] = 'CarrierWave::Storage::Nos'
+        end
+      end
+    end
+  end
+end

data/lib/carrierwave/nos/nos_client.rb

@@ -0,0 +1,154 @@
+require 'mime/types'
+require 'rest-client'
+require 'rexml/document'
+require 'rexml/xpath'
+
+module CarrierWave
+  module Nos
+    class NosClient
+      def initialize(access_key, secrete_key, bucket_name, host = 'nos-eastchina1.126.net')
+        @access_key = access_key
+        @secret_key = secrete_key
+        @bucket_name = bucket_name
+        @host = host
+      end
+
+      def put_file(file, object_key)
+        if file.class != File
+          raise ArgumentError.new("File object type needed, but got #{file.class}")
+        end
+
+        resp = if file.size > 100 * 1024 * 1024
+                 upload_large_file(file, object_key)
+               else
+                 send_request('PUT', @bucket_name, object_key, file)
+               end
+        resp
+      end
+
+      # PUT:    send_request('PUT', 'BUCKET_NAME', 'conan.jpg', data)
+      # param:  data = File.open(FILE_PATH, 'rb')
+      # GET:    send_request('GET', 'BUCKET_NAME', 'conan.jpg', nil)
+      # DELETE: send_request('DELETE', 'BUCKET_NAME', 'conan.jpg', nil)
+      # HEAD:   send_request('HEAD',  'BUCKET_NAME', 'conan.jpg', nil)
+      # POST:   send_request('POST', 'BUCKET_NAME', "#{object_key}?uploads", nil)
+      # send request and get response
+      def send_request(method, bucket, object_key, data = nil)
+        unless %w[GET DELETE HEAD PUT POST].include?(method)
+          raise ArgumentError.new('Only support following http method: GET DELETE HEAD PUT POST')
+        end
+        if data.nil?
+          content_type = ''
+        else
+          mime = MIME::Types.type_for(object_key).first
+          content_type = if mime.nil?
+                           'application/octet-stream'
+                         else
+                           mime.content_type
+                         end
+        end
+        # ruby url encode ignore '/', so replace '/' with '%2f' manually
+        resource = "/#{bucket}/#{URI.encode(object_key).gsub('/', '%2F')}"
+        headers = get_headers(method, resource, content_type, data.nil? ? nil : data.size)
+        url = "#{@bucket_name}.#{@host}" + "/#{URI.encode(object_key).gsub('/', '%2F')}"
+
+        if method == 'PUT'
+          res = RestClient.put(url, data, headers)
+        elsif method == 'GET'
+          res = RestClient.get(url, headers)
+        elsif method == 'DELETE'
+          res = RestClient.delete(url, headers)
+        elsif method == 'HEAD'
+          res = RestClient.head(url, headers)
+        elsif method == 'POST'
+          res = RestClient.post(url, data, headers)
+        end
+
+        res
+      end
+
+      def upload_large_file(file, object_key)
+        upload_id = init_multi_upload(object_key)
+        if upload_id == false
+          return 400
+        end
+        part_size = 50 * 1024 * 1024
+        part_num = 1
+        part_info = {}
+        until file.eof?
+          part_data = file.read(part_size)
+          etag = upload_part(object_key, part_num, upload_id, part_data)
+          if etag != false
+            part_info[part_num] = etag
+            part_num += 1
+          else
+            return 400
+          end
+        end
+        complete_multi_upload(object_key, upload_id, part_info)
+      end
+
+      def init_multi_upload(object_key)
+        resp = send_request('POST', @bucket_name, "#{object_key}?uploads", nil)
+        if resp.code == 200
+          doc = REXML::Document.new(resp.body)
+          upload_id = REXML::XPath.first(doc, '//UploadId/text()')
+          return upload_id
+        else
+          return false
+        end
+      end
+
+      def upload_part(object_key, part_num, upload_id, data)
+        resp = send_request('PUT', @bucket_name, "#{object_key}?partNumber=#{part_num}&uploadId=#{upload_id}", data)
+        if resp.code == 200
+          return resp.headers[:etag]
+        else
+          return false
+        end
+      end
+
+      def complete_multi_upload(object_key, upload_id, part_info)
+        data = '<CompleteMultipartUpload>'
+        part_info.each do |part_num, etag|
+          data += "<Part><PartNumber>#{part_num}</PartNumber><ETag>#{etag}</ETag></Part>"
+        end
+        data += '</CompleteMultipartUpload>'
+        send_request('POST', @bucket_name, "#{object_key}?uploadId=#{upload_id}", data)
+      end
+
+      private
+
+      def get_headers(method, resource, content_type = '', content_length = nil)
+        date = Time.now.httpdate
+        headers = {
+          'Authorization' => get_authorization(method, resource, date, content_type),
+          'Date'          => date,
+          'Host'          => "#{@bucket_name}.#{@host}"
+        }
+        unless content_type.nil?
+          headers['Content-Type'] = content_type
+        end
+        unless content_length.nil?
+          headers['Content-Length'] = content_length
+        end
+
+        headers
+      end
+
+      def get_authorization(method, resource, date, content_type = '')
+        content = {
+          'http_verb'              => method,
+          'content_md5'            => '',
+          'content_type'           => content_type,
+          'date'                   => date,
+          'canonicalized_resource' => resource,
+        }
+        str_to_sign = content.values.join("\n")
+        signature = Base64.encode64(OpenSSL::HMAC.digest('sha256', @secret_key, str_to_sign))
+
+        "NOS #{@access_key}:#{signature}"
+      end
+    end
+  end
+end

data/lib/carrierwave/nos/version.rb

@@ -0,0 +1,5 @@
+module CarrierWave
+  module Nos
+    VERSION = '0.1.0'
+  end
+end

data/lib/carrierwave/storage/nos.rb

@@ -0,0 +1,19 @@
+# coding: utf-8
+
+require 'carrierwave'
+
+module CarrierWave
+  module Storage
+    class Nos < Abstract
+      def store!(file)
+        f = NosFile.new(uploader, self, uploader.store_path)
+        f.store(::File.open(file.file))
+        f
+      end
+
+      def retrieve!(identifier)
+        NosFile.new(uploader, self, uploader.store_path(identifier))
+      end
+    end
+  end
+end

data/lib/carrierwave/storage/nos_file.rb

@@ -0,0 +1,39 @@
+module CarrierWave
+  module Storage
+    class NosFile < CarrierWave::SanitizedFile
+      attr_reader :path
+
+      def initialize(uploader, base, path)
+        @uploader = uploader
+        @base = base
+        @path = URI.encode(path)
+      end
+
+      def read
+        object = bucket.get(@path)
+        @headers = object.headers
+        object
+      end
+
+      def store(file)
+        bucket.put(@path, file)
+      end
+
+      def url(_opts = {})
+        bucket.path_to_url(@path)
+      end
+
+      private
+
+      def headers
+        @headers ||= {}
+      end
+
+      def bucket
+        return @bucket if defined? @bucket
+
+        @bucket = CarrierWave::Nos::Bucket.new(@uploader)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: carrierwave-nos
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shurui Yang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: NOS support for CarrierWave.
+email:
+- yangshurui1023@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- carrierwave-nos.gemspec
+- lib/carrierwave-nos.rb
+- lib/carrierwave/nos/bucket.rb
+- lib/carrierwave/nos/configuration.rb
+- lib/carrierwave/nos/nos_client.rb
+- lib/carrierwave/nos/version.rb
+- lib/carrierwave/storage/nos.rb
+- lib/carrierwave/storage/nos_file.rb
+homepage: https://github.com/yangsr/carrierwave-nos
+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.5.1
+signing_key: 
+specification_version: 4
+summary: NOS support for CarrierWave.
+test_files: []