adds websites list reload and delete.

Co-authored-by: Piotr Kaznowski <piotr@kazno.dev>

Author: filiplajszczak

pythonanywhere_core/schedule.py

@@ -10,7 +10,7 @@
 class Schedule:
     """Interface for PythonAnywhere scheduled tasks API.
 
-    Uses `pythonanywhere.api` :method: `get_api_endpoint` to create url,
+    Uses `pythonanywhere_core.api` :method: `get_api_endpoint` to create url,
     which is stored in a class variable `Schedule.base_url`, then calls
     `call_api` with appropriate arguments to execute scheduled tasks tasks
     actions. Covers 'GET' and 'POST' methods for tasks list, as well as

pythonanywhere_core/website.py

@@ -1,13 +1,32 @@
 import getpass
-from urllib.parse import urljoin
 
 from pythonanywhere_core.base import call_api, get_api_endpoint
 
 
 class Website:
+    """ Interface for PythonAnywhere websites API.
+
+    Uses ``pythonanywhere_core.base`` :method: ``get_api_endpoint`` to
+    create url, which is stored in a class variable ``Website.api_endpoint``,
+    then calls ``call_api`` with appropriate arguments to execute websites
+    action.
+
+    Use :method: ``Website.create`` to create new website.
+    Use :method: ``Website.get`` to get website info.
+    Use :method: ``Website.list`` to get all websites list.
+    Use :method: ``Website.reload`` to reload website.
+    Use :method: ``Website.delete`` to delete website.
+    """
+
     api_endpoint = get_api_endpoint(username=getpass.getuser(), flavor="websites")
 
-    def create(self, domain_name: str, command: str):
+    def create(self, domain_name: str, command: str) -> dict:
+        """Creates new website with ``domain_name`` and ``command``.
+
+        :param domain_name: domain name for new website
+        :param command: command for new website
+        :returns: dictionary with created website info"""
+
         response = call_api(
             self.api_endpoint,
             "post",
@@ -19,18 +38,45 @@ def create(self, domain_name: str, command: str):
         )
         return response.json()
 
-    def get(self, domain_name: str):
+    def get(self, domain_name: str) -> dict:
+        """Returns dictionary with website info for ``domain_name``.
+        :param domain_name:
+        :return: dictionary with website info"""
+
         response = call_api(
-            urljoin(self.api_endpoint, domain_name),
+            f"{self.api_endpoint}{domain_name}/",
             "get",
         )
         return response.json()
 
-    def list(self):
-        raise NotImplemented
+    def list(self) -> list:
+        """Returns list of dictionaries with all websites info.
+        :return: list of dictionaries with websites info"""
 
-    def reload(self):
-        raise NotImplemented
+        response = call_api(
+            self.api_endpoint,
+            "get",
+        )
+        return response.json()
+
+    def reload(self, domain_name: str) -> dict:
+        """Reloads website with ``domain_name``.
+        :param domain_name: domain name for website to reload
+        :return: dictionary with response"""
 
-    def delete(self):
-        raise NotImplemented
+        response = call_api(
+            f"{self.api_endpoint}{domain_name}/reload/",
+            "post",
+        )
+        return response.json()
+
+    def delete(self, domain_name: str) -> dict:
+        """Deletes website with ``domain_name``.
+        :param domain_name: domain name for website to delete
+        :return: empty dictionary"""
+
+        call_api(
+            f"{self.api_endpoint}{domain_name}/",
+            "delete",
+        )
+        return {}

tests/test_base.py

@@ -50,7 +50,7 @@ def test_get_api_endpoint_gets_domain_from_pythonanywhere_domain_and_adds_on_www
         ("students", "v0"),
         ("webapps", "v0"),
         ("websites", "v1"),
-     ]
+    ]
 )
 def test_get_api_endpoint_returns_url_with_correct_api_version(flavor, expected_version):
     result = get_api_endpoint(username="bill", flavor=flavor)

tests/test_website.py

@@ -64,14 +64,47 @@ def test_create_returns_json_with_created_website_info(
         "POST to create needs the payload to be passed as json field"
     )
 
+
 def test_get_returns_json_with_info_for_given_domain(
         api_responses, webapps_base_url, website_info, domain_name
 ):
     api_responses.add(
         responses.GET,
-        url=urljoin(webapps_base_url, domain_name),
+        url=f"{webapps_base_url}{domain_name}/",
         status=200,
         body=json.dumps(website_info)
     )
 
     assert Website().get(domain_name=domain_name) == website_info
+
+
+def test_list_returns_json_with_info_for_all_websites(api_responses, webapps_base_url, website_info):
+    api_responses.add(
+        responses.GET,
+        url=webapps_base_url,
+        status=200,
+        body=json.dumps([website_info])
+    )
+
+    assert Website().list() == [website_info]
+
+
+def test_reloads_website(api_responses, domain_name, webapps_base_url):
+    api_responses.add(
+        responses.POST,
+        url=f"{webapps_base_url}{domain_name}/reload",
+        status=200,
+        body=json.dumps({"status": "OK"})
+    )
+
+    assert Website().reload(domain_name=domain_name) == {"status": "OK"}
+
+
+def test_deletes_website(api_responses, domain_name, webapps_base_url):
+    api_responses.add(
+        responses.DELETE,
+        url=f"{webapps_base_url}{domain_name}/",
+        status=204,
+    )
+
+    assert Website().delete(domain_name=domain_name) == {}