Add command to list spent times

Author: egegunes

redmine/cli/main.py

@@ -15,6 +15,7 @@
 from redmine.project import Project
 from redmine.query import Query
 from redmine.redmine import Redmine
+from redmine.time import Time
 from redmine.tracker import Tracker
 from redmine.user import User
 from redmine.version import Version
@@ -121,15 +122,28 @@ def show(redmine, issue_id, journals, pager):
 
 
 @cli.command()
-@click.option(OPTIONS["subject"]["long"], OPTIONS["subject"]["short"], default=None, required=True)
+@click.option(
+    OPTIONS["subject"]["long"], OPTIONS["subject"]["short"], default=None, required=True
+)
 @click.option(
     OPTIONS["description"]["long"], OPTIONS["description"]["short"], default=None
 )
 @click.option(OPTIONS["edit"]["long"], OPTIONS["edit"]["short"], default=False)
-@click.option(OPTIONS["project"]["long"], OPTIONS["project"]["short"], default=None, required=True)
-@click.option(OPTIONS["status"]["long"], OPTIONS["status"]["short"], default=None, required=True)
-@click.option(OPTIONS["tracker"]["long"], OPTIONS["tracker"]["short"], default=None, required=True)
-@click.option(OPTIONS["priority"]["long"], OPTIONS["priority"]["short"], default=None, required=True)
+@click.option(
+    OPTIONS["project"]["long"], OPTIONS["project"]["short"], default=None, required=True
+)
+@click.option(
+    OPTIONS["status"]["long"], OPTIONS["status"]["short"], default=None, required=True
+)
+@click.option(
+    OPTIONS["tracker"]["long"], OPTIONS["tracker"]["short"], default=None, required=True
+)
+@click.option(
+    OPTIONS["priority"]["long"],
+    OPTIONS["priority"]["short"],
+    default=None,
+    required=True,
+)
 @click.option(OPTIONS["assignee"]["long"], OPTIONS["assignee"]["short"], default=None)
 @click.option(OPTIONS["start"]["long"], OPTIONS["start"]["short"], default=None)
 @click.option(OPTIONS["due"]["long"], OPTIONS["due"]["short"], default=None)
@@ -360,3 +374,35 @@ def open(redmine, issue_id):
 
     url = urljoin(redmine.url, "/issues/{}".format(issue_id))
     click.launch(url)
+
+
+@cli.command()
+@click.option(OPTIONS["user"]["long"], OPTIONS["user"]["short"], default=None)
+@click.option(OPTIONS["project"]["long"], OPTIONS["project"]["short"], default=None)
+@click.option(OPTIONS["from"]["long"], default=None)
+@click.option(OPTIONS["to"]["long"], default=None)
+@click.option(OPTIONS["on"]["long"], default=None)
+@click.pass_obj
+def times(redmine, **kwargs):
+    """ List spent times """
+
+    on = kwargs.get("on")
+    if on is not None:
+        kwargs.update({"from": on, "to": on})
+
+    try:
+        entries = redmine.get(
+            "time_entries",
+            cache=False,
+            **{
+                "user_id": kwargs.get("user"),
+                "project_id": kwargs.get("project"),
+                "from": kwargs.get("from"),
+                "to": kwargs.get("to"),
+            },
+        )
+    except HTTPError as e:
+        return click.echo(click.style(f"Fatal: {e}", fg="red"))
+
+    for entry in entries:
+        click.echo(Time(**entry))

redmine/cli/options.py

@@ -27,4 +27,8 @@
     "json": {"long": "--json/--no-json"},
     "account": {"long": "--account", "help": "Account name to use"},
     "pager": {"long": "--pager/--no-pager"},
+    "user": {"long": "--user", "short": "-u"},
+    "from": {"long": "--from"},
+    "to": {"long": "--to"},
+    "on": {"long": "--on"},
 }

redmine/redmine.py

@@ -36,10 +36,10 @@ def __repr__(self):
     def __str__(self):
         return repr(self)
 
-    def fetch(self, resource):
+    def fetch(self, resource, **kwargs):
         resp = requests.get(
             urljoin(self.url, "{}.json".format(resource)),
-            params={"limit": 100},
+            params={"limit": 100, **kwargs},
             headers=self.auth_header,
             verify=self.ssl_verify,
         )
@@ -52,16 +52,16 @@ def set_cache(self, cache_file, data):
         with open(cache_file, "w+") as cf:
             cf.write(json.dumps(data))
 
-    def get(self, resource):
+    def get(self, resource, cache=True, **kwargs):
         # Some resources (i.e issue_priorities) have paths that contain "/"
         rname = resource.split("/")[-1]
         cache_file = os.path.join(self.cache_dir, "{}.json".format(rname))
         if os.path.exists(cache_file):
             with open(cache_file, "r") as cf:
                 data = json.loads(cf.read())
         else:
-            data = self.fetch(resource)
-            if resource in data:
+            data = self.fetch(resource, **kwargs)
+            if resource in data and cache:
                 self.set_cache(cache_file, data)
 
         return data[rname]

redmine/time.py

@@ -0,0 +1,12 @@
+class Time:
+    def __init__(self, *args, **kwargs):
+        self.project = kwargs.get("project")
+        self.issue = kwargs.get("issue")
+        self.user = kwargs.get("user")
+        self.hours = kwargs.get("hours")
+        self.activity = kwargs.get("activity")
+        self.comments = kwargs.get("comments")
+        self.spent_on = kwargs.get("spent_on")
+
+    def __str__(self):
+        return f"{self.project['name']:<21.20} {self.issue['id']:>6} {self.user['name']:<21.20} {self.activity['name']:<15.14} {self.spent_on:<11} {self.hours:>6} hours"