uppy-s3_multipart 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfe2ae799d5586b474000ff740cfc72d5e30ab0186098665ff50060693d3fc79
-  data.tar.gz: 4748896f3bcaae2f5de3b739e2cf1fe4d99754241165feff92cb4c6a2c92f486
+  metadata.gz: e799b2dfe2ad03929e1e6477382b85c4d721313708abe699673c2c3e496e98e8
+  data.tar.gz: 05d354cff6f1f5a9ae807faffdd91b29d5f16c62fba9abbec82038b7713a1a3a
 SHA512:
-  metadata.gz: 9b4fc57d8a84a1ce4b7444b20d99fc824ce7afe89dc4bb1da81765b24667ca5cacf53b289d8ee336c99530210f96d58ee839b10a425232505b19096007e385fd
-  data.tar.gz: 801e7e0f455a23d4db546898ed20b118a642279a7270988ace5cb39e5c15505a57eab6094c8eeb79f4b689ff88854cdfe5315655e105940cfb80ae3164487e6a
+  metadata.gz: 336d352eeeb31ac132c074ddb4febd73d75f47b5fe41ed69caafb90eecf1d43494f37542d06a1df2859210fe9907207456695c0a3c965131384564f93b0abaa9
+  data.tar.gz: 2ae94a045d3b19e1eabc99dce49ffcaadc1d806caf77cbc87b6edf5b771e1509d58c56a3510f5e1a44b15adfdbe5d93f19fc6acf5322d66bb22791aa5d80d043

data/README.md

@@ -10,7 +10,7 @@ uploads.
 Add the gem to your Gemfile:
 
 ```rb
-gem "uppy-s3_multipart"
+gem "uppy-s3_multipart", "~> 0.2"
 ```
 
 ## Setup
@@ -56,14 +56,14 @@ directly.
 
 ### Shrine
 
-In the initializer load the `uppy_s3_multipart` plugin:
+In your Shrine initializer load the `uppy_s3_multipart` plugin:
 
 ```rb
 require "shrine"
 require "shrine/storage/s3"
 
 Shrine.storages = {
-  cache: Shrine::Storage::S3.new(...),
+  cache: Shrine::Storage::S3.new(prefix: "cache", ...),
   store: Shrine::Storage::S3.new(...),
 }
 
@@ -78,11 +78,11 @@ inside your main application:
 ```rb
 # Rails (config/routes.rb)
 Rails.application.routes.draw do
-  mount Shrine.uppy_s3_multipart(:cache) => "/s3"
+  mount Shrine.uppy_s3_multipart(:cache) => "/s3/multipart"
 end
 
 # Rack (config.ru)
-map "/s3" do
+map "/s3/multipart" do
   run Shrine.uppy_s3_multipart(:cache)
 end
 ```
@@ -97,14 +97,20 @@ POST   /s3/multipart/:uploadId/complete
 DELETE /s3/multipart/:uploadId
 ```
 
-Finally, in your Uppy configuration point `serverUrl` to your app's URL:
+Now in your Uppy configuration point `serverUrl` to your app's URL:
 
 ```js
 // ...
 uppy.use(Uppy.AwsS3Multipart, {
   serverUrl: '/',
 })
+```
+
+In the `upload-success` Uppy callback you can then construct the Shrine
+uploaded file data (this example assumes your temporary Shrine S3 storage has
+`prefix: "cache"` set):
 
