Create a Rails Engine version of the uppy-s3_multipart gem's Roda app

Author: carsomyr

Gemfile

@@ -10,6 +10,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "rubocop"
+gem "uppy-s3_multipart"
 
 group :test do
   gem "byebug"

Gemfile.lock

@@ -79,11 +79,28 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
+    aws-eventstream (1.2.0)
+    aws-partitions (1.781.0)
+    aws-sdk-core (3.175.0)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.651.0)
+      aws-sigv4 (~> 1.5)
+      jmespath (~> 1, >= 1.6.1)
+    aws-sdk-kms (1.67.0)
+      aws-sdk-core (~> 3, >= 3.174.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-s3 (1.126.0)
+      aws-sdk-core (~> 3, >= 3.174.0)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.4)
+    aws-sigv4 (1.5.2)
+      aws-eventstream (~> 1, >= 1.0.2)
     builder (3.2.4)
     byebug (11.1.3)
     case_transform (0.2)
       activesupport
     concurrent-ruby (1.1.10)
+    content_disposition (1.0.0)
     crass (1.0.6)
     diff-lcs (1.5.0)
     digest (3.1.0)
@@ -97,6 +114,7 @@ GEM
       activesupport (>= 5.0)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
+    jmespath (1.6.2)
     json (2.6.2)
     jsonapi-renderer (0.2.2)
     loofah (2.18.0)
@@ -164,6 +182,8 @@ GEM
     rake (13.0.6)
     regexp_parser (2.5.0)
     rexml (3.2.5)
+    roda (3.69.0)
+      rack
     rspec-core (3.11.0)
       rspec-support (~> 3.11.0)
     rspec-expectations (3.11.0)
@@ -201,6 +221,10 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.2.0)
+    uppy-s3_multipart (1.2.1)
+      aws-sdk-s3 (~> 1.0)
+      content_disposition (~> 1.0)
+      roda (>= 2.27, < 4)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
@@ -216,6 +240,7 @@ DEPENDENCIES
   rubocop
   scalient-rails!
   sqlite3
+  uppy-s3_multipart
 
 BUNDLED WITH
-   2.2.33
+   2.4.13

