Merge pull request #359 from HackSoftware/google-oauth

Blog example for Google OAuth2 with Django

Author: RadoRado

.env.example

@@ -9,3 +9,7 @@ AWS_S3_SECRET_ACCESS_KEY=""
 AWS_STORAGE_BUCKET_NAME=""
 AWS_S3_REGION_NAME=""
 AWS_S3_CUSTOM_DOMAIN=""
+
+DJANGO_GOOGLE_OAUTH2_CLIENT_ID=""
+DJANGO_GOOGLE_OAUTH2_CLIENT_SECRET=""
+DJANGO_GOOGLE_OAUTH2_PROJECT_ID=""

.gitignore

@@ -134,3 +134,5 @@ dmypy.json
 
 node_modules/
 package*.json
+
+google_client_secret.json

config/django/base.py

@@ -27,7 +27,6 @@
 
 ALLOWED_HOSTS = ["*"]
 
-
 # Application definition
 
 LOCAL_APPS = [
@@ -99,7 +98,6 @@
 
 WSGI_APPLICATION = "config.wsgi.application"
 
-
 # Database
 # https://docs.djangoproject.com/en/3.0/ref/settings/#databases
 
@@ -120,7 +118,6 @@
         }
     }
 
-
 # Password validation
 # https://docs.djangoproject.com/en/3.0/ref/settings/#auth-password-validators
 
@@ -141,7 +138,6 @@
 
 AUTH_USER_MODEL = "users.BaseUser"
 
-
 # Internationalization
 # https://docs.djangoproject.com/en/3.0/topics/i18n/
 
@@ -155,7 +151,6 @@
 
 USE_TZ = True
 
-
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/3.0/howto/static-files/
 
@@ -178,6 +173,7 @@
 from config.settings.cors import *  # noqa
 from config.settings.email_sending import *  # noqa
 from config.settings.files_and_storages import *  # noqa
+from config.settings.google_oauth2 import *  # noqa
 from config.settings.jwt import *  # noqa
 from config.settings.sentry import *  # noqa
 from config.settings.sessions import *  # noqa

config/settings/cors.py

@@ -1,2 +1,8 @@
+from config.env import env
+
 CORS_ALLOW_CREDENTIALS = True
 CORS_ALLOW_ALL_ORIGINS = True
+
+BASE_BACKEND_URL = env.str("DJANGO_BASE_BACKEND_URL", default="http://localhost:8000")
+BASE_FRONTEND_URL = env.str("DJANGO_BASE_FRONTEND_URL", default="http://localhost:3000")
+CORS_ORIGIN_WHITELIST = env.list("DJANGO_CORS_ORIGIN_WHITELIST", default=[BASE_FRONTEND_URL])

config/settings/google_oauth2.py

@@ -0,0 +1,5 @@
+from config.env import env
+
+GOOGLE_OAUTH2_CLIENT_ID = env.str("DJANGO_GOOGLE_OAUTH2_CLIENT_ID", default="")
+GOOGLE_OAUTH2_CLIENT_SECRET = env.str("DJANGO_GOOGLE_OAUTH2_CLIENT_SECRET", default="")
+GOOGLE_OAUTH2_PROJECT_ID = env.str("DJANGO_GOOGLE_OAUTH2_PROJECT_ID", default="")

mypy.ini

@@ -33,3 +33,11 @@ ignore_missing_imports = True
 [mypy-rest_framework_jwt.*]
 # Remove this when rest_framework_jwt stubs are present
 ignore_missing_imports = True
+
+[mypy-google_auth_oauthlib.*]
+# Remove this when google_auth_oauthlib stubs are present
+ignore_missing_imports = True
+
+[mypy-oauthlib.*]
+# Remove this when oauthlib stubs are present
+ignore_missing_imports = True

requirements/base.txt

@@ -21,3 +21,10 @@ attrs==22.1.0
 
 gunicorn==20.1.0
 sentry-sdk==1.14.0
+
+requests==2.30.0
+
+google-api-python-client==2.86.0
+google-auth==2.18.0
+google-auth-httplib2==0.1.0
+google-auth-oauthlib==1.0.0

styleguide_example/api/urls.py

@@ -5,4 +5,7 @@
     path("users/", include(("styleguide_example.users.urls", "users"))),
     path("errors/", include(("styleguide_example.errors.urls", "errors"))),
     path("files/", include(("styleguide_example.files.urls", "files"))),
+    path(
+        "google-oauth2/", include(("styleguide_example.blog_examples.google_login_server_flow.urls", "google-oauth2"))
+    ),
 ]