Merge pull request #18 from vapor-community/vapor-beta

Updates for Vapor 4 beta and GoogleCloudKit.

Author: Andrewangeta

Package.swift

@@ -5,25 +5,28 @@ import PackageDescription
 
 let package = Package(
     name: "GoogleCloud",
+    platforms: [
+       .macOS(.v10_14)
+    ],
     products: [
-        // Products define the executables and libraries produced by a package, and make them visible to other packages.
         .library(
             name: "GoogleCloud",
             targets: ["GoogleCloud"]),
+        .library(
+            name: "CloudStorage",
+            targets: ["CloudStorage"]),
     ],
     dependencies: [
-        // Dependencies declare other packages that this package depends on.
-        .package(url: "https://github.com/vapor/vapor.git", from: "4.0.0-alpha"),
+        .package(url: "https://github.com/vapor/vapor.git", from: "4.0.0-beta"),
         .package(url: "https://github.com/vapor-community/GoogleCloudKit.git", from: "1.0.0-alpha")
     ],
     targets: [
-        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
-        // Targets can depend on other targets in this package, and on products in packages which this package depends on.
         .target(
             name: "GoogleCloud",
             dependencies: ["Vapor", "GoogleCloudKit"]),
-        .testTarget(
-            name: "GoogleCloudTests",
-            dependencies: ["GoogleCloud"]),
+        
+        .target(
+            name: "CloudStorage",
+            dependencies: ["Vapor", "GoogleCloudStorage"]),
     ]
 )

README.md

@@ -11,7 +11,7 @@
 In your `Package.swift` file, add the following
 
 ```swift
-.package(url: "https://github.com/vapor-community/google-cloud-provider.git", from: "1.0.0-alpha.1")
+.package(url: "https://github.com/vapor-community/google-cloud-provider.git", from: "1.0.0-beta")
 ```
 
 Register the credentials configuration (required) and the provider in  `Configure.swift`
@@ -20,39 +20,34 @@ Register the credentials configuration (required) and the provider in  `Configur
  import GoogleCloud
 
  // register the credentials configuration which is used by all APIs
- s.register(GoogleCloudCredentialsConfiguration.self) { _ in
+ app.register(GoogleCloudCredentialsConfiguration.self) { _ in
      return GoogleCloudCredentialsConfiguration(project: "myprojectid-12345",
                                                 credentialsFile: "~/path/to/service-account.json")
  }
 
  // Register an API specific configuration. CloudStorage in this example.
- s.register(GoogleCloudStorageConfiguration.self) { _ in 
+ app.register(GoogleCloudStorageConfiguration.self) { _ in 
     return GoogleCloudStorageConfiguration.defult()
  }
 
- s.provider(GoogleCloudProvider())
+ // Configure more API configurations that you want to use.
+ 
+ // Add the GoogleCloudProvider and choose the APIs you want to include
+ app.provider(GoogleCloudProvider(apis: [.storage, .pubsub, ...])
 ```
 
-Example usage
-```swift
+Now we can access the `GoogleCloudClient` which has access to all the APIs we've configured.
 
-struct UploadRequest: Content {
-    var data: Data
-    var filename: String
-}
-
-func uploadImage(_ req: Request) throws {
-    let upload = try req.content.decode(UploadRequest.self)
-    
-    let storageClient = try container.make(GoogleCloudStorageClient.self)
-    storageClient.object.createSimpleUpload(bucket: "vapor-cloud-storage-demo",
-                                            data: upload.data,
-                                            name: upload.filename,
-                                            contentType: "image/jpeg").flatMap { uploadedObject in
-        print(uploadedObject.mediaLink) // prints the download link for the image.
+```swift
+    let cloudClient = app.make(GoogleCloudClient.self)
+    // Use the Storage api to list the buckets.
+    cloudClient.storage.buckets.list().flatMap { buckets in
+        print(buckets.items.last.name) 
     }
