Add [dynamic-yaml] badge

frontend/components/dynamic-badge-maker.js

@@ -42,6 +42,7 @@ export default class DynamicBadgeMaker extends React.Component {
           onChange={event => this.setState({ datatype: event.target.value })}>
           <option value="" disabled>data type</option>
           <option value="json">json</option>
+          <option value="yaml">yaml</option>
           <option value="xml">xml</option>
         </select> {}
         <input

frontend/components/usage.js

@@ -123,6 +123,9 @@ export default class Usage extends React.PureComponent {
         <p>
           <code>/badge/dynamic/json.svg?url=&lt;URL&gt;&amp;label=&lt;LABEL&gt;&amp;query=&lt;<a href="https://www.npmjs.com/package/jsonpath" target="_BLANK" title="JSONdata syntax">$.DATA.SUBDATA</a>&gt;&amp;colorB=&lt;COLOR&gt;&amp;prefix=&lt;PREFIX&gt;&amp;suffix=&lt;SUFFIX&gt;</code>
         </p>
+        <p>
+          <code>/badge/dynamic/yaml.svg?url=&lt;URL&gt;&amp;label=&lt;LABEL&gt;&amp;query=&lt;<a href="https://www.npmjs.com/package/jsonpath" target="_BLANK" title="JSONdata syntax">$.DATA.SUBDATA</a>&gt;&amp;colorB=&lt;COLOR&gt;&amp;prefix=&lt;PREFIX&gt;&amp;suffix=&lt;SUFFIX&gt;</code>
+        </p>
         <p>
           <code>/badge/dynamic/xml.svg?url=&lt;URL&gt;&amp;label=&lt;LABEL&gt;&amp;query=&lt;<a href="https://www.npmjs.com/package/xpath" target="_BLANK" title="XPath syntax">//data/subdata</a>&gt;&amp;colorB=&lt;COLOR&gt;&amp;prefix=&lt;PREFIX&gt;&amp;suffix=&lt;SUFFIX&gt;</code>
         </p>

frontend/lib/badge-url.spec.js

@@ -59,6 +59,28 @@ describe('Badge URL functions', function() {
     ].join(''))
   });
 
+  test(dynamicBadgeUrl, () => {
+    const yamlUrl = 'http://example.com/foo.yaml';
+    const query = '$.bar';
+    const prefix = 'value: ';
+
+    given(
+      'http://img.example.com',
+      'yaml',
+      'foo',
+      yamlUrl,
+      query,
+      { prefix, style: 'plastic' }
+    ).expect([
+      'http://img.example.com/badge/dynamic/yaml.svg',
+      '?label=foo',
+      `&url=${encodeURIComponent(yamlUrl)}`,
+      `&query=${encodeURIComponent(query)}`,
+      `&prefix=${encodeURIComponent(prefix)}`,
+      '&style=plastic',
+    ].join(''))
+  });
+
   test(dynamicBadgeUrl, () => {
     const xmlUrl = 'http://example.com/foo.xml';
     const query = '//bar';

package.json

@@ -28,6 +28,7 @@
     "escape-string-regexp": "^1.0.5",
     "glob": "^7.1.1",
     "gm": "^1.23.0",
+    "js-yaml": "^3.11.0",
     "json-autosave": "~1.1.2",
     "jsonpath": "~1.0.0",
     "lodash.countby": "^4.6.0",

server.js

@@ -10,6 +10,7 @@ const queryString = require('query-string');
 const semver = require('semver');
 const xml2js = require('xml2js');
 const xpath = require('xpath');
+const yaml = require('js-yaml');
 const Raven = require('raven');
 
 const serverSecrets = require('./lib/server-secrets');
@@ -7466,7 +7467,7 @@ camp.route(/^\/maven-metadata\/v\/(https?)\/(.+\.xml)\.(svg|png|gif|jpg|json)$/,
 }));
 
 // User defined sources - JSON response
