shields.io master

Create a badge

Services which query a GraphQL endpoint should extend BaseGraphqlService

Parse data from JSON endpoint

Services which query a JSON endpoint should extend BaseJsonService

Parse data from JSON endpoint

Services which scrape data from another SVG badge should extend BaseSvgScrapingService

Extract a value from SVG

Services which query a XML endpoint should extend BaseXmlService

Services which query a YAML endpoint should extend BaseYamlService

Abstract base class which all service classes inherit from. Concrete implementations of BaseService must implement the methods category(), route() and handle(namedParams, queryParams)

Base error class

Name of the class. Implementations of ShieldsRuntimeError should override this method.

Default message for this exception if none is specified. Implementations of ShieldsRuntimeError should implement this method.

Throw this to wrap a 404 or other 'not found' response from an upstream API

Throw this to wrap an invalid or unexpected response from an upstream API

Throw this if we can't contact an upstream API or to wrap a 5XX response

Throw this error when required credentials are missing

Throw this error when a user supplied input or parameter is invalid or unexpected

Throw this error to indicate that a service is deprecated or removed

Utility function to merge two graphql queries together This is basically copied from graphql-query-merge but can't use that due to incorrect packaging.

The Server is based on the web framework Scoutcamp. It creates an http server, sets up helpers for token persistence and monitoring. Then it loads all the services, injecting dependencies as it asks each one to register its route with Scoutcamp.

Badge Server Constructor

Set up Scoutcamp routes for 404/not found responses

Set up a couple of redirects: One for the raster badges. Another to redirect the base URL / (we use this to redirect {@link https://img.shields.io/} to {@link https://shields.io/} )

Iterate all the service classes defined in /services, load each service and register a Scoutcamp route for each service.

Automatically create a ServiceTester.

When run from e.g. gem-rank.tester.js, this will create a tester that attaches to the service found in gem-rank.service.js.

This can't be used for .service.js files which export more than one service.

Factory which wraps an "icedfrisby-nock" with some additional functionality:

• check if a request was intercepted
• set expectations on the badge JSON response

When called inside a CI build, infer the details of a pull request from the environment variables.

Pull Request

Load a collection of ServiceTester objects and register them with Mocha.

Function to invoke before each test. This is a stub which can be overridden on instances.

Prepare the runner by loading up all the ServiceTester objects.

Limit the test run to the specified services.

Register the tests with Mocha.

Encapsulate a suite of tests. Create new tests using create() and register them with Mocha using toss().

Service Tester Constructor

Construct a ServiceTester instance for a single service class

Invoked before each test. This is a stub which can be overridden on instances.

Create a new test. The hard work is delegated to IcedFrisby. {@link https://github.com/MarkHerhold/IcedFrisby/#show-me-some-code}

Note: The caller should not invoke toss() on the Frisby chain, as it's invoked automatically by the tester.

Run only this tester. This can be invoked using the --only argument to the CLI, or directly on the tester.

Register the tests with Mocha.

Given a pull request title like '[Travis Sonar] Support user token authentication' extract the list of service names in square brackets as an array of strings.

Compute a one-way hash of the input string.

Encapsulate a rate-limited token, with a user-provided ID and user-provided data.

Each token has a notion of the number of uses remaining until exhausted, and the next reset time, when it can be used again even if it's exhausted.

Token Constructor

Update the uses remaining and next reset time for a token.

Indicate that the token should no longer be used.

Freeze the uses remaining and next reset values. Helpful for keeping stable ordering for a valid priority queue.

Unfreeze the uses remaining and next reset values.

Encapsulate a collection of rate-limited tokens and choose the next available token when one is needed.

Designed for the Github API, though may be also useful with other rate- limited APIs.

TokenPool Constructor

compareTokens

Add a token with user-provided ID and data.

Obtain the next available token, returning null if no tokens are available.

Tokens are initially pulled from a FIFO queue. The first token is used for a batch of requests, then returned to the queue to give those requests the opportunity to complete. The next token is used for the next batch of requests.

This strategy allows a token to be used for concurrent requests, not just sequential request, and simplifies token recovery after errored and timed out requests.

By the time the original token re-emerges, its requests should have long since completed. Even if a couple them are still running, they can reasonably be ignored. The uses remaining won't be 100% correct, but that's fine, because Shields uses only 75%

The process continues until an exhausted token is pulled from the FIFO queue. At that time it's placed in the priority queue based on its scheduled reset time. To ensure the priority queue works as intended, the scheduled reset time is frozen then.

After obtaining a token using next(), invoke update() on it to set a new use-remaining count and next-reset time. Invoke invalidate() to indicate it should not be reused.

Iterate over all valid tokens.

Criterion Badge Service

Support and Contact:

• https://github.com/chmoder/api.criterion.dev

API Documentation:

• https://app.swaggerhub.com/apis-docs/chmoder/Criterion.dev

Dynamic service class factory which wraps {@link module:core/base-service/base~BaseService} with support of {@link https://jsonpath.com/|JSONPath}.

Validates affiliations should contain combination of allowed values in any order.

Return color for active, maintenance and archived statuses, which were the three example keywords used in Netflix's open-source meetup. See https://slideshare.net/aspyker/netflix-open-source-meetup-season-4-episode-1 Other keywords are possible, but will appear in grey.

The steam api is based like /{interface}/{method}/v{version}/