HTTP API support

[princejoogie]

Finished all HTTP APIs for #11 and fixed bug of #31

NEW CHANGES

1. Positional arguments to Object arguments

opted for object arguments because a lot of the remaining apis have optional params which is weird if done with positional arguments. e.g:

// BEFORE: in createRoom POST route, the parameters map, sourceSpace, and reason are optional
// if you want to leave sourceSpace null, then you would need to add an..
// extra comma to surpass that argument; which is not intuitive
await createRoom(name, map, , reason)

// AFTER: if you want to leave sourceSpace null, then just dont pass it along as an argument
// intuitive and better practice
await createRoom({ name, map, reason });

2. Re-wrote requester and separated each API route

current function _sendRequest only supports get routes.
created an api which contains individual routes per file.
Sample:

EXAMPLES

• examples for each HTTP route is under src/examples/index.ts. this file can be executed directly without compiling with
• npx ts-node src/examples/index.ts
• to be able to run successfully, the API_KEY variable should be changed accordingly as well as SPACE_ID_1 and SPACE_ID_2
• apikeys can be generated at https://gather.town/apiKeys
• SPACE_ID_2 is used in setMapSample function.

[princejoogie]

I can send screenshots of my manual tests per route if needed 🎇

[warengonzaga]

I can send screenshots of my manual tests per route if needed 🎇

I was thinking of jest for testing the API wrapper. We did a similar approach on BMC.JS but it is not successful. For the examples folder basically these are the manual tests?

[princejoogie]

I can send screenshots of my manual tests per route if needed 🎇

I was thinking of jest for testing the API wrapper. We did a similar approach on BMC.JS but it is not successful. For the examples folder basically these are the manual tests?

yes it is sort of a manual test. was gonna ask in discussions if we were going to implement jest, but since you mentioned it, ill try to implement it when im free again

[warengonzaga]

I can send screenshots of my manual tests per route if needed 🎇

I was thinking of jest for testing the API wrapper. We did a similar approach on BMC.JS but it is not successful. For the examples folder basically these are the manual tests?

yes it is sort of a manual test. was gonna ask in discussions if we were going to implement jest, but since you mentioned it, ill try to implement it when im free again

I'll create an issue regarding automated testing with Jest. Also adding a discussion related to this.

[warengonzaga]

Hi, @princejoogie did you change how we use the API? If yes, then how to use it? I'm concerned about documentation.

[princejoogie]

Hi, @princejoogie did you change how we use the API? If yes, then how to use it? I'm concerned about documentation.

the only change i made is mentioned in PR description number 1. from positional arguments to object arguments. yes, this change will need to be redocumented in usage.

[warengonzaga]

Please review my questions on each line. 👌

[warengonzaga]

Hi, @princejoogie did you change how we use the API? If yes, then how to use it? I'm concerned about documentation.

the only change i made is mentioned in PR description number 1. from positional arguments to object arguments. yes, this change will need to be redocumented in usage.

This is clear to me, basically, the usage now for the API wrapper is OOP?

[warengonzaga]

@princejoogie did you rename the createRoom to createSpace ?

[princejoogie]

@princejoogie did you rename the createRoom to createSpace ?

[warengonzaga]

All good, as the last request, add the documentation for POST. Then I'll merge this.

[warengonzaga]

These are now approved! I'm happy to merge this now.

[warengonzaga]

@princejoogie next time, use imperative sentences to your commit message. Use add instead of added as an example.