amplify-swift/AmplifyPlugins/Storage/AWSS3StoragePlugin/Dependency/AWSS3TransferUtilityAdapter.swift

//
// Copyright Amazon.com Inc. or its affiliates.
// All Rights Reserved.
//
// SPDX-License-Identifier: Apache-2.0
//

import Foundation
import AWSS3

/// The class confirming to AWSS3TransferUtilityBehavior which uses an instance of the AWSS3TransferUtility to
/// perform its methods. This class acts as a wrapper to expose AWSS3TransferUtility functionality through an
/// instance over a singleton, and allows for mocking in unit tests. The methods contain no other logic other than
/// calling the same method using the AWSS3TransferUtility instance.
class AWSS3TransferUtilityAdapter: AWSS3TransferUtilityBehavior {

    let transferUtility: AWSS3TransferUtility

    /// Creates a Transfer Utility Adapter.
    /// - Parameter transferUtility: Transfer Utility.
    public init(_ transferUtility: AWSS3TransferUtility) {
        self.transferUtility = transferUtility
    }

    /// Downloads data.
    /// - Parameters:
    ///   - fromBucket: Bucket.
    ///   - key: Key.
    ///   - expression: Expression.
    ///   - completionHandler: Completion handler.
    /// - Returns: Task which provides the download task.
    public func downloadData(fromBucket: String,
                             key: String,
                             expression: AWSS3TransferUtilityDownloadExpression,
                             completionHandler: (AWSS3TransferUtilityDownloadCompletionHandlerBlock)?)
        -> AWSTask<AWSS3TransferUtilityDownloadTask> {

            return transferUtility.downloadData(fromBucket: fromBucket,
                                                key: key,
                                                expression: expression,
                                                completionHandler: completionHandler)
    }

    /// Downloads to a file.
    /// - Parameters:
    ///   - fileURL: File URL.
    ///   - bucket: Bucket.
    ///   - key: Key.
    ///   - expression: Expression.
    ///   - completionHandler: Completion Handler
    /// - Returns: Task which provides the download task.
    public func download(to fileURL: URL,
                         bucket: String,
                         key: String,
                         expression: AWSS3TransferUtilityDownloadExpression,
                         completionHandler: AWSS3TransferUtilityDownloadCompletionHandlerBlock?)
        -> AWSTask<AWSS3TransferUtilityDownloadTask> {

            return transferUtility.download(to: fileURL,
                                            bucket: bucket,
                                            key: key,
                                            expression: expression,
                                            completionHandler: completionHandler)
    }

    // swiftlint:disable function_parameter_count

    /// Uploads data.
    /// - Parameters:
    ///   - data: Data.
    ///   - bucket: Bucket.
    ///   - key: Key.
    ///   - contentType: Content Type.
    ///   - expression: Expression.
    ///   - completionHandler: Completion Handler.
    /// - Returns: Task which provides the upload task.
    public func uploadData(data: Data,
                           bucket: String,
                           key: String,
                           contentType: String,
                           expression: AWSS3TransferUtilityUploadExpression,
                           completionHandler: AWSS3TransferUtilityUploadCompletionHandlerBlock?)
        -> AWSTask<AWSS3TransferUtilityUploadTask> {

            return transferUtility.uploadData(data,
                                              bucket: bucket,
                                              key: key,
                                              contentType: contentType,
                                              expression: expression,
                                              completionHandler: completionHandler)
    }

    /// Uploads file.
    /// - Parameters:
    ///   - fileURL: File URL.
    ///   - bucket: Bucket.
    ///   - key: Key.
    ///   - contentType: Content Type.
    ///   - expression: Expression.
    ///   - completionHandler: Completion Handler.
    /// - Returns: Task which provides the uplopad task.
    public func uploadFile(fileURL: URL,
                           bucket: String,
                           key: String,
                           contentType: String,
                           expression: AWSS3TransferUtilityUploadExpression,
                           completionHandler: AWSS3TransferUtilityUploadCompletionHandlerBlock?)
        -> AWSTask<AWSS3TransferUtilityUploadTask> {

        return transferUtility.uploadFile(fileURL,
                                          bucket: bucket,
                                          key: key,
                                          contentType: contentType,
                                          expression: expression,
                                          completionHandler: completionHandler)
    }

    /// Uploads using multipart process.
    /// - Parameters:
    ///   - fileURL: File URL,
    ///   - bucket: Bucket.
    ///   - key: Key.
    ///   - contentType: Content Type.
    ///   - expression: Expression.
    ///   - completionHandler: Completion handler.
    /// - Returns: Task which provides multipart upload task.
    public func uploadUsingMultiPart(fileURL: URL,
                                     bucket: String,
                                     key: String,
                                     contentType: String,
                                     expression: AWSS3TransferUtilityMultiPartUploadExpression,
                                     completionHandler: AWSS3TransferUtilityMultiPartUploadCompletionHandlerBlock?)
        -> AWSTask<AWSS3TransferUtilityMultiPartUploadTask> {

        return transferUtility.uploadUsingMultiPart(fileURL: fileURL,
                                                    bucket: bucket,
                                                    key: key,
                                                    contentType: contentType,
                                                    expression: expression,
                                                    completionHandler: completionHandler)
    }

    /// Uploads using multipart process.
    /// - Parameters:
    ///   - data: Data.
    ///   - bucket: Bucket.
    ///   - key: Key.
    ///   - contentType: Content Type.
    ///   - expression: Expression.
    ///   - completionHandler: Completion handle.
    /// - Returns: Task which provides the multipart upload task.
    public func uploadUsingMultiPart(data: Data,
                                     bucket: String,
                                     key: String,
                                     contentType: String,
                                     expression: AWSS3TransferUtilityMultiPartUploadExpression,
                                     completionHandler: AWSS3TransferUtilityMultiPartUploadCompletionHandlerBlock?)
        -> AWSTask<AWSS3TransferUtilityMultiPartUploadTask> {

        return transferUtility.uploadUsingMultiPart(data: data,
                                                    bucket: bucket,
                                                    key: key,
                                                    contentType: contentType,
                                                    expression: expression,
                                                    completionHandler: completionHandler)
    }
}