uw-it-aca · David-Strupinski · Aug 23, 2023 · Jun 15, 2023 · Jun 15, 2023 · Jun 21, 2023
diff --git a/Dockerfile-ARM b/Dockerfile-ARM
diff --git a/README.md b/README.md
@@ -19,36 +19,52 @@ These instructions will get you a copy of the project up and running on your loc
 
 First, clone the repository:
 
-    $ git clone https://github.com/uw-it-aca/scout.git
-
+```bash
+git clone https://github.com/uw-it-aca/scout.git
+```
 
 If you wish to change the default settings, navigate to the repository and copy the sample environment variables into your own `.env` file:
 
-```
+```bash
 cd scout
 cp sample.env .env
 ```
 
-Optionally, add custom 404 response to `docker/urls.py`:
+## Development
+
+### Setting up the correct environment variables
 
+Settings `RESTCLIENTS_SPOTSEEKER_DAO_CLASS` to `Mock` will allow you to run the app without connecting to a live Spotseeker server. This is useful for testing and development. However, if you want to properly test the app against a live Spotseeker server, you will need to set up the following environment variables:
+
+```bash
+RESTCLIENTS_SPOTSEEKER_DAO_CLASS=Live
+RESTCLIENTS_SPOTSEEKER_HOST=[your spotseeker server url]
+
+SPOTSEEKER_OAUTH_CREDENTIAL=[your spotseeker server oauth credential]
 ```
-handler404 = 'scout.views.custom_404_response'
+
+You must go to your live spotseeker server instance to get the oauth credential. In spotseeker server, run the following command:
+
+```bash
+docker exec -ti spotseeker-server bin/python manage.py register_application [-s/--show-credential]
 ```
 
-## Development
+You will be prompted for an app name. The default name for this app is `scout`. You can change this name by setting the `APP_NAME` environment variable. The command will give you a credential. Copy and paste this credential into the `SPOTSEEKER_OAUTH_CREDENTIAL` environment variable and you should be good to go.
+
+It is recommended that you keep the scope to read only as that is what scout is designed for.
 
 ### Running the App with Docker
 
 Run the following command to build your docker container:
 
-```
+```bash
 docker-compose up --build
 ```
 
 ### Running Unit Tests with Docker
 
