parent 20986b6

author Khan Winter <[email protected]> 1627658421 -0500
committer Khan Winter <[email protected]> 1638459904 -0600

Fixed RPC builder, removed testing framework

Fixed a bug with the RPC builder setting the query builder's method to the RPC's schema.

Added a test for RPC functions.

Removed unnecessary testing framework.

Updated README.md

Add Test for RPC function call

Fix RPC builder bug

RPC builder was passing `schema` to the `method` property.

Rename `form` to `from`

Update PostgrestBuilder.swift

Make body content-type explicit

Make body content-type explicit

Actually make content-type explicit for JSON httpbody

Update PostgrestFilterBuilder.swift

Add return= option

Adds an enum `PostgrestReturningOptions` that specifies either a `minimal` or `representation` return from the PostgREST query.

This option is added to `insert`, `update`, and `delete`. In relation to issue #18

Author: thecoolwinter

Package.resolved

@@ -2,7 +2,7 @@
 
 ## Installation
 
-Swift client for [PostgREST](https://postgrest.org). The goal of this library is to make an "ORM-like" restful interface. 
+Swift client for [PostgREST](https://postgrest.org). The goal of this library is to make an "ORM-like" restful interface.
 
 ### Swift Package Manager
 
@@ -77,13 +77,39 @@ do {
 semaphore.wait()
 ```
 
+Execute an RPC
+
+```swift
+let client = PostgrestClient(url: "https://example.supabase.co", schema: nil)
+
+do {
+    try client.rpc(fn: "testFunction", parameters: nil).execute { result in
+        // Handle result
+    }
+} catch {
+   print("Error executing the RPC: \(error)")
+}
+```
+
+## Auth
+
+You can add authentication to the databases requests by using the `client.headers` property. For example to add a `Bearer` auth header, simply set the headers dictionary to:
+
+```swift
+let client = PostgrestClient(url: "https://example.supabase.co",
+                             headers: ["Bearer": "{ Insert Token Here }"]
+                             schema: nil)
+```
+
+All requests made using this client will be sent with the `Bearer Token` header.
+
 ## Contributing
 
-- Fork the repo on GitHub
-- Clone the project to your own machine
-- Commit changes to your own branch
-- Push your work back up to your fork
-- Submit a Pull request so that we can review your changes and merge
+-   Fork the repo on GitHub
+-   Clone the project to your own machine
+-   Commit changes to your own branch
+-   Push your work back up to your fork
+-   Submit a Pull request so that we can review your changes and merge
 
 ## License
 

README.md

@@ -142,15 +142,19 @@ public class PostgrestBuilder {
         }
 
         var request = URLRequest(url: url)
-        request.httpMethod = method
-        request.allHTTPHeaderFields = headers
+        
         if let body = body {
             if let httpBody = body as? Data {
                 request.httpBody = httpBody
             } else {
                 request.httpBody = try JSONSerialization.data(withJSONObject: body, options: [])
+                headers["Content-Type"] = "application/json"
             }
         }
+        
+        request.httpMethod = method
+        request.allHTTPHeaderFields = headers
+        
         return request
     }
 

Sources/PostgREST/PostgrestBuilder.swift

@@ -18,9 +18,9 @@ public class PostgrestQueryBuilder: PostgrestBuilder {
         )
     }
 
-    public func insert(values: Any, upsert: Bool = false, onConflict: String? = nil) -> PostgrestBuilder {
+    public func insert(values: Any, upsert: Bool = false, onConflict: String? = nil, returning: PostgrestReturningOptions = .representation) -> PostgrestBuilder {
         method = "POST"
-        headers["Prefer"] = upsert ? "return=representation,resolution=merge-duplicates" : "return=representation"
+        headers["Prefer"] = upsert ? "return=\(returning.rawValue),resolution=merge-duplicates" : "return=\(returning.rawValue)"
         if let onConflict = onConflict {
             appendSearchParams(name: "on_conflict", value: onConflict)
         }
@@ -29,9 +29,9 @@ public class PostgrestQueryBuilder: PostgrestBuilder {
         return self
     }
 
-    public func upsert(values: Any, onConflict: String? = nil) -> PostgrestBuilder {
+    public func upsert(values: Any, onConflict: String? = nil, returning: PostgrestReturningOptions = .representation) -> PostgrestBuilder {
         method = "POST"
-        headers["Prefer"] = "return=representation,resolution=merge-duplicates"
+        headers["Prefer"] = "return=\(returning.rawValue),resolution=merge-duplicates"
         if let onConflict = onConflict {
             appendSearchParams(name: "on_conflict", value: onConflict)
         }
@@ -40,19 +40,19 @@ public class PostgrestQueryBuilder: PostgrestBuilder {
         return self
     }
 
-    public func update(values: Any) -> PostgrestFilterBuilder {
+    public func update(values: Any, returning: PostgrestReturningOptions = .representation) -> PostgrestFilterBuilder {
         method = "PATCH"
-        headers["Prefer"] = "return=representation"
+        headers["Prefer"] = "return=\(returning.rawValue)"
         body = values
         return PostgrestFilterBuilder(
             url: url, queryParams: queryParams, headers: headers, schema: schema, method: method,
             body: body
         )
     }
 
-    public func delete() -> PostgrestFilterBuilder {
+    public func delete(returning: PostgrestReturningOptions = .representation) -> PostgrestFilterBuilder {
         method = "DELETE"
-        headers["Prefer"] = "return=representation"
+        headers["Prefer"] = "return=\(returning.rawValue)"
         return PostgrestFilterBuilder(
             url: url, queryParams: queryParams, headers: headers, schema: schema, method: method,
             body: body

Sources/PostgREST/PostgrestQueryBuilder.swift

@@ -0,0 +1,10 @@
+/// Enum of options representing the ways PostgREST can return values from the server.
+/// Options are:
+/// - minimal => Returns nothing from the server
+/// - representation => Returns a copy of the updated data.
+///
+/// https://postgrest.org/en/v9.0/api.html?highlight=PREFER#insertions-updates
+public enum PostgrestReturningOptions: String {
+    case minimal = "minimal"
+    case representation = "representation"
+}

Sources/PostgREST/PostgrestReturningOptions.swift

@@ -28,10 +28,10 @@ final class BuildURLRequestTests: XCTestCase {
                     .insert(values: ["email": "[email protected]"])
                     .buildURLRequest(head: false, count: nil)
             },
-            TestCase(name: "call rpc") { client in
+            TestCase(name: "call rpc", build: { client in
                 try client.rpc(fn: "test_fcn", parameters: ["KEY": "VALUE"])
                     .buildURLRequest(head: false, count: nil)
-            }
+            })
         ]
 
         for testCase in testCases {

Tests/PostgRESTTests/BuildURLRequestTests.swift

@@ -2,12 +2,9 @@
 import XCTest
 
 final class PostgRESTTests: XCTestCase {
-    func testExample() {
-        // This is an example of a functional test case.
-        // Use XCTAssert and related functions to verify your tests produce the correct
-        // results.
-//        XCTAssertEqual(PostgREST().text, "Hello, World!")
-    }
+    
+    func testBuildRPCRequest() throws {
+        let client = PostgrestClient(url: url, schema: nil)
 
     static var allTests = [
         ("testExample", testExample),