Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Hax-io/libpb
PocketBase wrapper with serializer/deserializer support
https://github.com/Hax-io/libpb
Last synced: 24 days ago
JSON representation
PocketBase wrapper with serializer/deserializer support
- Host: GitHub
- URL: https://github.com/Hax-io/libpb
- Owner: Hax-io
- License: lgpl-3.0
- Created: 2022-12-29T13:22:14.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-06-18T11:35:02.000Z (over 1 year ago)
- Last Synced: 2024-07-31T20:38:48.916Z (4 months ago)
- Language: D
- Size: 72.3 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-pocketbase - GitHub - 3.0 | (D)
- awesome-pocketbase - GitHub - 3.0 | (D)
- awesome-pocketbase - libpb - PocketBase client wrapper for D with automatic serialization and deserialization to and from JSON.  (D)
- awesome-d - libpb - INteract with a PocketBase database (Database clients / XML)
README
libpb
=====
#### _PocketBase wrapper with serializer/deserializer support_
----
## Example usage
View the full API documentation (methods etc.) [here](https://libpb.dpldocs.info/libpb.html).
### Server initiation
Firstly we create a new PocketBase instance to manage our server:
```d
PocketBase pb = new PocketBase("http://127.0.0.1:8090/api/");
```
### Serialization
This is just to show off the serialization method `serializeRecord(RecordType)` which returns a `JSONValue` struct:
```d
import std.algorithm.searching : canFind;
import std.string : cmp;
struct Person
{
public string firstname, lastname;
public int age;
public string[] list;
public JSONValue extraJSON;
public EnumType eType;
}
Person p1;
p1.firstname = "Tristan";
p1.lastname = "Kildaire";
p1.age = 23;
p1.list = ["1", "2", "3"];
p1.extraJSON = parseJSON(`{"item":1, "items":[1,2,3]}`);
p1.eType = EnumType.CAT;
JSONValue serialized = serializeRecord(p1);
string[] keys = serialized.object().keys();
assert(canFind(keys, "firstname") && cmp(serialized["firstname"].str(), "Tristan") == 0);
assert(canFind(keys, "lastname") && cmp(serialized["lastname"].str(), "Kildaire") == 0);
assert(canFind(keys, "age") && serialized["age"].integer() == 23);
debug(dbg)
{
writeln(serialized.toPrettyString());
}
```
### Deserialization
This is to show off deserialization method `fromJSON(RecordType)(JSONValue jsonIn)` which returns a struct of type `RecordType` (so far most features are implemented):
```d
import std.string : cmp;
struct Person
{
public string firstname, lastname;
public int age;
public bool isMale;
public JSONValue obj;
public int[] list;
}
JSONValue json = parseJSON(`{
"firstname" : "Tristan",
"lastname": "Kildaire",
"age": 23,
"obj" : {"bruh":1},
"isMale": true,
"list": [1,2,3]
}
`);
Person person = fromJSON!(Person)(json);
debug(dbg)
{
writeln(person);
}
assert(cmp(person.firstname, "Tristan") == 0);
assert(cmp(person.lastname, "Kildaire") == 0);
assert(person.age == 23);
assert(person.isMale == true);
assert(person.obj["bruh"].integer() == 1);
//TODO: list test case
```
### Record management
#### Normal collections
Below we have a few calls like create and delete:
```d
PocketBase pb = new PocketBase();
struct Person
{
string id;
string name;
int age;
}
Person p1 = Person();
p1.name = "Tristan Gonzales";
p1.age = 23;
Person recordStored = pb.createRecord("dummy", p1);
pb.deleteRecord("dummy", recordStored.id);
recordStored = pb.createRecord("dummy", p1);
recordStored.age = 46;
recordStored = pb.updateRecord("dummy", recordStored);
Person recordFetched = pb.viewRecord!(Person)("dummy", recordStored.id);
pb.deleteRecord("dummy", recordStored);
Person[] people = [Person(), Person()];
people[0].name = "Abby";
people[1].name = "Becky";
people[0] = pb.createRecord("dummy", people[0]);
people[1] = pb.createRecord("dummy", people[1]);
Person[] returnedPeople = pb.listRecords!(Person)("dummy");
foreach(Person returnedPerson; returnedPeople)
{
writeln(returnedPerson);
pb.deleteRecord("dummy", returnedPerson);
}
```
#### `auth` collections
Auth collections require that certain calls, such as `createRecord(table, record, isAuthCollection)` have the last argument se to `true`.
```d
import core.thread : Thread, dur;
import std.string : cmp;
PocketBase pb = new PocketBase();
struct Person
{
string id;
string email;
string username;
string password;
string passwordConfirm;
}
Person p1;
p1.email = "[email protected]";
p1.username = "deavmi";
p1.password = "bigbruh1111";
p1.passwordConfirm = "bigbruh1111";
p1 = pb.createRecordAuth("dummy_auth", p1);
pb.deleteRecord("dummy_auth", p1);
```
## Development
### Dependencies
This requires that you have the `libcurl` libraries available for
linking against.
### Unit tests
To run tests you will want to enable the `pragma`s and `writeln`s. therefore pass the `dbg` flag in as such:
```bash
dub test -ddbg
```
Run pocketbase on the default port and then use the schema provided as `dummy.json` to test with (in a collection named `dummy`).
## License
See [LICENSE](LICENSE)