-camp.route(/^\/badge\/dynamic\/(json|xml)\.(svg|png|gif|jpg|json)$/,
+camp.route(/^\/badge\/dynamic\/(json|xml|yaml)\.(svg|png|gif|jpg|json)$/,
 cache({
   queryParams: ['uri', 'url', 'query', 'prefix', 'suffix'],
   handler: function(query, match, sendBadge, request) {
@@ -7503,6 +7504,13 @@ cache({
           }
         };
         break;
+      case 'yaml':
+        requestOptions = {
+          headers: {
+            Accept: 'application/yaml, text/yaml, text/plain'
+          }
+        };
+        break;
     }
 
     request(url, requestOptions, (err, res, data) => {
@@ -7533,6 +7541,14 @@ cache({
               innerText.push(pathExpression.indexOf('@') + 1 ? i.value : i.firstChild.data);
             });
             break;
+          case 'yaml':
+            data = yaml.safeLoad(data);
+            data = jp.query(data, pathExpression);
+            if (!data.length) {
+              throw 'no result';
+            }
+            innerText = data;
+            break;
         }
         badgeData.text[1] = (prefix || '') + innerText.join(', ') + (suffix || '');
       } catch (e) {

services/yaml/yaml.tester.js

@@ -0,0 +1,70 @@
+'use strict';
+
+const Joi = require('joi');
+const ServiceTester = require('../service-tester');
+const colorscheme = require('../../lib/colorscheme.json');
+const mapValues = require('lodash.mapvalues');
+
+const colorsB = mapValues(colorscheme, 'colorB');
+
+const t = new ServiceTester({ id: 'dynamic-yaml', title: 'User Defined YAML Source Data', pathPrefix: '/badge/dynamic/yaml' });
+module.exports = t;
+
+t.create('Connection error')
+  .get('.json?url=https://github.com/badges/shields/raw/master/package.json&query=$.name&label=Package Name&style=_shields_test')
+  .networkOff()
+  .expectJSON({ name: 'Package Name', value: 'inaccessible', colorB: colorsB.red });
+
+t.create('No URL specified')
+  .get('.json?query=$.name&label=Package Name&style=_shields_test')
+  .expectJSON({ name: 'Package Name', value: 'no url specified', colorB: colorsB.red });
+
+t.create('No query specified')
+  .get('.json?url=https://raw.githubusercontent.com/kubernetes/charts/568291d6e476c39ca8322c30c3f601d0383d4760/stable/coredns/Chart.yaml&label=Package Name&style=_shields_test')
+  .expectJSON({ name: 'Package Name', value: 'no query specified', colorB: colorsB.red });
+
+t.create('YAML from url')
+  .get('.json?url=https://raw.githubusercontent.com/kubernetes/charts/568291d6e476c39ca8322c30c3f601d0383d4760/stable/coredns/Chart.yaml&query=$.name&style=_shields_test')
+  .expectJSON({ name: 'custom badge', value: 'coredns', colorB: colorsB.brightgreen });
+
+t.create('YAML from uri (support uri query paramater)')
+  .get('.json?uri=https://raw.githubusercontent.com/kubernetes/charts/568291d6e476c39ca8322c30c3f601d0383d4760/stable/coredns/Chart.yaml&query=$.name&style=_shields_test')
+  .expectJSON({ name: 'custom badge', value: 'coredns', colorB: colorsB.brightgreen });
+
+t.create('YAML from url | multiple results')
+  .get('.json?url=https://raw.githubusercontent.com/kubernetes/charts/568291d6e476c39ca8322c30c3f601d0383d4760/stable/coredns/Chart.yaml&query=$..keywords[0:2:1]')
+  .expectJSON({ name: 'custom badge', value: 'coredns, dns' });
+
+t.create('YAML from url | caching with new query params')
+  .get('.json?url=https://raw.githubusercontent.com/kubernetes/charts/568291d6e476c39ca8322c30c3f601d0383d4760/stable/coredns/Chart.yaml&query=$.version')
+  .expectJSONTypes(Joi.object().keys({
+    name: 'custom badge',
+    value: Joi.string().regex(/^\d+(\.\d+)?(\.\d+)?$/)
+  }));
+
+t.create('YAML from url | with prefix & suffix & label')
+  .get('.json?url=https://raw.githubusercontent.com/kubernetes/charts/568291d6e476c39ca8322c30c3f601d0383d4760/stable/coredns/Chart.yaml&query=$.version&prefix=v&suffix= dev&label=Shields')
+  .expectJSONTypes(Joi.object().keys({
+    name: 'Shields',
+    value: Joi.string().regex(/^v\d+(\.\d+)?(\.\d+)?\sdev$/)
+  }));
+
+t.create('YAML from url | object doesnt exist')
+  .get('.json?url=https://raw.githubusercontent.com/kubernetes/charts/568291d6e476c39ca8322c30c3f601d0383d4760/stable/coredns/Chart.yaml&query=$.does_not_exist&style=_shields_test')
+  .expectJSON({ name: 'custom badge', value: 'no result', colorB: colorsB.lightgrey });
+
+t.create('YAML from url | invalid url')
+  .get('.json?url=https://raw.githubusercontent.com/kubernetes/charts/568291d6e476c39ca8322c30c3f601d0383d4760/stable/coredns/notafile.yaml&query=$.version&style=_shields_test')
+  .expectJSON({ name: 'custom badge', value: 'resource not found', colorB: colorsB.lightgrey });
+
+t.create('YAML from url | user color overrides default')
+  .get('.json?url=https://raw.githubusercontent.com/kubernetes/charts/568291d6e476c39ca8322c30c3f601d0383d4760/stable/coredns/Chart.yaml&query=$.name&colorB=10ADED&style=_shields_test')
+  .expectJSON({ name: 'custom badge', value: 'coredns', colorB: '#10ADED' });
+
+t.create('YAML from url | error color overrides default')
+  .get('.json?url=https://raw.githubusercontent.com/kubernetes/charts/568291d6e476c39ca8322c30c3f601d0383d4760/stable/coredns/notafile.yaml&query=$.version&style=_shields_test')
+  .expectJSON({ name: 'custom badge', value: 'resource not found', colorB: colorsB.lightgrey });
+
+t.create('YAML from url | error color overrides user specified')
+  .get('.json?query=$.version&colorB=10ADED&style=_shields_test')
+  .expectJSON({ name: 'custom badge', value: 'no url specified', colorB: colorsB.red });