shrine-uploadcare 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66200985dae4d285580e9820867b1433fd9212573bf840b7afe0937ffda15809
-  data.tar.gz: cd080f6783e48d1daee215bd0b2cba70f9d9d3e9355fa9643907ab0745b74a12
+  metadata.gz: 826464c7fa00009924eb9b89da88c3fb66fcc9e1626b27c70a473f91ca4ca41e
+  data.tar.gz: 1ded6035d05ba1747284362a15e4f9066d327f40072b00168b472bb530293f16
 SHA512:
-  metadata.gz: 72048ded05537ca65af704be57c10b99833d91a2d5296a345d91bc0db82f908d6cb4f80dacce571ee56e39e2e37fbf823842b393baf2451614dba2c80642ae62
-  data.tar.gz: 2c9017d63e9f86ab45029fb7b64ecd22319803c379c66bb9d2de81e911290a9828a63d9b2faa08cf7082d5012a453faab5db750f9794abc1156bf3a2f17e8dda
+  metadata.gz: 9cfa46ced7eb2d3273dc008ca3c92989df3f6a08cd9db953d5e3a8fe489f0666a036183d3007afb58e1b3a3357747ec8f385b16afa3e9cb366815ae9ba4ebde7
+  data.tar.gz: 161ee61ee644f3d6bf5da0259f2206623fd19762d81d5c97c9552bf876acdee720bffb4fc6592bce10c6d6253a04410754164312b89acbd48739c701cbd3fd7c

data/README.md

@@ -8,7 +8,7 @@ with an advanced HTML widget for direct uploads.
 ## Installation
 
 ```ruby
-gem "shrine-uploadcare"
+gem "shrine-uploadcare", "~> 1.0"
 ```
 
 ## Usage
