Remove Python 3.7 support

Respect pagination when returning all group members

.github/workflows/test.yml

@@ -5,11 +5,11 @@ on: [ push, pull_request ]
 jobs:
   test:
 
-    name: Test on Python ${{ matrix.py_version }}
+    name: Test on Python ${{ matrix.python-version }}
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ "3.7", "3.8", "3.9", "3.10" ]
+        python-version: [ "3.8", "3.9", "3.10", "3.11" ]
 
     steps:
       - uses: actions/checkout@v1

.gitignore

@@ -36,3 +36,9 @@ coverage.xml
 
 # Sphinx documentation
 docs/_build/
+
+# Pyenv
+.python-version
+
+# PyCharm
+.idea

CONTRIBUTING.rst

@@ -43,7 +43,7 @@ Or it's slightly faster cousin `detox
 
 Alternatively, you can run the self test with the following commands::
 
-    pip install -r requirements.dev.txt
+    pip install -r requirements.txt
     pip install -e .
     python setup.py test
 

HISTORY.rst

@@ -3,6 +3,21 @@
 Release history
 ===============
 
+1.5.0
+-----
+
+- Owner creation endpoint update from @akhmerov
+- Python 3.11 support from @Dettorer
+- Group membership fixes from @inducer
+- Rate limiting fixes from @inducer
+- Latest posts endpoint from @max-lancaster
+
+
+1.4.0
+-----
+
+- Documented here as skipped release
+
 1.3.0
 -----
 

docs/conf.py

@@ -51,9 +51,9 @@ copyright = u'2014, Marc Sibson'
 # built documents.
 #
 # The short X.Y version.
-version = '1.1'
+version = '1.5'
 # The full version, including alpha/beta/rc tags.
-release = '1.1.1'
+release = '1.5.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

setup.cfg

@@ -26,10 +26,10 @@ classifiers =
     License :: OSI Approved :: MIT License
     Operating System :: OS Independent
     Programming Language :: Python
-    Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
     Programming Language :: Python :: 3.10
+    Programming Language :: Python :: 3.11
 
 [options.packages.find]
 where=src

src/pydiscourse/__init__.py

@@ -1,8 +1,6 @@
-# -*- coding: utf-8 -*-
-
 """Python client for the Discourse API."""
 
-__version__ = "1.3.0"
+__version__ = "1.5.0"
 
 from pydiscourse.client import DiscourseClient
 

src/pydiscourse/client.py

@@ -649,6 +649,21 @@ class DiscourseClient(object):
             kwargs["post_ids[]"] = post_ids
         return self._get("/t/{0}/posts.json".format(topic_id), **kwargs)
 
+    def latest_posts(self, before=None, **kwargs):
+        """
+        List latest posts across topics
+
+        Args:
+            before: Load posts with an id lower than this value. Useful for pagination.
+            **kwargs:
+
+        Returns:
+
+        """
+        if before:
+            kwargs["before"] = before
+        return self._get("/posts.json", **kwargs)
+
     def topic_timings(self, topic_id, time, timings={}, **kwargs):
         """
         Set time spent reading a post
@@ -922,6 +937,18 @@ class DiscourseClient(object):
 
         return self._get(u"/c/{0}/show.json".format(category_id), **kwargs)
 
+    def update_category(self, category_id, **kwargs):
+        """
+
+        Args:
+            category_id:
+            **kwargs:
+
+        Returns:
+
+        """
+        return self._put("/categories/{0}".format(category_id), json=True, **kwargs)
+
     def delete_category(self, category_id, **kwargs):
         """
         Remove category
@@ -1118,9 +1145,7 @@ class DiscourseClient(object):
             JSON API response
 
         """
-        return self._put(
-            "/admin/groups/{0}/owners.json".format(groupid), **{"group[usernames]": username}
-        )
+        return self.add_group_owners(groupid, [username])
 
     def add_group_owners(self, groupid, usernames):
         """
@@ -1136,7 +1161,7 @@ class DiscourseClient(object):
         """
         usernames = ",".join(usernames)
         return self._put(
-            "/admin/groups/{0}/owners.json".format(groupid), **{"group[usernames]": usernames}
+            "/groups/{0}/owners.json".format(groupid), **{"usernames": usernames}
         )
 
     def delete_group_owner(self, groupid, userid):
@@ -1164,13 +1189,28 @@ class DiscourseClient(object):
         group = self._get("/groups/{0}/members.json".format(group_name))
         return group["owners"]
 
+    def _get_paginated_list(self, url, name, offset, **kwargs):
+        result = []
+        initial_offset = offset
+        while True:
+            kwargs["offset"] = offset
+            response = self._get(url, **kwargs)
+            nreturned = len(response[name])
+            result.extend(response[name])
+            offset += nreturned
+
+            if response["meta"]["total"] == len(result) - initial_offset:
+                return result
+            if nreturned == 0:
+                raise RuntimeError("more items expected, but none returned")
+
     def group_members(self, group_name, offset=0, **kwargs):
         """
         Get all members of a group by group name
         """
-        kwargs["offset"] = offset
-        group = self._get("/groups/{0}/members.json".format(group_name), **kwargs)
-        return group["members"]
+        return self._get_paginated_list(
+                "/groups/{0}/members.json".format(group_name),
+                "members", offset, **kwargs)
 
     def add_group_member(self, groupid, username):
         """
@@ -1188,7 +1228,7 @@ class DiscourseClient(object):
 
         """
         return self._put(
-            "/admin/groups/{0}/members.json".format(groupid), usernames=username
+            "/groups/{0}/members.json".format(groupid), usernames=username
         )
 
     def add_group_members(self, groupid, usernames):
@@ -1208,7 +1248,8 @@ class DiscourseClient(object):
         """
         usernames = ",".join(usernames)
         return self._put(
-            "/admin/groups/{0}/members.json".format(groupid), usernames=usernames
+            "/groups/{0}/members.json".format(groupid), usernames=usernames,
+            json=True,
         )
 
     def add_user_to_group(self, groupid, userid):
@@ -1228,7 +1269,7 @@ class DiscourseClient(object):
         """
         return self._post("/admin/users/{0}/groups".format(userid), group_id=groupid)
 
-    def delete_group_member(self, groupid, userid):
+    def delete_group_member(self, groupid, username):
         """
         Deletes a member from a group by user ID
 
@@ -1236,15 +1277,16 @@ class DiscourseClient(object):
 
         Args:
             groupid: the ID of the group
-            userid: the ID of the user
+            username: the user name of the user
 
         Returns:
             JSON API response
 
         """
-        return self._delete(
-            "/admin/groups/{0}/members.json".format(groupid), user_id=userid
-        )
+        return self._request(
+            DELETE, "/groups/{0}/members.json".format(groupid),
+            json={"usernames": username})
+
 
     def color_schemes(self, **kwargs):
         """
@@ -1561,7 +1603,8 @@ class DiscourseClient(object):
                 if 400 <= response.status_code < 500:
                     if 429 == response.status_code:
                         # This codepath relies on wait_seconds from Discourse v2.0.0.beta3 / v1.9.3 or higher.
-                        if "application/json" in response.headers.get("Content-Type"):
+                        content_type = response.headers.get("Content-Type")
+                        if content_type is not None and "application/json" in content_type:
                             ret = response.json()
                             wait_delay = (
                                 retry_backoff + ret["extras"]["wait_seconds"]
@@ -1571,14 +1614,17 @@ class DiscourseClient(object):
                             ret = response.content
                             wait_delay = retry_backoff + 10
 
+                        limit_name = response.headers.get(
+                                "Discourse-Rate-Limit-Error-Code", "<unknown>")
+
+                        log.info(
+                                "We have been rate limited (limit: {2}) and will wait {0} seconds ({1} retries left)".format(
+                                wait_delay, retry_count, limit_name
+                            )
+                        )
                         if retry_count > 1:
                             time.sleep(wait_delay)
                         retry_count -= 1
-                        log.info(
-                            "We have been rate limited and waited {0} seconds ({1} retries left)".format(
-                                wait_delay, retry_count
-                            )
-                        )
                         log.debug("API returned {0}".format(ret))
                         continue
                     else:

tests/test_client.py

@@ -182,6 +182,11 @@ class TestTopics(ClientBaseTestCase):
 @mock.patch("pydiscourse.client.requests.request")
 class MiscellaneousTests(ClientBaseTestCase):
 
+    def test_latest_posts(self, request):
+        prepare_response(request)
+        r = self.client.latest_posts(before=54321)
+        self.assertRequestCalled(request, "GET", "/posts.json", before=54321)
+
     def test_search(self, request):
         prepare_response(request)
         self.client.search("needle")
@@ -193,6 +198,11 @@ class MiscellaneousTests(ClientBaseTestCase):
         self.assertRequestCalled(request, "GET", "/categories.json")
         self.assertEqual(r, request().json()["category_list"]["categories"])
 
+    def test_update_category(self, request):
+        prepare_response(request)
+        self.client.update_category(123, a="a", b="b")
+        self.assertRequestCalled(request, "PUT", "/categories/123", a="a", b="b")
+
     def test_users(self, request):
         prepare_response(request)
         self.client.users()

tox.ini

@@ -1,12 +1,12 @@
 [tox]
-envlist = py37, py38, py39, py310
+envlist = py37, py38, py39, py310, py311
 
 [gh-actions]
 python =
-    3.7: py37
     3.8: py38
     3.9: py39
     3.10: py310
+    3.11: py311
 
 [testenv]
 setenv =