Use term DeviceGrant over Device

Perferred to use the Grant suffix in order to keep the naming
consistent with other grant models.

Author: cristiprg

oauth2_provider/migrations/0013_alter_application_authorization_grant_type_device.py

@@ -19,7 +19,7 @@ class Migration(migrations.Migration):
             field=models.CharField(choices=[('authorization-code', 'Authorization code'), ('urn:ietf:params:oauth:grant-type:device_code', 'Device Code'), ('implicit', 'Implicit'), ('password', 'Resource owner password-based'), ('client-credentials', 'Client credentials'), ('openid-hybrid', 'OpenID connect hybrid')], max_length=44),
         ),
         migrations.CreateModel(
-            name='Device',
+            name='DeviceGrant',
             fields=[
                 ('id', models.BigAutoField(primary_key=True, serialize=False)),
                 ('device_code', models.CharField(max_length=100, unique=True)),
@@ -34,8 +34,8 @@ class Migration(migrations.Migration):
             ],
             options={
                 'abstract': False,
-                'swappable': 'OAUTH2_PROVIDER_DEVICE_MODEL',
-                'constraints': [models.UniqueConstraint(fields=('device_code',), name='oauth2_provider_device_unique_device_code')],
+                'swappable': 'OAUTH2_PROVIDER_DEVICE_GRANT_MODEL',
+                'constraints': [models.UniqueConstraint(fields=('device_code',), name='oauth2_provider_devicegrant_unique_device_code')],
             },
         ),
     ]

oauth2_provider/models.py

@@ -655,7 +655,7 @@ class Meta(AbstractIDToken.Meta):
         swappable = "OAUTH2_PROVIDER_ID_TOKEN_MODEL"
 
 
