shrine-cloudinary 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62bb38b8c926704c9eada728c344f4586c33689933308ca052fc6b40c0091931
-  data.tar.gz: 408d13255233be4a9c90a82afe9122d855b3848c08d615f0eb1a8d78c582ea52
+  metadata.gz: 6fd427e7ba7152f8dcaa9d77157e5d6ab22ab48074ba06a3ed00523f81849ff7
+  data.tar.gz: 3b0c58833d9d2894b23633c365c9feff1fdf0e123f47cef0e8727e295ed96cfd
 SHA512:
-  metadata.gz: 29e2db03ac2395c2bb2046f993aa4b95b087f95ae6b3ac349d79301c39ece7e782f5ecd6d9aeb89cb5895a9f454b0f97b63b597ec19e7c139fd03707437e852f
-  data.tar.gz: fc5c41d4be4902f1eb08589ffeadfca966a121a58a4ad5de3ac2df2f1954cb2f91d1911a12a8fbb504d017ce6d35a20b615996b1333055e7984db530d3c4a297
+  metadata.gz: 3cf2577f5450d758fcedd96b64a10daf73316d2842a7d1bc16c0c7e44dbb96a3562af4ba77da0721e333e93e2456a0426f535d4cff6f28d224ee22069aced825
+  data.tar.gz: 92e263bf7b5cd8905f7834f4ed12a64b892e36adc8a3bc7235db464cd43c33edb390ba10e366068cc5b9c556b75ce004200a11be2c269f432ce5c78f1060d180

data/README.md

@@ -9,7 +9,7 @@ an HTML widget for direct uploads.
 ## Installation
 
 ```ruby
-gem "shrine-cloudinary"
+gem "shrine-cloudinary", "~> 1.1"
 ```
 
 ## Usage
