Add Leanpub Book Summary Badges [LeanpubBookSummary]

[calebcartwright]

Adds new service to provide badges for Leanpub book metrics which closes #2270

Comments:

• I wasn't sure what category this would fall under, so I chose other
• One of the badges (revenue) will only be available on self-hosted Shields instances. I added a note to the docs for that badge to indicate this, but not sure if there are other conventions/standards followed for self-hosted only badges
• The Leanpub API docs all reference providing the API Key (which would only be done for self-hosted Shields instances) via a query param. I'd prefer that be done via auth headers, but figured I'd just go with what their docs say, especially since I don't personally use the service

[shields-ci]

	Messages
📖	✨ Thanks for your contribution to Shields, @calebcartwright!

Generated by 🚫 dangerJS

[chris48s]

Thanks for submitting this.

I'm not sure what to do about the revenue badge. I don't think its particularly useful to add/document a badge on shields.io that nobody can use. Does anyone know of another example where we've got a badge in core that only works on a self-hosted instance?

[paulmelnikow]

I'm not sure what to do about the revenue badge. I don't think its particularly useful to add/document a badge on shields.io that nobody can use. Does anyone know of another example where we've got a badge in core that only works on a self-hosted instance?

I'm not aware of any.

In theory I wouldn't mind maintaining a badge that targets self-hosing users, though I'm not sure if there is anyone who wants the revenue badge enough to self-host.

Given that, maybe we could leave off the revenue badge for now?

[calebcartwright]

I think that's fair, and also aligns with what the original requestor said when we found it out would only be available for self-hosted.

I'll remove the revenue badge. Any other changes needed?

[chris48s]

cheers. I've left a couple of other minor comments to follow up on

[calebcartwright]

Also a semi-random question. I noticed in the code coverage results that the examples method is the only one that doesn't get hit (the other static methods like category and defaultBadgeData do get hit) resulting in coverage < 100%. Am I missing something in my tests or is this the expected behavior?

[chris48s]

Good question. I think if you run the full test suite (as opposed to just the service tests) with npm test there is a test in there somewhere which builds the full front-end data structure. That has the effect of touching all the service examples which will cause it to fail if something in there throws an exception, but we don't really test the examples beyond that.

[chris48s]

thanks for you work on this

[shields-deployment]

This pull request was merged to master branch. This change is now waiting for deployment, which will usually happen within a few days. Stay tuned by joining our #ops channel on Discord!

After deployment, changes are copied to gh-pages branch: