Mail

venv/lib/python3.12/site-packages/allauth/socialaccount/providers/mailchimp/provider.py

@@ -0,0 +1,48 @@
+"""Customise Provider classes for MailChimp API v3."""
+from allauth.socialaccount.providers.base import ProviderAccount
+from allauth.socialaccount.providers.oauth2.provider import OAuth2Provider
+
+
+class MailChimpAccount(ProviderAccount):
+
+    """ProviderAccount subclass for MailChimp."""
+
+    def get_profile_url(self):
+        """Return base profile url."""
+        return self.account.extra_data["api_endpoint"]
+
+    def get_avatar_url(self):
+        """Return avatar url."""
+        return self.account.extra_data["login"]["avatar"]
+
+
+class MailChimpProvider(OAuth2Provider):
+
+    """OAuth2Provider subclass for MailChimp v3."""
+
+    id = "mailchimp"
+    name = "MailChimp"
+    account_class = MailChimpAccount
+
+    def extract_uid(self, data):
+        """Extract uid ('user_id') and ensure it's a str."""
+        return str(data["user_id"])
+
+    def get_default_scope(self):
+        """Ensure scope is null to fit their API."""
+        return [""]
+
+    def extract_common_fields(self, data):
+        """Extract fields from a metadata query."""
+        return dict(
+            dc=data.get("dc"),
+            role=data.get("role"),
+            account_name=data.get("accountname"),
+            user_id=data.get("user_id"),
+            login=data.get("login"),
+            login_url=data.get("login_url"),
+            api_endpoint=data.get("api_endpoint"),
+        )
+
+
+provider_classes = [MailChimpProvider]

venv/lib/python3.12/site-packages/allauth/socialaccount/providers/mailchimp/tests.py

@@ -0,0 +1,33 @@
+"""Test MailChimp OAuth2 v3 Flow."""
+from allauth.socialaccount.tests import OAuth2TestsMixin
+from allauth.tests import MockedResponse, TestCase
+
+from .provider import MailChimpProvider
+
+
+class MailChimpTests(OAuth2TestsMixin, TestCase):
+
+    """Test Class for MailChimp OAuth2 v3."""
+
+    provider_id = MailChimpProvider.id
+
+    def get_mocked_response(self):
+        """Test authentication with an non-null avatar."""
+        return MockedResponse(
+            200,
+            """{
+            "dc": "usX",
+            "role": "owner",
+            "accountname": "Name can have spaces",
+            "user_id": "99999999",
+            "login": {
+                "email": "test@example.com",
+                "avatar": "http://gallery.mailchimp.com/1a1a/avatar/2a2a.png",
+                "login_id": "88888888",
+                "login_name": "test@example.com",
+                "login_email": "test@example.com"
+            },
+            "login_url": "https://login.mailchimp.com",
+            "api_endpoint": "https://usX.api.mailchimp.com"
+        }""",
+        )

venv/lib/python3.12/site-packages/allauth/socialaccount/providers/mailchimp/urls.py

@@ -0,0 +1,7 @@
+"""Register urls for MailChimpProvider"""
+from allauth.socialaccount.providers.oauth2.urls import default_urlpatterns
+
+from .provider import MailChimpProvider
+
+
+urlpatterns = default_urlpatterns(MailChimpProvider)

venv/lib/python3.12/site-packages/allauth/socialaccount/providers/mailchimp/views.py

@@ -0,0 +1,32 @@
+"""Views for MailChimp API v3."""
+import requests
+
+from allauth.socialaccount.providers.oauth2.views import (
+    OAuth2Adapter,
+    OAuth2CallbackView,
+    OAuth2LoginView,
+)
+
+from .provider import MailChimpProvider
+
+
+class MailChimpOAuth2Adapter(OAuth2Adapter):
+
+    """OAuth2Adapter for MailChimp API v3."""
+
+    provider_id = MailChimpProvider.id
+
+    authorize_url = "https://login.mailchimp.com/oauth2/authorize"
+    access_token_url = "https://login.mailchimp.com/oauth2/token"
+    profile_url = "https://login.mailchimp.com/oauth2/metadata"
+
+    def complete_login(self, request, app, token, **kwargs):
+        """Complete login, ensuring correct OAuth header."""
+        headers = {"Authorization": "OAuth {0}".format(token.token)}
+        metadata = requests.get(self.profile_url, headers=headers)
+        extra_data = metadata.json()
+        return self.get_provider().sociallogin_from_response(request, extra_data)
+
+
+oauth2_login = OAuth2LoginView.adapter_view(MailChimpOAuth2Adapter)
+oauth2_callback = OAuth2CallbackView.adapter_view(MailChimpOAuth2Adapter)