shrine-cloudinary 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88a038d6cf9285136e6a82d4ddf674f91e476802
-  data.tar.gz: a62342009fd3960a2aeed8e2dd67897bc60d568f
+  metadata.gz: 7620a61d65d4509c6835b0ab21fc0f47d13cf39a
+  data.tar.gz: d414fe35b912c48e317ed361e5a1a39082c03df7
 SHA512:
-  metadata.gz: 8804baaf7341ecabdd1592648a3ab1181e87612e2b145c05314bfd20f384b7c4d5f062fc66ae9d00961979b4a725d58cdfda2a68ba113501f7c6eba0701c332b
-  data.tar.gz: 8bba0e77831e522c76d03616be52b04f6806c50089d8eb689bae7f8a9188cdf822973f1fd7cfed19137a4dc17f7d9bf91e4fde19e21985e462960bc3942c5dbc
+  metadata.gz: 1a181bb8b94a81a687c2ce4bb671799a7445e39565d558f2538d640d841dff5f61ccfbd883a223ea428d076e873587492e57ef40a997c94f73a057d74a09cc87
+  data.tar.gz: f81035721ad1988bbb369966a2effa215d79cf451165c90eabe5773077335493e0a15f4a90901506d90dcab8db764b97c099aaedd0a60efbbda3b135afacc191

data/README.md

@@ -2,9 +2,8 @@
 
 Provides [Cloudinary] storage for [Shrine].
 
-Cloudinary provides storage with advanced on-the-fly processing (as well as
-processing on upload) for both images and videos, but can also store any other
-types of files.
+Cloudinary provides storage and advanced processing for images and videos, both
+on-demand and on upload.
 
 ## Installation
 
@@ -14,32 +13,62 @@ gem "shrine-cloudinary"
 
 ## Usage
 
-First you need to configure the Cloudinary gem:
+You'll typically want to upload photos directly to Cloudinary, so your setup
+might look like this:
 
 ```rb
 require "cloudinary"
+require "shrine/storage/cloudinary"
 
 Cloudinary.config(
   cloud_name: "...",
   api_key:    "...",
   api_secret: "...",
 )
+
+Shrine.storages = {
+  cache: Shrine::Storage::Cloudinary.new(prefix: "cache"), # for direct uploads
+  store: Shrine::Storage::Cloudinary.new(prefix: "store"),
+}
 ```
 
-You can now initialize your storage:
+### Direct uploads
 
-```rb
-require "shrine/storage/cloudinary"
+Cloudinary supports uploading files directly to their service, freeing your
+application from accepting file uploads. There are three ways in which you
+can do direct uploads:
+
+* [unsigned uploads using the widget](http://cloudinary.com/documentation/upload_widget)
+* [unsigned uploads using jQuery](http://cloudinary.com/blog/direct_upload_made_easy_from_browser_or_mobile_app_to_the_cloud)
+* [signed uploads via jQuery](http://cloudinary.com/documentation/jquery_image_upload)
+
+The first one is the simplest, you can see the [demo] app with complete
+implementation using shrine-cloudinary. Unsigned uploads don't require
+communicating with the server, you just need to set up an "upload preset".
 
-Shrine.storages[:store] = Shrine::Storage::Cloudinary.new
+If you would prefer that the server controlls who is allowed to upload,
+shrine-cloudinary also supports generating presigns, which works with the
+direct_upload plugin in the same way that S3 does. When rendering on the server
+side, you can generate a presign inline:
+
+```erb
+<input name="file" type="file"
+   class="cloudinary-fileupload" data-cloudinary-field="image_id"
+   data-form-data="<%= Shrine.storages[:cache].presign.fields.to_json %>" ></input>
 ```
 
-### Direct uploads
+Alternatively you can add an endpoint to your app which can generate presigns
+on request, which is suitable for apps where templates are rendered on the
+client-side (see [direct_upload] documentation):
 
-Cloudinary supports uploading files directly to their service, thus bypassing
-your application. The easiest way to do that is to setup [direct unsigned
-uploads]. Follow the linked blog post for instructions, and see the [demo] app
-for a complete implementation.
+```rb
+Shrine.plugin :direct_upload, presign: true
+```
+```rb
+Rails.application.routes.draw do
+  mount ImageUploader::UploadEndpoint => "/attachments/images"
+end
+```
 
 ### Copying
 
@@ -79,7 +108,7 @@ If you want some [Cloudinary options] to be applied to all uploads, you can
 specify `:upload_options`:
 
 ```rb
-Shrine::Storage::Cloudinary.new(upload_options: {type: "authenticated"})
+Shrine::Storage::Cloudinary.new(upload_options: {backup: true})
 ```
 
 You can also apply upload options dynamically per upload using the
@@ -233,7 +262,7 @@ $ bundle exec rake test
 
 ## Inspiration
 
-This gem has been inspired by [cloudinary]'s CarrierWave integration.
+This gem has been inspired by Cloudinary's [CarrierWave integration].
 
 ## License
 
@@ -241,11 +270,11 @@ This gem has been inspired by [cloudinary]'s CarrierWave integration.
 
 [Cloudinary]: http://cloudinary.com/
 [Shrine]: https://github.com/janko-m/shrine
-[cloudinary]: https://github.com/cloudinary/cloudinary_gem
+[CarrierWave integration]: https://github.com/cloudinary/cloudinary_gem
 [Cloudinary options]: http://cloudinary.com/documentation/upload_images#remote_upload
 [Rails image manipulation]: http://cloudinary.com/documentation/rails_image_manipulation
 [responsive breakpoints]: http://cloudinary.com/blog/introducing_intelligent_responsive_image_breakpoints_solutions
 [explicit API]: http://cloudinary.com/documentation/image_upload_api_reference#explicit
-[direct unsigned uploads]: http://cloudinary.com/blog/direct_upload_made_easy_from_browser_or_mobile_app_to_the_cloud
 [demo]: /demo
 [control access]: http://cloudinary.com/documentation/upload_images#control_access_to_images
+[direct_upload]: http://shrinerb.com/rdoc/classes/Shrine/Plugins/DirectUpload.html

data/lib/shrine/storage/cloudinary.rb

@@ -69,7 +69,7 @@ class Shrine
       end
 
       def url(id, **options)
-        ::Cloudinary::Utils.cloudinary_url(path(id), default_options.merge(options))
+        ::Cloudinary::Utils.cloudinary_url(path(id), default_options.merge(secure: true, **options))
       end
 
       def clear!(**options)
@@ -80,6 +80,20 @@ class Shrine
         end
       end
 
+      def presign(id = nil, **options)
+        upload_options.update(@upload_options)
+        upload_options.update(id ? {public_id: public_id(id)} : {folder: prefix})
+
+        fields = ::Cloudinary::Uploader.build_upload_params(upload_options.merge(options))
+        fields.reject! { |key, value| value.nil? || value == "" }
+        fields[:signature] = ::Cloudinary::Utils.api_sign_request(fields, ::Cloudinary.config.api_secret)
+        fields[:api_key] = ::Cloudinary.config.api_key
+
+        url = ::Cloudinary::Utils.cloudinary_api_url("upload", default_options)
+
+        Struct.new(:url, :fields).new(url, fields)
+      end
+
       protected
 
       def public_id(id)

data/shrine-cloudinary.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "shrine-cloudinary"
-  gem.version       = "0.3.1"
+  gem.version       = "0.4.0"
 
   gem.required_ruby_version = ">= 2.1"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine-cloudinary
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-02 00:00:00.000000000 Z
+date: 2016-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrine