remove comments and unnecessary files

modules/storages/app/common/storages/peripherals/storage_interaction/nextcloud/copy_template_folder_command.rb

@@ -26,102 +26,109 @@
 # See COPYRIGHT and LICENSE files for more details.
 #++
 
-module Storages::Peripherals::StorageInteraction::Nextcloud
-  class CopyTemplateFolderCommand
-    using Storages::Peripherals::ServiceResultRefinements
-
-    def self.call(storage:, source_path:, destination_path:)
-      new(storage).call(source_path:, destination_path:)
-    end
-
-    def initialize(storage)
-      @storage = storage
-    end
-
-    def call(source_path:, destination_path:)
-      valid_input_result = validate_inputs(source_path, destination_path).on_failure { |failure| return failure }
-
-      remote_urls = build_origin_urls(**valid_input_result.result)
-
-      remote_folder_does_not_exist?(remote_urls[:destination_url]).on_failure { |failure| return failure }
-
-      copy_folder(**remote_urls).on_failure { |failure| return failure }
-
-      get_folder_id(valid_input_result.result[:destination_path]).on_success do |command_result|
-        return ServiceResult
-          .success(result: { id: command_result.result[destination_path]['fileid'], url: remote_urls[:destination_url] })
+module Storages
+  module Peripherals
+    module StorageInteraction
+      module Nextcloud
+        class CopyTemplateFolderCommand
+          using ServiceResultRefinements
+
+          def self.call(storage:, source_path:, destination_path:)
+            new(storage).call(source_path:, destination_path:)
+          end
+
+          def initialize(storage)
+            @storage = storage
+            @data = ResultData::CopyTemplateFolder.new(id: nil, polling_url: nil, requires_polling: false)
+          end
+
+          def call(source_path:, destination_path:)
+            valid_input_result = validate_inputs(source_path, destination_path).on_failure { |failure| return failure }
+
+            remote_urls = build_origin_urls(**valid_input_result.result)
+
+            remote_folder_does_not_exist?(remote_urls[:destination_url]).on_failure { |failure| return failure }
+
+            copy_folder(**remote_urls).on_failure { |failure| return failure }
+
+            get_folder_id(valid_input_result.result[:destination_path]).on_success do |command_result|
+              return ServiceResult
+                .success(result: @data.with(id: command_result.result[destination_path]["fileid"]))
+            end
+          end
+
+          private
+
+          def validate_inputs(source_path, destination_path)
+            if source_path.blank? || destination_path.blank?
+              return Util.error(:error, "Source and destination paths must be present.")
+            end
+
+            ServiceResult.success(result: { source_path:, destination_path: })
+          end
+
+          def build_origin_urls(source_path:, destination_path:)
+            escaped_username = CGI.escapeURIComponent(@storage.username)
+
+            source_url = Util.join_uri_path(
+              @storage.uri,
+              "remote.php/dav/files",
+              escaped_username,
+              Util.escape_path(source_path)
+            )
+
+            destination_url = Util.join_uri_path(
+              @storage.uri,
+              "remote.php/dav/files",
+              escaped_username,
+              Util.escape_path(destination_path)
+            )
+
+            { source_url:, destination_url: }
+          end
+
+          def remote_folder_does_not_exist?(destination_url)
+            response = OpenProject.httpx.basic_auth(@storage.username, @storage.password).head(destination_url)
+
+            case response
+            in { status: 200..299 }
+              Util.error(:conflict, "Destination folder already exists.")
+            in { status: 401 }
+              Util.error(:unauthorized, "unauthorized (validate_destination)")
+            in { status: 404 }
+              ServiceResult.success
+            else
+              Util.error(:unknown, "Unexpected response (validate_destination): #{response.code}", response)
+            end
+          end
+
+          def copy_folder(source_url:, destination_url:)
+            response = OpenProject
+              .httpx
+              .basic_auth(@storage.username, @storage.password)
+              .request("COPY", source_url, headers: { "Destination" => destination_url, "Depth" => "infinity" })
+
+            case response
+            in { status: 200..299 }
+              ServiceResult.success(message: "Folder was successfully copied")
+            in { status: 401 }
+              Util.error(:unauthorized, "Unauthorized (copy_folder)")
+            in { status: 404 }
+              Util.error(:not_found, "Project folder not found (copy_folder)")
+            in { status: 409 }
+              Util.error(:conflict, Util.error_text_from_response(response))
+            else
+              Util.error(:unknown, "Unexpected response (copy_folder): #{response.status}", response)
+            end
+          end
+
+          def get_folder_id(destination_path)
+            Registry
+              .resolve("#{@storage.short_provider_type}.queries.file_ids")
+              .call(storage: @storage, path: destination_path)
+          end
+        end
       end
     end
