adding SFTP/File upload

Author: rafiki270

Package.resolved

@@ -12,7 +12,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/apple/swift-nio.git", from: "2.3.0"),
-        .package(url: "https://github.com/jakeheis/Shout.git", from: "0.5.0"),
+        .package(url: "https://github.com/Einstore/Shout.git", from: "0.5.1"),
         .package(url: "https://github.com/kareman/SwiftShell.git", from: "5.0.0")
     ],
     targets: [

Package.swift

@@ -34,4 +34,20 @@ public protocol Executor {
     /// - Parameter path: Path
     func cd(path: String) -> EventLoopFuture<Void>
 
+    
+    /// Upload a file
+    /// - Parameter file: Path to a local file
+    /// - Parameter to: Destination path (including filename)
+    func upload(file: String, to: String) -> EventLoopFuture<Void>
+    
+    /// Upload data as a file
+    /// - Parameter data: Path to a local file
+    /// - Parameter to: Destination path (including filename)
+    func upload(data: Data, to: String) -> EventLoopFuture<Void>
+    
+    /// Upload string as a file
+    /// - Parameter string: Path to a local file
+    /// - Parameter to: Destination path (including filename)
+    func upload(string: String, to: String) -> EventLoopFuture<Void>
+    
 }

Sources/ShellKit/Executors/Executor.swift

@@ -131,4 +131,42 @@ public class LocalExecutor: Executor {
         return eventLoop.makeSucceededFuture(Void())
     }
 
+    /// Upload string as a file
+    /// - Parameter string: Path to a local file
+    /// - Parameter to: Destination path (including filename)
+    public func upload(string: String, to path: String) -> EventLoopFuture<Void> {
+        guard let data = string.data(using: .utf8) else {
+            return eventLoop.makeFailedFuture(Shell.Error.unableToConvertStringToData)
+        }
+        return upload(data: data, to: path)
+    }
+    
+    /// Upload data as a file
+    /// - Parameter data: Path to a local file
+    /// - Parameter to: Destination path (including filename)
+    public func upload(data: Data, to path: String) -> EventLoopFuture<Void> {
+        let promise = eventLoop.makePromise(of: Void.self)
+        DispatchQueue.global(qos: .background).async {
+            do {
+                try data.write(to: URL(fileURLWithPath: path))
+                promise.succeed(Void())
+            } catch {
+                promise.fail(error)
+            }
+        }
+        return promise.futureResult
+    }
+    
+    /// Upload a file
+    /// - Parameter file: Path to a local file
+    /// - Parameter to: Destination path (including filename)
+    public func upload(file: String, to path: String) -> EventLoopFuture<Void> {
+        do {
+            let data = try Data(contentsOf: URL(fileURLWithPath: path))
+            return upload(data: data, to: path)
+        } catch {
+            return eventLoop.makeFailedFuture(error)
+        }
+    }
+    
 }

Sources/ShellKit/Executors/LocalExecutor.swift

@@ -87,4 +87,43 @@ public class SSHExecutor: Executor {
         return run(bash: "cd \(path.quoteEscape)").void()
     }
 
+    /// Upload string as a file
+    /// - Parameter string: Path to a local file
+    /// - Parameter to: Destination path (including filename)
+    public func upload(string: String, to path: String) -> EventLoopFuture<Void> {
+        guard let data = string.data(using: .utf8) else {
+            return eventLoop.makeFailedFuture(Shell.Error.unableToConvertStringToData)
+        }
+        return upload(data: data, to: path)
+    }
+    
+    /// Upload data as a file
+    /// - Parameter data: Path to a local file
+    /// - Parameter to: Destination path (including filename)
+    public func upload(data: Data, to path: String) -> EventLoopFuture<Void> {
+        let promise = eventLoop.makePromise(of: Void.self)
+        DispatchQueue.global(qos: .background).async {
+            do {
+                let sftp = try self.ssh.openSftp()
+                try sftp.upload(data: data, remotePath: path)
+                promise.succeed(Void())
+            } catch {
+                promise.fail(error)
+            }
+        }
+        return promise.futureResult
+    }
+    
+    /// Upload a file
+    /// - Parameter file: Path to a local file
+    /// - Parameter to: Destination path (including filename)
+    public func upload(file: String, to path: String) -> EventLoopFuture<Void> {
+        do {
+            let data = try Data(contentsOf: URL(fileURLWithPath: path))
+            return upload(data: data, to: path)
+        } catch {
+            return eventLoop.makeFailedFuture(error)
+        }
+    }
+    
 }

Sources/ShellKit/Executors/SSHExecutor.swift

@@ -18,6 +18,9 @@ public class Shell: Executor {
         /// Bad exit code error
         case badExitCode(command: String, exit: Int32, output: String)
 
+        /// Umable to convert string to `.utf8` data
+        case unableToConvertStringToData
+        
     }
 
     /// Connection type
@@ -140,4 +143,25 @@ public class Shell: Executor {
         return executor.cd(path: path)
     }
 
+    /// Upload string as a file
+    /// - Parameter string: Path to a local file
+    /// - Parameter to: Destination path (including filename)
+    public func upload(string: String, to path: String) -> EventLoopFuture<Void> {
+        return executor.upload(file: string, to: path)
+    }
+    
+    /// Upload data as a file
+    /// - Parameter data: Path to a local file
+    /// - Parameter to: Destination path (including filename)
+    public func upload(data: Data, to path: String) -> EventLoopFuture<Void> {
+        return upload(data: data, to: path)
+    }
+    
+    /// Upload a file
+    /// - Parameter file: Path to a local file
+    /// - Parameter to: Destination path (including filename)
+    public func upload(file: String, to path: String) -> EventLoopFuture<Void> {
+        return upload(file: file, to: path)
+    }
+    
 }