From 7161ef211cbd463a8174169cf17b32c719548827 Mon Sep 17 00:00:00 2001
From: Clemens Beck <github@beckcl.dev>
Date: Sun, 19 Feb 2023 02:37:13 +0100
Subject: [PATCH] [modules/gitlab] add module

---
 bumblebee_status/modules/contrib/gitlab.py |  78 +++++++++++++++++++++
 requirements/modules/gitlab.txt            |   1 +
 screenshots/gitlab.png                     | Bin 0 -> 2456 bytes
 tests/modules/contrib/test_gitlab.py       |  42 +++++++++++
 themes/icons/ascii.json                    |   3 +
 themes/icons/awesome-fonts.json            |   3 +
 6 files changed, 127 insertions(+)
 create mode 100644 bumblebee_status/modules/contrib/gitlab.py
 create mode 100644 requirements/modules/gitlab.txt
 create mode 100644 screenshots/gitlab.png
 create mode 100644 tests/modules/contrib/test_gitlab.py

diff --git a/bumblebee_status/modules/contrib/gitlab.py b/bumblebee_status/modules/contrib/gitlab.py
new file mode 100644
index 0000000..126650d
--- /dev/null
+++ b/bumblebee_status/modules/contrib/gitlab.py
@@ -0,0 +1,78 @@
+# pylint: disable=C0111,R0903
+
+"""
+Displays the GitLab todo count:
+
+    * https://docs.gitlab.com/ee/user/todos.html
+    * https://docs.gitlab.com/ee/api/todos.html
+
+Uses `xdg-open` or `x-www-browser` to open web-pages.
+
+Requires the following library:
+    * requests
+
+Errors:
+    if the GitLab todo query failed, the shown value is `n/a`
+
+Parameters:
+    * gitlab.token: GitLab personal access token, the token needs to have the "read_api" scope.
+    * gitlab.host: Host of the GitLab instance, default is "gitlab.com".
+    * gitlab.actions: Comma separated actions to be parsed (e.g.: gitlab.actions=assigned,approval_required)
+"""
+
+import json
+import requests
+import shutil
+import util
+
+import core.module
+import core.widget
+import core.decorators
+import core.input
+
+
+class Module(core.module.Module):
+    @core.decorators.every(minutes=5)
+    def __init__(self, config, theme):
+        super().__init__(config, theme, core.widget.Widget(self.gitlab))
+
+        self.background = True
+        self.__label = ""
+        self.__host = self.parameter("host", "gitlab.com")
+
+        self.__actions = []
+        actions = self.parameter("actions", "")
+        if actions:
+            self.__actions = util.format.aslist(actions)
+
+        self.__requests = requests.Session()
+        self.__requests.headers.update({"PRIVATE-TOKEN": self.parameter("token", "")})
+
+        cmd = "xdg-open"
+        if not shutil.which(cmd):
+            cmd = "x-www-browser"
+
+        core.input.register(
+            self,
+            button=core.input.LEFT_MOUSE,
+            cmd="{cmd} https:/{host}//dashboard/todos".format(
+                cmd=cmd, host=self.__host
+            ),
+        )
+
+    def gitlab(self, _):
+        return self.__label
+
+    def update(self):
+        try:
+            url = "https://{host}/api/v4/todos".format(host=self.__host)
+            response = self.__requests.get(url)
+            todos = response.json()
+            if self.__actions:
+                todos = [t for t in todos if t["action_name"] in self.__actions]
+            self.__label = str(len(todos))
+        except Exception as e:
+            self.__label = "n/a"
+
+
+# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4
diff --git a/requirements/modules/gitlab.txt b/requirements/modules/gitlab.txt
new file mode 100644
index 0000000..f229360
--- /dev/null
+++ b/requirements/modules/gitlab.txt
@@ -0,0 +1 @@
+requests
diff --git a/screenshots/gitlab.png b/screenshots/gitlab.png
new file mode 100644
index 0000000000000000000000000000000000000000..d488db0dd458860553f6cf7e01cf97432458f41e
GIT binary patch
literal 2456
zcmZ{mX*|^H8^(XpVMx|2<qShg#$bkH%`zBU_Ngq5Ek<J}V=2oVOGL&NS!YO5$uVV@
zUDi5`tz&I06++gDjIo?KFaIz8pXa`w@BLi&bG^TlZLCbra$n#E0N|{dDGJS^1xx2a
zY^?iSy{iTbr*Zn0`T$Use&+D@Z>%@O!xU`^01=k~Am#x89I&jI?*I@A2Y^*K0MN<<
z0MQ^)ldU#uz~OFgf&xzdJ5O6*X0aTuAX7&?i>#l3EAXn$i_U5|L(D9VIG5RkPD#oa
z(;D1a7Qe@Bt1uRWSQ2N6hb4gRrB4C?fPBqR`ZpZ91|3!co$Q5AXp61+Redu=oxcld
zS=)jWHVu~)Ff+qQ(JQY&Y{GF$kkVt#C?u#2B9#H{7rpiBR-LK0TzONeWr0@cszw;O
zXS+>FWpg%if9p=2&R3b3?jv}?uaJ#*%i+{bQY6*Gt6t1dIh_J0%IOKlA^-@qU9&L>
z;Nai~w49dyY)$F_;QXC=C>XTxk@47f9x$pO*pVoV=*!v;noae5sC6L0|E$`){N5is
zWhDke8JRNg5jNoWkGRp?1~K%b?Y|N!2^R8m>R)@D^>^=~fcUk<u9Ao8e7{BM5|XeQ
zX)ZWDgH1kLWr4sm`z4|5p|*zoVxwk#^)N9!@<p<za2h-Y0k=y|_=OC&NDe-CK6`az
zgMh_q%-7V7b0YVCN<D^MuauAiq~#XVi=v|7g>h@jLvhh1!%gyHQOD(3AG{=;dM0h}
zLfB5Bh6}DK3a8XIn>0t>fa#Y%qJ<~c_{5KPx-q*h8al80Pm59SUv$1|nB@5}0JeM^
z>{2#rCM%x4ltncub}C`#ROvNcagrV{CgKD~d{t^pN-x<yfz<oIBzs9M{tOHEF;o}L
z(JdmmI6Ed}tCAEBZ>k#m{@HP|)gRPYW9U7o!D$Qb-&53Zgu7glfF`{7VLR_|SzwFF
zEhjrHF-fDv^X~>+_JAxRwY<$VNtW%5V<Qh94ZTqmm9Zi#c`|);@shp&<~kQu5-cA5
zrF$~v4Y~Dj>Ktq>t?{E+ZM`3}d%M%?6-I7QlT+Z7a7HXdP!r@xSG1A84xIP+?XYVq
zd+l{w(FRGVnU%_Vyjnp)fWhnR`KYQJ*Nm9%ttA-z86y4SD`Oc2b8-6WJ3d{p_Ud;v
zU7+XjjIoyzI!Bd#gu2F-rg~nv!pKJ-OVo@_w})+{gjeuS+=(~)sWQMmo9WN4YH@x$
zUk(o*NF`Xd;E}OY*);ocr_;gC6S;J6RTC&V)IC~<cF8_8w3g5FdPBfKXO2lm4x;Q+
zzWQu%_#VKv3^}CJ_{OUGg=BltRsE|w+%?}899PZ{0RCb)5B3Bn?IkHJQ6Q7^NtY;6
zn$s1)zW%J;eY=+ji(Ws~j=&P-N`*QpywHinYuodFwHY-E-aK4Xy4*u%bScI_hRq|f
zU*X+bg*!7DkC`yB>B(sk5?ALMS18B;K#^)jJdP5wpV!Vl<c~qY5|Erk4%{M-c1%Vs
z*Xei)x?PiAJ)VeoQFq*%Ty@XY!S`#A3#hHFF525?>B~3O-aIt)eCp5LkRc^lthy9t
zw+j7AXGgp&VJ`QsySzB2A=j>BQow0gOClu=JJvg_{{WE5Szhp!$JdcCpE_=GprL|k
z<f!k*dTl$s-@0$^M_<Vi%$yav7~k`FO>TE)oRM6St7y%3x{TeKJQw*xzBiBY?*5$*
zcE;mEBj#r(qTT#Lemd;cg;R$HmEO<HJ`1_qR$H&u{5CJyID5RPAcFKeX01_`y|R^^
zFE}1F4=WB9%-o_|lZi54fINRoiy=h{MZPkHf<gPdbZ7}$gd#sz|JbWvF4on|wiHJ5
z{+hZm0S6ak{o|(00nJgK`jlQAbvU*%Wj{v{-EG+JOm(rHZ*hP{2QfZYE(*(?7Pt?p
zSPljzZ*_gPn2JkWy;Vg_$vh^GYF$`mbe6wiMybWpTwGdp+rQVqfXDPfGOc1F@YKMS
z-R@k;D7WvER2Kv|<w0cA)7_EO{BXajbJpDi#u3g=P3>fBXYJ}tGyk)jczaJ0e-C=4
zbvwDIZZ}@T$g!#M%yWSsK0#<z4AHh1OY$n56Xn_sqRQT(6uKimjp<~VK`W2ybqMQp
zyl7wQT3RZvUieN$PBvvckZ{lYaFtk&o7TrvnAt*&o@a^@_Wx2_3dbF{)z%L9`RWyk
zpyod-h=@+8OP6e@wa<xt&5Tb%Sw@75Kj0vRw&U@1p&IorXYxppH8oi=(2v%FSZ3qn
zk*p~_-PNv0w06$FhP|$Lv{xQv-#3_0ChB^XxyKYGN+n$;M+j?sTzPUJ-Ks=7rkwlI
zfIC)GZ}0GLwp+zC2>p`*vYnp6%uW&$3<$;k#O+b^AEujraroMBwV#w(XQjoZgWjGG
z-esYGD(jNWtv}~A>#FO0E>8WGIIh;<s>Mum-)G>habHL9lCH;N@+WykZM^0=xXe4{
zi>>yr-zXiXEEg@1jt+*DXl;Zu1{vt#rl^sxyjsoIw10(#**AoLS;$Z*Lv(8jF&FFA
zZ##lc#~xh=2^q+%YU(f<hwf5YhhLD#G;7^Dg|*Iw_p;Yj0?F<BS(~H_122wu4lqh&
zorc!BF24$4^NP*XDt{(!h=7+VZVjV{!TB3E_d9HKuabsn>KXRf9Q$#|{z!z)d3}w!
zsp;9t8GJ++8Z?HSxIjHSN!Xw9)%cqmL{gCwS<Y3ou)>kQyD6&b?lQcjel0Q5nOW2z
z#Uo~W+rdbgbu!|z(YuZ3i;(wXM6Uhl^r(f#>}T?mcBZnU+oqRAEc-4pvQ-*dg8lb6
z9(Vy`*|l|V0|Nrqn*v(Y2OMj345af--ZtNT4Qt@$fs~0Yr;{7!1eKS&0~BEbTYDzC
zYIYNOL-z3#)3Dd6PdkxFZmZdE&ba-6svEE;X;yznYuQT7aa8A5#YWL}MvYg+rsJ5H
zsp>@{F?RF=R(q{`DcAlDbrw>&R$$>Xod!-6>iwON5@9$1mi}uMwJrkw_yQBKmJFG4
z-4NncAfkpZ7$ALvTo|)=?*-ng-Q0A1Ds06b*U~)5Ig}%q2=TPsr4dS-EBJm7e_3<5
zvgM+0hk^EXICe23$M#%ZLwS}@GDV*Lcnh6Bskph&-+t<Tq&~Y`lFK@4`?wTh<Pd_r
z9pb6w5$wqVpbS@5QGhEeAT)2l5n3v&QkI9qwczk_`Hz(U3HS$Mz3<%r|AEP{V8Q<u
N95W*;6ve<T?q9eNko*7u

literal 0
HcmV?d00001

diff --git a/tests/modules/contrib/test_gitlab.py b/tests/modules/contrib/test_gitlab.py
new file mode 100644
index 0000000..d3a3b9a
--- /dev/null
+++ b/tests/modules/contrib/test_gitlab.py
@@ -0,0 +1,42 @@
+import pytest
+from unittest import TestCase, mock
+
+import core.config
+import core.widget
+import modules.contrib.gitlab
+
+from requests import Session
+from requests.models import Response
+
+pytest.importorskip("requests")
+
+
+def build_gitlab_module(actions=""):
+    config = core.config.Config(["-p", "gitlab.actions={}".format(actions)])
+    return modules.contrib.gitlab.Module(config=config, theme=None)
+
+def mock_todo_api_response():
+    res = mock.Mock()
+    res.json = lambda: [
+        {"action_name": "assigned"},
+        {"action_name": "assigned"},
+        {"action_name": "approval_required"},
+    ]
+    res.status_code = 200
+    return res
+
+class TestGitlabUnit(TestCase):
+    def test_load_module(self):
+        __import__("modules.contrib.gitlab")
+
+    @mock.patch.object(Session, "get", return_value=mock_todo_api_response())
+    def test_unfiltered(self, _):
+        module = build_gitlab_module()
+        module.update()
+        assert module.widgets()[0].full_text() == "3"
+
+    @mock.patch.object(Session, "get", return_value=mock_todo_api_response())
+    def test_filtered(self, _):
+        module = build_gitlab_module(actions="approval_required")
+        module.update()
+        assert module.widgets()[0].full_text() == "1"
diff --git a/themes/icons/ascii.json b/themes/icons/ascii.json
index 089fa3c..d353386 100644
--- a/themes/icons/ascii.json
+++ b/themes/icons/ascii.json
@@ -309,6 +309,9 @@
   "github": {
     "prefix": "github"
   },
+  "gitlab": {
+    "prefix": "gitlab"
+  },
   "deezer": {
     "prefix": ""
   },
diff --git a/themes/icons/awesome-fonts.json b/themes/icons/awesome-fonts.json
index e3aeebe..4015e43 100644
--- a/themes/icons/awesome-fonts.json
+++ b/themes/icons/awesome-fonts.json
@@ -581,6 +581,9 @@
   "github": {
     "prefix": "  "
   },
+  "gitlab": {
+    "prefix": ""
+  },
   "deezer": {
     "prefix": "  "
   },