diff --git a/.idea/.name b/.idea/.name index accd5c2..4ce8d05 100644 --- a/.idea/.name +++ b/.idea/.name @@ -1 +1 @@ -Playground \ No newline at end of file +Spine \ No newline at end of file diff --git a/.idea/runConfigurations/Run.xml b/.idea/runConfigurations/Run.xml deleted file mode 100644 index 4fe8d2e..0000000 --- a/.idea/runConfigurations/Run.xml +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - - true - true - false - false - - - \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6e855d2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2023 OpenSavvy + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index f3fd9b9..61c7613 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,22 @@ -# Playground: Gradle +# Spine: Typesafe HTTP APIs with Ktor and Arrow - -This a template to easily bootstrap your projects. +OpenSavvy Spine is a library to declare typesafe endpoints in code shared between your multiplatform clients and servers. -> This project is part of the OpenSavvy Playground. -> To learn more, visit [this page](docs/playground/README.md). +## Typed Ktor + +Typed Ktor is an effort to bring type safety to multiplatform Ktor projects: by declaring endpoints and DTOs in common code, we can avoid many bugs. + +## Safe Ktor + +Safe Ktor is a collection of DSLs to make error management in HTTP endpoints explicit, using Arrow. + +## Spine + +Spine is the combination of Typed and Safe Ktor. ## License - - +This project is licensed under the [Apache 2.0 license](LICENSE). ## Contributing diff --git a/build.gradle.kts b/build.gradle.kts index 04ac20c..4d08825 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -18,7 +18,15 @@ plugins { dependencies { // List the 'library' projects - // dokkatoo(projects.core) + dokkatoo(projects.typedShared) + dokkatoo(projects.typedServer) + dokkatoo(projects.typedClient) + dokkatoo(projects.safeShared) + dokkatoo(projects.safeServer) + dokkatoo(projects.safeClient) + dokkatoo(projects.spineShared) + dokkatoo(projects.spineServer) + dokkatoo(projects.spineClient) } // region Check the users of the project didn't forget to rename the group diff --git a/demo-client/build.gradle.kts b/demo-client/build.gradle.kts new file mode 100644 index 0000000..0168d6a --- /dev/null +++ b/demo-client/build.gradle.kts @@ -0,0 +1,21 @@ +plugins { + alias(opensavvyConventions.plugins.base) + alias(opensavvyConventions.plugins.kotlin.internal) +} + +kotlin { + jvm() + js { + browser() + nodejs() + } + linuxX64() + // iosArm64() + // iosSimulatorArm64() + // iosX64() + + sourceSets.commonMain.dependencies { + api(projects.spineClient) + api(projects.demoShared) + } +} diff --git a/demo-server/build.gradle.kts b/demo-server/build.gradle.kts new file mode 100644 index 0000000..77d746f --- /dev/null +++ b/demo-server/build.gradle.kts @@ -0,0 +1,14 @@ +plugins { + alias(opensavvyConventions.plugins.base) + alias(opensavvyConventions.plugins.kotlin.internal) +} + +kotlin { + jvm() + linuxX64() + + sourceSets.commonMain.dependencies { + api(projects.spineServer) + api(projects.demoShared) + } +} diff --git a/demo-shared/build.gradle.kts b/demo-shared/build.gradle.kts new file mode 100644 index 0000000..a8c86ff --- /dev/null +++ b/demo-shared/build.gradle.kts @@ -0,0 +1,20 @@ +plugins { + alias(opensavvyConventions.plugins.base) + alias(opensavvyConventions.plugins.kotlin.internal) +} + +kotlin { + jvm() + js { + browser() + nodejs() + } + linuxX64() + // iosArm64() + // iosSimulatorArm64() + // iosX64() + + sourceSets.commonMain.dependencies { + api(projects.spineShared) + } +} diff --git a/gradle.properties b/gradle.properties index 75d1cef..334b5f0 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,5 +1,5 @@ # Maven coordinates -appGroup=dev.opensavvy.playground +appGroup=dev.opensavvy.spine # Allow Gradle to execute tasks from different subprojects in parallel. org.gradle.parallel=true diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index d7e5a2c..1067d86 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -1,9 +1,30 @@ # List of dependencies of the project [versions] +# https://github.com/ktorio/ktor/releases +ktor = "2.3.7" + +# https://github.com/arrow-kt/arrow/releases +arrow = "1.2.1" + +# https://gitlab.com/opensavvy/prepared/-/releases +prepared = "0.6.0" [plugins] [libraries] +ktor-server-core = { module = "io.ktor:ktor-server-core", version.ref = "ktor" } +ktor-server-testHost = { module = "io.ktor:ktor-server-test-host", version.ref = "ktor" } +ktor-server-contentNegotiation = { module = "io.ktor:ktor-server-content-negotiation", version.ref = "ktor" } +ktor-client-core = { module = "io.ktor:ktor-client-core", version.ref = "ktor" } +ktor-client-contentNegotiation = { module = "io.ktor:ktor-client-content-negotiation", version.ref = "ktor" } +ktor-client-logging = { module = "io.ktor:ktor-client-logging", version.ref = "ktor" } +ktor-http = { module = "io.ktor:ktor-http", version.ref = "ktor" } +ktor-kotlinxJson = { module = "io.ktor:ktor-serialization-kotlinx-json", version.ref = "ktor" } + +arrow-core = { module = "io.arrow-kt:arrow-core", version.ref = "arrow" } + +prepared = { module = "dev.opensavvy.prepared:runner-kotest", version.ref = "prepared" } +prepared-arrow = { module = "dev.opensavvy.prepared:compat-arrow", version.ref = "prepared" } [bundles] diff --git a/safe-client/build.gradle.kts b/safe-client/build.gradle.kts new file mode 100644 index 0000000..1a3735b --- /dev/null +++ b/safe-client/build.gradle.kts @@ -0,0 +1,38 @@ +plugins { + alias(opensavvyConventions.plugins.base) + alias(opensavvyConventions.plugins.kotlin.library) +} + +kotlin { + jvm() + js { + browser() + nodejs() + } + linuxX64() + // iosArm64() + // iosSimulatorArm64() + // iosX64() + + sourceSets.commonMain.dependencies { + api(projects.safeShared) + + api(libs.ktor.client.core) + } + + sourceSets.commonTest.dependencies { + implementation(libs.prepared) + implementation(libs.prepared.arrow) + } +} + +library { + name.set("Safe Ktor (shared code)") + description.set("Ktor endpoints with explicit error management using Arrow") + homeUrl.set("https://gitlab.com/opensavvy/spine") + + license.set { + name.set("Apache 2.0") + url.set("https://www.apache.org/licenses/LICENSE-2.0.txt") + } +} diff --git a/safe-server/build.gradle.kts b/safe-server/build.gradle.kts new file mode 100644 index 0000000..7fbd5df --- /dev/null +++ b/safe-server/build.gradle.kts @@ -0,0 +1,31 @@ +plugins { + alias(opensavvyConventions.plugins.base) + alias(opensavvyConventions.plugins.kotlin.library) +} + +kotlin { + jvm() + linuxX64() + + sourceSets.commonMain.dependencies { + api(projects.typedShared) + + api(libs.ktor.server.core) + } + + sourceSets.commonTest.dependencies { + implementation(libs.prepared) + implementation(libs.prepared.arrow) + } +} + +library { + name.set("Safe Ktor (server-side)") + description.set("Ktor endpoints with explicit error management using Arrow") + homeUrl.set("https://gitlab.com/opensavvy/spine") + + license.set { + name.set("Apache 2.0") + url.set("https://www.apache.org/licenses/LICENSE-2.0.txt") + } +} diff --git a/safe-shared/build.gradle.kts b/safe-shared/build.gradle.kts new file mode 100644 index 0000000..67a1a7b --- /dev/null +++ b/safe-shared/build.gradle.kts @@ -0,0 +1,37 @@ +plugins { + alias(opensavvyConventions.plugins.base) + alias(opensavvyConventions.plugins.kotlin.library) +} + +kotlin { + jvm() + js { + browser() + nodejs() + } + linuxX64() + // iosArm64() + // iosSimulatorArm64() + // iosX64() + + sourceSets.commonMain.dependencies { + api(libs.arrow.core) + api(libs.ktor.http) + } + + sourceSets.commonTest.dependencies { + implementation(libs.prepared) + implementation(libs.prepared.arrow) + } +} + +library { + name.set("Safe Ktor (shared code)") + description.set("Ktor endpoints with explicit error management using Arrow") + homeUrl.set("https://gitlab.com/opensavvy/spine") + + license.set { + name.set("Apache 2.0") + url.set("https://www.apache.org/licenses/LICENSE-2.0.txt") + } +} diff --git a/settings.gradle.kts b/settings.gradle.kts index 473e24b..fc0c5dc 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -7,7 +7,7 @@ * in the user manual at https://docs.gradle.org/8.1.1/userguide/multi_project_builds.html */ -rootProject.name = "Playground" +rootProject.name = "Spine" pluginManagement { repositories { @@ -28,4 +28,20 @@ plugins { include( "gradle:templates:template-app", "gradle:templates:template-lib", + + "typed-shared", + "typed-server", + "typed-client", + + "safe-shared", + "safe-server", + "safe-client", + + "spine-shared", + "spine-server", + "spine-client", + + "demo-shared", + "demo-server", + "demo-client", ) diff --git a/spine-client/build.gradle.kts b/spine-client/build.gradle.kts new file mode 100644 index 0000000..94bdf7f --- /dev/null +++ b/spine-client/build.gradle.kts @@ -0,0 +1,39 @@ +plugins { + alias(opensavvyConventions.plugins.base) + alias(opensavvyConventions.plugins.kotlin.library) +} + +kotlin { + jvm() + js { + browser() + nodejs() + } + linuxX64() + // iosArm64() + // iosSimulatorArm64() + // iosX64() + + sourceSets.commonMain.dependencies { + api(projects.spineShared) + + api(projects.typedClient) + api(projects.safeClient) + } + + sourceSets.commonTest.dependencies { + implementation(libs.prepared) + implementation(libs.prepared.arrow) + } +} + +library { + name.set("Spine (server-side)") + description.set("Typesafe HTTP APIs with Ktor and Arrow") + homeUrl.set("https://gitlab.com/opensavvy/spine") + + license.set { + name.set("Apache 2.0") + url.set("https://www.apache.org/licenses/LICENSE-2.0.txt") + } +} diff --git a/spine-server/build.gradle.kts b/spine-server/build.gradle.kts new file mode 100644 index 0000000..4881f19 --- /dev/null +++ b/spine-server/build.gradle.kts @@ -0,0 +1,32 @@ +plugins { + alias(opensavvyConventions.plugins.base) + alias(opensavvyConventions.plugins.kotlin.library) +} + +kotlin { + jvm() + linuxX64() + + sourceSets.commonMain.dependencies { + api(projects.spineShared) + + api(projects.typedServer) + api(projects.safeServer) + } + + sourceSets.commonTest.dependencies { + implementation(libs.prepared) + implementation(libs.prepared.arrow) + } +} + +library { + name.set("Spine (server-side)") + description.set("Typesafe HTTP APIs with Ktor and Arrow") + homeUrl.set("https://gitlab.com/opensavvy/spine") + + license.set { + name.set("Apache 2.0") + url.set("https://www.apache.org/licenses/LICENSE-2.0.txt") + } +} diff --git a/spine-shared/build.gradle.kts b/spine-shared/build.gradle.kts new file mode 100644 index 0000000..e74bae5 --- /dev/null +++ b/spine-shared/build.gradle.kts @@ -0,0 +1,37 @@ +plugins { + alias(opensavvyConventions.plugins.base) + alias(opensavvyConventions.plugins.kotlin.library) +} + +kotlin { + jvm() + js { + browser() + nodejs() + } + linuxX64() + // iosArm64() + // iosSimulatorArm64() + // iosX64() + + sourceSets.commonMain.dependencies { + api(projects.typedShared) + api(projects.safeShared) + } + + sourceSets.commonTest.dependencies { + implementation(libs.prepared) + implementation(libs.prepared.arrow) + } +} + +library { + name.set("Spine (shared code)") + description.set("Typesafe HTTP APIs with Ktor and Arrow") + homeUrl.set("https://gitlab.com/opensavvy/spine") + + license.set { + name.set("Apache 2.0") + url.set("https://www.apache.org/licenses/LICENSE-2.0.txt") + } +} diff --git a/typed-client/build.gradle.kts b/typed-client/build.gradle.kts new file mode 100644 index 0000000..77af020 --- /dev/null +++ b/typed-client/build.gradle.kts @@ -0,0 +1,38 @@ +plugins { + alias(opensavvyConventions.plugins.base) + alias(opensavvyConventions.plugins.kotlin.library) +} + +kotlin { + jvm() + js { + browser() + nodejs() + } + linuxX64() + // iosArm64() + // iosSimulatorArm64() + // iosX64() + + sourceSets.commonMain.dependencies { + api(projects.typedShared) + + api(libs.ktor.client.core) + } + + sourceSets.commonTest.dependencies { + implementation(libs.prepared) + implementation(libs.prepared.arrow) + } +} + +library { + name.set("Typed Ktor (client-side)") + description.set("Typesafe HTTP APIs with Ktor") + homeUrl.set("https://gitlab.com/opensavvy/spine") + + license.set { + name.set("Apache 2.0") + url.set("https://www.apache.org/licenses/LICENSE-2.0.txt") + } +} diff --git a/typed-server/build.gradle.kts b/typed-server/build.gradle.kts new file mode 100644 index 0000000..ca78a2e --- /dev/null +++ b/typed-server/build.gradle.kts @@ -0,0 +1,31 @@ +plugins { + alias(opensavvyConventions.plugins.base) + alias(opensavvyConventions.plugins.kotlin.library) +} + +kotlin { + jvm() + linuxX64() + + sourceSets.commonMain.dependencies { + api(projects.typedShared) + + api(libs.ktor.server.core) + } + + sourceSets.commonTest.dependencies { + implementation(libs.prepared) + implementation(libs.prepared.arrow) + } +} + +library { + name.set("Typed Ktor (server-side)") + description.set("Typesafe HTTP APIs with Ktor") + homeUrl.set("https://gitlab.com/opensavvy/spine") + + license.set { + name.set("Apache 2.0") + url.set("https://www.apache.org/licenses/LICENSE-2.0.txt") + } +} diff --git a/typed-shared/build.gradle.kts b/typed-shared/build.gradle.kts new file mode 100644 index 0000000..df6c263 --- /dev/null +++ b/typed-shared/build.gradle.kts @@ -0,0 +1,36 @@ +plugins { + alias(opensavvyConventions.plugins.base) + alias(opensavvyConventions.plugins.kotlin.library) +} + +kotlin { + jvm() + js { + browser() + nodejs() + } + linuxX64() + // iosArm64() + // iosSimulatorArm64() + // iosX64() + + sourceSets.commonMain.dependencies { + api(libs.ktor.http) + } + + sourceSets.commonTest.dependencies { + implementation(libs.prepared) + implementation(libs.prepared.arrow) + } +} + +library { + name.set("Typed Ktor (shared code)") + description.set("Typesafe HTTP APIs with Ktor") + homeUrl.set("https://gitlab.com/opensavvy/spine") + + license.set { + name.set("Apache 2.0") + url.set("https://www.apache.org/licenses/LICENSE-2.0.txt") + } +}