From 3c6a81791b6187e9d245810382b976494788c39a Mon Sep 17 00:00:00 2001 From: "Tristan B. Velloza Kildaire" Date: Thu, 29 Dec 2022 15:24:07 +0200 Subject: [PATCH] Initial commit --- .gitignore | 16 ++++ LICENSE | 165 ++++++++++++++++++++++++++++++++ README.md | 14 +++ dub.json | 9 ++ source/app.d | 260 +++++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 464 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 dub.json create mode 100644 source/app.d diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..915ecb7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,16 @@ +.dub +docs.json +__dummy.html +docs/ +/libpb +libpb.so +libpb.dylib +libpb.dll +libpb.a +libpb.lib +libpb-test-* +*.exe +*.pdb +*.o +*.obj +*.lst diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0a04128 --- /dev/null +++ b/LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2872378 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +libpb +===== + +#### _PocketBase wrapper with serializer/deserializer support_ + +---- + +## Example usage + +TODO + +## License + +See [LICENSE](LICENSE) diff --git a/dub.json b/dub.json new file mode 100644 index 0000000..3ba2b6a --- /dev/null +++ b/dub.json @@ -0,0 +1,9 @@ +{ + "authors": [ + "Tristan B. Velloza Kildaire" + ], + "copyright": "Copyright © 2022, Tristan B. Velloza Kildaire", + "description": "PocketBase wrapper with serializer/deserializer support", + "license": "LGPL v3.0", + "name": "libpb" +} \ No newline at end of file diff --git a/source/app.d b/source/app.d new file mode 100644 index 0000000..9e18e2e --- /dev/null +++ b/source/app.d @@ -0,0 +1,260 @@ +import std.json; +import std.stdio; +import std.net.curl; +import std.conv : to; + +public final class PBException : Exception +{ + public enum ErrorType + { + CURL_NETWORK_ERROR, + JSON_PARSE_ERROR + } + + private ErrorType errType; + + this(ErrorType errType, string msg) + { + this.errType = errType; + super("PBException("~to!(string)(errType)~"): "~msg); + } +} + +public class PocketBase +{ + private string pocketBaseURL; + + this(string pocketBaseURL = "http://127.0.0.1:8090/api/") + { + this.pocketBaseURL = pocketBaseURL; + } + + public JSONValue listRecords(string table, ulong page = 1, ulong perPage = 30) + { + // Compute the query string + string queryStr = "page="~to!(string)(page)~"&perPage="~to!(string)(perPage); + + try + { + string responseData = cast(string)get(pocketBaseURL~"collections/"~table~"/records?"~queryStr); + JSONValue responseJSON = parseJSON(responseData); + + return responseJSON; + } + catch(CurlException e) + { + throw new PBException(PBException.ErrorType.CURL_NETWORK_ERROR, e.msg); + } + catch(JSONException e) + { + throw new PBException(PBException.ErrorType.JSON_PARSE_ERROR, e.msg); + } + } + + public JSONValue createRecord(string, RecordType)(string table, RecordType item) + { + HTTP httpSettings = HTTP(); + httpSettings.addRequestHeader("Content-Type", "application/json"); + + // Serialize the record instance + JSONValue serialized = serializeRecord(item); + + try + { + string responseData = cast(string)post(pocketBaseURL~"collections/"~table~"/records", serialized.toString(), httpSettings); + JSONValue responseJSON = parseJSON(responseData); + + return responseJSON; + } + catch(CurlException e) + { + throw new PBException(PBException.ErrorType.CURL_NETWORK_ERROR, e.msg); + } + catch(JSONException e) + { + throw new PBException(PBException.ErrorType.JSON_PARSE_ERROR, e.msg); + } + } + + public JSONValue updateRecord(string, RecordType)(string table, RecordType item) + { + HTTP httpSettings = HTTP(); + httpSettings.addRequestHeader("Content-Type", "application/json"); + + // Serialize the record instance + JSONValue serialized = serializeRecord(item); + + try + { + string responseData = cast(string)patch(pocketBaseURL~"collections/"~table~"/records/"~item.id, serialized.toString(), httpSettings); + JSONValue responseJSON = parseJSON(responseData); + + return responseJSON; + } + catch(CurlException e) + { + throw new PBException(PBException.ErrorType.CURL_NETWORK_ERROR, e.msg); + } + catch(JSONException e) + { + throw new PBException(PBException.ErrorType.JSON_PARSE_ERROR, e.msg); + } + } + + public static JSONValue serializeRecord(RecordType)(RecordType record) + { + import std.traits; + import std.meta : AliasSeq; + + // Final JSON to submit + JSONValue builtJSON; + + + // Alias as to only expand later when used in compile-time + alias structTypes = FieldTypeTuple!(RecordType); + alias structNames = FieldNameTuple!(RecordType); + alias structValues = record.tupleof; + + static foreach(cnt; 0..structTypes.length) + { + pragma(msg, structTypes[cnt]); + pragma(msg, structNames[cnt]); + // pragma(msg, structValues[cnt]); + + builtJSON[structNames[cnt]] = structValues[cnt]; + } + + writeln(builtJSON.toPrettyString()); + + return builtJSON; + } + + public static fromJSON(RecordType)(JSONValue jsonIn) + { + RecordType record; + + import std.traits; + import std.meta : AliasSeq; + + // Alias as to only expand later when used in compile-time + alias structTypes = FieldTypeTuple!(RecordType); + alias structNames = FieldNameTuple!(RecordType); + alias structValues = record.tupleof; + + static foreach(cnt; 0..structTypes.length) + { + pragma(msg, structTypes[cnt]); + pragma(msg, structNames[cnt]); + // pragma(msg, structValues[cnt]); + + //TODO: Add all integral types + static if(__traits(isSame, mixin(structTypes[cnt]), int)) + { + mixin("record."~structNames[cnt]) = cast(int)jsonIn[structNames[cnt]].integer(); + } + static if(__traits(isSame, mixin(structTypes[cnt]), uint)) + { + mixin("record."~structNames[cnt]) = cast(uint)jsonIn[structNames[cnt]].integer(); + } + static if(__traits(isSame, mixin(structTypes[cnt]), ulong)) + { + mixin("record."~structNames[cnt]) = cast(ulong)jsonIn[structNames[cnt]].integer(); + } + static if(__traits(isSame, mixin(structTypes[cnt]), long)) + { + mixin("record."~structNames[cnt]) = cast(long)jsonIn[structNames[cnt]].integer(); + } + static if(__traits(isSame, mixin(structTypes[cnt]), string)) + { + mixin("record."~structNames[cnt]) = jsonIn[structNames[cnt]].str(); + pragma(msg,"record."~structNames[cnt]); + } + static if(__traits(isSame, mixin(structTypes[cnt]), JSONValue)) + { + mixin("record."~structNames[cnt]) = jsonIn[structNames[cnt]]; + pragma(msg,"record."~structNames[cnt]); + } + static if(__traits(isSame, mixin(structTypes[cnt]), bool)) + { + mixin("record."~structNames[cnt]) = jsonIn[structNames[cnt]].boolean(); + pragma(msg,"record."~structNames[cnt]); + } + //FIXME: Not sure how to get array support going, very new to meta programming + static if(__traits(isSame, mixin(structTypes[cnt]), mixin(structTypes[cnt])[])) + { + mixin("record."~structNames[cnt]) = jsonIn[structNames[cnt]].boolean(); + pragma(msg,"record."~structNames[cnt]); + } + } + + return record; + } + +} + + + + +// Test serialization of a struct to JSON +unittest +{ + import std.algorithm.searching : canFind; + import std.string : cmp; + + struct Person + { + public string firstname, lastname; + public int age; + public string[] list; + public JSONValue extraJSON; + } + + 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]}`); + + JSONValue serialized = PocketBase.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); +} + + +unittest +{ + 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 = PocketBase.fromJSON!(Person)(json); + + writeln(person); + + assert(cmp(person.firstname, "Tristan") == 0); + assert(cmp(person.lastname, "Kildaire") == 0); + assert(person.age == 23); + assert(person.isMale == true); + //TODO: object test case, list test case +}