cli-setup (#24)

- adding cli initial config setup
- adding create new tests cases

Author: giuliocalzo

.gitignore

@@ -30,6 +30,8 @@ var/
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.
 *.manifest
 *.spec
+**/*_real.yaml
+**/*_real.json
 
 # Installer logs
 pip-log.txt

README.md

@@ -24,6 +24,29 @@ pipx install salesforce-timecard
 
 ## Configuration
 
+### Automatic Setup
+
+using the cli you can setup the cli as described in here
+
+```bash
+$ timecard setup
+[2021-08-09 11:44:30,565][WARNING] no config file found
+Please enter your salesforce username: your-salesforce-email@example.com
+{
+    "username": "your-salesforce-email@example.com",
+    "credential_store": "keyring"
+}
+can I create this config on /Users/your-username/.pse.json ? [Y/n]: y
+
+Insert your Saleforce Password: **********
+Insert your Saleforce Token:  **********
+
+Setup Completed
+```
+
+### Manual actions
+
+
 The script requires a local configuration file with your SalesForce credentials
 included in it, located at `~/.pse.json`. It should look like:
 
@@ -55,6 +78,7 @@ Default values for the keyring assume everything is stored under the `salesforce
 
 Under MacOS this can be added with the "Keychain Access" application, under the default "login" keychain. `salesforce_cli` is the Keychain Item Name for both instances, and the `your-salesforce-email@example.com_password` or `your-salesforce-email@example.com_token` string is the Account Name.
 
+
 ## Examples
 
 Adding 3 hours of personal development on Wednesday:
@@ -145,12 +169,6 @@ timecard TCH-08-26-2019-079768 submitted
 timecard TCH-08-26-2019-079769 submitted
 ```
 
-## TODO
-
--   Clean up remaining documentation
--   Run linter over the code
--   Setup tool for initial config file generation / keychain seeding
-
 ## License
 
 `salesforce-timecard` is licensed under the [WTFPL](LICENSE).

salesforce_timecard/__init__.py

@@ -1,7 +1,7 @@
 __title__ = "salesforce-timecard"
 __description__ = "PSE Timecard CLI"
 __url__ = "https://github.com/giuliocalzolari/salesforce-timecard"
-__version__ = "2.0.2"
+__version__ = "2.0.3"
 __author__ = "giuliocalzolari"
 __author_email__ = "giuliocalzolari@users.noreply.github.com"
 __license__ = "WTFPL"

salesforce_timecard/cli.py

@@ -2,9 +2,11 @@
 
 import sys
 import re
+import os
 import logging
 import json
 import yaml
+import keyring
 from functools import wraps
 import click
 from click_aliases import ClickAliasedGroup
@@ -24,6 +26,7 @@
 te = TimecardEntry()
 
 
+
 def process_row(ctx, project, notes, hours, weekday, w, file):
     assignment_id = None
     active_assignment = te.get_assignments_active()
@@ -301,4 +304,35 @@ def sample_timecard():
             "username": "YourName@example.com",
             "credential_store": "keyring"
         }, indent = 4)
-    )
+    )
+
+
+@cli.command(name="setup", aliases=["setup"])
+def setup_cli():
+    """setup_cli"""
+
+    username = click.prompt('Please enter your salesforce username', type=str)
+
+    cfg = {
+            "username": username,
+            "credential_store": "keyring"
+        }
+    click.echo(
+        json.dumps(cfg, indent=4)
+    )
+    cfg_file = os.path.expanduser("~/.pse.json")
+    click.confirm(f"can I create this config on {cfg_file} ?", default=True, abort=True)
+    click.echo()
+
+    with open(cfg_file, "w") as outfile:
+        json.dump(cfg,outfile, indent=4)
+
+    password = click.prompt("Insert your Saleforce Password", prompt_suffix=': ',hide_input=True, show_default=False, type=str)
+    click.echo()
+    token = click.prompt("Insert your Saleforce Token", prompt_suffix=': ', hide_input=True, show_default=False, type=str)
+    click.echo()
+
+    keyring.set_password("salesforce_cli", f"{username}_password", password)
+    keyring.set_password("salesforce_cli", f"{username}_token", token)
+
+    click.echo("Setup Completed")

