yilmaz-burak
commented
2 years ago -
-
Executive Summary
API
As a group, we have each created our own little projects by creating distinct endpoints, providing a unique functionality. I have used a currency converting api, namely currencyconverterapi and by using its features, created a table for conversion rates. User can send a post request to
/currency/allConversionsendpoint to get rates betweenUSDand[USD, EUR, TRY, AZN]currencies. Similar to this, users can also get the value of a currency in the form of another currency by sending a get request to/currency/getConversion.
Personal effort
Burak Yılmaz
Burak Yilmaz
- Created a release for the practice-app here #248.
- Created class diagrams for currency here #246.
- Created use case diagrams for currency here #245.
- Created sequence diagrams for currency here #198.
- Documented user and system requirements for currency here #197.
- Documented API by Swagger for currency here #194.
- Created unit tests for currency here #192.
- Created backend for currency here #191.
- Created frontend for currency here #190.
- Reviewed the pr Swagger Integration for Express #180.
- Reviewed the pr Containerization #221.
- Reviewed the pr Practice App/Lyrics #253.
- Attended all team meetings
Code
Code can be found within the report folder. I have implemented the currency route (/server/src/routes/currency)
currency.route
Declares the routes for the /currency. It has getConversion and allConversions configured.
currency.validate
Provides the validity checks for requests coming, body of the post request, query parameters etc.
currency.controller
Handles the API requests for the declared routes.
/currency/allConversions:- This endpoint takes a post request with a body of
allCurrencies, which is an array of currencies. The function loops over all the items in that array and makes a request to the external api. After the iteration is completed successfully, all the conversion rates are sent to the request origin. If any error is thrown (catch block), sends a 400 to the request origin.
- This endpoint takes a post request with a body of
/currency/getConversion:- This endpoint accepts get request with query parameters
from,toandamount, representing both currencies and a float representing the amount of currency. The function parses the query to get the data and then gets the conversion rate through the external api. After the conversion rate is successfully fetched, multiplies the rate value by the amount, resulting in the amount of currency equivalent to the value of the initial currency. If any error is thrown (catch block), sends a 400 to the request origin.
- Used on main page, can be seen on a screenshot here(#190 )
- This endpoint accepts get request with query parameters
/currency/index.js
- Overall logic here is simple. I use React's useState hooks to manage the state of the components. With that, I keep track of function parameters for the api calls. When the functions binded to buttons activate, they make a request - whether get or post - to their relevant endpoints, they have a response. By parsing those responses, I either create a table to showcase or simply generate the currency value to showcase.
/tests/index.js
This file contains the relevant tests for the /currency endpoints. For each endpoints, 3 cases are given:
- Successfull - 200 code
- Erroneous - 400 code
- Not Found - 404 code
API documentation
Sequence Diagrams
Use cases
Classes
Related Requirements
User Requirements
- 1.3.1. The user shall be able to fetch currency exchange rates from USD.
- 1.3.1.1. The user shall be able to get a list of [USD, EUR, TRY, AZN] currency conversions from USD from the UI of the project.
- 1.3.1.2. The user shall be able to get a list of currency conversions from USD by providing a list of currencies for the endpoint relevant to the process of currency conversion via post request.
- 1.3.2 The user shall be able to convert a unit of currency to some other unit of currency.
- 1.3.2.1 User shall be able to either use UI or the endpoint of the system by providing from, to currency strings and amount number to convert number amount of from currency to some unit of to currency depending on the exchange rate.
System Requirements
- 1.3.2.1 User shall be able to either use UI or the endpoint of the system by providing from, to currency strings and amount number to convert number amount of from currency to some unit of to currency depending on the exchange rate.
- 2.3.1. The system shall provide a UI to fetch conversion rates from USD to [USD, EUR, TRY, AZN].
- 2.3.2. The system shall provide the endpoint for fetching rates from USD to given array of currencies in a post request.
- 2.3.3. The system shall provide an interface enabling for conversion of currencies from and to on given amount.
Challenges
- While in development, external API's downtime was noticeable. That cause a lot of unnecessary debugging time, leading to frustration.
- My local development environment had some problems regarding react, node, npm versions. That caused a lot of overhead, leading to a similar kind of frustration.
- Finding a free and reliable currency converter api was hard. Even though I found one, it still caused some issues.
Code Review and Pull requests
- I have made a PR of my project,
\currencyin this pull request. Bilal quickly gave some good feedback and regarding his comments, I have made some changes. It was a quick and painless process. - I reviewed @muhammetssen' Swagger PR in this PR. He created the initial structure for our Swagger documentation. He made implemented a solid structure for it.
- I reviewed @muhammetssen' Containerization PR in this PR. He knows what he is doing. Similary, made an excellent job for dockerization.
muhammetssen
Each member needs to prepare an Individual Report showcasing the work they done with
Deadline: 20.05.2022 @ 23.59