User defined XML source badge [dynamic-xml dynamic-json] #1494

RedSparr0w · 2018-02-12T04:03:02Z

Continuation of #820

Description:

This PR Adds XML support to the dynamic badges.
Other:
added a test for query param specified
changed uri param to url (uri still supported)

To do:

Add tests
Add support for multiple results
Update front end dynamic badge generator

Examples:

All examples based on this XML

`?query=` param	badge
`/addon/name`
`/addon/@id`
`//version`
`/addon/reviews/@num`
`//daily_users`

Usage:

`?a=b` params	Usage	Example
`uri` (required)	Address where json is located	`uri=http://path.to.json`
`query` (required)	JSONpath expression	`query=$.version`
`label`	Left hand side text	`label=ProjectX`
`colorB`	Hex color of background for right hand side	`colorB=10ADED`
`prefix`	Prefix for right hand text	`prefix=v`
`suffix`	Suffix for right hand text	`suffix=%20dev`
`logo`	Logo for badge	`logo=twitter`
`style`	Badge style	`style=for-the-badge`

shields-ci · 2018-02-12T04:25:17Z

	Messages
📖	✨ Thanks for your contribution to Shields, @RedSparr0w!
📖	Thanks for contributing to our documentation. We ❤️ our documentarians!

Generated by 🚫 dangerJS

platan · 2018-02-14T16:26:17Z

server.js

