carrierwave-qiniu 0.2.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4f2676e8b7b98df69a4d64794ff9aa123fc6129
-  data.tar.gz: 0f2e39106d8f4ec702cc497535b1ecebe9f38be2
+  metadata.gz: 9eebff093b52ff063969297675687f497ccadcda
+  data.tar.gz: ee4b5d2023a718c8e25fce76fe5c79de8b21c43f
 SHA512:
-  metadata.gz: 3b37ff5997e8456fa4893d1fa080582685f4a56ece2efaff66e1f426b067306c4a6fd7b6449083351ada005a3096459e6ef7d30d9c09c2d01889c2e650b2c611
-  data.tar.gz: cf8851827113cfd0379c43da1dd3c084421f785ed4de64c78a151ac3c191994d694d75305c3d9b7335ddfadc626f9f86d5990f592ac19ad281e4cd9319b8529e
+  metadata.gz: 0d2b6d7dc64fb5d401131444a09cb7d56840d2909b6d9be31a706c5e8b1932ad9e1544095b688e89902df7dfe2ef63d5e645ba3c49bd88fceb155ccf2e66e908
+  data.tar.gz: c7e8a550038550afe3d953b87bf51d921ed77eee8cb728c66d7091a0b3d1a9fdab814282b0bb5f135035d68df186a169eeb2b843628cddbb5fdc4fea3496d597

data/CHANGELOG.md

@@ -1,10 +1,21 @@
 
 ## CHANGE LOG
 
+### v1.0.0
+
+- 变更图片样式的用法
+https://github.com/huobazi/carrierwave-qiniu/pull/70
+
+- 不兼容上一版本
+
+``` qiniu_styles ``` 移动到 config 中
+在 uploader 内 使用 ``` use_qiniu_styles ``` 来指定使用默认 styles 或者 覆盖默认配置
+详见 ReadMe 中的示例
+
 ### v0.2.6
 
 - 提供图片样式的便利方法
-https://github.com/huobazi/qiniu_direct_uploader/pull/68
+https://github.com/huobazi/carrierwave-qiniu/pull/68
 
 
 ### v0.2.5

data/README.md

@@ -1,6 +1,6 @@
 # Carrierwave::Qiniu
 
