Fixes #14

Author: afonsoc12

firefly_cli/cli.py

@@ -113,7 +113,7 @@ def do_edit(self, argslist):
 
     def help_edit(self):
         self.poutput(
-            "Edits connection credentials:\n\t> edit url http://<FireflyIII URL>:<Port>\n\t> edit api <API key>"
+            "Edits connection credentials:\n\t> edit url https://<FireflyIII URL>:<Port>\n\t> edit api <API key>"
         )
 
     @cmd2.with_argparser(Parser.accounts())
@@ -149,9 +149,11 @@ def do_add(self, parser):
 
         tab_header, tab_body = trans.get_tabulates()
         self.poutput(f"Transaction header:\n{tab_header}\n")
-        self.poutput(f"Transaction Body:\n{tab_body}\n")
+        self.poutput(f"Transaction body:\n{tab_body}\n")
 
-        if prompt_continue(extra_line=False, extra_msg=" adding the transaction"):
+        if parser.bypass_prompt or prompt_continue(
+            extra_line=False, extra_msg=" adding the transaction"
+        ):
             try:
                 response = self.api.create_transaction(trans)
 
@@ -176,12 +178,11 @@ def do_exit(self, _):
         return True
 
     def help_exit(self):
-        return self.poutput("exit the application. Shorthand: x q Ctrl-D.")
+        return self.poutput("Exits the application. Shorthand: q Ctrl-D.")
 
     def default(self):
-        self.poutput(
-            'Input not recognised. Please type "help" to list the available commands'
-        )
+        # todo default when arg not recognised
+        pass
 
     do_q = do_exit
     help_q = help_exit

firefly_cli/configs.py

@@ -4,23 +4,29 @@
 
 from xdg.BaseDirectory import xdg_config_home
 
-if os.getenv("FIREFLY_CLI_CONFIG"):
-    config_file_path = Path(os.environ["FIREFLY_CLI_CONFIG"])
-else:
-    config_file_path = Path(xdg_config_home).joinpath("firefly-cli", "firefly-cli.ini")
 
-    # Create dir if not exists
-    config_file_path.parent.mkdir(parents=True, exist_ok=True)
+def config_file_path():
+    if os.getenv("FIREFLY_CLI_CONFIG"):
+        config_file_path = Path(os.environ["FIREFLY_CLI_CONFIG"])
+    else:
+        config_file_path = Path(xdg_config_home).joinpath(
+            "firefly-cli", "firefly-cli.ini"
+        )
+
+        # Create dir if not exists
+        config_file_path.parent.mkdir(parents=True, exist_ok=True)
+
+    return config_file_path
 
 
 def load_configs():
     configs = configparser.ConfigParser()
 
     # No config file loaded because it was not available/not existent
-    if len(configs.read(config_file_path)) < 1:
+    if len(configs.read(config_file_path())) < 1:
         print("File not found, creating the file..")
 
-        with open(config_file_path, "w") as f:
+        with open(config_file_path(), "w") as f:
             configs["firefly-cli"] = {}
             save_configs_to_file(configs)
 
@@ -29,12 +35,12 @@ def load_configs():
 
 def save_configs_to_file(configs):
     try:
-        with open(config_file_path, "w") as f:
+        with open(config_file_path(), "w") as f:
             configs.write(f)
-            print("Config file saved at {}".format(str(config_file_path)))
+            print("Config file saved at {}".format(str(config_file_path())))
     except:
         print(
             "An error has occurred while saving file to {}".format(
-                str(config_file_path)
+                str(config_file_path())
             )
         )

firefly_cli/parser.py

@@ -29,11 +29,12 @@ def description_provider(cmd, limit=10):
 
 class Parser:
     @staticmethod
-    def entrypoint():
+    def entrypoint(prog=None):
         parser = ArgumentParser(
             description="A command line interface for conveniently entering expenses in Firefly III.\nRun without arguments to start interactive mode.",
             usage="firefly-cli [-h] [-v]",
             add_help=False,
+            prog=None,
         )
 
         # Optional arguments (json header)
@@ -50,10 +51,8 @@ def entrypoint():
         return parser
 
     @staticmethod
-    def accounts():
-        parser = Cmd2ArgumentParser(
-            description="Shows account information.",
-        )
+    def accounts(prog=None):
+        parser = Cmd2ArgumentParser(description="Shows account information.", prog=prog)
 
         # Optional arguments (json header)
         parser.add_argument("--json", action="store_true")
@@ -79,17 +78,28 @@ def accounts():
         return parser
 
     @staticmethod
-    def add():
+    def add(prog=None):
 
         parser = Cmd2ArgumentParser(
             description="Adds a new transaction to FireflyIII.",
             usage="add [comma-separated arguments] [-h] [--optional-arguments]",
+            prog=None,
         )
 
         # Positional arguments
-        parser.add_argument("transaction", nargs="*", help="Transaction data.")
+        parser.add_argument(
+            "transaction",
+            nargs="*",
+            help="Transaction data in comma-separated format: Amount, Description , Source account, Destination account, Category, Budget",
+        )
 
         # Optional arguments (json header)
+        parser.add_argument(
+            "-y",
+            dest="bypass_prompt",
+            action="store_true",
+            help="Bypass confirmation prompt.",
+        )
         parser.add_argument(
             "--apply-rules",
             default=True,
@@ -174,3 +184,8 @@ def add():
         )
 
         return parser
+
+    @staticmethod
+    def safe_string(args):
+        args_str = " ".join(list(map(lambda x: f"'{x}'" if " " in x else x, args)))
+        return args_str

test/test_parser.py

@@ -1,12 +1,16 @@
-import json
-from datetime import datetime
-from pathlib import Path
+import shlex
+import sys
+from unittest.mock import patch
 
-import pytest
+from firefly_cli.parser import Parser
 
-from firefly_cli import utils
 
-test_data = Path(__file__).parent.joinpath("test_data")
+class TestAutocomplete:
+    def test_accounts_name_provider(self):
+        pass
+
+    def test_description_provider(self):
+        pass
 
 
 class TestParser:
@@ -19,10 +23,29 @@ def test_accounts(self):
     def test_add(self):
         pass
 
-
-class TestAutocomplete:
-    def test_accounts_name_provider(self):
-        pass
-
-    def test_description_provider(self):
-        pass
+    def test_safe_string(self):
+        test_argv = [
+            "script.py",
+            "add",
+            "--source-name",
+            "My Bank Account",
+            "--amount",
+            "499",
+            "--description",
+            "Food",
+            "--destination-name",
+            "Shop A",
+        ]
+        expected_args_str = "add --source-name 'My Bank Account' --amount 499 --description Food --destination-name 'Shop A'"
+
+        with patch.object(sys, "argv", test_argv):
+            args, ffargs = Parser.entrypoint().parse_known_args()
+
+        args_str = Parser.safe_string(ffargs)
+        args = Parser.add().parse_args(shlex.split(args_str))
+
+        assert args_str == expected_args_str
+        assert args.source_name == "My Bank Account"
+        assert args.amount == 499
+        assert args.description == "Food"
+        assert args.destination_name == "Shop A"