exceptional-auth 0.3.1__py2-none-any.whl

exceptional_auth/README.md

@@ -0,0 +1,7 @@
+# exceptional_auth
+
+The purpose of this package is to provide a more flexible/powerful replacement for Django's `login_required` and `permission_required` decorators (and provide some entirely new related functionality).
+
+The idea is to create a standard set of exceptions which any code can raise (even reusable apps distributed on pypi), and leave the handling of these exceptions up to the site developer (via custom middleware). This makes the many per-view decisions easy (ie. just raise PermissionDenied), while letting you centralize/delay the decision of what to do in those situations. Since you have access to the request object in the middleware methods, you can easily tailor the handling of these exceptions base on section of site, request type, etc.
+
+We provide `exceptional_auth.BaseMiddleware`, a Middleware base class which makes it easier to handle our exceptions. Site developers should write a custom middleware extending this class, and add to `MIDDLEWARE` setting. You can also use `exceptional_auth.BaseMiddleware` to start with, and then extend it later.

exceptional_auth/RELEASE_NOTES.md

@@ -0,0 +1,12 @@
+### 0.3.1
+Fix 0.3.0
+
+## 0.3.0
+BROKEN
+Add `Conflict`, make strings translatable, fix `NotCurrentlyAllowed` content-type
+
+## 0.2.0
+Made BaseMiddleware usable directly.
+
+## 0.1.0
+Added ability to pass message to PermissionDenied

exceptional_auth/VERSION

@@ -0,0 +1 @@
+0.3.1

exceptional_auth/__init__.py

@@ -0,0 +1,125 @@
+from django import http
+from django.utils.translation import gettext as _
+
+class AuthException(Exception):
+    '''
+        Base class for all of our exceptions. 
+
+        Has no particular meaning, other than "the current user cannot currently access this resource".
+    '''
+    pass
+
+class LoginRequired(AuthException):
+    '''
+    The user is not logged in, and must log in to access this resource.
+
+    App developers are not expected to instantiate this directly. Call require_login() instead.
+
+    Site developers should catch this and provide the user with the opportunity to log in.
+    '''
+    pass
+
+class PermissionDenied(AuthException):
+    '''
+    Indicates that the user is logged in, but lacks some necessary permission.
+
+    App developers should call require_permission() when checking for standard django permissions, but they may also raise this directly when performing other custom permission checks.
+    '''
+    def __init__(self, message=None):
+        self.message = message
+
+class NotCurrentlyAllowed(AuthException):
+    '''
+    DEPRECATED. We recommend using Conflict, instead.
+
+    Indicates that the user has all necessary permissions, but that the request cannot be handled because of some other time-based/logic constraints.
+
+    Site developers should catch this and display a generic error message to the user.
+    '''
+    def __init__(self, reason):
+        self.reason = reason
+
+class Conflict(AuthException):
+    '''
+    The operation couldn't proceed because of some type of conflicting state
+    (registration window hasn't opened yet, you must delete related objects first, etc.). 
+
+    Note that this could be thrown from anywhere (even model code).
+    Expect the message to be presented directly to the end user.
+    '''
+    def __init__(self, message, code=None):
+        '''
+        message should fully decribe why action can't proceed,
+        and, ideally, what user can do to fix it. 
+        Expect message to be shown directly to the end user.
+        It may be a translatable string.
+
+        code may be set, and can be used by higher levels of code 
+        (ie. view code) to differentiate between types of Conflicts and
+        render more specific error message, if desired.
+        '''
+        self.message = message
+        self.code = code
+    def __str__(self):
+        return str(self.message)
+
+def require_login(request):
+    if request.user.is_anonymous :
+        raise LoginRequired()
+
+def require_permissions(request, *permission_names):
+    require_login(request)
+    user = request.user
+    for permission_name in permission_names :
+        # TODO - if DEBUG, should we validate that permission_name is actually a valid permission name?
+        if not user.has_perm(permission_name) :
+            raise PermissionDenied()
+
+class BaseMiddleware:
+    '''
+        A Middleware base class which site developers can extend, to make handling our exceptions easier.
+    '''
+
+    # Boilerplate, required by all middleware
+    def __init__(self, get_response):
+        self.get_response = get_response
+    def __call__(self, request):
+        return self.get_response(request)
+
+    def process_exception(self, request, exception):
+        if isinstance(exception, LoginRequired) :
+            return self.login_required(request, exception)
+        if isinstance(exception, PermissionDenied) :
+            return self.permission_denied(request, exception)
+        if isinstance(exception, NotCurrentlyAllowed) :
+            return self.not_currently_allowed(request, exception)
+        if isinstance(exception, Conflict) :
+            return self.conflict(request, exception)
+
+    # Site developers should override these methods
+    def login_required(self, request, exception):
+        return http.HttpResponse(_('Login required.'), content_type='text/plain')
+    def permission_denied(self, request, exception):
+        return http.HttpResponse(_('Permission denied.'), content_type='text/plain', status=403)
+    def not_currently_allowed(self, request, exception):
+        return http.HttpResponse(f'{_("Not currently allowed")}: {exception.reason}', content_type='text/plain', status=403)
+
+    def conflict(self, request, exception):
+        '''
+        This implementation likely doesn't need to be overridden.
+        Conflicts may be caught by view code to provide specific error messaging.
+        This implementation is probably good enough as a general fallback.
+
+        Note - if using jsform, this response works well if you add the 
+        following to your base javascript:
+
+            addEventListener('jsformerror', function(e) {
+                var r = e.detail;
+                if (r.status == 409 && r.responseText) {
+                    alert(r.responseText);
+                    e.preventDefault();
+                    e.target.removeAttribute('block-submissions');
+                }
+            });
+        '''
+        return http.HttpResponse(exception.message, content_type='text/plain', status=409)

