Merge pull request #2 from NeedleInAJayStack/feature/linux-compat

Linux compatibility

Author: NeedleInAJayStack

.github/workflows/test.yml

@@ -4,13 +4,20 @@ on:
   push: { branches: [ main ] }
 
 jobs:
-  test:
-    strategy:
-      matrix:
-        os: [ubuntu-latest, macos-latest]
-    runs-on: ${{ matrix.os }}
+  darwin-test:
+    runs-on: macos-latest
     steps:
-      - uses: fwal/setup-swift@v1
+      - uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: latest
       - uses: actions/checkout@v2
-      - name: Run tests
-        run: swift test
+      - name: Darwin build & test
+        run: swift test --skip IntegrationTests
+  linux-build:
+    runs-on: ubuntu-latest
+    container:
+      image: swift:latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Linux build
+        run: swift build --target HaystackClientNIO

Package.resolved

@@ -4,26 +4,65 @@ import PackageDescription
 
 let package = Package(
     name: "Haystack",
+    platforms: [
+        .macOS(.v12),
+        .iOS(.v15),
+        .tvOS(.v15),
+        .watchOS(.v8)
+    ],
     products: [
         .library(
             name: "Haystack",
             targets: ["Haystack"]
         ),
         .library(
-            name: "HaystackClient",
-            targets: ["HaystackClient"]
+            name: "HaystackClientDarwin",
+            targets: [
+                "HaystackClient",
+                "HaystackClientDarwin"
+            ]
+        ),
+        .library(
+            name: "HaystackClientNIO",
+            targets: [
+                "HaystackClient",
+                "HaystackClientNIO"
+            ]
         ),
     ],
-    dependencies: [],
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-crypto.git", "1.0.0" ..< "3.0.0"),
+        .package(url: "https://github.com/swift-server/async-http-client.git", from: "1.9.0")
+    ],
     targets: [
         .target(
             name: "Haystack",
             dependencies: []
         ),
         .target(
             name: "HaystackClient",
-            dependencies: ["Haystack"]
+            dependencies: [
+                "Haystack",
+                .product(name: "Crypto", package: "swift-crypto"),
+            ]
         ),
+        .target(
+            name: "HaystackClientDarwin",
+            dependencies: [
+                "Haystack",
+                "HaystackClient",
+            ]
+        ),
+        .target(
+            name: "HaystackClientNIO",
+            dependencies: [
+                "Haystack",
+                "HaystackClient",
+                .product(name: "AsyncHTTPClient", package: "async-http-client"),
+            ]
+        ),
+        
+        // Tests
         .testTarget(
             name: "HaystackTests",
             dependencies: ["Haystack"]
@@ -33,8 +72,12 @@ let package = Package(
             dependencies: ["HaystackClient"]
         ),
         .testTarget(
-            name: "HaystackClientIntegrationTests",
-            dependencies: ["HaystackClient"]
+            name: "HaystackClientNIOIntegrationTests",
+            dependencies: ["HaystackClientNIO"]
+        ),
+        .testTarget(
+            name: "HaystackClientDarwinIntegrationTests",
+            dependencies: ["HaystackClientDarwin"]
         ),
     ]
 )

Package.swift

@@ -1,3 +1,120 @@
 # Swift Haystack
 
-An implementation of Project Haystack in Swift.
+An implementation of [Project Haystack](https://project-haystack.org/) in Swift.
+
+## Getting Started
+
+To use this package, add it to your `Package.swift` dependencies:
+
+```swift
+dependencies: [
+    .package(url: "https://github.com/NeedleInAJayStack/swift-haystack.git", from: "0.0.0"),
+],
+targets: [
+    .target(
+        name: "MyTarget",
+        dependencies: [
+            .product(name: "Haystack", package: "swift-haystack"),
+        ]
+    ),
+]
+```
+
+You can then import and use the different libraries:
+
+```swift
+import Haystack
+
+func testGrid() throws -> Grid {
+    return try ZincReader(
+        """
+        ver:"3.0" foo:"bar"
+        dis dis:"Equip Name", equip, siteRef, installed
+        "RTU-1", M, @153c-699a HQ, 2005-06-01
+        "RTU-2", M, @153c-699b Library, 1997-07-12
+        """
+    ).readGrid()
+}
+```
+
+See below for available libraries and descriptions.
+
+## Available Packages
+
+### Haystack
+
+This contains the 
+[Haystack type-system primitives](https://project-haystack.org/doc/docHaystack/Kinds)
+and utilities to interact with them.
+
+### HaystackClientDarwin
+
+A Darwin-only client driver for the
+[Haystack HTTP API](https://project-haystack.org/doc/docHaystack/HttpApi) that
+requires minimal dependencies. Use this if you are only deploying to MacOS, iOS, etc and want
+to reduce dependencies.
+
+Here's an example of how to use it:
+
+```swift
+import HaystackClientDarwin
+
+func client() throws -> Client {
+    return try Client(
+        baseUrl: "http://mydomain.com/api/",
+        username: "username",
+        password: "password"
+    )
+}
+```
+
+### HaystackClientNIO
+
+A cross-platform client driver for the
+[Haystack HTTP API](https://project-haystack.org/doc/docHaystack/HttpApi) that
+has larger dependency requirements. Use this if you are only deploying to Linux or if you
+are deploying to Darwin platforms and are willing to accept more dependencies.
+
+Here's an example of how to use it:
+
+```swift
+import HaystackClientNIO
+
+func client() throws -> Client {
+    return try Client(
+        baseUrl: "http://mydomain.com/api/",
+        username: "username",
+        password: "password",
+        eventLoopGroup: MultiThreadedEventLoopGroup(numberOfThreads: 1)
+    )
+}
+```
+
+### HaystackClient
+
+This defines the main functionality of Haystack API clients. It should not be imported directly;
+its assets are imported automatically by `HaystackClientDarwin` or `HaystackClientNIO`.
+
+Once you create a client, you can use it to make requests:
+
+```swift
+func yesterdaysValues() async throws -> Grid {
+    let client = ...
+    
+    // Open and authenticate. This must be called before requests can be made
+    try await client.open()
+    
+    // Request the historical values for @28e7fb7d-e20316e0
+    let grid = try await client.hisRead(id: Ref("28e7fb7d-e20316e0"), range: .yesterday)
+    
+    // Close the client session and log out
+    try await client.close()
+    
+    return grid
+}
+```
+
+## License
+
+This package is licensed under the Academic Free License 3.0 for maximum compatibility with
+Project Haystack itself.

README.md

@@ -1,16 +1,15 @@
-import CryptoKit
+import Crypto
 
-@available(macOS 10.15, *)
 enum AuthHash: String {
     case SHA512 = "SHA-512"
     case SHA256 = "SHA-256"
 
     var hash: any HashFunction.Type {
         switch self {
         case .SHA256:
-            return CryptoKit.SHA256.self
+            return Crypto.SHA256.self
         case .SHA512:
-            return CryptoKit.SHA512.self
+            return Crypto.SHA512.self
         }
     }
 }