Skip to content

U
uppy-s3_multipart
Unverified Commit f9165a37 by Janko Marohnić
Options

Allow and recommend mounting on "/s3/multipart"

This allows defining other /s3/* routes without potential clashes when Uppy::S3Multipart::App isn't mounted last. One example of such route is "/s3/params", which is called by the AWS S3 Uppy plugin. We still keep backwards compatibility for users that currently have it mounted on "/s3".
parent 3c97c5e4
Showing with 57 additions and 49 deletions
README.md
......@@ -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
```
......@@ -167,11 +167,11 @@ and mount it in your 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
```
......
lib/uppy/s3_multipart/app.rb
......@@ -24,10 +24,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"]
......@@ -43,8 +47,8 @@ module Uppy
{ 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 +58,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 +67,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")
......@@ -81,8 +85,8 @@ module Uppy
{ location: result.fetch(:location) }
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)
......
test/app_test.rb
......@@ -4,7 +4,11 @@ require "rack/test_app"
describe Uppy::S3Multipart::App do
def app
Rack::TestApp.wrap(Rack::Lint.new(@endpoint))
app = Rack::Builder.new
app.use Rack::Lint
app.run Rack::URLMap.new("/s3/multipart" => @endpoint)
Rack::TestApp.wrap(app)
end
before do
......@@ -15,9 +19,9 @@ describe Uppy::S3Multipart::App do
@s3 = @bucket.client
end
describe "POST /multipart" do
describe "POST /s3/multipart" do
it "creates a multipart upload" do
response = app.post "/multipart"
response = app.post "/s3/multipart"
assert_equal :create_multipart_upload, @s3.api_requests[0][:operation_name]
assert_match /^\w{32}$/, @s3.api_requests[0][:params][:key]
......@@ -26,7 +30,7 @@ describe Uppy::S3Multipart::App do
it "returns multipart upload id and key" do
@s3.stub_responses(:create_multipart_upload, { upload_id: "foo", key: "bar" })
response = app.post "/multipart"
response = app.post "/s3/multipart"
assert_equal 200, response.status
assert_equal "application/json", response.headers["Content-Type"]
......@@ -36,14 +40,14 @@ describe Uppy::S3Multipart::App do
end
it "handles 'type' JSON body parameter" do
response = app.post "/multipart", json: { type: "text/plain" }
response = app.post "/s3/multipart", json: { type: "text/plain" }
assert_equal :create_multipart_upload, @s3.api_requests[0][:operation_name]
assert_equal "text/plain", @s3.api_requests[0][:params][:content_type]
end
it "handles 'filename' JSON body parameter" do
response = app.post "/multipart", json: { filename: "nature.jpg" }
response = app.post "/s3/multipart", json: { filename: "nature.jpg" }
assert_equal :create_multipart_upload, @s3.api_requests[0][:operation_name]
assert_equal "inline; filename=\"nature.jpg\"", @s3.api_requests[0][:params][:content_disposition]
......@@ -54,7 +58,7 @@ describe Uppy::S3Multipart::App do
it "handles :prefix option" do
@endpoint = Uppy::S3Multipart::App.new(bucket: @bucket, prefix: "prefix")
response = app.post "/multipart"
response = app.post "/s3/multipart"
assert_match /^prefix\/\w{32}$/, response.body_json["key"]
end
......@@ -64,7 +68,7 @@ describe Uppy::S3Multipart::App do
create_multipart_upload: { acl: "public-read" }
})
response = app.post "/multipart"
response = app.post "/s3/multipart"
assert_equal :create_multipart_upload, @s3.api_requests[0][:operation_name]
assert_equal "public-read", @s3.api_requests[0][:params][:acl]
......@@ -78,16 +82,16 @@ describe Uppy::S3Multipart::App do
}
})
response = app.post "/multipart"
response = app.post "/s3/multipart"
assert_equal :create_multipart_upload, @s3.api_requests[0][:operation_name]
assert_equal "public-read", @s3.api_requests[0][:params][:acl]
end
end
describe "GET /multipart/:uploadId" do
describe "GET /s3/multipart/:uploadId" do
it "fetches multipart parts" do
response = app.get "/multipart/foo", query: { key: "bar" }
response = app.get "/s3/multipart/foo", query: { key: "bar" }
assert_equal :list_parts, @s3.api_requests[0][:operation_name]
assert_equal "foo", @s3.api_requests[0][:params][:upload_id]
......@@ -97,7 +101,7 @@ describe Uppy::S3Multipart::App do
it "returns multipart parts" do
@s3.stub_responses(:list_parts, { parts: [ { part_number: 1, size: 123, etag: "etag1" } ] })
response = app.get "/multipart/foo", query: { key: "bar" }
response = app.get "/s3/multipart/foo", query: { key: "bar" }
assert_equal 200, response.status
assert_equal "application/json", response.headers["Content-Type"]
......@@ -108,7 +112,7 @@ describe Uppy::S3Multipart::App do
end
it "returns error response when 'key' parameter is missing" do
response = app.get "/multipart/foo"
response = app.get "/s3/multipart/foo"
assert_equal 400, response.status
assert_equal "application/json", response.headers["Content-Type"]
......@@ -121,7 +125,7 @@ describe Uppy::S3Multipart::App do
list_parts: { max_parts: 5 }
})
response = app.get "/multipart/foo", query: { key: "bar" }
response = app.get "/s3/multipart/foo", query: { key: "bar" }
assert_equal :list_parts, @s3.api_requests[0][:operation_name]
assert_equal 5, @s3.api_requests[0][:params][:max_parts]
......@@ -135,16 +139,16 @@ describe Uppy::S3Multipart::App do
}
})
response = app.get "/multipart/foo", query: { key: "bar" }
response = app.get "/s3/multipart/foo", query: { key: "bar" }
assert_equal :list_parts, @s3.api_requests[0][:operation_name]
assert_equal 5, @s3.api_requests[0][:params][:max_parts]
end
end
describe "GET /multipart/:uploadId/:partNumber" do
describe "GET /s3/multipart/:uploadId/:partNumber" do
it "returns presigned url for part upload" do
response = app.get "/multipart/foo/1", query: { key: "bar" }
response = app.get "/s3/multipart/foo/1", query: { key: "bar" }
assert_equal 200, response.status
assert_equal "application/json", response.headers["Content-Type"]
......@@ -153,7 +157,7 @@ describe Uppy::S3Multipart::App do
end
it "returns error response when 'key' parameter is missing" do
response = app.get "/multipart/foo/1"
response = app.get "/s3/multipart/foo/1"
assert_equal 400, response.status
assert_equal "application/json", response.headers["Content-Type"]
......@@ -166,7 +170,7 @@ describe Uppy::S3Multipart::App do
prepare_upload_part: { expires_in: 10 }
})
response = app.get "/multipart/foo/1", query: { key: "bar" }
response = app.get "/s3/multipart/foo/1", query: { key: "bar" }
assert_match "X-Amz-Expires=10", response.body_json["url"]
end
......@@ -179,15 +183,15 @@ describe Uppy::S3Multipart::App do
}
})
response = app.get "/multipart/foo/1", query: { key: "bar" }
response = app.get "/s3/multipart/foo/1", query: { key: "bar" }
assert_match "X-Amz-Expires=10", response.body_json["url"]
end
end
describe "POST /multipart/:uploadId/complete" do
describe "POST /s3/multipart/:uploadId/complete" do
it "completes the multipart upload" do
response = app.post "/multipart/foo/complete", query: { key: "bar" },
response = app.post "/s3/multipart/foo/complete", query: { key: "bar" },
json: { parts: [{ PartNumber: 1, ETag: "etag1" }] }
assert_equal :complete_multipart_upload, @s3.api_requests[0][:operation_name]
......@@ -198,7 +202,7 @@ describe Uppy::S3Multipart::App do
end
it "returns presigned URL to the object" do
response = app.post "/multipart/foo/complete", query: { key: "bar" }, json: { parts: [] }
response = app.post "/s3/multipart/foo/complete", query: { key: "bar" }, json: { parts: [] }
assert_equal 200, response.status
assert_equal "application/json", response.headers["Content-Type"]
......@@ -207,7 +211,7 @@ describe Uppy::S3Multipart::App do
end
it "returns error response when 'key' parameter is missing" do
response = app.post "/multipart/foo/complete", json: { parts: [] }
response = app.post "/s3/multipart/foo/complete", json: { parts: [] }
assert_equal 400, response.status
assert_equal "application/json", response.headers["Content-Type"]
......@@ -216,7 +220,7 @@ describe Uppy::S3Multipart::App do
end
it "returns error response when 'parts' parameter is missing" do
response = app.post "/multipart/foo/complete", query: { key: "bar" }
response = app.post "/s3/multipart/foo/complete", query: { key: "bar" }
assert_equal 400, response.status
assert_equal "application/json", response.headers["Content-Type"]
......@@ -225,7 +229,7 @@ describe Uppy::S3Multipart::App do
end
it "returns error response when a part is missing 'PartNumber' field" do
response = app.post "/multipart/foo/complete", query: { key: "bar" },
response = app.post "/s3/multipart/foo/complete", query: { key: "bar" },
json: { parts: [{ ETag: 1 }] }
assert_equal 400, response.status
......@@ -235,7 +239,7 @@ describe Uppy::S3Multipart::App do
end
it "returns error response when a part is missing 'ETag' field" do
response = app.post "/multipart/foo/complete", query: { key: "bar" },
response = app.post "/s3/multipart/foo/complete", query: { key: "bar" },
json: { parts: [{ PartNumber: 1 }] }
assert_equal 400, response.status
......@@ -249,7 +253,7 @@ describe Uppy::S3Multipart::App do
complete_multipart_upload: { request_payer: "bob" }
})
response = app.post "/multipart/foo/complete", query: { key: "bar" }, json: { parts: [] }
response = app.post "/s3/multipart/foo/complete", query: { key: "bar" }, json: { parts: [] }
assert_equal :complete_multipart_upload, @s3.api_requests[0][:operation_name]
assert_equal "bob", @s3.api_requests[0][:params][:request_payer]
......@@ -263,16 +267,16 @@ describe Uppy::S3Multipart::App do
}
})
response = app.post "/multipart/foo/complete", query: { key: "bar" }, json: { parts: [] }
response = app.post "/s3/multipart/foo/complete", query: { key: "bar" }, json: { parts: [] }
assert_equal :complete_multipart_upload, @s3.api_requests[0][:operation_name]
assert_equal "bob", @s3.api_requests[0][:params][:request_payer]
end
end
describe "DELETE /multipart/:uploadId" do
describe "DELETE /s3/multipart/:uploadId" do
it "aborts the multipart uplaod" do
response = app.delete "/multipart/foo", query: { key: "bar" }
response = app.delete "/s3/multipart/foo", query: { key: "bar" }
assert_equal :abort_multipart_upload, @s3.api_requests[0][:operation_name]
assert_equal "foo", @s3.api_requests[0][:params][:upload_id]
......@@ -280,7 +284,7 @@ describe Uppy::S3Multipart::App do
end
it "returns empty result" do
response = app.delete "/multipart/foo", query: { key: "bar" }
response = app.delete "/s3/multipart/foo", query: { key: "bar" }
assert_equal 200, response.status
assert_equal "application/json", response.headers["Content-Type"]
......@@ -289,7 +293,7 @@ describe Uppy::S3Multipart::App do
end
it "returns error response when 'key' parameter is missing" do
response = app.delete "/multipart/foo"
response = app.delete "/s3/multipart/foo"
assert_equal 400, response.status
assert_equal "application/json", response.headers["Content-Type"]
......@@ -302,7 +306,7 @@ describe Uppy::S3Multipart::App do
abort_multipart_upload: { request_payer: "bob" }
})
response = app.delete "/multipart/foo", query: { key: "bar" }
response = app.delete "/s3/multipart/foo", query: { key: "bar" }
assert_equal :abort_multipart_upload, @s3.api_requests[0][:operation_name]
assert_equal "bob", @s3.api_requests[0][:params][:request_payer]
......@@ -316,7 +320,7 @@ describe Uppy::S3Multipart::App do
}
})
response = app.delete "/multipart/foo", query: { key: "bar" }
response = app.delete "/s3/multipart/foo", query: { key: "bar" }
assert_equal :abort_multipart_upload, @s3.api_requests[0][:operation_name]
assert_equal "bob", @s3.api_requests[0][:params][:request_payer]
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment