uppy-s3_multipart 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c747885d4a3c5e57af416694daa5ad809831f42a73e03ea0f72c6be2106bca4b
-  data.tar.gz: 3dfdb337a8d1ff8f9096018233435d4e3a8b1cc71092ca10fae0582b660e1d1a
+  metadata.gz: dfe2ae799d5586b474000ff740cfc72d5e30ab0186098665ff50060693d3fc79
+  data.tar.gz: 4748896f3bcaae2f5de3b739e2cf1fe4d99754241165feff92cb4c6a2c92f486
 SHA512:
-  metadata.gz: 8366713f060f860ecaaf98177751471a3cbab32bcb4e29414fea742a13bd90ffa6b46845371a10c4deb90273bdfe0a5c5c6db68f579ad6d502f479dcd2fbc4bc
-  data.tar.gz: e2aa4485b564ba814ddea95b0d77d8872b9afde9baedbd2c0c298cd5434054c2bc56ce6eac48722cddd9719a7bc3f44ccecba696a8f34a1bd86297c72fbec47d
+  metadata.gz: 9b4fc57d8a84a1ce4b7444b20d99fc824ce7afe89dc4bb1da81765b24667ca5cacf53b289d8ee336c99530210f96d58ee839b10a425232505b19096007e385fd
+  data.tar.gz: 801e7e0f455a23d4db546898ed20b118a642279a7270988ace5cb39e5c15505a57eab6094c8eeb79f4b689ff88854cdfe5315655e105940cfb80ae3164487e6a

data/README.md

@@ -15,32 +15,38 @@ gem "uppy-s3_multipart"
 
 ## Setup
 
-Once you've created your S3 bucket, you need to set up CORS for it. The
-following script sets up minimal CORS configuration needed for multipart
-uploads on your bucket using the `aws-sdk-s3` gem:
-
-```rb
-require "aws-sdk-s3"
-
-client = Aws::S3::Client.new(
-  access_key_id:     "<YOUR KEY>",
-  secret_access_key: "<YOUR SECRET>",
-  region:            "<REGION>",
-)
-
-client.put_bucket_cors(
-  bucket: "<YOUR BUCKET>",
-  cors_configuration: {
-    cors_rules: [{
-      allowed_headers: ["Authorization", "Content-Type", "Origin", "ETag"],
-      allowed_methods: ["GET", "POST", "PUT", "DELETE"],
-      allowed_origins: ["*"],
-      max_age_seconds: 3000,
-    }]
-  }
-)
+In order to allow direct multipart uploads to your S3 bucket, we need to update
+the bucket's CORS configuration. In the AWS S3 Console go to your bucket, click
+on "Permissions" tab and then on "CORS configuration". There paste in the
+following:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<CORSConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
+  <CORSRule>
+    <AllowedOrigin>https://my-app.com</AllowedOrigin>
+    <AllowedMethod>GET</AllowedMethod>
+    <AllowedMethod>POST</AllowedMethod>
+    <AllowedMethod>PUT</AllowedMethod>
+    <MaxAgeSeconds>3000</MaxAgeSeconds>
+    <AllowedHeader>Authorization</AllowedHeader>
+    <AllowedHeader>x-amz-date</AllowedHeader>
+    <AllowedHeader>x-amz-content-sha256</AllowedHeader>
+    <AllowedHeader>content-type</AllowedHeader>
+    <ExposeHeader>ETag</ExposeHeader>
+  </CORSRule>
+  <CORSRule>
+    <AllowedOrigin>*</AllowedOrigin>
+    <AllowedMethod>GET</AllowedMethod>
+    <MaxAgeSeconds>3000</MaxAgeSeconds>
+  </CORSRule>
+</CORSConfiguration>
 ```
 
+Replace `https://my-app.com` with the URL to your app (in development you can
+set this to `*`). Once you've hit "Save", it may take some time for the new
+CORS settings to be applied.
+
 ## Usage
 
 This gem provides a Rack application that you can mount inside your main