-}
 ```
 
+### Supported APIs
+[x] [CloudStorage](/Sources/CloudStorage/README.md) 
+
 ### A More detailed guide can be found [here](https://github.com/vapor-community/GoogleCloudKit).
 

Sources/CloudStorage/CloudStorageProvider.swift

@@ -0,0 +1,23 @@
+//
+//  CloudStorageProvider.swift
+//  
+//
+//  Created by Andrew Edwards on 11/2/19.
+//
+
+import Vapor
+@_exported import Core
+@_exported import Storage
+
+public final class CloudStorageProvider: Provider {
+    public init() {}
+    public func register(_ app: Application) {
+        app.register(GoogleCloudStorageClient.self) { app in
+            let credentialsConfig = app.make(GoogleCloudCredentialsConfiguration.self)
+            let storageConfig = app.make(GoogleCloudStorageConfiguration.self)
+            return try GoogleCloudStorageClient(configuration: credentialsConfig,
+                                                storageConfig: storageConfig,
+                                                eventLoop: app.make())
+        }
+    }
+}

Sources/CloudStorage/README.md

@@ -0,0 +1,63 @@
+# CloudStorageProvider
+
+## Getting Started
+If you only need to use the [Google Cloud Storage API](https://cloud.google.com/storage/), then this guide will help you get started.
+
+In your `Package.swift` file, make sure you have the following dependencies and targets
+
+```swift
+dependencies: [
+        //...
+        .package(url: "https://github.com/vapor-community/google-cloud-provider.git", from: "1.0.0-beta"),
+    ],
+    targets: [
+        .target(name: "MyAppName", dependencies: [// Other dependencies
+                                                    "CloudStorage",
+                                                  ]),
+    ]
+```
+
+Now you can register the `GoogleCloudCredentialsConfiguraton` and the `GoogleCloudStorageConfiguration`.
+
+In `Configure.swift`
+
+```swift
+ import CloudStorage
+ 
+ // register the credentials configuration which is used by all APIs
+ app.register(GoogleCloudCredentialsConfiguration.self) { _ in
+     return GoogleCloudCredentialsConfiguration(project: "myprojectid-12345",
+                                                credentialsFile: "~/path/to/service-account.json")
+ }
+ 
+ // Register the CloudStorage Configuraton.
+ app.register(GoogleCloudStorageConfiguration.self) { _ in
+    return GoogleCloudStorageConfiguration.defult()
+ }
+ 
+// Add the CloudStorageProvder
+ app.provider(CloudStorageProvider())
+```
+
+Now we can start using the CloudStorage API.
+We do that by making a `GoogleCloudStorageClient` object that's already configured
+from the `CloudStorageProvider` we setup above.
+
+```swift
+struct UploadRequest: Content {
+    var data: Data
+    var filename: String
+}
+
+func uploadImage(_ req: Request) throws {
+    let upload = try req.content.decode(UploadRequest.self)
+    
+    let storageClient = app.make(GoogleCloudStorageClient.self)
+    storageClient.object.createSimpleUpload(bucket: "vapor-cloud-storage-demo",
+                                            data: upload.data,
+                                            name: upload.filename,
+                                            contentType: "image/jpeg").flatMap { uploadedObject in
+        print(uploadedObject.mediaLink) // prints the download link for the image.
+    }
+}
+```

Sources/GoogleCloud/APIs.swift

@@ -0,0 +1,15 @@
+//
+//  APIs.swift
+//  
+//
+//  Created by Andrew Edwards on 11/2/19.
+//
+
+import Foundation
+
+/// An enum that describes all the currently suported APIs.
+/// New APIs that are supported should be added as a new case named after the API.
+public enum GoogleCloudAPI: CaseIterable {
+    /// The Cloud Storage API.
+    case storage
+}

Sources/GoogleCloud/GoogleCloudProvider.swift

@@ -4,20 +4,57 @@
 //
 //  Created by Andrew Edwards on 4/17/18.
 //
+
 import Vapor
-@_exported import GoogleCloudKit
+@_exported import Core
+@_exported import Storage
+// New APIs added to GoogleCloudKit should be exported here.
 
 public final class GoogleCloudProvider: Provider {
+    private let apis: [GoogleCloudAPI]
+    
+    /// - Parameter apis: An array containing  `GoogleCloudAPI`s that you want to use and that have also been configured to use.
+    public init(apis: [GoogleCloudAPI]) {
+        self.apis = apis
+    }
+    
+    public func register(_ app: Application) {
+        app.register(GoogleCloudClient.self) { app in
+            return try GoogleCloudClient(apis: self.apis, app: app)
+        }
+    }
+}
+
+/** The GoogleCloudClient acts as a single point of access for interacting with one or more GCP APIs that have been configured.
+ 
+    ```
+        let client: GoogleCloudClient = GoogleCloudClient(...)
+        client.storage.buckets // etc.
+        client.pubsub // etc.
+        client.gcpAPI // etc.
+    ```
+*/
+public class GoogleCloudClient {
+    private var _storage: GoogleCloudStorageClient?
 
-    public init() {}
+    /// An instance of the CloudStorageClient used to access the various CloudStorage APIs.
+    public var storage: GoogleCloudStorageClient {
+        guard let storageClient = _storage else {
+            fatalError("Failed to create CloudStorageClient. Make sure you specify '.storage' when creating the 'GoogleCloudProvider'.")
+        }
+        return storageClient
+    }
 
-    public func register(_ s: inout Services) {
-        s.register(GoogleCloudStorageClient.self) { container in
-            let credentialsConfig = try container.make(GoogleCloudCredentialsConfiguration.self)
-            let storageConfig = try container.make(GoogleCloudStorageConfiguration.self)
-            return try GoogleCloudStorageClient(configuration: credentialsConfig,
-                                                storageConfig: storageConfig,
-                                                eventLoop: container.eventLoop)
+    init(apis: [GoogleCloudAPI], app: Application) throws {
+        let credentialsConfig = app.make(GoogleCloudCredentialsConfiguration.self)
+        for api in apis {
+            switch api {
+            case .storage:
+                let storageConfig = app.make(GoogleCloudStorageConfiguration.self)
+                _storage = try GoogleCloudStorageClient(configuration: credentialsConfig,
+                                                        storageConfig: storageConfig,
+                                                        eventLoop: app.make())
+            }
         }
     }
 }