uppy-s3_multipart 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e799b2dfe2ad03929e1e6477382b85c4d721313708abe699673c2c3e496e98e8
-  data.tar.gz: 05d354cff6f1f5a9ae807faffdd91b29d5f16c62fba9abbec82038b7713a1a3a
+  metadata.gz: c3d7712b2f5d9b2dd18d9bf4292905a2d2e75acf33b59088162313b762b870fc
+  data.tar.gz: 2677578c6ca2c73fe65c64ba779bfd9a7d00501e7f93da85576ce9364800cdef
 SHA512:
-  metadata.gz: 336d352eeeb31ac132c074ddb4febd73d75f47b5fe41ed69caafb90eecf1d43494f37542d06a1df2859210fe9907207456695c0a3c965131384564f93b0abaa9
-  data.tar.gz: 2ae94a045d3b19e1eabc99dce49ffcaadc1d806caf77cbc87b6edf5b771e1509d58c56a3510f5e1a44b15adfdbe5d93f19fc6acf5322d66bb22791aa5d80d043
+  metadata.gz: af9554216d54735f7ee792bdd08194b950fa3f43730b085898a8b447bb51648be03f1bae126beb2f0ff3234186b422ba7dc363c5eba051aa9bc3df88e412b2a8
+  data.tar.gz: 12ea6a1d7a75b90c6b30a001c4215ef4ed5b6026b9e2f8e4b41dfe94041351b539f6680851b18361682d5ad1f61345b76081a3d907940e1aa4dcffbb6f969cda

data/README.md

@@ -71,8 +71,8 @@ Shrine.storages = {
 Shrine.plugin :uppy_s3_multipart # load the plugin
 ```
 
-The plugin will provide a `Shrine.uppy_s3_multipart` method, which returns an
-instance of `Uppy::S3Multipart::App`, which is a Rack app that you can mount
+The plugin will provide a `Shrine.uppy_s3_multipart` method that creates a new
+`Uppy::S3Multipart::App` instance, which is a Rack app that you can mount
 inside your main application:
 
 ```rb
@@ -87,16 +87,6 @@ map "/s3/multipart" do
 end
 ```
 
-This will add the routes that the `AwsS3Multipart` Uppy plugin expects:
-
-```
-POST   /s3/multipart
-GET    /s3/multipart/:uploadId
-GET    /s3/multipart/:uploadId/:partNumber
-POST   /s3/multipart/:uploadId/complete
-DELETE /s3/multipart/:uploadId
-```
-
 Now in your Uppy configuration point `serverUrl` to your app's URL:
 
 ```js
@@ -129,36 +119,10 @@ 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.**
 
-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: {
-  create_multipart_upload: { acl: "public-read" } # static
-}
-
-# OR
-
-Shrine.uppy_s3_multipart(:cache, options: {
-  create_multipart_upload: -> (request) { { acl: "public-read" } } # dynamic
-})
-```
-
-In the dynamic version the yielded object is an instance of [`Rack::Request`].
+Note that **Shrine won't extract metadata from directly upload files on
+assignment** by default. 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.
 
 ### App
 
@@ -193,7 +157,17 @@ map "/s3/multipart" do
 end
 ```
 
-In your Uppy configuration point `serverUrl` to your app's URL:
+This will add the routes that the `AwsS3Multipart` Uppy plugin expects:
+
+```
+POST   /s3/multipart
+GET    /s3/multipart/:uploadId
+GET    /s3/multipart/:uploadId/:partNumber
+POST   /s3/multipart/:uploadId/complete
+DELETE /s3/multipart/:uploadId
+```
+
+Now in your Uppy configuration point `serverUrl` to your app's URL:
 
 ```js
 // ...
@@ -202,30 +176,153 @@ uppy.use(Uppy.AwsS3Multipart, {
 })
 ```
 
-If you want to make uploads public and have public URLs without query
-parameters returned, you can pass `public: true` to the app.
+### Configuration
+
+This section describe various configuration options that you can pass to
+`Uppy::S3Multipart::App`.
+
+#### `:bucket`
+
+The `:bucket` option is mandatory and accepts an instance of `Aws::S3::Bucket`.
+It's easiest to create an `Aws::S3::Resource`, and call `#bucket` on it.
 
 ```rb
-Uppy::S3Multipart::App.new(bucket: bucket, public: true)
+require "uppy/s3_multipart"
+
+resource = Aws::S3::Resource.new(
+  access_key_id:     "<ACCESS_KEY_ID>",
+  secret_access_key: "<SECRET_ACCESS_KEY>",
+  region:            "<REGION>",
+)
+
+bucket = resource.bucket("<BUCKET>")
+
+Uppy::S3MUltipart::App.new(bucket: bucket)
 ```
 
-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):
+If you want to use [Minio], you can easily configure your `Aws::S3::Bucket` to
+point to your Minio server:
 
 ```rb
-Uppy::S3Multipart::App.new(bucket: bucket, options: {
-  create_multipart_upload: { acl: "public-read" } # static
-})
+resource = Aws::S3::Resource.new(
+  access_key_id:     "<MINIO_ACCESS_KEY>", # "AccessKey" value
+  secret_access_key: "<MINIO_SECRET_KEY>", # "SecretKey" value
+  endpoint:          "<MINIO_ENDPOINT>",   # "Endpoint"  value
+  region:            "us-east-1",
+  force_path_style:  true,
+)
+
+bucket = resource.bucket("<MINIO_BUCKET>") # name of the bucket you created
+```
+
+See the [`Aws::S3::Client#initialize`] docs for all supported configuration
+options. In the Shrine plugin this option is inferred from the S3 storage.
+
+#### `:prefix`
 
