carrierwave-qiniu 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24b8b0cf41531013c7b13a1a2b48f997b9a112ce
-  data.tar.gz: 836021574d7018c854513f2a1caf3bdb1ad2b837
+  metadata.gz: e4f2676e8b7b98df69a4d64794ff9aa123fc6129
+  data.tar.gz: 0f2e39106d8f4ec702cc497535b1ecebe9f38be2
 SHA512:
-  metadata.gz: f9a07551fe4fe866fdab074a0a53ca700e87b85d040caf255c63534d8017c4cdabba6549e358e8743c5d201efb5a676259c0a8af654c7170fefc87a2a0ffdadd
-  data.tar.gz: 2011fb606f7a0ce8e5cef3a5262db2ff5d932d0122fbc81d09ae849b857508825fce85148fb7fd58579f3bdfa61c5cd9474e798c0a1d7f52fea55a9f91c1acf9
+  metadata.gz: 3b37ff5997e8456fa4893d1fa080582685f4a56ece2efaff66e1f426b067306c4a6fd7b6449083351ada005a3096459e6ef7d30d9c09c2d01889c2e650b2c611
+  data.tar.gz: cf8851827113cfd0379c43da1dd3c084421f785ed4de64c78a151ac3c191994d694d75305c3d9b7335ddfadc626f9f86d5990f592ac19ad281e4cd9319b8529e

data/CHANGELOG.md

@@ -1,9 +1,16 @@
 
 ## CHANGE LOG
 
+### v0.2.6
+
+- 提供图片样式的便利方法
+https://github.com/huobazi/qiniu_direct_uploader/pull/68
+
+
 ### v0.2.5
 
 https://github.com/huobazi/carrierwave-qiniu/pull/61
+
 https://github.com/huobazi/carrierwave-qiniu/pull/62
 
 

data/README.md

@@ -1,6 +1,6 @@
 # Carrierwave::Qiniu
 
