Merge pull request #5 from cookiecutter-openedx/version-bump

Add changelog and bump pyproject version

.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: lpm0073
+patreon: lpm0073

CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGE LOG
 
+## Version 1.0.8 (2024-02-01)
+
+- add support for UPDATE_USER_ON_LOGIN flag
+
+## Version 1.0.7 (2023-08-12)
+
+- match version requirements in pyproject.toml to those in requirements/stable-psa.txt
+
 ## Version 1.0.6 (2022-12-20)
 
 - standardize usage of python3 in Makefile

oauth2_wordpress/__about__.py

@@ -1 +1 @@
-__version__ = "1.0.6"
+__version__ = "1.0.8"

oauth2_wordpress/wp_oauth.py

@@ -110,6 +110,9 @@ class WPOpenEdxOAuth2(BaseOAuth2):
     # changed to a list. example 'basic, email, profile'. This
     # list can be delimited with commas, spaces, whatever.
     SCOPE_SEPARATOR = " "
+    
+    # Enable updates on the Django user object on successful WordPress login.
+    UPDATE_USER_ON_LOGIN = True
 
     # private utility function. not part of psa.
     def _urlopen(self, url):
@@ -409,28 +412,28 @@ class WPOpenEdxOAuth2(BaseOAuth2):
         except User.DoesNotExist:
             return self.user_details
 
-        if (user.is_superuser != self.user_details["is_superuser"]) or (
-            user.is_staff != self.user_details["is_staff"]
-        ):
-            user.is_superuser = self.user_details["is_superuser"]
-            user.is_staff = self.user_details["is_staff"]
-            user.save()
-            logger.info(
-                "Updated the is_superuser/is_staff flags for user {username}".format(
-                    username=user.username
+        if self.UPDATE_USER_ON_LOGIN:
+            if (user.is_superuser != self.user_details["is_superuser"]) or (
+                user.is_staff != self.user_details["is_staff"]
+            ):
+                user.is_superuser = self.user_details["is_superuser"]
+                user.is_staff = self.user_details["is_staff"]
+                user.save()
+                logger.info(
+                    "Updated the is_superuser/is_staff flags for user {username}".format(
+                        username=user.username
+                    )
                 )
-            )
-
-        if (user.first_name != self.user_details["first_name"]) or (
-            user.last_name != self.user_details["last_name"]
-        ):
-            user.first_name = self.user_details["first_name"]
-            user.last_name = self.user_details["last_name"]
-            user.save()
-            logger.info(
-                "Updated first_name/last_name for user {username}".format(
-                    username=user.username
+            if (user.first_name != self.user_details["first_name"]) or (
+                user.last_name != self.user_details["last_name"]
+            ):
+                user.first_name = self.user_details["first_name"]
+                user.last_name = self.user_details["last_name"]
+                user.save()
+                logger.info(
+                    "Updated first_name/last_name for user {username}".format(
+                        username=user.username
+                    )
                 )
-            )
 
         return self.user_details

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta:__legacy__"
 
 [project]
 name = "edx-oauth2-wordpress-backend"
-version = "1.0.6"
+version = "1.0.8"
 authors = [
   { name="Lawrence McDaniel", email="lpm0073@gmail.com" },
 ]
@@ -17,7 +17,7 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 dependencies = [
-  "social-auth-core>=4.2.0",
+  "social-auth-core==4.3.0",
   "social-auth-app-django==5.0.0"
 ]
 keywords = ["Open edX", "oauth", "Wordpress"]