salesforce_timecard/core.py

@@ -39,32 +39,35 @@ def cred_store(cls, v, values):
 class TimecardEntry:
     def __init__(self, cfg="~/.pse.json"):
 
+
+        self.get_week(date.today().strftime("%d-%m-%Y"))
         self.cfg_file = os.path.expanduser(cfg)
-        with open(self.cfg_file) as inf:
-            try:
-                self.cfg = AppConfig(**json.load(inf))
-            except json.decoder.JSONDecodeError:
-                sys.exit(f"Unable to decode JSON config at {self.cfg_file}")
 
-        try:
-            self.sf = Salesforce(
-                username=self.cfg.username,
-                password=self.cfg.password,
-                security_token=self.cfg.token,
-                domain=self.cfg.domain,
-                client_id="FF",
-            )
-        except SalesforceAuthenticationFailed as e:
-            logger.error(e)
-            sys.exit(1)
+        if os.path.isfile(self.cfg_file):
+            with open(self.cfg_file) as inf:
+                try:
+                    self.cfg = AppConfig(**json.load(inf))
+                except json.decoder.JSONDecodeError:
+                    sys.exit(f"Unable to decode JSON config at {self.cfg_file}")
 
-        self.contact_id = self.get_contact_id(self.cfg.username)
-        self.assignments = self.get_assignments_active()
-        self.global_project = self.get_global_project()
+            try:
+                self.sf = Salesforce(
+                    username=self.cfg.username,
+                    password=self.cfg.password,
+                    security_token=self.cfg.token,
+                    domain=self.cfg.domain,
+                    client_id="FF",
+                )
+            except SalesforceAuthenticationFailed as e:
+                logger.error(e)
+                sys.exit(1)
+
+            self.contact_id = self.get_contact_id(self.cfg.username)
+            self.assignments = self.get_assignments_active()
+            self.global_project = self.get_global_project()
+        else:
+            logger.warning("no config file found")
 
-        today = date.today()
-        day = today.strftime("%d-%m-%Y")
-        self.get_week(day)
 
     def get_week(self, day):
         dt = datetime.strptime(day, "%d-%m-%Y")
@@ -254,7 +257,7 @@ def get_global_project(self):
 
     def delete_time_entry(self, _id):
         try:
-            self.sf.pse__Timecard_Header__c.delete(_id)
+            return self.sf.pse__Timecard_Header__c.delete(_id)
         except SalesforceError:
             logger.error("failed on deletion id:{}".format(_id))
             logger.error(sys.exc_info()[1])
@@ -305,15 +308,15 @@ def add_time_entry(self, assignment_id, day_n, hours, notes):
                 "pse__Status__c not in ('Submitted', 'Approved') "
             )
 
-        new_timecard["pse__" + day_n + "_Hours__c"] = hours
-        new_timecard["pse__" + day_n + "_Notes__c"] = notes
+        new_timecard[f"pse__{day_n}_Hours__c"] = hours
+        new_timecard[f"pse__{day_n}_Notes__c"] = notes
 
         results = self.safe_sql(sql_query)
         logger.debug(json.dumps(new_timecard, indent=4))
         if len(results["records"]) > 0:
             logger.debug("required update")
             try:
-                self.sf.pse__Timecard_Header__c.update(
+                return self.sf.pse__Timecard_Header__c.update(
                     results["records"][0]["Id"], new_timecard
                 )
             except SalesforceError:
@@ -323,7 +326,7 @@ def add_time_entry(self, assignment_id, day_n, hours, notes):
 
         else:
             try:
-                self.sf.pse__Timecard_Header__c.create(new_timecard)
+                return self.sf.pse__Timecard_Header__c.create(new_timecard)
             except SalesforceError:
                 logger.error("failed on creation")
                 logger.error(sys.exc_info()[1])