-[![Gem Version](https://badge.fury.io/rb/carrierwave-qiniu@2x.png?0.2.4)](http://badge.fury.io/rb/carrierwave-qiniu)
+[![Gem Version](https://badge.fury.io/rb/carrierwave-qiniu@2x.png?0.2.6)](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
@@ -78,6 +78,44 @@ class AvatarUploader < CarrierWave::Uploader::Base
 
 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
+class AvatarUploader < CarrierWave::Uploader::Base
+  storage :qiniu
+
+  qiniu_styles [:thumb, :large]
+end
+
+# original url
+user.avatar.url
+
+# thumb url
+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'
+end
+
+# thumb url
+user.avatar.url(:thumb)
+# http://.../avatar.jpg-thumb
+
+# inline thubm url
+user.avatar.url(:thumb, inline: true)
+# http://.../avatar.jpg?imageView2/1/w/200
+
+# just style param
+user.avatar.url(style: 'imageView2/1/w/200')
+# http://.../avatar.jpg?imageView2/1/w/200
+```
+
 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/lib/carrierwave-qiniu.rb

@@ -2,6 +2,7 @@
 require "carrierwave-qiniu/version"
 require "carrierwave/storage/qiniu"
 require "carrierwave/qiniu/configuration"
+require "carrierwave/qiniu/style"
 require "carrierwave/uploader/base"
 
 ::CarrierWave.configure do |config|
@@ -9,3 +10,4 @@ require "carrierwave/uploader/base"
 end
 
 ::CarrierWave::Uploader::Base.send(:include, ::CarrierWave::Qiniu::Configuration)
+::CarrierWave::Uploader::Base.send(:include, ::CarrierWave::Qiniu::Style)

data/lib/carrierwave-qiniu/version.rb

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

data/lib/carrierwave/qiniu/configuration.rb

@@ -20,11 +20,30 @@ module CarrierWave
         add_config :qiniu_expires_in
         add_config :qiniu_up_host
         add_config :qiniu_private_url_expires_in
+        add_config :qiniu_style_separator
 
         alias_config :qiniu_protocal, :qiniu_protocol
+
+        reset_qiniu_config
       end
 
       module ClassMethods
+        # Set default value
+        def reset_qiniu_config
+          configure do |config|
+            config.qiniu_protocol = 'http'
+            config.qiniu_bucket_private = false
+            config.qiniu_block_size = 1024*1024*4
+            config.qiniu_async_ops = ''
+            config.qiniu_can_overwrite = false
+            config.qiniu_private_url_expires_in = 3600
+            config.qiniu_callback_url = ''
+            config.qiniu_callback_body = ''
+            config.qiniu_persistent_notify_url = ''
+            config.qiniu_style_separator = '-'
+          end
+        end
+
         def alias_config(new_name, old_name)
           class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def self.#{new_name}(value=nil)

data/lib/carrierwave/qiniu/style.rb

@@ -0,0 +1,35 @@
+require 'carrierwave/qiniu/url'
+
+module CarrierWave
+  module Qiniu
+    module Style
+      extend ActiveSupport::Concern
+
+      class_methods do
+        # === Examples:
+        #
+        #    qiniu_styles [:thumbnail, :large]
+        #    qiniu_styles :thumbnail => 'imageView/0/w/200', :large => 'imageView/0/w/800'
+        #    qiniu_styles
+        #
+        def 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
+          end
+        end
+
+        def get_qiniu_styles
+          @qiniu_styles
+        end
+      end
+    end
+  end
+end

data/lib/carrierwave/qiniu/url.rb

@@ -0,0 +1,45 @@
+module CarrierWave
+  module Qiniu
+    module Url
+      # === Examples:
+      #
+      #     avatar.url(:version)
+      #     avatar.url(:version, inline: true)
+      #     avatar.url(style: 'imageView2/0/w/200')
+      #
+      def url(*args)
+        return super if args.empty?
+
+        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
+          version = args.first.to_sym
+          if qiniu_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]}"
+            else # Usage: avatar.url(:version)
+              return "#{url}#{self.class.qiniu_style_separator}#{version}"
+            end
+          end
+        end
+
+        # Fallback to original url
+        super
+      end
+
+      def qiniu_styles
+        self.class.get_qiniu_styles
+      end
+    end
+  end
+end

data/lib/carrierwave/storage/qiniu.rb

@@ -24,6 +24,7 @@ module CarrierWave
           @qiniu_callback_url           = options[:qiniu_callback_url] || ''
           @qiniu_callback_body          = options[:qiniu_callback_body] || ''
           @qiniu_persistent_notify_url  = options[:qiniu_persistent_notify_url] || ''
+          @qiniu_style_separator        = options[:qiniu_style_separator] || '-'
           init
         end
 
@@ -197,7 +198,8 @@ module CarrierWave
               :qiniu_private_url_expires_in => @uploader.qiniu_private_url_expires_in,
               :qiniu_callback_url  => @uploader.qiniu_callback_url,
               :qiniu_callback_body => @uploader.qiniu_callback_body,
-              :qiniu_persistent_notify_url  => @uploader.qiniu_persistent_notify_url
+              :qiniu_persistent_notify_url  => @uploader.qiniu_persistent_notify_url,
+              :qiniu_style_separator => @uploader.qiniu_style_separator
             }
 
             config[:qiniu_async_ops] = Array(@uploader.qiniu_async_ops).join(';') rescue ''

data/spec/spec_helper.rb

@@ -47,9 +47,6 @@ end
 
   config.qiniu_bucket        = ENV['qiniu_bucket']
   config.qiniu_bucket_domain = ENV['qiniu_bucket_domain']
-
-  config.qiniu_block_size    = 4*1024*1024
-  config.qiniu_protocol      = "http"
 end
 
 def load_file(fname)
@@ -60,4 +57,3 @@ end
 RSpec.configure do |config|
 
 end
-

data/spec/upload_spec.rb

@@ -77,12 +77,15 @@ require 'carrierwave/processing/mini_magick'
         self.qiniu_bucket = 'not_exists'
       end
 
-      class Photo < ActiveRecord::Base
+      class WrongPhoto < ActiveRecord::Base
+        self.table_name = 'photos'
+
         mount_uploader :image, WrongUploader
       end
 
       f = load_file("mm.jpg")
-      photo = Photo.new(:image => f)
+      photo = WrongPhoto.new(:image => f)
+      # FIXME: also raise error, see: CarrierWave::Qiniu#store L54
       photo.save
       expect(photo).to_not be_valid
 
@@ -150,4 +153,90 @@ require 'carrierwave/processing/mini_magick'
       expect(photo.image.file.exists?).to eq(false)
     end
   end
+
+  context "Styles" do
+
+    context 'array styles' do
+      class ArrayStylesUploader < CarrierWave::Uploader::Base
+        qiniu_styles [:thumb]
+
+        def store_dir
+          "carrierwave-qiniu-spec"
+        end
+      end
+
+      class ArrayStyledPhoto < ActiveRecord::Base
+        self.table_name = 'photos'
+
+        mount_uploader :image, ArrayStylesUploader
+      end
+
+      it 'style url' do
+        f = load_file("mm.jpg")
+        photo = ArrayStyledPhoto.new(image: f)
+        photo.save
+        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"
+
+        def store_dir
+          "carrierwave-qiniu-spec"
+        end
+      end
+
+      class HashStyledPhoto < ActiveRecord::Base
+        self.table_name = 'photos'
+
+        mount_uploader :image, HashStylesUploader
+      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
+        puts photo.image.url('thumb')
+        expect(photo.image.url('thumb').end_with?("mm.jpg-thumb")).to eq true
+      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
+    end
+
+    context "Only Style param" do
+      class StylesUploader < CarrierWave::Uploader::Base
+        qiniu_styles
+      end
+
+      class StyledPhoto < ActiveRecord::Base
+        self.table_name = 'photos'
+
+        mount_uploader :image, StylesUploader
+      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
+      end
+    end
+
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave-qiniu
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Marble Wu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-09 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carrierwave
@@ -56,6 +56,8 @@ files:
 - lib/carrierwave-qiniu.rb
 - lib/carrierwave-qiniu/version.rb
 - lib/carrierwave/qiniu/configuration.rb
+- lib/carrierwave/qiniu/style.rb
+- lib/carrierwave/qiniu/url.rb
 - lib/carrierwave/storage/qiniu.rb
 - lib/carrierwave/uploader/base.rb
 - spec/mm.jpg