carrierwave-qcloud 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61f57f3a44b467c0b0d7c33535bc2529c415d999
+  data.tar.gz: d443608f6d032f619c8d5c8e667bbcf705402f87
+SHA512:
+  metadata.gz: cba36fd5c311319a3abef639664c39444ee4e061b03163e2aaf1412b2c472f3cff5e50d8f4b090b26dafb04f96e7059309a875b2a48fff109356856253659cf1
+  data.tar.gz: 930895f85340d8ba3620936658b0cba252f819a506b305fdfa6c6f3b3f845719eb695a0c4043f97df36b01dee4d469b0f04443e8c644620310cb174b871ef3a3

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in carrierwave-qcloud.gemspec
+gemspec

data/README.md

@@ -0,0 +1,62 @@
+# Carrierwave::Qcloud
+
+This gem adds storage support for [Qcloud COS](https://www.qcloud.com/doc/product/227/%E4%BA%A7%E5%93%81%E4%BB%8B%E7%BB%8D) to [CarrierWave](https://github.com/carrierwaveuploader/carrierwave)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'carrierwave-qcloud'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carrierwave-qcloud
+
+## Usage
+
+You'll need to configure the to use this in config/initializes/carrierwave.rb
+
+```ruby
+CarrierWave.configure do |config|
+  #config.storage           = :qcloud # set default storage
+  config.qcloud_app_id     = 'xxxxxx'
+  config.qcloud_secret_id  = 'xxxxxx'
+  config.qcloud_secret_key = 'xxxxxx'
+  config.qcloud_bucket     = "bucketname"
+end
+```
+
+If dont want to use `qcloud` as default storage, just set the storage to `:qcloud` in the specified uploader:
+
+```ruby
+class AvatarUploader < CarrierWave::Uploader::Base
+  storage :qcloud
+end
+```
+
+You can override configuration item in individual uploader like this:
+
+```ruby
+class AvatarUploader < CarrierWave::Uploader::Base
+  storage :qcloud
+
+  self.qcloud_bucket = "avatars"
+end
+```
+
+## Development
+
+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 tags, 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/rainchen/carrierwave-qcloud.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "carrierwave/qcloud"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/carrierwave-qcloud.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carrierwave/qcloud/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "carrierwave-qcloud"
+  spec.version       = Carrierwave::Qcloud::VERSION
+  spec.authors       = ["RainChen"]
+  spec.email         = ["hirainchen@gmail.com"]
+
+  spec.summary       = %q{Qcloud COS Storage support for CarrierWave}
+  spec.description   = %q{Qcloud COS Storage support for CarrierWave}
+  spec.homepage      = "https://github.com/rainchen/carrierwave-qcloud"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "carrierwave", ">= 0.10.0"
+  spec.add_dependency "qcloud_cos", ">= 0.4.2"
+end

data/lib/carrierwave/qcloud.rb

@@ -0,0 +1,17 @@
+require "carrierwave/qcloud/version"
+require "carrierwave/qcloud/configuration"
+require 'carrierwave/storage/qcloud'
+
+module Carrierwave
+  module Qcloud
+    def self.register_carrierwave_storage_engine
+      CarrierWave.configure do |config|
+        config.storage_engines.merge!({ qcloud: 'CarrierWave::Storage::Qcloud' })
+      end
+
+      CarrierWave::Uploader::Base.send(:include, CarrierWave::Qcloud::Configuration)
+    end
+  end
+end
+
+Carrierwave::Qcloud.register_carrierwave_storage_engine

data/lib/carrierwave/qcloud/configuration.rb

@@ -0,0 +1,37 @@
+module CarrierWave
+  module Qcloud
+    module Configuration
+      extend ActiveSupport::Concern
+
+      included do
+        add_config :qcloud_app_id
+        add_config :qcloud_secret_id
+        add_config :qcloud_secret_key
+        add_config :qcloud_bucket
+      end
+    end
+
+    module ClassMethods
+      def add_config(name)
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def self.#{name}(value=nil)
+            @#{name} = value if value
+            return @#{name} if self.object_id == #{self.object_id} || defined?(@#{name})
+            name = superclass.#{name}
+            return nil if name.nil? && !instance_variable_defined?("@#{name}")
+            @#{name} = name && !name.is_a?(Module) && !name.is_a?(Symbol) && !name.is_a?(Numeric) && !name.is_a?(TrueClass) && !name.is_a?(FalseClass) ? name.dup : name
+          end
+
+          def self.#{name}=(value)
+            @#{name} = value
+          end
+
+          def #{name}
+            value = self.class.#{name}
+            value.instance_of?(Proc) ? value.call : value
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/carrierwave/qcloud/version.rb

@@ -0,0 +1,5 @@
+module Carrierwave
+  module Qcloud
+    VERSION = "0.1.0"
+  end
+end

data/lib/carrierwave/storage/qcloud.rb

@@ -0,0 +1,101 @@
+require 'carrierwave'
+require 'qcloud_cos' # use qcloud cos SDK
+
+module CarrierWave
+  module Storage
+    ##
+    #  qcloud storage engine
+    #
+    #  CarrierWave.configure do |config|
+    #    config.storage           = :qcloud
+    #    config.qcloud_app_id     = 'xxxxxx'
+    #    config.qcloud_secret_id  = 'xxxxxx'
+    #    config.qcloud_secret_key = 'xxxxxx'
+    #    config.qcloud_bucket     = "bucketname"
+    #  end
+    #
+    # wiki: https://github.com/richardkmichael/carrierwave-activerecord/wiki/Howto:-Adding-a-new-storage-engine
+    # rdoc: http://www.rubydoc.info/gems/carrierwave/CarrierWave/Storage/Abstract
+    class Qcloud < Abstract
+      # config qcloud sdk by getting configuration from uplander
+      def self.configure_qcloud_sdk(uploader)
+        QcloudCos.configure do |config|
+          config.app_id     = uploader.qcloud_app_id
+          config.secret_id  = uploader.qcloud_secret_id
+          config.secret_key = uploader.qcloud_secret_key
+          config.bucket     = uploader.qcloud_bucket
+          config.endpoint   = "http://web.file.myqcloud.com/files/v1/"
+        end
+      end
+
+      # hook: store the file on qcloud
+      def store!(file)
+        self.class.configure_qcloud_sdk(uploader)
+
+        qcloud_file = File.new(file)
+        qcloud_file.path = uploader.store_path(identifier)
+        qcloud_file.store
+        qcloud_file
+      end
+
+      # hook: retrieve the file on qcloud
+      def retrieve!(identifier)
+        self.class.configure_qcloud_sdk(uploader)
+
+        if uploader.file # file is present after store!
+          uploader.file
+        else
+          file_path = uploader.store_path(identifier)
+          File.new(nil).tap do |file|
+            file.path = file_path
+            file.stat
+          end
+        end
+      end
+
+      # store and retrieve file using qcloud-cos-sdk
+      # sdk ref: https://github.com/zlx/qcloud-cos-sdk/blob/master/wiki/get_started.md#api%E8%AF%A6%E7%BB%86%E8%AF%B4%E6%98%8E
+      class File < CarrierWave::SanitizedFile
+        attr_accessor :qcloud_info
+        attr_accessor :path
+
+        # store/upload file to qcloud
+        def store
+          result = QcloudCos.upload(path, file.to_file)
+          # e.g.: {"code"=>0, "message"=>"SUCCESS", "data"=>{"access_url"=>"http://#{bucket}-#{app_id}.file.myqcloud.com/uploads/user/avatar/5/81b97fdf4f5b4353916c0f40878258bc.jpg", "resource_path"=>"/uploads/user/avatar/5/81b97fdf4f5b4353916c0f40878258bc.jpg", "source_url"=>"http://#{bucket}-#{app_id}.cos.myqcloud.com/uploads/user/avatar/5/81b97fdf4f5b4353916c0f40878258bc.jpg", "url"=>"http://web.file.myqcloud.com/files/v1/uploads/user/avatar/5/81b97fdf4f5b4353916c0f40878258bc.jpg"}}
+
+          if result['message'] == 'SUCCESS'
+            self.qcloud_info = result['data']
+          end
+        end
+
+        # file access url on qcloud
+        def url
+          qcloud_info['access_url']
+        end
+
+        # get file stat on qcloud
+        def stat
+          result = QcloudCos.stat(path)
+          if result['message'] == 'SUCCESS'
+            self.qcloud_info = result['data']
+          end
+        end
+
+        # delete file on qcloud
+        def delete
+          result = QcloudCos.delete(path)
+          result['message'] == 'SUCCESS'
+          # TODO: delete parent dir if it's empty
+          # ref: https://github.com/carrierwaveuploader/carrierwave/wiki/How-to%3A-Make-a-fast-lookup-able-storage-directory-structure
+        end
+
+        # TODO: retrieve/download file from qcloud
+        def retrieve
+          # TODO
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: carrierwave-qcloud
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- RainChen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: qcloud_cos
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+description: Qcloud COS Storage support for CarrierWave
+email:
+- hirainchen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- carrierwave-qcloud.gemspec
+- lib/carrierwave/qcloud.rb
+- lib/carrierwave/qcloud/configuration.rb
+- lib/carrierwave/qcloud/version.rb
+- lib/carrierwave/storage/qcloud.rb
+homepage: https://github.com/rainchen/carrierwave-qcloud
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Qcloud COS Storage support for CarrierWave
+test_files: []