First commit

.gitignore

@@ -0,0 +1,8 @@
+*.py[cod]
+__pycache__/
+
+secret.py
+venv
+.venv
+db.sqlite3
+media

README.md

@@ -0,0 +1,11 @@
+# Study Bank
+
+## Development
+
+- clone the git repo
+- create `settings/secret.py` based on `settings/secret.sample`
+- register an OAuth app with Ion for authentication (client-type = confidential, auth-grant-type = authorization-code)
+- copy the client_id for SOCIAL_AUTH_ION_KEY and client_secret for SOCIAL_AUTH_ION_SECRET from Ion to `settings/secret.py`
+- edit `settings/__init__.py` so that `MEDIA_ROOT` and `STATIC_ROOT` point to your desired directories (you also need to create these directories)
+- uploaded documents will be stored in the media directory, and static files will be collected to the static directory
+- django will not serve any files in either of these directories, so you need to make sure your web server will

studyguides/manage.py

@@ -0,0 +1,21 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'studyguides.settings')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()

studyguides/studyguides/apps/auth/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

studyguides/studyguides/apps/auth/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class AuthConfig(AppConfig):
+    name = 'studyguides.apps.auth'
+    label = 'authentication'
+

studyguides/studyguides/apps/auth/models.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

studyguides/studyguides/apps/auth/oauth.py

@@ -0,0 +1,40 @@
+from social_core.backends.oauth import BaseOAuth2
+from social_core.pipeline.user import get_username as social_get_username
+
+
+def get_username(strategy, details, user = None, *args, **kwargs):
+    result = social_get_username(strategy, details, user = user, *args, **kwargs)
+    return result
+
+
+class IonOauth2(BaseOAuth2):
+    name = 'ion'
+    AUTHORIZATION_URL = 'https://ion.tjhsst.edu/oauth/authorize'
+    ACCESS_TOKEN_URL = 'https://ion.tjhsst.edu/oauth/token'
+    ACCESS_TOKEN_METHOD = 'POST'
+    EXTRA_DATA = [
+        ('refresh_token', 'refresh_token', True),
+        ('expires_in', 'expires')
+    ]
+
+    def get_scope(self):
+        return ["read"]
+
+    def get_user_details(self, response):
+        profile = self.get_json(
+            'https://ion.tjhsst.edu/api/profile',
+            params = {'access_token': response['access_token']},
+        )
+        # fields used to populate/update User model
+        return {
+            'id': profile['id'],
+            'username': profile['ion_username'],
+            'first_name': profile['first_name'],
+            'last_name': profile['last_name'],
+            'full_name': profile['full_name'],
+            'email': profile['tj_email'],
+        }
+
+    def get_user_id(self, details, response):
+        return details["id"]
+

studyguides/studyguides/apps/auth/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

studyguides/studyguides/apps/auth/urls.py

@@ -0,0 +1,11 @@
+from django.urls import path
+
+from . import views
+
+app_name = "auth"
+
+urlpatterns = [
+    path("login", views.login, name = "login"),
+    path("logout", views.logout, name = "logout"),
+]
+

studyguides/studyguides/apps/auth/views.py

@@ -0,0 +1,10 @@
+from django.shortcuts import render
+from django.contrib.auth.views import LogoutView
+
+# Create your views here.
+
+def login(request):
+    return render(request, "auth/login.html")
+
+logout = LogoutView.as_view()
+

studyguides/studyguides/apps/courses/admin.py

@@ -0,0 +1,7 @@
+from django.contrib import admin
+from .models import Subject, Course, Guide
+# Register your models here.
+
+admin.site.register(Subject)
+admin.site.register(Course)
+admin.site.register(Guide)

studyguides/studyguides/apps/courses/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class CoursesConfig(AppConfig):
+    name = 'courses'

studyguides/studyguides/apps/courses/migrations/0001_initial.py

@@ -0,0 +1,44 @@
+# Generated by Django 3.1.2 on 2020-10-14 18:22
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Course',
+            fields=[
+                ('id', models.AutoField(primary_key=True, serialize=False)),
+                ('name', models.CharField(max_length=100, unique=True)),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Guide',
+            fields=[
+                ('id', models.AutoField(primary_key=True, serialize=False)),
+                ('name', models.CharField(max_length=100)),
+                ('url', models.URLField(max_length=300)),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Subject',
+            fields=[
+                ('id', models.AutoField(primary_key=True, serialize=False)),
+                ('name', models.CharField(max_length=100, unique=True)),
+                ('url', models.CharField(max_length=20, unique=True, validators=[django.core.validators.RegexValidator(message='Only alphanumeric, dashes, and underscores allowed', regex='^[a-zA-Z0-9_\\-]+$')])),
+                ('courses', models.ManyToManyField(related_name='subject', to='courses.Course')),
+            ],
+        ),
+        migrations.AddField(
+            model_name='course',
+            name='units',
+            field=models.ManyToManyField(related_name='course', to='courses.Guide'),
+        ),
+    ]