app/controllers/scalient/rails/uppy_s3_multiparts_controller.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+# Adapted from `https://github.com/janko/uppy-s3_multipart/blob/master/lib/uppy/s3_multipart/app.rb`.
+
+require "uppy/s3_multipart"
+
+module Scalient
+  module Rails
+    class UppyS3MultipartsController < ::Rails.application.config.uppy_s3_multipart.base_controller.safe_constantize
+      # `POST /`
+      def create
+        type = params["type"]
+        filename = params["filename"]
+
+        key = SecureRandom.hex + File.extname(filename.to_s)
+        key = [*prefix, key].join("/")
+
+        options = {}
+
+        if type
+          options[:content_type] = type
+        end
+
+        if filename
+          options[:content_disposition] = ContentDisposition.inline(filename)
+        end
+
+        if is_public
+          options[:acl] = "public-read"
+        end
+
+        result = client_call(:create_multipart_upload, key: key, **options)
+
+        render json: {uploadId: result.fetch(:upload_id), key: result.fetch(:key)}
+      end
+
+      # `GET /:upload_id`
+      def show
+        upload_id = params.require(:upload_id)
+        key = params.require(:key)
+
+        result = client_call(:list_parts, upload_id: upload_id, key: key)
+
+        render json: result.map do |part|
+          {PartNumber: part.fetch(:part_number), Size: part.fetch(:size), ETag: part.fetch(:etag)}
+        end
+      end
+
+      # `GET /:upload_id/batch`
+      def batch
+        upload_id = params.require(:upload_id)
+        key = params.require(:key)
+        part_numbers = params.require(:partNumbers).split(",")
+
+        batch = part_numbers.to_h do |part_number|
+          result = client_call(:prepare_upload_part, upload_id: upload_id, key: key, part_number: part_number)
+          [part_number, result.fetch(:url)]
+        end
+
+        render json: {presignedUrls: batch}
+      end
+
+      # `GET /:upload_id/:part_number`
+      def part_number
+        upload_id = params.require(:upload_id)
+        key = params.require(:key)
+        part_number = params.require(:part_number)
+
+        result = client_call(:prepare_upload_part, upload_id: upload_id, key: key, part_number: part_number)
+
+        render json: {url: result.fetch(:url)}
+      end
+
+      # `POST /:upload_id/complete`
+      def complete
+        upload_id = params.require(:upload_id)
+        key = params.require(:key)
+        parts = params.require(:parts)
+
+        parts = parts.map do |part|
+          begin
+            {part_number: part.fetch("PartNumber"), etag: part.fetch("ETag")}
+          rescue KeyError
+            render json: error_json("At least one part is missing \"PartNumber\" or \"ETag\" field"), status: 400
+
+            return
+          end
+        end
+
+        client_call(:complete_multipart_upload, upload_id: upload_id, key: key, parts: parts)
+
+        object_url = client_call(:object_url, key: key, public: is_public)
+
+        render json: {location: object_url}
+      end
+
+      # `DELETE /:upload_id`
+      def destroy
+        upload_id = params.require(:upload_id)
+        key = params.require(:key)
+
+        begin
+          client_call(:abort_multipart_upload, upload_id: upload_id, key: key)
+        rescue Aws::S3::Errors::NoSuchUpload
+          render json: error_json("Upload doesn't exist for \"key\" parameter"), status: 404
+
+          return
+        end
+
+        render :head
+      end
+
+      private
+
+      def is_public
+        ::Rails.application.config.uppy_s3_multipart.public
+      end
+
+      def prefix
+        @prefix ||= ::Rails.application.config.uppy_s3_multipart.prefix
+      end
+
+      def client
+        @client ||= Uppy::S3Multipart::Client.new(bucket: ::Rails.application.config.uppy_s3_multipart.bucket)
+      end
+
+      def app_options
+        @options ||= ::Rails.application.config.uppy_s3_multipart.options
+      end
+
+      def client_call(operation, **options)
+        overrides = app_options[operation] || {}
+        overrides = overrides.call(request) if overrides.respond_to?(:call)
+
+        options = options.merge(overrides)
+
+        client.send(operation, **options)
+      end
+
+      def error_json(message)
+        {message: message}
+      end
+    end
+  end
+end

config/routes.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Scalient LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+Scalient::Rails::Engine.routes.draw do
+  id_any_pattern = Regexp.new("[^\\/]+")
+
+  constraints(upload_id: id_any_pattern) do
+    # Draw the Uppy Companion routes (see `https://uppy.io/docs/companion/`).
+    post "/s3/multipart", to: "uppy_s3_multiparts#create"
+    get "/s3/multipart/:upload_id", to: "uppy_s3_multiparts#show"
+    get "/s3/multipart/:upload_id/batch", to: "uppy_s3_multiparts#show", as: "batch"
+    get "/s3/multipart/:upload_id/:part_number", to: "uppy_s3_multiparts#part_number", as: "part_number"
+    post "/s3/multipart/:upload_id/complete", to: "uppy_s3_multiparts#complete", as: "complete"
+    delete "/s3/multipart/:upload_id", to: "uppy_s3_multiparts#destroy"
+  end
+end

lib/scalient/rails/engine.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-#
-# Copyright 2015 Scalient LLC
+# Copyright 2015-2023 Scalient LLC
 # All rights reserved.
 
 require "scalient/rails/helpers/application_helper"
@@ -11,7 +10,11 @@ module Rails
     class Engine < ::Rails::Engine
       isolate_namespace ::Scalient::Rails
 
-      config.autoload_paths.push(File.expand_path("../../../../app/policies", __FILE__))
+      config.uppy_s3_multipart = ActiveSupport::OrderedOptions.new
+      config.uppy_s3_multipart.base_controller = "ActionController::Base"
+      config.uppy_s3_multipart.prefix = nil
+      config.uppy_s3_multipart.public = false
+      config.uppy_s3_multipart.options = {}
     end
 
     ::Rails::Application.include ApplicationHelper