sauliuz / amokjs Goto Github PK

amock serves responses from response files.
we need example where values in static response file can be dynamically generated before sending then back to the client application.

Externalise current local file response feature as a npm module

• add plugin support for amok.
• this would allow for developers to create npm based plugins for amok and extend its capabilities based on their usecase.
• amok would contain few default plugins for serving responses from flat files, swagger files, s3 buckets etc.

amock should become standalone npm module.

With quick summary and how-to related to specific example projects

Usecase:
In some cases mock is required to reference the information from previous transaction. For example: if payment was created with specific transaction id mock should be able to refund the original transaction amount.

How
amok should leverage cache to store transaction data. If running in Apigee global cache can be used. For standalone usecase - should be researched.

For example mock should detect specific dynamic variables in the response files and replace them with dynamically generated values in the responses. Initially supported variables:
@Date@
@uuid@
@Transactionid@

Usecase
currentlly amok supports responses from the files stored within the node.js project. Developers might want to host response files on external hosts like Amazon S3 bucket, BaaS system etc.

How
introduce module support, with simple amok configuration pointing to which response file source is being used.

Use https://github.com/boo1ean/casual for template variable support

once amock becomes standalone npm module 2 example projects should be maintained. Apigee example and standalone.

Usecase:
Introduce steps to build Docker container image and upload it to Docker Hub. Add usage instructions.