studyguides/studyguides/apps/courses/models.py

@@ -0,0 +1,34 @@
+from django.db import models
+from django.core.validators import RegexValidator, FileExtensionValidator
+
+# Create your models here.
+class Subject(models.Model):
+    id = models.AutoField(primary_key = True)
+    name = models.CharField(max_length=100, unique = True)
+    url = models.CharField(max_length=20, unique = True, validators=[RegexValidator(regex="^[a-zA-Z0-9_\-]+$", message="Only alphanumeric, dashes, and underscores allowed")])
+
+    courses = models.ManyToManyField("Course", related_name="subject")
+
+    def __str__(self):
+        return self.name
+
+class Course(models.Model):
+    id = models.AutoField(primary_key = True)
+    name = models.CharField(max_length=100, unique = True)
+
+    units = models.ManyToManyField("Guide", related_name="course")
+
+    def __str__(self):
+        return self.name
+
+class Guide(models.Model):
+    id = models.AutoField(primary_key = True)
+    name = models.CharField(max_length=100)
+    
+    url = models.URLField(max_length=300)
+
+    def __str__(self):
+        return self.name
+
+
+

studyguides/studyguides/apps/courses/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

studyguides/studyguides/apps/courses/urls.py

@@ -0,0 +1,9 @@
+from django.urls import path
+
+from . import views
+
+app_name = "courses"
+
+urlpatterns = [
+    
+]

studyguides/studyguides/apps/courses/views.py

@@ -0,0 +1,8 @@
+import random
+
+from django import http
+from django.shortcuts import render, redirect, reverse, get_object_or_404
+
+from .models import Subject, Course, Guide
+# Create your views here.
+

studyguides/studyguides/apps/home/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

studyguides/studyguides/apps/home/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class HomeConfig(AppConfig):
+    name = 'home'

studyguides/studyguides/apps/home/models.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

studyguides/studyguides/apps/home/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

studyguides/studyguides/apps/home/urls.py

@@ -0,0 +1,9 @@
+from django.urls import path
+from . import views
+
+app_name = "home"
+
+urlpatterns = [
+    path("", views.index_view, name = "index"), 
+]
+

studyguides/studyguides/apps/home/views.py

@@ -0,0 +1,10 @@
+from django.shortcuts import render, redirect
+from django.http import HttpResponse
+
+# Create your views here.
+
+def index_view(request):
+   return render(request, "base.html")
+   #return HttpResponse("hello world")
+
+

studyguides/studyguides/apps/users/admin.py

@@ -0,0 +1,7 @@
+from django.contrib import admin
+from django.contrib.auth.admin import UserAdmin
+from .models import User
+
+# Register your models here.
+
+admin.site.register(User, UserAdmin)

studyguides/studyguides/apps/users/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class UsersConfig(AppConfig):
+    name = 'users'

studyguides/studyguides/apps/users/models.py

@@ -0,0 +1,48 @@
+from django.contrib.auth.models import AbstractUser
+from django.db import models
+
+from social_django.utils import load_strategy
+
+import requests
+import logging
+
+logger = logging.getLogger(__name__)
+
+# Create your models here.
+class User(AbstractUser):
+    id = models.AutoField(primary_key = True)
+    full_name = models.CharField(max_length = 105)
+
+    @property
+    def short_name(self):
+        return self.username
+    def __str__(self):
+        return self.full_name
+    def empty_fields(self):
+        list = []
+        for field in User._meta.fields:
+            list.append((field.value_from_object(self),field))
+        return list
+    def api_request(self, url, params={}, refresh=True):
+        s = self.get_social_auth()
+        params.update({"format": "json"})
+        params.update({"access_token": s.access_token})
+        r = requests.get(
+            "https://ion.tjhsst.edu/api/{}".format(url),
+            params = params,
+        )
+        if r.status_code == 401:
+            if refresh:
+                try:
+                    self.get_social_auth().refresh_token(load_strategy())
+                except BaseException as e:
+                    logger.exception(str(e))
+                return self.api_request(url, params, False)
+            else:
+                logger.error(
+                    "Ion API Request Failure: {} {}".format(r.status_code,
+                                                            r.json()))
+        return r.json()
+
+    def get_social_auth(self):
+        return self.social_auth.get(provider = "ion")

studyguides/studyguides/apps/users/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

studyguides/studyguides/apps/users/urls.py

@@ -0,0 +1,10 @@
+from django.urls import path
+
+from . import views
+
+app_name = "users"
+
+urlpatterns = [
+
+]
+

