Implement rest of page namespace

Author: rossjrw

scuttle/versions/base.py

@@ -9,11 +9,15 @@ def __init__(self, domain, api_key):
             domain, type(self).version)
         self.api_key = api_key
 
-    def request(self, namespace, value=None):
-        response = requests.get(
+    def _request(self, namespace, value=None, data=None):
+        method = 'get' if data is None else 'post'
+        send = {'headers': {"Authorization": "Bearer {}".format(self.api_key)}}
+        if data is not None:
+            send['data'] = data
+        response = getattr(requests, method)(
             "{}/{}".format(
                 self.endpoint,
                 namespace.format(value)),
-            headers={"Authorization": "Bearer {}".format(self.api_key)})
+            **send)
         print(response.text)
         return response.json()

scuttle/versions/v1.py

@@ -9,25 +9,38 @@ class Api(BaseApi):
     version = 1
 
     def wikis(self):
-        return self.request("wikis")
+        return self._request("wikis")
 
     def wiki(self):
-        return self.request("wiki")
+        return self._request("wiki")
 
     def all_pages(self):
-        return self.request("page")
+        return self._request("page")
 
     def page_by_id(self, page_id):
-        return self.request("page/{}", page_id)
+        return self._request("page/{}", page_id)
 
     def page_by_slug(self, page_slug):
-        return self.request("page/slug/{}", page_slug)
+        return self._request("page/slug/{}", page_slug)
 
-    def page_revisions(self, page_id):
-        return self.request("page/{}/revisions", page_id)
+    def all_page_revisions(self, page_id):
+        return self._request("page/{}/revisions", page_id)
+
+    def page_revisions(self, page_id, *, limit=20, offset=0, direction="asc"):
+        data = {'limit': limit, 'offset': offset, 'direction': direction}
+        return self._request("page/{}/revisions", page_id, data)
+
+    def page_votes(self, page_id):
+        return self._request("page/{}/votes", page_id)
+
+    def page_tags(self, page_id):
+        return self._request("page/{}/tags", page_id)
+
+    def page_files(self, page_id):
+        return self._request("page/{}/files", page_id)
 
     def get_revision(self, revision_id):
-        return self.request("revision/{}", revision_id)
+        return self._request("revision/{}", revision_id)
 
     def get_full_revision(self, revision_id):
-        return self.request("revision/{}/full", revision_id)
+        return self._request("revision/{}/full", revision_id)

test/test_api.py

@@ -1,7 +1,10 @@
 #!/usr/bin/env python3
 
 import os
+import dateutil.parser as dp
+
 import pytest
+
 import scuttle
 
 API_KEY = os.environ['SCUTTLE_API_KEY']
@@ -33,13 +36,25 @@ def test_page():
     assert set(pages[0].keys()) == {'id', 'slug', 'wd_page_id'}
     page_id = pages[0]['id']
     assert wiki.page_by_id(page_id)['id'] == page_id
-    assert wiki.page_by_slug("scp-1111")['metadata']['wikidot_metadata']['fullname'] == "scp-1111"
+    assert wiki.page_by_slug("scp-001")['metadata']['wikidot_metadata']['fullname'] == "scp-001"
+    if len(votes := wiki.page_votes(page_id)) > 0:
+        assert isinstance(votes[0]['vote'], int)
+    if len(tags := wiki.page_tags(page_id)) > 0:
+        assert isinstance(tags[0]['name'], str)
+    if len(files := wiki.page_files(page_id)) > 0:
+        assert isinstance(files[0]['path'], str)
+
 
 def test_revisions():
     wiki = scuttle.scuttle('en', API_KEY, 1)
     page_id = wiki.all_pages()[0]['id']
-    revision_id = wiki.page_revisions(page_id)[0]['id']
+    revision_id = wiki.all_page_revisions(page_id)[0]['id']
     assert wiki.get_revision(revision_id)['page_id'] == page_id
     full_revision = wiki.get_full_revision(revision_id)
     assert full_revision['page_id'] == page_id
     assert 'content' in full_revision
+    first_rev = wiki.page_revisions(page_id, limit=1, direction="asc")
+    assert len(first_rev) == 1
+    final_rev = wiki.page_revisions(page_id, limit=1, direction="desc")
+    assert dp.parse(first_rev[0]['created_at']) <= dp.parse(final_rev[0]['created_at'])
+