+```js
 uppy.on('upload-success', function (file, data, uploadURL) {
   var uploadedFileData = JSON.stringify({
     id: uploadURL.match(/\/cache\/([^\?]+)/)[1], // extract key without prefix
@@ -123,8 +129,22 @@ uppy.on('upload-success', function (file, data, uploadURL) {
 Shrine. From there you can swap the `presign_endpoint` + `AwsS3` code with the
 `uppy_s3_multipart` + `AwsS3Multipart` setup.**
 
-Both the plugin and method accepts `:options` for specifying additional options
-to the aws-sdk calls (read further for more details on these options):
+Note that by default **Shrine won't extract metadata from directly upload
+files**, instead it will just copy metadata that was extracted on the client
+side. See [this section][metadata direct uploads] for the rationale and
+instructions on how to opt in.
+
+If you want to make uploads public and have public URLs without query
+parameters returned, you can pass `public: true` to the Shrine storage (note
+that this is supported starting from Shrine 2.13).
+
+```rb
+Shrine::Storage::S3.new(public: true, **options)
+```
+
+Both the plugin and method accept `:options` for specifying additional options
+to the S3 client operations (see the [Client](#client) section for list of
+operations and options they accept):
 
 ```rb
 Shrine.plugin :uppy_s3_multipart, options: {
@@ -138,14 +158,11 @@ Shrine.uppy_s3_multipart(:cache, options: {
 })
 ```
 
-Note that by default **Shrine won't extract metadata from directly upload
-files**, instead it will just copy metadata that was extracted on the client
-side. See [this section][metadata direct uploads] for the rationale and
-instructions on how to opt in.
+In the dynamic version the yielded object is an instance of [`Rack::Request`].
 
-### Standalone
+### App
 
-You can also use `uppy-s3_multipart` without Shrine. Start by initializing the
+You can also use `uppy-s3_multipart` without Shrine, by initializing the
 `Uppy::S3Multipart::App` directly:
 
 ```rb
@@ -162,16 +179,16 @@ bucket = resource.bucket("my-bucket")
 UPPY_S3_MULTIPART_APP = Uppy::S3Multipart::App.new(bucket: bucket)
 ```
 
-and mount it in your app in the same way:
+You can mount it inside your main app in the same way:
 
 ```rb
 # Rails (config/routes.rb)
 Rails.application.routes.draw do
-  mount UPPY_S3_MULTIPART_APP => "/s3"
+  mount UPPY_S3_MULTIPART_APP => "/s3/multipart"
 end
 
 # Rack (config.ru)
-map "/s3" do
+map "/s3/multipart" do
   run UPPY_S3_MULTIPART_APP
 end
 ```
@@ -185,25 +202,34 @@ uppy.use(Uppy.AwsS3Multipart, {
 })
 ```
 
-The `Uppy::S3Mutipart::App` initializer accepts `:options` for specifying
-additional options to the aws-sdk calls (read further for more details on these
-options):
+If you want to make uploads public and have public URLs without query
+parameters returned, you can pass `public: true` to the app.
+
+```rb
+Uppy::S3Multipart::App.new(bucket: bucket, public: true)
+```
+
+You can also pass `:options` for specifying additional options to the S3 client
+operations (see the [Client](#client) section for list of operations and
+options they accept):
 
 ```rb
 Uppy::S3Multipart::App.new(bucket: bucket, options: {
-  create_multipart_upload: { acl: "public-read" }
+  create_multipart_upload: { acl: "public-read" } # static
 })
 
 # OR
 
 Uppy::S3Multipart::App.new(bucket: bucket, options: {
-  create_multipart_upload: -> (request) { { acl: "public-read" } }
+  create_multipart_upload: -> (request) { { acl: "public-read" } } # dynamic
 })
 ```
 
-### Custom implementation
+In the dynamic version the yielded object is an instance of [`Rack::Request`].
+
+### Client
 
-If you would rather implement the endpoints yourself, you can utilize
+If you would rather implement the endpoints yourself, you can utilize the
 `Uppy::S3Multipart::Client` to make S3 requests.
 
 ```rb
@@ -223,13 +249,13 @@ client.create_multipart_upload(key: "foo", **options)
 
 Accepts:
 
-* `:key` -- object key
+* `:key` – object key
 * additional options for [`Aws::S3::Client#create_multipart_upload`]
 
 Returns:
 
-* `:upload_id` -- id of the created multipart upload
-* `:key` -- object key
+* `:upload_id` – id of the created multipart upload
+* `:key` – object key
 
 #### `#list_parts`
 
@@ -244,17 +270,17 @@ client.list_parts(upload_id: "MultipartUploadId", key: "foo", **options)
 
 Accepts:
 
-* `:upload_id` -- multipart upload id
-* `:key` -- object key
+* `:upload_id` – multipart upload id
+* `:key` – object key
 * additional options for [`Aws::S3::Client#list_parts`]
 
 Returns:
 
 * array of parts
 
-  - `:part_number` -- position of the part
-  - `:size` -- filesize of the part
-  - `:etag` -- etag of the part
+  - `:part_number` – position of the part
+  - `:size` – filesize of the part
+  - `:etag` – etag of the part
 
 #### `#prepare_upload_part`
 
@@ -267,14 +293,14 @@ client.prepare_upload_part(upload_id: "MultipartUploadId", key: "foo", part_numb
 
 Accepts:
 
-* `:upload_id` -- multipart upload id
-* `:key` -- object key
-* `:part_number` -- number of the next part
+* `:upload_id` – multipart upload id
+* `:key` – object key
+* `:part_number` – number of the next part
 * additional options for [`Aws::S3::Client#upload_part`] and [`Aws::S3::Presigner#presigned_url`]
 
 Returns:
 
-* `:url` -- endpoint that should be used for uploading a new multipart part via a `PUT` request
+* `:url` – endpoint that should be used for uploading a new multipart part via a `PUT` request
 
 #### `#complete_multipart_upload`
 
@@ -287,14 +313,36 @@ client.complete_multipart_upload(upload_id: upload_id, key: key, parts: [{ part_
 
 Accepts:
 
-* `:upload_id` -- multipart upload id
-* `:key` -- object key
-* `:parts` -- list of all uploaded parts, consisting of `:part_number` and `:etag`
+* `:upload_id` – multipart upload id
+* `:key` – object key
+* `:parts` – list of all uploaded parts, consisting of `:part_number` and `:etag`
 * additional options for [`Aws::S3::Client#complete_multipart_upload`]
 
 Returns:
 
-* `:location` -- URL to the uploaded object
+* `:location` – URL to the uploaded object
+
+#### `#object_url`
+
+Generates URL to the object.
+
+```rb
+client.object_url(key: key, **options)
+# => "https://my-bucket.s3.amazonaws.com/foo?..."
+```
+
+This is called after `#complete_multipart_upload` in the app and returned in
+the response.
+
+Accepts:
+
+* `:key` – object key
+* `:public` – for generating a public URL (default is presigned expiring URL)
+* additional options for [`Aws::S3::Object#presigned_url`] and [`Aws::S3::Client#get_object`]
+
+Returns:
+
+* URL to the object
 
 #### `#abort_multipart_upload`
 
@@ -307,8 +355,8 @@ client.abort_multipart_upload(upload_id: upload_id, key: key, **options)
 
 Accepts:
 
-* `:upload_id` -- multipart upload id
-* `:key` -- object key
+* `:upload_id` – multipart upload id
+* `:key` – object key
 * additional options for [`Aws::S3::Client#abort_multipart_upload`]
 
 ## Contributing
@@ -331,10 +379,13 @@ License](https://opensource.org/licenses/MIT).
 [AwsS3Multipart]: https://uppy.io/docs/aws-s3-multipart/
 [Shrine]: https://shrinerb.com
 [Adding Direct S3 Uploads]: https://github.com/shrinerb/shrine/wiki/Adding-Direct-S3-Uploads
+[`Rack::Request`]: https://www.rubydoc.info/github/rack/rack/master/Rack/Request
 [`Aws::S3::Client#create_multipart_upload`]: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Client.html#create_multipart_upload-instance_method
 [`Aws::S3::Client#list_parts`]: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Client.html#list_parts-instance_method
 [`Aws::S3::Client#upload_part`]: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Client.html#upload_part-instance_method
 [`Aws::S3::Presigner#presigned_url`]: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Presigner.html#presigned_url-instance_method
 [`Aws::S3::Client#complete_multipart_upload`]: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Client.html#complete_multipart_upload-instance_method
+[`Aws::S3::Object#presigned_url`]: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#presigned_url-instance_method
+[`Aws::S3::Client#get_object`]: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Client.html#get_object-instance_method
 [`Aws::S3::Client#abort_multipart_upload`]: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Client.html#abort_multipart_upload-instance_method
 [metadata direct uploads]: https://github.com/shrinerb/shrine/blob/master/doc/metadata.md#direct-uploads

data/lib/shrine/plugins/uppy_s3_multipart.rb

@@ -15,12 +15,12 @@ class Shrine
             fail Error, "expected storage to be a Shrine::Storage::S3, but was #{s3.inspect}"
           end
 
-          ::Uppy::S3Multipart::App.new(
-            bucket:  s3.bucket,
-            prefix:  s3.prefix,
-            options: opts[:uppy_s3_multipart_options],
-            **options
-          )
+          options[:bucket]  ||= s3.bucket
+          options[:prefix]  ||= s3.prefix
+          options[:public]  ||= s3.public if s3.respond_to?(:public)
+          options[:options] ||= opts[:uppy_s3_multipart_options]
+
+          ::Uppy::S3Multipart::App.new(**options)
         end
       end
     end

data/lib/uppy/s3_multipart/app.rb

@@ -8,10 +8,11 @@ require "cgi"
 module Uppy
   module S3Multipart
     class App
-      def initialize(bucket:, prefix: nil, options: {})
+      def initialize(bucket:, prefix: nil, public: nil, options: {})
         @router = Class.new(Router)
         @router.opts[:client]  = Client.new(bucket: bucket)
         @router.opts[:prefix]  = prefix
+        @router.opts[:public]  = public
         @router.opts[:options] = options
       end
 
@@ -24,10 +25,14 @@ module Uppy
         plugin :json
         plugin :json_parser
         plugin :halt
+        plugin :path_rewriter
+
+        # allow mounting on "/s3" for backwards compatibility
+        rewrite_path "/multipart", ""
 
         route do |r|
-          # POST /multipart
-          r.post "multipart" do
+          # POST /s3/multipart
+          r.post true do
             content_type = r.params["type"]
             filename     = r.params["filename"]
 
@@ -38,13 +43,16 @@ module Uppy
             # CGI-escape the filename because aws-sdk's signature calculator trips on special characters
             content_disposition = "inline; filename=\"#{CGI.escape(filename)}\"" if filename
 
-            result = client_call(:create_multipart_upload, key: key, content_type: content_type, content_disposition: content_disposition)
+            options = { content_type: content_type, content_disposition: content_disposition }
+            options[:acl] = "public-read" if opts[:public]
+
+            result = client_call(:create_multipart_upload, key: key, **options)
 
             { uploadId: result.fetch(:upload_id), key: result.fetch(:key) }
           end
 
-          # GET /multipart/:uploadId
-          r.get "multipart", String do |upload_id|
+          # GET /s3/multipart/:uploadId
+          r.get String do |upload_id|
             key = param!("key")
 
             result = client_call(:list_parts, upload_id: upload_id, key: key)
@@ -54,8 +62,8 @@ module Uppy
             end
           end
 
-          # GET /multipart/:uploadId/:partNumber
-          r.get "multipart", String, String do |upload_id, part_number|
+          # GET /s3/multipart/:uploadId/:partNumber
+          r.get String, String do |upload_id, part_number|
             key = param!("key")
 
             result = client_call(:prepare_upload_part, upload_id: upload_id, key: key, part_number: part_number)
@@ -63,8 +71,8 @@ module Uppy
             { url: result.fetch(:url) }
           end
 
-          # POST /multipart/:uploadId/complete
-          r.post "multipart", String, "complete" do |upload_id|
+          # POST /s3/multipart/:uploadId/complete
+          r.post String, "complete" do |upload_id|
             key   = param!("key")
             parts = param!("parts")
 
@@ -72,17 +80,19 @@ module Uppy
               begin
                 { part_number: part.fetch("PartNumber"), etag: part.fetch("ETag") }
               rescue KeyError
-                r.halt 400, { error: "At least one part is missing \"PartNumber\" or \"ETag\" field" }
+                error! "At least one part is missing \"PartNumber\" or \"ETag\" field"
               end
             end
 
-            result = client_call(:complete_multipart_upload, upload_id: upload_id, key: key, parts: parts)
+            client_call(:complete_multipart_upload, upload_id: upload_id, key: key, parts: parts)
+
+            object_url = client_call(:object_url, key: key, public: opts[:public])
 
-            { location: result.fetch(:location) }
+            { location: object_url }
           end
 
-          # DELETE /multipart/:uploadId
-          r.delete "multipart", String do |upload_id|
+          # DELETE /s3/multipart/:uploadId
+          r.delete String do |upload_id|
             key = param!("key")
 
             client_call(:abort_multipart_upload, upload_id: upload_id, key: key)
@@ -105,10 +115,14 @@ module Uppy
         def param!(name)
           value = request.params[name]
 
-          request.halt 400, { error: "Missing \"#{name}\" parameter" } if value.nil?
+          error! "Missing \"#{name}\" parameter" if value.nil?
 
           value
         end
+
+        def error!(message)
+          request.halt 400, { error: message }
+        end
       end
     end
   end

data/lib/uppy/s3_multipart/client.rb

@@ -43,7 +43,15 @@ module Uppy
           **options
         )
 
-        { location: object(key).presigned_url(:get) }
+        { location: object_url(key: key) }
+      end
+
+      def object_url(key:, public: nil, **options)
+        if public
+          object(key).public_url(**options)
+        else
+          object(key).presigned_url(:get, **options)
+        end
       end
 
       def abort_multipart_upload(upload_id:, key:, **options)

data/uppy-s3_multipart.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "uppy-s3_multipart"
-  gem.version       = "0.1.1"
+  gem.version       = "0.2.0"
 
   gem.required_ruby_version = ">= 2.2"
 
@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rake"
   gem.add_development_dependency "minitest"
   gem.add_development_dependency "rack-test_app"
-  gem.add_development_dependency "shrine", "~> 2.0"
+  gem.add_development_dependency "shrine", "~> 2.13"
   gem.add_development_dependency "shrine-memory"
   gem.add_development_dependency "aws-sdk-core", "~> 3.23"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uppy-s3_multipart
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-20 00:00:00.000000000 Z
+date: 2018-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roda
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.13'
 - !ruby/object:Gem::Dependency
   name: shrine-memory
   requirement: !ruby/object:Gem::Requirement