reneweb/hulk

Hulk is a web framework to create RESTful API's.

hulk's Issues

Introduce server side web socket support

It should be possible to provide mustache templates from file

Currently when using mustache templates it is required to pass the template itself as a string. It would be nice to have an option to pass in some file/path object and then read the template from the given file.

Consolidate action API

Currently there are three different types of action, which are Sync/Async/WebSocket action. It is not possible to implement filters for WebSocket actions and having Sync and Async actions makes it complex to create filters. I wouldn't mind dropping Sync action as most of the time people will use async anyway and there is Future.successful if you have some sync result and want to pass it to async action. There is still a question though how to enable filters for websocket action.

When filtering a ws response it should send a canel event to the used actor/stream

Currently we wouldn't send a cancel message when a filter is used that filters the response and thus the user has no chance to act on this (for example removing it from a list)

HAL/JSON LD support

Introduce support for x-www-form-urlencoded requests

Currently there is nothing provided that parses x-www-form-urlencoded requests into a nice format. It is still possible to get the raw bytes or as plain text, but it would be much nicer to have an appropriate structure.

Introduce oauth 2 provider

Increase test coverage

Currently the test coverage is ~63%. It should be at least above 70, better yet 80%.

Data for mustache requires to be java collections

The mustache template engine that is used requires that all the data structures used are java collections. The map that is passed as the root collection is already translated into a java collection. However, if there are nested collections these are currently not converted and therefore need to be converted by the user. The solution should be to recursively check the nested objects for convertable collection types (convertable via the JavaConverters) and then do the conversion if possible. Other solution would be to look for another mustache templating engine that already supports scala.

Look at coda city issues

There are some valid code quality issues that should be looked at.

Extend readme

The read me currently only covers the very basic usage. It should be extended to include more usage information.

Upgrade to akka http 2.4.2

Consolidate filter API

Currently filters are different for global ones vs action specific ones. Would be nice to consolidate (this could also be useful to introduce filters in websocket actions.

Rate limiting doesn't work properly with DefaultEhCache if requests are sent extremly fast

When using the DefaultEhCache, storing and retrieving values is using futures. If there are request coming in extremely fast, the first one might still be stored (i.e. the counter will be increased), while the second one is already reading the value and thus gets a wrong result.

Currently it is only possible to give one actor to the whole action

It should be possible to give a specific sender actor for each new ws channel (also possibly something similar for receiving).