9734679075

Committed 30 Jun 2024 08:16PM UTC coverage: 53.287%. Remained the same

Build # 9734679075

Build Type

Pull #52

github

Committed by

web-flow

Commit Message

Merge f533069ae into 9e1a4fc66

Pull Request Pull Request #52: Add lots of docstrings

Run Details

309 of 953 branches covered (32.42%)

Branch coverage included in aggregate %.

22 of 31 new or added lines in 6 files covered. (70.97%)

33 existing lines in 9 files now uncovered.

1693 of 2804 relevant lines covered (60.38%)

0.6 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

55.56

/tin/apps/users/models.py

from __future__ import annotations

import logging

import requests
from django.contrib.auth.models import AbstractBaseUser, PermissionsMixin
from django.contrib.auth.models import UserManager as DjangoUserManager
from django.db import models
from django.utils import timezone
from social_django.utils import load_strategy

logger = logging.getLogger(__name__)


class UserManager(DjangoUserManager):
    """The Manager for :class:`~User`"""


class User(AbstractBaseUser, PermissionsMixin):
    """A Tin user"""

    id = models.AutoField(primary_key=True)
    username = models.CharField(unique=True, max_length=32)
    full_name = models.CharField(max_length=105)
    nickname = models.CharField(max_length=35, blank=True)
    first_name = models.CharField(max_length=35)
    last_name = models.CharField(max_length=70)
    email = models.CharField(max_length=50)
    is_staff = models.BooleanField(default=False)
    is_teacher = models.BooleanField(default=False)
    is_student = models.BooleanField(default=False)
    date_joined = models.DateTimeField(default=timezone.now)

    USERNAME_FIELD = "username"
    REQUIRED_FIELDS = ["email"]

    objects = UserManager()

    @property
    def short_name(self):
        return self.username

    def api_request(self, url, params=None, *, refresh=True):
        """Log in to Tin via Ion"""
        if params is None:
            params = {}

        social_auth = self.get_social_auth()
        params.update({"format": "json"})
        params.update({"access_token": social_auth.access_token})
        res = requests.get(f"https://ion.tjhsst.edu/api/{url}", params=params)
        if res.status_code == 401:
            if refresh:
                try:
                    self.get_social_auth().refresh_token(load_strategy())
                except BaseException as ex:  # pylint: disable=broad-except
                    logger.exception(str(ex))
                return self.api_request(url, params, refresh=False)
            else:
                logger.error("Ion API Request Failure: %s %s", res.status_code, res.json())
        return res.json()

    def get_social_auth(self):
        """Get social auth information from Ion"""
        return self.social_auth.get(provider="ion")

1	from __future__ import annotations	1✔
2
3	import logging	1✔
4
5	import requests	1✔
6	from django.contrib.auth.models import AbstractBaseUser, PermissionsMixin	1✔
7	from django.contrib.auth.models import UserManager as DjangoUserManager	1✔
8	from django.db import models	1✔
9	from django.utils import timezone	1✔
10	from social_django.utils import load_strategy	1✔
11
12	logger = logging.getLogger(__name__)	1✔
13
14
15	class UserManager(DjangoUserManager):	1✔
16	"""The Manager for :class:`~User`"""
17
18
19	class User(AbstractBaseUser, PermissionsMixin):	1✔
20	"""A Tin user"""
21
22	id = models.AutoField(primary_key=True)	1✔
23	username = models.CharField(unique=True, max_length=32)	1✔
24	full_name = models.CharField(max_length=105)	1✔
25	nickname = models.CharField(max_length=35, blank=True)	1✔
26	first_name = models.CharField(max_length=35)	1✔
27	last_name = models.CharField(max_length=70)	1✔
28	email = models.CharField(max_length=50)	1✔
29	is_staff = models.BooleanField(default=False)	1✔
30	is_teacher = models.BooleanField(default=False)	1✔
31	is_student = models.BooleanField(default=False)	1✔
32	date_joined = models.DateTimeField(default=timezone.now)	1✔
33
34	USERNAME_FIELD = "username"	1✔
35	REQUIRED_FIELDS = ["email"]	1✔
36
37	objects = UserManager()	1✔
38
39	@property	1✔
40	def short_name(self):	1!
41	return self.username	×
42
43	def api_request(self, url, params=None, *, refresh=True):	1✔
44	"""Log in to Tin via Ion"""
45	if params is None:	×
46	params = {}	×
47
48	social_auth = self.get_social_auth()	×
49	params.update({"format": "json"})	×
50	params.update({"access_token": social_auth.access_token})	×
51	res = requests.get(f"https://ion.tjhsst.edu/api/{url}", params=params)	×
52	if res.status_code == 401:	×
53	if refresh:	×
54	try:	×
55	self.get_social_auth().refresh_token(load_strategy())	×
56	except BaseException as ex: # pylint: disable=broad-except	×
57	logger.exception(str(ex))	×
58	return self.api_request(url, params, refresh=False)	×
59	else:
60	logger.error("Ion API Request Failure: %s %s", res.status_code, res.json())	×
61	return res.json()	×
62
63	def get_social_auth(self):	1✔
64	"""Get social auth information from Ion"""
UNCOV 65	return self.social_auth.get(provider="ion")	×

tjcsl / tin / 9734679075

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous