first commit

Author: bitwit

.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj
+xcuserdata/

.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata

@@ -0,0 +1,28 @@
+// swift-tools-version:5.3
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "structured-networking",
+    products: [
+        // Products define the executables and libraries a package produces, and make them visible to other packages.
+        .library(
+            name: "structured-networking",
+            targets: ["structured-networking"]),
+    ],
+    dependencies: [
+        // Dependencies declare other packages that this package depends on.
+        // .package(url: /* package url */, from: "1.0.0"),
+    ],
+    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 this package depends on.
+        .target(
+            name: "structured-networking",
+            dependencies: []),
+        .testTarget(
+            name: "structured-networkingTests",
+            dependencies: ["structured-networking"]),
+    ]
+)

Package.swift

@@ -0,0 +1,69 @@
+# Structured Networking
+
+Strongly typed networking built on top of Combine
+
+#### What the API looks like
+
+```
+let networking = Networking(
+    baseURLStringProvider: { (request) -> String in
+        return "http://exampleapi.com"
+    }
+)
+
+LoginEndpoint(body: LoginRequestBody(useername: "me", password: "something"))
+	.execute(with: networking)
+	.sink { (completion) in
+       // error checking
+   } receiveValue: { (response: AuthResponse) in
+       print(response)
+   }
+```
+
+
+#### How to define endpoints
+Endpoints define all aspects of the request and response in types. If an endpoint doesnt have a params, query or a body you can use Void to indicate this is unused.
+
+*NOTE*: It is your responsibility to define how `Parameters` fit in the endpoint
+
+```swift
+public struct LoginEndpoint: APIRequest {
+
+    public typealias Parameters = Void
+    public typealias Query = Void
+    public typealias Body = LoginRequestBody
+    
+    public typealias ResponseBody = AuthResponse
+
+    public static let method: HTTPMethod = .post
+
+    public var parameters: Parameters = ()
+    public var query: Query = ()
+    public var body: LoginRequestBody
+
+    public var endpoint: String {
+        "/users/login"
+    }
+}
+
+```
+
+#### Accompanying endpoint structures
+
+```
+public struct LoginRequestBody: Codable {
+    public var password: String
+    public var username: String
+}
+
+```
+
+```swift
+public struct AuthResponse: Codable {
+    public var refreshToken: String
+    public var refreshTokenExpiry: Date
+    public var token: String
+    public var tokenExpiry: Date
+}
+
+```

README.md

@@ -0,0 +1,14 @@
+import Foundation
+import Combine
+
+public extension APIRequest where Self.ResponseBody: Decodable {
+    func execute(with networking: Networking) -> AnyPublisher<ResponseBody, NetworkingError> {
+        return networking.call(self)
+    }
+}
+
+public extension APIRequest where Self.ResponseBody == Void {
+    func execute(with networking: Networking) -> AnyPublisher<ResponseBody, NetworkingError> {
+        return networking.call(self)
+    }
+}

Sources/structured-networking/APIRequest+Networking.swift

@@ -0,0 +1,60 @@
+import Foundation
+
+public enum HTTPMethod: String {
+    case get
+    case put
+    case post
+    case patch
+    case delete
+}
+
+public protocol AnyAPIRequest {
+    static var method: HTTPMethod { get }
+    var endpoint: String { get }
+}
+
+public protocol APIRequest: AnyAPIRequest {
+    
+    associatedtype Parameters
+    associatedtype Query
+    associatedtype Body
+    associatedtype ResponseBody
+    
+    static var method: HTTPMethod { get }
+    static var requiresAuth: Bool { get }
+    
+    var endpoint: String { get }
+    var additionalHeaders: [String: String] { get }
+    
+    var body: Body { get }
+    
+    func getContentType() throws -> String?
+    func getBody() throws -> Data?
+}
+
+public extension APIRequest {
+    
+    var description: String {
+        return "\(Self.method.rawValue.uppercased()) \(endpoint)"
+    }
+
+    static var requiresAuth: Bool { false }
+    
+    var additionalHeaders: [String: String] { [:] }
+    
+    func getContentType() -> String? { nil }
+    func getBody() throws -> Data? { nil }
+}
+
+public extension APIRequest where Body: Encodable {
+    
+    func getContentType() -> String? { "application/json" }
+    
+    func getBody() throws -> Data? {
+        try JSONEncoder().encode(self.body)
+    }
+}
+
+public protocol BinaryEncodable {
+    var fileUrl: URL { get }
+}