-
-    private
-
-    def validate_inputs(source_path, destination_path)
-      if source_path.blank? || destination_path.blank?
-        return Util.error(:error, 'Source and destination paths must be present.')
-      end
-
-      ServiceResult.success(result: { source_path:, destination_path: })
-    end
-
-    def build_origin_urls(source_path:, destination_path:)
-      escaped_username = CGI.escapeURIComponent(@storage.username)
-
-      source_url = Util.join_uri_path(
-        @storage.uri,
-        "remote.php/dav/files",
-        escaped_username,
-        Util.escape_path(source_path)
-      )
-
-      destination_url = Util.join_uri_path(
-        @storage.uri,
-        "remote.php/dav/files",
-        escaped_username,
-        Util.escape_path(destination_path)
-      )
-
-      { source_url:, destination_url: }
-    end
-
-    def remote_folder_does_not_exist?(destination_url)
-      response = OpenProject.httpx.basic_auth(@storage.username, @storage.password).head(destination_url)
-
-      case response
-      in { status: 200..299 }
-        Util.error(:conflict, 'Destination folder already exists.')
-      in { status: 401 }
-        Util.error(:unauthorized, "unauthorized (validate_destination)")
-      in { status: 404 }
-        ServiceResult.success
-      else
-        Util.error(:unknown, "Unexpected response (validate_destination): #{response.code}", response)
-      end
-    end
-
-    def copy_folder(source_url:, destination_url:)
-      response = OpenProject
-        .httpx
-        .basic_auth(@storage.username, @storage.password)
-        .request('COPY', source_url, headers: { 'Destination' => destination_url, 'Depth' => 'infinity' })
-
-      case response
-      in { status: 200..299 }
-        ServiceResult.success(message: 'Folder was successfully copied')
-      in { status: 401 }
-        Util.error(:unauthorized, "Unauthorized (copy_folder)")
-      in { status: 404 }
-        Util.error(:not_found, "Project folder not found (copy_folder)")
-      in { status: 409 }
-        Util.error(:conflict, Util.error_text_from_response(response))
-      else
-        Util.error(:unknown, "Unexpected response (copy_folder): #{response.status}", response)
-      end
-    end
-
-    def get_folder_id(destination_path)
-      Storages::Peripherals::Registry
-        .resolve("#{@storage.short_provider_type}.queries.file_ids")
-        .call(storage: @storage, path: destination_path)
-    end
   end
 end

modules/storages/app/common/storages/peripherals/storage_interaction/one_drive/copy_template_folder_command.rb

@@ -38,7 +38,7 @@ def self.call(storage:, source_path:, destination_path:)
               return ServiceResult.failure(
                 result: :error,
                 errors: StorageError.new(code: :error,
-                                         log_message: 'Both source and destination paths need to be present')
+                                         log_message: "Both source and destination paths need to be present")
               )
             end
 
@@ -47,6 +47,7 @@ def self.call(storage:, source_path:, destination_path:)
 
           def initialize(storage)
             @storage = storage
+            @data = ResultData::CopyTemplateFolder.new(id: nil, polling_url: nil, requires_polling: true)
           end
 
           def call(source_location:, destination_name:)
@@ -62,15 +63,15 @@ def call(source_location:, destination_name:)
           def handle_response(response)
             case response
             in { status: 202 }
-              ServiceResult.success(result: { id: nil, url: response.headers[:location] })
+              ServiceResult.success(result: @data.with(polling_url: response.headers[:location]))
             in { status: 401 }
               ServiceResult.failure(result: :unauthorized)
             in { status: 403 }
               ServiceResult.failure(result: :forbidden)
             in { status: 404 }
-              ServiceResult.failure(result: :not_found, message: 'Template folder not found')
+              ServiceResult.failure(result: :not_found, message: "Template folder not found")
             in { status: 409 }
-              ServiceResult.failure(result: :conflict, message: 'The copy would overwrite an already existing folder')
+              ServiceResult.failure(result: :conflict, message: "The copy would overwrite an already existing folder")
             else
               ServiceResult.failure(result: :error)
             end

modules/storages/app/common/storages/peripherals/storage_interaction/result_data/copy_template_folder.rb

@@ -0,0 +1,11 @@
+module Storages
+  module Peripherals
+    module StorageInteraction
+      module ResultData
+        CopyTemplateFolder = Data.define(:id, :polling_url, :requires_polling) do
+          def requires_polling? = !!requires_polling
+        end
+      end
+    end
+  end
+end