Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/amaterazu7/rotunda-api

URL Parser, Logger Email Sender & Zoo Modeling APIs exercises on Javascript, ExpressJS and Docker.
https://github.com/amaterazu7/rotunda-api

docker docker-compose exercise expressjs javascript javascript-library

Last synced: 5 days ago
JSON representation

URL Parser, Logger Email Sender & Zoo Modeling APIs exercises on Javascript, ExpressJS and Docker.

Awesome Lists containing this project

README 

        
# Rotunda REST API   

I created an API for this exercises taking a generic Express and add it the corresponding logic to each exercise. This API expose 4 endpoint, the fist is a generic one created by Express and other 3 are for the exercises, down here I will explain to you how test each one.  



Please first step, clone or download this project.



### Running the APP 

* You can launch the app, typing on a terminal:



    `` cd Rotunda-API `` (if you are outside the project)



* Then you have to install NPM dependencies and after that, you can run it this way:



    `` npm install ``



    `` npm start ``



### Running the APP with docker 

* You can install docker & docker-compose and run this commands in order to create a docker images. So, you can run the application on a docker containers with the docker-compose file:



    `` docker-compose up --build ``



* If you don't want to see any log on you terminal you can run this:



    `` docker-compose up --build -d ``



* When the application is started you can go here to see each exercise:

  

    * URL Parser:



        * http://0.0.0.0:3000/url-parser/

    

        * The http method is by :: >> ``` POST ```

        

        * This is a body sample:

            ```

            {

                "URLFormat": "/:version/api/:collection/:id",

                "URLInstance": "/6/api/listings/3?sort=desc&limit=10"

            }

            ```

        

    * Error Alarm:        



        * http://0.0.0.0:3000/log-error/

        

        * The http method is by :: >> ``` GET ```

                

        * This is a body sample:

            ```

            Not need it.

            ```

        

    * Zoo:        



        * http://0.0.0.0:3000/zoo/

        

        * The http method is by :: >> ``` POST ```

                

        * This is a body sample:

            ```

            {

            	"animalType": "LION",

            	"inputSpeak": "I'm a lion"

            }

            ```

            ```

            {

                "animalType": "TIGER",

                "inputSpeak": "Lions suck"

            }

            ```

  

    ` Please, remember that you need to leave the ":3000" port free to run the application. `  



# Rotunda Code Challenge:

## URL Parser Exercise:

We need some logic that extracts the variable parts of a url into a hash. The keys of the extract hash will be the "names" of the variable parts of a url, and the values of the hash will be the values. We will be supplied with:

1. A url format string , which describes the format of a url. A url format string can contain constant parts and variable parts, in any order, where "parts" of a url are separated with "/". All variable parts begin with a colon. Here is an example of such a url format string: ``` '/:version/api/:collection/:id' ```

2. A particular url instance that is guaranteed to have the format given by the url format string. It may also contain url parameters. 

* For example:

    * Given the example url format string above, the url instance might be: `` '/6/api/listings/3?sort=desc&limit=10' ``

    * Given this example url format string and url instance, the hash we want that maps all the variable parts of the url instance to their values would look like this:

    ```

    {

        version: 6,

        collection: 'listings',

        id: 3,

        sort: 'desc',

        limit: 10

    }

    ```



Please implement a solution to this problem in JavaScript with attention to code

structure and readability. Feel free to use low-level libraries like underscore.



## Error Alarm Exercise:

Suppose we have a web application that runs on a single server. Errors that occur from time to time during normal operation of the application are logged to a text file that is stored in the file system on the server. We are not concerned about these errors when their frequency is low. However, when lots of errors occur in a short period of time, there may be a problem with the application and we want to be notified immediately. Specifically, when more than ten errors occur in one minute, we want to receive an email notification. In general terms or pseudo code, how would you implement such an alarm?



Please assume:

1. The general paradigm of logging errors to a text file will be kept in place.

2. There exists a function function logError( error ) This function is called each time there is an error and appends the error to the end of the log file.

3. We never want to receive more than one email notification per minute.



## Zoo Exercise:

We are building a zoo inside a computer. Each animal species in our zoo has lots of different, particular, behaviors, but all animals talk to each other in a similar way. Specifically, they all implement a speak method, the output of which is the arbitrary input string interspersed with an "animal sound" that is particular to that type of animal.



* For example, the lion's speak function behaves like so:



    ``` >lion.speak( "I'm a lion" ); ```



    ``` < "I'm roar a roar lion roar" ```



* The tiger's speak function behaves similarly but with a different sound:

    

    ``` > tiger.speak( "Lions suck" ); ```

    

    ``` < "Lions grrr suck grrr" ```



Please write logic and classes to support our zoo in JavaScript (using whatever

class model you like) with attention to code structure and readability.