feat: implemented initial version of schema validation #195

[richardruiter]

Description

Please include a summary of the change and which issue is fixed.

Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes #195

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Test Configuration:

• OS: OSX
• Node version: 18.4.0
• NPM Version: 8.12.1

Checklist:

• My code follows the guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• This does not break any existing functionalities
• Any dependent changes have been merged and published in downstream modules

[richardruiter]

I made changes to the HttpParser that I'm insecure about. I needed to postpone sending a status and/or body in order to validate it. Need guidance to see if I don't break anything.

[shubhendumadhukar]

Changes look good. Some modification suggestions in HttpParser:

• Redundant reassignments of status code

https://github.com/richardruiter/camouflage/blob/082473b24c3fd8e60ef034bae6a56a7e8ea9f717/src/parser/HttpParser.ts#L91

https://github.com/richardruiter/camouflage/blob/082473b24c3fd8e60ef034bae6a56a7e8ea9f717/src/parser/HttpParser.ts#L169

https://github.com/richardruiter/camouflage/blob/082473b24c3fd8e60ef034bae6a56a7e8ea9f717/src/parser/HttpParser.ts#L187

First two instances (Line 91 and 169 can be removed), whereas 3rd instance can be modified from response.status = codeResponse["status"] || this.res.statusCode; to response.status = codeResponse["status"];

• Finally we should append headers to the response object, incase validations need to carried out on headers as well. We can add response.headers[headerKey] = headerValue; after following line

https://github.com/richardruiter/camouflage/blob/082473b24c3fd8e60ef034bae6a56a7e8ea9f717/src/parser/HttpParser.ts#L160

[richardruiter]

Added docs. Can we merge it?

[github-actions]

🎉 This PR is included in version 0.13.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