-[![Gem Version](https://badge.fury.io/rb/carrierwave-qiniu@2x.png?0.2.6)](http://badge.fury.io/rb/carrierwave-qiniu)
+[![Gem Version](https://badge.fury.io/rb/carrierwave-qiniu@2x.png?1.0.0)](http://badge.fury.io/rb/carrierwave-qiniu)
 
 This gem adds storage support for [Qiniu](http://qiniutek.com) to [Carrierwave](https://github.com/jnicklas/carrierwave)
 example: https://github.com/huobazi/carrierwave-qiniu-example
@@ -9,7 +9,7 @@ example: https://github.com/huobazi/carrierwave-qiniu-example
 
 Add this line to your application's Gemfile:
 
-    gem 'carrierwave-qiniu'
+    gem 'carrierwave-qiniu', '~> 1.0.0'
 
 And then execute:
 
@@ -80,12 +80,17 @@ end
 ```
 
 You can use [qiniu image styles](https://qiniu.kf5.com/hc/kb/article/68884/) instead [version](https://github.com/carrierwaveuploader/carrierwave#adding-versions) processing of CarrierWave.
-```
-# Case 1
+
+```ruby
+# Case 1: Array styles
+CarrierWave.configure do |config|
+  config.qiniu_styles = [:thumb, :large]
+end
+
 class AvatarUploader < CarrierWave::Uploader::Base
   storage :qiniu
 
-  qiniu_styles [:thumb, :large]
+  use_qiniu_styles
 end
 
 # original url
@@ -96,11 +101,9 @@ user.avatar.url(:thumb)
 # http://.../avatar.jpg-thumb
 
 
-# Case 2
-class AvatarUploader < CarrierWave::Uploader::Base
-  storage :qiniu
-
-  qiniu_styles thumb: 'imageView2/1/w/200', large: 'imageView2/1/w/800'
+# Case 2: Hash styles
+CarrierWave.configure do |config|
+  config.qiniu_styles = { thumb: 'imageView2/1/w/200', large: 'imageView2/1/w/800' }
 end
 
 # thumb url
@@ -114,8 +117,47 @@ user.avatar.url(:thumb, inline: true)
 # just style param
 user.avatar.url(style: 'imageView2/1/w/200')
 # http://.../avatar.jpg?imageView2/1/w/200
+
+# Case 3: Inline all styles in development environment
+CarrierWave.configure do |config|
+  config.qiniu_styles = { thumb: 'imageView2/1/w/200', large: 'imageView2/1/w/800' }
+  config.qiniu_style_inline = true if Rails.env.development?
+end
+
+class AvatarUploader < CarrierWave::Uploader::Base
+  storage :qiniu
+
+  use_qiniu_styles
+end
+
+user.avatar.url(:thumb)
+# http://.../avatar.jpg?imageView2/1/w/200
+
+# Case 4: Custom styles and bucket
+class AvatarUploader < CarrierWave::Uploader::Base
+  storage :qiniu
+
+  # Override default styles and use your own
+  use_qiniu_styles :thumb => 'imageView/0/w/400', :xlarge => 'imageView/0/w/1600'
+
+  self.qiniu_bucket                = "avatars"
+  self.qiniu_bucket_domain         = "avatars.files.example.com"
+
+end
+
+user.avatar.url(:thumb, inline: true)
+# http://.../avatar.jpg?imageView2/1/w/400
+
 ```
+Sync Qiniu styles of uploader
 
+```
+$ rake carrierwave:qiniu:sync_styles
+
+# Bucket: bucket_name_1, Set style: thumb => imageView2/1/w/200
+# Bucket: bucket_name_2, Set style: large => imageView2/1/w/800
+
+```
 You can see a example project on: https://github.com/huobazi/carrierwave-qiniu-example
 
 or see the spec test on https://github.com/huobazi/carrierwave-qiniu/blob/master/spec/upload_spec.rb

data/carrierwave-qiniu.gemspec

@@ -17,6 +17,6 @@ Gem::Specification.new do |gem|
   gem.version       = Carrierwave::Qiniu::VERSION
 
 
-  gem.add_dependency "carrierwave"
-  gem.add_dependency "qiniu",["~> 6.8.0"]
+  gem.add_dependency "carrierwave" , "~> 0"
+  gem.add_dependency "qiniu", "~> 6.8", ">= 6.8.0"
 end

data/lib/carrierwave-qiniu.rb

@@ -4,6 +4,7 @@ require "carrierwave/storage/qiniu"
 require "carrierwave/qiniu/configuration"
 require "carrierwave/qiniu/style"
 require "carrierwave/uploader/base"
+ require "carrierwave/qiniu/railtie" if defined?(Rails)
 
 ::CarrierWave.configure do |config|
   config.storage_engines[:qiniu] = "::CarrierWave::Storage::Qiniu".freeze

data/lib/carrierwave-qiniu/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Carrierwave
   module Qiniu
-    VERSION = "0.2.6"
+    VERSION = "1.0.0"
   end
 end

data/lib/carrierwave/qiniu/configuration.rb

@@ -21,6 +21,8 @@ module CarrierWave
         add_config :qiniu_up_host
         add_config :qiniu_private_url_expires_in
         add_config :qiniu_style_separator
+        add_config :qiniu_style_inline
+        add_config :qiniu_styles
 
         alias_config :qiniu_protocal, :qiniu_protocol
 
@@ -41,6 +43,7 @@ module CarrierWave
             config.qiniu_callback_body = ''
             config.qiniu_persistent_notify_url = ''
             config.qiniu_style_separator = '-'
+            config.qiniu_style_inline = false
           end
         end
 

data/lib/carrierwave/qiniu/railtie.rb

@@ -0,0 +1,10 @@
+module CarrierWave
+  module Qiniu
+
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load 'carrierwave/tasks/qiniu.rake'
+      end
+    end
+  end
+end

data/lib/carrierwave/qiniu/style.rb

@@ -8,26 +8,48 @@ module CarrierWave
       class_methods do
         # === Examples:
         #
-        #    qiniu_styles [:thumbnail, :large]
-        #    qiniu_styles :thumbnail => 'imageView/0/w/200', :large => 'imageView/0/w/800'
-        #    qiniu_styles
+        #    CarrierWave.configure do |config|
+        #      config.qiniu_styles = [:thumbnail, :large]
+        #      # or
+        #      config.qiniu_styles = {:thumbnail => 'imageView/0/w/200', :large => 'imageView/0/w/800'}
+        #    end
         #
-        def qiniu_styles(versions = nil)
+        #    # Eanble qiniu styles otherwise default version processing
+        #    # And use default styles
+        #    use_qiniu_styles
+        #
+        #    # Override default styles and use your own styles
+        #    use_qniu_styles :thumbnail => 'imageView/0/w/400', :xlarge => 'imageView/0/w/1600'
+        #
+        def use_qiniu_styles(versions = nil)
+
           # Override #url method when set styles, otherwise still default strategy.
           unless include? ::CarrierWave::Qiniu::Url
             send(:include, ::CarrierWave::Qiniu::Url)
           end
 
-          @qiniu_styles = {}
-          if versions.is_a? Array
-            @qiniu_styles = versions.map { |version| [version.to_sym, nil] }.to_h
-          elsif versions.is_a? Hash
-            @qiniu_styles = versions.symbolize_keys
+          @_qiniu_styles = {}
+          if self.qiniu_styles
+            # Set default styles
+            @_qiniu_styles = parse_qiniu_styles(self.qiniu_styles)
+          elsif versions
+            # Set custom styles
+            self.qiniu_styles = versions
+            @_qiniu_styles = parse_qiniu_styles(versions)
           end
         end
 
         def get_qiniu_styles
-          @qiniu_styles
+          @_qiniu_styles
+        end
+
+        private
+        def parse_qiniu_styles(styles)
+          if styles.is_a? Array
+            styles.map { |version| [version.to_sym, nil] }.to_h
+          elsif styles.is_a? Hash
+            styles.symbolize_keys
+          end
         end
       end
     end

data/lib/carrierwave/qiniu/url.rb

@@ -10,25 +10,31 @@ module CarrierWave
       def url(*args)
         return super if args.empty?
 
+        # Usage: avatar.url(style: 'imageView/0/w/200')
         if args.first.is_a? Hash
           options = args.first
-          # Usage: avatar.url(style: 'imageView/0/w/200')
           if options[:style]
             url = super({})
             return "#{url}?#{options[:style]}"
           end
         else
+        # Usage: avatar.url(version, options)
           version = args.first.to_sym
-          if qiniu_styles.key? version.to_sym
+          if styles.key? version.to_sym
             options = args.last
 
             # TODO: handle private url
             url = super({})
             # Usage: avatar.url(:version, inline: true)
-            if options.present? && options.is_a?(Hash) && options[:inline] && qiniu_styles[version]
-              return "#{url}?#{qiniu_styles[version]}"
+            if options.present? && options.is_a?(Hash) && options[:inline] && styles[version]
+              return "#{url}?#{styles[version]}"
             else # Usage: avatar.url(:version)
-              return "#{url}#{self.class.qiniu_style_separator}#{version}"
+              # inline mode
+              if self.class.qiniu_style_inline && styles[version]
+                return "#{url}?#{styles[version]}"
+              else
+                return "#{url}#{self.class.qiniu_style_separator}#{version}"
+              end
             end
           end
         end
@@ -37,7 +43,7 @@ module CarrierWave
         super
       end
 
-      def qiniu_styles
+      def styles
         self.class.get_qiniu_styles
       end
     end

data/lib/carrierwave/tasks/qiniu.rake

@@ -0,0 +1,21 @@
+namespace :carrierwave do
+  namespace :qiniu do
+    desc 'Sync Qiniu styles of uploader'
+    task sync_styles: :environment do
+      options = [:qiniu_access_key, :qiniu_secret_key, :qiniu_block_size, :qiniu_up_host].reduce({}) do |options, key|
+        options.merge!(key => CarrierWave::Uploader::Base.public_send(key))
+      end
+      # Config Qiniu establish_connection
+      CarrierWave::Storage::Qiniu::Connection.new(options)
+
+      bucket = CarrierWave::Uploader::Base.qiniu_bucket
+      styles = CarrierWave::Uploader::Base.qiniu_styles
+      if styles && styles.is_a?(Hash)
+        styles.each do |name, style|
+          puts "Bucket: #{bucket}, Set style: #{name} => #{style}"
+          Qiniu.set_style(bucket, name.to_s, style)
+        end
+      end
+    end
+  end
+end

data/spec/upload_spec.rb

@@ -155,53 +155,62 @@ require 'carrierwave/processing/mini_magick'
   end
 
   context "Styles" do
+    class StylesUploader < CarrierWave::Uploader::Base
+      use_qiniu_styles
+    end
 
-    context 'array styles' do
-      class ArrayStylesUploader < CarrierWave::Uploader::Base
-        qiniu_styles [:thumb]
+    class StyledPhoto < ActiveRecord::Base
+      self.table_name = 'photos'
 
-        def store_dir
-          "carrierwave-qiniu-spec"
-        end
-      end
+      mount_uploader :image, StylesUploader
+    end
 
-      class ArrayStyledPhoto < ActiveRecord::Base
-        self.table_name = 'photos'
+    class CustomStylesUploader < CarrierWave::Uploader::Base
+      use_qiniu_styles thumb2: 'imageView2/0/w/200'
+    end
 
-        mount_uploader :image, ArrayStylesUploader
-      end
+    class CustomStyledPhoto < ActiveRecord::Base
+      self.table_name = 'photos'
+
+      mount_uploader :image, CustomStylesUploader
+    end
+
+    let(:photo) {
+      f = load_file("mm.jpg")
+      photo = StyledPhoto.new(image: f)
+      photo.save
+      photo
+    }
 
+    context 'array styles' do
       it 'style url' do
-        f = load_file("mm.jpg")
-        photo = ArrayStyledPhoto.new(image: f)
-        photo.save
+        StylesUploader.qiniu_styles = [:thumb]
+        StylesUploader.use_qiniu_styles
+
         photo.errors.count.should == 0
 
         expect(photo.image.url).not_to be_nil
         puts photo.image.url('thumb')
         expect(photo.image.url('thumb').end_with?("mm.jpg-thumb")).to eq true
       end
-    end
 
-    context "Hash styles" do
-      class HashStylesUploader < CarrierWave::Uploader::Base
-        qiniu_styles thumb: "imageView2/0/w/200"
+      it 'global inline mode' do
+        StylesUploader.qiniu_styles = [:thumb]
+        StylesUploader.use_qiniu_styles
+        CarrierWave.configure {|config| config.qiniu_style_inline = true }
 
-        def store_dir
-          "carrierwave-qiniu-spec"
-        end
+        expect(photo.image.url('thumb', inline: true).end_with?("mm.jpg-thumb")).to eq true
+        CarrierWave.configure {|config| config.qiniu_style_inline = false }
       end
+    end
 
-      class HashStyledPhoto < ActiveRecord::Base
-        self.table_name = 'photos'
-
-        mount_uploader :image, HashStylesUploader
+    context "Hash styles" do
+      before :each do
+        StylesUploader.qiniu_styles = { thumb: 'imageView2/0/w/200' }
+        StylesUploader.use_qiniu_styles
       end
 
       it 'style url' do
-        f = load_file("mm.jpg")
-        photo = HashStyledPhoto.new(image: f)
-        photo.save
         photo.errors.count.should == 0
 
         expect(photo.image.url).not_to be_nil
@@ -210,33 +219,58 @@ require 'carrierwave/processing/mini_magick'
       end
 
       it 'inline style url' do
-        f = load_file("mm.jpg")
-        photo = HashStyledPhoto.new(image: f)
-        photo.save
         puts photo.image.url('thumb', inline: true)
         expect(photo.image.url('thumb', inline: true).end_with?("mm.jpg?imageView2/0/w/200")).to eq true
       end
+
+      it 'global inline mode' do
+        CarrierWave.configure {|config| config.qiniu_style_inline = true }
+        expect(photo.image.url('thumb', inline: true).end_with?("mm.jpg?imageView2/0/w/200")).to eq true
+        CarrierWave.configure {|config| config.qiniu_style_inline = false }
+      end
     end
 
     context "Only Style param" do
-      class StylesUploader < CarrierWave::Uploader::Base
-        qiniu_styles
+      it 'url' do
+        puts photo.image.url(style: 'imageView2/0/w/200')
+        expect(photo.image.url(style: 'imageView2/0/w/200').end_with?("mm.jpg?imageView2/0/w/200")).to eq true
       end
+    end
 
-      class StyledPhoto < ActiveRecord::Base
-        self.table_name = 'photos'
+    context "Custom styles" do
+      let(:custom_photo) {
+        f = load_file("mm.jpg")
+        photo = CustomStyledPhoto.new(image: f)
+        photo.save
+        photo
+      }
+
+      it 'override default styles' do
+        photo = custom_photo
+        expect(CustomStylesUploader.qiniu_styles).to eq({ thumb2: 'imageView2/0/w/200' })
+        # Version thumb doesn't exist!
+        expect { photo.image.url('thumb') }.to raise_error
+      end
 
-        mount_uploader :image, StylesUploader
+      it 'style url' do
+        photo = custom_photo
+        expect(photo.image.url).not_to be_nil
+        puts photo.image.url('thumb2')
+        expect(photo.image.url('thumb2').end_with?("mm.jpg-thumb2")).to eq true
       end
 
-      it 'url' do
-        f = load_file("mm.jpg")
-        photo = StyledPhoto.new(image: f)
-        photo.save
-        puts photo.image.url(style: 'imageView2/0/w/200')
-        expect(photo.image.url(style: 'imageView2/0/w/200').end_with?("mm.jpg?imageView2/0/w/200")).to eq true
+      it 'inline style url' do
+        photo = custom_photo
+        puts photo.image.url('thumb2', inline: true)
+        expect(photo.image.url('thumb2', inline: true).end_with?("mm.jpg?imageView2/0/w/200")).to eq true
       end
-    end
 
+      it 'global inline mode' do
+        photo = custom_photo
+        CarrierWave.configure {|config| config.qiniu_style_inline = true }
+        expect(photo.image.url('thumb2', inline: true).end_with?("mm.jpg?imageView2/0/w/200")).to eq true
+        CarrierWave.configure {|config| config.qiniu_style_inline = false }
+      end
+    end
   end
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave-qiniu
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Marble Wu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-17 00:00:00.000000000 Z
+date: 2016-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carrierwave
   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
@@ -29,6 +29,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.8'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 6.8.0
   type: :runtime
@@ -36,6 +39,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.8'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 6.8.0
 description: Qiniu Storage support for CarrierWave
@@ -56,9 +62,11 @@ files:
 - lib/carrierwave-qiniu.rb
 - lib/carrierwave-qiniu/version.rb
 - lib/carrierwave/qiniu/configuration.rb
+- lib/carrierwave/qiniu/railtie.rb
 - lib/carrierwave/qiniu/style.rb
 - lib/carrierwave/qiniu/url.rb
 - lib/carrierwave/storage/qiniu.rb
+- lib/carrierwave/tasks/qiniu.rake
 - lib/carrierwave/uploader/base.rb
 - spec/mm.jpg
 - spec/spec_helper.rb
@@ -83,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Qiniu Storage support for CarrierWave