@@ -29,47 +29,17 @@ Cloudinary.config(
 
 Shrine.storages = {
   cache: Shrine::Storage::Cloudinary.new(prefix: "cache"), # for direct uploads
-  store: Shrine::Storage::Cloudinary.new(prefix: "store"),
+  store: Shrine::Storage::Cloudinary.new,
 }
 ```
 
 ### Direct uploads
 
-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:
+The `Shrine::Storage::Cloudinary` class implements the `#presign` method, so it
+should work with Shrine's [presign_endpoint] plugin and Uppy's [AwsS3] plugin.
 
-* [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".
-
-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 %>">
-```
-
-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):
-
-```rb
-Shrine.plugin :direct_upload, presign: true
-```
-```rb
-Rails.application.routes.draw do
-  mount ImageUploader::UploadEndpoint => "/attachments/images"
-end
-```
+If that doesn't work, you can always use Shrine's [upload_endpoint] plugin with
+Uppy's [XHRUpload] plugin.
 
 ### Copying
 
@@ -109,7 +79,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: {backup: true})
+Shrine::Storage::Cloudinary.new(upload_options: { backup: true })
 ```
 
 You can also apply upload options dynamically per upload using the
@@ -122,8 +92,8 @@ class MyUploader < Shrine
     {
       format: "png",
       eager: [
-        {width: 500, height: 500, crop: :scale},
-        {width: 300, height: 300, crop: :crop, gravity: :south},
+        { width: 500, height: 500, crop: :scale },
+        { width: 300, height: 300, crop: :crop, gravity: :south },
       ]
     }
   end
@@ -133,7 +103,7 @@ end
 Finally, you can pass upload options when using the uploader directly:
 
 ```rb
-uploader.upload(file, upload_options: {format: "png"})
+uploader.upload(file, upload_options: { format: "png" })
 ```
 
 ### URLs
@@ -189,7 +159,7 @@ for images. In Shrine you can leverage this via `:upload_options` and
 
 ```rb
 Shrine::Storage::Cloudinary.new(
-  upload_options: {responsive_breakpoints: {...}},
+  upload_options: { responsive_breakpoints: {...} },
   store_data: true,
 )
 ```
@@ -218,7 +188,7 @@ If the `:responsive_breakpoints` value needs to be dynamic, you can use the
 
 ```rb
 Shrine.plugin :upload_options, store: -> (io, context) do
-  {responsive_breakpoints: {...}}
+  { responsive_breakpoints: {...} }
 end
 ```
 
@@ -238,8 +208,8 @@ The default chunk size is 20 MB, but you can change that by passing
 
 ```rb
 Shrine::Storage::Cloudinary.new(
-  large: 100*1024*1024                      # 100 MB
-  upload_options: {chunk_size: 5*1024*1204} # 5 MB
+  large: 100*1024*1024                        # 100 MB
+  upload_options: { chunk_size: 5*1024*1204 } # 5 MB
 )
 ```
 
@@ -298,6 +268,8 @@ This gem has been inspired by Cloudinary's [CarrierWave integration].
 [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
-[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
+[presign_endpoint]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/presign_endpoint.md#readme
+[upload_endpoint]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/upload_endpoint.md#readme
+[AwsS3]: https://uppy.io/docs/aws-s3/
+[XHRUpload]: https://uppy.io/docs/xhr-upload/

data/lib/shrine/storage/cloudinary.rb

@@ -18,9 +18,8 @@ class Shrine
 
       def upload(io, id, shrine_metadata: {}, **upload_options)
         options = { public_id: public_id(id) }
-        options.update(default_options)
-        options.update(@upload_options)
-        options.update(upload_options)
+        options.merge!(@upload_options)
+        options.merge!(upload_options)
 
         result = store(io, **options)
 
@@ -31,52 +30,47 @@ class Shrine
       end
 
       def update(id, **options)
-        ::Cloudinary::Uploader.explicit(public_id(id), default_options.merge(options))
-      end
-
-      def move(io, id, shrine_metadata: {}, **upload_options)
-        ::Cloudinary::Uploader.rename(io.storage.public_id(io.id), public_id(id), default_options)
-      end
-
-      def movable?(io, id)
-        io.is_a?(UploadedFile) && io.storage.is_a?(Storage::Cloudinary)
+        uploader.explicit(public_id(id), **options)
       end
 
       def open(id, **options)
         Down::Http.open(url(id, sign_url: true), **options)
+      rescue Down::NotFound
+        raise Shrine::FileNotFound, "file #{id.inspect} not found on storage"
       end
 
       def exists?(id)
-        result = ::Cloudinary::Api.resources_by_ids([public_id(id)], default_options)
+        result = api.resources_by_ids([public_id(id)])
         result.fetch("resources").any?
       end
 
       def delete(id)
-        ::Cloudinary::Uploader.destroy(public_id(id), default_options)
+        uploader.destroy(public_id(id))
       end
 
       def url(id, **options)
-        ::Cloudinary::Utils.cloudinary_url(path(id), default_options.merge(secure: true, **options))
+        utils.cloudinary_url(path(id), secure: true, **options)
       end
 
       def clear!(**options)
         if prefix
-          ::Cloudinary::Api.delete_resources_by_prefix(prefix, default_options.merge(options))
+          api.delete_resources_by_prefix(prefix, **options)
         else
-          ::Cloudinary::Api.delete_all_resources(default_options.merge(options))
+          api.delete_all_resources(**options)
         end
       end
 
-      def presign(id = nil, **options)
-        upload_options = id ? { public_id: public_id(id) } : { folder: prefix }
-        upload_options.update(@upload_options)
+      def presign(id = nil, **presign_options)
+        options = id ? { public_id: public_id(id) } : { folder: prefix }
+        options.merge!(@upload_options)
+        options.merge!(presign_options)
 
-        fields = ::Cloudinary::Uploader.build_upload_params(upload_options.merge(options))
+        fields = ::Cloudinary::Uploader.build_upload_params(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
+        fields[:api_key]   = ::Cloudinary.config.api_key
 
-        url = ::Cloudinary::Utils.cloudinary_api_url("upload", default_options)
+        url = utils.cloudinary_api_url("upload")
 
         { method: :post, url: url, fields: fields }
       end
@@ -99,18 +93,22 @@ class Shrine
 
       def store(io, chunk_size: nil, **options)
         if remote?(io)
-          ::Cloudinary::Uploader.upload(io.url, **options)
+          uploader.upload(io.url, **options)
         else
           make_rest_client_recognize_as_file!(io)
           if large?(io)
             io.instance_eval { def match(*); false; end } # https://github.com/cloudinary/cloudinary_gem/pull/260
-            ::Cloudinary::Uploader.upload_large(io, chunk_size: chunk_size, **options)
+            uploader.upload_large(io, chunk_size: chunk_size, **options)
           else
-            ::Cloudinary::Uploader.upload(io, **options)
+            uploader.upload(io, **options)
           end
         end
       end
 
+      def uploader; Delegator.new(::Cloudinary::Uploader, default_options); end
+      def api;      Delegator.new(::Cloudinary::Api,      default_options); end
+      def utils;    Delegator.new(::Cloudinary::Utils,    default_options); end
+
       def remote?(io)
         io.is_a?(UploadedFile) && io.url.to_s =~ /^ftp:|^https?:/
       end
@@ -175,6 +173,23 @@ class Shrine
         "mpeg" => "video/mpeg",
         "avi"  => "video/x-msvideo",
       }
+
+      # Delegates each method call to the specified klass, but passing
+      # specified default options.
+      class Delegator
+        def initialize(klass, default_options)
+          @klass           = klass
+          @default_options = default_options
+        end
+
+        def method_missing(name, *args, **options, &block)
+          @klass.public_send(name, *args, **@default_options, **options, &block)
+        end
+
+        def respond_to_missing?(name, include_private = false)
+          @klass.respond_to?(name, include_private)
+        end
+      end
     end
   end
 end

data/shrine-cloudinary.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "shrine-cloudinary"
-  gem.version       = "1.0.2"
+  gem.version       = "1.1.0"
 
   gem.required_ruby_version = ">= 2.1"
 
@@ -13,10 +13,10 @@ Gem::Specification.new do |gem|
   gem.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "*.gemspec"]
   gem.require_path = "lib"
 
-  gem.add_dependency "shrine", "~> 2.11"
+  gem.add_dependency "shrine", ">= 3.0.0.rc", "< 4"
   gem.add_dependency "cloudinary", "< 2"
-  gem.add_dependency "down", "~> 4.4"
-  gem.add_dependency "http", ">= 3.2"
+  gem.add_dependency "down", "~> 5.0"
+  gem.add_dependency "http", ">= 3.2", "< 5"
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "minitest"

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: shrine-cloudinary
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-04 00:00:00.000000000 Z
+date: 2019-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: 3.0.0.rc
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: cloudinary
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -59,6 +65,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -66,6 +75,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement