Update makefile

Added badges endpoint to pydiscourse

HISTORY.rst

@@ -3,6 +3,16 @@
 Release history
 ===============
 
+0.5.0
+-----
+
+* Adds badges functionality
+
+0.4.0
+-----
+
+* Adds initial groups functionality
+
 0.3.2
 -----
 

Makefile

@@ -37,13 +37,15 @@ test-all:  ## Run all tox test environments, parallelized
 
 check: clean-build clean-pyc clean-test lint test-coverage
 
-release: clean  ## Uploads new source and wheel distributions (cleans first)
-	python setup.py sdist upload
-	python setup.py bdist_wheel upload
+build: clean  ## Create distribution files for release
+	python setup.py sdist bdist_wheel
 
-dist: clean  ## Creates new source and wheel distributions (cleans first)
+release: build  ## Create distribution files and publish to PyPI
+	python setup.py check -r -s
+	twine upload dist/*
+
+sdist: clean  ##sdist Create source distribution only
 	python setup.py sdist
-	python setup.py bdist_wheel
 	ls -l dist
 
 api-docs:  ## Build autodocs from docstrings

docs/conf.py

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

pydiscourse/__init__.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
 
-__version__ = '0.3.2'
+__version__ = '0.5.0'
 
 from pydiscourse.client import DiscourseClient

pydiscourse/client.py

@@ -13,6 +13,12 @@ from pydiscourse.sso import sso_payload
 
 log = logging.getLogger('pydiscourse.client')
 
+# HTTP verbs to be used as non string literals
+DELETE = "DELETE"
+GET = "GET"
+POST = "POST"
+PUT = "PUT"
+
 
 class DiscourseClient(object):
     """Discourse API client"""
@@ -535,6 +541,43 @@ class DiscourseClient(object):
         kwargs['term'] = term
         return self._get('/search.json', **kwargs)
 
+
+    def badges(self, **kwargs):
+        """
+
+        Args:
+            **kwargs:
+
+        Returns:
+
+        """
+        return self._get('/admin/badges.json', **kwargs)
+
+    def grant_badge_to(self, username, badge_id, **kwargs):
+        """
+
+        Args:
+            username:
+            badge_id:
+            **kwargs:
+
+        Returns:
+
+        """
+        return self._post('/user_badges', username=username, badge_id=badge_id, **kwargs)
+
+    def user_badges(self, username, **kwargs):
+        """
+
+        Args:
+            username:
+
+        Returns:
+
+        """
+        return self._get('/user-badges/{}.json'.format(username))
+
+
     def create_category(self, name, color, text_color='FFFFFF',
                         permissions=None, parent=None, **kwargs):
         """
@@ -611,7 +654,117 @@ class DiscourseClient(object):
         """
         for setting, value in kwargs.items():
             setting = setting.replace(' ', '_')
-            self._request('PUT', '/admin/site_settings/{0}'.format(setting), {setting: value})
+            self._request(PUT, '/admin/site_settings/{0}'.format(setting), {setting: value})
+
+    def groups(self, **kwargs):
+        """
+        Returns a list of all groups.
+
+        Returns:
+            List of dictionaries of groups
+
+                [
+                  {
+                    'alias_level': 0,
+                    'automatic': True,
+                    'automatic_membership_email_domains': None,
+                    'automatic_membership_retroactive': False,
+                    'grant_trust_level': None,
+                    'has_messages': True,
+                    'id': 1,
+                    'incoming_email': None,
+                    'mentionable': False,
+                    'name': 'admins',
+                    'notification_level': 2,
+                    'primary_group': False,
+                    'title': None,
+                    'user_count': 9,
+                    'visible': True
+                  },
+                  {
+                    'alias_level': 0,
+                    'automatic': True,
+                    'automatic_membership_email_domains': None,
+                    'automatic_membership_retroactive': False,
+                    'grant_trust_level': None,
+                    'has_messages': False,
+                    'id': 0,
+                    'incoming_email': None,
+                    'mentionable': False,
+                    'name': 'everyone',
+                    'notification_level': None,
+                    'primary_group': False,
+                    'title': None,
+                    'user_count': 0,
+                    'visible': True
+                  }
+                ]
+
+        """
+        return self._get("/admin/groups.json", **kwargs)
+
+    def add_group_owner(self, groupid, username):
+        """
+        Add an owner to a group by username
+
+        Args:
+            groupid: the ID of the group
+            username: the new owner usernmae
+
+        Returns:
+            JSON API response
+
+        """
+        return self._put("/admin/groups/{0}/owners.json".format(groupid), usernames=username)
+
+    def delete_group_owner(self, groupid, userid):
+        """
+        Deletes an owner from a group by user ID
+
+        Does not delete the user from Discourse.
+
+        Args:
+            groupid: the ID of the group
+            userid: the ID of the user
+
+        Returns:
+            JSON API response
+
+        """
+        return self._delete("/admin/groups/{0}/owners.json".format(groupid), user_id=userid)
+
+    def add_group_member(self, groupid, username):
+        """
+        Add a member to a group by username
+
+        Args:
+            groupid: the ID of the group
+            username: the new member usernmae
+
+        Returns:
+            JSON API response
+
+        Raises:
+            DiscourseError if user is already member of group
+
+        """
+        return self._put("/admin/groups/{0}/members.json".format(groupid), usernames=username)
+
+    def delete_group_member(self, groupid, userid):
+        """
+        Deletes a member from a group by user ID
+
+        Does not delete the user from Discourse.
+
+        Args:
+            groupid: the ID of the group
+            userid: the ID of the user
+
+        Returns:
+            JSON API response
+
+        """
+        return self._delete("/admin/groups/{0}/members.json".format(groupid), user_id=userid)
 
     def _get(self, path, **kwargs):
         """
@@ -623,7 +776,7 @@ class DiscourseClient(object):
         Returns:
 
         """
-        return self._request('GET', path, kwargs)
+        return self._request(GET, path, kwargs)
 
     def _put(self, path, **kwargs):
         """
@@ -635,7 +788,7 @@ class DiscourseClient(object):
         Returns:
 
         """
-        return self._request('PUT', path, kwargs)
+        return self._request(PUT, path, kwargs)
 
     def _post(self, path, **kwargs):
         """
@@ -647,7 +800,7 @@ class DiscourseClient(object):
         Returns:
 
         """
-        return self._request('POST', path, kwargs)
+        return self._request(POST, path, kwargs)
 
     def _delete(self, path, **kwargs):
         """
@@ -659,15 +812,16 @@ class DiscourseClient(object):
         Returns:
 
         """
-        return self._request('DELETE', path, kwargs)
+        return self._request(DELETE, path, kwargs)
 
     def _request(self, verb, path, params):
         """
+        Executes HTTP request to API and handles response
 
         Args:
-            verb:
-            path:
-            params:
+            verb: HTTP verb as string: GET, DELETE, PUT, POST
+            path: the path on the Discourse API
+            params: dictionary of parameters to include to the API
 
         Returns:
 

tests/test_client.py

@@ -120,6 +120,11 @@ class TestUser(ClientBaseTestCase):
         self.client.unsuspend(123)
         self.assertRequestCalled(request, 'PUT', '/admin/users/123/unsuspend')
 
+    def test_user_bagdes(self, request):
+        prepare_response(request)
+        self.client.user_badges('username')
+        self.assertRequestCalled(request, 'GET', '/user-badges/{}.json'.format('username'))
+
 
 @mock.patch('requests.request')
 class TestTopics(ClientBaseTestCase):
@@ -175,3 +180,13 @@ class MiscellaneousTests(ClientBaseTestCase):
         prepare_response(request)
         self.client.users()
         self.assertRequestCalled(request, 'GET', '/admin/users/list/active.json')
+
+    def test_badges(self, request):
+        prepare_response(request)
+        self.client.badges()
+        self.assertRequestCalled(request, 'GET', '/admin/badges.json')
+
+    def test_grant_badge_to(self, request):
+        prepare_response(request)
+        self.client.grant_badge_to('username', 1)
+        self.assertRequestCalled(request, 'POST', '/user_badges', username='username', badge_id=1)