Add missing http.Forbidden error (djc#305)

adrienverge · djc · commit 61b440947df8 · 2016-09-20T21:38:30.000+02:00
"401 Unauthorized" and "403 Forbidden" are two different HTTP errors. CouchDB uses the first one when the server requires authentication credentials, and the second one when the request requires an authorisation that the current user does not have. For instance, using a `validate_doc_update` design document can result in "403 Forbidden" being returned. See the official documentation [1] for more details and examples: // user is not authorized to make the change but may re-authenticate throw({ unauthorized: 'Error message here.' }); // change is not allowed throw({ forbidden: 'Error message here.' }); This patch adds Forbidden to the list of HTTP errors raised by couchdb-python. [1]: http://docs.couchdb.org/en/stable/couchapp/ddocs.html#validate-document-update-functions
diff --git a/couchdb/__init__.py b/couchdb/__init__.py
@@ -8,7 +8,8 @@
 
 from .client import Database, Document, Server
 from .http import HTTPError, PreconditionFailed, Resource, \
-        ResourceConflict, ResourceNotFound, ServerError, Session, Unauthorized
+        ResourceConflict, ResourceNotFound, ServerError, Session, \
+        Unauthorized, Forbidden
 
 try:
     __version__ = __import__('pkg_resources').get_distribution('CouchDB').version
diff --git a/couchdb/http.py b/couchdb/http.py
@@ -38,8 +38,8 @@
 from couchdb import util
 
 __all__ = ['HTTPError', 'PreconditionFailed', 'ResourceNotFound',
-           'ResourceConflict', 'ServerError', 'Unauthorized', 'RedirectLimit',
-           'Session', 'Resource']
+           'ResourceConflict', 'ServerError', 'Unauthorized', 'Forbidden',
+           'RedirectLimit', 'Session', 'Resource']
 __docformat__ = 'restructuredtext en'
 
 
@@ -114,6 +114,12 @@ class Unauthorized(HTTPError):
     """
 
 
+class Forbidden(HTTPError):
+    """Exception raised when the request requires an authorisation that the
+    current user does not have.
+    """
+
+
 class RedirectLimit(Exception):
     """Exception raised when a request is redirected more often than allowed
     by the maximum number of redirections.
@@ -411,6 +417,8 @@ def _try_request():
                 error = ''
             if status == 401:
                 raise Unauthorized(error)
+            elif status == 403:
+                raise Forbidden(error)
             elif status == 404:
                 raise ResourceNotFound(error)
             elif status == 409:
diff --git a/couchdb/tests/package.py b/couchdb/tests/package.py
@@ -11,7 +11,7 @@ def test_exports(self):
             'Server', 'Database', 'Document',
             # couchdb.http
             'HTTPError', 'PreconditionFailed', 'ResourceNotFound',
-            'ResourceConflict', 'ServerError', 'Unauthorized',
+            'ResourceConflict', 'ServerError', 'Unauthorized', 'Forbidden',
             'Resource', 'Session'
         ])
         exported = set(e for e in dir(couchdb) if not e.startswith('_'))
