Version 0.4.0

.gitignore

@@ -1,4 +1,6 @@
 .DS_Store
+ModelVersions.md
+
 /.build
 /Packages
 /*.xcodeproj

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:4.2
+// swift-tools-version:5.0
 
 import PackageDescription
 
@@ -8,19 +8,21 @@ let package = Package(
         .library(name: "PayPal", targets: ["PayPal"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/skelpo/Countries.git", from: "0.9.1"),
-        .package(url: "https://github.com/skelpo/Failable.git", from: "0.2.0"),
-        .package(url: "https://github.com/vapor/vapor.git", from: "3.1.0"),
-        .package(url: "https://github.com/skelpo/JSON.git", from: "0.13.1"),
+        .package(url: "https://github.com/skelpo/Countries.git", from: "1.0.0"),
+        .package(url: "https://github.com/skelpo/Failable.git", from: "0.4.0"),
+        .package(url: "https://github.com/vapor/vapor.git", from: "3.3.0"),
+        .package(url: "https://github.com/skelpo/JSON.git", from: "1.0.0"),
         .package(url: "https://github.com/twostraws/SwiftGD.git", from: "2.2.0")
     ],
     targets: [
         .target(name: "PayPal", dependencies: ["Vapor", "JSON", "Failable", "Countries"]),
+        .target(name: "PayPalV1", dependencies: ["Vapor", "PayPal"], path: "Sources/V1"),
+        .target(name: "PayPalV2", dependencies: ["Vapor", "PayPal"], path: "Sources/V2"),
 
         .target(name: "TestUtilities", dependencies: ["PayPal", "Vapor"]),
         .testTarget(name: "ConfigTests", dependencies: ["PayPal", "TestUtilities"]),
         .testTarget(name: "ControllerTests", dependencies: ["PayPal", "SwiftGD", "TestUtilities"]),
         .testTarget(name: "ModelTests", dependencies: ["PayPal", "TestUtilities"]),
-        .testTarget(name: "PayPalTests", dependencies: ["PayPal", "Vapor", "JSON"]),
+        .testTarget(name: "PayPalTests", dependencies: ["PayPal", "Vapor", "JSON", "ConfigTests", "ControllerTests", "ModelTests"]),
     ]
 )

Sources/PayPal/API/API.swift

@@ -0,0 +1,24 @@
+import Vapor
+
+/// The wrapper for the whole PayPal REST API.
+public final class API {
+
+    /// The client used to send requests to PayPal.
+    public let client: PayPalClient
+
+    /// Creates a new `API` instance with the dependencies for the `PayPalClient` instance.
+    ///
+    /// - Parameters:
+    ///   - client: The `Client` instance that the `PayPalClient` instance uses to send requests.
+    ///   - environment: The PayPal environment to send requests to.
+    public init(client: Client, version: Version, environment: Environment) {
+        self.client = PayPalClient(client: client, version: version, env: environment)
+    }
+
+    /// Creates a new `API` instance with the `PayPalClient` instance to use.
+    ///
+    /// - Parameter client: The `PayPalClient` instance that will be used to send requests to the PayPal API.
+    public init(client: PayPalClient) {
+        self.client = client
+    }
+}

Sources/PayPal/API/Authentication.swift

@@ -55,15 +55,15 @@ extension PayPalClient {
     ///
     /// - Returns: A void future that can be used to get notified when the auth information has been fetched and stored.
     public func authenticate() -> Future<Void> {
-        return Future.flatMap(on: self.container) { () -> Future<Response> in
-            let config = try self.container.make(Configuration.self)
+        return Future.flatMap(on: self.client.container) { () -> Future<Response> in
+            let config = try self.client.container.make(Configuration.self)
 
             let credentials = "\(config.id):\(config.secret)"
             let encoded = Data(credentials.utf8).base64EncodedString()
             let headers: HTTPHeaders = ["Accept": "application/json", "Accept-Language": "en_US", "Authorization": "Basic \(encoded)"]
 
-            let request = try self.container.paypal(.POST, "v1/oauth2/token", headers: headers, auth: false, body: ["grant_type": "client_credentials"])
-            return try self.container.client().send(request)
+            let request = try self.request(.POST, "v1/oauth2/token", headers: headers, auth: false, body: ["grant_type": "client_credentials"])
+            return self.client.send(request)
         }.flatMap(to: AuthResponse.self) { response in
             if !(200...299).contains(response.http.status.code) {
                 return try response.content.decode(PayPalAPIIdentityError.self).map { error in throw error }
@@ -72,8 +72,7 @@ extension PayPalClient {
             return try response.content.decode(AuthResponse.self)
 
         }.map(to: Void.self) { data in
-            let auth = try self.container.make(AuthInfo.self)
-            data.populate(auth)
+            data.populate(self.auth)
         }
     }
 }

Sources/PayPal/API/Controller.swift

@@ -50,3 +50,28 @@ extension PayPalController {
         }
     }
 }
+
+// TODO: - Renamed protocol to PayPalController.
+
+/// A controller that handles a versioned resource of the PayPal API.
+public protocol VersionedController {
+
+    /// The `PayPalClient` instance used to send requests to the PayPal API.
+    var client: PayPalClient { get }
+
+    /// The path components for the API resource that the controller interacts with.
+    var resource: [String] { get }
+
+    /// Creates a new instance of `Self` with the `PayPalClient` instance that will be used by it.
+    ///
+    /// - Parameter client: The `PayPalClient` instance to send requests with.
+    init(client: PayPalClient)
+}
+
+extension VersionedController {
+
+    /// The resource elements joined togeather as a URL path.
+    public var path: String {
+        return self.resource.joined(separator: "/") + "/"
+    }
+}

Sources/PayPal/API/Controllers/CustomerDisputes.swift

@@ -213,7 +213,7 @@ public final class CustomerDisputes: PayPalController {
     /// - Returns: An array of request-related [HATEOAS links](https://developer.paypal.com/docs/api/overview/#hateoas-links).
     ///   If an error response was sent back instead, it gets converted to a Swift error and the future wraps that instead.
     public func evidence(for disputeID: String, file: File, evidences: [Evidence]) -> Future<[LinkDescription]> {
-        return Future.flatMap(on: self.container) { () -> Future<[LinkDescription]> in
+        return self.client { client -> Future<[LinkDescription]> in
 
             guard let ext = file.ext, ext == "jpg" || ext == "gif" || ext == "png" || ext == "pdf" else {
                 throw PayPalError(status: .badRequest, identifier: "invalidExtension", reason: "File type must be JPG, GIF, PNG, or PDF")
@@ -222,7 +222,7 @@ public final class CustomerDisputes: PayPalController {
             let json = try MultipartPart(data: JSONEncoder().encode(evidences), headers: ["Content-Type": "application/json"])
             let body: [String: MultipartPartConvertible] = ["input": json, "file1": file]
 
-            let request: Request = try self.container.paypal(.POST, self.path + disputeID + "/provide-evidence", body: nil as [Int]?)
+            let request: Request = try client.request(.POST, self.path + disputeID + "/provide-evidence", body: nil as [Int]?)
             try request.content.encode(body.parts(), as: .related)
 
             let response = try self.container.client().send(request)

Sources/PayPal/API/Controllers/ManagedAccounts.swift

@@ -33,7 +33,7 @@ public final class ManagedAccounts: PayPalController {
     /// See `PayPalController.init(container:)`.
     public init(container: Container) {
         self.container = container
-        self.resource = "partners/merchant-accounts"
+        self.resource = "customer/partners/merchant-accounts"
         self.version = try container.make(Configuration.self).version || .v1
     }