Skip to content

Commit

Permalink
Add distinguish and undistinguish to SubredditModeration.
Browse files Browse the repository at this point in the history
  • Loading branch information
@bboe
bboe committed Mar 20, 2016
1 parent 4df63e4 commit fd70c11
Show file tree
Hide file tree
Showing 4 changed files with 230 additions and 11 deletions.
21 changes: 10 additions & 11 deletions praw/models/reddit/subreddit.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,19 +148,18 @@ def approve(self, thing):
self.subreddit._reddit.post(API_PATH['approve'],
data={'id': thing.fullname})

def distinguish(self, as_made_by='mod'):
"""Distinguish object as made by mod, admin or special.
def distinguish(self, thing, how='yes'):
"""Distinguish a Comment or Submission.
Distinguished objects have a different author color. With Reddit
Enhancement Suite it is the background color that changes.
:param thing: An instance of Comment or Submission.
:returns: The json response from the server.
:param how: One of 'yes', 'no', 'admin', 'special'. 'yes' adds a
moderator level distinguish. 'no' removes any distinction. 'admin'
and 'special' require special user priviliges to use.
"""
url = self.reddit_session.config['distinguish']
data = {'id': self.fullname,
'how': 'yes' if as_made_by == 'mod' else as_made_by}
return self.reddit_session.request_json(url, data=data)
return self.subreddit._reddit.post(
API_PATH['distinguish'], data={'how': how, 'id': thing.fullname})

def ignore_reports(self):
"""Ignore future reports on this object.
Expand All @@ -185,13 +184,13 @@ def remove(self, thing, spam=False):
data = {'id': thing.fullname, 'spam': bool(spam)}
self.subreddit._reddit.post(API_PATH['remove'], data=data)

def undistinguish(self):
def undistinguish(self, thing):
"""Remove mod, admin or special distinguishing on object.
:returns: The json response from the server.
"""
return self.distinguish(as_made_by='no')
return self.distinguish(thing, how='no')

