Merge pull request #16 from kmaehashi/update-tag-list-apis

Update URI API

Author: kmaehashi

atwiki/test/test_uri.py

@@ -30,13 +30,15 @@ def test_path_output(self):
     self.assertEqual(uri.search('test', is_and=False), '{0}/?cmd=search&keyword=test&andor=or&search_field=&cmp=cmp'.format(base))
     self.assertEqual(uri.search('test', wiki_syntax=True), '{0}/?cmd=search&keyword=test&andor=and&search_field=source&cmp=cmp'.format(base))
     self.assertEqual(uri.search('test', complete=False), '{0}/?cmd=search&keyword=test&andor=and&search_field=&cmp='.format(base))
-    self.assertEqual(uri.tag(), '{0}/tag/?p=0'.format(base))
-    self.assertEqual(uri.tag('test'), '{0}/tag/test?p=0'.format(base))
-    self.assertEqual(uri.tag('test', 1), '{0}/tag/test?p=1'.format(base))
+    self.assertEqual(uri.tags(), '{0}/tag/?sort=&p=1'.format(base))
+    self.assertEqual(uri.tags('num', 2), '{0}/tag/?sort=num&p=2'.format(base))
+    self.assertEqual(uri.tag(), '{0}/tag/?p=1'.format(base))  # deprecated
+    self.assertEqual(uri.tag('test'), '{0}/tag/test?p=1'.format(base))
+    self.assertEqual(uri.tag('test', 2), '{0}/tag/test?p=2'.format(base))
     self.assertEqual(uri.new(), '{0}/new'.format(base))
-    self.assertEqual(uri.list(), '{0}/list?sort=update&pp=0'.format(base))
-    self.assertEqual(uri.list('create'), '{0}/list?sort=create&pp=0'.format(base))
-    self.assertEqual(uri.list('create', 1), '{0}/list?sort=create&pp=1'.format(base))
+    self.assertEqual(uri.list(), '{0}/list?sort=update&pp=1'.format(base))
+    self.assertEqual(uri.list('create'), '{0}/list?sort=create&pp=1'.format(base))
+    self.assertEqual(uri.list('create', 2), '{0}/list?sort=create&pp=2'.format(base))
     self.assertEqual(uri.contact(), '{0}/contact'.format(base))
 
     self.assertEqual(uri.backup_list(), '{0}/?cmd=backup&action=list'.format(base))

atwiki/uri.py

@@ -62,13 +62,21 @@ def search(self, keyword=None, is_and=True, wiki_syntax=False, complete=True):
     else:
       return '{0}/search'.format(self._base)
 
-  def tag(self, tag_name='', index=0):
+  def tags(self, sort='', index=1):
+    return '{}/tag/?sort={}&p={}'.format(self._base, sort, index)
+
+  def tag(self, tag_name='', index=1):
+    if tag_name == '':
+      warnings.warn(
+        'Specifying empty string to tag_name to get URL for list of tags is deprecated.'
+        ' Use .tags() instead.',
+        DeprecationWarning)
     return '{0}/tag/{1}?p={2}'.format(self._base, urlquote(tag_name), index)
 
   def new(self):
     return '{0}/new'.format(self._base)
 
-  def list(self, sort='update', index=0):
+  def list(self, sort='update', index=1):
     """
     ``sort`` can be any of ``update``, ``create``, ``create_desc`` or ``pagename``.
     """