-
-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
596955b
commit e582534
Showing
11 changed files
with
352 additions
and
129 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
|
|
||
| ## Thingifier as a Library | ||
|
|
||
| This is a work in progress so it currently has a hard coded models of a small TODO application. | ||
|
|
||
| The models are found in the `examplemodels` module. | ||
|
|
||
| --- | ||
|
|
||
| ## Model | ||
|
|
||
| Entities: | ||
|
|
||
| - todo | ||
| - Fields: | ||
| - doneStatus | ||
| - guid | ||
| - description | ||
| - title | ||
| - project | ||
| - Fields: | ||
| - guid | ||
| - description | ||
| - active | ||
| - completed | ||
| - title | ||
| - category | ||
| - Fields: | ||
| - guid | ||
| - description | ||
| - title | ||
|
|
||
| Relationships: | ||
|
|
||
| - projects : category => project | ||
| - categories : todo => category | ||
| - todos : category => todo | ||
| - tasks : project => todo | ||
|
|
||
| ### Resulting REST API | ||
|
|
||
| This generates the following REST API automatically | ||
|
|
||
| - /todos | ||
| - GET - all the todos | ||
| - POST - create a todo - body JSON | ||
| - OPTIONS | ||
| - /todos/_GUID_ | ||
| - GET - a specific todo | ||
| - DELETE - a specific todo | ||
| - POST - amend the todo | ||
| - PUT - replace all the todo fields in the JSON body | ||
| - OPTIONS | ||
| - /todos/_GUID_/categories | ||
| - GET - all the categories for a todo | ||
| - POST - create a todo - body JSON must contain a GUID for a category e.g. `{"guid":"1234-1234-1234-1234"}` | ||
|
|
||
| Similar for `/projects` and `/categories` | ||
|
|
||
| The JSON body for creating and amending is simply | ||
|
|
||
| `{"fieldname":"fieldvalue", "anotherFieldName":"anotherValue", etc.}` | ||
|
|
||
| The XML body for creating and amending is simply | ||
|
|
||
| `<entity><fieldname>fieldvalue></fieldname><anotherFieldName>anotherValue</anotherFieldName><entity>` | ||
|
|
||
| e.g. | ||
|
|
||
| `<todo><title>my title</title></todo>` | ||
|
|
||
| The fieldnames are shown in the list above for the model or the code below. | ||
|
|
||
| The REST API has some guards to check for 404s but very little error handling and no enforcement of mandatory fields etc. | ||
|
|
||
| But it is a workable API and all details are stored in memory. | ||
|
|
||
| The deployed app does have some sample data for testing purposes, this can easily be `DELETE`d using the API. | ||
|
|
||
| ### Code for Model | ||
|
|
||
| ~~~~~~~~ | ||
| Thing todo = todoManager.createThing("todo", "todos"); | ||
| todo.definition() | ||
| .addFields(Field.is("title", STRING). | ||
| mandatory(). | ||
| withValidation( | ||
| VRule.notEmpty(), | ||
| VRule.matchesType()), | ||
| Field.is("description", STRING), | ||
| Field.is("doneStatus", FieldType.BOOLEAN). | ||
| withDefaultValue("FALSE"). | ||
| withValidation( | ||
| VRule.matchesType())); | ||
| Thing project = todoManager.createThing("project", "projects"); | ||
| project.definition() | ||
| .addFields( | ||
| Field.is("title", STRING), | ||
| Field.is("description", STRING), | ||
| Field.is("completed", FieldType.BOOLEAN). | ||
| withDefaultValue("FALSE"). | ||
| withValidation(VRule.matchesType()), | ||
| Field.is("active", FieldType.BOOLEAN). | ||
| withDefaultValue("TRUE"). | ||
| withValidation(VRule.matchesType())); | ||
| Thing category = todoManager.createThing("category", "categories"); | ||
| category.definition() | ||
| .addFields( | ||
| Field.is("title", STRING). | ||
| mandatory(). | ||
| withValidation(VRule.notEmpty()), | ||
| Field.is("description", STRING)); | ||
| todoManager.defineRelationship(Between.things(project, todo), AndCall.it("tasks"), WithCardinality.of("1", "*")). | ||
| whenReversed(WithCardinality.of("1", "*"), AndCall.it("task-of")); | ||
| todoManager.defineRelationship(Between.things(project, category), AndCall.it("categories"), WithCardinality.of("1", "*")); | ||
| todoManager.defineRelationship(Between.things(category, todo), AndCall.it("todos"), WithCardinality.of("1", "*")); | ||
| todoManager.defineRelationship(Between.things(category, project), AndCall.it("projects"), WithCardinality.of("1", "*")); | ||
| todoManager.defineRelationship(Between.things(todo, category), AndCall.it("categories"), WithCardinality.of("1", "*")); | ||
| ~~~~~~~~ | ||
|
|
9 changes: 9 additions & 0 deletions
9
thingifier/src/main/java/uk/co/compendiumdev/thingifier/application/PreRequestHook.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| package uk.co.compendiumdev.thingifier.application; | ||
|
|
||
| import spark.Request; | ||
| import spark.Response; | ||
|
|
||
| public interface PreRequestHook { | ||
| // return false if we want to 'stop' the request | ||
| boolean run(Request request, Response response); | ||
| } |
Oops, something went wrong.