-# OR
+The `:prefix` option allows you to specify a directory which you want the files
+to be uploaded to.
 
+```rb
+Uppy::S3Multipart::App.new(bucket: bucket, prefix: "cache")
+```
+
+In the Shrine plugin this option is inferred from the S3 storage:
+
+```rb
+Shrine.storages = {
+  cache: Shrine::Storage::S3.new(prefix: "cache", **options),
+  store: Shrine::Storage::S3.new(**options),
+}
+```
+
+#### `:options`
+
+The `:options` option allows you to pass additional parameters to [Client]
+operations. With the Shrine plugin they can be passed when initializing the
+plugin:
+
+```rb
+Shrine.plugin :uppy_s3_multipart, options: { ... }
+```
+
+or when creating the app:
+
+```rb
+Shrine.uppy_s3_multipart(:cache, options: { ... })
+```
+
+In the end they are just forwarded to `Uppy::S3Multipart::App#initialize`:
+
+```rb
+Uppy::S3Multipart::App.new(bucket: bucket, options: { ... })
+```
+
+In the `:options` hash keys are [Client] operation names, and values are the
+parameters. The parameters can be provided statically:
+
+```rb
+options: {
+  create_multipart_upload: { cache_control: "max-age=#{365*24*60*60}" },
+}
+```
+
+or generated dynamically for each request:
+
+```rb
+options: {
+  create_multipart_upload: -> (request) do
+    { key: SecureRandom.uuid }
+  end
+}
+```
+
+In that case a [`Rack::Request`] object is also passed to the block. The
+initial request to `POST /s3/multipart` will contain `type` and `filename`
+query parameters, so for example you could use that to make requesting the URL
+later force a download with the original filename (using the
+[content_disposition] gem):
+
+```rb
+options: {
+  create_multipart_upload: -> (request) do
+    filename = request.params["filename"]
+
+    { content_disposition: ContentDisposition.attachment(filename) }
+  end
+}
+```
+
+See the [Client] section for list of operations and parameters they accept.
+
+#### `:public`
+
+The `:public` option sets the ACL of uploaded objects to `public-read`, and
+makes sure the object URL returned at the end is a public non-expiring URL
+without query parameters.
+
+```rb
+Uppy::S3Multipart::App.new(bucket: bucket, public: true)
+```
+
+It's really just a shorthand for:
+
+```rb
 Uppy::S3Multipart::App.new(bucket: bucket, options: {
-  create_multipart_upload: -> (request) { { acl: "public-read" } } # dynamic
+  create_multipart_upload: { acl: "public-read" },
+  object_url: { public: true },
 })
 ```
 
-In the dynamic version the yielded object is an instance of [`Rack::Request`].
+In the Shrine plugin this option is inferred from the S3 storage (available
+from Shrine 2.13):
+
+```rb
+Shrine.storages = {
+  cache: Shrine::Storage::S3.new(prefix: "cache", public: true, **options),
+  store: Shrine::Storage::S3.new(**options),
+}
+```
 
 ### Client
 
@@ -379,7 +476,11 @@ 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
+[Minio]: https://minio.io/
+[Client]: #client
+[content_disposition]: https://github.com/shrinerb/content_disposition
 [`Rack::Request`]: https://www.rubydoc.info/github/rack/rack/master/Rack/Request
+[`Aws::S3::Client#initialize`]: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Client.html#initialize-instance_method
 [`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

data/lib/uppy/s3_multipart/app.rb

@@ -1,9 +1,9 @@
 require "uppy/s3_multipart/client"
 
 require "roda"
+require "content_disposition"
 
 require "securerandom"
-require "cgi"
 
 module Uppy
   module S3Multipart
@@ -40,8 +40,7 @@ module Uppy
             key       = SecureRandom.hex + extension
             key       = "#{opts[:prefix]}/#{key}" if opts[:prefix]
 
-            # CGI-escape the filename because aws-sdk's signature calculator trips on special characters
-            content_disposition = "inline; filename=\"#{CGI.escape(filename)}\"" if filename
+            content_disposition = ContentDisposition.inline(filename) if filename
 
             options = { content_type: content_type, content_disposition: content_disposition }
             options[:acl] = "public-read" if opts[:public]

data/uppy-s3_multipart.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
-  gem.name          = "uppy-s3_multipart"
-  gem.version       = "0.2.0"
+  gem.name         = "uppy-s3_multipart"
+  gem.version      = "0.3.0"
 
   gem.required_ruby_version = ">= 2.2"
 
@@ -15,6 +15,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "roda", ">= 2.27", "< 4"
   gem.add_dependency "aws-sdk-s3", "~> 1.0"
+  gem.add_dependency "content_disposition", "~> 1.0"
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "minitest"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uppy-s3_multipart
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-08 00:00:00.000000000 Z
+date: 2018-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roda
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: content_disposition
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement