Add a config variable to add a link to whatsdeployed in contribute.json

README.rst

@@ -50,15 +50,17 @@ database services to configure.
 
 However you can configure the following parameters using environment variables:
 
-+-----------------------+-------------------------------------------------+
-| **VARIABLE**          | **Description**                                 |
-+-----------------------+-------------------------------------------------+
-| ``PORT``              | The service PORT, by default runs on 9876       |
-+-----------------------+-------------------------------------------------+
-| ``VERSION_FILE``      | The JSON version file, default PWD/version.json |
-+-----------------------+-------------------------------------------------+
-| ``CACHE_MAX_AGE``     | The Cache-Control max-age value, default to 30  |
-|                       | seconds. Set it to 0 to set it to no-cache      |
-+-----------------------+-------------------------------------------------+
-| ``TELEMETRY_API_KEY`` | API KEY to use to query the Telemetry Service   |
-+-----------------------+-------------------------------------------------+
++-----------------------+--------------------------------------------------+
+| **VARIABLE**          | **Description**                                  |
++-----------------------+--------------------------------------------------+
+| ``PORT``              | The service PORT, by default runs on 9876        |
++-----------------------+--------------------------------------------------+
+| ``VERSION_FILE``      | The JSON version file, default PWD/version.json  |
++-----------------------+--------------------------------------------------+
+| ``CACHE_MAX_AGE``     | The Cache-Control max-age value, default to 30   |
+|                       | seconds. Set it to 0 to set it to no-cache       |
++-----------------------+--------------------------------------------------+
+| ``TELEMETRY_API_KEY`` | API KEY to use to query the Telemetry Service    |
++-----------------------+--------------------------------------------------+
+| ``WHATSDEPLOYED_URL`` | Short URL link to https://whatsdeployed.io/s-9sl |
++-----------------------+--------------------------------------------------+

pollbot/views/utilities.py

@@ -23,9 +23,10 @@ async def version(request):
     return web.HTTPNotFound()
 
 
-def render_yaml_file(filename):
+def render_yaml_file(filename, **options):
     with open(os.path.join(HERE, "..", filename)) as stream:
         content = yaml.safe_load(stream)
+    content.update(options)
     return web.json_response(content)
 
 
@@ -34,7 +35,11 @@ async def oas_spec(request):
 
 
 async def contribute_json(request):
-    return render_yaml_file("contribute.yaml")
+    settings = {}
+    whatsdeployed_url = os.getenv('WHATSDEPLOYED_URL')
+    if whatsdeployed_url:
+        settings['whatsdeployed'] = whatsdeployed_url
+    return render_yaml_file("contribute.yaml", **settings)
 
 
 async def contribute_redirect(request):

tests/test_views.py

@@ -61,9 +61,10 @@ async def test_redirects_trailing_slashes(cli):
     assert resp.headers['Location'] == "/v1/firefox/54.0"
 
 
-async def check_yaml_resource(cli, url, filename):
+async def check_yaml_resource(cli, url, filename, **options):
     with open(os.path.join(HERE, "..", "pollbot", filename)) as stream:
         content = yaml.safe_load(stream)
+    content.update(options)
     resp = await cli.get(url)
     assert await resp.json() == content
 
@@ -77,6 +78,16 @@ async def test_contribute_redirect(cli):
     assert resp.headers['Location'] == "/v1/contribute.json"
 
 
+async def test_contribute_json_with_whatsdeployed_url(cli):
+    whatsdeployed_url = ' https://whatsdeployed.io/s-9sl'
+    os.environ['WHATSDEPLOYED_URL'] = whatsdeployed_url
+    try:
+        await check_yaml_resource(cli, "/v1/contribute.json", "contribute.yaml",
+                                  whatsdeployed=whatsdeployed_url)
+    finally:
+        del os.environ['WHATSDEPLOYED_URL']
+
+
 async def test_contribute_json(cli):
     await check_yaml_resource(cli, "/v1/contribute.json", "contribute.yaml")