@@ -91,15 +97,32 @@ POST   /s3/multipart/:uploadId/complete
 DELETE /s3/multipart/:uploadId
 ```
 
-Finally, in your Uppy configuration pass your app's URL as the `serverUrl`:
+Finally, in your Uppy configuration point `serverUrl` to your app's URL:
 
 ```js
 // ...
 uppy.use(Uppy.AwsS3Multipart, {
-  serverUrl: "https://your-app.com/",
+  serverUrl: '/',
+})
+
+uppy.on('upload-success', function (file, data, uploadURL) {
+  var uploadedFileData = JSON.stringify({
+    id: uploadURL.match(/\/cache\/([^\?]+)/)[1], // extract key without prefix
+    storage: 'cache',
+    metadata: {
+      size:      file.size,
+      filename:  file.name,
+      mime_type: file.type,
+    }
+  })
+  // ...
 })
 ```
 
+**See [Adding Direct S3 Uploads] for an example of a complete Uppy setup with
+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):
 
@@ -115,9 +138,15 @@ 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.
+
 ### Standalone
 
-You can also initialize `Uppy::S3Multipart::App` directly:
+You can also use `uppy-s3_multipart` without Shrine. Start by initializing the
+`Uppy::S3Multipart::App` directly:
 
 ```rb
 require "uppy/s3_multipart"
@@ -147,12 +176,12 @@ map "/s3" do
 end
 ```
 
-In your Uppy configuration point the `serverUrl` to your application:
+In your Uppy configuration point `serverUrl` to your app's URL:
 
 ```js
 // ...
 uppy.use(Uppy.AwsS3Multipart, {
-  serverUrl: "https://your-app.com/",
+  serverUrl: '/',
 })
 ```
 
@@ -189,7 +218,7 @@ Initiates a new multipart upload.
 
 ```rb
 client.create_multipart_upload(key: "foo", **options)
-#=> { upload_id: "MultipartUploadId", key: "foo" }
+# => { upload_id: "MultipartUploadId", key: "foo" }
 ```
 
 Accepts:
@@ -208,9 +237,9 @@ Retrieves currently uploaded parts of a multipart upload.
 
 ```rb
 client.list_parts(upload_id: "MultipartUploadId", key: "foo", **options)
-#=> [ { part_number: 1, size: 5402383, etag: "etag1" },
-#     { part_number: 2, size: 5982742, etag: "etag2" },
-#     ... ]
+# => [ { part_number: 1, size: 5402383, etag: "etag1" },
+#      { part_number: 2, size: 5982742, etag: "etag2" },
+#      ... ]
 ```
 
 Accepts:
@@ -233,7 +262,7 @@ Returns the endpoint that should be used for uploading a new multipart part.
 
 ```rb
 client.prepare_upload_part(upload_id: "MultipartUploadId", key: "foo", part_number: 1, **options)
-#=> { url: "https://my-bucket.s3.amazonaws.com/foo?partNumber=1&uploadId=MultipartUploadId&..." }
+# => { url: "https://my-bucket.s3.amazonaws.com/foo?partNumber=1&uploadId=MultipartUploadId&..." }
 ```
 
 Accepts:
@@ -253,7 +282,7 @@ Finalizes the multipart upload and returns URL to the object.
 
 ```rb
 client.complete_multipart_upload(upload_id: upload_id, key: key, parts: [{ part_number: 1, etag: "etag1" }], **options)
-#=> { location: "https://my-bucket.s3.amazonaws.com/foo?..." }
+# => { location: "https://my-bucket.s3.amazonaws.com/foo?..." }
 ```
 
 Accepts:
@@ -273,7 +302,7 @@ Aborts the multipart upload, removing all parts uploaded so far.
 
 ```rb
 client.abort_multipart_upload(upload_id: upload_id, key: key, **options)
-#=> {}
+# => {}
 ```
 
 Accepts:
@@ -301,9 +330,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
 [`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::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

@@ -1,7 +1,5 @@
 require "uppy/s3_multipart"
 
-require "securerandom"
-
 class Shrine
   module Plugins
     module UppyS3Multipart
@@ -13,6 +11,10 @@ class Shrine
         def uppy_s3_multipart(storage_key, **options)
           s3 = find_storage(storage_key)
 
+          unless defined?(Shrine::Storage::S3) && s3.is_a?(Shrine::Storage::S3)
+            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,

data/uppy-s3_multipart.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "uppy-s3_multipart"
-  gem.version       = "0.1.0"
+  gem.version       = "0.1.1"
 
   gem.required_ruby_version = ">= 2.2"
 
@@ -20,5 +20,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "minitest"
   gem.add_development_dependency "rack-test_app"
   gem.add_development_dependency "shrine", "~> 2.0"
+  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.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-27 00:00:00.000000000 Z
+date: 2018-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roda
@@ -100,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: shrine-memory
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
   requirement: !ruby/object:Gem::Requirement