+            } catch (e) {
+              switch (e.toString()){
+                case "TypeError: Cannot read property 'value' of undefined":
+                case "TypeError: Cannot read property 'firstChild' of undefined":


There is not test for this case (TypeError: Cannot read property 'firstChild' of undefined). Would you like to add it?

platan · 2018-02-14T16:52:19Z

server.js

+                case "TypeError: Cannot read property 'firstChild' of undefined":
+                  throw 'no result';
+                default:
+                  throw e;


Are we able to test this part of the code?

platan · 2018-02-14T16:55:29Z

server.js

@@ -7503,8 +7505,22 @@ cache({
            var innerText = jsonpath.join(', ');
            badgeData.text[1] = (prefix || '') + innerText + (suffix || '');
            break;
+          case 'xml':
+            data = new dom().parseFromString(data);
+            var xpathdata = xpath.select(pathExpression, data, true);


Alternatively we could check xpathdata value and remove try-catch block. What do you think about it?

let value; if (xpathdata) { value = (prefix || '') + (pathExpression.indexOf('@') + 1 ? xpathdata.value : xpathdata.firstChild.data) + (suffix || ''); } else { value = 'no result'; setBadgeColor(badgeData, 'lightgrey'); } badgeData.text[1] = value;

Nice, a lot more simple!

platan · 2018-02-14T17:00:51Z

service-tests/xml.js

+
+const colorsB = mapValues(colorscheme, 'colorB');
+
+const t = new ServiceTester({ id: 'badge/dynamic/xml', title: 'User Defined XML Source Data' });


Can you add a test for querying an attribute (/addon/@id)?

Knew i forgot something! Glad you caught this.

RedSparr0w · 2018-02-14T22:15:22Z

server.js

-
-        if (err != null || !res || res.statusCode !== 200)
-          throw 'inaccessible';
+        if (checkErrorResponse(badgeData, err, res, 'uri not found')) {


Updated to use checkErrorResponse() but not sure if uri not found || not found is the best message for a 404 error on this badge?

Maybe file not found or resource not found?

platan · 2018-02-15T17:35:35Z

server.js

-
-        if (err != null || !res || res.statusCode !== 200)
-          throw 'inaccessible';
+        if (checkErrorResponse(badgeData, err, res, 'uri not found')) {


Maybe file not found or resource not found?

platan · 2018-02-15T17:35:44Z

service-tests/xml.js

+  .get('.json?uri=https://services.addons.mozilla.org/en-US/firefox/api/1.5/addon/707078&query=//name')
+  .expectJSONTypes(Joi.object().keys({
+    name: 'custom badge',
+    value: Joi.string().regex(/^.+,\s.+$/)


Currently //name finds IndieGala Helper, Danial Nickford, GNU General Public License, version 3.0, Firefox, Firefox for Android. In .+,\s.+:

the first part .+ (greedy) matches IndieGala Helper, Danial Nickford, GNU General Public License, version 3.0, Firefox

the last part ,\s.+ matches , Firefox for Android

So this regular expression does not check if all elements are separated by a comma.

If we change query to query=/addon/compatible_applications/application/name we could compare result with exact value Firefox, Firefox for Android. What do you think about it?

Thanks, That makes more sense.
Wasn't quite sure how to test it, so i just tried to test for the separator.

Not sure why but the values seem to swap order occasionally.

I ran the test 10 times and 3 of those times it failed with the values swapped around
x 7
x 3
what about a regex of /^Firefox( for Android)?,\sFirefox( for Android)?$/

As far as I know XPath 1.0 (xpath is an XPath 1.0 implementation) uses node-sets to store results, which is an unordered collection of nodes. XPath 2.0 uses node sequences, which are an ordered collections (https://www.w3.org/TR/xpath/, https://www.w3.org/TR/xpath20/).
It would be great to use XPath 2.0 implementation, but I haven't found any good one.

still alot of room for improvement to this test

platan · 2018-02-24T17:02:53Z

Now it looks great! Would you like to update the dynamic badge section in documentation (current state below)?

RedSparr0w · 2018-02-27T22:56:52Z

Thanks, Have updated the front end dynamic badge generator,
But I think it looks a bit strange and am unsure how to make it better:

specifically the query= part, any ideas @platan?

tooomm · 2018-02-28T11:41:38Z

data type should have an explanation on which types are possible (json + xml). Maybe a mouse over hint? Or have it in the headline? Dynamic (json or xml)

json url should change it's label according to data type (or have a general name, source link?)

In the example at the bottom, <URI> should be <URL> to match "json url"
In one PR @paulmelnikow mentioned to use url over uri when possible.

paulmelnikow · 2018-03-04T01:18:16Z

Thanks for bringing that up @tooomm. Unfortunately, the dynamic badge already supports a uri parameter because it came up before I realized how much things have been standardizing on url. Would be great to switch it over (while leaving support for the old one, for a while), though I don't think that needs to be dealt with in this PR.

@RedSparr0w Could you clarify which part of the UI you're not liking?

kept support for uri, incase of any already existing badges.

RedSparr0w · 2018-03-04T20:19:52Z

data type should have an explanation on which types are possible (json + xml). Maybe a mouse over hint? Or have it in the headline? Dynamic (json or xml)

Good point, it was just using a datalist like the static badge colors input, but it does makes more sense to be a select, seeing as there is only 2 possible options.

json url should change it's label according to data type (or have a general name, source link?)

Have changed it to just be url,
Also updated from uri → url, but have kept support for uri so no badges will be broken.

Could you clarify which part of the UI you're not liking?

The query part, i feel like there must be a better way to convey how that param should be used.

paulmelnikow · 2018-03-04T21:40:30Z

The query part, i feel like there must be a better way to convey how that param should be used.

Ah, I see, because the query format is different.

How about providing two examples, one with DATATYPE filled in with json, and the other filled in with xml? The different query will help reinforce the difference.

RedSparr0w · 2018-03-05T01:32:52Z

That looks a lot better,
Thanks for the idea 😄

platan · 2018-03-06T17:37:36Z

This looks great @RedSparr0w!
What do you think about changing $.data.dubd placeholder to query?

RedSparr0w · 2018-03-06T21:40:27Z

@platan Good idea! that makes a lot more sense.

ToJen · 2018-08-02T15:47:22Z

I published a package to npm. How do I dynamically get the number of weekly/monthly downloads from there using an XML/JSON source ?

RedSparr0w force-pushed the dynamic-xml branch from 9ace157 to 7188309 Compare February 12, 2018 04:22

add dynamic xml badge support

948e6be

RedSparr0w force-pushed the dynamic-xml branch from 7188309 to 948e6be Compare February 12, 2018 04:24

RedSparr0w added 2 commits February 12, 2018 17:34

add tests

26a113c

dynamic badge add tests for query param

7e3a693

platan reviewed Feb 14, 2018

View reviewed changes

remove try catch

024fd95

RedSparr0w changed the title ~~[badge/dynamic/xml] User defined XML source badge~~ [badge/dynamic/xml] User defined XML source badge //test [badge/dynamic/json] Feb 14, 2018

use checkErrorResponse()

c9046db

RedSparr0w changed the title ~~[badge/dynamic/xml] User defined XML source badge //test [badge/dynamic/json]~~ User defined XML source badge [badge/dynamic/xml badge/dynamic/json] Feb 14, 2018

RedSparr0w added 3 commits February 15, 2018 10:13

update tests

d077155

[dynamic json] add test for multiple items

65290a0

Rebase, [dynamic xml] Add support for multiple items

a512340

RedSparr0w commented Feb 14, 2018

View reviewed changes

RedSparr0w added the service-badge New or updated service badge label Feb 15, 2018

platan reviewed Feb 15, 2018

View reviewed changes

RedSparr0w added 2 commits February 16, 2018 12:37

404 response -> resource not found

a91830d

multiple results test less greedy regex

28dc58e

still alot of room for improvement to this test

RedSparr0w force-pushed the dynamic-xml branch from 0774385 to 28dc58e Compare February 15, 2018 23:44

update dynamic badge gen

21d25d3

RedSparr0w force-pushed the dynamic-xml branch 2 times, most recently from fc71cbd to 495f691 Compare February 27, 2018 22:44

add dynamic xml gen tests

78bc48a

RedSparr0w force-pushed the dynamic-xml branch from 495f691 to 78bc48a Compare February 27, 2018 22:46

RedSparr0w changed the title ~~User defined XML source badge [badge/dynamic/xml badge/dynamic/json]~~ User defined XML source badge [dynamic-xml dynamic-json] Feb 27, 2018

update tests id & path

2b448ec

datalist -> select

c6f47d8

RedSparr0w force-pushed the dynamic-xml branch from 094da78 to 2c3e1af Compare March 4, 2018 20:16

uri -> url

2c3e1af

kept support for uri, incase of any already existing badges.

split dynamic gen uri

fd130d6

paulmelnikow approved these changes Mar 5, 2018

View reviewed changes

update query placeholder

7b4b00d

RedSparr0w merged commit be09cee into badges:master Mar 6, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

User defined XML source badge [dynamic-xml dynamic-json] #1494

User defined XML source badge [dynamic-xml dynamic-json] #1494

RedSparr0w commented Feb 12, 2018 •

edited

Loading

shields-ci commented Feb 12, 2018 •

edited

Loading

platan Feb 14, 2018

platan Feb 14, 2018

platan Feb 14, 2018

RedSparr0w Feb 14, 2018

platan Feb 14, 2018

RedSparr0w Feb 14, 2018

RedSparr0w Feb 14, 2018

platan Feb 15, 2018

platan Feb 15, 2018

platan Feb 15, 2018

RedSparr0w Feb 15, 2018

RedSparr0w Feb 15, 2018 •

edited

Loading

platan Feb 24, 2018

platan commented Feb 24, 2018

RedSparr0w commented Feb 27, 2018

tooomm commented Feb 28, 2018

paulmelnikow commented Mar 4, 2018

RedSparr0w commented Mar 4, 2018

paulmelnikow commented Mar 4, 2018

RedSparr0w commented Mar 5, 2018

platan commented Mar 6, 2018

RedSparr0w commented Mar 6, 2018

ToJen commented Aug 2, 2018


		const colorsB = mapValues(colorscheme, 'colorB');

		const t = new ServiceTester({ id: 'badge/dynamic/xml', title: 'User Defined XML Source Data' });

User defined XML source badge [dynamic-xml dynamic-json] #1494

User defined XML source badge [dynamic-xml dynamic-json] #1494

Conversation

RedSparr0w commented Feb 12, 2018 • edited Loading

Description:

To do:

Examples:

Usage:

shields-ci commented Feb 12, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RedSparr0w Feb 15, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

platan commented Feb 24, 2018

RedSparr0w commented Feb 27, 2018

tooomm commented Feb 28, 2018

paulmelnikow commented Mar 4, 2018

RedSparr0w commented Mar 4, 2018

paulmelnikow commented Mar 4, 2018

RedSparr0w commented Mar 5, 2018

platan commented Mar 6, 2018

RedSparr0w commented Mar 6, 2018

ToJen commented Aug 2, 2018

RedSparr0w commented Feb 12, 2018 •

edited

Loading

shields-ci commented Feb 12, 2018 •

edited

Loading

RedSparr0w Feb 15, 2018 •

edited

Loading