ttitcombe / casset Goto Github PK

Plot multiple portfolios against one another to compare

Allow the user to select timeframe and stocks to include in the plotting

As a user, I want to be able to easily switch between my saved portfolios

Acceptance criteria:

• The gui should have a switchbox populated with the names of portfolios in the database
• Selecting a portfolio in the switchbox will load the portfolio to the table

The current license was provided as part of the simple cpp project boilerplate upon which this project was started.
The correct license for this project should be chosen

As a user, I want a structured, scalable way to display my portfolio. The stocks contained in a portfolio should be displayed in a table

Acceptance criteria:

• The portfolio is displayed in a table, with one row for each stock
• Each row should have the columns: stock name, number of shares, total value
• Up to 5 stocks should be displayed at any one time
• If more than 5 stocks are present, the table should have a scroll bar to show the remaining entries
• The portfolio name and total value should always be displayed

Points: 8

Calls to the IEX API have stopped working. We need to investigate if IEX have stopped the service entirely or if it's merely a question of verification.

To test:
See https://api.iextrading.com/1.0/stock/AAPL/chart

Bring out the bulk of the scripts in the travis jobs to a separate bash file to clean up the travis.yml file

Move logic for making GET requests and parsing the response object for IEX to a separate class

As a user, I want to be able to set the name of my portfolio so I can remember its contents easier

Acceptance criteria:

• On the portfolio gui tab, you should be able to edit the portfolio name displayed

Points: 1

Persistent portfolios

• #51 - Form portfolios from user-selected stocks
• #52 - Saving and loading of portfolios

currently hardcoded to aapl, let the user enter a ticker, validate it, and then retrieve data

Allow for basic plotting of a single stock over time

spdlog logging library and CLI11 command line interface library are very useful tools to know about. Both have conan packages:
CLI11/1.7.1@cliutils/stable (remote: https://api.bintray.com/conan/cliutils/CLI11)
spdlog/1.3.1@bincrafters/stable

As a user, I must be able to select multiple stocks, associated with a number of shares. I should be able to see the value of this portfolio.

Acceptance criteria:

• The gui should display current stocks in the portfolio, the number of shares for the stock, and the total value of the portfolio in dollars
• The gui should have a button for adding and removing stocks from a portfolio
• You should be able to add or remove shares from a stock in the portfolio without removing it from the portfolio
• The number of shares should be validated to ensure it is a positive integer which is less than total number of shares available for the company

Points: 5

As a user, I want my portfolios to evolve over time. E.g. I should be able to by 10 shares of Apple on Monday, sell 3 on Tuesday, and buy 4 on Wednesday.

Acceptance criteria:

• The gui should allow a user to enter a stock, number of shares, and the date of the transaction.
  • Adding/removing shares for a certain company on multiple days will add multiple entries to the csv.
  • If no date is selected, it should be assumed to be the current day.
  • Entering the date of a current entry will amend that position. E.g. If you buy 5 shares and sell 3 on one day, the entry for that day will just be +2 shares
• The gui should display only currently held positions.
• A user should not be able to sell more shares than they currently have (shorting not supported at this point)

Points: 5

Store historical data

Until clang formatting can be checked during CI, update the pre-commit hooks so that commits must be clang formatted

Currently Travis will build each commit twice: once for branch, and once for the PR. Currently we only want to build once

As a user, I want to click a button on a gui to display recent price information about Apple.

Acceptance criteria:

• Running Casset should open a gui
• This gui should contain a button
• When clicked, recent information about Apple stock should be displayed on the gui. This should include:
  • Date of information
  • Close price

Points: 3

Add CI build and run tests with Travis

If you search for a valid stock symbol with a slow internet connection, you will receive a timeout. Currently, the presenter interprets this to mean the stock was not found and displays a message to tell you so.
A check should be made for timeouts, and a relevant message should be displayed if that is the case

We currently only retrieve the date from the data associated with a ticker. We should retrieve stock value

Currently, user input of ticker symbols must be in upper case.
Casset should automatically make the symbol uppercase

As a user I want clear divisions between the different functions of the app. Therefore, portfolio handling should be on a separate tab of the gui to the button/line edit where you can grab the latest information on a particular stock.

Acceptance criteria

• The gui has a main tab, which contains stock information functionality
• The gui contains a second tab, which contains portfolio information functionality

Points: 2

Introduce some more advanced plotting options

Get unit testing in place for Casset.
We will use catch2 for testing and Trompeloeil for mocking, where necessary

A windows environment of system tests, cppcheck, clang formatting

As a user, I want to be able to save portfolios I have created

Acceptance criteria:

• The gui contains a button to save the current portfolio. This will create a database table with the name of the portfolio

Points: 5

Functionality to save and load basic portfolios to disk.

Update main.cpp to be include cpr.
Update CMake so this simple program builds

When an API call comes back with an error, the check for an error code currently takes place at IEX::getParsedJson. If the reponse code is not 200, the returned object is an empty json.
Casset then tries to turn this (empty) json into a string, which throws nlohhman:detail:type_error exception.

The status of the reponse must be checked in the presenter as well, before attempting to convert to a string

Windows builds of Casset using VisualStudio have errors caused by current Conan set-up.
conanfile needs to be changed and docs updated to describe how to get the build to work on windows

Allow the user to add and remove stocks to a portfolio. They should be able to specify when this event occurred, which stock was involved, and how much (either price or number of shares)

Extend plotting functionality to work for a group of stocks

As a user, I want to be able to load a saved portfolio

Acceptance criteria:

• The gui should have a button to load a portfolio
• When clicked, you can select which portfolio from those saved in the database
• Selecting a portfolio will populate the portfolio table
• You cannot attempt to load the same portfolio as you are currently viewing
• If you attempt to load a new portfolio while editing a different portfolio, you will be prompted if you want to save changes before loading

Currently only stocks can be part of the portfolio. This should be extended to other asset classes

As a user, I want to be able to choose which stock Casset displays information about.

Acceptance criteria:

• The gui should contain an editable toolbar into which a user can enter a stock symbol (e.g. "AAPL" for Apple)
• When the stock button is clicked, recent information about the stock is displayed on the gui. This should include:
  • The stock symbol for which the information relates
  • The date of the information
  • The close price
• The user-entered symbols should be case-insensitive. E.g. "aapl" and "AAPL" should both return information on Apple
• A clear message should displayed if the stock symbol cannot be found
• A clear message should be displayed if GET requests cannot be made
• Users should be able to continue using the application after successful and unsuccessful requests for information

Points: 3

Add a QT GUI that will allow a user to select and manage portfolios, plots etc.

Create a document outlining the necessary requirements of Casset functionality, and additional functionality.

• #48
• #49

Unit test the functionality in the IEX class. We should mock out calls to the API, but test that 1. we can find a valid ticker in a json containing ticker information 2. We can extract valid data from the full stock information json