-class AbstractDevice(models.Model):
+class AbstractDeviceGrant(models.Model):
     class Meta:
         abstract = True
         constraints = [
@@ -718,11 +718,11 @@ def get_by_natural_key(self, client_id, device_code, user_code):
         return self.get(client_id=client_id, device_code=device_code, user_code=user_code)
 
 
-class Device(AbstractDevice):
+class DeviceGrant(AbstractDeviceGrant):
     objects = DeviceManager()
 
-    class Meta(AbstractDevice.Meta):
-        swappable = "OAUTH2_PROVIDER_DEVICE_MODEL"
+    class Meta(AbstractDeviceGrant.Meta):
+        swappable = "OAUTH2_PROVIDER_DEVICE_GRANT_MODEL"
 
     def natural_key(self):
         return (self.client_id, self.device_code, self.user_code)
@@ -746,10 +746,10 @@ class DeviceCodeResponse:
     verification_uri_complete: Optional[Union[str, Callable]] = None
 
 
-def create_device(device_request: DeviceRequest, device_response: DeviceCodeResponse) -> Device:
+def create_device_grant(device_request: DeviceRequest, device_response: DeviceCodeResponse) -> DeviceGrant:
     now = datetime.now(tz=dt_timezone.utc)
 
-    return Device.objects.create(
+    return DeviceGrant.objects.create(
         client_id=device_request.client_id,
         device_code=device_response.device_code,
         user_code=device_response.user_code,
@@ -763,9 +763,9 @@ def get_application_model():
     return apps.get_model(oauth2_settings.APPLICATION_MODEL)
 
 
-def get_device_model():
-    """Return the Device model that is active in this project."""
-    return apps.get_model(oauth2_settings.DEVICE_MODEL)
+def get_device_grant_model():
+    """Return the DeviceGrant model that is active in this project."""
+    return apps.get_model(oauth2_settings.DEVICE_GRANT_MODEL)
 
 
 def get_grant_model():

oauth2_provider/settings.py

@@ -30,7 +30,7 @@
 USER_SETTINGS = getattr(settings, "OAUTH2_PROVIDER", None)
 
 APPLICATION_MODEL = getattr(settings, "OAUTH2_PROVIDER_APPLICATION_MODEL", "oauth2_provider.Application")
-DEVICE_MODEL = getattr(settings, "OAUTH2_PROVIDER_DEVICE_MODEL", "oauth2_provider.Device")
+DEVICE_GRANT_MODEL = getattr(settings, "OAUTH2_PROVIDER_DEVICE_GRANT_MODEL", "oauth2_provider.DeviceGrant")
 ACCESS_TOKEN_MODEL = getattr(settings, "OAUTH2_PROVIDER_ACCESS_TOKEN_MODEL", "oauth2_provider.AccessToken")
 ID_TOKEN_MODEL = getattr(settings, "OAUTH2_PROVIDER_ID_TOKEN_MODEL", "oauth2_provider.IDToken")
 GRANT_MODEL = getattr(settings, "OAUTH2_PROVIDER_GRANT_MODEL", "oauth2_provider.Grant")
@@ -68,7 +68,7 @@
     "APPLICATION_MODEL": APPLICATION_MODEL,
     "ACCESS_TOKEN_MODEL": ACCESS_TOKEN_MODEL,
     "ID_TOKEN_MODEL": ID_TOKEN_MODEL,
-    "DEVICE_MODEL": DEVICE_MODEL,
+    "DEVICE_GRANT_MODEL": DEVICE_GRANT_MODEL,
     "DEVICE_FLOW_INTERVAL": 5,
     "GRANT_MODEL": GRANT_MODEL,
     "REFRESH_TOKEN_MODEL": REFRESH_TOKEN_MODEL,

oauth2_provider/utils.py

@@ -94,7 +94,7 @@ def set_oauthlib_user_to_device_request_user(request: Request) -> None:
     """
     # Since this function is used in the settings module, it will lead to circular imports
     # since django isn't fully initialised yet when settings run
-    from oauth2_provider.models import Device, get_device_model
+    from oauth2_provider.models import DeviceGrant, get_device_grant_model
 
-    device: Device = get_device_model().objects.get(device_code=request._params["device_code"])
+    device: DeviceGrant = get_device_grant_model().objects.get(device_code=request._params["device_code"])
     request.user = device.user

oauth2_provider/views/base.py

@@ -15,7 +15,7 @@
 from django.views.generic import FormView, View
 from oauthlib.oauth2.rfc8628 import errors as rfc8628_errors
 
-from oauth2_provider.models import Device
+from oauth2_provider.models import DeviceGrant
 
 from ..compat import login_not_required
 from ..exceptions import OAuthToolkitError
@@ -318,8 +318,8 @@ def device_flow_token_response(
         self, request: http.HttpRequest, device_code: str, *args, **kwargs
     ) -> http.HttpResponse:
         try:
-            device = Device.objects.get(device_code=device_code)
-        except Device.DoesNotExist:
+            device = DeviceGrant.objects.get(device_code=device_code)
+        except DeviceGrant.DoesNotExist:
             # The RFC does not mention what to return when the device is not found,
             # but to keep it consistent with the other errors, we return the error
             # in json format with an "error" key and the value formatted in the same

oauth2_provider/views/device.py

@@ -11,7 +11,13 @@
 from oauthlib.oauth2 import DeviceApplicationServer
 
 from oauth2_provider.compat import login_not_required
-from oauth2_provider.models import Device, DeviceCodeResponse, DeviceRequest, create_device, get_device_model
+from oauth2_provider.models import (
+    DeviceCodeResponse,
+    DeviceGrant,
+    DeviceRequest,
+    create_device_grant,
+    get_device_grant_model,
+)
 from oauth2_provider.views.mixins import OAuthLibMixin
 
 
@@ -29,7 +35,7 @@ def post(self, request, *args, **kwargs):
             return http.JsonResponse(data=json.loads(response), status=status, headers=headers)
 
         device_response = DeviceCodeResponse(**response)
-        create_device(device_request, device_response)
+        create_device_grant(device_request, device_response)
 
         return http.JsonResponse(data=response, status=status, headers=headers)
 
@@ -61,8 +67,8 @@ def device_user_code_view(request):
 
     user_code: str = form.cleaned_data["user_code"]
     try:
-        device: Device = get_device_model().objects.get(user_code=user_code)
-    except Device.DoesNotExist:
+        device: DeviceGrant = get_device_grant_model().objects.get(user_code=user_code)
+    except DeviceGrant.DoesNotExist:
         form.add_error("user_code", "Incorrect user code")
         return render(request, "oauth2_provider/device/user_code.html", {"form": form}, status=404)
 
@@ -91,11 +97,11 @@ def device_user_code_view(request):
 @login_required
 def device_confirm_view(request: http.HttpRequest, client_id: str, user_code: str):
     try:
-        device: Device = get_device_model().objects.get(
+        device: DeviceGrant = get_device_grant_model().objects.get(
             # there is a db index on client_id
             Q(client_id=client_id) & Q(user_code=user_code)
         )
-    except Device.DoesNotExist:
+    except DeviceGrant.DoesNotExist:
         return http.HttpResponseNotFound("<h1>Device not found</h1>")
 
     if device.status != device.AUTHORIZATION_PENDING:

tests/test_device.py

@@ -13,7 +13,7 @@
 from oauth2_provider.models import (
     get_access_token_model,
     get_application_model,
-    get_device_model,
+    get_device_grant_model,
     get_refresh_token_model,
 )
 from oauth2_provider.utils import set_oauthlib_user_to_device_request_user
@@ -26,7 +26,7 @@
 AccessToken = get_access_token_model()
 RefreshToken = get_refresh_token_model()
 UserModel = get_user_model()
-DeviceModel: oauth2_provider.models.Device = get_device_model()
+DeviceModel: oauth2_provider.models.DeviceGrant = get_device_grant_model()
 
 
 @pytest.mark.usefixtures("oauth2_settings")