refactoring of badge creation (#1166)

Author: 1ucian0

.github/workflows/welcome-new-member.yml

@@ -20,6 +20,7 @@ jobs:
 
         uuid=$(echo "${{github.head_ref}}" | cut -d - -f2 | awk '{$1=$1};1')
         echo "uuid=$uuid" >> $GITHUB_OUTPUT
+
     - name: Create comment on success
       uses: peter-evans/create-or-update-comment@v5
       with:
@@ -30,7 +31,7 @@ jobs:
               **${{ steps.get-id.outputs.project_name }} is now part of the Qiskit Ecosystem**. Here are some follow up actions you can take to get the most out of the program:
 
               - :speech_balloon: Join other Qiskit ecosystem developers in the Slack [channel `#qiskit-ecosystem`](https://qiskit.slack.com/archives/C04RHE56N93). If you are not in the Qiskit workspace yet, sign up at https://qisk.it/join-slack
-              - :books: Use the [Qiskit theme](https://github.com/Qiskit/qiskit_sphinx_theme) for your documentation
+              - :books: Use the [Qiskit Sphinx theme](https://github.com/Qiskit/qiskit_sphinx_theme) for your documentation
               - :purple_heart: Add the [Qiskit Ecosystem badge](https://qiskit.github.io/ecosystem/p/${{ steps.get-id.outputs.uuid }}/#badge) to the project's `README.md`
               - :ballot_box_with_check: Keep an eye on the [criteria compliance](https://qiskit.github.io/ecosystem/p/${{ steps.get-id.outputs.uuid }}/#checkups) to keep the project membership status.
               - :telephone_receiver: If you have questions or feedback, [join the Qiskit Community Call](http://evt.to/eooiimagw), [hosted by the Unitary Foundation](https://unitary.foundation/community/events/), or just open an issue on this repo.

ecosystem/badge.py

@@ -3,8 +3,9 @@
 from dataclasses import dataclass
 from typing import Optional
 
+from .error_handling import EcosystemError, logger
+from .request import URL, request_json
 from .serializable import JsonSerializable
-from .request import URL
 
 
 @dataclass
@@ -15,7 +16,7 @@ class BadgeData(JsonSerializable):
     """
 
     # pylint: disable=invalid-name
-    url: str | URL  # the bitly link to the badge
+    url: Optional[str | URL] = None  # the bitly link to the badge
     style: Optional[str] = None  # default: "flat"
     schemaVersion: Optional[int] = None
     label: Optional[str] = None
@@ -27,5 +28,61 @@ class BadgeData(JsonSerializable):
     logoSize: Optional[str] = None
 
     def __post_init__(self):
-        self.url = self.url if isinstance(self.url, URL) else URL(self.url)
-        self.style = "flat" if self.style is None else str(self.style)
+        if self.url:
+            self.url = self.url if isinstance(self.url, URL) else URL(self.url)
+        if self.style:
+            if self.style not in [
+                "flat",
+                "flat-square",
+                "plastic",
+                "for-the-badge",
+                "social",
+            ]:
+                raise EcosystemError("Entry badge.style not valid")
+        else:
+            self.style = "flat"
+
+    def update_url(self, name, short_uuid):
+        """If not there yet, creates a new Bitly link for the badge"""
+        short_url = f"https://qisk.it/e-{short_uuid}"
+
+        qisk_dot_it_link_check = request_json(
+            short_url,
+            parser=lambda x: {
+                "exists": x.startswith("<svg xmlns") and x.endswith("</svg>")
+            },
+        )
+        if qisk_dot_it_link_check["exists"]:
+            self.url = short_url
+        else:
+            self.url = BadgeData.create_link(name, short_uuid)
+
+    @staticmethod
+    def create_link(name, short_uuid):
+        """Creates short link in bitly.com"""
+        long_url = (
+            "https://img.shields.io/endpoint?url="
+            f"https://qiskit.github.io/ecosystem/b/{short_uuid}"
+        )
+        keyword = f"e-{short_uuid}"
+        data = {
+            "long_url": long_url,
+            "domain": "qisk.it",
+            "keyword": keyword,
+            "group_guid": "Bj9rgMHKfxH",
+            "title": f'Qiskit ecosystem "{name}" badge',
+            "tags": ["qiskit ecosystem badge", "permanent _do NOT remove_"],
+        }
+        try:
+            response = request_json("https://api-ssl.bitly.com/v4/bitlinks", post=data)
+        except EcosystemError as err:
+            if "Bad Request (400)" in err.message:
+                logger.info(
+                    "Bitly creation failed: %s -> %s ", f"qisk.it/{keyword}", long_url
+                )
+                return None  # Sometimes, bitly errors 400 for some server-side reason
+            raise err
+        logger.info(
+            "Bitly short link created: %s -> %s ", f"qisk.it/{keyword}", long_url
+        )
+        return response["link"]

ecosystem/member.py

@@ -4,14 +4,14 @@
 from uuid import uuid4
 from slugify import slugify
 
-from .error_handling import EcosystemError, logger
+from .error_handling import EcosystemError
 from .julia import JuliaData
 from .serializable import JsonSerializable, parse_datetime
 from .github import GitHubData
 from .pypi import PyPIData
 from .check import CheckData
 from .badge import BadgeData
-from .request import URL, request_json
+from .request import URL
 from .validation import validate_member
 
 
@@ -182,50 +182,13 @@ def update_github(self):
             self.github.update_json()
             self.github.update_owner_repo()
 
-    def _create_qisk_dot_it_link_for_badge(self):
-        long_url = (
-            "https://img.shields.io/endpoint?url="
-            f"https://qiskit.github.io/ecosystem/b/{self.short_uuid}"
-        )
-        keyword = f"e-{self.short_uuid}"
-        data = {
-            "long_url": long_url,
-            "domain": "qisk.it",
-            "keyword": keyword,
-            "group_guid": "Bj9rgMHKfxH",
-            "title": f'Qiskit ecosystem "{self.name}" badge',
-            "tags": ["qiskit ecosystem badge", "permanent _do NOT remove_"],
-        }
-        try:
-            response = request_json("https://api-ssl.bitly.com/v4/bitlinks", post=data)
-        except EcosystemError as err:
-            if "Bad Request (400)" in err.message:
-                return None  # Sometimes, bitly errors 400 for some server-side reason
-            raise err
-        logger.info(
-            "Bitly short link created: %s -> %s ", f"qisk.it/{keyword}", long_url
-        )
-        return response["link"]
-
-    def _qisk_dot_it_link_exists(self):
-        qisk_dot_it_link_check = request_json(
-            f"https://qisk.it/e-{self.short_uuid}",
-            parser=lambda x: {"exists": "<title>Qiskit Ecosystem:" not in x},
-        )
-        return (
-            f"https://qisk.it/e-{self.short_uuid}"
-            if qisk_dot_it_link_check["exists"]
-            else None
-        )
-
     def update_badge(self):
         """If not there yet, creates a new Bitly link for the badge"""
-        if self.badge is None:
-            badge_url = (
-                self._qisk_dot_it_link_exists()
-                or self._create_qisk_dot_it_link_for_badge()
-            )
-            self.badge = BadgeData(url=badge_url) if badge_url else None
+        if self.badge:
+            self.badge.update_url(name=self.name, short_uuid=self.short_uuid)
+        else:
+            url = BadgeData.create_link(name=self.name, short_uuid=self.short_uuid)
+            self.badge = BadgeData(url)
 
     def update_data(self):
         """Update all the member data in each existing section"""