Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/waldohidalgo/stock_price_checker

Primer proyecto requisito obligatorio para obtener la Information Security Certification de freecodecamp
https://github.com/waldohidalgo/stock_price_checker

bcrypt bootstrap chai express helmet helmetjs mocha mongodb

Last synced: 9 days ago
JSON representation

Primer proyecto requisito obligatorio para obtener la Information Security Certification de freecodecamp

Host: GitHub
URL: https://github.com/waldohidalgo/stock_price_checker
Owner: waldohidalgo
Created: 2024-06-22T22:44:08.000Z (5 months ago)
Default Branch: main
Last Pushed: 2024-06-23T19:42:06.000Z (5 months ago)
Last Synced: 2024-10-11T22:41:08.526Z (about 1 month ago)
Topics: bcrypt, bootstrap, chai, express, helmet, helmetjs, mocha, mongodb
Language: JavaScript
Homepage: https://stock-price-checker-gfor.onrender.com/
Size: 1.22 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Stock Price Checker

Solución al [primer proyecto](https://freecodecamp.org/learn/information-security/information-security-projects/stock-price-checker) requisito obligatorio para obtener la **Information Security Certification** de freecodecamp.

El proyecto consiste en crear un servidor el cual disponibiliza una ruta que recibe como query parameter **stock** igual al nombre de alguna acción. Los datos de la acción son consultados en la siguiente URL:

> [https://stock-price-checker-proxy.freecodecamp.rocks](https://stock-price-checker-proxy.freecodecamp.rocks)

Si la acción existe, el servidor retorna un objeto con la propiedad **stockData** y el valor igual a un objeto con las siguientes propiedades: **stock**, **price** y **likes**. También se puede añadir un query parameter **like** con el valor de true, el cual aumenta en uno el like a dicha stock. Solo se permite dar un like por IP. Por último, también se pueden pasar más de una stock a la ruta y también el query parameter **like** y en ese caso se dará like a ambas stocks si la IP ya no ha dado like antes. Cuando se presenta un error ya sea, por ejemplo, que una stock no exista, el servidor responde con el objeto siguiente:

> { stock: "Unknown symbol" }

El registro de IPs se realiza en una collection de una base de datos MongoDB encriptando dichas IP utilizando la librería **bcrypt**.

Los tests que he creado son **pesados** en el sentido que el testeo de likes se realiza previo **borrado** de la IP en la base de datos de modo que el valor de likes se incremente.

## Tabla de Contenidos

- [Stock Price Checker](#stock-price-checker)

  - [Tabla de Contenidos](#tabla-de-contenidos)

  - [Deploy](#deploy)

  - [Requisitos](#requisitos)

  - [Proyecto Aprobado](#proyecto-aprobado)

  - [Test Superados](#test-superados)

  - [Screenshots](#screenshots)

    - [1. Home](#1-home)

    - [2.Consulta de Solo una Stock Válida](#2consulta-de-solo-una-stock-válida)

    - [3.Consulta de una Stock con Like](#3consulta-de-una-stock-con-like)

    - [4. Consulta de Stock Inválida](#4-consulta-de-stock-inválida)

    - [5.Consulta de Dos Stocks Válidas](#5consulta-de-dos-stocks-válidas)

    - [6. Consulta de Dos Stocks con solo una válida](#6-consulta-de-dos-stocks-con-solo-una-válida)

    - [7.Consulta de Dos Stocks Inválidas](#7consulta-de-dos-stocks-inválidas)

  - [Test Funcionales Creados](#test-funcionales-creados)

    - [1.Viewing one stock: GET request to /api/stock-prices/](#1viewing-one-stock-get-request-to-apistock-prices)

    - [2.Viewing one stock and liking it: GET request to /api/stock-prices/](#2viewing-one-stock-and-liking-it-get-request-to-apistock-prices)

    - [3.Viewing the same stock and liking it again: GET request to /api/stock-prices/](#3viewing-the-same-stock-and-liking-it-again-get-request-to-apistock-prices)

    - [4.Viewing two stocks: GET request to /api/stock-prices/](#4viewing-two-stocks-get-request-to-apistock-prices)

    - [5.Viewing two stocks and liking them: GET request to /api/stock-prices/](#5viewing-two-stocks-and-liking-them-get-request-to-apistock-prices)

## Deploy

El proyecto lo he entregado a freecodecamp realizado en **Gitpod**. Quise entregar el proyecto desplegado en Render pero los tests me dieron problemas de timeout aún siendo los mismos proyectos. El costo de entregar el proyecto en Gitpod es que luego de un tiempo la URL del proyecto se elimina y para ello he desplegado mi proyecto también en Render pero **NO** en ambiente de pruebas de modo que quede un registro más duradero.

El link de mi proyecto desplegado en Gitpod es (fue) el siguiente:

> [https://3000-freecodecam-boilerplate-6mxxk3664d6.ws-us114.gitpod.io/](https://3000-freecodecam-boilerplate-6mxxk3664d6.ws-us114.gitpod.io/)

El link de mi proyecto desplegado en Render es el siguiente:

> [https://stock-price-checker-gfor.onrender.com/](https://stock-price-checker-gfor.onrender.com/)

## Requisitos

![Requisitos](./screenshots/requisitos.webp)

## Proyecto Aprobado

![Proyecto Aprobado](./screenshots/proyecto_aprobado.webp)

## Test Superados

![Test Superados](./screenshots/tests_superados.jpg)

## Screenshots

### 1. Home

![Imagen de Home](./screenshots/1home.webp)

### 2.Consulta de Solo una Stock Válida

![Imagen de Consulta de Solo una Stock](./screenshots/2query_one_stock.webp)

### 3.Consulta de una Stock con Like

![Imagen de Consulta de una Stock con Like](./screenshots/3query_one_stock_with_like.webp)

### 4. Consulta de Stock Inválida

![Imagen de Consulta de Stock Inválida](./screenshots/4query_wrong_stock.webp)

### 5.Consulta de Dos Stocks Válidas

![Imagen de Consulta de Dos Stocks](./screenshots/5query_two_stocks.webp)

### 6. Consulta de Dos Stocks con solo una válida

![Imagen de Consulta de Dos Stocks con solo una válida](./screenshots/6query_two_stock_but_one_correct.webp)

### 7.Consulta de Dos Stocks Inválidas

![Imagen de Consulta de Dos Stocks Inválidas](./screenshots/7query_two_wrong_stocks.webp)

## Test Funcionales Creados

### 1.Viewing one stock: GET request to /api/stock-prices/

```js

let likes = null;

test("Viewing one stock: GET request to /api/stock-prices/", function (done) {

  chai

    .request(server)

    .keepOpen()

    .get("/api/stock-prices?stock=GOOG")

    .end(function (err, res) {

      likes = res.body.stockData.likes;

      assert.equal(res.status, 200);

      assert.isString(res.body.stockData.stock);

      assert.isNumber(res.body.stockData.price);

      assert.isNumber(res.body.stockData.likes);

      done();

    });

});

```

### 2.Viewing one stock and liking it: GET request to /api/stock-prices/

```js

test("Viewing one stock and liking it: GET request to /api/stock-prices/", function (done) {

  chai

    .request(server)

    .keepOpen()

    .get("/api/ip")

    .end(async (err, res) => {

      const id = res.body.id;

      const ipsCollection = dbObject.db.collection("ips");

      if (id) {

        await ipsCollection.deleteOne({

          _id: new ObjectId(String(id)),

        });

      }

      chai

        .request(server)

        .keepOpen()

        .get("/api/stock-prices?stock=GOOG&like=true")

        .end(function (err, res) {

          assert.equal(res.status, 200);

          assert.isString(res.body.stockData.stock);

          assert.isNumber(res.body.stockData.price);

          assert.isNumber(res.body.stockData.likes);

          // likes should be increased by 1

          assert.equal(likes + 1, res.body.stockData.likes);

          likes = likes + 1;

          done();

        });

    });

});

```

### 3.Viewing the same stock and liking it again: GET request to /api/stock-prices/

```js

test("Viewing the same stock and liking it again: GET request to /api/stock-prices/", function (done) {

  chai

    .request(server)

    .keepOpen()

    .get("/api/stock-prices?stock=GOOG&like=true")

    .end(function (err, res) {

      assert.equal(res.status, 200);

      assert.isString(res.body.stockData.stock);

      assert.isNumber(res.body.stockData.price);

      assert.isNumber(res.body.stockData.likes);

      // likes should be the same

      assert.equal(likes, res.body.stockData.likes);

      done();

    });

});

```

### 4.Viewing two stocks: GET request to /api/stock-prices/

```js

let likes1 = null;

let likes2 = null;

test("Viewing two stocks: GET request to /api/stock-prices/", function (done) {

  chai

    .request(server)

    .keepOpen()

    .get("/api/stock-prices?stock=GOOG")

    .end(function (err, res) {

      likes1 = res.body.stockData.likes;

      chai

        .request(server)

        .keepOpen()

        .get("/api/stock-prices?stock=MSFT")

        .end(function (err, res) {

          likes2 = res.body.stockData.likes;

          chai

            .request(server)

            .keepOpen()

            .get("/api/stock-prices?stock=GOOG&stock=MSFT")

            .end(function (err, res) {

              assert.equal(res.status, 200);

              assert.isObject(res.body.stockData[0]);

              assert.isObject(res.body.stockData[1]);

              assert.property(res.body.stockData[0], "rel_likes");

              assert.property(res.body.stockData[1], "rel_likes");

              assert.equal(

                res.body.stockData[0]["rel_likes"] +

                  res.body.stockData[1]["rel_likes"],

                0

              );

              assert.equal(likes1 - likes2, res.body.stockData[0]["rel_likes"]);

              done();

            });

        });

    });

});

```

### 5.Viewing two stocks and liking them: GET request to /api/stock-prices/

```js

test("Viewing two stocks and liking them: GET request to /api/stock-prices/", function (done) {

  chai

    .request(server)

    .keepOpen()

    .get("/api/ip")

    .end(async (err, res) => {

      const id = res.body.id;

      const ipsCollection = dbObject.db.collection("ips");

      if (id) {

        await ipsCollection.deleteOne({

          _id: new ObjectId(String(id)),

        });

      }

      chai

        .request(server)

        .keepOpen()

        .get("/api/stock-prices?stock=GOOG&stock=MSFT&like=true")

        .end(function (err, res) {

          assert.equal(res.status, 200);

          const stockData1 = res.body.stockData[0];

          const stockData2 = res.body.stockData[1];

          assert.isObject(stockData1);

          assert.isObject(stockData2);

          assert.property(stockData1, "rel_likes");

          assert.property(stockData2, "rel_likes");

          assert.equal(stockData1["rel_likes"] + stockData2["rel_likes"], 0);

          assert.equal(likes1 - likes2, stockData1["rel_likes"]);

          done();

        });

    });

});

```