Merge branch 'restframework2' of https://github.com/tomchristie/django-rest-framework into restframework2

djangorestframework/authentication.py

@@ -6,14 +6,9 @@ Authentication behavior is provided by mixing the :class:`mixins.RequestMixin` c
 
 from django.contrib.auth import authenticate
 from djangorestframework.compat import CsrfViewMiddleware
+from djangorestframework.authtoken.models import Token
 import base64
 
-__all__ = (
-    'BaseAuthentication',
-    'BasicAuthentication',
-    'SessionAuthentication'
-)
-
 
 class BaseAuthentication(object):
     """
@@ -105,36 +100,33 @@ class SessionAuthentication(BaseAuthentication):
 
 class TokenAuthentication(BaseAuthentication):
     """
-    Use a token model for authentication.
+    Simple token based authentication.
 
-    A custom token model may be used here, but must have the following minimum
+    Clients should authenticate by passing the token key in the "Authorization"
-    properties:
+    HTTP header, prepended with the string "Token ".  For example:
+
+        Authorization: Token 401f7ac837da42b97f613d789819ff93537bee6a
+    """
+
+    model = Token
+    """
+    A custom token model may be used, but must have the following properties.
 
     * key -- The string identifying the token
     * user -- The user to which the token belongs
-    * revoked -- The status of the token
-
-    The token key should be passed in as a string to the "Authorization" HTTP
-    header.  For example:
-
-        Authorization: 0123456789abcdef0123456789abcdef
-
     """
-    model = None
 
     def authenticate(self, request):
-        key = request.META.get('HTTP_AUTHORIZATION', '').strip()
+        auth = request.META.get('HTTP_AUTHORIZATION', '').split()
 
-        if self.model is None:
+        if len(auth) == 2 and auth[0].lower() == "token":
-            from djangorestframework.tokenauth.models import BasicToken
+            key = auth[1]
-            self.model = BasicToken
+            try:
+                token = self.model.objects.get(key=key)
+            except self.model.DoesNotExist:
+                return None
 
-        try:
+            if token.user.is_active and not getattr(token, 'revoked', False):
-             token = self.model.objects.get(key=key)
+                return (token.user, token)
-        except self.model.DoesNotExist:
-             return None
 
-        if token.user.is_active and not token.revoked:
+# TODO: OAuthAuthentication
-            return (token.user, token)
-
-# TODO: DigestAuthentication, OAuthAuthentication

djangorestframework/authtoken/migrations/0001_initial.py

@@ -0,0 +1,72 @@
+# -*- coding: utf-8 -*-
+import datetime
+from south.db import db
+from south.v2 import SchemaMigration
+from django.db import models
+
+
+class Migration(SchemaMigration):
+
+    def forwards(self, orm):
+        # Adding model 'Token'
+        db.create_table('authtoken_token', (
+            ('key', self.gf('django.db.models.fields.CharField')(max_length=40, primary_key=True)),
+            ('user', self.gf('django.db.models.fields.related.ForeignKey')(to=orm['auth.User'])),
+            ('revoked', self.gf('django.db.models.fields.BooleanField')(default=False)),
+            ('created', self.gf('django.db.models.fields.DateTimeField')(auto_now_add=True, blank=True)),
+        ))
+        db.send_create_signal('authtoken', ['Token'])
+
+
+    def backwards(self, orm):
+        # Deleting model 'Token'
+        db.delete_table('authtoken_token')
+
+
+    models = {
+        'auth.group': {
+            'Meta': {'object_name': 'Group'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '80'}),
+            'permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'})
+        },
+        'auth.permission': {
+            'Meta': {'ordering': "('content_type__app_label', 'content_type__model', 'codename')", 'unique_together': "(('content_type', 'codename'),)", 'object_name': 'Permission'},
+            'codename': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'content_type': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['contenttypes.ContentType']"}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '50'})
+        },
+        'auth.user': {
+            'Meta': {'object_name': 'User'},
+            'date_joined': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'email': ('django.db.models.fields.EmailField', [], {'max_length': '75', 'blank': 'True'}),
+            'first_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
+            'groups': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Group']", 'symmetrical': 'False', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'is_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'is_staff': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'is_superuser': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'last_login': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'last_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
+            'password': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
+            'user_permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'}),
+            'username': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '30'})
+        },
+        'authtoken.token': {
+            'Meta': {'object_name': 'Token'},
+            'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
+            'key': ('django.db.models.fields.CharField', [], {'max_length': '40', 'primary_key': 'True'}),
+            'revoked': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'user': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['auth.User']"})
+        },
+        'contenttypes.contenttype': {
+            'Meta': {'ordering': "('name',)", 'unique_together': "(('app_label', 'model'),)", 'object_name': 'ContentType', 'db_table': "'django_content_type'"},
+            'app_label': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'model': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '100'})
+        }
+    }
+
+    complete_apps = ['authtoken']

djangorestframework/authtoken/models.py

@@ -0,0 +1,23 @@
+import uuid
+import hmac
+from hashlib import sha1
+from django.db import models
+
+
+class Token(models.Model):
+    """
+    The default authorization token model.
+    """
+    key = models.CharField(max_length=40, primary_key=True)
+    user = models.ForeignKey('auth.User')
+    revoked = models.BooleanField(default=False)
+    created = models.DateTimeField(auto_now_add=True)
+
+    def save(self, *args, **kwargs):
+        if not self.key:
+            self.key = self.generate_key()
+        return super(Token, self).save(*args, **kwargs)
+
+    def generate_key(self):
+        unique = str(uuid.uuid4())
+        return hmac.new(unique, digestmod=sha1).hexdigest()

djangorestframework/runtests/settings.py

@@ -90,7 +90,7 @@ INSTALLED_APPS = (
     # Uncomment the next line to enable admin documentation:
     # 'django.contrib.admindocs',
     'djangorestframework',
-    'djangorestframework.tokenauth',
+    'djangorestframework.authtoken',
 )
 
 STATIC_URL = '/static/'

djangorestframework/tests/authentication.py

@@ -8,7 +8,7 @@ from django.http import HttpResponse
 from djangorestframework.views import APIView
 from djangorestframework import permissions
 
-from djangorestframework.tokenauth.models import BasicToken
+from djangorestframework.authtoken.models import Token
 from djangorestframework.authentication import TokenAuthentication
 
 import base64
@@ -123,17 +123,17 @@ class TokenAuthTests(TestCase):
         self.user = User.objects.create_user(self.username, self.email, self.password)
 
         self.key = 'abcd1234'
-        self.token = BasicToken.objects.create(key=self.key, user=self.user)
+        self.token = Token.objects.create(key=self.key, user=self.user)
 
     def test_post_form_passing_token_auth(self):
         """Ensure POSTing json over token auth with correct credentials passes and does not require CSRF"""
-        auth = self.key
+        auth = "Token " + self.key
         response = self.csrf_client.post('/', {'example': 'example'}, HTTP_AUTHORIZATION=auth)
         self.assertEqual(response.status_code, 200)
 
     def test_post_json_passing_token_auth(self):
         """Ensure POSTing form over token auth with correct credentials passes and does not require CSRF"""
-        auth = self.key
+        auth = "Token " + self.key
         response = self.csrf_client.post('/', json.dumps({'example': 'example'}), 'application/json', HTTP_AUTHORIZATION=auth)
         self.assertEqual(response.status_code, 200)
 
@@ -149,5 +149,5 @@ class TokenAuthTests(TestCase):
 
     def test_token_has_auto_assigned_key_if_none_provided(self):
         """Ensure creating a token with no key will auto-assign a key"""
-        token = BasicToken.objects.create(user=self.user)
+        token = Token.objects.create(user=self.user)
-        self.assertEqual(len(token.key), 32)
+        self.assertTrue(bool(token.key))

djangorestframework/tokenauth/models.py

@@ -1,15 +0,0 @@
-import uuid
-from django.db import models
-
-class BasicToken(models.Model):
-    """
-    The default authorization token model class.
-    """
-    key = models.CharField(max_length=32, primary_key=True, blank=True)
-    user = models.ForeignKey('auth.User')
-    revoked = models.BooleanField(default=False)
-
-    def save(self, *args, **kwargs):
-        if not self.key:
-            self.key = uuid.uuid4().hex
-        return super(BasicToken, self).save(*args, **kwargs)

docs/api-guide/authentication.md

@@ -18,7 +18,7 @@ The `request.auth` property is used for any additional authentication informatio
 
 ## How authentication is determined
 
-Authentication is always set as a list of classes.  REST framework will attempt to authenticate with each class in the list, and will set `request.user` and `request.auth` using the return value of the first class that successfully authenticates.
+The authentication policy is always defined as a list of classes.  REST framework will attempt to authenticate with each class in the list, and will set `request.user` and `request.auth` using the return value of the first class that successfully authenticates.
 
 If no class authenticates, `request.user` will be set to an instance of `django.contrib.auth.models.AnonymousUser`, and `request.auth` will be set to `None`.
 
@@ -60,33 +60,40 @@ Or, if you're using the `@api_view` decorator with function based views.
         }
         return Response(content)
 
-## UserBasicAuthentication
+## BasicAuthentication
 
-This policy uses [HTTP Basic Authentication][basicauth], signed against a user's username and password.  User basic authentication is generally only appropriate for testing.
+This policy uses [HTTP Basic Authentication][basicauth], signed against a user's username and password.  Basic authentication is generally only appropriate for testing.
 
-**Note:** If you run `UserBasicAuthentication` in production your API should be `https` only.  You should also ensure that your API clients will always re-request the username and password at login, and will never store those details to persistent storage.
+If successfully authenticated, `BasicAuthentication` provides the following credentials.
-
-If successfully authenticated, `UserBasicAuthentication` provides the following credentials.
 
 * `request.user` will be a `django.contrib.auth.models.User` instance.
 * `request.auth` will be `None`.
 
+**Note:** If you use `BasicAuthentication` in production you must ensure that your API is only available over `https` only.  You should also ensure that your API clients will always re-request the username and password at login, and will never store those details to persistent storage.
+
 ## TokenAuthentication
 
-This policy uses simple token-based HTTP Authentication.  Token basic authentication is appropriate for client-server setups, such as native desktop and mobile clients.
+This policy uses a simple token-based HTTP Authentication scheme.  Token authentication is appropriate for client-server setups, such as native desktop and mobile clients.
 
-The token key should be passed in as a string to the "Authorization" HTTP header.  For example:
+To use the `TokenAuthentication` policy, include `djangorestframework.authtoken` in your `INSTALLED_APPS` setting.
 
-    curl http://my.api.org/ -X POST -H "Authorization: 0123456789abcdef0123456789abcdef"
+You'll also need to create tokens for your users.
 
-**Note:** If you run `TokenAuthentication` in production your API should be `https` only.
+    from djangorestframework.authtoken.models import Token
+
+    token = Token.objects.create(user=...)
+    print token.key
+
+For clients to authenticate, the token key should be included in the `Authorization` HTTP header.  The key should be prefixed by the string literal "Token", with whitespace seperating the two strings.  For example:
+
+    Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b
 
 If successfully authenticated, `TokenAuthentication` provides the following credentials.
 
 * `request.user` will be a `django.contrib.auth.models.User` instance.
 * `request.auth` will be a `djangorestframework.tokenauth.models.BasicToken` instance.
 
-To use the `TokenAuthentication` policy, you must have a token model.  Django REST Framework comes with a minimal default token model.  To use it, include `djangorestframework.tokenauth` in your installed applications and sync your database.  To use your own token model, subclass the `djangorestframework.tokenauth.TokenAuthentication` class and specify a `model` attribute that references your custom token model.  The token model must provide `user`, `key`, and `revoked` attributes.  Refer to the `djangorestframework.tokenauth.models.BasicToken` model as an example.
+**Note:** If you use `TokenAuthentication` in production you must ensure that your API is only available over `https` only.
 
 ## OAuthAuthentication
 

docs/api-guide/exceptions.md

@@ -8,7 +8,7 @@
 
 ## Exception handling in REST framework views
 
-REST framework's views handle various exceptions, and deal with returning appropriate error responses for you.
+REST framework's views handle various exceptions, and deal with returning appropriate error responses.
 
 The handled exceptions are:
 
@@ -16,9 +16,9 @@ The handled exceptions are:
 * Django's `Http404` exception.
 * Django's `PermissionDenied` exception.
 
-In each case, REST framework will return a response, rendering it to an appropriate content-type.
+In each case, REST framework will return a response with an appropriate status code and content-type.  The body of the response will include any additional details regarding the nature of the error.
 
-By default all error messages will include a key `details` in the body of the response, but other keys may also be included.
+By default all error responses will include a key `details` in the body of the response, but other keys may also be included.
 
 For example, the following request:
 

docs/api-guide/permissions.md

@@ -12,8 +12,9 @@ Permission checks are always run at the very start of the view, before any other
 
 ## How permissions are determined
 
-Permissions in REST framework are always defined as a list of permission classes.  Before running the main body of the view, each permission in the list is checked.
+Permissions in REST framework are always defined as a list of permission classes.  
 
+Before running the main body of the view each permission in the list is checked.
 If any permission check fails an `exceptions.PermissionDenied` exception will be raised, and the main body of the view will not run.
 
 ## Object level permissions
@@ -73,7 +74,17 @@ This permission is suitable if you want to your API to allow read permissions to
 
 ## DjangoModelPermissions
 
-This permission class ties into Django's standard `django.contrib.auth` model permissions.  When applied to a view that has a `.model` property, permission will only be granted if the user
+This permission class ties into Django's standard `django.contrib.auth` [model permissions][contribauth].  When applied to a view that has a `.model` property, authorization will only be granted if the user has the relevant model permissions assigned.
+
+* `POST` requests require the user to have the `add` permission on the model.
+* `PUT` and `PATCH` requests require the user to have the `change` permission on the model.
+* `DELETE` requests require the user to have the `delete` permission on the model.
+ 
+The default behaviour can also be overridden to support custom model permissions.  For example, you might want to include a `view` model permission for `GET` requests.
+
+To use custom model permissions, override `DjangoModelPermissions` and set the `.perms_map` property.  Refer to the source code for details.
+
+The `DjangoModelPermissions` class also supports object-level permissions.  Third-party authorization backends such as [django-guardian][guardian] that provide object-level permissions should work just fine with `DjangoModelPermissions` without any custom configuration required.
 
 ## Custom permissions
 
@@ -84,4 +95,6 @@ The method should return `True` if the request should be granted access, and `Fa
 
 [cite]: https://developer.apple.com/library/mac/#documentation/security/Conceptual/AuthenticationAndAuthorizationGuide/Authorization/Authorization.html
 [authentication]: authentication.md
-[throttling]: throttling.md
+[throttling]: throttling.md
+[contribauth]: https://docs.djangoproject.com/en/1.0/topics/auth/#permissions
+[guardian]: https://github.com/lukaszb/django-guardian

docs/api-guide/throttling.md

@@ -8,8 +8,69 @@
 
 [cite]: https://dev.twitter.com/docs/error-codes-responses
 
-## PerUserThrottle
+Throttling is similar to [permissions], in that it determines if a request should be authorized.  Throttles indicate a temporary state, and are used to control the rate of requests that clients can make to an API.
 
-## PerViewThrottle
+As with permissions, multiple throttles may be used.  Your API might have a restrictive throttle for unauthenticated requests, and a less restrictive throttle for authenticated requests.
 
-## Custom throttles
+Another scenario where you might want to use multiple throttles would be if you need to impose different constraints on different parts of the API, due ato some services being particularly resource-intensive.
+
+Throttles do not necessarily only refer to rate-limiting requests.  For example a storage service might also need to throttle against bandwidth.
+
+## How throttling is determined
+
+As with permissions and authentication, throttling in REST framework is always defined as a list of classes.
+
+Before running the main body of the view each throttle in the list is checked.
+If any throttle check fails an `exceptions.Throttled` exception will be raised, and the main body of the view will not run.
+
+## Setting the throttling policy
+
+The default throttling policy may be set globally, using the `DEFAULT_THROTTLES` setting.  For example.
+
+    API_SETTINGS = {
+        'DEFAULT_THROTTLES': (
+            'djangorestframework.throttles.AnonThrottle',
+            'djangorestframework.throttles.UserThrottle',
+        )
+        'DEFAULT_THROTTLE_RATES': {
+            'anon': '100/day',
+            'user': '1000/day'
+        }        
+    }
+
+You can also set the throttling policy on a per-view basis, using the `APIView` class based views.
+
+    class ExampleView(APIView):
+        throttle_classes = (UserThrottle,)
+
+        def get(self, request, format=None):
+            content = {
+                'status': 'request was permitted'
+            }
+            return Response(content)
+
+Or, if you're using the `@api_view` decorator with function based views.
+
+    @api_view('GET')
+    @throttle_classes(UserThrottle)
+    def example_view(request, format=None):
+        content = {
+            'status': 'request was permitted'
+        }
+        return Response(content)
+
+## AnonThrottle
+
+The `AnonThrottle` will only ever throttle unauthenticated users.  The IP address of the incoming request is used to identify 
+
+`AnonThrottle` is suitable if you want to restrict the rate of requests from unknown sources.
+
+## UserThrottle
+
+`UserThrottle` is suitable if you want a simple restriction
+
+## ScopedThrottle
+
+## Custom throttles
+
+[permissions]: permissions.md

docs/static/css/default.css

@@ -22,6 +22,13 @@ pre {
     display: block;
 }
 
+/* Header link to GitHub */
+.repo-link {
+    float: right;
+    margin-right: 10px;
+    margin-top: 9px;
+}
+
 /* GitHub 'Star' badge */
 body.index #main-content iframe {
     float: right;

docs/template.html

@@ -10,7 +10,7 @@
     <link href="{{ base_url }}/css/prettify.css" rel="stylesheet">
     <link href="{{ base_url }}/css/bootstrap.css" rel="stylesheet">
     <link href="{{ base_url }}/css/bootstrap-responsive.css" rel="stylesheet">
-    <link href="{{ base_url }}/css/drf-styles.css" rel="stylesheet">
+    <link href="{{ base_url }}/css/default.css" rel="stylesheet">
 
     <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
     <!--[if lt IE 9]>
@@ -23,6 +23,7 @@
     <div class="navbar navbar-inverse navbar-fixed-top">
       <div class="navbar-inner">
         <div class="container-fluid">
+            <a class="repo-link btn btn-primary btn-small" href="https://github.com/tomchristie/django-rest-framework/tree/restframework2">GitHub</a>
           <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
             <span class="icon-bar"></span>
             <span class="icon-bar"></span>