-```
-docker-compose run --rm app bin/python manage.py test
+```bash
+docker exec -ti scout bin/python manage.py test
 ```
 
 ### Running the app against a Live Spotseeker Server ###
@@ -82,7 +98,7 @@ See also the list of [contributors](https://github.com/uw-it-aca/scout/contribut
 
 ## License
 
-Copyright 2012-2016 UW Information Technology, University of Washington
+Copyright 2012-2023 UW Information Technology, University of Washington
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -98,18 +114,25 @@ limitations under the License.
 
 ## List of settings
 
-(To be moved to the wiki eventually.)
-
-CAMPUS_URL_LIST
-
 GOOGLE_ANALYTICS_KEY
 
 GOOGLE_MAPS_API
 
+COMPRESS_ENABLED
+
+OAUTH_USER
+
+SCOUT_SHOW_ALT_TECH
+
+DEBUG_CACHING
+- If set to True, will use a real cache even while in DEBUG=True. This is useful for testing.
+
 RESTCLIENTS_SPOTSEEKER_DAO_CLASS
 
-RESTCLIENTS_SPOTSEEKER_HOST = ''
+RESTCLIENTS_SPOTSEEKER_HOST
+
+SPOTSEEKER_OAUTH_CREDENTIAL
 
-SPOTSEEKER_OAUTH_KEY = ''
+SPOTSEEKER_OAUTH_SCOPE
 
-SPOTSEEKER_OAUTH_SECRET = ''
+APP_NAME
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -6,21 +6,20 @@ services:
     container_name: scout
     build:
       context: .
-      dockerfile: ${DOCKERFILE:-Dockerfile}
       target: app-container
     volumes:
       - ./scout:/app/scout
     ports:
       - "${PORT:-8000}:8000"
     environment:
       ENV: localdev
+      APP_NAME: ${APP_NAME:-"scout"}
       SCOUT_SHOW_NEWSSPLASH: ${SCOUT_SHOW_NEWSSPLASH:-False}
       RESTCLIENTS_SPOTSEEKER_HOST: ${RESTCLIENTS_SPOTSEEKER_HOST:-""}
-      SPOTSEEKER_OAUTH_KEY: ${SPOTSEEKER_OAUTH_KEY:-""}
-      SPOTSEEKER_OAUTH_SECRET: ${SPOTSEEKER_OAUTH_SECRET:-""}
+      SPOTSEEKER_OAUTH_CREDENTIAL: ${SPOTSEEKER_OAUTH_CREDENTIAL:-""}
+      SCOPE: ${SCOPE:-read}
+      DEBUG_CACHING: ${DEBUG_CACHING:-True}
       RESTCLIENTS_SPOTSEEKER_DAO_CLASS: ${RESTCLIENTS_SPOTSEEKER_DAO_CLASS:-Mock}
       OAUTH_USER: ${OAUTH_USER:-javerage}
       SCOUT_SHOW_ALT_TECH: ${SCOUT_SHOW_ALT_TECH:-False}
       COMPRESS_ENABLED: ${COMPRESS_ENABLED:-True}
-
-
diff --git a/docker/prod-values.yml b/docker/prod-values.yml
@@ -72,6 +72,8 @@ environmentVariables:
     value: 'False'
   - name: SCOUT_SHOW_ALT_TECH
     value: 'False'
+  - name: SPOTSEEKER_OAUTH_SCOPE
+    value: read
 externalSecrets:
   enabled: true
   secrets:
@@ -108,11 +110,7 @@ environmentVariablesSecrets:
     name: GOOGLE_MAPS_API
     secretName: prod.scout.uw.edu-secrets
     secretKey: google-maps-api-key
-  spotseekerOauthKey:
-    name: SPOTSEEKER_OAUTH_KEY
+  spotseekerOauthCredential:
+    name: SPOTSEEKER_OAUTH_CREDENTIAL
     secretName: prod.scout.uw.edu-secrets
-    secretKey: spotseeker-oauth-key
-  spotseekerOauthSecret:
-    name: SPOTSEEKER_OAUTH_SECRET
-    secretName: prod.scout.uw.edu-secrets
-    secretKey: spotseeker-oauth-secret
+    secretKey: spotseeker-oauth-credential
diff --git a/docker/settings.py b/docker/settings.py
@@ -8,6 +8,8 @@
     "hybridize",
 ]
 
+APP_NAME = os.getenv("APP_NAME", "scout")
+
 MIDDLEWARE += ["django_user_agents.middleware.UserAgentMiddleware"]
 
 COMPRESS_ROOT = "/static/"
@@ -51,10 +53,26 @@
 CAMPUS_URL_LIST = ["seattle", "tacoma", "bothell"]
 SCOUT_SHOW_NEWSSPLASH = os.getenv("SCOUT_SHOW_NEWSSPLASH") == "True"
 RESTCLIENTS_SPOTSEEKER_HOST = os.getenv("RESTCLIENTS_SPOTSEEKER_HOST", "")
-SPOTSEEKER_OAUTH_KEY = os.getenv("SPOTSEEKER_OAUTH_KEY", "")
-SPOTSEEKER_OAUTH_SECRET = os.getenv("SPOTSEEKER_OAUTH_SECRET", "")
+SPOTSEEKER_OAUTH_CREDENTIAL = os.getenv("SPOTSEEKER_OAUTH_CREDENTIAL", "")
+SPOTSEEKER_OAUTH_SCOPE = os.getenv("SPOTSEEKER_OAUTH_SCOPE", "read")
 RESTCLIENTS_SPOTSEEKER_DAO_CLASS = os.getenv(
     "RESTCLIENTS_SPOTSEEKER_DAO_CLASS", "Mock"
 )
 OAUTH_USER = os.getenv("OAUTH_USER", "javerage")
 SCOUT_SHOW_ALT_TECH = os.getenv("SCOUT_SHOW_ALT_TECH") == "True"
+
+DEBUG_CACHING = os.getenv("DEBUG_CACHING", "True") == "True"
+
+if DEBUG and not DEBUG_CACHING:
+    CACHES = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.dummy.DummyCache",
+        }
+    }
+else:
+    CACHES = {
+        'default': {
+            'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
+            'LOCATION': 'scout',
+        }
+    }
diff --git a/docker/test-values.yml b/docker/test-values.yml
@@ -62,6 +62,8 @@ environmentVariables:
     value: 'False'
   - name: SCOUT_SHOW_ALT_TECH
     value: 'False'
+  - name: SPOTSEEKER_OAUTH_SCOPE
+    value: read
 externalSecrets:
   enabled: true
   secrets:
@@ -98,11 +100,7 @@ environmentVariablesSecrets:
     name: GOOGLE_MAPS_API
     secretName: test.scout.uw.edu-secrets
     secretKey: google-maps-api-key
-  spotseekerOauthKey:
-    name: SPOTSEEKER_OAUTH_KEY
+  spotseekerOauthCredential:
+    name: SPOTSEEKER_OAUTH_CREDENTIAL
     secretName: test.scout.uw.edu-secrets
-    secretKey: spotseeker-oauth-key
-  spotseekerOauthSecret:
-    name: SPOTSEEKER_OAUTH_SECRET
-    secretName: test.scout.uw.edu-secrets
-    secretKey: spotseeker-oauth-secret
+    secretKey: spotseeker-oauth-credential
diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,3 @@
--e git+https://github.com/uw-it-aca/uw-restclients-spotseeker.git#egg=uw_restclients_spotseeker
+-e git+https://github.com/uw-it-aca/uw-restclients-spotseeker.git@v2.0#egg=uw_restclients_spotseeker
 -e git+https://github.com/uw-it-aca/django-hybridize/#egg=hybridize
 -e .
diff --git a/sample.env b/sample.env
@@ -10,17 +10,12 @@
 #RESTCLIENTS_SPOTSEEKER_HOST=http://yourdns.edu:8001
 #RESTCLIENTS_SPOTSEEKER_DAO_CLASS=Live
 
-# Spotseeker oath variables
-# Generate these with: ./manage.py create_consumer or
-# docker exec -it bin/python manage.py create_consumer
-#SPOTSEEKER_OAUTH_KEY=tempkey
-#SPOTSEEKER_OAUTH_SECRET=tempsecret
-
-# Alternate Dockerfile for ARM-based Macs
-#DOCKERFILE=DOCKERFILE-ARM
+# Spotseeker oauth variables
+SPOTSEEKER_OAUTH_CREDENTIAL=credential
+SPOTSEEKER_OAUTH_SCOPE=read
 
 # Show alternate tech tab content
 #SCOUT_SHOW_ALT_TECH=True
 
 # Disable compressing CSS and JS files
-#COMPRESS_ENABLED=False
+#COMPRESS_ENABLED=False
diff --git a/scout/context_processors.py b/scout/context_processors.py
@@ -1,4 +1,4 @@
-# Copyright 2023 UW-IT, University of Washington
+# Copyright 2024 UW-IT, University of Washington
 # SPDX-License-Identifier: Apache-2.0
 
 from django.conf import settings

diff --git a/scout/dao/image.py b/scout/dao/image.py
@@ -1,4 +1,4 @@
-# Copyright 2023 UW-IT, University of Washington
+# Copyright 2024 UW-IT, University of Washington
 # SPDX-License-Identifier: Apache-2.0
 
 from uw_spotseeker import Spotseeker

diff --git a/scout/dao/item.py b/scout/dao/item.py
@@ -1,4 +1,4 @@
-# Copyright 2023 UW-IT, University of Washington
+# Copyright 2024 UW-IT, University of Washington
 # SPDX-License-Identifier: Apache-2.0
 
 from scout.dao.space import get_spots_by_filter, _get_spot_filters, \

diff --git a/scout/dao/space.py b/scout/dao/space.py
@@ -1,8 +1,9 @@
-# Copyright 2023 UW-IT, University of Washington
+# Copyright 2024 UW-IT, University of Washington
 # SPDX-License-Identifier: Apache-2.0
 
 from django.conf import settings
 from uw_spotseeker import Spotseeker
+from uw_spotseeker.models import Spot
 from restclients_core.exceptions import DataFailureException
 import datetime
 import pytz
@@ -442,7 +443,7 @@ def _get_names_for_extended_info(prefix, mapping, info):
     return names
 
 
-def add_payment_names(spot):
+def add_payment_names(spot) -> Spot:
     PAYMENT_PREFIX = "s_pay"
     PAYMENT_MAPPING = {
         "s_pay_cash": "Cash",

diff --git a/scout/templatetags/scout_filters.py b/scout/templatetags/scout_filters.py
@@ -1,4 +1,4 @@
-# Copyright 2023 UW-IT, University of Washington
+# Copyright 2024 UW-IT, University of Washington
 # SPDX-License-Identifier: Apache-2.0
 
 from django import template

diff --git a/scout/test/__init__.py b/scout/test/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2023 UW-IT, University of Washington
+# Copyright 2024 UW-IT, University of Washington
 # SPDX-License-Identifier: Apache-2.0
 
 from django.test import TestCase

diff --git a/scout/test/dao/test_item_dao.py b/scout/test/dao/test_item_dao.py
@@ -1,4 +1,4 @@
-# Copyright 2023 UW-IT, University of Washington
+# Copyright 2024 UW-IT, University of Washington
 # SPDX-License-Identifier: Apache-2.0
 
 import copy

diff --git a/scout/test/dao/test_space_dao.py b/scout/test/dao/test_space_dao.py
@@ -1,4 +1,4 @@
-# Copyright 2023 UW-IT, University of Washington
+# Copyright 2024 UW-IT, University of Washington
 # SPDX-License-Identifier: Apache-2.0
 
 import datetime

diff --git a/scout/test/pageflow/test_content.py b/scout/test/pageflow/test_content.py
@@ -1,4 +1,4 @@
-# Copyright 2023 UW-IT, University of Washington
+# Copyright 2024 UW-IT, University of Washington
 # SPDX-License-Identifier: Apache-2.0
 
 """

diff --git a/scout/test/pageflow/test_navigation.py b/scout/test/pageflow/test_navigation.py
@@ -1,4 +1,4 @@
-# Copyright 2023 UW-IT, University of Washington
+# Copyright 2024 UW-IT, University of Washington
 # SPDX-License-Identifier: Apache-2.0
 
 """

diff --git a/scout/test/pageflow/test_page_load_status.py b/scout/test/pageflow/test_page_load_status.py
@@ -1,4 +1,4 @@
-# Copyright 2023 UW-IT, University of Washington
+# Copyright 2024 UW-IT, University of Washington
 # SPDX-License-Identifier: Apache-2.0
 
 """

diff --git a/scout/urls.py b/scout/urls.py
@@ -1,4 +1,4 @@
-# Copyright 2023 UW-IT, University of Washington
+# Copyright 2024 UW-IT, University of Washington
 # SPDX-License-Identifier: Apache-2.0
 
 from django.conf import settings

diff --git a/scout/views.py b/scout/views.py
@@ -1,4 +1,4 @@
-# Copyright 2023 UW-IT, University of Washington
+# Copyright 2024 UW-IT, University of Washington
 # SPDX-License-Identifier: Apache-2.0
 
 from django.http import Http404, HttpResponse

diff --git a/scout/wsgi.py b/scout/wsgi.py
@@ -1,4 +1,4 @@
-# Copyright 2023 UW-IT, University of Washington
+# Copyright 2024 UW-IT, University of Washington
 # SPDX-License-Identifier: Apache-2.0
 
 import os