From: Matías Aguirre Date: Fri, 26 Aug 2011 02:54:21 +0000 (-0300) Subject: Rename GOOGLE_OAUTH2_CLIENT_KEY to GOOGLE_OAUTH2_CLIENT_ID, keep backward compatibili... X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=8e3166c62d07e881ee6db45d1d45429d43abb59e;p=django-social-auth.git Rename GOOGLE_OAUTH2_CLIENT_KEY to GOOGLE_OAUTH2_CLIENT_ID, keep backward compatibility name. Closes gh-133 --- diff --git a/README.rst b/README.rst index 5017de1..3feeeac 100644 --- a/README.rst +++ b/README.rst @@ -148,7 +148,7 @@ Configuration ORKUT_CONSUMER_SECRET = '' GOOGLE_CONSUMER_KEY = '' GOOGLE_CONSUMER_SECRET = '' - GOOGLE_OAUTH2_CLIENT_KEY = '' + GOOGLE_OAUTH2_CLIENT_ID = '' GOOGLE_OAUTH2_CLIENT_SECRET = '' FOURSQUARE_CONSUMER_KEY = '' FOURSQUARE_CONSUMER_SECRET = '' @@ -512,12 +512,11 @@ To enable OAuth2 support: - fill ``Client ID`` and ``Client Secret`` settings, these values can be obtained easily as described on `OAuth2 Registering`_ doc:: - GOOGLE_OAUTH2_CLIENT_KEY = '' + GOOGLE_OAUTH2_CLIENT_ID = '' GOOGLE_OAUTH2_CLIENT_SECRET = '' - Take into account that ``GOOGLE_OAUTH2_CLIENT_KEY`` is the value referred as - ``Client ID`` on Google's doc, but ``django-social-auth`` uses ``*_KEY`` - terminology on all backends to keep it consistent. + previous name ``GOOGLE_OAUTH2_CLIENT_KEY`` is supported for backward + compatibility. - scopes are shared between OAuth mechanisms:: diff --git a/doc/backends/google.rst b/doc/backends/google.rst index eafd856..c3cbcfd 100644 --- a/doc/backends/google.rst +++ b/doc/backends/google.rst @@ -52,12 +52,11 @@ To enable OAuth2 support: - fill ``Client ID`` and ``Client Secret`` settings, these values can be obtained easily as described on `OAuth2 Registering`_ doc:: - GOOGLE_OAUTH2_CLIENT_KEY = '' + GOOGLE_OAUTH2_CLIENT_ID = '' GOOGLE_OAUTH2_CLIENT_SECRET = '' - Take into account that ``GOOGLE_OAUTH2_CLIENT_KEY`` is the value referred as - ``Client ID`` on Google's doc, but ``django-social-auth`` uses ``*_KEY`` - terminology on all backends to keep it consistent. + previous name ``GOOGLE_OAUTH2_CLIENT_KEY`` is supported for backward + compatibility. - scopes are shared between OAuth mechanisms:: diff --git a/doc/configuration.rst b/doc/configuration.rst index 4c2cc1f..7ed85fb 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -55,7 +55,7 @@ Configuration ORKUT_CONSUMER_SECRET = '' GOOGLE_CONSUMER_KEY = '' GOOGLE_CONSUMER_SECRET = '' - GOOGLE_OAUTH2_CLIENT_KEY = '' + GOOGLE_OAUTH2_CLIENT_ID = '' GOOGLE_OAUTH2_CLIENT_SECRET = '' FOURSQUARE_CONSUMER_KEY = '' FOURSQUARE_CONSUMER_SECRET = '' diff --git a/example/local_settings.py.template b/example/local_settings.py.template index 8b52a3b..6e733b4 100644 --- a/example/local_settings.py.template +++ b/example/local_settings.py.template @@ -6,7 +6,7 @@ LINKEDIN_CONSUMER_KEY = '' LINKEDIN_CONSUMER_SECRET = '' ORKUT_CONSUMER_KEY = '' ORKUT_CONSUMER_SECRET = '' -GOOGLE_OAUTH2_CLIENT_KEY = '' +GOOGLE_OAUTH2_CLIENT_ID = '' GOOGLE_OAUTH2_CLIENT_SECRET = '' SOCIAL_AUTH_CREATE_USERS = True SOCIAL_AUTH_FORCE_RANDOM_USERNAME = False @@ -16,4 +16,6 @@ LOGIN_ERROR_URL = '/login/error/' #SOCIAL_AUTH_USER_MODEL = 'app.CustomUser' SOCIAL_AUTH_ERROR_KEY = 'socialauth_error' GITHUB_APP_ID = '' -GITHUB_API_SECRET = '' \ No newline at end of file +GITHUB_API_SECRET = '' +FOURSQUARE_CONSUMER_KEY = '' +FOURSQUARE_CONSUMER_SECRET = '' diff --git a/social_auth/backends/google.py b/social_auth/backends/google.py index 9550121..52f701f 100644 --- a/social_auth/backends/google.py +++ b/social_auth/backends/google.py @@ -141,12 +141,18 @@ class GoogleOAuth(BaseGoogleOAuth): return True +# TODO: Remove this setting name check, keep for backward compatibility +_OAUTH2_KEY_NAME = hasattr(settings, 'GOOGLE_OAUTH2_CLIENT_ID') and \ + 'GOOGLE_OAUTH2_CLIENT_ID' or \ + 'GOOGLE_OAUTH2_CLIENT_KEY' + + class GoogleOAuth2(BaseOAuth2): """Google OAuth2 support""" AUTH_BACKEND = GoogleOAuth2Backend AUTHORIZATION_URL = 'https://accounts.google.com/o/oauth2/auth' ACCESS_TOKEN_URL = 'https://accounts.google.com/o/oauth2/token' - SETTINGS_KEY_NAME = 'GOOGLE_OAUTH2_CLIENT_KEY' + SETTINGS_KEY_NAME = _OAUTH2_KEY_NAME SETTINGS_SECRET_NAME = 'GOOGLE_OAUTH2_CLIENT_SECRET' def get_scope(self):