Backlogs

.gitignore

@@ -127,3 +127,9 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Mac Sys files
+.DS_Store
+
+# Generated files
+expense_record.json

.travis.yml

@@ -5,6 +5,10 @@ python:
 install:
   - pip install .
   - pip install -r requirements.txt
+  - pip install coverage
+  - pip install codecov
 script:
-  - pytest test/
-
+  - flake8 --ignore=E501,W605
+  - coverage run -m  pytest -q test/
+after_success:
+  - bash <(curl -s https://codecov.io/bash) -t c18f2a5b-6240-4bec-a551-b427163f05b8

README.md

@@ -1,17 +1,23 @@
 # TrackMyDollar
 <hr>
 <p align="center">
-<a><img  height=560 width=1000 
+<a><img  height=360 width=550 
   src="https://github.com/deekay2310/MyDollarBot/blob/c56b4afd4fd5bbfffea0d0a4aade58596a5cb678/docs/0001-8711513694_20210926_212845_0000.png" alt="Expense tracking made easy!"></a>
 </p>
 <hr>
 
 ![MIT license](https://img.shields.io/badge/License-MIT-green.svg)
+[![Platform](https://img.shields.io/badge/Platform-Telegram-blue)](https://desktop.telegram.org/)
 ![GitHub](https://img.shields.io/badge/Language-Python-blue.svg)
-![GitHub contributors](https://img.shields.io/github/contributors/deekay2310/SE21_HW2B_Group6)
+
+![GitHub contributors](https://img.shields.io/github/contributors/sak007/project-X)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5542548.svg)](https://doi.org/10.5281/zenodo.5542548)
-[![Platform](https://img.shields.io/badge/Platform-Telegram-blue)](https://desktop.telegram.org/)
-[![Build Status](https://app.travis-ci.com/deekay2310/MyDollarBot.svg?branch=main)](https://app.travis-ci.com/github/deekay2310/MyDollarBot)
+
+[![Build Status](https://app.travis-ci.com/sak007/MyDollarBot.svg?branch=backlogs)](https://app.travis-ci.com/github/sak007/MyDollarBot)
+[![codecov](https://codecov.io/gh/sak007/MyDollarBot/branch/main/graph/badge.svg?token=5AYMR8MNMP)](https://codecov.io/gh/sak007/MyDollarBot)
+[![GitHub issues](https://img.shields.io/github/issues/sak007/MyDollarBot)](https://github.com/sak007/MyDollarBot/issues?q=is%3Aopen+is%3Aissue)
+[![GitHub closed issues](https://img.shields.io/github/issues-closed/sak007/MyDollarBot)](https://github.com/sak007/MyDollarBot/issues?q=is%3Aissue+is%3Aclosed)
+![Lines of code](https://img.shields.io/tokei/lines/github/sak007/MyDollarBot)
 
 <hr>
 
@@ -32,46 +38,43 @@ https://user-images.githubusercontent.com/15325746/135395315-e234dc5e-d891-470a-
 
 The below instructions can be followed in order to set-up this bot at your end in a span of few minutes! Let's get started:
 
-1. This installation guide assumes that you have already installed Python (Python3 would be preferred)
-
-2. Clone this repository to your local system at a suitable directory/location of your choice
-
-3. Start a terminal session, and navigate to the directory where the repo has been cloned
+1. This installation guide assumes that you have already installed Python (Python3 would be preferred) and Telegram web or Desktop. Clone this repository to your local system.
 
-4. Run the following command to install the required dependencies:
+2. Start a terminal session in the directory where the project has been cloned. Run the following command to install the required dependencies:
 ```
   pip install -r requirements.txt
 ```
-5. Download and install the Telegram desktop application for your system from the following site: https://desktop.telegram.org/
 
-6. Once you login to your Telegram account, search for "BotFather" in Telegram. Click on "Start" --> enter the following command:
+3. In Telegram, search for "BotFather". Click on "Start", and enter the following command:
 ```
   /newbot
 ```
-7. Follow the instructions on screen and choose a name for your bot. Post this, select a username for your bot that ends with "bot" (as per the instructions on your Telegram screen)
+Follow the instructions on screen and choose a name for your bot. After this, select a username for your bot that ends with "bot".
 
-8. BotFather will now confirm the creation of your bot and provide a TOKEN to access the HTTP API - copy this token for future use.
+4. BotFather will now confirm the creation of your bot and provide a TOKEN to access the HTTP API - copy and save this token for future use.
 
-9. In the directory where this repo has been cloned, navigate to the "code" folder and open the "code.py" file. This file consists of a variable by the name "api_token". Paste the token copied in step 8 in the placeholder provided for this variable:
+5. In the directory where this repo has been cloned, please run the below command to execute a bash script to run the Telegram Bot:
 ```
-  api_token = "INSERT API KEY HERE"
+   ./run.sh
 ```
-10. In the Telegram app, search for your newly created bot by entering the username and open the same. Once this is done, go back to the terminal session. Navigate to the directory containing the "code.py" file and run the following command:
+(OR)
 ```
-  python code.py
+   bash run.sh
 ```
-11. A successful run will generate a message on your terminal that says "TeleBot: Started polling." 
-12. Post this, navigate to your bot on Telegram, enter the "/start" or "/menu" command, and you are all set to track your expenses!
+Please note that it will ask you to paste the API token you received from Telegram in step 4.
+A successful run will generate a message on your terminal that says "TeleBot: Started polling." 
 
+6. In the Telegram app, search for your newly created bot by entering the username and open the same. Now, on Telegram, enter the "/start" or "/menu" command, and you are all set to track your expenses!
 
 
+# Notes:
+You can download and install the Telegram desktop application for your system from the following site: https://desktop.telegram.org/
 
 
 
 <hr>
-<p>--------------------------------------------------------------------------------------------------</p>
 <p>Title:'Track My Dollar'</p>
-<p>Version: '1.0'</p>
+<p>Version: '1.5'</p>
 <p>Description: 'An easy to use Telegram Bot to track everyday expenses'</p>
-<p>Authors:'Dev, Prakruthi, Radhika, Rohan, Sunidhi'</p>
-<p>--------------------------------------------------------------------------------------------------</p>
+<p>Authors(Iteration 1.5):'Athithya, Subramanian, Ashok, Zunaid, Rithik'</p>
+<p>Authors(Iteration 1):'Dev, Prakruthi, Radhika, Rohan, Sunidhi'</p>

code/__init__.py

@@ -1,8 +1,3 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-"""
-Created on Wed Sep 29 17:10:59 2021
-
-@author: deekay
-"""
-
+import os
+import sys
+sys.path.insert(0, os.getcwd() + "/code")

code/add.py

@@ -0,0 +1,69 @@
+import helper
+import logging
+from telebot import types
+from datetime import datetime
+
+
+option = {}
+
+
+def run(message, bot):
+    helper.read_json()
+    chat_id = message.chat.id
+    option.pop(chat_id, None)  # remove temp choice
+    markup = types.ReplyKeyboardMarkup(one_time_keyboard=True)
+    markup.row_width = 2
+    for c in helper.getSpendCategories():
+        markup.add(c)
+    msg = bot.reply_to(message, 'Select Category', reply_markup=markup)
+    bot.register_next_step_handler(msg, post_category_selection, bot)
+
+
+def post_category_selection(message, bot):
+    try:
+        chat_id = message.chat.id
+        selected_category = message.text
+        if selected_category not in helper.getSpendCategories():
+            bot.send_message(chat_id, 'Invalid', reply_markup=types.ReplyKeyboardRemove())
+            raise Exception("Sorry I don't recognise this category \"{}\"!".format(selected_category))
+
+        option[chat_id] = selected_category
+        message = bot.send_message(chat_id, 'How much did you spend on {}? \n(Enter numeric values only)'.format(str(option[chat_id])))
+        bot.register_next_step_handler(message, post_amount_input, bot)
+    except Exception as e:
+        logging.exception(str(e))
+        bot.reply_to(message, 'Oh no! ' + str(e))
+        display_text = ""
+        commands = helper.getCommands()
+        for c in commands:  # generate help text out of the commands dictionary defined at the top
+            display_text += "/" + c + ": "
+            display_text += commands[c] + "\n"
+        bot.send_message(chat_id, 'Please select a menu option from below:')
+        bot.send_message(chat_id, display_text)
+
+
+def post_amount_input(message, bot):
+    try:
+        chat_id = message.chat.id
+        amount_entered = message.text
+        amount_value = helper.validate_entered_amount(amount_entered)  # validate
+        if amount_value == 0:  # cannot be $0 spending
+            raise Exception("Spent amount has to be a non-zero number.")
+
+        date_of_entry = datetime.today().strftime(helper.getDateFormat() + ' ' + helper.getTimeFormat())
+        date_str, category_str, amount_str = str(date_of_entry), str(option[chat_id]), str(amount_value)
+        helper.write_json(add_user_record(chat_id, "{},{},{}".format(date_str, category_str, amount_str)))
+        bot.send_message(chat_id, 'The following expenditure has been recorded: You have spent ${} for {} on {}'.format(amount_str, category_str, date_str))
+
+    except Exception as e:
+        logging.exception(str(e))
+        bot.reply_to(message, 'Oh no. ' + str(e))
+
+
+def add_user_record(chat_id, record_to_be_added):
+    user_list = helper.read_json()
+    if str(chat_id) not in user_list:
+        user_list[str(chat_id)] = []
+
+    user_list[str(chat_id)].append(record_to_be_added)
+    return user_list