Fix typo in client registration API for logo_uri
authorJessica Tallon <jessica@megworld.co.uk>
Thu, 2 Oct 2014 19:28:58 +0000 (20:28 +0100)
committerJessica Tallon <jessica@megworld.co.uk>
Thu, 2 Oct 2014 19:34:25 +0000 (20:34 +0100)
docs/source/api/client_register.rst
mediagoblin/oauth/views.py
mediagoblin/tests/test_oauth1.py

index 08f92c4797a8b4c073bd109bf627059db02fa696..9c29bafcf36c3c3b4ddd096679e02eb95c3177fb 100644 (file)
@@ -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 <https://openid.net/specs/openid-connect-registration-1_0.html>`_, 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 <https://openid.net/specs/openid-connect-registration-1_0.html>`_, 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 <URI> is not a valid URI
     This is when your URI is invalid.
 
index 910df95737266f7629ada32be2f6c754a03808db..1b7c789aa75a6e9b18ae1e9d2c370fe4560c5596 100644 (file)
@@ -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)
 
index 9a5e332b5b6d5cc74ebb1ce35248dacb5cd07cdd..e41a68c71db35fcd7f2bee82d04b0b70324bb2a2 100644 (file)
@@ -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):