Adding eBay as a service provider for "Login with eBay"

[kareemassad]

Hello!

I was wondering if there was any interest in implementing "Login with eBay"? I am currently working on a project in Django that it would be nice to have for it. If there is interest, I would be happy to implement it within the library myself but would need some guidance as this would be my first open-source project

Thank you!

[pennersr]

Feel free to submit a PR to add eBay support. Given that it seems to be just a regular OAuth2 provider, you could copy e.g. allauth/socialaccount/providers/auth0 to allauth/socialaccount/providers/ebay, and start renaming the classes (e.g. Auth0Provider to EBayProvider). Then, you'll need to revisit URLs like access_token_url in views.py. Also, please apply this checklist:

• Make sure unit tests are available.
• Add an entry of your provider in test_settings.py::INSTALLED_APPS and docs/installation.rst::INSTALLED_APPS.
• Add documentation to docs/providers/<provider name>.rst and docs/providers/index.rst Provider Specifics toctree.
• Add an entry to the list of supported providers over at docs/overview.rst.

[kareemassad]

Thank you for the reply. I started work on it here: #3483

I was wondering if there was a standard on how to handle both Production and Sandbox environments? This is what I have so far within the view.py.

class EBayOAuth2Adapter(OAuth2Adapter):
    provider_id = EBayProvider.id
    production_access_token_url = "https://api.ebay.com/identity/v1/oauth2/token"
    sandbox_access_token_url = "https://api.sandbox.ebay.com/identity/v1/oauth2/token"
    production_authorize_url = "https://auth.ebay.com/oauth2/authorize"
    sandbox_authorize_url = "https://auth.sandbox.ebay.com/oauth2/authorize"

    grant_type = "authorization_code"
    scope = ["https://api.ebay.com/oauth/api_scope"]

    supports_state = False

    def complete_login(self, request, app, token, **kwargs):
        headers = {
            "Authorization": f"Bearer {token.token}",
            "Content-Type": "application/json",
            "Accept": "application/json",
        }
        resp = requests.get("https://api.ebay.com/oauth/api_scope", headers=headers)

        resp.raise_for_status()
        data = resp.json()
        return self.get_provider().sociallogin_from_response(request, data)

    def get_access_token_url(self, request, app):
        return (
            self.production_access_token_url
            if app.sandbox
            else self.sandbox_access_token_url
        )

    def get_authorize_url(self, request, app):
        return (
            self.production_authorize_url
            if not app.sandbox
            else self.sandbox_authorize_url
        )


oauth2_login = OAuth2LoginView.adapter_view(EBayOAuth2Adapter)
oauth2_callback = OAuth2CallbackView.adapter_view(EBayOAuth2Adapter)

Is this an okay way to check the application environment? I am unfamiliar with how this should be setup as typically this information would be tucked away within the settings.py.

# settings.py

EBAY_CLIENT_ID = 'your-ebay-client-id'
EBAY_CLIENT_SECRET = 'your-ebay-client-secret'
EBAY_PRODUCTION_ACCESS_TOKEN_URL = 'https://api.ebay.com/identity/v1/oauth2/token'
EBAY_SANDBOX_ACCESS_TOKEN_URL = 'https://api.sandbox.ebay.com/identity/v1/oauth2/token'
EBAY_AUTHORIZE_URL = 'your-ebay-authorize-url'
EBAY_API_ENVIRONMENT = 'sandbox'  # or 'production'

[kareemassad]

Update: I went through some of the other examples of implemented providers and found this style of doing this:

ENVIRONMENTS = {
    "production": {
        "auth_url": "https://auth.ebay.com/oauth2/authorize",
        "token_url": "https://api.ebay.com/identity/v1/oauth2/token",
    },
    "sandbox": {
        "auth_url": "https://auth.sandbox.ebay.com/oauth2/authorize",
        "token_url": "https://api.sandbox.ebay.com/identity/v1/oauth2/token",
    },
}

Is this the preferred way?

[pennersr]

That is answered here: #3483 (comment)