exceptional_auth-0.3.1.dist-info/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2020 Quadrant Newmedia Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

exceptional_auth-0.3.1.dist-info/METADATA

@@ -0,0 +1,24 @@
+Metadata-Version: 2.1
+Name: exceptional-auth
+Version: 0.3.1
+Summary: Exception-based authentication helpers for django
+Home-page: https://github.com/quadrant-newmedia/exceptional_auth
+Author: Alex Fischer
+Author-email: alex@quadrant.net
+License: UNKNOWN
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: Django (<5,>=2.2)
+
+# exceptional_auth
+
+The purpose of this package is to provide a more flexible/powerful replacement for Django's `login_required` and `permission_required` decorators (and provide some entirely new related functionality).
+
+The idea is to create a standard set of exceptions which any code can raise (even reusable apps distributed on pypi), and leave the handling of these exceptions up to the site developer (via custom middleware). This makes the many per-view decisions easy (ie. just raise PermissionDenied), while letting you centralize/delay the decision of what to do in those situations. Since you have access to the request object in the middleware methods, you can easily tailor the handling of these exceptions base on section of site, request type, etc.
+
+We provide `exceptional_auth.BaseMiddleware`, a Middleware base class which makes it easier to handle our exceptions. Site developers should write a custom middleware extending this class, and add to `MIDDLEWARE` setting. You can also use `exceptional_auth.BaseMiddleware` to start with, and then extend it later.
+

exceptional_auth-0.3.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+exceptional_auth/README.md,sha256=d0y73M6HEIgzo-5LPXW2iJI66yl2wTIcrMZVyRZF3AU,1079
+exceptional_auth/RELEASE_NOTES.md,sha256=cF68viNJ-U0RwnW2TC2iKvBUEltAb51pVnrQHn_uPSg,225
+exceptional_auth/VERSION,sha256=9PyVbsYbGHzRh5DAsKb6XR06MN5KVJPjJ3RgSF7RiPI,5
+exceptional_auth/__init__.py,sha256=bhieHDlK8uzmP35v9qFglnlegmmSU6yEBBeX3mmk5Is,4981
+exceptional_auth/__pycache__/__init__.cpython-36.pyc,sha256=hehRHpJSEuP2wa4_qDSllXccNhQPE5Tiu6rkXQelWqA,3927
+exceptional_auth-0.3.1.dist-info/LICENSE,sha256=3zadg6RilfqcoXgQ6j6BXFbJBGZbjlpiAxtVboyrBQk,1072
+exceptional_auth-0.3.1.dist-info/METADATA,sha256=E-0-DJt2cfebY0hzZER-hwpWmrj2b2FGevcZpKCLVrs,1596
+exceptional_auth-0.3.1.dist-info/WHEEL,sha256=1VPi6hfNQaRRNuEdK_3dv9o8COtLGnHWJghhj4CQ28k,92
+exceptional_auth-0.3.1.dist-info/top_level.txt,sha256=7X4XuoTCS3lzq_v2FzKA0Prp3PdwRiRFEVkaiNmJnZ8,17
+exceptional_auth-0.3.1.dist-info/RECORD,,

exceptional_auth-0.3.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.37.1)
+Root-Is-Purelib: true
+Tag: py2-none-any
+

exceptional_auth-0.3.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+exceptional_auth