def unignore_reports(self):
"""Remove ignoring of future reports on this object.
Expand Down
103 changes: 103 additions & 0 deletions tests/integration/cassettes/TestSubredditModeration.test_distinguish.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
{
"http_interactions": [
{
"recorded_at": "2016-03-20T07:13:47",
"request": {
"body": {
"encoding": "utf-8",
"string": "username=<USERNAME>&grant_type=password&password=<PASSWORD>"
},
"headers": {
"Accept": "*/*",
"Accept-Encoding": "identity",
"Authorization": "Basic <BASIC_AUTH>",
"Connection": "keep-alive",
"Content-Length": "57",
"Content-Type": "application/x-www-form-urlencoded",
"User-Agent": "<USER_AGENT> PRAW/4.0.0a1 prawcore/0.0.7"
},
"method": "POST",
"uri": "https://www.reddit.com/api/v1/access_token"
},
"response": {
"body": {
"encoding": "UTF-8",
"string": "{\"access_token\": \"7302867-BywZFMED-Qi5erXPBA_s9aIcY-I\", \"token_type\": \"bearer\", \"expires_in\": 3600, \"scope\": \"*\"}"
},
"headers": {
"CF-RAY": "28675d0871be39c4-PHX",
"Connection": "keep-alive",
"Content-Length": "113",
"Content-Type": "application/json; charset=UTF-8",
"Date": "Sun, 20 Mar 2016 07:13:47 GMT",
"Server": "cloudflare-nginx",
"Set-Cookie": "__cfduid=dabd949ecaa76ac9873b1ab4d655380a21458458026; expires=Mon, 20-Mar-17 07:13:46 GMT; path=/; domain=.reddit.com; HttpOnly",
"Strict-Transport-Security": "max-age=15552000; includeSubDomains; preload",
"X-Moose": "majestic",
"cache-control": "max-age=0, must-revalidate",
"x-content-type-options": "nosniff",
"x-frame-options": "SAMEORIGIN",
"x-xss-protection": "1; mode=block"
},
"status": {
"code": 200,
"message": "OK"
},
"url": "https://www.reddit.com/api/v1/access_token"
}
},
{
"recorded_at": "2016-03-20T07:13:47",
"request": {
"body": {
"encoding": "utf-8",
"string": "how=yes&id=t3_4b536h&api_type=json"
},
"headers": {
"Accept": "*/*",
"Accept-Encoding": "identity",
"Authorization": "bearer 7302867-BywZFMED-Qi5erXPBA_s9aIcY-I",
"Connection": "keep-alive",
"Content-Length": "34",
"Content-Type": "application/x-www-form-urlencoded",
"Cookie": "__cfduid=dabd949ecaa76ac9873b1ab4d655380a21458458026; loidcreated=2016-03-20T07%3A13%3A46.532Z; loid=heCrpzJFFgF2DpBSYf",
"User-Agent": "<USER_AGENT> PRAW/4.0.0a1 prawcore/0.0.7"
},
"method": "POST",
"uri": "https://oauth.reddit.com/api/distinguish/?raw_json=1"
},
"response": {
"body": {
"encoding": "UTF-8",
"string": "{\"json\": {\"errors\": [], \"data\": {\"things\": [{\"kind\": \"t3\", \"data\": {\"domain\": \"self.<TEST_SUBREDDIT>\", \"banned_by\": \"<USERNAME>\", \"media_embed\": {}, \"subreddit\": \"<TEST_SUBREDDIT>\", \"selftext_html\": \"\\u003C!-- SC_OFF --\\u003E\\u003Cdiv class=\\\"md\\\"\\u003E\\u003Cp\\u003ETest text.\\u003C/p\\u003E\\n\\u003C/div\\u003E\\u003C!-- SC_ON --\\u003E\", \"selftext\": \"Test text.\", \"likes\": true, \"suggested_sort\": null, \"user_reports\": [], \"secure_media\": null, \"link_flair_text\": null, \"id\": \"4b536h\", \"from_kind\": null, \"gilded\": 0, \"archived\": false, \"clicked\": false, \"report_reasons\": [], \"author\": \"<USERNAME>\", \"media\": null, \"score\": 1, \"approved_by\": null, \"over_18\": false, \"hidden\": false, \"num_comments\": 0, \"thumbnail\": \"\", \"subreddit_id\": \"t5_2t5o6\", \"hide_score\": false, \"edited\": false, \"link_flair_css_class\": null, \"author_flair_css_class\": null, \"downs\": 0, \"secure_media_embed\": {}, \"saved\": false, \"removal_reason\": null, \"stickied\": false, \"from\": null, \"is_self\": true, \"from_id\": null, \"permalink\": \"/r/<TEST_SUBREDDIT>/comments/4b536h/test_title/\", \"locked\": false, \"name\": \"t3_4b536h\", \"created\": 1458455265.0, \"url\": \"https://www.reddit.com/r/<TEST_SUBREDDIT>/comments/4b536h/test_title/\", \"author_flair_text\": \"foobar\", \"quarantine\": false, \"title\": \"Test Title\", \"created_utc\": 1458426465.0, \"distinguished\": \"moderator\", \"mod_reports\": [], \"visited\": false, \"num_reports\": 0, \"ups\": 1}}]}}}"
},
"headers": {
"CF-RAY": "28675d0e927d39a6-PHX",
"Connection": "keep-alive",
"Content-Type": "application/json; charset=UTF-8",
"Date": "Sun, 20 Mar 2016 07:13:47 GMT",
"Server": "cloudflare-nginx",
"Strict-Transport-Security": "max-age=15552000; includeSubDomains; preload",
"Transfer-Encoding": "chunked",
"Vary": "accept-encoding",
"X-Moose": "majestic",
"cache-control": "private, s-maxage=0, max-age=0, must-revalidate",
"expires": "-1",
"x-content-type-options": "nosniff",
"x-frame-options": "SAMEORIGIN",
"x-ratelimit-remaining": "598.0",
"x-ratelimit-reset": "373",
"x-ratelimit-used": "2",
"x-ua-compatible": "IE=edge",
"x-xss-protection": "1; mode=block"
},
"status": {
"code": 200,
"message": "OK"
},
"url": "https://oauth.reddit.com/api/distinguish/?raw_json=1"
}
}
],
"recorded_with": "betamax/0.5.1"
}
103 changes: 103 additions & 0 deletions tests/integration/cassettes/TestSubredditModeration.test_undistinguish.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
{
"http_interactions": [
{
"recorded_at": "2016-03-20T07:14:40",
"request": {
"body": {
"encoding": "utf-8",
"string": "username=<USERNAME>&grant_type=password&password=<PASSWORD>"
},
"headers": {
"Accept": "*/*",
"Accept-Encoding": "identity",
"Authorization": "Basic <BASIC_AUTH>",
"Connection": "keep-alive",
"Content-Length": "57",
"Content-Type": "application/x-www-form-urlencoded",
"User-Agent": "<USER_AGENT> PRAW/4.0.0a1 prawcore/0.0.7"
},
"method": "POST",
"uri": "https://www.reddit.com/api/v1/access_token"
},
"response": {
"body": {
"encoding": "UTF-8",
"string": "{\"access_token\": \"7302867-dhPWJ1JA3aNdtQQdF-O70Kc8I2Y\", \"token_type\": \"bearer\", \"expires_in\": 3600, \"scope\": \"*\"}"
},
"headers": {
"CF-RAY": "28675e58c53539b8-PHX",
"Connection": "keep-alive",
"Content-Length": "113",
"Content-Type": "application/json; charset=UTF-8",
"Date": "Sun, 20 Mar 2016 07:14:40 GMT",
"Server": "cloudflare-nginx",
"Set-Cookie": "__cfduid=d24dd6c942c2667ebefd11dd4e2c2e0be1458458080; expires=Mon, 20-Mar-17 07:14:40 GMT; path=/; domain=.reddit.com; HttpOnly",
"Strict-Transport-Security": "max-age=15552000; includeSubDomains; preload",
"X-Moose": "majestic",
"cache-control": "max-age=0, must-revalidate",
"x-content-type-options": "nosniff",
"x-frame-options": "SAMEORIGIN",
"x-xss-protection": "1; mode=block"
},
"status": {
"code": 200,
"message": "OK"
},
"url": "https://www.reddit.com/api/v1/access_token"
}
},
{
"recorded_at": "2016-03-20T07:14:40",
"request": {
"body": {
"encoding": "utf-8",
"string": "api_type=json&how=no&id=t3_4b536h"
},
"headers": {
"Accept": "*/*",
"Accept-Encoding": "identity",
"Authorization": "bearer 7302867-dhPWJ1JA3aNdtQQdF-O70Kc8I2Y",
"Connection": "keep-alive",
"Content-Length": "33",
"Content-Type": "application/x-www-form-urlencoded",
"Cookie": "loidcreated=2016-03-20T07%3A14%3A40.166Z; __cfduid=d24dd6c942c2667ebefd11dd4e2c2e0be1458458080; loid=jud1lCvJQHp5rJwu3W",
"User-Agent": "<USER_AGENT> PRAW/4.0.0a1 prawcore/0.0.7"
},
"method": "POST",
"uri": "https://oauth.reddit.com/api/distinguish/?raw_json=1"
},
"response": {
"body": {
"encoding": "UTF-8",
"string": "{\"json\": {\"errors\": [], \"data\": {\"things\": [{\"kind\": \"t3\", \"data\": {\"domain\": \"self.<TEST_SUBREDDIT>\", \"banned_by\": \"<USERNAME>\", \"media_embed\": {}, \"subreddit\": \"<TEST_SUBREDDIT>\", \"selftext_html\": \"\\u003C!-- SC_OFF --\\u003E\\u003Cdiv class=\\\"md\\\"\\u003E\\u003Cp\\u003ETest text.\\u003C/p\\u003E\\n\\u003C/div\\u003E\\u003C!-- SC_ON --\\u003E\", \"selftext\": \"Test text.\", \"likes\": true, \"suggested_sort\": null, \"user_reports\": [], \"secure_media\": null, \"link_flair_text\": null, \"id\": \"4b536h\", \"from_kind\": null, \"gilded\": 0, \"archived\": false, \"clicked\": false, \"report_reasons\": [], \"author\": \"<USERNAME>\", \"media\": null, \"score\": 1, \"approved_by\": null, \"over_18\": false, \"hidden\": false, \"num_comments\": 0, \"thumbnail\": \"\", \"subreddit_id\": \"t5_2t5o6\", \"hide_score\": false, \"edited\": false, \"link_flair_css_class\": null, \"author_flair_css_class\": null, \"downs\": 0, \"secure_media_embed\": {}, \"saved\": false, \"removal_reason\": null, \"stickied\": false, \"from\": null, \"is_self\": true, \"from_id\": null, \"permalink\": \"/r/<TEST_SUBREDDIT>/comments/4b536h/test_title/\", \"locked\": false, \"name\": \"t3_4b536h\", \"created\": 1458455265.0, \"url\": \"https://www.reddit.com/r/<TEST_SUBREDDIT>/comments/4b536h/test_title/\", \"author_flair_text\": \"foobar\", \"quarantine\": false, \"title\": \"Test Title\", \"created_utc\": 1458426465.0, \"distinguished\": null, \"mod_reports\": [], \"visited\": false, \"num_reports\": 0, \"ups\": 1}}]}}}"
},
"headers": {
"CF-RAY": "28675e5cf3393988-PHX",
"Connection": "keep-alive",
"Content-Type": "application/json; charset=UTF-8",
"Date": "Sun, 20 Mar 2016 07:14:40 GMT",
"Server": "cloudflare-nginx",
"Strict-Transport-Security": "max-age=15552000; includeSubDomains; preload",
"Transfer-Encoding": "chunked",
"Vary": "accept-encoding",
"X-Moose": "majestic",
"cache-control": "private, s-maxage=0, max-age=0, must-revalidate",
"expires": "-1",
"x-content-type-options": "nosniff",
"x-frame-options": "SAMEORIGIN",
"x-ratelimit-remaining": "597.0",
"x-ratelimit-reset": "320",
"x-ratelimit-used": "3",
"x-ua-compatible": "IE=edge",
"x-xss-protection": "1; mode=block"
},
"status": {
"code": 200,
"message": "OK"
},
"url": "https://oauth.reddit.com/api/distinguish/?raw_json=1"
}
}
],
"recorded_with": "betamax/0.5.1"
}
14 changes: 14 additions & 0 deletions tests/integration/models/reddit/test_subreddit.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,13 +88,27 @@ def test_approve(self):
submission = self.reddit.submission('4b536h')
self.subreddit.mod.approve(submission)

def test_distinguish(self):
self.reddit.read_only = False
with self.recorder.use_cassette(
'TestSubredditModeration.test_distinguish'):
submission = self.reddit.submission('4b536h')
self.subreddit.mod.distinguish(submission)

def test_remove(self):
self.reddit.read_only = False
with self.recorder.use_cassette(
'TestSubredditModeration.test_remove'):
submission = self.reddit.submission('4b536h')
self.subreddit.mod.remove(submission, spam=True)

def test_undistinguish(self):
self.reddit.read_only = False
with self.recorder.use_cassette(
'TestSubredditModeration.test_undistinguish'):
submission = self.reddit.submission('4b536h')
self.subreddit.mod.undistinguish(submission)


class TestSubredditRelationships(IntegrationTest):
REDDITOR = 'pyapitestuser3'
Expand Down

0 comments on commit fd70c11

Please sign in to comment.