studyguides/studyguides/apps/users/views.py

@@ -0,0 +1,6 @@
+from django.shortcuts import render, redirect
+from django import http
+from .models import User
+from django.forms import formset_factory
+# Create your views here.
+

studyguides/studyguides/settings/__init__.py

@@ -0,0 +1,177 @@
+"""
+Django settings for studyguides project.
+
+Generated by 'django-admin startproject' using Django 2.2.1.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/2.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/2.2/ref/settings/
+"""
+
+import os
+
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+PROJECT_ROOT = os.path.join(BASE_DIR, "studyguides")
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/2.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = ''
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = ['localhost', '127.0.0.1', 'studyguides.tjhsst.edu', '*']
+
+SOCIAL_AUTH_ION_KEY = ""
+
+SOCIAL_AUTH_ION_SECRET = ""
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'social_django',
+    'studyguides.apps.courses',
+    'studyguides.apps.home',
+    'studyguides.apps.users',
+    'studyguides.apps.auth.apps.AuthConfig',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'studyguides.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [
+            os.path.join(BASE_DIR, "studyguides/templates")
+        ],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+                'social_django.context_processors.backends',
+                'social_django.context_processors.login_redirect',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'studyguides.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/2.2/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/2.2/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+AUTHENTICATION_BACKENDS = (
+    'studyguides.apps.auth.oauth.IonOauth2',
+    'django.contrib.auth.backends.ModelBackend',
+)
+
+SOCIAL_AUTH_USER_FIELDS = ['username', 'full_name', 'first_name', 'last_name', 'email', 'id']
+
+SOCIAL_AUTH_URL_NAMESPACE = 'social'
+
+SOCIAL_AUTH_PIPELINE = (
+    'social_core.pipeline.social_auth.social_details',
+    'social_core.pipeline.social_auth.social_uid',
+    'social_core.pipeline.social_auth.auth_allowed',
+    'social_core.pipeline.social_auth.social_user',
+    'studyguides.apps.auth.oauth.get_username',
+    'social_core.pipeline.social_auth.associate_by_email',
+    'social_core.pipeline.user.create_user',
+    'social_core.pipeline.social_auth.associate_user',
+    'social_core.pipeline.social_auth.load_extra_data',
+)
+
+AUTH_USER_MODEL = "users.User"
+
+SOCIAL_AUTH_ALWAYS_ASSOCIATE = True
+
+# Internationalization
+# https://docs.djangoproject.com/en/2.2/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+LOGIN_URL = "auth:login"
+LOGIN_REDIRECT_URL = "users:index"
+LOGOUT_REDIRECT_URL = "home:index"
+
+SOCIAL_AUTH_LOGIN_ERROR_URL = '/'
+SOCIAL_AUTH_RAISE_EXCEPTIONS = False
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/2.2/howto/static-files/
+
+STATIC_URL = '/static/'
+
+STATIC_ROOT = os.path.join(BASE_DIR, 'studyguides/serve')
+
+STATICFILES_DIRS = (
+    os.path.join(BASE_DIR, 'studyguides/static'),
+)
+
+MEDIA_ROOT = os.path.join(BASE_DIR, 'studyguides/media')
+
+MEDIA_URL = "/media/"
+
+USE_X_FORWARDED_HOST = True
+
+STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'
+from .secret import *

studyguides/studyguides/templates/base.html

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+{% load static %}
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Study Guide Bank</title>
+    <meta name="description" content="Study guide bank for students of Thomas Jefferson High School for Science and Technology.">
+    <meta name="keywords" content="tjhsst, study bank, study guide, guide bank, tjhsst study, tjhsst background-size">
+  
+    
+</script>
+  {% block head %}{% endblock %}
+  </head>
+  <body id="page">
+  {% block main %}{% endblock %}
+  </body>
+</html>

studyguides/studyguides/urls.py

@@ -0,0 +1,32 @@
+"""studyguides URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/2.2/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import path, include
+from django.conf import settings
+from django.conf.urls.static import static
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+
+    path('courses/', include('studyguides.apps.courses.urls', namespace = 'courses')),
+    path('auth/', include('studyguides.apps.auth.urls', namespace = 'auth')),
+    path('', include('studyguides.apps.home.urls', namespace='home')),
+    path('', include('social_django.urls', namespace = 'social')),
+
+]
+if settings.DEBUG:
+    urlpatterns.extend(static("static/", document_root=settings.STATIC_ROOT))
+    urlpatterns.extend(static("media/", document_root = settings.MEDIA_ROOT))

studyguides/studyguides/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for studyguides project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/2.2/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'studyguides.settings')
+
+application = get_wsgi_application()