Added ability to report a submission, and get the reported submissions of a subreddit (must be a mod)

Alignment issue

Author: Tailszefox

reddit/__init__.py

@@ -60,6 +60,8 @@ class Config(object):  # pylint: disable-msg=R0903
                  'read_message':        'api/read_message/',
                  'reddit_url':          '/',
                  'register':            'api/register/',
+                 'report':              'api/report/',
+                 'reports':             'r/%s/about/reports/',
                  'save':                'api/save/',
                  'saved':               'saved/',
                  'search_reddit_names': 'api/search_reddit_names/',
@@ -281,6 +283,12 @@ def get_contributors(self, subreddit):
     def get_moderators(self, subreddit):
         """Get the list of moderators for a subreddit."""
         return self.request_json(self.config['moderators'] % str(subreddit))
+        
+    @reddit.decorators.require_login
+    def get_reports(self, subreddit, limit=None):
+        """Get the list of reported submissions for a subreddit."""
+        return self.get_content(self.config['reports'] % str(subreddit),
+                                limit=limit, url_data={'uh':self.user.modhash})
 
     @reddit.decorators.require_login
     def flair_list(self, subreddit, limit=None):

reddit/objects.py

@@ -86,6 +86,21 @@ def content_id(self):
         return '%s_%s' % (by_object[self.__class__], self.id)
 
 
+class Reportable(RedditContentObject):
+    """
+    Additional interface for Reddit content objects that can be reported.
+    """
+    @require_login
+    def report(self):
+        url = self.reddit_session.config['report']
+        params = {'id': self.content_id,
+                  'uh': self.reddit_session.modhash,
+                  'api_type': 'json'}
+        response = self.reddit_session.request_json(url, params)
+        # pylint: disable-msg=E1101
+        _request.is_stale([self.reddit_session.config['user']])
+        return response
+
 class Saveable(RedditContentObject):
     """
     Additional interface for Reddit content objects that can be saved.
@@ -315,7 +330,7 @@ def get_unread(self, limit=0):
         return self.reddit_session.get_content(url, limit=limit)
 
 
-class Submission(Deletable, Saveable, Voteable):
+class Submission(Deletable, Reportable, Saveable, Voteable):
     """A class for submissions to Reddit."""
     def __init__(self, reddit_session, json_dict):
         super(Submission, self).__init__(reddit_session, json_dict)
@@ -449,6 +464,11 @@ def subscribe(self):
     def unsubscribe(self):
         """Unsubscribe from the given subreddit."""
         return self._subscribe(unsubscribe=True)
+        
+    @require_login
+    def get_reports(self, *args, **kwargs):
+        """Get the reported submissions on the given subreddit."""
+        return self.reddit_session.get_reports(self, *args, **kwargs)
 
 
 class UserList(RedditContentObject):

reddit/reddit_test.py

@@ -443,7 +443,24 @@ def test_upvote(self):
         # reload the submission
         submission = self.r.get_submission(submission_id=submission.id)
         self.assertEqual(submission.likes, True)
-
+        
+    def test_report(self):
+        # login as new user to report submission
+        oth = Reddit('reddit_api test suite')
+        oth.login('PyApiTestUser3', '1111')
+        submission = None
+        for submission in oth.get_redditor(self.r.user.name).get_submitted():
+            if submission.hidden is False:
+                break
+        if not submission or submission.hidden is True:
+            self.fail('Could not find a non-reported submission.')
+        submission.report()
+        # check if submission was reported
+        for report in self.r.get_subreddit(self.sr).get_reports():
+            if report.id == submission.id:
+               break
+        else:
+            self.fail('Could not find reported submission.')
 
 class SubmissionCreateTest(unittest.TestCase, AuthenticatedHelper):
     def setUp(self):