@@ -30,14 +30,11 @@ Shrine.storages = {
 
 ### Direct uploads
 
-Uploadcare supports uploading files directly to the service, freeing your
-application from accepting file uploads. The easiest way to do that is by using
-Uploadcare's [HTML widget], you can see how it can be used in the
-shrine-uploadcare [demo app].
+The `Shrine::Storage::Uploadcare` class implements the `#presign` method, so it
+should work with Shrine's [presign_endpoint] plugin and Uppy's [AwsS3] plugin.
 
-[Secure file uploads] are also supported, you can generate signatures with
-`#presign` on the storage, or using the [direct_upload plugin] with `presign:
-true`.
+If that doesn't work, you can always use Shrine's [upload_endpoint] plugin with
+Uppy's [XHRUpload] plugin.
 
 ### URL operations
 
@@ -48,49 +45,20 @@ photo.image_url(resize: "200x")
 photo.image_url(crop: ["200x300", :center])
 ```
 
-### Upload options
+### Metadata
 
-You can add upload options using the upload_options plugin or using
-`:upload_options` on the storage:
+Uploadcare metadata is automatically stored on upload:
 
-```rb
-Shrine::Storage::Uploadcare.new(upload_options: {...}, **uploadcare_options)
-```
-
-### Storing information
-
-You can have all Uploadcare file information saved in the uploaded file's
-metadata:
-
-```rb
-Shrine::Storage::Uploadcare.new(store_info: true, **uploadcare_options)
-```
 ```rb
 user = User.create(avatar: image_file)
-user.avatar.metadata["uploadcare"] #=>
+user.avatar.metadata
 # {
-#   "type" => "file",
-#   "result" => {
-#     "original_file_url" => "http://www.ucarecdn.com/d1d2dc43-4904-4783-bb4d-fbcf64264e63/image.png",
-#     "image_info" => {
-#       "height" => 45,
-#       "width" => 91,
-#       "geo_location" => null,
-#       "datetime_original" => null,
-#       "format" => "PNG"
-#     },
-#     "mime_type" => "image/png",
-#     "is_ready" => true,
-#     "url" => "https://api.uploadcare.com/files/d1d2dc43-4904-4783-bb4d-fbcf64264e63/",
-#     "uuid" => "d1d2dc43-4904-4783-bb4d-fbcf64264e63",
-#     "original_filename" => "image.png",
-#     "datetime_uploaded" => "2014-09-09T16:48:57.284Z",
-#     "size" => 12952,
-#     "is_image" => null,
-#     "datetime_stored" => "2014-09-09T16:48:57.291Z",
-#     "datetime_removed" => null,
-#     "source" => "/03ccf9ab-f266-43fb-973d-a6529c55c2ae/"
-#   }
+#   "height" => 45,
+#   "width" => 91,
+#   "geo_location" => null,
+#   "datetime_original" => null,
+#   "format" => "PNG",
+#   ...
 # }
 ```
 
@@ -126,8 +94,8 @@ $ rake test
 
 [Uploadcare]: https://uploadcare.com/
 [Shrine]: https://github.com/shrinerb/shrine
-[HTML widget]: https://uploadcare.com/documentation/widget/
-[demo app]: /demo
-[Secure file uploads]: https://uploadcare.com/documentation/upload/#secure-uploads
-[direct_upload plugin]: http://shrinerb.com/rdoc/classes/Shrine/Plugins/DirectUpload.html
 [URL operations]: https://uploadcare.com/documentation/cdn/
+[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/uploadcare.rb

@@ -9,159 +9,92 @@ class Shrine
     class Uploadcare
       Error = Class.new(StandardError)
 
-      attr_reader :uploadcare
+      attr_reader :api
 
-      def initialize(store_info: false, upload_options: {}, **options)
-        @uploadcare = ::Uploadcare::Api.new(api_version: "0.5", **options)
-        @store_info = store_info
-        @upload_options = upload_options
+      def initialize(**options)
+        @api = ::Uploadcare::Api.new(**options)
       end
 
       def upload(io, id, shrine_metadata: {}, **upload_options)
-        result = _upload(io, id, shrine_metadata: shrine_metadata, **upload_options)
-        update_metadata!(shrine_metadata, result)
-        update_id!(id, result)
+        file = _upload(io, id, shrine_metadata: shrine_metadata, **upload_options)
+        file.load_data
+
+        update_metadata!(shrine_metadata, file)
+        update_id!(id, file)
+
+        file
       end
 
       def open(id, **options)
         Down::Http.open(url(id), **options)
+      rescue Down::NotFound
+        raise Shrine::FileNotFound, "file #{id.inspect} not found on storage"
       end
 
       def exists?(id)
-        response = api_client.get("/files/#{id}/")
-        !!response.body["datetime_stored"]
+        file = api.file(id)
+        file.load_data
+        !!file.datetime_stored
       rescue ::Uploadcare::Error::RequestError::NotFound
         false
       end
 
       def delete(id)
-        api_client.delete("/files/#{id}/storage/")
+        file = api.file(id)
+        file.delete
       end
 
       def url(id, **options)
-        operations = options.to_a.map { |operation| operation.flatten.join("/") }
-        file(id, operations).cdn_url(true)
-      end
-
-      def clear!
-        response = api_client.get("/files/", stored: true, limit: 1000)
-        loop do
-          uuids = response.body["results"].map { |result| result.fetch("uuid") }
-          batch_delete(uuids) unless uuids.empty?
-          return if (next_url = response.body["next"]).nil?
-          response = api_client.get(URI(next_url).request_uri)
-        end
+        file = api.file(id)
+        file.operations = options.map { |operation| operation.flatten.join("/") }
+        file.cdn_url(true)
       end
 
       def presign(id = nil, **options)
         expire = Time.now.to_i + (options[:expires_in] || 60*60)
-        secret_key = uploadcare.options[:private_key]
+        secret_key = api.options[:private_key]
 
         signature = Digest::MD5.hexdigest(secret_key + expire.to_s)
 
         fields = {
-          UPLOADCARE_PUB_KEY: uploadcare.options[:public_key],
+          UPLOADCARE_PUB_KEY: api.options[:public_key],
           signature: signature,
           expire: expire,
         }
 
-        url = upload_client.url_prefix + "base/"
+        url = URI.join(api.options[:upload_url_base], "base/").to_s
 
         { method: :post, url: url, fields: fields }
       end
 
-      protected
-
-      def file(id, operations = [])
-        ::Uploadcare::Api::File.new(uploadcare, id, operations: operations)
+      def clear!
+        api.file_list(limit: 1000).each_slice(100) do |file_batch|
+          api.delete_files(file_batch)
+        end
       end
 
       private
 
-      def _upload(io, id, **options)
-        if uploadcare_file?(io)
-          store(io, id, **options)
-        else
-          create(io, id, **options)
-        end
-      end
-
-      def store(io, id, **options)
-        response = api_client.put "/files/#{io.id}/storage/"
-        response.body
-      end
+      def _upload(io, id, shrine_metadata: {}, **upload_options)
+        options = { store: true }
+        options.merge!(upload_options)
 
-      def create(io, id, **options)
         if remote_file?(io)
-          create_from_url(io, id, **options)
+          api.upload_from_url(io.url, options)
         else
-          create_from_file(io, id, **options)
-        end
-      end
-
-      def create_from_url(io, id, shrine_metadata: {}, **upload_options)
-        options = {source_url: io.url, store: 1, pub_key: uploadcare.options[:public_key]}
-        options.update(@upload_options).update(upload_options)
-        response = upload_client.post "/from_url/", options
-        token = response.body.fetch("token")
-
-        loop do
-          response = upload_client.get "/from_url/status/", token: token
-          raise Error, response.body["error"] if response.body["status"] == "error"
-          break response.body if response.body["status"] == "success"
-          sleep 0.5
-        end
-      rescue ::Uploadcare::Error::RequestError::Forbidden => error
-        raise Error, "You must allow \"automatic file storing\" in project settings"
-      end
-
-      def create_from_file(io, id, shrine_metadata: {}, **upload_options)
-        options = {UPLOADCARE_PUB_KEY: uploadcare.options[:public_key], UPLOADCARE_STORE: 1}
-        options.update(@upload_options).update(upload_options)
-        io = Faraday::UploadIO.new(io, shrine_metadata["mime_type"], shrine_metadata["filename"])
-        io.instance_eval { def length; size; end } # hack for multipart-post
-        response = upload_client.post "/base/", file: io, **options
-        {"uuid" => response.body.fetch("file")}
-      rescue ::Uploadcare::Error::RequestError::Forbidden => error
-        raise Error, "You must allow \"automatic file storing\" in project settings"
-      end
-
-      def batch_delete(ids)
-        ids.each_slice(100) do |ids_slice|
-          api_client.delete("/files/storage/") do |request|
-            request.body = ids_slice.to_json
-            request.headers["Content-Type"] = "application/json"
+          Shrine.with_file(io) do |file|
+            api.upload(file, options)
           end
         end
       end
 
-      def api_client
-        uploadcare.instance_variable_get("@api_connection")
+      def update_metadata!(metadata, file)
+        metadata.merge!(file.image_info.to_h)
+        metadata.merge!("mime_type" => file.mime_type, "size" => file.size)
       end
 
-      def upload_client
-        uploadcare.instance_variable_get("@upload_connection")
-      end
-
-      def update_metadata!(metadata, result)
-        retrieved_metadata = {
-          "mime_type" => result["mime_type"],
-          "width"     => result["image_info"] && result["image_info"]["width"],
-          "height"    => result["image_info"] && result["image_info"]["height"],
-          "size"      => result["size"],
-        }
-        retrieved_metadata.reject! { |key, value| value.nil? }
-        retrieved_metadata["uploadcare"] = result if @store_info
-
-        metadata.update(retrieved_metadata)
-      end
-
-      def update_id!(id, result)
-        id.replace(result.fetch("uuid"))
-      end
-
-      def uploadcare_file?(io)
-        io.is_a?(UploadedFile) && io.storage.is_a?(Storage::Uploadcare)
+      def update_id!(id, file)
+        id.replace(file.uuid)
       end
 
       def remote_file?(io)
@@ -170,3 +103,15 @@ class Shrine
     end
   end
 end
+
+module Uploadcare
+  module UploadingApi
+    class UploadParams
+      # fix determining MIME type
+      def extract_mime_type(file)
+        mime_type = MIME::Types.of(file.path).first
+        mime_type.content_type if mime_type
+      end
+    end
+  end
+end

data/shrine-uploadcare.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "shrine-uploadcare"
-  gem.version       = "0.3.1"
+  gem.version       = "1.0.0"
 
   gem.required_ruby_version = ">= 2.1"
 
@@ -13,9 +13,9 @@ 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", "< 4"
-  gem.add_dependency "uploadcare-ruby", "~> 1.0.5"
-  gem.add_dependency "down", "~> 4.4"
+  gem.add_dependency "shrine", ">= 3.0.0.rc", "< 4"
+  gem.add_dependency "uploadcare-ruby", "~> 2.1"
+  gem.add_dependency "down", "~> 5.0"
   gem.add_dependency "http", ">= 3.2", "< 5"
 
   gem.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine-uploadcare
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-25 00:00:00.000000000 Z
+date: 2019-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrine
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: 3.0.0.rc
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: 3.0.0.rc
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -36,28 +36,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: down
   requirement: !ruby/object:Gem::Requirement
     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