From 670cdef79c39262fa0844a91777b8c69751bab01 Mon Sep 17 00:00:00 2001 From: Jessica Tallon Date: Thu, 2 Oct 2014 20:28:58 +0100 Subject: [PATCH] Fix typo in client registration API for logo_uri --- docs/source/api/client_register.rst | 11 +++++------ mediagoblin/oauth/views.py | 8 ++++---- mediagoblin/tests/test_oauth1.py | 8 ++++---- 3 files changed, 13 insertions(+), 14 deletions(-) diff --git a/docs/source/api/client_register.rst b/docs/source/api/client_register.rst index 08f92c47..9c29bafc 100644 --- a/docs/source/api/client_register.rst +++ b/docs/source/api/client_register.rst @@ -15,7 +15,7 @@ Registering a Client ==================== -To use the GNU MediaGoblin API you need to use the dynamic client registration. This has been adapted from the `OpenID specification `_, this is the only part of OpenID that is being used to serve the purpose to provide the client registration which is used in OAuth. +To use the GNU MediaGoblin API you need to use the dynamic client registration. This has been adapted from the `OpenID specification `_, this is the only part of OpenID that is being used to serve the purpose to provide the client registration which is used in OAuth. The endpoint is ``/api/client/register`` @@ -39,8 +39,8 @@ application_type application_name **optional** - This is the name of your client -logo_url - **optional** - This is a URL of the logo image for your client +logo_uri + **optional** - This is a URI of the logo image for your client redirect_uri **optional** - This is a space seporated list of pre-registered URLs for use at the Authorization Server @@ -93,8 +93,8 @@ Using the response we got above we can update the information and add new inform "client_id": "vwljdhUMhhNbdKizpjZlxv", "client_secret": "hJtfhaQzgKerlLVdaeRAgmbcstSOBLRfgOinMxBCHcb", "application_type": "web", - "application_name": "MyClient!", - "logo_url": "https://myclient.org/images/my_logo.png", + "application_name": "MyClient!", + "logo_uri": "https://myclient.org/images/my_logo.png", "contacts": "myemail@someprovider.com another_developer@provider.net", } @@ -155,4 +155,3 @@ redirect_uris must be space-separated URLs. URI is not a valid URI This is when your URI is invalid. - diff --git a/mediagoblin/oauth/views.py b/mediagoblin/oauth/views.py index 910df957..1b7c789a 100644 --- a/mediagoblin/oauth/views.py +++ b/mediagoblin/oauth/views.py @@ -125,15 +125,15 @@ def client_register(request): error = "Invalid registration type" return json_response({"error": error}, status=400) - logo_url = data.get("logo_url", client.logo_url) - if logo_url is not None and not validate_url(logo_url): - error = "Logo URL {0} is not a valid URL.".format(logo_url) + logo_uri = data.get("logo_uri", client.logo_url) + if logo_uri is not None and not validate_url(logo_uri): + error = "Logo URI {0} is not a valid URI.".format(logo_uri) return json_response( {"error": error}, status=400 ) else: - client.logo_url = logo_url + client.logo_url = logo_uri client.application_name = data.get("application_name", None) diff --git a/mediagoblin/tests/test_oauth1.py b/mediagoblin/tests/test_oauth1.py index 9a5e332b..e41a68c7 100644 --- a/mediagoblin/tests/test_oauth1.py +++ b/mediagoblin/tests/test_oauth1.py @@ -72,7 +72,7 @@ class TestOAuth(object): "application_name": "Testificate MD", "application_type": "web", "contacts": "someone@someplace.com tuteo@tsengeo.lu", - "logo_url": "http://ayrel.com/utral.png", + "logo_uri": "http://ayrel.com/utral.png", "redirect_uris": "http://navi-kosman.lu http://gmg-yawne-oeru.lu", } @@ -85,7 +85,7 @@ class TestOAuth(object): assert client.secret == client_info["client_secret"] assert client.application_type == query["application_type"] assert client.redirect_uri == query["redirect_uris"].split() - assert client.logo_url == query["logo_url"] + assert client.logo_url == query["logo_uri"] assert client.contacts == query["contacts"].split() @@ -102,7 +102,7 @@ class TestOAuth(object): "type": "client_update", "application_name": "neytiri", "contacts": "someone@someplace.com abc@cba.com", - "logo_url": "http://place.com/picture.png", + "logo_uri": "http://place.com/picture.png", "application_type": "web", "redirect_uris": "http://blah.gmg/whatever https://inboxen.org/", } @@ -117,7 +117,7 @@ class TestOAuth(object): assert client.application_type == update_query["application_type"] assert client.application_name == update_query["application_name"] assert client.contacts == update_query["contacts"].split() - assert client.logo_url == update_query["logo_url"] + assert client.logo_url == update_query["logo_uri"] assert client.redirect_uri == update_query["redirect_uris"].split() def to_authorize_headers(self, data): -- 2.25.1