Compare commits

...

13 Commits

Author SHA1 Message Date
Ben Lopatin 712f9282b1 Version bump 1.1.2 2020-11-10 18:06:02 -05:00
Ben Lopatin b69a142811 Add blame ignore file 2020-11-10 18:03:57 -05:00
Ben Lopatin ce7038b05d Fix version and add history 2020-11-10 18:03:57 -05:00
Ben Lopatin ffbd47868d Merge pull request #47 from dkgv/master
Fix endpoint used for user creation (closes #46)
2020-11-10 17:26:53 -05:00
Gustav 5040b24dcc Fix endpoint used for user creation (closes #46)
See https://review.discourse.org/t/fix-move-hp-request-from-users-to-token-10795/15871
2020-11-10 13:26:48 +01:00
Ben Lopatin e7906a0568 Merge pull request #44 from dkgv/pypi-publishing
Add workflow to publish package to PyPI on tag/release (fixes #43)
2020-10-07 09:25:22 -04:00
Gustav 11a82695c5 Add workflow to publish package to PyPI on tag/release (fixes #43) 2020-10-04 22:16:42 +02:00
Alex Kerney 6e31953118 Fix 413 response from Discourse due to empty dict passed as json 2020-08-11 13:17:52 -04:00
Christian Kindel 2ad158e195 Fix call to get group info by name 2020-08-10 21:13:26 -04:00
Ben Lopatin 719035e9a9 Fix classifier error 2020-07-21 17:22:55 -04:00
Ben Lopatin 3a4af08827 Bump version 1.1.0 2020-07-21 17:21:10 -04:00
Alex Kerney 5d334f1d80 Use immutable arguments and adjust naming to simplify 2020-07-21 17:14:54 -04:00
Alex Kerney 361bf77949 Allow client methods to override requests kwargs
Due to some changes in the Discourse API, certain methods now work better if redirects are allowed.

Get /c/{id}.json will redirect to /c/{category_slug}.json which will cause the client.category_topics(id) method to fail as the redirect is not followed by default.

Now the keyword arguments to requests.request can be overridden by individual methods. This is implemented for .category_topics
2020-07-21 17:14:54 -04:00
8 changed files with 88 additions and 21 deletions
+1
View File
@@ -0,0 +1 @@
c0db7215c95dbd31770ade1fc6ea65aa426d4590
+33
View File
@@ -0,0 +1,33 @@
name: Publish package to PyPI
on:
push:
branches: [master]
release:
types: [created]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install setuptools wheel twine
- name: Build and publish distribution
if: (github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')) || github.event_name == 'release'
env:
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
run: |
python setup.py sdist bdist_wheel
twine upload dist/*
+1
View File
@@ -10,3 +10,4 @@ Jason Dorweiler
Pierre-Alain Dupont
Karl Goetz
Alex Kerney
Gustav <https://github.com/dkgv>
+21
View File
@@ -3,6 +3,27 @@
Release history
===============
1.1.2
-----
- Fix for Discourse users API change
1.1.1
-----
- Fix for empty dictionary and 413 API response
- Fix for getting member groups
1.1.0
-----
- Added ability to follow redirects in requests
1.0.0
-----
- Authenticate with headers
0.9.0
-----
+2 -2
View File
@@ -51,9 +51,9 @@ copyright = u'2014, Marc Sibson'
# built documents.
#
# The short X.Y version.
version = '0.9'
version = '1.1'
# The full version, including alpha/beta/rc tags.
release = '0.9.0'
release = '1.1.1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
+1 -1
View File
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
__version__ = "0.9.0"
__version__ = "1.1.2"
from pydiscourse.client import DiscourseClient
+28 -17
View File
@@ -147,7 +147,7 @@ class DiscourseClient(object):
????
"""
r = self._get("/users/hp.json")
r = self._get("/session/hp.json")
challenge = r["challenge"][::-1] # reverse challenge, discourse security check
confirmations = r["value"]
return self._post(
@@ -489,7 +489,11 @@ class DiscourseClient(object):
JSON API response
"""
return self._get("/c/{0}.json".format(category_id), **kwargs)
return self._get(
"/c/{0}.json".format(category_id),
override_request_kwargs={"allow_redirects": True},
**kwargs
)
def hot_topics(self, **kwargs):
"""
@@ -945,7 +949,7 @@ class DiscourseClient(object):
"""
Get all infos of a group by group name
"""
return self._get("/groups/{0}/members.json".format(group_name))
return self._get("/groups/{0}.json".format(group_name))
def create_group(
self,
@@ -1281,7 +1285,7 @@ class DiscourseClient(object):
kwargs["parent_tag_name"] = parent_tag_name
return self._post("/tag_groups", json=True, **kwargs)["tag_group"]
def _get(self, path, **kwargs):
def _get(self, path, override_request_kwargs=None, **kwargs):
"""
Args:
@@ -1291,9 +1295,9 @@ class DiscourseClient(object):
Returns:
"""
return self._request(GET, path, params=kwargs)
return self._request(GET, path, params=kwargs, override_request_kwargs=override_request_kwargs)
def _put(self, path, json=False, **kwargs):
def _put(self, path, json=False, override_request_kwargs=None, **kwargs):
"""
Args:
@@ -1304,12 +1308,12 @@ class DiscourseClient(object):
"""
if not json:
return self._request(PUT, path, data=kwargs)
return self._request(PUT, path, data=kwargs, override_request_kwargs=override_request_kwargs)
else:
return self._request(PUT, path, json=kwargs)
return self._request(PUT, path, json=kwargs, override_request_kwargs=override_request_kwargs)
def _post(self, path, files={}, json=False, **kwargs):
def _post(self, path, files=None, json=False, override_request_kwargs=None, **kwargs):
"""
Args:
@@ -1320,12 +1324,12 @@ class DiscourseClient(object):
"""
if not json:
return self._request(POST, path, files=files, data=kwargs)
return self._request(POST, path, files=files, data=kwargs, override_request_kwargs=override_request_kwargs)
else:
return self._request(POST, path, files=files, json=kwargs)
return self._request(POST, path, files=files, json=kwargs, override_request_kwargs=override_request_kwargs)
def _delete(self, path, **kwargs):
def _delete(self, path, override_request_kwargs=None, **kwargs):
"""
Args:
@@ -1335,9 +1339,11 @@ class DiscourseClient(object):
Returns:
"""
return self._request(DELETE, path, params=kwargs)
return self._request(DELETE, path, params=kwargs, override_request_kwargs=override_request_kwargs)
def _request(self, verb, path, params={}, files={}, data={}, json={}):
def _request(
self, verb, path, params=None, files=None, data=None, json=None, override_request_kwargs=None
):
"""
Executes HTTP request to API and handles response
@@ -1345,11 +1351,14 @@ class DiscourseClient(object):
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
override_request_kwargs: dictionary of requests.request keyword arguments to override defaults
Returns:
dictionary of response body data or None
"""
override_request_kwargs = override_request_kwargs or {}
url = self.host + path
headers = {
@@ -1364,9 +1373,7 @@ class DiscourseClient(object):
retry_backoff = 1
while retry_count > 0:
response = requests.request(
verb,
url,
request_kwargs = dict(
allow_redirects=False,
params=params,
files=files,
@@ -1376,6 +1383,10 @@ class DiscourseClient(object):
timeout=self.timeout,
)
request_kwargs.update(override_request_kwargs)
response = requests.request(verb, url, **request_kwargs)
log.debug("response %s: %s", response.status_code, repr(response.text))
if response.ok:
break
+1 -1
View File
@@ -34,7 +34,7 @@ setup(
]
},
classifiers=[
"Development Status :: 5 - Production/Stable"
"Development Status :: 5 - Production/Stable",
"Environment :: Web Environment",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",