improve logo escaping (#3511)

* escape logo in make-badge

* 2.2.1 release notes

* tighten up validation of logo param

.buildpacks

@@ -1,2 +0,0 @@
-https://github.com/mojodna/heroku-buildpack-cairo.git
-https://github.com/heroku/heroku-buildpack-nodejs.git

.circleci/config.yml

@@ -0,0 +1,415 @@
+version: 2
+
+main_steps: &main_steps
+  steps:
+    - checkout
+
+    - restore_cache:
+        keys:
+          - v2-dependencies-{{ checksum "package-lock.json" }}
+          # https://github.com/badges/shields/issues/1937
+          - v2-dependencies-
+
+    - run:
+        name: Install dependencies
+        command: npm ci
+
+    - save_cache:
+        paths:
+          - node_modules
+        key: v2-dependencies-{{ checksum "package-lock.json" }}
+
+    - run:
+        name: Linter
+        when: always
+        command: npm run lint
+
+    - run:
+        name: Core tests
+        when: always
+        environment:
+          mocha_reporter: mocha-junit-reporter
+          MOCHA_FILE: junit/core/results.xml
+        command: npm run test:core
+
+    - run:
+        name: Entrypoint tests
+        when: always
+        environment:
+          mocha_reporter: mocha-junit-reporter
+          MOCHA_FILE: junit/entrypoint/results.xml
+        command: npm run test:entrypoint
+
+    - store_test_results:
+        path: junit
+
+    - run:
+        name: 'Prettier check (quick fix: `npm run prettier`)'
+        when: always
+        command: npm run prettier:check
+
+integration_steps: &integration_steps
+  steps:
+    - checkout
+
+    - restore_cache:
+        keys:
+          - v2-dependencies-{{ checksum "package-lock.json" }}
+          # https://github.com/badges/shields/issues/1937
+          - v2-dependencies-
+
+    - run:
+        name: Install dependencies
+        command: npm ci
+
+    - run:
+        name: Integration tests
+        when: always
+        environment:
+          mocha_reporter: mocha-junit-reporter
+          MOCHA_FILE: junit/integration/results.xml
+        command: npm run test:integration
+
+    - store_test_results:
+        path: junit
+
+services_steps: &services_steps
+  steps:
+    - checkout
+
+    - restore_cache:
+        keys:
+          - v2-dependencies-{{ checksum "package-lock.json" }}
+          # https://github.com/badges/shields/issues/1937
+          - v2-dependencies-
+
+    - run:
+        name: Install dependencies
+        command: npm ci
+
+    - run:
+        name: Identify services tagged in the PR title
+        command: npm run test:services:pr:prepare
+
+    - run:
+        name: Run tests for tagged services
+        environment:
+          mocha_reporter: mocha-junit-reporter
+          MOCHA_FILE: junit/services/results.xml
+        command: npm run test:services:pr:run
+
+    - store_test_results:
+        path: junit
+
+run_package_tests: &run_package_tests
+  when: always
+  command: |
+    # https://discuss.circleci.com/t/switch-nodejs-version-on-machine-executor-solved/26675/3
+    set +e
+    export NVM_DIR="/opt/circleci/.nvm"
+    [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
+    nvm install $NODE_VERSION
+    nvm use $NODE_VERSION
+    node --version
+    npm run test:package
+
+package_steps: &package_steps
+  steps:
+    - checkout
+
+    - restore_cache:
+        keys:
+          - v2-dependencies-{{ checksum "package-lock.json" }}
+          # https://github.com/badges/shields/issues/1937
+          - v2-dependencies-
+
+    - run:
+        name: Install dependencies
+        command: |
+          set +e
+          export NVM_DIR="/opt/circleci/.nvm"
+          [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
+          nvm install v12
+          nvm use v12
+          npm install -g npm
+          npm ci
+
+    # Run the package tests on each currently supported node version. See:
+    # https://github.com/badges/shields/blob/master/gh-badges/README.md#node-version-support
+
+    - run:
+        <<: *run_package_tests
+        environment:
+          mocha_reporter: mocha-junit-reporter
+          MOCHA_FILE: junit/gh-badges/v8/results.xml
+          NODE_VERSION: v8
+        name: Run package tests on Node 8
+
+    - run:
+        <<: *run_package_tests
+        environment:
+          mocha_reporter: mocha-junit-reporter
+          MOCHA_FILE: junit/gh-badges/v10/results.xml
+          NODE_VERSION: v10
+        name: Run package tests on Node 10
+
+    - run:
+        <<: *run_package_tests
+        environment:
+          mocha_reporter: mocha-junit-reporter
+          MOCHA_FILE: junit/gh-badges/v11/results.xml
+          NODE_VERSION: v11
+        name: Run package tests on Node 11
+
+    - run:
+        <<: *run_package_tests
+        environment:
+          mocha_reporter: mocha-junit-reporter
+          MOCHA_FILE: junit/gh-badges/v12/results.xml
+          NODE_VERSION: v12
+        name: Run package tests on Node 12
+
+    - store_test_results:
+        path: junit
+
+jobs:
+  npm-install:
+    docker:
+      - image: circleci/node:8
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - v2-dependencies-{{ checksum "package-lock.json" }}
+            # fallback to using the latest cache if no exact match is found
+            - v2-dependencies-
+
+      - run:
+          name: Install dependencies
+          command: npm ci
+
+      - save_cache:
+          paths:
+            - node_modules
+          key: v2-dependencies-{{ checksum "package-lock.json" }}
+
+  main:
+    docker:
+      - image: circleci/node:8
+
+    <<: *main_steps
+
+  main@node-latest:
+    docker:
+      - image: circleci/node:latest
+
+    <<: *main_steps
+
+  integration:
+    docker:
+      - image: circleci/node:8
+      - image: redis
+
+    <<: *integration_steps
+
+  integration@node-latest:
+    docker:
+      - image: circleci/node:latest
+      - image: redis
+
+    <<: *integration_steps
+
+  danger:
+    docker:
+      - image: circleci/node:8
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - v2-dependencies-{{ checksum "package-lock.json" }}
+            # https://github.com/badges/shields/issues/1937
+            - v2-dependencies-
+
+      - run:
+          name: Install dependencies
+          command: npm ci
+
+      - run:
+          name: Danger
+          when: always
+          environment:
+            # https://github.com/gatsbyjs/gatsby/pull/11555
+            NODE_ENV: test
+          command: npm run danger ci
+
+  frontend:
+    docker:
+      - image: circleci/node:8
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - v2-dependencies-{{ checksum "package-lock.json" }}
+            # https://github.com/badges/shields/issues/1937
+            - v2-dependencies-
+
+      - run:
+          name: Install dependencies
+          command: npm ci
+
+      - run:
+          name: Prepare frontend tests
+          command: npm run defs && npm run features
+
+      - run:
+          name: Frontend unit tests
+          environment:
+            mocha_reporter: mocha-junit-reporter
+            MOCHA_FILE: junit/frontend/results.xml
+          command: npm run test:frontend
+
+      - store_test_results:
+          path: junit
+
+      - run:
+          name: Frontend build completes successfully
+          when: always
+          command: npm run build
+
+  package:
+    machine: true
+
+    <<: *package_steps
+
+  services:
+    docker:
+      - image: circleci/node:8
+
+    <<: *services_steps
+
+  services@node-latest:
+    docker:
+      - image: circleci/node:latest
+
+    <<: *services_steps
+
+  e2e:
+    docker:
+      - image: cypress/base:8
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - v2-dependencies-{{ checksum "package-lock.json" }}
+            # https://github.com/badges/shields/issues/1937
+            - v2-dependencies-
+
+      - run:
+          name: Install dependencies
+          command: npm ci
+
+      - run:
+          name: Frontend build
+          command: GATSBY_BASE_URL=http://localhost:8080 npm run build
+
+      - run:
+          name: Run tests
+          environment:
+            CYPRESS_REPORTER: junit
+            MOCHA_FILE: junit/e2e/results.xml
+          command: npm run e2e-on-build
+
+      - store_test_results:
+          path: junit
+
+      - store_artifacts:
+          path: cypress/videos
+
+      - store_artifacts:
+          path: cypress/screenshots
+
+workflows:
+  version: 2
+
+  on-commit:
+    jobs:
+      - main:
+          filters:
+            branches:
+              ignore: gh-pages
+      - main@node-latest:
+          filters:
+            branches:
+              ignore: gh-pages
+      - integration@node-latest:
+          filters:
+            branches:
+              ignore: gh-pages
+      - frontend:
+          filters:
+            branches:
+              ignore: gh-pages
+      - package:
+          filters:
+            branches:
+              ignore: gh-pages
+      - services:
+          filters:
+            branches:
+              ignore:
+                - master
+                - gh-pages
+      - services@node-latest:
+          filters:
+            branches:
+              ignore:
+                - master
+                - gh-pages
+      - danger:
+          filters:
+            branches:
+              ignore:
+                - master
+                - gh-pages
+                - /dependabot\/.*/
+      - e2e:
+          filters:
+            branches:
+              ignore: gh-pages
+  # on-commit-with-cache:
+  #   jobs:
+  #     - npm-install:
+  #         filters:
+  #           branches:
+  #             ignore: gh-pages
+  #     - main:
+  #         requires:
+  #           - npm-install
+  #     - main@node-latest:
+  #         requires:
+  #           - npm-install
+  #     - frontend:
+  #         requires:
+  #           - npm-install
+  #     - services:
+  #         requires:
+  #           - npm-install
+  #         filters:
+  #           branches:
+  #             ignore: master
+  #     - services@node-latest:
+  #         requires:
+  #           - npm-install
+  #         filters:
+  #           branches:
+  #             ignore: master
+  #     - danger:
+  #         requires:
+  #           - npm-install
+  #         filters:
+  #           branches:
+  #             ignore: /dependabot\/.*/

.dependabot/config.yml

@@ -0,0 +1,11 @@
+version: 1
+update_configs:
+  # shields.io dependencies
+  - package_manager: 'javascript'
+    directory: '/'
+    update_schedule: 'weekly'
+
+  # gh-badges package dependencies
+  - package_manager: 'javascript'
+    directory: '/gh-badges'
+    update_schedule: 'weekly'

.dockerignore

@@ -0,0 +1,8 @@
+node_modules/
+shields.env
+.git/
+.gitignore
+.vscode/
+
+# Improve layer cacheability.
+Dockerfile

.eslintignore

@@ -0,0 +1,5 @@
+/build
+/coverage
+/__snapshots__
+/public
+gh-badges/node_modules/

.eslintrc-frontend.yml

@@ -0,0 +1,28 @@
+env:
+  browser: true
+
+plugins:
+  - import
+  - react-hooks
+
+parser: 'babel-eslint'
+
+parserOptions:
+  sourceType: 'module'
+
+extends:
+  - 'standard-jsx'
+  - 'standard-react'
+  - './.eslintrc.yml'
+
+settings:
+  react:
+    version: '16.4'
+
+rules:
+  no-console: 'error'
+
+  import/extensions: ['error', 'never', { 'json': 'always', 'yml': 'always' }]
+  react/jsx-sort-props: 'error'
+  react-hooks/rules-of-hooks: 'error'
+  react-hooks/exhaustive-deps: 'error'

.eslintrc.yml

@@ -0,0 +1,84 @@
+extends:
+  - standard
+  - prettier
+
+env:
+  node: true
+  mocha: true
+
+parserOptions:
+  # Override eslint-config-standard, which incorrectly sets this to "module",
+  # though that setting is only for ES6 modules, not CommonJS modules.
+  sourceType: 'script'
+
+overrides:
+  - files:
+      - gatsby-browser.js
+    parserOptions:
+      sourceType: 'module'
+  - files:
+      - 'core/base-service/**/*.js'
+      - 'services/**/*.js'
+    rules:
+      sort-class-members/sort-class-members:
+        [
+          'error',
+          {
+            order:
+              [
+                'name',
+                'category',
+                'isDeprecated',
+                'route',
+                'examples',
+                '_cacheLength',
+                'defaultBadgeData',
+                'render',
+                'constructor',
+                'fetch',
+                'transform',
+                'handle',
+              ],
+          },
+        ]
+
+plugins:
+  - mocha
+  - no-extension-in-require
+  - chai-friendly
+  - sort-class-members
+
+rules:
+  # Disable some rules from eslint:recommended.
+  no-console: 'off'
+  no-empty: ['error', { 'allowEmptyCatch': true }]
+  # Allow unused parameters. In callbacks, removing them seems to obscure
+  # what the functions are doing.
+  no-unused-vars: ['error', { 'args': 'none' }]
+
+  # These should be disabled by eslint-config-prettier, but are not.
+  spaced-comment: 'off'
+  standard/object-curly-even-spacing: 'off'
+  one-var: 'off'
+
+  # Shields additions.
+  no-var: 'error'
+  prefer-const: 'error'
+  strict: 'error'
+  arrow-body-style: ['error', 'as-needed']
+  no-extension-in-require/main: 'error'
+  object-shorthand: ['error', 'properties']
+  prefer-template: 'error'
+  promise/prefer-await-to-then: 'error'
+  func-style: ['error', 'declaration', { 'allowArrowFunctions': true }]
+  new-cap: ['error', { 'capIsNew': true }]
+  import/order: ['error', { 'newlines-between': 'never' }]
+
+  # Mocha-related.
+  mocha/no-exclusive-tests: 'error'
+  mocha/no-mocha-arrows: 'error'
+  mocha/prefer-arrow-callback: 'error'
+
+  # Chai friendly.
+  no-unused-expressions: 'off'
+  chai-friendly/no-unused-expressions: 'error'

.github/FUNDING.yml

@@ -0,0 +1 @@
+open_collective: shields

.github/ISSUE_TEMPLATE/1_Bug_report.md

@@ -0,0 +1,28 @@
+---
+name: 🐛 Bug Report
+about: Report errors and problems
+---
+
+Are you experiencing an issue with...
+
+- [ ] [shields.io](https://shields.io/#/)
+- [ ] My own instance
+- [ ] [gh-badges NPM package](https://www.npmjs.com/package/gh-badges)
+
+:beetle: **Description**
+
+<!-- A clear and concise description of the problem. -->
+
+:link: **Link to the badge**
+
+<!--
+If you are reporting a problem with a specific badge on shields.io,
+provide a link to a badge demonstrating the error
+-->
+
+:bulb: **Possible Solution**
+
+<!--- Optional: only if you have suggestions on a fix/reason for the bug -->
+
+<!-- Love Shields? Please consider donating $10 to sustain our activities:
+👉  https://opencollective.com/shields -->

.github/ISSUE_TEMPLATE/2_Failing_service_test.md

@@ -0,0 +1,35 @@
+---
+name: 💚 Failing service test
+about: Note failing service tests
+---
+
+:clock11: **When did the problem start?**
+
+<!-- Indicate when the problem started -->
+
+:camera: **Live badge**
+
+<!-- Provide a link to the live badge in plain text and markdown.  -->
+
+![]( url goes here )
+
+:wrench: **Is the live badge working?**
+
+<!-- Indicate whether or not the live badge is working. -->
+
+:link: **CircleCI link**
+
+<!-- Provide a link to the failing test in CircleCI. -->
+
+:beetle: **Stack trace**
+
+```
+<!-- Provide the complete stack trace from the CircleCI test summary. -->
+```
+
+:bulb: **Possible solution**
+
+<!--- Optional: only if you have suggestions on a fix/reason for the bug -->
+
+<!-- Love Shields? Please consider donating $10 to sustain our activities:
+👉  https://opencollective.com/shields -->

.github/ISSUE_TEMPLATE/3_Badge_request.md

@@ -0,0 +1,36 @@
+---
+name: 💡 Badge Request
+about: Ideas for new badges
+---
+
+:clipboard: **Description**
+
+<!--
+A clear and concise description of the new badge.
+
+- Which service is this badge for e.g: GitHub, Travis CI
+- What sort of information should this badge show?
+  Provide an example in plain text e.g: "version | v1.01" or as a static badge
+  (static badge generator can be found at https://shields.io)
+-->
+
+:link: **Data**
+
+<!--
+Where can we get the data from?
+
+- Is there a public API?
+- Does the API requires an API key?
+- Link to the API documentation.
+-->
+
+:microphone: **Motivation**
+
+<!--
+Please explain why this feature should be implemented and how it would be used.
+
+- What is the specific use case?
+-->
+
+<!-- Love Shields? Please consider donating $10 to sustain our activities:
+👉  https://opencollective.com/shields -->

.github/ISSUE_TEMPLATE/4_Feature_request.md

@@ -0,0 +1,11 @@
+---
+name: 💡 Feature Request
+about: Ideas for other new features or improvements
+---
+
+:clipboard: **Description**
+
+<!-- A clear and concise description of the new feature. -->
+
+<!-- Love Shields? Please consider donating $10 to sustain our activities:
+👉  https://opencollective.com/shields -->

.github/ISSUE_TEMPLATE/5_Support_question.md

@@ -0,0 +1,16 @@
+---
+name: ❓ Support Question
+about: Ask a question about shields.io
+---
+
+:question: **Question**
+
+<!--
+Ask your question clearly and concisely.
+
+#support on our [Discord](https://discordapp.com/invite/HjJCwm5)
+is also a great place to ask questions and get help
+-->
+
+<!-- Love Shields? Please consider donating $10 to sustain our activities:
+👉  https://opencollective.com/shields -->

.github/probot.js

@@ -0,0 +1,10 @@
+on('pull_request.closed')
+  .filter(context => context.payload.pull_request.merged)
+  .filter(
+    context =>
+      context.payload.pull_request.head.ref.slice(0, 11) !== 'dependabot/'
+  )
+  .filter(context => context.payload.pull_request.base.ref === 'master')
+  .comment(`This pull request was merged to [{{ pull_request.base.ref }}]({{ repository.html_url }}/tree/{{ pull_request.base.ref }}) 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](https://discordapp.com/invite/HjJCwm5)!
+  
+After deployment, changes are copied to [gh-pages]({{ repository.html_url }}/tree/gh-pages) branch: ![](https://img.shields.io/github/commit-status/{{ repository.full_name }}/gh-pages/{{ pull_request.merge_commit_sha }}.svg?label=deploy%20status)`)

.gitignore

@@ -4,11 +4,10 @@
 /coverage.html
 /redis
 /ServerScript
-/secret.json
-/.github-user-tokens.json
-
-# Installed npm modules
-node_modules
+/private
+/index.html
+/shields.env
+gh-badges/package-lock.json
 
 # Folder view configuration files
 .DS_Store
@@ -18,6 +17,96 @@ Desktop.ini
 ._*
 Thumbs.db
 
+# Visual Studio Code User Settings
+.vscode/settings.json
+
+# eclipse
+.project
+.settings
+
 # Files that might appear on external disks
 .Spotlight-V100
 .Trashes
+
+# Jetbrains
+/.idea
+
+# Created by https://www.gitignore.io/api/node
+
+### Node ###
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# Temporary build artifacts.
+/build
+.next
+badge-examples.json
+supported-features.json
+service-definitions.yml
+
+# Local runtime configuration.
+/config/local*.yml
+
+# Template for the local runtime configuration.
+!/config/local*.template.yml
+
+# Gatsby
+/.cache
+/public
+
+# Cypress
+/cypress/videos/
+/cypress/screenshots/

.gitpod.yml

@@ -0,0 +1,5 @@
+ports:
+  - port: 8080
+tasks:
+  - init: npm ci && npm run build
+    command: node server 8080 0.0.0.0

.mocharc-frontend.yml

@@ -0,0 +1,6 @@
+reporter: mocha-env-reporter
+require:
+  - '@babel/polyfill'
+  - '@babel/register'
+  - mocha-yaml-loader
+  - frontend/mocha-ignore-pngs

.mocharc.yml

@@ -0,0 +1 @@
+reporter: mocha-env-reporter

.nowignore

@@ -0,0 +1,30 @@
+*
+!frontend/
+!gh-badges/
+!lib/
+!core/
+!logo/
+!pages/
+!public/
+!templates/
+!services/
+!package-lock.json
+!/*.js
+!scripts/export-*.js
+!config/
+config/local*.yml
+*.spec.js
+*~
+.env
+.circleci
+.github
+.vscode
+__snapshots__
+.buildpacks
+.eslint*
+.editorconfig
+.nycrc*
+.gitpod*
+.prettier*
+CONTRIBUTING.md
+Dockerfile

.nycrc-frontend.json

@@ -0,0 +1,10 @@
+{
+  "reporter": ["lcov"],
+  "all": false,
+  "silent": true,
+  "clean": false,
+  "sourceMap": false,
+  "instrument": false,
+  "include": ["frontend/**/*.js"],
+  "exclude": ["**/*.spec.js", "**/mocha-*.js"]
+}

.nycrc.json

@@ -0,0 +1,24 @@
+{
+  "reporter": ["lcov"],
+  "all": true,
+  "silent": true,
+  "clean": false,
+  "exclude": [
+    "**/*.spec.js",
+    "**/*.integration.js",
+    "**/test-helpers.js",
+    "**/*-test-helpers.js",
+    "**/*-fixtures.js",
+    "dangerfile.js",
+    "gatsby-*.js",
+    "core/service-test-runner",
+    "services/**/*.tester.js",
+    "services/test-validators.js",
+    "services/tester.js",
+    "core/base-service/loader-test-fixtures",
+    "scripts",
+    "coverage",
+    "build",
+    ".github"
+  ]
+}

.prettierignore

@@ -0,0 +1,14 @@
+package.json
+package-lock.json
+/__snapshots__
+/.next
+/.cache
+/build
+/public
+/coverage
+private/*.json
+/.nyc_output
+analytics.json
+gh-badges/templates/default-template.json
+supported-features.json
+service-definitions.yml

.prettierrc.yml

@@ -0,0 +1,5 @@
+semi: false
+singleQuote: true
+trailingComma: es5
+bracketSpacing: true
+endOfLine: lf

.travis.yml

@@ -1,18 +0,0 @@
-before_install:
-  - sudo apt-get update -myqq
-  - sudo apt-get install libcairo2-dev libjpeg8-dev libpango1.0-dev libgif-dev build-essential g++
-language: node_js
-node_js:
-  - 6
-
-branches:
-  only:
-    - master
-
-notifications:
-  email:
-    - thaddee.tyl@gmail.com
-  irc: "irc.freenode.org#shields"
-
-git:
-  depth: 10

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "esbenp.prettier-vscode",
+    "EditorConfig.EditorConfig",
+    "dbaeumer.vscode-eslint"
+  ]
+}

.vscode/launch.json

@@ -0,0 +1,13 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "attach",
+      "name": "Node: Nodemon",
+      "processId": "${command:PickProcess}",
+      "restart": true,
+      "protocol": "inspector"
+    }
+  ]
+}

CNAME

@@ -1 +0,0 @@
-shields.io

CONTRIBUTING.md

@@ -1,65 +1,141 @@
-# Contribution Guidelines
+# Contributing to Shields
 
-This is the home of Shields.io, home to the badge design specification, API documentation, and server code for Badges as a Service.
+Shields is a community project. We invite your participation through
+financial contributions, issues, and pull requests!
 
-We invite participation through [GitHub Issues][], which we use much like a discussion forum. This repository should only contain non-implementation specific topics: specifications, design, and the web site.
+## Ways you can help
 
-## This implementation
+### Financial contributions
 
-Please see [INSTALL.md][] for information on how to start contributing code to
-shields.io.
+We welcome financial contributions in full transparency on our
+[open collective](https://opencollective.com/shields). Anyone can file an
+expense. If the expense makes sense for the development of the community, it
+will be "merged" into the ledger of our open collective by the core
+contributors and the person who filed the expense will be reimbursed.
 
-[INSTALL.md]: ./INSTALL.md
+### Contributing code
 
-Note that the root gets redirected to <http://shields.io>.
-For testing purposes, you can go to `http://localhost/try.html`.
-You should modify that file. The "real" root, `http://localhost/index.html`,
-gets generated from the `try.html` file with a `make website`.
+This project has quite a backlog of suggestions! If you're new to the project,
+maybe you'd like to open a pull request to address one of them:
 
-## Ground rules
+[![GitHub issues by-label](https://img.shields.io/github/issues/badges/shields/good%20first%20issue.svg)](https://github.com/badges/shields/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+
+### Contributing documentation
+
+You can help by improving the project's usage and developer instructions.
+
+- When you read the documentation, you can fix mistakes and add your own thoughts.
+- When your pull request follows the documentation but the practice changed,
+  consider pointing this out and change the documentation for the next person.
+
+### Helping others
+
+You can help with code review, which reduces bugs, and over time has a
+wonderful side effect of making the code more readable and therefore more
+approachable. It's also a great way to teach and learn. Feel free to jump in!
+Be welcoming, appreciative, and helpful. You can perform first reviews of
+simple changes, like badge additions. These are usually tagged with
+[service badge][service badge pr tag].
+
+Please review [these impeccable guidelines][code review guidelines].
+
+You can monitor [issues][] and the [chat room][], and help other people who
+have questions about contributing to Shields, or using it for their projects.
+
+Feel free to reach out to one of the [maintainers][]
+if you need help getting started.
+
+[service badge pr tag]: https://github.com/badges/shields/pulls?q=is%3Apr+is%3Aopen+label%3Aservice-badge
+[code review guidelines]: https://kickstarter.engineering/a-guide-to-mindful-communication-in-code-reviews-48aab5282e5e
+[issues]: https://github.com/badges/shields/issues
+[chat room]: https://discordapp.com/invite/HjJCwm5
+[maintainers]: https://github.com/badges/shields#project-leaders
+
+### Suggesting improvements
+
+There are _a lot_ of suggestions on file. You can help by weighing in on these
+suggestions, which helps convey community need to other contributors who might
+pick them up.
+
+There is no need to post a new comment. Just add a :thumbsup: or :heart: to
+the top post.
+
+If you have a suggestion of your own, [search the open issues][issues]. If you
+don't see it, feel free to [open a new issue][open an issue].
+
+[open an issue]: https://github.com/badges/shields/issues/new/choose
+
+### Spreading the word
+
+Feel free to star the repository. This will help increase the visibility of the project, therefore attracting more users and contributors to Shields!
+
+We're also asking for [one-time \$10 donations](https://opencollective.com/shields) from developers who use and love Shields, please spread the word!
+
+## Getting help
+
+There are three places to get help:
+
+1. If you're new to the project, a good place to start is the [tutorial][].
+2. If you need help getting started or implementing a change, [open an issue][]
+   with your question. We promise it's okay to do that. If there is already an
+   issue open for the feature you're working on, you can post there.
+3. You can also join the [chat room][] and ask your question there.
+
+[tutorial]: doc/TUTORIAL.md
+
+## Badge guidelines
+
+- Shields.io hosts integrations for services which are primarily
+  used by developers or which are widely used by developers
+- The left-hand side of a badge should not advertise. It should be a lowercase _noun_
+  succinctly describing the meaning of the right-hand side.
+- Except for badges using the `social` style, logos should be _turned off by
+  default_.
+
+## Badge URLs
 
-- The left-hand side of a badge should not advertize. It should be a noun
-  describing succinctly the meaning of the right-hand-side data.
-- New query parameters (such as `?label=` or `?style=`) should apply to any
-  requested badge. They must be registered in the cache (see `LruCache` in
-  `server.js`).
 - The format of new badges should be of the form
-  `/VENDOR/SUBVENDOR-BADGE-SPECIFIC/PARAMETERS.format`. For instance,
-  `https://img.shields.io/gitter/room/nwjs/nw.js.svg`. The vendor is gitter, the
+  `/SERVICE/NOUN/PARAMETERS/QUALIFIERS.format`. For instance,
+  `/gitter/room/nwjs/nw.js.svg`. The vendor is gitter, the
   badge is for rooms, the parameter is nwjs/nw.js, and the format is svg.
+- For services which require a hostname, the badge should be of the form
+  `/SERVICE/SCHEME/HOST/NOUN/PARAMETERS/QUALIFIERS.format`. For instance,
+  `/discourse/https/discourse.example.com/topics.svg`.
 
-## Implementations
+## Coding guidelines
 
-The main implementation, available at <http://shields.io>, has its code located in this repository.
+### Prettier
 
-Other systems that produce badges following the same design, hosted elsewhere, are listed below.
+This project formats its source code using Prettier. The most enjoyable way to
+use Prettier is to let it format code for you when you save. You can [integrate
+it into your editor][integrate prettier].
 
-| website / AP                      | language   | issues                       |
-| --------------------------------- | ---------- | ---------------------------- |
-| shielded                          | JavaScript | [shielded][shielded issues]  |
-| [buckler.repl.ca][]               | Go         | [buckler][buckler issues]    |
-| old img.shields.io (discontinued) | Python     | [img.shields.io-old][]       |
-| DotBadge                          | C#         | [DotBadge](https://github.com/rebornix/DotBadge/issues) |
+Whether you integrate it into your editor or not, a pre-commit hook will run
+Prettier before a commit by default.
 
-Please report **bugs** and discuss implementation specific concerns (performance characteristics, etc.) in the repository for the respective implementation.
+[integrate prettier]: https://prettier.io/docs/en/editors.html
 
-## Adding support for a service
+### Tests
 
-Please [open an issue][new issue] if you'd like to use Shields badges for a project that isn't yet supported.
+When adding or changing a service [please write tests][service-tests].
 
+When opening a pull request, include your service name in brackets in the pull
+request title. That way, those service tests will run in CI.
 
-[shields.io]: http://shields.io/
-[website]: https://github.com/badges/shields/tree/gh-pages
-[GitHub Issues]: https://github.com/badges/shields/issues
-[new issue]: https://github.com/badges/shields/issues/new
+e.g. **[Travis] Fix timeout issues**
 
-[img.shields.io]: http://img.shields.io/
-[gh-badges issues]: https://github.com/badges/shields/issues
-[primary]: https://github.com/badges/shields/issues/94
+When changing other code, please add unit tests.
 
-[shielded issues]: https://github.com/badges/shielded/issues
+To run the integration tests, you must have redis installed and in your PATH.
+Use `brew install redis`, `yum install redis`, etc. The test runner will
+start the server automatically.
 
-[buckler.repl.ca]: http://buckler.repl.ca/
-[buckler issues]: https://github.com/badges/buckler/issues
+[service-tests]: https://github.com/badges/shields/blob/master/doc/service-tests.md
 
-[img.shields.io-old]: https://github.com/badges/img.shields.io-old/issues
+### Code organization
+
+There is a [High-level code walkthrough](doc/code-walkthrough.md) describing the layout of the project.
+
+### Logos
+
+We have [documentation for logo usage](doc/logos.md) which includes [contribution guidance](doc/logos.md#contributing-logos)

Dockerfile

@@ -1,3 +1,26 @@
-FROM node:0.12-onbuild
-ENV INFOSITE http://shields.io
+FROM node:8-alpine
+
+RUN apk add --no-cache gettext imagemagick librsvg git
+
+RUN mkdir -p /usr/src/app
+RUN mkdir /usr/src/app/private
+WORKDIR /usr/src/app
+
+COPY package.json package-lock.json /usr/src/app/
+# Without the gh-badges package.json and CLI script in place, `npm ci` will fail.
+COPY gh-badges /usr/src/app/gh-badges/
+
+# We need dev deps to build the front end.
+RUN NODE_ENV=development npm ci
+
+COPY . /usr/src/app
+RUN npm run build
+RUN npm prune --production
+RUN npm cache clean --force
+
+# Run the server using production configs.
+ENV NODE_ENV production
+
+CMD node server
+
 EXPOSE 80

INSTALL.md

@@ -1,170 +0,0 @@
-# GitHub badges in SVG format
-
-[![npm version](http://img.shields.io/npm/v/gh-badges.svg)](https://npmjs.org/package/gh-badges)
-
-![coverage](https://rawgithub.com/badges/shields/master/coverage.svg)
-
-[![build status](http://img.shields.io/travis/badges/gh-badges.svg)](https://travis-ci.org/badges/gh-badges)
-
-Make your own badges [here][badges]! (Quick guide: `https://img.shields.io/badge/left-right-f39f37.svg`.)
-
-[badges]: <http://shields.io/#your-badge>
-
-# Install the API
-
-```bash
-npm install gh-badges
-```
-
-```js
-var badge = require('gh-badges');
-// Optional step, to have accurate text width computation.
-badge.loadFont('/path/to/Verdana.ttf', function(err) {
-  badge({ text: ["build", "passed"], colorscheme: "green", template: "flat" },
-    function(svg, err) {
-      // svg is a String of your badge.
-    });
-});
-```
-
-# Use the CLI
-
-```bash
-npm install -g gh-badges
-badge build passed :green .png > mybadge.png
-# Stored a PNG version of your badge on disk.
-```
-
-# Start the Server
-To run the server you will need the following executables on your Path:
-- [PhantomJS](http://www.phantomjs.org/)
-
-On an OS X machine, [Homebrew](brew.sh) is a good package manager that will
-allow you to install that.
-
-On Ubuntu / Debian: `sudo apt-get install phantomjs`.
-
-```bash
-git clone https://github.com/badges/shields.git
-cd shields
-npm install  # You may need sudo for this.
-sudo node server
-```
-
-The server uses port 80 by default, which requires `sudo` permissions.
-There are two ways to provide an alternate port:
-
-```bash
-PORT=8080 node server
-node server 8080
-```
-
-The root gets redirected to <http://shields.io>.
-For testing purposes, you can go to `http://localhost/try.html`.
-You should modify that file. The "real" root, `http://localhost/index.html`,
-gets generated from the `try.html` file.
-
-# Format
-
-The format is the following:
-
-```js
-{
-  /* Textual information shown, in order. */
-  "text": [ "build", "passed" ],
-  "format": "svg",  // Also supports "json".
-  "colorscheme": "green",
-  /* … Or… */
-  "colorA": "#555",
-  "colorB": "#4c1",
-  /* See template/ for a list of available templates.
-     Each offers a different visual design. */
-  "template": "flat"
-}
-```
-
-# Defaults
-
-If you want to add a colorscheme, head to `colorscheme.json`. Each scheme has a
-name and a [CSS/SVG color][] for the color used in the first box (for the first
-piece of text, field `colorA`) and for the one used in the second box (field
-`colorB`).
-
-[CSS/SVG color]: http://www.w3.org/TR/SVG/types.html#DataTypeColor
-
-```js
-"green": {
-  "colorB": "#4c1"
-}
-```
-
-Both `colorA` and `colorB` have default values. Usually, the first box uses the
-same dark grey, so you can rely on that default value by not providing a
-`"colorA"` field (such as above).
-
-You can also use the `"colorA"` and `"colorB"` fields directly in the badges if
-you don't want to make a color scheme for it. In that case, remove the
-`"colorscheme"` field altogether.
-
-# Making your Heroku badge server
-
-Once you have installed the [Heroku Toolbelt][]:
-
-[Heroku Toolbelt]: https://toolbelt.heroku.com/
-
-```bash
-heroku login
-heroku create your-app-name
-heroku config:set BUILDPACK_URL=https://github.com/mojodna/heroku-buildpack-multi.git#build-env
-cp /path/to/Verdana.ttf .
-make deploy
-heroku open
-```
-
-# Docker
-
-You can build and run the server locally using Docker. First build an image:
-
-```console
-$ docker build -t shields ./
-Sending build context to Docker daemon 3.923 MB
-Step 0 : FROM node:0.12.7-onbuild
-…
-Removing intermediate container c4678889953f
-Successfully built 4471b442c220
-```
-
-Then run the container:
-
-```console
-$ docker run --rm -p 8080:80 shields
-
-> gh-badges@1.1.2 start /usr/src/app
-> node server.js
-
-http://[::1]:80/try.html
-```
-
-Assuming Docker is running locally, you should be able to get to the application at http://localhost:8080/try.html. If you run Docker in a virtual machine (such as boot2docker or Docker Machine) then you will need to replace `localhost` with the actual IP address of that virtual machine.
-
-# Main Server Sysadmin
-
-- DNS round-robin between https://vps197850.ovh.net/try.html and https://vps244529.ovh.net/try.html.
-- Self-signed TLS certificates, but `img.shields.io` is behind CloudFlare, which provides signed certificates.
-- Using node v0.12.7 because later versions, combined with node-canvas, give inaccurate badge measurements.
-- Using forever (the node monitor) to automatically restart the server when it crashes.
-
-See https://github.com/badges/ServerScript for helper admin scripts.
-
-# Links
-
-See <https://github.com/h5bp/lazyweb-requests/issues/150> for a story of the
-project's inception.
-
-This is also available as a gem `badgerbadgerbadger`, [code here][gem].
-
-[gem]: https://github.com/badges/badgerbadgerbadger
-
-# License
-
-All work here is licensed CC0.

LICENSE

@@ -0,0 +1,116 @@
+CC0 1.0 Universal
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific
+works ("Commons") that the public can reliably and without fear of later
+claims of infringement build upon, modify, incorporate in other works, reuse
+and redistribute as freely as possible in any form whatsoever and for any
+purposes, including without limitation commercial purposes. These owners may
+contribute to the Commons to promote the ideal of a free culture and the
+further production of creative, cultural and scientific works, or to gain
+reputation or greater distribution for their Work in part through the use and
+efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation
+of additional consideration or compensation, the person associating CC0 with a
+Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
+and publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not limited
+to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display, communicate,
+  and translate a Work;
+
+  ii. moral rights retained by the original author(s) and/or performer(s);
+
+  iii. publicity and privacy rights pertaining to a person's image or likeness
+  depicted in a Work;
+
+  iv. rights protecting against unfair competition in regards to a Work,
+  subject to the limitations in paragraph 4(a), below;
+
+  v. rights protecting the extraction, dissemination, use and reuse of data in
+  a Work;
+
+  vi. database rights (such as those arising under Directive 96/9/EC of the
+  European Parliament and of the Council of 11 March 1996 on the legal
+  protection of databases, and under any national implementation thereof,
+  including any amended or successor version of such directive); and
+
+  vii. other similar, equivalent or corresponding rights throughout the world
+  based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
+and Related Rights and associated claims and causes of action, whether now
+known or unknown (including existing as well as future claims and causes of
+action), in the Work (i) in all territories worldwide, (ii) for the maximum
+duration provided by applicable law or treaty (including future time
+extensions), (iii) in any current or future medium and for any number of
+copies, and (iv) for any purpose whatsoever, including without limitation
+commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
+the Waiver for the benefit of each member of the public at large and to the
+detriment of Affirmer's heirs and successors, fully intending that such Waiver
+shall not be subject to revocation, rescission, cancellation, termination, or
+any other legal or equitable action to disrupt the quiet enjoyment of the Work
+by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+judged legally invalid or ineffective under applicable law, then the Waiver
+shall be preserved to the maximum extent permitted taking into account
+Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
+is so judged Affirmer hereby grants to each affected person a royalty-free,
+non transferable, non sublicensable, non exclusive, irrevocable and
+unconditional license to exercise Affirmer's Copyright and Related Rights in
+the Work (i) in all territories worldwide, (ii) for the maximum duration
+provided by applicable law or treaty (including future time extensions), (iii)
+in any current or future medium and for any number of copies, and (iv) for any
+purpose whatsoever, including without limitation commercial, advertising or
+promotional purposes (the "License"). The License shall be deemed effective as
+of the date CC0 was applied by Affirmer to the Work. Should any part of the
+License for any reason be judged legally invalid or ineffective under
+applicable law, such partial invalidity or ineffectiveness shall not
+invalidate the remainder of the License, and in such case Affirmer hereby
+affirms that he or she will not (i) exercise any of his or her remaining
+Copyright and Related Rights in the Work or (ii) assert any associated claims
+and causes of action with respect to the Work, in either case contrary to
+Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+  a. No trademark or patent rights held by Affirmer are waived, abandoned,
+  surrendered, licensed or otherwise affected by this document.
+
+  b. Affirmer offers the Work as-is and makes no representations or warranties
+  of any kind concerning the Work, express, implied, statutory or otherwise,
+  including without limitation warranties of title, merchantability, fitness
+  for a particular purpose, non infringement, or the absence of latent or
+  other defects, accuracy, or the present or absence of errors, whether or not
+  discoverable, all to the greatest extent permissible under applicable law.
+
+  c. Affirmer disclaims responsibility for clearing rights of other persons
+  that may apply to the Work or any use thereof, including without limitation
+  any person's Copyright and Related Rights in the Work. Further, Affirmer
+  disclaims responsibility for obtaining any necessary consents, permissions
+  or other rights required for any use of the Work.
+
+  d. Affirmer understands and acknowledges that Creative Commons is not a
+  party to this document and has no duty or obligation with respect to this
+  CC0 or use of the Work.
+
+For more information, please see
+<http://creativecommons.org/publicdomain/zero/1.0/>

LICENSE.md

@@ -1,33 +0,0 @@
-# DEDICATED TO THE PUBLIC DOMAIN
-
-Shields has been dedicated to the public domain. It is protected by the Creative Commons CC0 Universal Public Domain Dedication license. You can read the entire license below or at http://creativecommons.org/publicdomain/zero/1.0/deed.en.
-
-# CC0 UNIVERSAL PUBLIC DOMAIN DEDICATION LICENSE
-
-## Statement of Purpose
-
-The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work").
-
-Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others.
-
-For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights.
-
-1. Copyright and Related Rights. A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following:
-a. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work;
-b. moral rights retained by the original author(s) and/or performer(s);
-c. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work;
-rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below;
-d. rights protecting the extraction, dissemination, use and reuse of data in a Work;
-e. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and
-f. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof.
-
-2. Waiver. To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose.
-
-3. Public License Fallback. Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose.
-
-4. Limitations and Disclaimers.
-
-a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document.
-b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law.
-c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work.
-d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work.

Makefile

@@ -1,72 +1,70 @@
-all: website favicon test
+SHELL:=/bin/bash
 
-UNAME_S := $(shell uname -s)
-ifeq ($(UNAME_S),Linux)
-	SED=sed -r
-	NEWLINE=$\n
-endif
-ifeq ($(UNAME_S),Darwin)
-	SED=sed -E
-	NEWLINE=$$'\n'
-endif
+SERVER_TMP=${TMPDIR}shields-server-deploy
+FRONTEND_TMP=${TMPDIR}shields-frontend-deploy
 
-favicon:
-	node gh-badge.js '' '' '#bada55' .png > favicon.png
+# This branch is reserved for the deploy process and should not be used for
+# development. The deploy script will clobber it. To avoid accidentally
+# pushing secrets to GitHub, this branch is configured to reject pushes.
+WORKING_BRANCH=server-deploy-working-branch
 
-website:
-	cat try.html | $(SED) "s,(<img src=')(/[^'\?]+)',\1https://img.shields.io\2?maxAge=2592000'," \
-		| $(SED) "s,(<img src=')(/[^'\?]+\?[^']+)',\1https://img.shields.io\2\&maxAge=2592000'," \
-		| $(SED) "s,<span id='imgUrlPrefix'>,&https://img.shields.io," \
-		| $(SED) "s,var origin = '';,var origin = 'https://img.shields.io';," \
-		| $(SED) "s,<style>,<!-- WARNING: THIS FILE WAS GENERATED FROM try.html -->\\"$(NEWLINE)"<style>," > index.html
+all: test
 
-deploy: deploy-s0 deploy-s1 deploy-gh-pages
+deploy: deploy-s0 deploy-s1 deploy-s2 clean-server-deploy deploy-gh-pages deploy-gh-pages-clean
 
-deploy-s0:
-	git add -f Verdana.ttf
-	git add -f secret.json
-	git commit -m'MUST NOT BE ON GITHUB'
-	git push -f s0 HEAD:master
-	git reset HEAD~1
-	git checkout master
+deploy-s0: prepare-server-deploy push-s0
+deploy-s1: prepare-server-deploy push-s1
+deploy-s2: prepare-server-deploy push-s2
 
-deploy-s1:
-	git add -f Verdana.ttf
-	git add -f secret.json
-	git commit -m'MUST NOT BE ON GITHUB'
-	git push -f s1 HEAD:master
-	git reset HEAD~1
-	git checkout master
+prepare-server-deploy:
+	# Ship a copy of the front end to each server for debugging.
+	# https://github.com/badges/shields/issues/1220
+	INCLUDE_DEV_PAGES=false \
+		npm run build
+	rm -rf ${SERVER_TMP}
+	git worktree prune
+	git worktree add -B ${WORKING_BRANCH} ${SERVER_TMP}
+	cp -r public ${SERVER_TMP}
+	git -C ${SERVER_TMP} add -f public/
+	git -C ${SERVER_TMP} commit --no-verify -m '[DEPLOY] Add frontend for debugging'
+	cp config/local-shields-io-production.yml ${SERVER_TMP}/config/
+	git -C ${SERVER_TMP} add -f config/local-shields-io-production.yml
+	git -C ${SERVER_TMP} commit --no-verify -m '[DEPLOY] MUST NOT BE ON GITHUB'
+
+clean-server-deploy:
+	rm -rf ${SERVER_TMP}
+	git worktree prune
+
+push-s0:
+	git push -f s0 ${WORKING_BRANCH}:master
+
+push-s1:
+	git push -f s1 ${WORKING_BRANCH}:master
+
+push-s2:
+	git push -f s2 ${WORKING_BRANCH}:master
 
 deploy-gh-pages:
-	(git checkout -B gh-pages && \
-	git merge master && \
-	git push -f origin gh-pages:gh-pages) || git checkout master
-	git checkout master
+	rm -rf ${FRONTEND_TMP}
+	git worktree prune
+	GATSBY_BASE_URL=https://img.shields.io \
+		INCLUDE_DEV_PAGES=false \
+		npm run build
+	git worktree add -B gh-pages ${FRONTEND_TMP}
+	git -C ${FRONTEND_TMP} ls-files | xargs git -C ${FRONTEND_TMP} rm
+	git -C ${FRONTEND_TMP} commit --no-verify -m '[DEPLOY] Completely clean the index'
+	cp -r public/* ${FRONTEND_TMP}
+	echo shields.io > ${FRONTEND_TMP}/CNAME
+	touch ${FRONTEND_TMP}/.nojekyll
+	git -C ${FRONTEND_TMP} add .
+	git -C ${FRONTEND_TMP} commit --no-verify -m '[DEPLOY] Add built site'
+	git push -f origin gh-pages
 
-deploy-heroku:
-	git add -f Verdana.ttf
-	git add -f secret.json
-	git commit -m'MUST NOT BE ON GITHUB'
-	git push -f heroku HEAD:master
-	git reset HEAD~1
-	(git checkout -B gh-pages && \
-	git merge master && \
-	git push -f origin gh-pages:gh-pages) || git checkout master
-	git checkout master
-
-setup:
-	curl http://download.redis.io/releases/redis-2.8.8.tar.gz >redis.tar.gz \
-	&& tar xf redis.tar.gz \
-	&& rm redis.tar.gz \
-	&& mv redis-2.8.8 redis \
-	&& cd redis \
-	&& make
-
-redis:
-	./redis/src/redis-server
+deploy-gh-pages-clean:
+	rm -rf ${FRONTEND_TMP}
+	git worktree prune
 
 test:
 	npm test
 
-.PHONY: all favicon website deploy deploy-s0 deploy-s1 deploy-gh-pages deploy-heroku setup redis test
+.PHONY: all deploy prepare-server-deploy clean-server-deploy deploy-s0 deploy-s1 deploy-s2 push-s0 push-s1 push-s2 deploy-gh-pages deploy-gh-pages-clean deploy-heroku setup redis test

Procfile

@@ -0,0 +1 @@
+web: npm run start:server:prod

README.md

@@ -1,96 +1,241 @@
 <p align="center">
-    <img src="https://rawgit.com/badges/shields/master/logo.svg"
-         height="130">
+    <img src="./frontend/images/logo.svg"
+        height="130">
 </p>
 <p align="center">
-    <a href="https://www.gratipay.com/Shields/">
-        <img src="https://img.shields.io/gratipay/team/shields.svg"
-             alt="Gratipay">
-    </a>
-    <a href="https://npmjs.org/package/gh-badges">
-        <img src="https://img.shields.io/npm/v/gh-badges.svg"
-             alt="npm version">
-    </a>
-    <a href="https://travis-ci.org/badges/shields">
-        <img src="https://img.shields.io/travis/badges/shields.svg"
-             alt="build status">
-    </a>
+    <a href="https://github.com/badges/shields/graphs/contributors" alt="Contributors">
+        <img src="https://img.shields.io/github/contributors/badges/shields.svg" /></a>
+    <a href="#backers" alt="Backers on Open Collective">
+        <img src="https://img.shields.io/opencollective/backers/shields.svg" /></a>
+    <a href="#sponsors" alt="Sponsors on Open Collective">
+        <img src="https://img.shields.io/opencollective/sponsors/shields.svg" /></a>
+    <a href="https://github.com/badges/shields/pulse" alt="Activity">
+        <img src="https://img.shields.io/github/commit-activity/m/badges/shields.svg" /></a>
+    <a href="https://circleci.com/gh/badges/shields/tree/master">
+        <img src="https://img.shields.io/circleci/project/github/badges/shields/master.svg" alt="build status"></a>
+    <a href="https://circleci.com/gh/badges/daily-tests">
+        <img src="https://img.shields.io/circleci/project/github/badges/daily-tests.svg?label=service%20tests"
+            alt="service-test status"></a>
+    <a href="https://coveralls.io/github/badges/shields">
+        <img src="https://img.shields.io/coveralls/github/badges/shields.svg"
+            alt="coverage"></a>
+    <a href="https://lgtm.com/projects/g/badges/shields/alerts/">
+        <img src="https://img.shields.io/lgtm/alerts/g/badges/shields.svg"
+            alt="Total alerts"/></a>
+    <a href="https://github.com/badges/shields/compare/gh-pages...master">
+        <img src="https://img.shields.io/github/commits-since/badges/shields/gh-pages.svg?label=commits%20to%20be%20deployed"
+            alt="commits to be deployed"></a>
+    <a href="https://discord.gg/HjJCwm5">
+        <img src="https://img.shields.io/discord/308323056592486420.svg?logo=discord"
+            alt="chat on Discord"></a>
+    <a href="https://twitter.com/intent/follow?screen_name=shields_io">
+        <img src="https://img.shields.io/twitter/follow/shields_io.svg?style=social&logo=twitter"
+            alt="follow on Twitter"></a>
 </p>
-<p align="center"><sup><strong>An image server for legible and concise information. Our <a href="http://shields.io/">Homepage</a> | <a href="https://twitter.com/shields_io">Twitter</a></strong></sup></p>
 
-* **[INSTALL](INSTALL.md)** – installation instructions.
-* **[CONTRIBUTING](CONTRIBUTING.md)** – project contribution guidelines.
-* **[SPECIFICATION](spec/SPECIFICATION.md)** – spec for the visual design of Shields badges.
-* **[LICENSE](LICENSE.md)** – public domain dedication.
+This is home to [Shields.io][shields.io], a service for concise, consistent,
+and legible badges in SVG and raster format, which can easily be included in
+GitHub readmes or any other web page. The service supports dozens of
+continuous integration services, package registries, distributions, app
+stores, social networks, code coverage services, and code analysis services.
+Every month it serves over 470 million images.
 
-Make your own badges [here][badges]! (Quick guide: `https://img.shields.io/badge/left-right-f39f37.svg`.)
+This repo hosts:
 
-[badges]: <http://shields.io/#your-badge>
+- The [Shields.io][shields.io] frontend and server code
+- An [NPM library for generating badges][gh-badges]
+  - [documentation][gh-badges-docs]
+  - [changelog][gh-badges-changelog]
+- The [badge design specification][badge-spec]
 
-## Solving the problem
-Many GitHub repositories sport badges for things like:
-<table>
-  <tr>
-    <td><a href="https://travis-ci.org/"><strong>Travis CI</strong></a><p><sup>(build status)</sup></p></td>
-    <td><img src="http://f.cl.ly/items/2H233M0I0T43313c3h0C/Screen%20Shot%202013-01-30%20at%202.45.30%20AM.png" alt="Travis CI badge"></td>
-  </tr>
-  <tr>
-    <td><a href="https://gemnasium.com/"><strong>Gemnasium</strong></a><p><sup>(dependency checks)</sup></p></td>
-    <td><img src="http://f.cl.ly/items/2j1D2R0q2C3s1x2y3k09/Screen%20Shot%202013-01-30%20at%202.46.10%20AM.png" alt="Gemnasium badge"></td>
-  </tr>
-  <tr>
-    <td><a href="http://codeclimate.com"><strong>Code Climate</strong></a><p><sup>(static analysis)</sup></p></td>
-    <td><img src="http://f.cl.ly/items/0H2O1A3q2b3j1D2i0M3j/Screen%20Shot%202013-01-30%20at%202.46.47%20AM.png" alt="Code Climate badge"></td>
-  </tr>
-  <tr>
-    <td><a href="http://rubygems.org"><strong>RubyGems</strong></a><p><sup>(released gem version)</sup></p></td>
-    <td><img src="http://f.cl.ly/items/443X21151h1V301s2s3a/Screen%20Shot%202013-01-30%20at%202.47.10%20AM.png" alt="RubyGems badge"></td>
-  </tr>
-</table>
-
-As you can see from the zoomed 400% versions of these badges above, nobody is (really) using the same badge file and at normal size, they're hardly legible. Worst of all, they're completely inconsistent. The information provided isn't of the same kind on each badge. The context is blurry, which doesn't make for a straightforward understanding of how these badges are relevant to the project they're attached to and what information they provide.
-
-## The Shields solution
-As you can see below, without increasing the footprint of these badges, I've tried to increase legibility and coherence, removing useless text to decrease the horizontal length in the (likely) scenario that more of these badge thingies crop up on READMEs all across the land.
-
-![Badge design](spec/proportions.png)
-
-This badge design corresponds to an old and now deprecated version which has since been replaced by beautiful and scalable SVG versions that can be found on [shields.io](http://shields.io).
+[shields.io]: https://shields.io/
+[gh-badges]: https://www.npmjs.com/package/gh-badges
+[badge-spec]: https://github.com/badges/shields/tree/master/spec
+[gh-badges-docs]: https://github.com/badges/shields/tree/master/gh-badges/README.md
+[gh-badges-changelog]: https://github.com/badges/shields/tree/master/gh-badges/CHANGELOG.md
 
 ## Examples
-What kind of metadata can you convey using badges?
-* test build status: `build | failing`
-* code coverage percentage: `coverage | 80%`
-* stable release version: `version | 1.2.3`
-* package manager release: `gem | 1.2.3`
-* status of third-party dependencies: `dependencies | out-of-date`
-* static code analysis GPA: `code climate | 3.8`
-* [SemVer](http://semver.org/) version observance: `semver | 2.0.0`
-* amount of [Gratipay](http://gratipay.com) donations per week: `tips | $2/week`
 
-## Services using the Shields standard
-* [Badger](https://github.com/badges/badgerbadgerbadger)
-* [badges2svg](https://github.com/bfontaine/badges2svg)
-* [Codacy](https://www.codacy.com)
-* [Code Climate](https://codeclimate.com/changelog/510d4fde56b102523a0004bf)
-* [Coveralls](https://coveralls.io/)
-* [Forkability](http://basicallydan.github.io/forkability/)
-* [Gemnasium](http://support.gemnasium.com/forums/236528-general/suggestions/5518400-use-svg-for-badges-so-they-still-look-sharp-on-r)
-* [GoDoc](https://godoc.org/)
-* [PHPPackages](https://phppackages.org)
-* [Read the Docs](https://readthedocs.org/)
-* [reposs](https://github.com/rexfinn/reposs)
-* [ruby-gem-downloads-badge](https://github.com/bogdanRada/ruby-gem-downloads-badge/)
-* [Scrutinizer](https://scrutinizer-ci.com/)
-* [Semaphore](https://semaphoreapp.com)
-* [Travis CI](https://github.com/travis-ci/travis-ci/issues/630#issuecomment-38054967)
-* [Version Badge](http://badge.fury.io/)
-* [VersionEye](https://www.versioneye.com/)
+- code coverage percentage: ![coverage](https://img.shields.io/badge/coverage-80%25-yellowgreen.svg?cacheSeconds=2592000)
+- stable release version: ![version](https://img.shields.io/badge/version-1.2.3-blue.svg?cacheSeconds=2592000)
+- package manager release: ![gem](https://img.shields.io/badge/gem-2.2.0-blue.svg?cacheSeconds=2592000)
+- status of third-party dependencies: ![dependencies](https://img.shields.io/badge/dependencies-out%20of%20date-orange.svg?cacheSeconds=2592000)
+- static code analysis grade: ![codacy](https://img.shields.io/badge/codacy-B-green.svg?cacheSeconds=2592000)
+- [SemVer](https://semver.org/) version observance: ![semver](https://img.shields.io/badge/semver-2.0.0-blue.svg?cacheSeconds=2592000)
+- amount of [Liberapay](https://liberapay.com/) donations per week: ![receives](https://img.shields.io/badge/receives-2.00%20USD%2Fweek-yellow.svg?cacheSeconds=2592000)
+- Python package downloads: ![downloads](https://img.shields.io/badge/downloads-13k%2Fmonth-brightgreen.svg?cacheSeconds=2592000)
+- Chrome Web Store extension rating: ![rating](https://img.shields.io/badge/rating-★★★★☆-brightgreen.svg?cacheSeconds=2592000)
+- [Uptime Robot](https://uptimerobot.com) percentage: ![uptime](https://img.shields.io/badge/uptime-100%25-brightgreen.svg?cacheSeconds=2592000)
 
-# Legal
+[Make your own badges!][custom badges]
+(Quick example: `https://img.shields.io/badge/left-right-f39f37.svg`)
 
-All assets and code are under the [CC0 LICENSE](LICENSE.md) and in the public
+Browse a [complete list of badges][shields.io].
+
+[custom badges]: http://shields.io/#your-badge
+
+## Contributing
+
+Shields is a community project. We invite your participation through issues
+and pull requests! You can peruse the [contributing guidelines][contributing].
+
+When adding or changing a service [please add tests][service-tests].
+
+This project has quite a backlog of suggestions! If you're new to the project,
+maybe you'd like to open a pull request to address one of them:
+
+[![GitHub issues by-label](https://img.shields.io/github/issues/badges/shields/good%20first%20issue.svg)](https://github.com/badges/shields/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+
+You can read a [tutorial on how to add a badge][tutorial].
+
+[service-tests]: https://github.com/badges/shields/blob/master/doc/service-tests.md
+[tutorial]: doc/TUTORIAL.md
+[contributing]: CONTRIBUTING.md
+
+## Development
+
+1. Install Node 8 or later. You can use the [package manager][] of your choice.
+   Tests need to pass in Node 8 and 10.
+2. Clone this repository.
+3. Run `npm ci` to install the dependencies.
+4. Run `npm start` to start the badge server and the frontend dev server.
+5. Open `http://localhost:3000/` to view the frontend.
+
+When server source files change, the badge server should automatically restart
+itself (using [nodemon][]). When the frontend files change, the frontend dev
+server (`gatsby dev`) should also automatically reload. However the badge
+definitions are built only before the server first starts. To regenerate those,
+either run `npm run defs` or manually restart the server.
+
+To debug a badge from the command line, run `npm run badge -- /npm/v/nock.svg`.
+It also works with full URLs like
+`npm run badge -- https://img.shields.io/npm/v/nock.svg`.
+
+Use `npm run debug:server` to start server in debug mode.
+[This recipe][nodemon debug] shows how to debug Node.js application in [VS Code][].
+
+Shields has experimental support for [Gitpod Beta][gitpod], a pre-configured development
+environment that runs in your browser. To use Gitpod, click the button below and
+sign in with GitHub. Gitpod also offers a browser add-on, though it is not required.
+Please report any Gitpod bugs, questions, or suggestions in issue
+[#2772](https://github.com/badges/shields/issues/2772).
+
+[![Edit with Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/badges/shields)
+
+[Snapshot tests][] ensure we don't inadvertently make changes that affect the
+SVG or JSON output. When deliberately changing the output, run
+`SNAPSHOT_DRY=1 npm run test:js:server` to preview changes to the saved
+snapshots, and `SNAPSHOT_UPDATE=1 npm run test:js:server` to update them.
+
+The server can be configured to use [Sentry][] ([configuration][sentry configuration]) and [Prometheus][] ([configuration][prometheus configuration]).
+
+Daily tests, including a full run of the service tests and overall code coverage, are run via [badges/daily-tests][daily-tests].
+
+[package manager]: https://nodejs.org/en/download/package-manager/
+[gitpod]: https://www.gitpod.io/
+[snapshot tests]: https://glebbahmutov.com/blog/snapshot-testing/
+[prometheus]: https://prometheus.io/
+[prometheus configuration]: doc/self-hosting.md#prometheus
+[sentry]: https://sentry.io/
+[sentry configuration]: doc/self-hosting.md#sentry
+[daily-tests]: https://github.com/badges/daily-tests
+[nodemon]: https://nodemon.io/
+[nodemon debug]: https://github.com/Microsoft/vscode-recipes/tree/master/nodemon
+[vs code]: https://code.visualstudio.com/
+
+## Hosting your own server
+
+There is documentation about [hosting your own server][self-hosting].
+
+[self-hosting]: doc/self-hosting.md
+
+## History
+
+b.adge.me was the original website for this service. Heroku back then had a
+thing which made it hard to use a toplevel domain with it, hence the odd
+domain. It used code developed in 2013 from a library called
+[gh-badges][old-gh-badges], both developed by [Thaddée Tyl][espadrine].
+The project merged with shields.io by making it use the b.adge.me code
+and closed b.adge.me.
+
+The original badge specification was developed in 2013 by
+[Olivier Lacan][olivierlacan]. It was inspired by the Travis CI and similar
+badges (there were a lot fewer, back then). In 2014 Thaddée Tyl redesigned
+it with help from a Travis CI employee and convinced everyone to switch to
+it. The old design is what today is called the plastic style; the new one
+is the flat style.
+
+You can read more about [the project's inception][thread],
+[the motivation of the SVG badge specification][motivation], and
+[the specification itself][spec].
+
+[olivierlacan]: https://github.com/olivierlacan
+[espadrine]: https://github.com/espadrine
+[old-gh-badges]: https://github.com/badges/gh-badges
+[motivation]: spec/motivation.md
+[spec]: spec/SPECIFICATION.md
+[thread]: https://github.com/h5bp/lazyweb-requests/issues/150
+
+## Project leaders
+
+Maintainers:
+
+- [calebcartwright](https://github.com/calebcartwright) (core team)
+- [chris48s](https://github.com/chris48s) (core team)
+- [Daniel15](https://github.com/Daniel15) (core team)
+- [espadrine](https://github.com/espadrine) (core team)
+- [paulmelnikow](https://github.com/paulmelnikow) (core team)
+- [platan](https://github.com/platan) (core team)
+- [PyvesB](https://github.com/PyvesB) (core team)
+- [RedSparr0w](https://github.com/RedSparr0w) (core team)
+
+Operations:
+
+- [espadrine](https://github.com/espadrine) (sysadmin)
+- [paulmelnikow](https://github.com/paulmelnikow) (limited access)
+
+Alumni:
+
+- [olivierlacan](https://github.com/olivierlacan)
+
+## Related projects
+
+- [badgerbadgerbadger gem][gem]
+- [pybadges python library][pybadges]
+
+[gem]: https://github.com/badges/badgerbadgerbadger
+[pybadges]: https://github.com/google/pybadges
+
+## License
+
+All assets and code are under the [CC0 LICENSE](LICENSE) and in the public
 domain unless specified otherwise.
 
-The assets in `logo/` are trademarks of their respective companies and are under
-their terms and license.
+The assets in `logo/` are trademarks of their respective companies and are
+under their terms and license.
+
+## Contributors
+
+This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
+<a href="https://github.com/badges/shields/graphs/contributors"><img src="https://opencollective.com/shields/contributors.svg?width=890" /></a>
+
+## Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/shields#backer)]
+
+<a href="https://opencollective.com/shields#backers" target="_blank"><img src="https://opencollective.com/shields/backers.svg?width=890"></a>
+
+## Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/shields#sponsor)]
+
+<a href="https://opencollective.com/shields/sponsor/0/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/0/avatar.svg"></a>
+<a href="https://opencollective.com/shields/sponsor/1/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/1/avatar.svg"></a>
+<a href="https://opencollective.com/shields/sponsor/2/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/2/avatar.svg"></a>
+<a href="https://opencollective.com/shields/sponsor/3/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/3/avatar.svg"></a>
+<a href="https://opencollective.com/shields/sponsor/4/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/4/avatar.svg"></a>
+<a href="https://opencollective.com/shields/sponsor/5/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/5/avatar.svg"></a>
+<a href="https://opencollective.com/shields/sponsor/6/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/6/avatar.svg"></a>
+<a href="https://opencollective.com/shields/sponsor/7/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/7/avatar.svg"></a>
+<a href="https://opencollective.com/shields/sponsor/8/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/8/avatar.svg"></a>
+<a href="https://opencollective.com/shields/sponsor/9/website" target="_blank"><img src="https://opencollective.com/shields/sponsor/9/avatar.svg"></a>

__snapshots__/make-badge.spec.js

@@ -0,0 +1,19 @@
+exports['The badge generator SVG should always produce the same SVG (unless we have changed something!) 1'] = `
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="90" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="90" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h45v20H0z"/><path fill="#4c1" d="M45 0h45v20H45z"/><path fill="url(#b)" d="M0 0h90v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"> <text x="235" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="350">cactus</text><text x="235" y="140" transform="scale(.1)" textLength="350">cactus</text><text x="665" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="350">grown</text><text x="665" y="140" transform="scale(.1)" textLength="350">grown</text></g> </svg>
+`
+
+exports['The badge generator badges with logos should always produce the same badge shields GitHub logo custom color (whitesmoke) 1'] = `
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="113" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="113" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h54v20H0z"/><path fill="#4c1" d="M54 0h59v20H54z"/><path fill="url(#b)" d="M0 0h113v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"><image x="5" y="3" width="14" height="14" xlink:href="github"/> <text x="365" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">label</text><text x="365" y="140" transform="scale(.1)" textLength="270">label</text><text x="825" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="490">message</text><text x="825" y="140" transform="scale(.1)" textLength="490">message</text></g> </svg>
+`
+
+exports['The badge generator badges with logos should always produce the same badge shields GitHub logo default color (#333333) 1'] = `
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="113" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="113" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h54v20H0z"/><path fill="#4c1" d="M54 0h59v20H54z"/><path fill="url(#b)" d="M0 0h113v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"><image x="5" y="3" width="14" height="14" xlink:href="github"/> <text x="365" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">label</text><text x="365" y="140" transform="scale(.1)" textLength="270">label</text><text x="825" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="490">message</text><text x="825" y="140" transform="scale(.1)" textLength="490">message</text></g> </svg>
+`
+
+exports['The badge generator badges with logos should always produce the same badge simple-icons javascript logo custom color (rgba(46,204,113,0.8)) 1'] = `
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="113" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="113" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h54v20H0z"/><path fill="#4c1" d="M54 0h59v20H54z"/><path fill="url(#b)" d="M0 0h113v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"><image x="5" y="3" width="14" height="14" xlink:href="javascript"/> <text x="365" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">label</text><text x="365" y="140" transform="scale(.1)" textLength="270">label</text><text x="825" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="490">message</text><text x="825" y="140" transform="scale(.1)" textLength="490">message</text></g> </svg>
+`
+
+exports['The badge generator badges with logos should always produce the same badge simple-icons javascript logo default color (#F7DF1E) 1'] = `
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="113" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="113" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h54v20H0z"/><path fill="#4c1" d="M54 0h59v20H54z"/><path fill="url(#b)" d="M0 0h113v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"><image x="5" y="3" width="14" height="14" xlink:href="javascript"/> <text x="365" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">label</text><text x="365" y="140" transform="scale(.1)" textLength="270">label</text><text x="825" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="490">message</text><text x="825" y="140" transform="scale(.1)" textLength="490">message</text></g> </svg>
+`

app.json

@@ -0,0 +1,24 @@
+{
+  "name": "Shields",
+  "description": "Concise, consistent, and legible badges in SVG and raster format.",
+  "keywords": ["badge", "github", "svg", "status"],
+  "website": "https://shields.io/",
+  "repository": "https://github.com/badges/shields",
+  "logo": "http://shields.io/favicon.png",
+  "env": {
+    "WHEELMAP_TOKEN": {
+      "description": "Configure the token to be used for the Wheelmap service.",
+      "required": false
+    },
+    "GH_TOKEN": {
+      "description": "Configure the token to be used for the GitHub services.",
+      "required": false
+    }
+  },
+  "formation": {
+    "web": {
+      "quantity": 1,
+      "size": "free"
+    }
+  }
+}

badge.js

@@ -1,102 +0,0 @@
-var fs = require('fs');
-var path = require('path');
-var SVGO = require('svgo');
-var dot = require('dot');
-var measureTextWidth = require('./measure-text');
-
-// cache templates.
-var templates = {};
-var templateFiles = fs.readdirSync(path.join(__dirname, 'templates'));
-dot.templateSettings.strip = false;  // Do not strip whitespace.
-templateFiles.forEach(function(filename) {
-  if (filename[0] === '.') { return; }
-  var templateData = fs.readFileSync(
-    path.join(__dirname, 'templates', filename)).toString();
-  var extension = filename.split('.').pop();
-  var style = filename.slice(0, -(('-template.' + extension).length));
-  templates[style + '-' + extension] = dot.template(templateData);
-});
-
-function escapeXml(s) {
-  return s.replace(/&/g, '&')
-          .replace(/</g, '&lt;')
-          .replace(/>/g, '&gt;')
-          .replace(/"/g, '&quot;')
-          .replace(/'/g, '&apos;');
-}
-function capitalize(s) {
-  return s[0].toUpperCase() + s.slice(1);
-}
-function addEscapers(data) {
-  data.escapeXml = escapeXml;
-  data.capitalize = capitalize;
-}
-
-var colorscheme = require(path.join(__dirname, 'colorscheme.json'));
-
-function optimize(string, callback) {
-  var svgo = new SVGO();
-  svgo.optimize(string, callback);
-}
-
-function makeImage(data, cb) {
-  if (data.format !== 'json') {
-    data.format = 'svg';
-  }
-  if (!(data.template + '-' + data.format in templates)) {
-    data.template = 'default';
-  }
-  if (data.colorscheme) {
-    var pickedColorscheme = colorscheme[data.colorscheme];
-    if (!pickedColorscheme) {
-      pickedColorscheme = colorscheme.red;
-    }
-    data.colorA = pickedColorscheme.colorA;
-    data.colorB = pickedColorscheme.colorB;
-  }
-  // Logo.
-  data.logoWidth = +data.logoWidth || (data.logo? 14: 0);
-  data.logoPadding = (data.logo? 3: 0);
-  // String coercion.
-  data.text[0] = '' + data.text[0];
-  data.text[1] = '' + data.text[1];
-  if (data.text[0].length === 0) {
-    data.logoPadding = 0;
-  }
-
-  var textWidth1 = (measureTextWidth(data.text[0])|0);
-  var textWidth2 = (measureTextWidth(data.text[1])|0);
-  // Increase chances of pixel grid alignment.
-  if (textWidth1 % 2 === 0) { textWidth1++; }
-  if (textWidth2 % 2 === 0) { textWidth2++; }
-  data.widths = [
-    textWidth1 + 10 + data.logoWidth + data.logoPadding,
-    textWidth2 + 10,
-  ];
-  if (data.links === undefined) {
-    data.links = ['', ''];
-  } else {
-    for (var i = 0; i < data.links.length; i++) {
-      data.links[i] = escapeXml(data.links[i]);
-    }
-  }
-
-  var template = templates[data.template + '-' + data.format];
-  addEscapers(data);
-  try {
-    var result = template(data);
-  } catch(e) {
-    cb('', e);
-    return;
-  }
-
-  if (data.format === 'json') {
-    cb(result);
-  } else {
-    // Run the SVG through SVGO.
-    optimize(result, function(object) { cb(object.data); });
-  }
-}
-
-module.exports = makeImage;
-module.exports.loadFont = measureTextWidth.loadFont;

colorscheme.json

@@ -1,13 +0,0 @@
-{
-  "brightgreen":    { "colorB": "#4c1" },
-  "green":          { "colorB": "#97CA00" },
-  "yellow":         { "colorB": "#dfb317" },
-  "yellowgreen":    { "colorB": "#a4a61d" },
-  "orange":         { "colorB": "#fe7d37" },
-  "red":            { "colorB": "#e05d44" },
-  "blue":           { "colorB": "#007ec6" },
-  "grey":           { "colorB": "#555" },
-  "gray":           { "colorB": "#555" },
-  "lightgrey":      { "colorB": "#9f9f9f" },
-  "lightgray":      { "colorB": "#9f9f9f" }
-}

config/custom-environment-variables.yml

@@ -0,0 +1,64 @@
+public:
+  bind:
+    address: 'BIND_ADDRESS'
+    port: 'PORT'
+
+  metrics:
+    prometheus:
+      enabled: 'METRICS_PROMETHEUS_ENABLED'
+
+  ssl:
+    isSecure: 'HTTPS'
+    key: 'HTTPS_KEY'
+    cert: 'HTTPS_CRT'
+
+  redirectUri: 'REDIRECT_URI'
+
+  cors:
+    allowedOrigin:
+      __name: 'ALLOWED_ORIGIN'
+      __format: 'json'
+
+  persistence:
+    dir: 'PERSISTENCE_DIR'
+    redisUrl: 'REDIS_URL'
+
+  services:
+    github:
+      baseUri: 'GITHUB_URL'
+      debug:
+        enabled: 'GITHUB_DEBUG_ENABLED'
+        intervalSeconds: 'GITHUB_DEBUG_INTERVAL_SECONDS'
+    trace: 'TRACE_SERVICES'
+
+  profiling:
+    makeBadge: 'PROFILE_MAKE_BADGE'
+
+  cacheHeaders:
+    defaultCacheLengthSeconds: 'BADGE_MAX_AGE_SECONDS'
+
+  rateLimit: 'RATE_LIMIT'
+
+  fetchLimit: 'FETCH_LIMIT'
+
+private:
+  azure_devops_token: 'AZURE_DEVOPS_TOKEN'
+  bintray_user: 'BINTRAY_USER'
+  bintray_apikey: 'BINTRAY_API_KEY'
+  drone_token: 'DRONE_TOKEN'
+  gh_client_id: 'GH_CLIENT_ID'
+  gh_client_secret: 'GH_CLIENT_SECRET'
+  gh_token: 'GH_TOKEN'
+  jenkins_user: 'JENKINS_USER'
+  jenkins_pass: 'JENKINS_PASS'
+  jira_user: 'JIRA_USER'
+  jira_pass: 'JIRA_PASS'
+  nexus_user: 'NEXUS_USER'
+  nexus_pass: 'NEXUS_PASS'
+  npm_token: 'NPM_TOKEN'
+  sentry_dsn: 'SENTRY_DSN'
+  shields_secret: 'SHIELDS_SECRET'
+  sl_insight_userUuid: 'SL_INSIGHT_USER_UUID'
+  sl_insight_apiToken: 'SL_INSIGHT_API_TOKEN'
+  sonarqube_token: 'SONARQUBE_TOKEN'
+  wheelmap_token: 'WHEELMAP_TOKEN'

config/default.yml

@@ -0,0 +1,38 @@
+public:
+  bind:
+    address: '::'
+
+  metrics:
+    prometheus:
+      enabled: false
+
+  ssl:
+    isSecure: false
+
+  cors:
+    allowedOrigin: []
+
+  persistence:
+    dir: './private'
+
+  services:
+    github:
+      baseUri: 'https://api.github.com/'
+      debug:
+        enabled: false
+        intervalSeconds: 200
+    trace: false
+
+  profiling:
+    makeBadge: false
+
+  cacheHeaders:
+    defaultCacheLengthSeconds: 120
+
+  rateLimit: true
+
+  handleInternalErrors: true
+
+  fetchLimit: '10MB'
+
+private: {}

config/development.yml

@@ -0,0 +1,10 @@
+public:
+  bind:
+    address: 'localhost'
+
+  cors:
+    allowedOrigin: ['http://localhost:3000']
+
+  rateLimit: false
+
+  handleInternalErrors: false

config/local-shields-io-production.template.yml

@@ -0,0 +1,10 @@
+private:
+  bintray_user: ...
+  bintray_apikey: ...
+  gh_client_id: ...
+  gh_client_secret: ...
+  sentry_dsn: ...
+  shields_secret: ...
+  sl_insight_userUuid: ...
+  sl_insight_apiToken: ...
+  wheelmap_token: ...

config/local.template.yml

@@ -0,0 +1,8 @@
+# Copy this file to `config/local.yml` and fill it in! It will be gitignored.
+
+private:
+  # The possible values are documented in `doc/server-secrets.md`. Note that
+  # you can also set these values through environment variables, which may be
+  # preferable for self hosting.
+  gh_token: '...'
+  wheelmap_token: '...'

config/production.yml

@@ -0,0 +1,3 @@
+public:
+  bind:
+    address: '0.0.0.0'

config/shields-io-production.yml

@@ -0,0 +1,16 @@
+public:
+  metrics:
+    prometheus:
+      enabled: true
+
+  ssl:
+    isSecure: true
+
+  cors:
+    allowedOrigin: ['http://shields.io', 'https://shields.io']
+
+  redirectUrl: 'https://shields.io/'
+
+private:
+  # These are not really private; they should be moved to `public`.
+  shields_ips: ['192.99.59.72', '51.254.114.150', '149.56.96.133']

config/test.yml

@@ -0,0 +1,10 @@
+public:
+  bind:
+    address: 'localhost'
+    port: 1111
+
+  rateLimit: false
+
+  redirectUrl: 'http://badge-server.example.com'
+
+  handleInternalErrors: false

core/badge-urls/make-badge-url.js

@@ -0,0 +1,144 @@
+'use strict'
+
+const queryString = require('query-string')
+const pathToRegexp = require('path-to-regexp')
+
+function badgeUrlFromPath({
+  baseUrl = '',
+  path,
+  queryParams,
+  style,
+  format = 'svg',
+  longCache = false,
+}) {
+  const outExt = format.length ? `.${format}` : ''
+
+  const outQueryString = queryString.stringify({
+    cacheSeconds: longCache ? '2592000' : undefined,
+    style,
+    ...queryParams,
+  })
+  const suffix = outQueryString ? `?${outQueryString}` : ''
+
+  return `${baseUrl}${path}${outExt}${suffix}`
+}
+
+function badgeUrlFromPattern({
+  baseUrl = '',
+  pattern,
+  namedParams,
+  queryParams,
+  style,
+  format = 'svg',
+  longCache = false,
+}) {
+  const toPath = pathToRegexp.compile(pattern, {
+    strict: true,
+    sensitive: true,
+  })
+
+  const path = toPath(namedParams)
+
+  return badgeUrlFromPath({
+    baseUrl,
+    path,
+    queryParams,
+    style,
+    format,
+    longCache,
+  })
+}
+
+function encodeField(s) {
+  return encodeURIComponent(s.replace(/-/g, '--').replace(/_/g, '__'))
+}
+
+function staticBadgeUrl({
+  baseUrl = '',
+  label,
+  message,
+  color = 'lightgray',
+  style,
+  namedLogo,
+  format = 'svg',
+}) {
+  const path = [label, message, color].map(encodeField).join('-')
+  const outQueryString = queryString.stringify({
+    style,
+    logo: namedLogo,
+  })
+  const suffix = outQueryString ? `?${outQueryString}` : ''
+  return `${baseUrl}/badge/${path}.${format}${suffix}`
+}
+
+function queryStringStaticBadgeUrl({
+  baseUrl = '',
+  label,
+  message,
+  color,
+  labelColor,
+  style,
+  namedLogo,
+  logoColor,
+  logoWidth,
+  logoPosition,
+  format = 'svg',
+}) {
+  // schemaVersion could be a parameter if we iterate on it,
+  // for now it's hardcoded to the only supported version.
+  const schemaVersion = '1'
+  const suffix = `?${queryString.stringify({
+    label,
+    message,
+    color,
+    labelColor,
+    style,
+    logo: namedLogo,
+    logoColor,
+    logoWidth,
+    logoPosition,
+  })}`
+  return `${baseUrl}/static/v${schemaVersion}.${format}${suffix}`
+}
+
+function dynamicBadgeUrl({
+  baseUrl,
+  datatype,
+  label,
+  dataUrl,
+  query,
+  prefix,
+  suffix,
+  color,
+  style,
+  format = 'svg',
+}) {
+  const queryParams = {
+    label,
+    url: dataUrl,
+    query,
+    style,
+  }
+
+  if (color) {
+    queryParams.color = color
+  }
+  if (prefix) {
+    queryParams.prefix = prefix
+  }
+  if (suffix) {
+    queryParams.suffix = suffix
+  }
+
+  const outQueryString = queryString.stringify(queryParams)
+  return `${baseUrl}/badge/dynamic/${datatype}.${format}?${outQueryString}`
+}
+
+module.exports = {
+  badgeUrlFromPath,
+  badgeUrlFromPattern,
+  encodeField,
+  staticBadgeUrl,
+  queryStringStaticBadgeUrl,
+  dynamicBadgeUrl,
+}

core/badge-urls/make-badge-url.spec.js

@@ -0,0 +1,159 @@
+'use strict'
+
+const { test, given } = require('sazerac')
+const {
+  badgeUrlFromPath,
+  badgeUrlFromPattern,
+  encodeField,
+  staticBadgeUrl,
+  queryStringStaticBadgeUrl,
+  dynamicBadgeUrl,
+} = require('./make-badge-url')
+
+describe('Badge URL generation functions', function() {
+  test(badgeUrlFromPath, () => {
+    given({
+      baseUrl: 'http://example.com',
+      path: '/npm/v/gh-badges',
+      style: 'flat-square',
+      longCache: true,
+    }).expect(
+      'http://example.com/npm/v/gh-badges.svg?cacheSeconds=2592000&style=flat-square'
+    )
+  })
+
+  test(badgeUrlFromPattern, () => {
+    given({
+      baseUrl: 'http://example.com',
+      pattern: '/npm/v/:packageName',
+      namedParams: { packageName: 'gh-badges' },
+      style: 'flat-square',
+      longCache: true,
+    }).expect(
+      'http://example.com/npm/v/gh-badges.svg?cacheSeconds=2592000&style=flat-square'
+    )
+  })
+
+  test(encodeField, () => {
+    given('foo').expect('foo')
+    given('').expect('')
+    given('happy go lucky').expect('happy%20go%20lucky')
+    given('do-right').expect('do--right')
+    given('it_is_a_snake').expect('it__is__a__snake')
+  })
+
+  test(staticBadgeUrl, () => {
+    given({
+      label: 'foo',
+      message: 'bar',
+      color: 'blue',
+      style: 'flat-square',
+    }).expect('/badge/foo-bar-blue.svg?style=flat-square')
+    given({
+      label: 'foo',
+      message: 'bar',
+      color: 'blue',
+      style: 'flat-square',
+      format: 'png',
+      namedLogo: 'github',
+    }).expect('/badge/foo-bar-blue.png?logo=github&style=flat-square')
+    given({
+      label: 'Hello World',
+      message: 'Привет Мир',
+      color: '#aabbcc',
+    }).expect(
+      '/badge/Hello%20World-%D0%9F%D1%80%D0%B8%D0%B2%D0%B5%D1%82%20%D0%9C%D0%B8%D1%80-%23aabbcc.svg'
+    )
+    given({
+      label: '123-123',
+      message: 'abc-abc',
+      color: 'blue',
+    }).expect('/badge/123--123-abc--abc-blue.svg')
+    given({
+      label: '123-123',
+      message: '',
+      color: 'blue',
+      style: 'social',
+    }).expect('/badge/123--123--blue.svg?style=social')
+    given({
+      label: '',
+      message: 'blue',
+      color: 'blue',
+    }).expect('/badge/-blue-blue.svg')
+  })
+
+  test(queryStringStaticBadgeUrl, () => {
+    // the query-string library sorts parameters by name
+    given({
+      label: 'foo',
+      message: 'bar',
+      color: 'blue',
+      style: 'flat-square',
+    }).expect(
+      '/static/v1.svg?color=blue&label=foo&message=bar&style=flat-square'
+    )
+    given({
+      label: 'foo Bar',
+      message: 'bar Baz',
+      color: 'blue',
+      style: 'flat-square',
+      format: 'png',
+      namedLogo: 'github',
+    }).expect(
+      '/static/v1.png?color=blue&label=foo%20Bar&logo=github&message=bar%20Baz&style=flat-square'
+    )
+    given({
+      label: 'Hello World',
+      message: 'Привет Мир',
+      color: '#aabbcc',
+    }).expect(
+      '/static/v1.svg?color=%23aabbcc&label=Hello%20World&message=%D0%9F%D1%80%D0%B8%D0%B2%D0%B5%D1%82%20%D0%9C%D0%B8%D1%80'
+    )
+  })
+
+  test(dynamicBadgeUrl, () => {
+    const dataUrl = 'http://example.com/foo.json'
+    const query = '$.bar'
+    const prefix = 'value: '
+    given({
+      baseUrl: 'http://img.example.com',
+      datatype: 'json',
+      label: 'foo',
+      dataUrl,
+      query,
+      prefix,
+      style: 'plastic',
+    }).expect(
+      [
+        'http://img.example.com/badge/dynamic/json.svg',
+        '?label=foo',
+        `&prefix=${encodeURIComponent(prefix)}`,
+        `&query=${encodeURIComponent(query)}`,
+        '&style=plastic',
+        `&url=${encodeURIComponent(dataUrl)}`,
+      ].join('')
+    )
+    const suffix = '<- value'
+    const color = 'blue'
+    given({
+      baseUrl: 'http://img.example.com',
+      datatype: 'json',
+      label: 'foo',
+      dataUrl,
+      query,
+      suffix,
+      color,
+      style: 'plastic',
+    }).expect(
+      [
+        'http://img.example.com/badge/dynamic/json.svg',
+        '?color=blue',
+        '&label=foo',
+        `&query=${encodeURIComponent(query)}`,
+        '&style=plastic',
+        `&suffix=${encodeURIComponent(suffix)}`,
+        `&url=${encodeURIComponent(dataUrl)}`,
+      ].join('')
+    )
+  })
+})

core/badge-urls/path-helpers.js

@@ -0,0 +1,21 @@
+'use strict'
+
+// Escapes `t` using the format specified in
+// <https://github.com/espadrine/gh-badges/issues/12#issuecomment-31518129>
+function escapeFormat(t) {
+  return (
+    t
+      // Inline single underscore.
+      .replace(/([^_])_([^_])/g, '$1 $2')
+      // Leading or trailing underscore.
+      .replace(/([^_])_$/, '$1 ')
+      .replace(/^_([^_])/, ' $1')
+      // Double underscore and double dash.
+      .replace(/__/g, '_')
+      .replace(/--/g, '-')
+  )
+}
+
+module.exports = {
+  escapeFormat,
+}

core/base-service/base-json.js

@@ -0,0 +1,43 @@
+'use strict'
+
+// See available emoji at http://emoji.muan.co/
+const emojic = require('emojic')
+const BaseService = require('./base')
+const trace = require('./trace')
+const { InvalidResponse } = require('./errors')
+
+class BaseJsonService extends BaseService {
+  _parseJson(buffer) {
+    const logTrace = (...args) => trace.logTrace('fetch', ...args)
+    let json
+    try {
+      json = JSON.parse(buffer)
+    } catch (err) {
+      logTrace(emojic.dart, 'Response JSON (unparseable)', buffer)
+      throw new InvalidResponse({
+        prettyMessage: 'unparseable json response',
+        underlyingError: err,
+      })
+    }
+    logTrace(emojic.dart, 'Response JSON (before validation)', json, {
+      deep: true,
+    })
+    return json
+  }
+
+  async _requestJson({ schema, url, options = {}, errorMessages = {} }) {
+    const mergedOptions = {
+      ...{ headers: { Accept: 'application/json' } },
+      ...options,
+    }
+    const { buffer } = await this._request({
+      url,
+      options: mergedOptions,
+      errorMessages,
+    })
+    const json = this._parseJson(buffer)
+    return this.constructor._validate(json, schema)
+  }
+}
+
+module.exports = BaseJsonService

core/base-service/base-json.spec.js

@@ -0,0 +1,134 @@
+'use strict'
+
+const Joi = require('joi')
+const { expect } = require('chai')
+const sinon = require('sinon')
+const BaseJsonService = require('./base-json')
+
+const dummySchema = Joi.object({
+  requiredString: Joi.string().required(),
+}).required()
+
+class DummyJsonService extends BaseJsonService {
+  static get category() {
+    return 'cat'
+  }
+
+  static get route() {
+    return {
+      base: 'foo',
+    }
+  }
+
+  async handle() {
+    const { requiredString } = await this._requestJson({
+      schema: dummySchema,
+      url: 'http://example.com/foo.json',
+    })
+    return { message: requiredString }
+  }
+}
+
+describe('BaseJsonService', function() {
+  describe('Making requests', function() {
+    let sendAndCacheRequest
+    beforeEach(function() {
+      sendAndCacheRequest = sinon.stub().returns(
+        Promise.resolve({
+          buffer: '{"some": "json"}',
+          res: { statusCode: 200 },
+        })
+      )
+    })
+
+    it('invokes _sendAndCacheRequest', async function() {
+      await DummyJsonService.invoke(
+        { sendAndCacheRequest },
+        { handleInternalErrors: false }
+      )
+
+      expect(sendAndCacheRequest).to.have.been.calledOnceWith(
+        'http://example.com/foo.json',
+        { headers: { Accept: 'application/json' } }
+      )
+    })
+
+    it('forwards options to _sendAndCacheRequest', async function() {
+      class WithOptions extends DummyJsonService {
+        async handle() {
+          const { value } = await this._requestJson({
+            schema: dummySchema,
+            url: 'http://example.com/foo.json',
+            options: { method: 'POST', qs: { queryParam: 123 } },
+          })
+          return { message: value }
+        }
+      }
+
+      await WithOptions.invoke(
+        { sendAndCacheRequest },
+        { handleInternalErrors: false }
+      )
+
+      expect(sendAndCacheRequest).to.have.been.calledOnceWith(
+        'http://example.com/foo.json',
+        {
+          headers: { Accept: 'application/json' },
+          method: 'POST',
+          qs: { queryParam: 123 },
+        }
+      )
+    })
+  })
+
+  describe('Making badges', function() {
+    it('handles valid json responses', async function() {
+      const sendAndCacheRequest = async () => ({
+        buffer: '{"requiredString": "some-string"}',
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummyJsonService.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        message: 'some-string',
+      })
+    })
+
+    it('handles json responses which do not match the schema', async function() {
+      const sendAndCacheRequest = async () => ({
+        buffer: '{"unexpectedKey": "some-string"}',
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummyJsonService.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        isError: true,
+        color: 'lightgray',
+        message: 'invalid response data',
+      })
+    })
+
+    it('handles unparseable json responses', async function() {
+      const sendAndCacheRequest = async () => ({
+        buffer: 'not json',
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummyJsonService.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        isError: true,
+        color: 'lightgray',
+        message: 'unparseable json response',
+      })
+    })
+  })
+})

core/base-service/base-non-memory-caching.js

@@ -0,0 +1,70 @@
+'use strict'
+
+const makeBadge = require('../../gh-badges/lib/make-badge')
+const BaseService = require('./base')
+const { setCacheHeaders } = require('./cache-headers')
+const { makeSend } = require('./legacy-result-sender')
+const coalesceBadge = require('./coalesce-badge')
+const { prepareRoute, namedParamsForMatch } = require('./route')
+
+// Badges are subject to two independent types of caching: in-memory and
+// downstream.
+//
+// Services deriving from `NonMemoryCachingBaseService` are not cached in
+// memory on the server. This means that each request that hits the server
+// triggers another call to the handler. When using badges for server
+// diagnostics, that's useful!
+//
+// In contrast, The `handle()` function of most other `BaseService`
+// subclasses is wrapped in onboard, in-memory caching. See `lib /request-
+// handler.js` and `BaseService.prototype.register()`.
+//
+// All services, including those extending NonMemoryCachingBaseServices, may
+// be cached _downstream_. This is governed by cache headers, which are
+// configured by the service, the user's request, and the server's default
+// cache length.
+module.exports = class NonMemoryCachingBaseService extends BaseService {
+  static register({ camp, requestCounter }, serviceConfig) {
+    const { cacheHeaders: cacheHeaderConfig } = serviceConfig
+    const { _cacheLength: serviceDefaultCacheLengthSeconds } = this
+    const { regex, captureNames } = prepareRoute(this.route)
+
+    const serviceRequestCounter = this._createServiceRequestCounter({
+      requestCounter,
+    })
+
+    camp.route(regex, async (queryParams, match, end, ask) => {
+      const namedParams = namedParamsForMatch(captureNames, match, this)
+      const serviceData = await this.invoke(
+        {},
+        serviceConfig,
+        namedParams,
+        queryParams
+      )
+
+      const badgeData = coalesceBadge(
+        queryParams,
+        serviceData,
+        this.defaultBadgeData,
+        this
+      )
+
+      // The final capture group is the extension.
+      const format = match.slice(-1)[0]
+      badgeData.format = format
+
+      const svg = makeBadge(badgeData)
+
+      setCacheHeaders({
+        cacheHeaderConfig,
+        serviceDefaultCacheLengthSeconds,
+        queryParams,
+        res: ask.res,
+      })
+
+      makeSend(format, ask.res, end)(svg)
+
+      serviceRequestCounter.inc()
+    })
+  }
+}

core/base-service/base-static.js

@@ -0,0 +1,66 @@
+'use strict'
+
+const makeBadge = require('../../gh-badges/lib/make-badge')
+const BaseService = require('./base')
+const {
+  serverHasBeenUpSinceResourceCached,
+  setCacheHeadersForStaticResource,
+} = require('./cache-headers')
+const { makeSend } = require('./legacy-result-sender')
+const coalesceBadge = require('./coalesce-badge')
+const { prepareRoute, namedParamsForMatch } = require('./route')
+
+module.exports = class BaseStaticService extends BaseService {
+  static register({ camp, requestCounter }, serviceConfig) {
+    const {
+      profiling: { makeBadge: shouldProfileMakeBadge },
+    } = serviceConfig
+    const { regex, captureNames } = prepareRoute(this.route)
+
+    const serviceRequestCounter = this._createServiceRequestCounter({
+      requestCounter,
+    })
+
+    camp.route(regex, async (queryParams, match, end, ask) => {
+      if (serverHasBeenUpSinceResourceCached(ask.req)) {
+        // Send Not Modified.
+        ask.res.statusCode = 304
+        ask.res.end()
+        return
+      }
+
+      const namedParams = namedParamsForMatch(captureNames, match, this)
+      const serviceData = await this.invoke(
+        {},
+        serviceConfig,
+        namedParams,
+        queryParams
+      )
+
+      const badgeData = coalesceBadge(
+        queryParams,
+        serviceData,
+        this.defaultBadgeData,
+        this
+      )
+
+      // The final capture group is the extension.
+      const format = match.slice(-1)[0]
+      badgeData.format = format
+
+      if (shouldProfileMakeBadge) {
+        console.time('makeBadge total')
+      }
+      const svg = makeBadge(badgeData)
+      if (shouldProfileMakeBadge) {
+        console.timeEnd('makeBadge total')
+      }
+
+      setCacheHeadersForStaticResource(ask.res)
+
+      makeSend(format, ask.res, end)(svg)
+
+      serviceRequestCounter.inc()
+    })
+  }
+}

core/base-service/base-svg-scraping.js

@@ -0,0 +1,57 @@
+'use strict'
+
+// See available emoji at http://emoji.muan.co/
+const emojic = require('emojic')
+const BaseService = require('./base')
+const trace = require('./trace')
+const { InvalidResponse } = require('./errors')
+
+const defaultValueMatcher = />([^<>]+)<\/text><\/g>/
+const leadingWhitespace = /(?:\r\n\s*|\r\s*|\n\s*)/g
+
+class BaseSvgScrapingService extends BaseService {
+  static valueFromSvgBadge(svg, valueMatcher = defaultValueMatcher) {
+    if (typeof svg !== 'string') {
+      throw new TypeError('Parameter should be a string')
+    }
+    const stripped = svg.replace(leadingWhitespace, '')
+    const match = valueMatcher.exec(stripped)
+    if (match) {
+      return match[1]
+    } else {
+      throw new InvalidResponse({
+        prettyMessage: 'unparseable svg response',
+        underlyingError: Error(`Can't get value from SVG:\n${svg}`),
+      })
+    }
+  }
+
+  async _requestSvg({
+    schema,
+    valueMatcher,
+    url,
+    options = {},
+    errorMessages = {},
+  }) {
+    const logTrace = (...args) => trace.logTrace('fetch', ...args)
+    const mergedOptions = {
+      ...{ headers: { Accept: 'image/svg+xml' } },
+      ...options,
+    }
+    const { buffer } = await this._request({
+      url,
+      options: mergedOptions,
+      errorMessages,
+    })
+    logTrace(emojic.dart, 'Response SVG', buffer)
+    const data = {
+      message: this.constructor.valueFromSvgBadge(buffer, valueMatcher),
+    }
+    logTrace(emojic.dart, 'Response SVG (before validation)', data, {
+      deep: true,
+    })
+    return this.constructor._validate(data, schema)
+  }
+}
+
+module.exports = BaseSvgScrapingService

core/base-service/base-svg-scraping.spec.js

@@ -0,0 +1,167 @@
+'use strict'
+
+const { expect } = require('chai')
+const sinon = require('sinon')
+const Joi = require('joi')
+const makeBadge = require('../../gh-badges/lib/make-badge')
+const BaseSvgScrapingService = require('./base-svg-scraping')
+
+function makeExampleSvg({ label, message }) {
+  return makeBadge({ text: ['this is the label', 'this is the result!'] })
+}
+
+const schema = Joi.object({
+  message: Joi.string().required(),
+}).required()
+
+class DummySvgScrapingService extends BaseSvgScrapingService {
+  static get category() {
+    return 'cat'
+  }
+
+  static get route() {
+    return {
+      base: 'foo',
+    }
+  }
+
+  async handle() {
+    return this._requestSvg({
+      schema,
+      url: 'http://example.com/foo.svg',
+    })
+  }
+}
+
+describe('BaseSvgScrapingService', function() {
+  const exampleLabel = 'this is the label'
+  const exampleMessage = 'this is the result!'
+  const exampleSvg = makeExampleSvg({
+    label: exampleLabel,
+    message: exampleMessage,
+  })
+
+  describe('valueFromSvgBadge', function() {
+    it('should find the correct value', function() {
+      expect(BaseSvgScrapingService.valueFromSvgBadge(exampleSvg)).to.equal(
+        exampleMessage
+      )
+    })
+  })
+
+  describe('Making requests', function() {
+    let sendAndCacheRequest
+    beforeEach(function() {
+      sendAndCacheRequest = sinon.stub().returns(
+        Promise.resolve({
+          buffer: exampleSvg,
+          res: { statusCode: 200 },
+        })
+      )
+    })
+
+    it('invokes _sendAndCacheRequest with the expected header', async function() {
+      await DummySvgScrapingService.invoke(
+        { sendAndCacheRequest },
+        { handleInternalErrors: false }
+      )
+
+      expect(sendAndCacheRequest).to.have.been.calledOnceWith(
+        'http://example.com/foo.svg',
+        { headers: { Accept: 'image/svg+xml' } }
+      )
+    })
+
+    it('forwards options to _sendAndCacheRequest', async function() {
+      class WithCustomOptions extends DummySvgScrapingService {
+        async handle() {
+          const { message } = await this._requestSvg({
+            schema,
+            url: 'http://example.com/foo.svg',
+            options: {
+              method: 'POST',
+              qs: { queryParam: 123 },
+            },
+          })
+          return { message }
+        }
+      }
+
+      await WithCustomOptions.invoke(
+        { sendAndCacheRequest },
+        { handleInternalErrors: false }
+      )
+
+      expect(sendAndCacheRequest).to.have.been.calledOnceWith(
+        'http://example.com/foo.svg',
+        {
+          method: 'POST',
+          headers: { Accept: 'image/svg+xml' },
+          qs: { queryParam: 123 },
+        }
+      )
+    })
+  })
+
+  describe('Making badges', function() {
+    it('handles valid svg responses', async function() {
+      const sendAndCacheRequest = async () => ({
+        buffer: exampleSvg,
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummySvgScrapingService.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        message: exampleMessage,
+      })
+    })
+
+    it('allows overriding the valueMatcher', async function() {
+      class WithValueMatcher extends BaseSvgScrapingService {
+        static get route() {
+          return {}
+        }
+
+        async handle() {
+          return this._requestSvg({
+            schema,
+            valueMatcher: />([^<>]+)<\/desc>/,
+            url: 'http://example.com/foo.svg',
+          })
+        }
+      }
+      const sendAndCacheRequest = async () => ({
+        buffer: '<desc>a different message</desc>',
+        res: { statusCode: 200 },
+      })
+      expect(
+        await WithValueMatcher.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        message: 'a different message',
+      })
+    })
+
+    it('handles unparseable svg responses', async function() {
+      const sendAndCacheRequest = async () => ({
+        buffer: 'not svg yo',
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummySvgScrapingService.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        isError: true,
+        color: 'lightgray',
+        message: 'unparseable svg response',
+      })
+    })
+  })
+})

core/base-service/base-xml.js

@@ -0,0 +1,43 @@
+'use strict'
+
+// See available emoji at http://emoji.muan.co/
+const emojic = require('emojic')
+const fastXmlParser = require('fast-xml-parser')
+const BaseService = require('./base')
+const trace = require('./trace')
+const { InvalidResponse } = require('./errors')
+
+class BaseXmlService extends BaseService {
+  async _requestXml({
+    schema,
+    url,
+    options = {},
+    errorMessages = {},
+    parserOptions = {},
+  }) {
+    const logTrace = (...args) => trace.logTrace('fetch', ...args)
+    const mergedOptions = {
+      ...{ headers: { Accept: 'application/xml, text/xml' } },
+      ...options,
+    }
+    const { buffer } = await this._request({
+      url,
+      options: mergedOptions,
+      errorMessages,
+    })
+    const validateResult = fastXmlParser.validate(buffer)
+    if (validateResult !== true) {
+      throw new InvalidResponse({
+        prettyMessage: 'unparseable xml response',
+        underlyingError: validateResult.err,
+      })
+    }
+    const xml = fastXmlParser.parse(buffer, parserOptions)
+    logTrace(emojic.dart, 'Response XML (before validation)', xml, {
+      deep: true,
+    })
+    return this.constructor._validate(xml, schema)
+  }
+}
+
+module.exports = BaseXmlService

core/base-service/base-xml.spec.js

@@ -0,0 +1,165 @@
+'use strict'
+
+const Joi = require('joi')
+const { expect } = require('chai')
+const sinon = require('sinon')
+const BaseXmlService = require('./base-xml')
+
+const dummySchema = Joi.object({
+  requiredString: Joi.string().required(),
+}).required()
+
+class DummyXmlService extends BaseXmlService {
+  static get category() {
+    return 'cat'
+  }
+
+  static get route() {
+    return {
+      base: 'foo',
+    }
+  }
+
+  async handle() {
+    const { requiredString } = await this._requestXml({
+      schema: dummySchema,
+      url: 'http://example.com/foo.xml',
+    })
+    return { message: requiredString }
+  }
+}
+
+describe('BaseXmlService', function() {
+  describe('Making requests', function() {
+    let sendAndCacheRequest
+    beforeEach(function() {
+      sendAndCacheRequest = sinon.stub().returns(
+        Promise.resolve({
+          buffer: '<requiredString>some-string</requiredString>',
+          res: { statusCode: 200 },
+        })
+      )
+    })
+
+    it('invokes _sendAndCacheRequest', async function() {
+      await DummyXmlService.invoke(
+        { sendAndCacheRequest },
+        { handleInternalErrors: false }
+      )
+
+      expect(sendAndCacheRequest).to.have.been.calledOnceWith(
+        'http://example.com/foo.xml',
+        { headers: { Accept: 'application/xml, text/xml' } }
+      )
+    })
+
+    it('forwards options to _sendAndCacheRequest', async function() {
+      class WithCustomOptions extends BaseXmlService {
+        static get route() {
+          return {}
+        }
+
+        async handle() {
+          const { requiredString } = await this._requestXml({
+            schema: dummySchema,
+            url: 'http://example.com/foo.xml',
+            options: { method: 'POST', qs: { queryParam: 123 } },
+          })
+          return { message: requiredString }
+        }
+      }
+
+      await WithCustomOptions.invoke(
+        { sendAndCacheRequest },
+        { handleInternalErrors: false }
+      )
+
+      expect(sendAndCacheRequest).to.have.been.calledOnceWith(
+        'http://example.com/foo.xml',
+        {
+          headers: { Accept: 'application/xml, text/xml' },
+          method: 'POST',
+          qs: { queryParam: 123 },
+        }
+      )
+    })
+  })
+
+  describe('Making badges', function() {
+    it('handles valid xml responses', async function() {
+      const sendAndCacheRequest = async () => ({
+        buffer: '<requiredString>some-string</requiredString>',
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummyXmlService.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        message: 'some-string',
+      })
+    })
+
+    it('parses XML response with custom parser options', async function() {
+      const customParserOption = { trimValues: false }
+      class DummyXmlServiceWithParserOption extends DummyXmlService {
+        async handle() {
+          const { requiredString } = await this._requestXml({
+            schema: dummySchema,
+            url: 'http://example.com/foo.xml',
+            parserOptions: customParserOption,
+          })
+          return { message: requiredString }
+        }
+      }
+      const sendAndCacheRequest = async () => ({
+        buffer:
+          '<requiredString>some-string with trailing whitespace   </requiredString>',
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummyXmlServiceWithParserOption.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        message: 'some-string with trailing whitespace   ',
+      })
+    })
+
+    it('handles xml responses which do not match the schema', async function() {
+      const sendAndCacheRequest = async () => ({
+        buffer: '<unexpectedAttribute>some-string</unexpectedAttribute>',
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummyXmlService.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        isError: true,
+        color: 'lightgray',
+        message: 'invalid response data',
+      })
+    })
+
+    it('handles unparseable xml responses', async function() {
+      const sendAndCacheRequest = async () => ({
+        buffer: 'not xml',
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummyXmlService.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        isError: true,
+        color: 'lightgray',
+        message: 'unparseable xml response',
+      })
+    })
+  })
+})

core/base-service/base-yaml.js

@@ -0,0 +1,49 @@
+'use strict'
+
+const emojic = require('emojic')
+const yaml = require('js-yaml')
+const BaseService = require('./base')
+const { InvalidResponse } = require('./errors')
+const trace = require('./trace')
+
+class BaseYamlService extends BaseService {
+  async _requestYaml({
+    schema,
+    url,
+    options = {},
+    errorMessages = {},
+    encoding = 'utf8',
+  }) {
+    const logTrace = (...args) => trace.logTrace('fetch', ...args)
+    const mergedOptions = {
+      ...{
+        headers: {
+          Accept:
+            'text/x-yaml, text/yaml, application/x-yaml, application/yaml, text/plain',
+        },
+      },
+      ...options,
+    }
+    const { buffer } = await this._request({
+      url,
+      options: mergedOptions,
+      errorMessages,
+    })
+    let parsed
+    try {
+      parsed = yaml.safeLoad(buffer.toString(), encoding)
+    } catch (err) {
+      logTrace(emojic.dart, 'Response YAML (unparseable)', buffer)
+      throw new InvalidResponse({
+        prettyMessage: 'unparseable yaml response',
+        underlyingError: err,
+      })
+    }
+    logTrace(emojic.dart, 'Response YAML (before validation)', parsed, {
+      deep: true,
+    })
+    return this.constructor._validate(parsed, schema)
+  }
+}
+
+module.exports = BaseYamlService

core/base-service/base-yaml.spec.js

@@ -0,0 +1,158 @@
+'use strict'
+
+const Joi = require('joi')
+const { expect } = require('chai')
+const sinon = require('sinon')
+const BaseYamlService = require('./base-yaml')
+
+const dummySchema = Joi.object({
+  requiredString: Joi.string().required(),
+}).required()
+
+class DummyYamlService extends BaseYamlService {
+  static get category() {
+    return 'cat'
+  }
+
+  static get route() {
+    return {
+      base: 'foo',
+    }
+  }
+
+  async handle() {
+    const { requiredString } = await this._requestYaml({
+      schema: dummySchema,
+      url: 'http://example.com/foo.yaml',
+    })
+    return { message: requiredString }
+  }
+}
+
+const expectedYaml = `
+---
+requiredString: some-string
+`
+
+const unexpectedYaml = `
+---
+unexpectedKey: some-string
+`
+
+const invalidYaml = `
+---
+foo: bar
+foo: baz
+`
+
+describe('BaseYamlService', function() {
+  describe('Making requests', function() {
+    let sendAndCacheRequest
+    beforeEach(function() {
+      sendAndCacheRequest = sinon.stub().returns(
+        Promise.resolve({
+          buffer: expectedYaml,
+          res: { statusCode: 200 },
+        })
+      )
+    })
+
+    it('invokes _sendAndCacheRequest', async function() {
+      await DummyYamlService.invoke(
+        { sendAndCacheRequest },
+        { handleInternalErrors: false }
+      )
+
+      expect(sendAndCacheRequest).to.have.been.calledOnceWith(
+        'http://example.com/foo.yaml',
+        {
+          headers: {
+            Accept:
+              'text/x-yaml, text/yaml, application/x-yaml, application/yaml, text/plain',
+          },
+        }
+      )
+    })
+
+    it('forwards options to _sendAndCacheRequest', async function() {
+      class WithOptions extends DummyYamlService {
+        async handle() {
+          const { requiredString } = await this._requestYaml({
+            schema: dummySchema,
+            url: 'http://example.com/foo.yaml',
+            options: { method: 'POST', qs: { queryParam: 123 } },
+          })
+          return { message: requiredString }
+        }
+      }
+
+      await WithOptions.invoke(
+        { sendAndCacheRequest },
+        { handleInternalErrors: false }
+      )
+
+      expect(sendAndCacheRequest).to.have.been.calledOnceWith(
+        'http://example.com/foo.yaml',
+        {
+          headers: {
+            Accept:
+              'text/x-yaml, text/yaml, application/x-yaml, application/yaml, text/plain',
+          },
+          method: 'POST',
+          qs: { queryParam: 123 },
+        }
+      )
+    })
+  })
+
+  describe('Making badges', function() {
+    it('handles valid yaml responses', async function() {
+      const sendAndCacheRequest = async () => ({
+        buffer: expectedYaml,
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummyYamlService.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        message: 'some-string',
+      })
+    })
+
+    it('handles yaml responses which do not match the schema', async function() {
+      const sendAndCacheRequest = async () => ({
+        buffer: unexpectedYaml,
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummyYamlService.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        isError: true,
+        color: 'lightgray',
+        message: 'invalid response data',
+      })
+    })
+
+    it('handles unparseable yaml responses', async function() {
+      const sendAndCacheRequest = async () => ({
+        buffer: invalidYaml,
+        res: { statusCode: 200 },
+      })
+      expect(
+        await DummyYamlService.invoke(
+          { sendAndCacheRequest },
+          { handleInternalErrors: false }
+        )
+      ).to.deep.equal({
+        isError: true,
+        color: 'lightgray',
+        message: 'unparseable yaml response',
+      })
+    })
+  })
+})

core/base-service/base.js

@@ -0,0 +1,424 @@
+'use strict'
+
+const decamelize = require('decamelize')
+// See available emoji at http://emoji.muan.co/
+const emojic = require('emojic')
+const Joi = require('joi')
+const { assertValidCategory } = require('./categories')
+const checkErrorResponse = require('./check-error-response')
+const coalesceBadge = require('./coalesce-badge')
+const {
+  NotFound,
+  InvalidResponse,
+  Inaccessible,
+  InvalidParameter,
+  Deprecated,
+} = require('./errors')
+const { validateExample, transformExample } = require('./examples')
+const {
+  makeFullUrl,
+  assertValidRoute,
+  prepareRoute,
+  namedParamsForMatch,
+  getQueryParamNames,
+} = require('./route')
+const { assertValidServiceDefinition } = require('./service-definitions')
+const trace = require('./trace')
+const validate = require('./validate')
+
+const defaultBadgeDataSchema = Joi.object({
+  label: Joi.string(),
+  color: Joi.string(),
+  labelColor: Joi.string(),
+  namedLogo: Joi.string(),
+}).required()
+
+const optionalStringWhenNamedLogoPrsent = Joi.alternatives().when('namedLogo', {
+  is: Joi.string().required(),
+  then: Joi.string(),
+})
+
+const optionalNumberWhenAnyLogoPresent = Joi.alternatives()
+  .when('namedLogo', { is: Joi.string().required(), then: Joi.number() })
+  .when('logoSvg', { is: Joi.string().required(), then: Joi.number() })
+
+const serviceDataSchema = Joi.object({
+  isError: Joi.boolean(),
+  label: Joi.string().allow(''),
+  // While a number of badges pass a number here, in the long run we may want
+  // `render()` to always return a string.
+  message: Joi.alternatives(Joi.string().allow(''), Joi.number()).required(),
+  color: Joi.string(),
+  link: Joi.array()
+    .items(Joi.string().uri())
+    .single()
+    .max(2),
+  // Generally services should not use these options, which are provided to
+  // support the Endpoint badge.
+  labelColor: Joi.string(),
+  namedLogo: Joi.string(),
+  logoSvg: Joi.string(),
+  logoColor: optionalStringWhenNamedLogoPrsent,
+  logoWidth: optionalNumberWhenAnyLogoPresent,
+  logoPosition: optionalNumberWhenAnyLogoPresent,
+  cacheSeconds: Joi.number()
+    .integer()
+    .min(0),
+  style: Joi.string(),
+})
+  .oxor('namedLogo', 'logoSvg')
+  .required()
+
+module.exports = class BaseService {
+  /**
+   * Name of the category to sort this badge into (eg. "build"). Used to sort
+   * the badges on the main shields.io website.
+   */
+  static get category() {
+    throw new Error(`Category not set for ${this.name}`)
+  }
+
+  static get isDeprecated() {
+    return false
+  }
+
+  /**
+   * Returns an object:
+   *  - base: (Optional) The base path of the routes for this service. This is
+   *    used as a prefix.
+   *  - format: Regular expression to use for routes for this service's badges
+   *  - capture: Array of names for the capture groups in the regular
+   *             expression. The handler will be passed an object containing
+   *             the matches.
+   *  - queryParamSchema: (Optional) A Joi schema (`Joi.object({ ... }).required()`)
+   *                      for the query param object. If you know a parameter
+   *                      will never receive a numeric string, you can use
+   *                      `Joi.string()`. Because of quirks in Scoutcamp and Joi,
+   *                      alphanumeric strings should be declared using
+   *                      `Joi.alternatives().try(Joi.string(), Joi.number())`,
+   *                      otherwise a value like `?success_color=999` will fail.
+   *                      A parameter requiring a numeric string can use
+   *                      `Joi.number()`. A parameter that receives only non-numeric
+   *                      strings can use `Joi.string()`. A parameter that never
+   *                      receives numeric can use `Joi.string()`. A boolean
+   *                      parameter should use `Joi.equal('')` and will receive an
+   *                      empty string on e.g. `?compact_message` and undefined
+   *                      when the parameter is absent. (Note that in,
+   *                      `examples.queryParams` boolean query params should be given
+   *                      `null` values.)
+   */
+  static get route() {
+    throw new Error(`Route not defined for ${this.name}`)
+  }
+
+  /**
+   * Example URLs for this service. These should use the format
+   * specified in `route`, and can be used to demonstrate how to use badges for
+   * this service.
+   *
+   * The preferred way to specify an example is with `namedParams` which are
+   * substituted into the service's compiled route pattern. The rendered badge
+   * is specified with `staticPreview`.
+   *
+   * For services which use a route `format`, the `pattern` can be specified as
+   * part of the example.
+   *
+   * title: Descriptive text that will be shown next to the badge. The default
+   *   is to use the service class name, which probably is not what you want.
+   * namedParams: An object containing the values of named parameters to
+   *   substitute into the compiled route pattern.
+   * queryParams: An object containing query parameters to include in the
+   *   example URLs. For alphanumeric query parameters, specify a string value.
+   *   For boolean query parameters, specify `null`.
+   * pattern: The route pattern to compile. Defaults to `this.route.pattern`.
+   * staticPreview: A rendered badge of the sort returned by `handle()` or
+   *   `render()`: an object containing `message` and optional `label` and
+   *   `color`. This is usually generated by invoking `this.render()` with some
+   *   explicit props.
+   * keywords: Additional keywords, other than words in the title. This helps
+   *   users locate relevant badges.
+   * documentation: An HTML string that is included in the badge popup.
+   */
+  static get examples() {
+    return []
+  }
+
+  static get _cacheLength() {
+    const cacheLengths = {
+      build: 30,
+      license: 3600,
+      version: 300,
+      debug: 60,
+    }
+    return cacheLengths[this.category]
+  }
+
+  /**
+   * Default data for the badge. Can include label, logo, and color. These
+   * defaults are used if the value is neither included in the service data
+   * from the handler nor overridden by the user via query parameters.
+   */
+  static get defaultBadgeData() {
+    return {}
+  }
+
+  static render(props) {
+    throw new Error(`render() function not implemented for ${this.name}`)
+  }
+
+  static validateDefinition() {
+    assertValidCategory(this.category, `Category for ${this.name}`)
+
+    assertValidRoute(this.route, `Route for ${this.name}`)
+
+    Joi.assert(
+      this.defaultBadgeData,
+      defaultBadgeDataSchema,
+      `Default badge data for ${this.name}`
+    )
+
+    this.examples.forEach((example, index) =>
+      validateExample(example, index, this)
+    )
+  }
+
+  static getDefinition() {
+    const { category, name, isDeprecated } = this
+    const { base, format, pattern } = this.route
+    const queryParams = getQueryParamNames(this.route)
+
+    const examples = this.examples.map((example, index) =>
+      transformExample(example, index, this)
+    )
+
+    let route
+    if (pattern) {
+      route = { pattern: makeFullUrl(base, pattern), queryParams }
+    } else if (format) {
+      route = { format, queryParams }
+    } else {
+      route = undefined
+    }
+
+    const result = { category, name, isDeprecated, route, examples }
+
+    assertValidServiceDefinition(result, `getDefinition() for ${this.name}`)
+
+    return result
+  }
+
+  constructor({ sendAndCacheRequest }, { handleInternalErrors }) {
+    this._requestFetcher = sendAndCacheRequest
+    this._handleInternalErrors = handleInternalErrors
+  }
+
+  async _request({ url, options = {}, errorMessages = {} }) {
+    const logTrace = (...args) => trace.logTrace('fetch', ...args)
+    logTrace(emojic.bowAndArrow, 'Request', url, '\n', options)
+    const { res, buffer } = await this._requestFetcher(url, options)
+    logTrace(emojic.dart, 'Response status code', res.statusCode)
+    return checkErrorResponse(errorMessages)({ buffer, res })
+  }
+
+  static _validate(
+    data,
+    schema,
+    {
+      prettyErrorMessage = 'invalid response data',
+      includeKeys = false,
+      allowAndStripUnknownKeys = true,
+    } = {}
+  ) {
+    return validate(
+      {
+        ErrorClass: InvalidResponse,
+        prettyErrorMessage,
+        includeKeys,
+        traceErrorMessage: 'Response did not match schema',
+        traceSuccessMessage: 'Response after validation',
+        allowAndStripUnknownKeys,
+      },
+      data,
+      schema
+    )
+  }
+
+  /**
+   * Asynchronous function to handle requests for this service. Take the route
+   * parameters (as defined in the `route` property), perform a request using
+   * `this._sendAndCacheRequest`, and return the badge data.
+   */
+  async handle(namedParams, queryParams) {
+    throw new Error(`Handler not implemented for ${this.constructor.name}`)
+  }
+
+  _handleError(error) {
+    if (error instanceof NotFound || error instanceof InvalidParameter) {
+      trace.logTrace('outbound', emojic.noGoodWoman, 'Handled error', error)
+      return {
+        isError: true,
+        message: error.prettyMessage,
+        color: 'red',
+      }
+    } else if (
+      error instanceof InvalidResponse ||
+      error instanceof Inaccessible ||
+      error instanceof Deprecated
+    ) {
+      trace.logTrace('outbound', emojic.noGoodWoman, 'Handled error', error)
+      return {
+        isError: true,
+        message: error.prettyMessage,
+        color: 'lightgray',
+      }
+    } else if (this._handleInternalErrors) {
+      if (
+        !trace.logTrace(
+          'unhandledError',
+          emojic.boom,
+          'Unhandled internal error',
+          error
+        )
+      ) {
+        // This is where we end up if an unhandled exception is thrown in
+        // production. Send the error to the logs.
+        console.log(error)
+      }
+      return {
+        isError: true,
+        label: 'shields',
+        message: 'internal error',
+        color: 'lightgray',
+      }
+    } else {
+      trace.logTrace(
+        'unhandledError',
+        emojic.boom,
+        'Unhandled internal error',
+        error
+      )
+      throw error
+    }
+  }
+
+  static async invoke(
+    context = {},
+    config = {},
+    namedParams = {},
+    queryParams = {}
+  ) {
+    trace.logTrace('inbound', emojic.womanCook, 'Service class', this.name)
+    trace.logTrace('inbound', emojic.ticket, 'Named params', namedParams)
+    trace.logTrace('inbound', emojic.crayon, 'Query params', queryParams)
+
+    const serviceInstance = new this(context, config)
+
+    let serviceError
+    const { queryParamSchema } = this.route
+    let transformedQueryParams
+    if (queryParamSchema) {
+      try {
+        transformedQueryParams = validate(
+          {
+            ErrorClass: InvalidParameter,
+            prettyErrorMessage: 'invalid query parameter',
+            includeKeys: true,
+            traceErrorMessage: 'Query params did not match schema',
+            traceSuccessMessage: 'Query params after validation',
+          },
+          queryParams,
+          queryParamSchema
+        )
+        trace.logTrace(
+          'inbound',
+          emojic.crayon,
+          'Query params after validation',
+          queryParams
+        )
+      } catch (error) {
+        serviceError = error
+      }
+    } else {
+      transformedQueryParams = {}
+    }
+
+    let serviceData
+    if (!serviceError) {
+      try {
+        serviceData = await serviceInstance.handle(
+          namedParams,
+          transformedQueryParams
+        )
+        Joi.assert(serviceData, serviceDataSchema)
+      } catch (error) {
+        serviceError = error
+      }
+    }
+
+    if (serviceError) {
+      serviceData = serviceInstance._handleError(serviceError)
+    }
+
+    trace.logTrace('outbound', emojic.shield, 'Service data', serviceData)
+
+    return serviceData
+  }
+
+  static _createServiceRequestCounter({ requestCounter }) {
+    if (requestCounter) {
+      const { category, serviceFamily, name } = this
+      const service = decamelize(name)
+      return requestCounter.labels(category, serviceFamily, service)
+    } else {
+      // When metrics are disabled, return a mock counter.
+      return { inc: () => {} }
+    }
+  }
+
+  static register(
+    { camp, handleRequest, githubApiProvider, requestCounter },
+    serviceConfig
+  ) {
+    const { cacheHeaders: cacheHeaderConfig, fetchLimitBytes } = serviceConfig
+    const { regex, captureNames } = prepareRoute(this.route)
+    const queryParams = getQueryParamNames(this.route)
+
+    const serviceRequestCounter = this._createServiceRequestCounter({
+      requestCounter,
+    })
+
+    camp.route(
+      regex,
+      handleRequest(cacheHeaderConfig, {
+        queryParams,
+        handler: async (queryParams, match, sendBadge, request) => {
+          const namedParams = namedParamsForMatch(captureNames, match, this)
+          const serviceData = await this.invoke(
+            {
+              sendAndCacheRequest: request.asPromise,
+              sendAndCacheRequestWithCallbacks: request,
+              githubApiProvider,
+            },
+            serviceConfig,
+            namedParams,
+            queryParams
+          )
+
+          const badgeData = coalesceBadge(
+            queryParams,
+            serviceData,
+            this.defaultBadgeData,
+            this
+          )
+          // The final capture group is the extension.
+          const format = match.slice(-1)[0]
+          sendBadge(format, badgeData)
+
+          serviceRequestCounter.inc()
+        },
+        cacheLength: this._cacheLength,
+        fetchLimitBytes,
+      })
+    )
+  }
+}

core/base-service/base.spec.js

@@ -0,0 +1,485 @@
+'use strict'
+
+const Joi = require('joi')
+const { expect } = require('chai')
+const sinon = require('sinon')
+const trace = require('./trace')
+const {
+  NotFound,
+  Inaccessible,
+  InvalidResponse,
+  InvalidParameter,
+  Deprecated,
+} = require('./errors')
+const BaseService = require('./base')
+
+require('../register-chai-plugins.spec')
+
+const queryParamSchema = Joi.object({
+  queryParamA: Joi.string(),
+})
+  .rename('legacyQueryParamA', 'queryParamA', {
+    ignoreUndefined: true,
+    override: true,
+  })
+  .required()
+
+class DummyService extends BaseService {
+  static get category() {
+    return 'other'
+  }
+
+  static get route() {
+    return {
+      base: 'foo',
+      pattern: ':namedParamA',
+      queryParamSchema,
+    }
+  }
+
+  static get examples() {
+    return [
+      {
+        pattern: ':world',
+        namedParams: { world: 'World' },
+        staticPreview: this.render({ namedParamA: 'foo', queryParamA: 'bar' }),
+        keywords: ['hello'],
+      },
+    ]
+  }
+
+  static get defaultBadgeData() {
+    return { label: 'cat', namedLogo: 'appveyor' }
+  }
+
+  static render({ namedParamA, queryParamA }) {
+    return {
+      message: `Hello namedParamA: ${namedParamA} with queryParamA: ${queryParamA}`,
+    }
+  }
+
+  async handle({ namedParamA }, { queryParamA }) {
+    return this.constructor.render({ namedParamA, queryParamA })
+  }
+}
+
+describe('BaseService', function() {
+  const defaultConfig = { handleInternalErrors: false }
+
+  it('Invokes the handler as expected', async function() {
+    expect(
+      await DummyService.invoke(
+        {},
+        defaultConfig,
+        { namedParamA: 'bar.bar.bar' },
+        { queryParamA: '!' }
+      )
+    ).to.deep.equal({
+      message: 'Hello namedParamA: bar.bar.bar with queryParamA: !',
+    })
+  })
+
+  it('Validates query params', async function() {
+    expect(
+      await DummyService.invoke(
+        {},
+        defaultConfig,
+        { namedParamA: 'bar.bar.bar' },
+        { queryParamA: ['foo', 'bar'] }
+      )
+    ).to.deep.equal({
+      color: 'red',
+      isError: true,
+      message: 'invalid query parameter: queryParamA',
+    })
+  })
+
+  describe('Required overrides', function() {
+    it('Should throw if render() is not overridden', function() {
+      expect(() => BaseService.render()).to.throw(
+        'render() function not implemented for BaseService'
+      )
+    })
+
+    it('Should throw if route is not overridden', async function() {
+      try {
+        await BaseService.invoke({}, {}, {})
+        expect.fail('Expected to throw')
+      } catch (e) {
+        expect(e.message).to.equal('Route not defined for BaseService')
+      }
+    })
+
+    class WithRoute extends BaseService {
+      static get route() {
+        return {}
+      }
+    }
+    it('Should throw if handle() is not overridden', async function() {
+      try {
+        await WithRoute.invoke({}, {}, {})
+        expect.fail('Expected to throw')
+      } catch (e) {
+        expect(e.message).to.equal('Handler not implemented for WithRoute')
+      }
+    })
+
+    it('Should throw if category is not overridden', function() {
+      expect(() => BaseService.category).to.throw(
+        'Category not set for BaseService'
+      )
+    })
+  })
+
+  describe('Logging', function() {
+    let sandbox
+    beforeEach(function() {
+      sandbox = sinon.createSandbox()
+    })
+    afterEach(function() {
+      sandbox.restore()
+    })
+    beforeEach(function() {
+      sandbox.stub(trace, 'logTrace')
+    })
+    it('Invokes the logger as expected', async function() {
+      await DummyService.invoke(
+        {},
+        defaultConfig,
+        { namedParamA: 'bar.bar.bar' },
+        { queryParamA: '!' }
+      )
+      expect(trace.logTrace).to.be.calledWithMatch(
+        'inbound',
+        sinon.match.string,
+        'Service class',
+        'DummyService'
+      )
+      expect(trace.logTrace).to.be.calledWith(
+        'inbound',
+        sinon.match.string,
+        'Named params',
+        { namedParamA: 'bar.bar.bar' }
+      )
+      expect(trace.logTrace).to.be.calledWith(
+        'inbound',
+        sinon.match.string,
+        'Query params after validation',
+        { queryParamA: '!' }
+      )
+    })
+  })
+
+  describe('Service data validation', function() {
+    it('Allows a link array', async function() {
+      const message = 'hello'
+      const link = ['https://example.com/', 'https://other.example.com/']
+      class LinkService extends DummyService {
+        async handle() {
+          return { message, link }
+        }
+      }
+
+      const serviceData = await LinkService.invoke(
+        {},
+        { handleInternalErrors: false },
+        { namedParamA: 'bar.bar.bar' }
+      )
+
+      expect(serviceData).to.deep.equal({
+        message,
+        link,
+      })
+    })
+
+    it('Throws a validation error on invalid data', async function() {
+      class ThrowingService extends DummyService {
+        async handle() {
+          return {
+            some: 'nonsense',
+          }
+        }
+      }
+      try {
+        await ThrowingService.invoke(
+          {},
+          { handleInternalErrors: false },
+          { namedParamA: 'bar.bar.bar' }
+        )
+        expect.fail('Expected to throw')
+      } catch (e) {
+        expect(e.name).to.equal('ValidationError')
+        expect(e.details.map(({ message }) => message)).to.deep.equal([
+          '"message" is required',
+        ])
+      }
+    })
+  })
+
+  describe('Error handling', function() {
+    it('Handles internal errors', async function() {
+      class ThrowingService extends DummyService {
+        async handle() {
+          throw Error("I've made a huge mistake")
+        }
+      }
+      expect(
+        await ThrowingService.invoke(
+          {},
+          { handleInternalErrors: true },
+          { namedParamA: 'bar.bar.bar' }
+        )
+      ).to.deep.equal({
+        isError: true,
+        color: 'lightgray',
+        label: 'shields',
+        message: 'internal error',
+      })
+    })
+
+    describe('Handles known subtypes of ShieldsInternalError', function() {
+      it('handles NotFound errors', async function() {
+        class ThrowingService extends DummyService {
+          async handle() {
+            throw new NotFound()
+          }
+        }
+        expect(
+          await ThrowingService.invoke({}, {}, { namedParamA: 'bar.bar.bar' })
+        ).to.deep.equal({
+          isError: true,
+          color: 'red',
+          message: 'not found',
+        })
+      })
+
+      it('handles Inaccessible errors', async function() {
+        class ThrowingService extends DummyService {
+          async handle() {
+            throw new Inaccessible()
+          }
+        }
+        expect(
+          await ThrowingService.invoke({}, {}, { namedParamA: 'bar.bar.bar' })
+        ).to.deep.equal({
+          isError: true,
+          color: 'lightgray',
+          message: 'inaccessible',
+        })
+      })
+
+      it('handles InvalidResponse errors', async function() {
+        class ThrowingService extends DummyService {
+          async handle() {
+            throw new InvalidResponse()
+          }
+        }
+        expect(
+          await ThrowingService.invoke({}, {}, { namedParamA: 'bar.bar.bar' })
+        ).to.deep.equal({
+          isError: true,
+          color: 'lightgray',
+          message: 'invalid',
+        })
+      })
+
+      it('handles Deprecated', async function() {
+        class ThrowingService extends DummyService {
+          async handle() {
+            throw new Deprecated()
+          }
+        }
+        expect(
+          await ThrowingService.invoke({}, {}, { namedParamA: 'bar.bar.bar' })
+        ).to.deep.equal({
+          isError: true,
+          color: 'lightgray',
+          message: 'no longer available',
+        })
+      })
+
+      it('handles InvalidParameter errors', async function() {
+        class ThrowingService extends DummyService {
+          async handle() {
+            throw new InvalidParameter()
+          }
+        }
+        expect(
+          await ThrowingService.invoke({}, {}, { namedParamA: 'bar.bar.bar' })
+        ).to.deep.equal({
+          isError: true,
+          color: 'red',
+          message: 'invalid parameter',
+        })
+      })
+    })
+  })
+
+  describe('ScoutCamp integration', function() {
+    const expectedRouteRegex = /^\/foo\/([^/]+?)\.(svg|png|gif|jpg|json)$/
+
+    let mockCamp
+    let mockHandleRequest
+
+    beforeEach(function() {
+      mockCamp = {
+        route: sinon.spy(),
+      }
+      mockHandleRequest = sinon.spy()
+      DummyService.register(
+        { camp: mockCamp, handleRequest: mockHandleRequest },
+        defaultConfig
+      )
+    })
+
+    it('registers the service', function() {
+      expect(mockCamp.route).to.have.been.calledOnce
+      expect(mockCamp.route).to.have.been.calledWith(expectedRouteRegex)
+    })
+
+    it('handles the request', async function() {
+      expect(mockHandleRequest).to.have.been.calledOnce
+
+      const {
+        queryParams: serviceQueryParams,
+        handler: requestHandler,
+      } = mockHandleRequest.getCall(0).args[1]
+      expect(serviceQueryParams).to.deep.equal([
+        'queryParamA',
+        'legacyQueryParamA',
+      ])
+
+      const mockSendBadge = sinon.spy()
+      const mockRequest = {
+        asPromise: sinon.spy(),
+      }
+      const queryParams = { queryParamA: '?' }
+      const match = '/foo/bar.svg'.match(expectedRouteRegex)
+      await requestHandler(queryParams, match, mockSendBadge, mockRequest)
+
+      const expectedFormat = 'svg'
+      expect(mockSendBadge).to.have.been.calledOnce
+      expect(mockSendBadge).to.have.been.calledWith(expectedFormat, {
+        text: ['cat', 'Hello namedParamA: bar with queryParamA: ?'],
+        color: 'lightgrey',
+        template: undefined,
+        namedLogo: undefined,
+        logo: undefined,
+        logoWidth: undefined,
+        logoPosition: undefined,
+        links: [],
+        labelColor: undefined,
+        cacheLengthSeconds: undefined,
+      })
+    })
+  })
+
+  describe('getDefinition', function() {
+    it('returns the expected result', function() {
+      const {
+        category,
+        name,
+        isDeprecated,
+        route,
+        examples,
+      } = DummyService.getDefinition()
+      expect({
+        category,
+        name,
+        isDeprecated,
+        route,
+      }).to.deep.equal({
+        category: 'other',
+        name: 'DummyService',
+        isDeprecated: false,
+        route: {
+          pattern: '/foo/:namedParamA',
+          queryParams: ['queryParamA', 'legacyQueryParamA'],
+        },
+      })
+      // The in-depth tests for examples reside in examples.spec.js
+      expect(examples).to.have.lengthOf(1)
+    })
+  })
+
+  describe('validate', function() {
+    const dummySchema = Joi.object({
+      requiredString: Joi.string().required(),
+    }).required()
+
+    it('throws error for invalid responses', async function() {
+      try {
+        DummyService._validate(
+          { requiredString: ['this', "shouldn't", 'work'] },
+          dummySchema
+        )
+        expect.fail('Expected to throw')
+      } catch (e) {
+        expect(e).to.be.an.instanceof(InvalidResponse)
+      }
+    })
+  })
+
+  describe('request', function() {
+    let sandbox
+    beforeEach(function() {
+      sandbox = sinon.createSandbox()
+    })
+    afterEach(function() {
+      sandbox.restore()
+    })
+    beforeEach(function() {
+      sandbox.stub(trace, 'logTrace')
+    })
+
+    it('logs appropriate information', async function() {
+      const sendAndCacheRequest = async () => ({
+        buffer: '',
+        res: { statusCode: 200 },
+      })
+      const serviceInstance = new DummyService(
+        { sendAndCacheRequest },
+        defaultConfig
+      )
+
+      const url = 'some-url'
+      const options = { headers: { Cookie: 'some-cookie' } }
+      await serviceInstance._request({ url, options })
+
+      expect(trace.logTrace).to.be.calledWithMatch(
+        'fetch',
+        sinon.match.string,
+        'Request',
+        url,
+        '\n',
+        options
+      )
+      expect(trace.logTrace).to.be.calledWithMatch(
+        'fetch',
+        sinon.match.string,
+        'Response status code',
+        200
+      )
+    })
+
+    it('handles errors', async function() {
+      const sendAndCacheRequest = async () => ({
+        buffer: '',
+        res: { statusCode: 404 },
+      })
+      const serviceInstance = new DummyService(
+        { sendAndCacheRequest },
+        defaultConfig
+      )
+
+      try {
+        await serviceInstance._request({})
+        expect.fail('Expected to throw')
+      } catch (e) {
+        expect(e).to.be.an.instanceof(NotFound)
+        expect(e.message).to.equal('Not Found')
+        expect(e.prettyMessage).to.equal('not found')
+      }
+    })
+  })
+})

core/base-service/cache-headers.js

@@ -0,0 +1,115 @@
+'use strict'
+
+const assert = require('assert')
+const Joi = require('joi')
+const coalesce = require('./coalesce')
+
+const serverStartTimeGMTString = new Date().toGMTString()
+const serverStartTimestamp = Date.now()
+
+const isOptionalNonNegativeInteger = Joi.number()
+  .integer()
+  .min(0)
+
+const queryParamSchema = Joi.object({
+  cacheSeconds: isOptionalNonNegativeInteger,
+  maxAge: isOptionalNonNegativeInteger,
+})
+  .oxor('cacheSeconds', 'maxAge')
+  .unknown(true)
+  .required()
+
+function overrideCacheLengthFromQueryParams(queryParams) {
+  try {
+    const {
+      cacheSeconds: overrideCacheLength,
+      maxAge: legacyOverrideCacheLength,
+    } = Joi.attempt(queryParams, queryParamSchema)
+    return coalesce(overrideCacheLength, legacyOverrideCacheLength)
+  } catch (e) {
+    return undefined
+  }
+}
+
+function coalesceCacheLength({
+  cacheHeaderConfig,
+  serviceDefaultCacheLengthSeconds,
+  serviceOverrideCacheLengthSeconds,
+  queryParams,
+}) {
+  const { defaultCacheLengthSeconds } = cacheHeaderConfig
+  // The config returns a number so this should never happen. But this logic
+  // would be completely broken if it did.
+  assert(defaultCacheLengthSeconds !== undefined)
+
+  const cacheLength = coalesce(
+    serviceDefaultCacheLengthSeconds,
+    defaultCacheLengthSeconds
+  )
+
+  // Overrides can apply _more_ caching, but not less. Query param overriding
+  // can request more overriding than service override, but not less.
+  const candidateOverrides = [
+    serviceOverrideCacheLengthSeconds,
+    overrideCacheLengthFromQueryParams(queryParams),
+  ].filter(x => x !== undefined)
+
+  return Math.max(cacheLength, ...candidateOverrides)
+}
+
+function setHeadersForCacheLength(res, cacheLengthSeconds) {
+  const now = new Date()
+  const nowGMTString = now.toGMTString()
+
+  // Send both Cache-Control max-age and Expires in case the client implements
+  // HTTP/1.0 but not HTTP/1.1.
+  let cacheControl, expires
+  if (cacheLengthSeconds === 0) {
+    // Prevent as much downstream caching as possible.
+    cacheControl = 'no-cache, no-store, must-revalidate'
+    expires = nowGMTString
+  } else {
+    cacheControl = `max-age=${cacheLengthSeconds}`
+    expires = new Date(now.getTime() + cacheLengthSeconds * 1000).toGMTString()
+  }
+
+  res.setHeader('Date', nowGMTString)
+  res.setHeader('Cache-Control', cacheControl)
+  res.setHeader('Expires', expires)
+}
+
+function setCacheHeaders({
+  cacheHeaderConfig,
+  serviceDefaultCacheLengthSeconds,
+  serviceOverrideCacheLengthSeconds,
+  queryParams,
+  res,
+}) {
+  const cacheLengthSeconds = coalesceCacheLength({
+    cacheHeaderConfig,
+    serviceDefaultCacheLengthSeconds,
+    serviceOverrideCacheLengthSeconds,
+    queryParams,
+  })
+  setHeadersForCacheLength(res, cacheLengthSeconds)
+}
+
+const staticCacheControlHeader = `max-age=${24 * 3600}` // 1 day.
+function setCacheHeadersForStaticResource(res) {
+  res.setHeader('Cache-Control', staticCacheControlHeader)
+  res.setHeader('Last-Modified', serverStartTimeGMTString)
+}
+
+function serverHasBeenUpSinceResourceCached(req) {
+  return (
+    serverStartTimestamp <= new Date(req.headers['if-modified-since']).getTime()
+  )
+}
+
+module.exports = {
+  coalesceCacheLength,
+  setCacheHeaders,
+  setHeadersForCacheLength,
+  setCacheHeadersForStaticResource,
+  serverHasBeenUpSinceResourceCached,
+}

core/base-service/cache-headers.spec.js

@@ -0,0 +1,241 @@
+'use strict'
+
+const { test, given } = require('sazerac')
+const chai = require('chai')
+const { expect } = require('chai')
+const sinon = require('sinon')
+const httpMocks = require('node-mocks-http')
+const {
+  coalesceCacheLength,
+  setHeadersForCacheLength,
+  setCacheHeaders,
+  setCacheHeadersForStaticResource,
+  serverHasBeenUpSinceResourceCached,
+} = require('./cache-headers')
+
+chai.use(require('chai-datetime'))
+
+describe('Cache header functions', function() {
+  let res
+  beforeEach(function() {
+    res = httpMocks.createResponse()
+  })
+
+  describe('coalesceCacheLength', function() {
+    const cacheHeaderConfig = { defaultCacheLengthSeconds: 777 }
+    test(coalesceCacheLength, () => {
+      given({ cacheHeaderConfig, queryParams: {} }).expect(777)
+      given({
+        cacheHeaderConfig,
+        serviceDefaultCacheLengthSeconds: 900,
+        queryParams: {},
+      }).expect(900)
+      given({
+        cacheHeaderConfig,
+        serviceDefaultCacheLengthSeconds: 900,
+        queryParams: { cacheSeconds: 1000 },
+      }).expect(1000)
+      given({
+        cacheHeaderConfig,
+        serviceDefaultCacheLengthSeconds: 900,
+        queryParams: { cacheSeconds: 1000, other: 'here', maybe: 'bogus' },
+      }).expect(1000)
+      given({
+        cacheHeaderConfig,
+        serviceDefaultCacheLengthSeconds: 900,
+        queryParams: { cacheSeconds: 400 },
+      }).expect(900)
+      given({
+        cacheHeaderConfig,
+        serviceDefaultCacheLengthSeconds: 900,
+        queryParams: { cacheSeconds: '-1000' },
+      }).expect(900)
+      given({
+        cacheHeaderConfig,
+        serviceDefaultCacheLengthSeconds: 900,
+        queryParams: { cacheSeconds: '' },
+      }).expect(900)
+      given({
+        cacheHeaderConfig,
+        serviceDefaultCacheLengthSeconds: 900,
+        queryParams: { cacheSeconds: 'not a number' },
+      }).expect(900)
+      given({
+        cacheHeaderConfig,
+        serviceDefaultCacheLengthSeconds: 900,
+        // Legacy name.
+        queryParams: { maxAge: 1000 },
+      }).expect(1000)
+      given({
+        cacheHeaderConfig,
+        serviceDefaultCacheLengthSeconds: 900,
+        // Both legacy and new name provided -> both ignored.
+        queryParams: { maxAge: 1000, cacheSeconds: 1000 },
+      }).expect(900)
+      given({
+        cacheHeaderConfig,
+        serviceDefaultCacheLengthSeconds: 900,
+        serviceOverrideCacheLengthSeconds: 400,
+        queryParams: {},
+      }).expect(900)
+      given({
+        cacheHeaderConfig,
+        serviceOverrideCacheLengthSeconds: 400,
+        queryParams: {},
+      }).expect(777)
+      given({
+        cacheHeaderConfig,
+        serviceOverrideCacheLengthSeconds: 900,
+        queryParams: {},
+      }).expect(900)
+      given({
+        cacheHeaderConfig,
+        serviceOverrideCacheLengthSeconds: 800,
+        queryParams: { cacheSeconds: 500 },
+      }).expect(800)
+      given({
+        cacheHeaderConfig,
+        serviceOverrideCacheLengthSeconds: 900,
+        queryParams: { cacheSeconds: 800 },
+      }).expect(900)
+    })
+  })
+
+  describe('setHeadersForCacheLength', function() {
+    let sandbox
+    beforeEach(function() {
+      sandbox = sinon.createSandbox()
+      sandbox.useFakeTimers()
+    })
+    afterEach(function() {
+      sandbox.restore()
+      sandbox = undefined
+    })
+
+    it('should set the correct Date header', function() {
+      // Confidence check.
+      expect(res._headers.date).to.equal(undefined)
+
+      // Act.
+      setHeadersForCacheLength(res, 123)
+
+      // Assert.
+      const now = new Date().toGMTString()
+      expect(res._headers.date).to.equal(now)
+    })
+
+    context('cacheLengthSeconds is zero', function() {
+      beforeEach(function() {
+        setHeadersForCacheLength(res, 0)
+      })
+
+      it('should set the expected Cache-Control header', function() {
+        expect(res._headers['cache-control']).to.equal(
+          'no-cache, no-store, must-revalidate'
+        )
+      })
+
+      it('should set the expected Expires header', function() {
+        expect(res._headers.expires).to.equal(new Date().toGMTString())
+      })
+    })
+
+    context('cacheLengthSeconds is nonzero', function() {
+      beforeEach(function() {
+        setHeadersForCacheLength(res, 123)
+      })
+
+      it('should set the expected Cache-Control header', function() {
+        expect(res._headers['cache-control']).to.equal('max-age=123')
+      })
+
+      it('should set the expected Expires header', function() {
+        const expires = new Date(Date.now() + 123 * 1000).toGMTString()
+        expect(res._headers.expires).to.equal(expires)
+      })
+    })
+  })
+
+  describe('setCacheHeaders', function() {
+    it('sets the expected fields', function() {
+      const expectedFields = ['date', 'cache-control', 'expires']
+      expectedFields.forEach(field =>
+        expect(res._headers[field]).to.equal(undefined)
+      )
+
+      setCacheHeaders({
+        cacheHeaderConfig: { defaultCacheLengthSeconds: 1234 },
+        serviceDefaultCacheLengthSeconds: 567,
+        queryParams: { cacheSeconds: 999999 },
+        res,
+      })
+
+      expectedFields.forEach(field =>
+        expect(res._headers[field])
+          .to.be.a('string')
+          .and.have.lengthOf.at.least(1)
+      )
+    })
+  })
+
+  describe('setCacheHeadersForStaticResource', function() {
+    beforeEach(function() {
+      setCacheHeadersForStaticResource(res)
+    })
+
+    it('should set the expected Cache-Control header', function() {
+      expect(res._headers['cache-control']).to.equal(`max-age=${24 * 3600}`)
+    })
+
+    it('should set the expected Last-Modified header', function() {
+      const lastModified = res._headers['last-modified']
+      expect(new Date(lastModified)).to.be.withinTime(
+        // Within the last 60 seconds.
+        new Date(Date.now() - 60 * 1000),
+        new Date()
+      )
+    })
+  })
+
+  describe('serverHasBeenUpSinceResourceCached', function() {
+    // The stringified req's are hard to understand. I thought Sazerac
+    // provided a way to override the describe message, though I can't find it.
+    context('when there is no If-Modified-Since header', function() {
+      it('returns false', function() {
+        const req = httpMocks.createRequest()
+        expect(serverHasBeenUpSinceResourceCached(req)).to.equal(false)
+      })
+    })
+    context('when the If-Modified-Since header is invalid', function() {
+      it('returns false', function() {
+        const req = httpMocks.createRequest({
+          headers: { 'If-Modified-Since': 'this-is-not-a-date' },
+        })
+        expect(serverHasBeenUpSinceResourceCached(req)).to.equal(false)
+      })
+    })
+    context(
+      'when the If-Modified-Since header is before the process started',
+      function() {
+        it('returns false', function() {
+          const req = httpMocks.createRequest({
+            headers: { 'If-Modified-Since': '2018-02-01T05:00:00.000Z' },
+          })
+          expect(serverHasBeenUpSinceResourceCached(req)).to.equal(false)
+        })
+      }
+    )
+    context(
+      'when the If-Modified-Since header is after the process started',
+      function() {
+        it('returns true', function() {
+          const modifiedTimeStamp = new Date(Date.now() + 1800000)
+          const req = httpMocks.createRequest({
+            headers: { 'If-Modified-Since': modifiedTimeStamp.toISOString() },
+          })
+          expect(serverHasBeenUpSinceResourceCached(req)).to.equal(true)
+        })
+      }
+    )
+  })
+})

core/base-service/categories.js

@@ -0,0 +1,19 @@
+'use strict'
+
+const Joi = require('joi')
+const categories = require('../../services/categories')
+
+const isRealCategory = Joi.equal(categories.map(({ id }) => id)).required()
+
+const isValidCategory = Joi.alternatives()
+  .try(isRealCategory, Joi.equal('debug', 'dynamic', 'static').required())
+  .required()
+
+function assertValidCategory(category, message = undefined) {
+  Joi.assert(category, isValidCategory, message)
+}
+
+module.exports = {
+  isValidCategory,
+  assertValidCategory,
+}

core/base-service/check-error-response.js

@@ -0,0 +1,37 @@
+'use strict'
+
+const { NotFound, InvalidResponse, Inaccessible } = require('./errors')
+
+const defaultErrorMessages = {
+  404: 'not found',
+}
+
+module.exports = function checkErrorResponse(errorMessages = {}) {
+  return async function({ buffer, res }) {
+    let error
+    errorMessages = { ...defaultErrorMessages, ...errorMessages }
+    if (res.statusCode === 404) {
+      error = new NotFound({ prettyMessage: errorMessages[404] })
+    } else if (res.statusCode !== 200) {
+      const underlying = Error(
+        `Got status code ${res.statusCode} (expected 200)`
+      )
+      const props = { underlyingError: underlying }
+      if (errorMessages[res.statusCode] !== undefined) {
+        props.prettyMessage = errorMessages[res.statusCode]
+      }
+      if (res.statusCode >= 500) {
+        error = new Inaccessible(props)
+      } else {
+        error = new InvalidResponse(props)
+      }
+    }
+    if (error) {
+      error.response = res
+      error.buffer = buffer
+      throw error
+    } else {
+      return { buffer, res }
+    }
+  }
+}

core/base-service/check-error-response.spec.js

@@ -0,0 +1,113 @@
+'use strict'
+
+const { expect } = require('chai')
+const { NotFound, InvalidResponse, Inaccessible } = require('./errors')
+const checkErrorResponse = require('./check-error-response')
+
+describe('async error handler', function() {
+  const buffer = Buffer.from('some stuff')
+
+  context('when status is 200', function() {
+    it('passes through the inputs', async function() {
+      const res = { statusCode: 200 }
+      expect(await checkErrorResponse()({ res, buffer })).to.deep.equal({
+        res,
+        buffer,
+      })
+    })
+  })
+
+  context('when status is 404', function() {
+    const buffer = Buffer.from('some stuff')
+    const res = { statusCode: 404 }
+
+    it('throws NotFound', async function() {
+      try {
+        await checkErrorResponse()({ res, buffer })
+        expect.fail('Expected to throw')
+      } catch (e) {
+        expect(e).to.be.an.instanceof(NotFound)
+        expect(e.message).to.equal('Not Found')
+        expect(e.prettyMessage).to.equal('not found')
+        expect(e.response).to.equal(res)
+        expect(e.buffer).to.equal(buffer)
+      }
+    })
+
+    it('displays the custom not found message', async function() {
+      const notFoundMessage = 'no goblins found'
+      try {
+        await checkErrorResponse({ 404: notFoundMessage })({ res, buffer })
+        expect.fail('Expected to throw')
+      } catch (e) {
+        expect(e).to.be.an.instanceof(NotFound)
+        expect(e.message).to.equal('Not Found: no goblins found')
+        expect(e.prettyMessage).to.equal('no goblins found')
+      }
+    })
+  })
+
+  context('when status is 4xx', function() {
+    it('throws InvalidResponse', async function() {
+      const res = { statusCode: 499 }
+      try {
+        await checkErrorResponse()({ res, buffer })
+        expect.fail('Expected to throw')
+      } catch (e) {
+        expect(e).to.be.an.instanceof(InvalidResponse)
+        expect(e.message).to.equal(
+          'Invalid Response: Got status code 499 (expected 200)'
+        )
+        expect(e.prettyMessage).to.equal('invalid')
+        expect(e.response).to.equal(res)
+        expect(e.buffer).to.equal(buffer)
+      }
+    })
+
+    it('displays the custom error message', async function() {
+      const res = { statusCode: 403 }
+      try {
+        await checkErrorResponse({ 403: 'access denied' })({ res })
+        expect.fail('Expected to throw')
+      } catch (e) {
+        expect(e).to.be.an.instanceof(InvalidResponse)
+        expect(e.message).to.equal(
+          'Invalid Response: Got status code 403 (expected 200)'
+        )
+        expect(e.prettyMessage).to.equal('access denied')
+      }
+    })
+  })
+
+  context('when status is 5xx', function() {
+    it('throws Inaccessible', async function() {
+      const res = { statusCode: 503 }
+      try {
+        await checkErrorResponse()({ res, buffer })
+        expect.fail('Expected to throw')
+      } catch (e) {
+        expect(e).to.be.an.instanceof(Inaccessible)
+        expect(e.message).to.equal(
+          'Inaccessible: Got status code 503 (expected 200)'
+        )
+        expect(e.prettyMessage).to.equal('inaccessible')
+        expect(e.response).to.equal(res)
+        expect(e.buffer).to.equal(buffer)
+      }
+    })
+
+    it('displays the custom error message', async function() {
+      const res = { statusCode: 500 }
+      try {
+        await checkErrorResponse({ 500: 'server overloaded' })({ res, buffer })
+        expect.fail('Expected to throw')
+      } catch (e) {
+        expect(e).to.be.an.instanceof(Inaccessible)
+        expect(e.message).to.equal(
+          'Inaccessible: Got status code 500 (expected 200)'
+        )
+        expect(e.prettyMessage).to.equal('server overloaded')
+      }
+    })
+  })
+})

core/base-service/coalesce-badge.js

@@ -0,0 +1,174 @@
+'use strict'
+
+const {
+  decodeDataUrlFromQueryParam,
+  prepareNamedLogo,
+} = require('../../lib/logos')
+const { svg2base64 } = require('../../lib/svg-helpers')
+const coalesce = require('./coalesce')
+const toArray = require('./to-array')
+
+// Translate modern badge data to the legacy schema understood by the badge
+// maker. Allow the user to override the label, color, logo, etc. through the
+// query string. Provide support for most badge options via `serviceData` so
+// the Endpoint badge can specify logos and colors, though allow that the
+// user's logo or color to take precedence. A notable exception is the case of
+// errors. When the service specifies that an error has occurred, the user's
+// requested color does not override the error color.
+//
+// Logos are resolved in this manner:
+//
+// 1. When `?logo=` contains the name of one of the Shields logos, or contains
+//    base64-encoded SVG, that logo is used. In the case of a named logo, when
+//    a `&logoColor=` is specified, that color is used. Otherwise the default
+//    color is used. `logoColor` will not be applied to a custom
+//    (base64-encoded) logo; if a custom color is desired the logo should be
+//    recolored prior to making the request. The appearance of the logo can be
+//    customized using `logoWidth`, and in the case of the popout badge,
+//    `logoPosition`. When `?logo=` is specified, any logo-related parameters
+//    specified dynamically by the service, or by default in the service, are
+//    ignored.
+// 2. The second precedence is the dynamic logo returned by a service. This is
+//    used only by the Endpoint badge. The `logoColor` can be overridden by the
+//    query string.
+// 3. In the case of the `social` style only, the last precedence is the
+//    service's default logo. The `logoColor` can be overridden by the query
+//    string.
+module.exports = function coalesceBadge(
+  overrides,
+  serviceData,
+  // These two parameters were kept separate to make tests clearer.
+  defaultBadgeData,
+  { category, _cacheLength: defaultCacheSeconds } = {}
+) {
+  // The "overrideX" naming is based on services that provide badge
+  // parameters themselves, which can be overridden by a query string
+  // parameter. (For a couple services, the dynamic badge and the
+  // query-string-based static badge, the service never sets a value
+  // so the query string overrides are the _only_ way to configure
+  // these badge parameters.
+  const {
+    style: overrideStyle,
+    label: overrideLabel,
+    logo: overrideLogo,
+    logoColor: overrideLogoColor,
+    link: overrideLink,
+    colorB: legacyOverrideColor,
+    colorA: legacyOverrideLabelColor,
+  } = overrides
+  let {
+    logoWidth: overrideLogoWidth,
+    logoPosition: overrideLogoPosition,
+    color: overrideColor,
+    labelColor: overrideLabelColor,
+  } = overrides
+
+  // Only use the legacy properties if the new ones are not provided
+  if (typeof overrideColor === 'undefined') {
+    overrideColor = legacyOverrideColor
+  }
+  if (typeof overrideLabelColor === 'undefined') {
+    overrideLabelColor = legacyOverrideLabelColor
+  }
+
+  // Scoutcamp converts numeric query params to numbers. Convert them back.
+  if (typeof overrideColor === 'number') {
+    overrideColor = `${overrideColor}`
+  }
+  if (typeof overrideLabelColor === 'number') {
+    overrideLabelColor = `${overrideLabelColor}`
+  }
+  overrideLogoWidth = +overrideLogoWidth || undefined
+  overrideLogoPosition = +overrideLogoPosition || undefined
+
+  const {
+    isError,
+    label: serviceLabel,
+    message: serviceMessage,
+    color: serviceColor,
+    labelColor: serviceLabelColor,
+    logoSvg: serviceLogoSvg,
+    namedLogo: serviceNamedLogo,
+    logoColor: serviceLogoColor,
+    logoWidth: serviceLogoWidth,
+    logoPosition: serviceLogoPosition,
+    link: serviceLink,
+    cacheSeconds: serviceCacheSeconds,
+    style: serviceStyle,
+  } = serviceData
+
+  const {
+    color: defaultColor,
+    namedLogo: defaultNamedLogo,
+    label: defaultLabel,
+    labelColor: defaultLabelColor,
+  } = defaultBadgeData
+
+  const style = coalesce(overrideStyle, serviceStyle)
+
+  let namedLogo, namedLogoColor, logoWidth, logoPosition, logoSvgBase64
+  if (overrideLogo) {
+    // `?logo=` could be a named logo or encoded svg.
+    const overrideLogoSvgBase64 = decodeDataUrlFromQueryParam(overrideLogo)
+    if (overrideLogoSvgBase64) {
+      logoSvgBase64 = overrideLogoSvgBase64
+    } else {
+      namedLogo = overrideLogo
+      // If the logo has been overridden it does not make sense to inherit the
+      // original color.
+      namedLogoColor = overrideLogoColor
+    }
+    // If the logo has been overridden it does not make sense to inherit the
+    // original width or position.
+    logoWidth = overrideLogoWidth
+    logoPosition = overrideLogoPosition
+  } else {
+    if (serviceLogoSvg) {
+      logoSvgBase64 = svg2base64(serviceLogoSvg)
+    } else {
+      namedLogo = coalesce(
+        serviceNamedLogo,
+        style === 'social' ? defaultNamedLogo : undefined
+      )
+      namedLogoColor = coalesce(overrideLogoColor, serviceLogoColor)
+    }
+    logoWidth = coalesce(overrideLogoWidth, serviceLogoWidth)
+    logoPosition = coalesce(overrideLogoPosition, serviceLogoPosition)
+  }
+  if (namedLogo) {
+    logoSvgBase64 = prepareNamedLogo({
+      name: namedLogo,
+      color: namedLogoColor,
+      style,
+    })
+  }
+
+  return {
+    text: [
+      // Use `coalesce()` to support empty labels and messages, as in the
+      // static badge.
+      coalesce(overrideLabel, serviceLabel, defaultLabel, category),
+      coalesce(serviceMessage, 'n/a'),
+    ],
+    color: coalesce(
+      // In case of an error, disregard user's color override.
+      isError ? undefined : overrideColor,
+      serviceColor,
+      defaultColor,
+      'lightgrey'
+    ),
+    labelColor: coalesce(
+      // In case of an error, disregard user's color override.
+      isError ? undefined : overrideLabelColor,
+      serviceLabelColor,
+      defaultLabelColor
+    ),
+    template: style,
+    namedLogo,
+    logo: logoSvgBase64,
+    logoWidth,
+    logoPosition,
+    links: toArray(overrideLink || serviceLink),
+    cacheLengthSeconds: coalesce(serviceCacheSeconds, defaultCacheSeconds),
+  }
+}

core/base-service/coalesce-badge.spec.js

@@ -0,0 +1,294 @@
+'use strict'
+
+const { expect } = require('chai')
+const { getShieldsIcon, getSimpleIcon } = require('../../lib/logos')
+const coalesceBadge = require('./coalesce-badge')
+
+describe('coalesceBadge', function() {
+  describe('Label', function() {
+    it('uses the default label', function() {
+      expect(coalesceBadge({}, {}, { label: 'heyo' }).text).to.deep.equal([
+        'heyo',
+        'n/a',
+      ])
+    })
+
+    // This behavior isn't great and we might want to remove it.
+    it('uses the category as a default label', function() {
+      expect(coalesceBadge({}, {}, {}, { category: 'cat' }).text).to.deep.equal(
+        ['cat', 'n/a']
+      )
+    })
+
+    it('preserves an empty label', function() {
+      expect(
+        coalesceBadge({}, { label: '', message: '10k' }, {}).text
+      ).to.deep.equal(['', '10k'])
+    })
+
+    it('overrides the label', function() {
+      expect(
+        coalesceBadge({ label: 'purr count' }, { label: 'purrs' }, {}).text
+      ).to.deep.equal(['purr count', 'n/a'])
+    })
+  })
+
+  describe('Message', function() {
+    it('applies the service message', function() {
+      expect(coalesceBadge({}, { message: '10k' }, {}).text).to.deep.equal([
+        undefined,
+        '10k',
+      ])
+    })
+
+    it('applies a numeric service message', function() {
+      // While a number of badges use this, in the long run we may want
+      // `render()` to always return a string.
+      expect(coalesceBadge({}, { message: 10 }, {}).text).to.deep.equal([
+        undefined,
+        10,
+      ])
+    })
+  })
+
+  describe('Right color', function() {
+    it('uses the default color', function() {
+      expect(coalesceBadge({}, {}, {}).color).to.equal('lightgrey')
+    })
+
+    it('overrides the color', function() {
+      expect(
+        coalesceBadge({ color: '10ADED' }, { color: 'red' }, {}).color
+      ).to.equal('10ADED')
+      // also expected for legacy name
+      expect(
+        coalesceBadge({ colorB: 'B0ADED' }, { color: 'red' }, {}).color
+      ).to.equal('B0ADED')
+    })
+
+    context('In case of an error', function() {
+      it('does not override the color', function() {
+        expect(
+          coalesceBadge(
+            { color: '10ADED' },
+            { isError: true, color: 'lightgray' },
+            {}
+          ).color
+        ).to.equal('lightgray')
+        // also expected for legacy name
+        expect(
+          coalesceBadge(
+            { colorB: 'B0ADED' },
+            { isError: true, color: 'lightgray' },
+            {}
+          ).color
+        ).to.equal('lightgray')
+      })
+    })
+
+    it('applies the service color', function() {
+      expect(coalesceBadge({}, { color: 'red' }, {}).color).to.equal('red')
+    })
+  })
+
+  describe('Left color', function() {
+    it('provides no default label color', function() {
+      expect(coalesceBadge({}, {}, {}).labelColor).to.be.undefined
+    })
+
+    it('applies the service label color', function() {
+      expect(coalesceBadge({}, { labelColor: 'red' }, {}).labelColor).to.equal(
+        'red'
+      )
+    })
+
+    it('overrides the label color', function() {
+      expect(
+        coalesceBadge({ labelColor: '42f483' }, { color: 'green' }, {})
+          .labelColor
+      ).to.equal('42f483')
+      // also expected for legacy name
+      expect(
+        coalesceBadge({ colorA: 'B2f483' }, { color: 'green' }, {}).labelColor
+      ).to.equal('B2f483')
+    })
+
+    it('converts a query-string numeric color to a string', function() {
+      expect(
+        coalesceBadge(
+          // Scoutcamp converts numeric query params to numbers.
+          { color: 123 },
+          { color: 'green' },
+          {}
+        ).color
+      ).to.equal('123')
+      // also expected for legacy name
+      expect(
+        coalesceBadge(
+          // Scoutcamp converts numeric query params to numbers.
+          { colorB: 123 },
+          { color: 'green' },
+          {}
+        ).color
+      ).to.equal('123')
+    })
+  })
+
+  describe('Named logos', function() {
+    it('when not a social badge, ignores the default named logo', function() {
+      expect(coalesceBadge({}, {}, { namedLogo: 'appveyor' }).logo).to.be
+        .undefined
+    })
+
+    it('when a social badge, uses the default named logo', function() {
+      // .not.be.empty for confidence that nothing has changed with `getShieldsIcon()`.
+      expect(
+        coalesceBadge({ style: 'social' }, {}, { namedLogo: 'appveyor' }).logo
+      ).to.equal(getSimpleIcon({ name: 'appveyor' })).and.not.be.empty
+    })
+
+    it('applies the named logo', function() {
+      expect(coalesceBadge({}, { namedLogo: 'npm' }, {}).namedLogo).to.equal(
+        'npm'
+      )
+      expect(coalesceBadge({}, { namedLogo: 'npm' }, {}).logo).to.equal(
+        getShieldsIcon({ name: 'npm' })
+      ).and.not.to.be.empty
+    })
+
+    it('applies the named logo with color', function() {
+      expect(
+        coalesceBadge({}, { namedLogo: 'npm', logoColor: 'blue' }, {}).logo
+      ).to.equal(getShieldsIcon({ name: 'npm', color: 'blue' })).and.not.to.be
+        .empty
+    })
+
+    it('overrides the logo', function() {
+      expect(
+        coalesceBadge({ logo: 'npm' }, { namedLogo: 'appveyor' }, {}).logo
+      ).to.equal(getShieldsIcon({ name: 'npm' })).and.not.be.empty
+    })
+
+    it('overrides the logo with a color', function() {
+      expect(
+        coalesceBadge(
+          { logo: 'npm', logoColor: 'blue' },
+          { namedLogo: 'appveyor' },
+          {}
+        ).logo
+      ).to.equal(getShieldsIcon({ name: 'npm', color: 'blue' })).and.not.be
+        .empty
+    })
+
+    it("when the logo is overridden, it ignores the service's logo color, position, and width", function() {
+      expect(
+        coalesceBadge(
+          { logo: 'npm' },
+          {
+            namedLogo: 'appveyor',
+            logoColor: 'red',
+            logoPosition: -3,
+            logoWidth: 100,
+          },
+          {}
+        ).logo
+      ).to.equal(getShieldsIcon({ name: 'npm' })).and.not.be.empty
+    })
+
+    it("overrides the service logo's color", function() {
+      expect(
+        coalesceBadge(
+          { logoColor: 'blue' },
+          { namedLogo: 'npm', logoColor: 'red' },
+          {}
+        ).logo
+      ).to.equal(getShieldsIcon({ name: 'npm', color: 'blue' })).and.not.be
+        .empty
+    })
+
+    // https://github.com/badges/shields/issues/2998
+    it('overrides logoSvg', function() {
+      const logoSvg = 'data:image/svg+xml;base64,PHN2ZyB4bWxu'
+      expect(coalesceBadge({ logo: 'npm' }, { logoSvg }, {}).logo).to.equal(
+        getShieldsIcon({ name: 'npm' })
+      ).and.not.be.empty
+    })
+  })
+
+  describe('Custom logos', function() {
+    it('overrides the logo with custom svg', function() {
+      const logoSvg = 'data:image/svg+xml;base64,PHN2ZyB4bWxu'
+      expect(
+        coalesceBadge({ logo: logoSvg }, { namedLogo: 'appveyor' }, {}).logo
+      ).to.equal(logoSvg)
+    })
+
+    it('ignores the color when custom svg is provided', function() {
+      const logoSvg = 'data:image/svg+xml;base64,PHN2ZyB4bWxu'
+      expect(
+        coalesceBadge(
+          { logo: logoSvg, logoColor: 'brightgreen' },
+          { namedLogo: 'appveyor' },
+          {}
+        ).logo
+      ).to.equal(logoSvg)
+    })
+  })
+
+  describe('Logo width', function() {
+    it('overrides the logoWidth', function() {
+      expect(coalesceBadge({ logoWidth: 20 }, {}, {}).logoWidth).to.equal(20)
+    })
+
+    it('applies the logo width', function() {
+      expect(
+        coalesceBadge({}, { namedLogo: 'npm', logoWidth: 275 }, {}).logoWidth
+      ).to.equal(275)
+    })
+  })
+
+  describe('Logo position', function() {
+    it('overrides the logoPosition', function() {
+      expect(
+        coalesceBadge({ logoPosition: -10 }, {}, {}).logoPosition
+      ).to.equal(-10)
+    })
+
+    it('applies the logo position', function() {
+      expect(
+        coalesceBadge({}, { namedLogo: 'npm', logoPosition: -10 }, {})
+          .logoPosition
+      ).to.equal(-10)
+    })
+  })
+
+  describe('Links', function() {
+    it('overrides the links', function() {
+      expect(
+        coalesceBadge(
+          { link: 'https://circleci.com/gh/badges/daily-tests' },
+          {
+            link:
+              'https://circleci.com/workflow-run/184ef3de-4836-4805-a2e4-0ceba099f92d',
+          },
+          {}
+        ).links
+      ).to.deep.equal(['https://circleci.com/gh/badges/daily-tests'])
+    })
+  })
+
+  describe('Style', function() {
+    it('overrides the template', function() {
+      expect(coalesceBadge({ style: 'pill' }, {}, {}).template).to.equal('pill')
+    })
+  })
+
+  describe('Cache length', function() {
+    it('overrides the cache length', function() {
+      expect(
+        coalesceBadge({ style: 'pill' }, { cacheSeconds: 123 }, {})
+          .cacheLengthSeconds
+      ).to.equal(123)
+    })
+  })
+})

core/base-service/coalesce.js

@@ -0,0 +1,5 @@
+'use strict'
+
+module.exports = function coalesce(...candidates) {
+  return candidates.find(c => c !== undefined && c !== null)
+}

core/base-service/coalesce.spec.js

@@ -0,0 +1,23 @@
+'use strict'
+
+const { test, given } = require('sazerac')
+const coalesce = require('./coalesce')
+
+// Sticking with our one-line spread implementation, and defaulting to
+// `undefined` instead of `null`, though h/t to
+// https://github.com/royriojas/coalescy for these tests!
+
+describe('coalesce', function() {
+  test(coalesce, function() {
+    given().expect(undefined)
+    given(null, []).expect([])
+    given(null, [], {}).expect([])
+    given(null, undefined, 0, {}).expect(0)
+
+    const a = null,
+      c = 0,
+      d = 1
+    let b
+    given(a, b, c, d).expect(0)
+  })
+})

core/base-service/deprecated-service.js

@@ -0,0 +1,63 @@
+'use strict'
+
+const Joi = require('joi')
+const camelcase = require('camelcase')
+const BaseService = require('./base')
+const { isValidCategory } = require('./categories')
+const { Deprecated } = require('./errors')
+const { isValidRoute } = require('./route')
+
+const attrSchema = Joi.object({
+  route: isValidRoute,
+  name: Joi.string(),
+  label: Joi.string(),
+  category: isValidCategory,
+  // The content of examples is validated later, via `transformExamples()`.
+  examples: Joi.array().default([]),
+  message: Joi.string(),
+  dateAdded: Joi.date().required(),
+}).required()
+
+function deprecatedService(attrs) {
+  const { route, name, label, category, examples, message } = Joi.attempt(
+    attrs,
+    attrSchema,
+    `Deprecated service for ${attrs.route.base}`
+  )
+
+  return class DeprecatedService extends BaseService {
+    static get name() {
+      return name
+        ? `Deprecated${name}`
+        : `Deprecated${camelcase(route.base.replace(/\//g, '_'), {
+            pascalCase: true,
+          })}`
+    }
+
+    static get category() {
+      return category
+    }
+
+    static get isDeprecated() {
+      return true
+    }
+
+    static get route() {
+      return route
+    }
+
+    static get examples() {
+      return examples
+    }
+
+    static get defaultBadgeData() {
+      return { label }
+    }
+
+    async handle() {
+      throw new Deprecated({ prettyMessage: message })
+    }
+  }
+}
+
+module.exports = deprecatedService

core/base-service/deprecated-service.spec.js

@@ -0,0 +1,69 @@
+'use strict'
+
+const { expect } = require('chai')
+const deprecatedService = require('./deprecated-service')
+
+describe('DeprecatedService', function() {
+  const route = {
+    base: 'service/that/no/longer/exists',
+    format: '(?:.+)',
+  }
+  const category = 'analysis'
+  const dateAdded = new Date()
+  const commonAttrs = { route, category, dateAdded }
+
+  it('returns true on isDeprecated', function() {
+    const service = deprecatedService({ ...commonAttrs })
+    expect(service.isDeprecated).to.be.true
+  })
+
+  it('has the expected name', function() {
+    const service = deprecatedService({ ...commonAttrs })
+    expect(service.name).to.equal('DeprecatedServiceThatNoLongerExists')
+  })
+
+  it('sets specified route', function() {
+    const service = deprecatedService({ ...commonAttrs })
+    expect(service.route).to.deep.equal(route)
+  })
+
+  it('sets specified label', function() {
+    const label = 'coverity'
+    const service = deprecatedService({ ...commonAttrs, label })
+    expect(service.defaultBadgeData.label).to.equal(label)
+  })
+
+  it('sets specified category', function() {
+    const service = deprecatedService({ ...commonAttrs })
+    expect(service.category).to.equal(category)
+  })
+
+  it('sets specified examples', function() {
+    const examples = [
+      {
+        title: 'Not sure we would have examples',
+      },
+    ]
+    const service = deprecatedService({ ...commonAttrs, examples })
+    expect(service.examples).to.deep.equal(examples)
+  })
+
+  it('uses default deprecation message when no message specified', async function() {
+    const service = deprecatedService({ ...commonAttrs })
+    expect(await service.invoke()).to.deep.equal({
+      isError: true,
+      color: 'lightgray',
+      message: 'no longer available',
+    })
+  })
+
+  it('uses custom deprecation message when specified', async function() {
+    const message = 'extended outage'
+    const service = deprecatedService({ ...commonAttrs, message })
+    expect(await service.invoke()).to.deep.equal({
+      isError: true,
+      color: 'lightgray',
+      message,
+    })
+  })
+})

core/base-service/errors.js

@@ -0,0 +1,113 @@
+'use strict'
+
+class ShieldsRuntimeError extends Error {
+  get name() {
+    return 'ShieldsRuntimeError'
+  }
+  get defaultPrettyMessage() {
+    throw new Error('Must implement abstract method')
+  }
+
+  constructor(props = {}, message) {
+    super(message)
+    this.prettyMessage = props.prettyMessage || this.defaultPrettyMessage
+    if (props.underlyingError) {
+      this.stack = props.underlyingError.stack
+    }
+  }
+}
+
+const defaultNotFoundError = 'not found'
+
+class NotFound extends ShieldsRuntimeError {
+  get name() {
+    return 'NotFound'
+  }
+  get defaultPrettyMessage() {
+    return defaultNotFoundError
+  }
+
+  constructor(props = {}) {
+    const prettyMessage = props.prettyMessage || defaultNotFoundError
+    const message =
+      prettyMessage === defaultNotFoundError
+        ? 'Not Found'
+        : `Not Found: ${prettyMessage}`
+    super(props, message)
+    this.response = props.response
+  }
+}
+
+class InvalidResponse extends ShieldsRuntimeError {
+  get name() {
+    return 'InvalidResponse'
+  }
+  get defaultPrettyMessage() {
+    return 'invalid'
+  }
+
+  constructor(props = {}) {
+    const message = props.underlyingError
+      ? `Invalid Response: ${props.underlyingError.message}`
+      : 'Invalid Response'
+    super(props, message)
+    this.response = props.response
+  }
+}
+
+class Inaccessible extends ShieldsRuntimeError {
+  get name() {
+    return 'Inaccessible'
+  }
+  get defaultPrettyMessage() {
+    return 'inaccessible'
+  }
+
+  constructor(props = {}) {
+    const message = props.underlyingError
+      ? `Inaccessible: ${props.underlyingError.message}`
+      : 'Inaccessible'
+    super(props, message)
+    this.response = props.response
+  }
+}
+
+class InvalidParameter extends ShieldsRuntimeError {
+  get name() {
+    return 'InvalidParameter'
+  }
+  get defaultPrettyMessage() {
+    return 'invalid parameter'
+  }
+
+  constructor(props = {}) {
+    const message = props.underlyingError
+      ? `Invalid Parameter: ${props.underlyingError.message}`
+      : 'Invalid Parameter'
+    super(props, message)
+    this.response = props.response
+  }
+}
+
+class Deprecated extends ShieldsRuntimeError {
+  get name() {
+    return 'Deprecated'
+  }
+  get defaultPrettyMessage() {
+    return 'no longer available'
+  }
+
+  constructor(props) {
+    const message = 'Deprecated'
+    super(props, message)
+  }
+}
+
+module.exports = {
+  ShieldsRuntimeError,
+  NotFound,
+  InvalidResponse,
+  Inaccessible,
+  InvalidParameter,
+  Deprecated,
+}

core/base-service/examples.js

@@ -0,0 +1,169 @@
+'use strict'
+
+const Joi = require('joi')
+const pathToRegexp = require('path-to-regexp')
+const coalesceBadge = require('./coalesce-badge')
+const { makeFullUrl } = require('./route')
+
+const optionalObjectOfKeyValues = Joi.object().pattern(
+  /./,
+  Joi.string().allow(null)
+)
+
+const schema = Joi.object({
+  // This should be:
+  // title: Joi.string().required(),
+  title: Joi.string(),
+  namedParams: optionalObjectOfKeyValues.required(),
+  queryParams: optionalObjectOfKeyValues.default({}),
+  pattern: Joi.string(),
+  staticPreview: Joi.object({
+    label: Joi.string(),
+    message: Joi.alternatives()
+      .try(
+        Joi.string()
+          .allow('')
+          .required(),
+        Joi.number()
+      )
+      .required(),
+    color: Joi.string(),
+    style: Joi.string(),
+  }).required(),
+  keywords: Joi.array()
+    .items(Joi.string())
+    .default([]),
+  documentation: Joi.string(), // Valid HTML.
+}).required()
+
+function validateExample(example, index, ServiceClass) {
+  const result = Joi.attempt(
+    example,
+    schema,
+    `Example for ${ServiceClass.name} at index ${index}`
+  )
+
+  const { pattern, namedParams } = result
+
+  if (!pattern && !ServiceClass.route.pattern) {
+    throw new Error(
+      `Example for ${
+        ServiceClass.name
+      } at index ${index} does not declare a pattern`
+    )
+  }
+  if (pattern === ServiceClass.route.pattern) {
+    throw new Error(
+      `Example for ${
+        ServiceClass.name
+      } at index ${index} declares a redundant pattern which should be removed`
+    )
+  }
+
+  // Make sure we can build the full URL using these patterns.
+  try {
+    pathToRegexp.compile(pattern || ServiceClass.route.pattern)(namedParams)
+  } catch (e) {
+    throw Error(
+      `In example for ${
+        ServiceClass.name
+      } at index ${index}, ${e.message.toLowerCase()}`
+    )
+  }
+  // Make sure there are no extra keys.
+  let keys = []
+  pathToRegexp(pattern || ServiceClass.route.pattern, keys)
+  keys = keys.map(({ name }) => name)
+  const extraKeys = Object.keys(namedParams).filter(k => !keys.includes(k))
+  if (extraKeys.length) {
+    throw Error(
+      `In example for ${
+        ServiceClass.name
+      } at index ${index}, namedParams contains unknown keys: ${extraKeys.join(
+        ', '
+      )}`
+    )
+  }
+
+  if (example.keywords) {
+    // Make sure the keywords are at least two characters long.
+    const tinyKeywords = example.keywords.filter(k => k.length < 2)
+    if (tinyKeywords.length) {
+      throw Error(
+        `In example for ${
+          ServiceClass.name
+        } at index ${index}, keywords contains words that are less than two characters long: ${tinyKeywords.join(
+          ', '
+        )}`
+      )
+    }
+    // Make sure none of the keywords are already included in the title.
+    const title = (example.title || ServiceClass.name).toLowerCase()
+    const redundantKeywords = example.keywords.filter(k =>
+      title.includes(k.toLowerCase())
+    )
+    if (redundantKeywords.length) {
+      throw Error(
+        `In example for ${
+          ServiceClass.name
+        } at index ${index}, keywords contains words that are already in the title: ${redundantKeywords.join(
+          ', '
+        )}`
+      )
+    }
+  }
+
+  return result
+}
+
+function transformExample(inExample, index, ServiceClass) {
+  const {
+    // We should get rid of this transform, since the class name is never what
+    // we want to see.
+    title = ServiceClass.name,
+    namedParams,
+    queryParams,
+    pattern,
+    staticPreview,
+    keywords,
+    documentation,
+  } = validateExample(inExample, index, ServiceClass)
+
+  const {
+    text: [label, message],
+    color,
+    template: style,
+    namedLogo,
+  } = coalesceBadge(
+    {},
+    staticPreview,
+    ServiceClass.defaultBadgeData,
+    ServiceClass
+  )
+
+  return {
+    title,
+    example: {
+      pattern: makeFullUrl(
+        ServiceClass.route.base,
+        pattern || ServiceClass.route.pattern
+      ),
+      namedParams,
+      queryParams,
+    },
+    preview: {
+      label,
+      message: `${message}`,
+      color,
+      style: style === 'flat' ? undefined : style,
+      namedLogo,
+    },
+    keywords,
+    documentation: documentation ? { __html: documentation } : undefined,
+  }
+}
+
+module.exports = {
+  validateExample,
+  transformExample,
+}

core/base-service/examples.spec.js

@@ -0,0 +1,168 @@
+'use strict'
+
+const { expect } = require('chai')
+const { test, given } = require('sazerac')
+const { validateExample, transformExample } = require('./examples')
+
+describe('validateExample function', function() {
+  it('passes valid examples', function() {
+    const validExamples = [
+      {
+        title: 'Package manager versioning badge',
+        staticPreview: { message: '123' },
+        pattern: 'dt/:package',
+        namedParams: { package: 'mypackage' },
+        keywords: ['semver', 'management'],
+      },
+    ]
+
+    validExamples.forEach(example => {
+      expect(() =>
+        validateExample(example, 0, { route: {}, name: 'mockService' })
+      ).not.to.throw(Error)
+    })
+  })
+
+  it('rejects invalid examples', function() {
+    const invalidExamples = [
+      {},
+      { staticPreview: { message: '123' } },
+      {
+        staticPreview: { message: '123' },
+        pattern: 'dt/:package',
+        namedParams: { package: 'mypackage' },
+        exampleUrl: 'dt/mypackage',
+      },
+      { staticPreview: { message: '123' }, pattern: 'dt/:package' },
+      {
+        staticPreview: { message: '123' },
+        pattern: 'dt/:package',
+        previewUrl: 'dt/mypackage',
+      },
+      {
+        staticPreview: { message: '123' },
+        pattern: 'dt/:package',
+        exampleUrl: 'dt/mypackage',
+      },
+      { previewUrl: 'dt/mypackage' },
+      {
+        staticPreview: { message: '123' },
+        pattern: 'dt/:package',
+        namedParams: { package: 'mypackage' },
+        keywords: ['a'], // Keyword too short.
+      },
+      {
+        staticPreview: { message: '123' },
+        pattern: 'dt/:package',
+        namedParams: { package: 'mypackage' },
+        keywords: ['mockService'], // No title and keyword matching the class name.
+      },
+      {
+        title: 'Package manager versioning badge',
+        staticPreview: { message: '123' },
+        pattern: 'dt/:package',
+        namedParams: { package: 'mypackage' },
+        keywords: ['version'], // Keyword included in title.
+      },
+    ]
+
+    invalidExamples.forEach(example => {
+      expect(() =>
+        validateExample(example, 0, { route: {}, name: 'mockService' })
+      ).to.throw(Error)
+    })
+  })
+})
+
+test(transformExample, function() {
+  const ExampleService = {
+    name: 'ExampleService',
+    route: {
+      base: 'some-service',
+      pattern: ':interval/:packageName',
+    },
+    defaultBadgeData: {
+      label: 'downloads',
+    },
+  }
+
+  given(
+    {
+      pattern: 'dt/:packageName',
+      namedParams: { packageName: 'express' },
+      staticPreview: { message: '50k' },
+      keywords: ['hello'],
+    },
+    0,
+    ExampleService
+  ).expect({
+    title: 'ExampleService',
+    example: {
+      pattern: '/some-service/dt/:packageName',
+      namedParams: { packageName: 'express' },
+      queryParams: {},
+    },
+    preview: {
+      label: 'downloads',
+      message: '50k',
+      color: 'lightgrey',
+      namedLogo: undefined,
+      style: undefined,
+    },
+    keywords: ['hello'],
+    documentation: undefined,
+  })
+
+  given(
+    {
+      namedParams: { interval: 'dt', packageName: 'express' },
+      staticPreview: { message: '50k' },
+      keywords: ['hello'],
+    },
+    0,
+    ExampleService
+  ).expect({
+    title: 'ExampleService',
+    example: {
+      pattern: '/some-service/:interval/:packageName',
+      namedParams: { interval: 'dt', packageName: 'express' },
+      queryParams: {},
+    },
+    preview: {
+      label: 'downloads',
+      message: '50k',
+      color: 'lightgrey',
+      namedLogo: undefined,
+      style: undefined,
+    },
+    keywords: ['hello'],
+    documentation: undefined,
+  })
+
+  given(
+    {
+      namedParams: { interval: 'dt', packageName: 'express' },
+      queryParams: { registry_url: 'http://example.com/' },
+      staticPreview: { message: '50k' },
+      keywords: ['hello'],
+    },
+    0,
+    ExampleService
+  ).expect({
+    title: 'ExampleService',
+    example: {
+      pattern: '/some-service/:interval/:packageName',
+      namedParams: { interval: 'dt', packageName: 'express' },
+      queryParams: { registry_url: 'http://example.com/' },
+    },
+    preview: {
+      label: 'downloads',
+      message: '50k',
+      color: 'lightgrey',
+      namedLogo: undefined,
+      style: undefined,
+    },
+    keywords: ['hello'],
+    documentation: undefined,
+  })
+})

core/base-service/index.js

@@ -0,0 +1,35 @@
+'use strict'
+
+const BaseService = require('./base')
+const BaseJsonService = require('./base-json')
+const NonMemoryCachingBaseService = require('./base-non-memory-caching')
+const BaseStaticService = require('./base-static')
+const BaseSvgScrapingService = require('./base-svg-scraping')
+const BaseXmlService = require('./base-xml')
+const BaseYamlService = require('./base-yaml')
+const deprecatedService = require('./deprecated-service')
+const redirector = require('./redirector')
+const {
+  NotFound,
+  InvalidResponse,
+  Inaccessible,
+  InvalidParameter,
+  Deprecated,
+} = require('./errors')
+
+module.exports = {
+  BaseService,
+  BaseJsonService,
+  NonMemoryCachingBaseService,
+  BaseStaticService,
+  BaseSvgScrapingService,
+  BaseXmlService,
+  BaseYamlService,
+  deprecatedService,
+  redirector,
+  NotFound,
+  InvalidResponse,
+  Inaccessible,
+  InvalidParameter,
+  Deprecated,
+}

core/base-service/legacy-request-handler.js

@@ -0,0 +1,310 @@
+'use strict'
+
+// eslint-disable-next-line node/no-deprecated-api
+const domain = require('domain')
+const request = require('request')
+const queryString = require('query-string')
+const LruCache = require('../../gh-badges/lib/lru-cache')
+const makeBadge = require('../../gh-badges/lib/make-badge')
+const log = require('../server/log')
+const { setCacheHeaders } = require('./cache-headers')
+const {
+  Inaccessible,
+  InvalidResponse,
+  ShieldsRuntimeError,
+} = require('./errors')
+const { makeSend } = require('./legacy-result-sender')
+const coalesceBadge = require('./coalesce-badge')
+
+// We avoid calling the vendor's server for computation of the information in a
+// number of badges.
+const minAccuracy = 0.75
+
+// The quotient of (vendor) data change frequency by badge request frequency
+// must be lower than this to trigger sending the cached data *before*
+// updating our data from the vendor's server.
+// Indeed, the accuracy of our badges are:
+// A(Δt) = 1 - min(# data change over Δt, # requests over Δt)
+//             / (# requests over Δt)
+//       = 1 - max(1, df) / rf
+const freqRatioMax = 1 - minAccuracy
+
+// Request cache size of 5MB (~5000 bytes/image).
+const requestCache = new LruCache(1000)
+
+// Deep error handling for vendor hooks.
+const vendorDomain = domain.create()
+vendorDomain.on('error', err => {
+  log.error('Vendor hook error:', err.stack)
+})
+
+// These query parameters are available to any badge. They are handled by
+// `coalesceBadge`.
+const globalQueryParams = new Set([
+  'label',
+  'style',
+  'link',
+  'logo',
+  'logoColor',
+  'logoPosition',
+  'logoWidth',
+  'link',
+  'colorA',
+  'colorB',
+  'color',
+  'labelColor',
+])
+
+function flattenQueryParams(queryParams) {
+  const union = new Set(globalQueryParams)
+  ;(queryParams || []).forEach(name => {
+    union.add(name)
+  })
+  return Array.from(union).sort()
+}
+
+// handlerOptions can contain:
+// - handler: The service's request handler function
+// - queryParams: An array of the field names of any custom query parameters
+//   the service uses
+// - cacheLength: An optional badge or category-specific cache length
+//   (in number of seconds) to be used in preference to the default
+// - fetchLimitBytes: A limit on the response size we're willing to parse
+//
+// For safety, the service must declare the query parameters it wants to use.
+// Only the declared parameters (and the global parameters) are provided to
+// the service. Consequently, failure to declare a parameter results in the
+// parameter not working at all (which is undesirable, but easy to debug)
+// rather than indeterminate behavior that depends on the cache state
+// (undesirable and hard to debug).
+//
+// Pass just the handler function as shorthand.
+function handleRequest(cacheHeaderConfig, handlerOptions) {
+  if (!cacheHeaderConfig) {
+    throw Error('cacheHeaderConfig is required')
+  }
+
+  if (typeof handlerOptions === 'function') {
+    handlerOptions = { handler: handlerOptions }
+  }
+
+  const allowedKeys = flattenQueryParams(handlerOptions.queryParams)
+  const {
+    cacheLength: serviceDefaultCacheLengthSeconds,
+    fetchLimitBytes,
+  } = handlerOptions
+
+  return (queryParams, match, end, ask) => {
+    const reqTime = new Date()
+
+    // `defaultCacheLengthSeconds` can be overridden by
+    // `serviceDefaultCacheLengthSeconds` (either by category or on a badge-
+    // by-badge basis). Then in turn that can be overridden by
+    // `serviceOverrideCacheLengthSeconds` (which we expect to be used only in
+    // the dynamic badge) but only if `serviceOverrideCacheLengthSeconds` is
+    // longer than `serviceDefaultCacheLengthSeconds` and then the `cacheSeconds`
+    // query param can also override both of those but again only if `cacheSeconds`
+    // is longer.
+    //
+    // When the legacy services have been rewritten, all the code in here
+    // will go away, which should achieve this goal in a simpler way.
+    //
+    // Ref: https://github.com/badges/shields/pull/2755
+    function setCacheHeadersOnResponse(res, serviceOverrideCacheLengthSeconds) {
+      setCacheHeaders({
+        cacheHeaderConfig,
+        serviceDefaultCacheLengthSeconds,
+        serviceOverrideCacheLengthSeconds,
+        queryParams,
+        res,
+      })
+    }
+
+    const filteredQueryParams = {}
+    allowedKeys.forEach(key => {
+      filteredQueryParams[key] = queryParams[key]
+    })
+
+    // Use sindresorhus query-string because it sorts the keys, whereas the
+    // builtin querystring module relies on the iteration order.
+    const stringified = queryString.stringify(filteredQueryParams)
+    const cacheIndex = `${match[0]}?${stringified}`
+
+    // Should we return the data right away?
+    const cached = requestCache.get(cacheIndex)
+    let cachedVersionSent = false
+    if (cached !== undefined) {
+      // A request was made not long ago.
+      const tooSoon = +reqTime - cached.time < cached.interval
+      if (tooSoon || cached.dataChange / cached.reqs <= freqRatioMax) {
+        const svg = makeBadge(cached.data.badgeData)
+        setCacheHeadersOnResponse(
+          ask.res,
+          cached.data.badgeData.cacheLengthSeconds
+        )
+        makeSend(cached.data.format, ask.res, end)(svg)
+        cachedVersionSent = true
+        // We do not wish to call the vendor servers.
+        if (tooSoon) {
+          return
+        }
+      }
+    }
+
+    // In case our vendor servers are unresponsive.
+    let serverUnresponsive = false
+    const serverResponsive = setTimeout(() => {
+      serverUnresponsive = true
+      if (cachedVersionSent) {
+        return
+      }
+      if (requestCache.has(cacheIndex)) {
+        const cached = requestCache.get(cacheIndex)
+        const svg = makeBadge(cached.data.badgeData)
+        setCacheHeadersOnResponse(
+          ask.res,
+          cached.data.badgeData.cacheLengthSeconds
+        )
+        makeSend(cached.data.format, ask.res, end)(svg)
+        return
+      }
+      ask.res.setHeader('Cache-Control', 'no-cache, no-store, must-revalidate')
+      const badgeData = coalesceBadge(
+        filteredQueryParams,
+        { label: 'vendor', message: 'unresponsive' },
+        {}
+      )
+      const svg = makeBadge(badgeData)
+      let extension
+      try {
+        extension = match[0].split('.').pop()
+      } catch (e) {
+        extension = 'svg'
+      }
+      setCacheHeadersOnResponse(ask.res)
+      makeSend(extension, ask.res, end)(svg)
+    }, 25000)
+
+    // Only call vendor servers when last request is older than…
+    let cacheInterval = 5000 // milliseconds
+    function cachingRequest(uri, options, callback) {
+      if (typeof options === 'function' && !callback) {
+        callback = options
+      }
+      if (options && typeof options === 'object') {
+        options.uri = uri
+      } else if (typeof uri === 'string') {
+        options = { uri }
+      } else {
+        options = uri
+      }
+      options.headers = options.headers || {}
+      options.headers['User-Agent'] =
+        options.headers['User-Agent'] || 'Shields.io'
+
+      let bufferLength = 0
+      const r = request(options, (err, res, body) => {
+        if (res != null && res.headers != null) {
+          const cacheControl = res.headers['cache-control']
+          if (cacheControl != null) {
+            const age = cacheControl.match(/max-age=([0-9]+)/)
+            // Would like to get some more test coverage on this before changing it.
+            // eslint-disable-next-line no-self-compare
+            if (age != null && +age[1] === +age[1]) {
+              cacheInterval = +age[1] * 1000
+            }
+          }
+        }
+        callback(err, res, body)
+      })
+      r.on('data', chunk => {
+        bufferLength += chunk.length
+        if (bufferLength > fetchLimitBytes) {
+          r.abort()
+          r.emit(
+            'error',
+            new InvalidResponse({
+              prettyMessage: 'Maximum response size exceeded',
+            })
+          )
+        }
+      })
+    }
+
+    // Wrapper around `cachingRequest` that returns a promise rather than
+    // needing to pass a callback.
+    cachingRequest.asPromise = (uri, options) =>
+      new Promise((resolve, reject) => {
+        cachingRequest(uri, options, (err, res, buffer) => {
+          if (err) {
+            if (err instanceof ShieldsRuntimeError) {
+              reject(err)
+            } else {
+              // Wrap the error in an Inaccessible so it can be identified
+              // by the BaseService handler.
+              reject(new Inaccessible({ underlyingError: err }))
+            }
+          } else {
+            resolve({ res, buffer })
+          }
+        })
+      })
+
+    vendorDomain.run(() => {
+      const result = handlerOptions.handler(
+        filteredQueryParams,
+        match,
+        // eslint-disable-next-line mocha/prefer-arrow-callback
+        function sendBadge(format, badgeData) {
+          if (serverUnresponsive) {
+            return
+          }
+          clearTimeout(serverResponsive)
+          // Check for a change in the data.
+          let dataHasChanged = false
+          if (
+            cached !== undefined &&
+            cached.data.badgeData.text[1] !== badgeData.text[1]
+          ) {
+            dataHasChanged = true
+          }
+          // Add format to badge data.
+          badgeData.format = format
+          // Update information in the cache.
+          const updatedCache = {
+            reqs: cached ? cached.reqs + 1 : 1,
+            dataChange: cached
+              ? cached.dataChange + (dataHasChanged ? 1 : 0)
+              : 1,
+            time: +reqTime,
+            interval: cacheInterval,
+            data: { format, badgeData },
+          }
+          requestCache.set(cacheIndex, updatedCache)
+          if (!cachedVersionSent) {
+            const svg = makeBadge(badgeData)
+            setCacheHeadersOnResponse(ask.res, badgeData.cacheLengthSeconds)
+            makeSend(format, ask.res, end)(svg)
+          }
+        },
+        cachingRequest
+      )
+      if (result && result.catch) {
+        result.catch(err => {
+          throw err
+        })
+      }
+    })
+  }
+}
+
+function clearRequestCache() {
+  requestCache.clear()
+}
+
+module.exports = {
+  handleRequest,
+  clearRequestCache,
+  // Expose for testing.
+  _requestCache: requestCache,
+}

core/base-service/legacy-request-handler.spec.js

@@ -0,0 +1,392 @@
+'use strict'
+
+const { expect } = require('chai')
+// https://github.com/nock/nock/issues/1523
+const got = require('got').extend({ retry: 0 })
+const nock = require('nock')
+const portfinder = require('portfinder')
+const Camp = require('camp')
+const coalesceBadge = require('./coalesce-badge')
+const {
+  handleRequest,
+  clearRequestCache,
+  _requestCache,
+} = require('./legacy-request-handler')
+
+async function performTwoRequests(baseUrl, first, second) {
+  expect((await got(`${baseUrl}${first}`)).statusCode).to.equal(200)
+  expect((await got(`${baseUrl}${second}`)).statusCode).to.equal(200)
+}
+
+function fakeHandler(queryParams, match, sendBadge, request) {
+  const [, someValue, format] = match
+  const badgeData = coalesceBadge(
+    queryParams,
+    {
+      label: 'testing',
+      message: someValue,
+    },
+    {}
+  )
+  sendBadge(format, badgeData)
+}
+
+function createFakeHandlerWithCacheLength(cacheLengthSeconds) {
+  return function fakeHandler(queryParams, match, sendBadge, request) {
+    const [, someValue, format] = match
+    const badgeData = coalesceBadge(
+      queryParams,
+      {
+        label: 'testing',
+        message: someValue,
+      },
+      {},
+      {
+        _cacheLength: cacheLengthSeconds,
+      }
+    )
+    sendBadge(format, badgeData)
+  }
+}
+
+function fakeHandlerWithNetworkIo(queryParams, match, sendBadge, request) {
+  const [, someValue, format] = match
+  request('https://www.google.com/foo/bar', (err, res, buffer) => {
+    let message
+    if (err) {
+      message = err.prettyMessage
+    } else {
+      message = someValue
+    }
+    const badgeData = coalesceBadge(
+      queryParams,
+      {
+        label: 'testing',
+        message,
+        format,
+      },
+      {}
+    )
+    sendBadge(format, badgeData)
+  })
+}
+
+describe('The request handler', function() {
+  let port, baseUrl
+  beforeEach(async function() {
+    port = await portfinder.getPortPromise()
+    baseUrl = `http://127.0.0.1:${port}`
+  })
+
+  let camp
+  beforeEach(function(done) {
+    camp = Camp.start({ port, hostname: '::' })
+    camp.on('listening', () => done())
+  })
+  afterEach(function(done) {
+    clearRequestCache()
+    if (camp) {
+      camp.close(() => done())
+      camp = null
+    }
+  })
+
+  const standardCacheHeaders = { defaultCacheLengthSeconds: 120 }
+
+  describe('the options object calling style', function() {
+    beforeEach(function() {
+      camp.route(
+        /^\/testing\/([^/]+)\.(svg|png|gif|jpg|json)$/,
+        handleRequest(standardCacheHeaders, { handler: fakeHandler })
+      )
+    })
+
+    it('should return the expected response', async function() {
+      const { statusCode, body } = await got(`${baseUrl}/testing/123.json`, {
+        json: true,
+      })
+      expect(statusCode).to.equal(200)
+      expect(body).to.deep.equal({
+        name: 'testing',
+        value: '123',
+        label: 'testing',
+        message: '123',
+        color: 'lightgrey',
+        link: [],
+      })
+    })
+  })
+
+  describe('the function shorthand calling style', function() {
+    beforeEach(function() {
+      camp.route(
+        /^\/testing\/([^/]+)\.(svg|png|gif|jpg|json)$/,
+        handleRequest(standardCacheHeaders, fakeHandler)
+      )
+    })
+
+    it('should return the expected response', async function() {
+      const { statusCode, body } = await got(`${baseUrl}/testing/123.json`, {
+        json: true,
+      })
+      expect(statusCode).to.equal(200)
+      expect(body).to.deep.equal({
+        name: 'testing',
+        value: '123',
+        label: 'testing',
+        message: '123',
+        color: 'lightgrey',
+        link: [],
+      })
+    })
+  })
+
+  describe('the response size limit', function() {
+    beforeEach(function() {
+      camp.route(
+        /^\/testing\/([^/]+)\.(svg|png|gif|jpg|json)$/,
+        handleRequest(standardCacheHeaders, {
+          handler: fakeHandlerWithNetworkIo,
+          fetchLimitBytes: 100,
+        })
+      )
+    })
+
+    it('should not throw an error if the response <= fetchLimitBytes', async function() {
+      nock('https://www.google.com')
+        .get('/foo/bar')
+        .once()
+        .reply(200, 'x'.repeat(100))
+      const { statusCode, body } = await got(`${baseUrl}/testing/123.json`, {
+        json: true,
+      })
+      expect(statusCode).to.equal(200)
+      expect(body).to.deep.equal({
+        name: 'testing',
+        value: '123',
+        label: 'testing',
+        message: '123',
+        color: 'lightgrey',
+        link: [],
+      })
+    })
+
+    it('should throw an error if the response is > fetchLimitBytes', async function() {
+      nock('https://www.google.com')
+        .get('/foo/bar')
+        .once()
+        .reply(200, 'x'.repeat(101))
+      const { statusCode, body } = await got(`${baseUrl}/testing/123.json`, {
+        json: true,
+      })
+      expect(statusCode).to.equal(200)
+      expect(body).to.deep.equal({
+        name: 'testing',
+        value: 'Maximum response size exceeded',
+        label: 'testing',
+        message: 'Maximum response size exceeded',
+        color: 'lightgrey',
+        link: [],
+      })
+    })
+
+    afterEach(function() {
+      nock.cleanAll()
+    })
+  })
+
+  describe('caching', function() {
+    describe('standard query parameters', function() {
+      let handlerCallCount
+      beforeEach(function() {
+        handlerCallCount = 0
+      })
+
+      function register({ cacheHeaderConfig }) {
+        camp.route(
+          /^\/testing\/([^/]+)\.(svg|png|gif|jpg|json)$/,
+          handleRequest(
+            cacheHeaderConfig,
+            (queryParams, match, sendBadge, request) => {
+              ++handlerCallCount
+              fakeHandler(queryParams, match, sendBadge, request)
+            }
+          )
+        )
+      }
+
+      context('With standard cache settings', function() {
+        beforeEach(function() {
+          register({ cacheHeaderConfig: standardCacheHeaders })
+        })
+
+        it('should cache identical requests', async function() {
+          await performTwoRequests(
+            baseUrl,
+            '/testing/123.svg',
+            '/testing/123.svg'
+          )
+          expect(handlerCallCount).to.equal(1)
+        })
+
+        it('should differentiate known query parameters', async function() {
+          await performTwoRequests(
+            baseUrl,
+            '/testing/123.svg?label=foo',
+            '/testing/123.svg?label=bar'
+          )
+          expect(handlerCallCount).to.equal(2)
+        })
+
+        it('should ignore unknown query parameters', async function() {
+          await performTwoRequests(
+            baseUrl,
+            '/testing/123.svg?foo=1',
+            '/testing/123.svg?foo=2'
+          )
+          expect(handlerCallCount).to.equal(1)
+        })
+      })
+
+      it('should set the expires header to current time + defaultCacheLengthSeconds', async function() {
+        register({ cacheHeaderConfig: { defaultCacheLengthSeconds: 900 } })
+        const { headers } = await got(`${baseUrl}/testing/123.json`)
+        const expectedExpiry = new Date(
+          +new Date(headers.date) + 900000
+        ).toGMTString()
+        expect(headers.expires).to.equal(expectedExpiry)
+        expect(headers['cache-control']).to.equal('max-age=900')
+      })
+
+      it('should set the expected cache headers on cached responses', async function() {
+        register({ cacheHeaderConfig: { defaultCacheLengthSeconds: 900 } })
+
+        // Make first request.
+        await got(`${baseUrl}/testing/123.json`)
+
+        const { headers } = await got(`${baseUrl}/testing/123.json`)
+        const expectedExpiry = new Date(
+          +new Date(headers.date) + 900000
+        ).toGMTString()
+        expect(headers.expires).to.equal(expectedExpiry)
+        expect(headers['cache-control']).to.equal('max-age=900')
+      })
+
+      it('should let live service data override the default cache headers with longer value', async function() {
+        camp.route(
+          /^\/testing\/([^/]+)\.(svg|png|gif|jpg|json)$/,
+          handleRequest(
+            { defaultCacheLengthSeconds: 300 },
+            (queryParams, match, sendBadge, request) => {
+              ++handlerCallCount
+              createFakeHandlerWithCacheLength(400)(
+                queryParams,
+                match,
+                sendBadge,
+                request
+              )
+            }
+          )
+        )
+
+        const { headers } = await got(`${baseUrl}/testing/123.json`)
+        expect(headers['cache-control']).to.equal('max-age=400')
+      })
+
+      it('should not let live service data override the default cache headers with shorter value', async function() {
+        camp.route(
+          /^\/testing\/([^/]+)\.(svg|png|gif|jpg|json)$/,
+          handleRequest(
+            { defaultCacheLengthSeconds: 300 },
+            (queryParams, match, sendBadge, request) => {
+              ++handlerCallCount
+              createFakeHandlerWithCacheLength(200)(
+                queryParams,
+                match,
+                sendBadge,
+                request
+              )
+            }
+          )
+        )
+
+        const { headers } = await got(`${baseUrl}/testing/123.json`)
+        expect(headers['cache-control']).to.equal('max-age=300')
+      })
+
+      it('should set the expires header to current time + cacheSeconds', async function() {
+        register({ cacheHeaderConfig: { defaultCacheLengthSeconds: 0 } })
+        const { headers } = await got(
+          `${baseUrl}/testing/123.json?cacheSeconds=3600`
+        )
+        const expectedExpiry = new Date(
+          +new Date(headers.date) + 3600000
+        ).toGMTString()
+        expect(headers.expires).to.equal(expectedExpiry)
+        expect(headers['cache-control']).to.equal('max-age=3600')
+      })
+
+      it('should ignore cacheSeconds when shorter than defaultCacheLengthSeconds', async function() {
+        register({ cacheHeaderConfig: { defaultCacheLengthSeconds: 600 } })
+        const { headers } = await got(
+          `${baseUrl}/testing/123.json?cacheSeconds=300`
+        )
+        const expectedExpiry = new Date(
+          +new Date(headers.date) + 600000
+        ).toGMTString()
+        expect(headers.expires).to.equal(expectedExpiry)
+        expect(headers['cache-control']).to.equal('max-age=600')
+      })
+
+      it('should set Cache-Control: no-cache, no-store, must-revalidate if cache seconds is 0', async function() {
+        register({ cacheHeaderConfig: { defaultCacheLengthSeconds: 0 } })
+        const { headers } = await got(`${baseUrl}/testing/123.json`)
+        expect(headers.expires).to.equal(headers.date)
+        expect(headers['cache-control']).to.equal(
+          'no-cache, no-store, must-revalidate'
+        )
+      })
+
+      describe('the cache key', function() {
+        beforeEach(function() {
+          register({ cacheHeaderConfig: standardCacheHeaders })
+        })
+        const expectedCacheKey = '/testing/123.json?color=123&label=foo'
+        it('should match expected and use canonical order - 1', async function() {
+          await got(`${baseUrl}/testing/123.json?color=123&label=foo`)
+          expect(_requestCache.cache).to.have.keys(expectedCacheKey)
+        })
+        it('should match expected and use canonical order - 2', async function() {
+          await got(`${baseUrl}/testing/123.json?label=foo&color=123`)
+          expect(_requestCache.cache).to.have.keys(expectedCacheKey)
+        })
+      })
+    })
+
+    describe('custom query parameters', function() {
+      let handlerCallCount
+      beforeEach(function() {
+        handlerCallCount = 0
+        camp.route(
+          /^\/testing\/([^/]+)\.(svg|png|gif|jpg|json)$/,
+          handleRequest(standardCacheHeaders, {
+            queryParams: ['foo'],
+            handler: (queryParams, match, sendBadge, request) => {
+              ++handlerCallCount
+              fakeHandler(queryParams, match, sendBadge, request)
+            },
+          })
+        )
+      })
+
+      it('should differentiate them', async function() {
+        await performTwoRequests(
+          baseUrl,
+          '/testing/123.svg?foo=1',
+          '/testing/123.svg?foo=2'
+        )
+        expect(handlerCallCount).to.equal(2)
+      })
+    })
+  })
+})

core/base-service/legacy-result-sender.js

@@ -0,0 +1,61 @@
+'use strict'
+
+const fs = require('fs')
+const path = require('path')
+const stream = require('stream')
+const svg2img = require('../../gh-badges/lib/svg-to-img')
+const log = require('../server/log')
+
+const internalError = fs.readFileSync(
+  path.resolve(__dirname, '..', 'server', 'error-pages', '500.html'),
+  'utf-8'
+)
+
+function streamFromString(str) {
+  const newStream = new stream.Readable()
+  newStream._read = () => {
+    newStream.push(str)
+    newStream.push(null)
+  }
+  return newStream
+}
+
+function sendSVG(res, askres, end) {
+  askres.setHeader('Content-Type', 'image/svg+xml;charset=utf-8')
+  end(null, { template: streamFromString(res) })
+}
+
+function sendOther(format, res, askres, end) {
+  askres.setHeader('Content-Type', `image/${format}`)
+  svg2img(res, format)
+    // This interacts with callback code and can't use async/await.
+    // eslint-disable-next-line promise/prefer-await-to-then
+    .then(data => {
+      end(null, { template: streamFromString(data) })
+    })
+    .catch(err => {
+      // This emits status code 200, though 500 would be preferable.
+      log.error('svg2img error', err)
+      end(internalError)
+    })
+}
+
+function sendJSON(res, askres, end) {
+  askres.setHeader('Content-Type', 'application/json')
+  askres.setHeader('Access-Control-Allow-Origin', '*')
+  end(null, { template: streamFromString(res) })
+}
+
+function makeSend(format, askres, end) {
+  if (format === 'svg') {
+    return res => sendSVG(res, askres, end)
+  } else if (format === 'json') {
+    return res => sendJSON(res, askres, end)
+  } else {
+    return res => sendOther(format, res, askres, end)
+  }
+}
+
+module.exports = {
+  makeSend,
+}

core/base-service/loader-test-fixtures/empty-array.fixture.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = []

core/base-service/loader-test-fixtures/empty-no-export.fixture.js

@@ -0,0 +1,4 @@
+/* eslint-disable */
+'use strict'
+
+class BadService {}

core/base-service/loader-test-fixtures/empty-object.fixture.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = {}

core/base-service/loader-test-fixtures/empty-undefined.fixture.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = undefined

core/base-service/loader-test-fixtures/invalid-mixed.fixture.js

@@ -0,0 +1,9 @@
+'use strict'
+
+const BaseJsonService = require('../base-json')
+
+class BadBaseService {}
+class GoodService extends BaseJsonService {}
+class BadService extends BadBaseService {}
+
+module.exports = [GoodService, BadService]

core/base-service/loader-test-fixtures/invalid-no-base.fixture.js

@@ -0,0 +1,5 @@
+'use strict'
+
+class BadService {}
+
+module.exports = BadService

core/base-service/loader-test-fixtures/invalid-wrong-base.fixture.js

@@ -0,0 +1,6 @@
+'use strict'
+
+class BadBaseService {}
+class BadService extends BadBaseService {}
+
+module.exports = BadService

core/base-service/loader-test-fixtures/valid-array.fixture.js

@@ -0,0 +1,30 @@
+'use strict'
+
+const BaseJsonService = require('../base-json')
+
+class GoodServiceOne extends BaseJsonService {
+  static get category() {
+    return 'build'
+  }
+
+  static get route() {
+    return {
+      base: 'good',
+      pattern: 'one',
+    }
+  }
+}
+class GoodServiceTwo extends BaseJsonService {
+  static get category() {
+    return 'build'
+  }
+
+  static get route() {
+    return {
+      base: 'good',
+      pattern: 'two',
+    }
+  }
+}
+
+module.exports = [GoodServiceOne, GoodServiceTwo]

core/base-service/loader-test-fixtures/valid-class.fixture.js

@@ -0,0 +1,18 @@
+'use strict'
+
+const BaseJsonService = require('../base-json')
+
+class GoodService extends BaseJsonService {
+  static get category() {
+    return 'build'
+  }
+
+  static get route() {
+    return {
+      base: 'it/is',
+      pattern: 'good',
+    }
+  }
+}
+
+module.exports = GoodService

core/base-service/loader-test-fixtures/valid-object.fixture.js

@@ -0,0 +1,30 @@
+'use strict'
+
+const BaseJsonService = require('../base-json')
+
+class GoodServiceOne extends BaseJsonService {
+  static get category() {
+    return 'build'
+  }
+
+  static get route() {
+    return {
+      base: 'good',
+      pattern: 'one',
+    }
+  }
+}
+class GoodServiceTwo extends BaseJsonService {
+  static get category() {
+    return 'build'
+  }
+
+  static get route() {
+    return {
+      base: 'good',
+      pattern: 'two',
+    }
+  }
+}
+
+module.exports = { GoodServiceOne, GoodServiceTwo }

core/base-service/loader.js

@@ -0,0 +1,115 @@
+'use strict'
+
+const path = require('path')
+const glob = require('glob')
+const countBy = require('lodash.countby')
+const categories = require('../../services/categories')
+const BaseService = require('./base')
+const { assertValidServiceDefinitionExport } = require('./service-definitions')
+
+const serviceDir = path.join(__dirname, '..', '..', 'services')
+
+class InvalidService extends Error {
+  constructor(message) {
+    super(message)
+    this.name = 'InvalidService'
+  }
+}
+
+function loadServiceClasses(servicePaths) {
+  if (!servicePaths) {
+    servicePaths = glob.sync(path.join(serviceDir, '**', '*.service.js'))
+  }
+
+  let serviceClasses = []
+  servicePaths.forEach(servicePath => {
+    const module = require(servicePath)
+
+    const theseServiceClasses = []
+    if (
+      !module ||
+      (module.constructor === Array && module.length === 0) ||
+      (module.constructor === Object && Object.keys(module).length === 0)
+    ) {
+      throw new InvalidService(
+        `Expected ${servicePath} to export a service or a collection of services`
+      )
+    } else if (module.prototype instanceof BaseService) {
+      theseServiceClasses.push(module)
+    } else if (module.constructor === Array || module.constructor === Object) {
+      for (const key in module) {
+        const serviceClass = module[key]
+        if (serviceClass.prototype instanceof BaseService) {
+          theseServiceClasses.push(serviceClass)
+        } else {
+          throw new InvalidService(
+            `Expected ${servicePath} to export a service or a collection of services; one of them was ${serviceClass}`
+          )
+        }
+      }
+    } else {
+      throw new InvalidService(
+        `Expected ${servicePath} to export a service or a collection of services; got ${module}`
+      )
+    }
+
+    // Decorate each service class with the directory that contains it.
+    theseServiceClasses.forEach(serviceClass => {
+      serviceClass.serviceFamily = servicePath
+        .replace(serviceDir, '')
+        .split(path.sep)[1]
+    })
+
+    serviceClasses = serviceClasses.concat(theseServiceClasses)
+  })
+
+  serviceClasses.forEach(ServiceClass => ServiceClass.validateDefinition())
+
+  return serviceClasses
+}
+
+function assertNamesUnique(names, { message }) {
+  const duplicates = {}
+  Object.entries(countBy(names))
+    .filter(([name, count]) => count > 1)
+    .forEach(([name, count]) => {
+      duplicates[name] = count
+    })
+  if (Object.keys(duplicates).length) {
+    throw new Error(`${message}: ${JSON.stringify(duplicates, undefined, 2)}`)
+  }
+}
+
+function checkNames() {
+  const services = loadServiceClasses()
+  assertNamesUnique(services.map(({ name }) => name), {
+    message: 'Duplicate service names found',
+  })
+}
+
+function collectDefinitions() {
+  const services = loadServiceClasses()
+    // flatMap.
+    .map(ServiceClass => ServiceClass.getDefinition())
+    .reduce((accum, these) => accum.concat(these), [])
+
+  const result = { schemaVersion: '0', categories, services }
+
+  assertValidServiceDefinitionExport(result)
+
+  return result
+}
+
+function loadTesters() {
+  return glob
+    .sync(path.join(serviceDir, '**', '*.tester.js'))
+    .map(path => require(path))
+}
+
+module.exports = {
+  InvalidService,
+  loadServiceClasses,
+  checkNames,
+  collectDefinitions,
+  loadTesters,
+}

core/base-service/loader.spec.js

@@ -0,0 +1,59 @@
+'use strict'
+
+const { expect } = require('chai')
+const { loadServiceClasses, InvalidService } = require('./loader')
+
+describe('loadServiceClasses function', function() {
+  it('throws if module exports empty', function() {
+    expect(() =>
+      loadServiceClasses(['./loader-test-fixtures/empty-undefined.fixture.js'])
+    ).to.throw(InvalidService)
+    expect(() =>
+      loadServiceClasses(['./loader-test-fixtures/empty-array.fixture.js'])
+    ).to.throw()
+    expect(() =>
+      loadServiceClasses(['./loader-test-fixtures/empty-object.fixture.js'])
+    ).to.throw(InvalidService)
+    expect(() =>
+      loadServiceClasses(['./loader-test-fixtures/empty-no-export.fixture.js'])
+    ).to.throw(InvalidService)
+    expect(() =>
+      loadServiceClasses([
+        './loader-test-fixtures/valid-array.fixture.js',
+        './loader-test-fixtures/valid-class.fixture.js',
+        './loader-test-fixtures/empty-array.fixture.js',
+      ])
+    ).to.throw(InvalidService)
+  })
+
+  it('throws if module exports invalid', function() {
+    expect(() =>
+      loadServiceClasses(['./loader-test-fixtures/invalid-no-base.fixture.js'])
+    ).to.throw(InvalidService)
+    expect(() =>
+      loadServiceClasses([
+        './loader-test-fixtures/invalid-wrong-base.fixture.js',
+      ])
+    ).to.throw(InvalidService)
+    expect(() =>
+      loadServiceClasses(['./loader-test-fixtures/invalid-mixed.fixture.js'])
+    ).to.throw(InvalidService)
+    expect(() =>
+      loadServiceClasses([
+        './loader-test-fixtures/valid-array.fixture.js',
+        './loader-test-fixtures/valid-class.fixture.js',
+        './loader-test-fixtures/invalid-no-base.fixture.js',
+      ])
+    ).to.throw(InvalidService)
+  })
+
+  it('registers services if module exports valid service classes', function() {
+    expect(
+      loadServiceClasses([
+        './loader-test-fixtures/valid-array.fixture.js',
+        './loader-test-fixtures/valid-object.fixture.js',
+        './loader-test-fixtures/valid-class.fixture.js',
+      ])
+    ).to.have.length(5)
+  })
+})

core/base-service/redirector.js

@@ -0,0 +1,123 @@
+'use strict'
+
+const camelcase = require('camelcase')
+const emojic = require('emojic')
+const Joi = require('joi')
+const queryString = require('query-string')
+const BaseService = require('./base')
+const {
+  serverHasBeenUpSinceResourceCached,
+  setCacheHeadersForStaticResource,
+} = require('./cache-headers')
+const { isValidCategory } = require('./categories')
+const { isValidRoute, prepareRoute, namedParamsForMatch } = require('./route')
+const trace = require('./trace')
+
+const attrSchema = Joi.object({
+  name: Joi.string().min(3),
+  category: isValidCategory,
+  route: isValidRoute,
+  transformPath: Joi.func()
+    .maxArity(1)
+    .required()
+    .error(
+      () =>
+        '"transformPath" must be a function that transforms named params to a new path'
+    ),
+  transformQueryParams: Joi.func().arity(1),
+  dateAdded: Joi.date().required(),
+  overrideTransformedQueryParams: Joi.bool().optional(),
+}).required()
+
+module.exports = function redirector(attrs) {
+  const {
+    name,
+    category,
+    route,
+    transformPath,
+    transformQueryParams,
+    overrideTransformedQueryParams,
+  } = Joi.attempt(attrs, attrSchema, `Redirector for ${attrs.route.base}`)
+
+  return class Redirector extends BaseService {
+    static get name() {
+      if (name) {
+        return name
+      } else {
+        return `${camelcase(route.base.replace(/\//g, '_'), {
+          pascalCase: true,
+        })}Redirect`
+      }
+    }
+
+    static get category() {
+      return category
+    }
+
+    static get isDeprecated() {
+      return true
+    }
+
+    static get route() {
+      return route
+    }
+
+    static register({ camp, requestCounter }) {
+      const { regex, captureNames } = prepareRoute(this.route)
+
+      const serviceRequestCounter = this._createServiceRequestCounter({
+        requestCounter,
+      })
+
+      camp.route(regex, async (queryParams, match, end, ask) => {
+        if (serverHasBeenUpSinceResourceCached(ask.req)) {
+          // Send Not Modified.
+          ask.res.statusCode = 304
+          ask.res.end()
+          return
+        }
+
+        const namedParams = namedParamsForMatch(captureNames, match, this)
+        trace.logTrace(
+          'inbound',
+          emojic.arrowHeadingUp,
+          'Redirector',
+          route.base
+        )
+        trace.logTrace('inbound', emojic.ticket, 'Named params', namedParams)
+        trace.logTrace('inbound', emojic.crayon, 'Query params', queryParams)
+
+        const targetPath = transformPath(namedParams)
+        trace.logTrace('validate', emojic.dart, 'Target', targetPath)
+
+        let urlSuffix = ask.uri.search || ''
+
+        if (transformQueryParams) {
+          const specifiedParams = queryString.parse(urlSuffix)
+          const transformedParams = transformQueryParams(namedParams)
+          const redirectParams = overrideTransformedQueryParams
+            ? Object.assign(transformedParams, specifiedParams)
+            : Object.assign(specifiedParams, transformedParams)
+          const outQueryString = queryString.stringify(redirectParams)
+          urlSuffix = `?${outQueryString}`
+        }
+
+        // The final capture group is the extension.
+        const format = match.slice(-1)[0]
+        const redirectUrl = `${targetPath}.${format}${urlSuffix}`
+        trace.logTrace('outbound', emojic.shield, 'Redirect URL', redirectUrl)
+
+        ask.res.statusCode = 301
+        ask.res.setHeader('Location', redirectUrl)
+
+        // To avoid caching mistakes for a long time, and to make this simpler
+        // to reason about, use the same cache semantics as the static badge.
+        setCacheHeadersForStaticResource(ask.res)
+
+        ask.res.end()
+
+        serviceRequestCounter.inc()
+      })
+    }
+  }
+}

core/base-service/redirector.spec.js

@@ -0,0 +1,207 @@
+'use strict'
+
+const Camp = require('camp')
+const got = require('got')
+const portfinder = require('portfinder')
+const { expect } = require('chai')
+const redirector = require('./redirector')
+
+describe('Redirector', function() {
+  const route = {
+    base: 'very/old/service',
+    pattern: ':namedParamA',
+  }
+  const category = 'analysis'
+  const transformPath = () => {}
+  const dateAdded = new Date()
+  const attrs = { category, route, transformPath, dateAdded }
+
+  it('returns true on isDeprecated', function() {
+    expect(redirector(attrs).isDeprecated).to.be.true
+  })
+
+  it('has the expected name', function() {
+    expect(redirector(attrs).name).to.equal('VeryOldServiceRedirect')
+  })
+
+  it('overrides the name', function() {
+    expect(
+      redirector({
+        ...attrs,
+        name: 'ShinyRedirect',
+      }).name
+    ).to.equal('ShinyRedirect')
+  })
+
+  it('sets specified route', function() {
+    expect(redirector(attrs).route).to.deep.equal(route)
+  })
+
+  it('sets specified category', function() {
+    expect(redirector(attrs).category).to.equal(category)
+  })
+
+  it('throws the expected error when dateAdded is missing', function() {
+    expect(() =>
+      redirector({ route, category, transformPath }).validateDefinition()
+    ).to.throw('"dateAdded" is required')
+  })
+
+  describe('ScoutCamp integration', function() {
+    let port, baseUrl
+    beforeEach(async function() {
+      port = await portfinder.getPortPromise()
+      baseUrl = `http://127.0.0.1:${port}`
+    })
+
+    let camp
+    beforeEach(async function() {
+      camp = Camp.start({ port, hostname: '::' })
+      await new Promise(resolve => camp.on('listening', () => resolve()))
+    })
+    afterEach(async function() {
+      if (camp) {
+        await new Promise(resolve => camp.close(resolve))
+        camp = undefined
+      }
+    })
+
+    const transformPath = ({ namedParamA }) => `/new/service/${namedParamA}`
+
+    beforeEach(function() {
+      const ServiceClass = redirector({
+        category,
+        route,
+        transformPath,
+        dateAdded,
+      })
+      ServiceClass.register({ camp }, {})
+    })
+
+    it('should redirect as configured', async function() {
+      const { statusCode, headers } = await got(
+        `${baseUrl}/very/old/service/hello-world.svg`,
+        {
+          followRedirect: false,
+        }
+      )
+
+      expect(statusCode).to.equal(301)
+      expect(headers.location).to.equal('/new/service/hello-world.svg')
+    })
+
+    it('should preserve the extension', async function() {
+      const { statusCode, headers } = await got(
+        `${baseUrl}/very/old/service/hello-world.png`,
+        {
+          followRedirect: false,
+        }
+      )
+
+      expect(statusCode).to.equal(301)
+      expect(headers.location).to.equal('/new/service/hello-world.png')
+    })
+
+    it('should forward the query params', async function() {
+      const { statusCode, headers } = await got(
+        `${baseUrl}/very/old/service/hello-world.svg?color=123&style=flat-square`,
+        {
+          followRedirect: false,
+        }
+      )
+
+      expect(statusCode).to.equal(301)
+      expect(headers.location).to.equal(
+        '/new/service/hello-world.svg?color=123&style=flat-square'
+      )
+    })
+
+    describe('transformQueryParams', function() {
+      const route = {
+        base: 'another/old/service',
+        pattern: 'token/:token/:namedParamA',
+      }
+      const transformQueryParams = ({ token }) => ({ token })
+
+      beforeEach(function() {
+        const ServiceClass = redirector({
+          category,
+          route,
+          transformPath,
+          transformQueryParams,
+          dateAdded,
+        })
+        ServiceClass.register({ camp }, {})
+      })
+
+      it('should forward the transformed query params', async function() {
+        const { statusCode, headers } = await got(
+          `${baseUrl}/another/old/service/token/abc123/hello-world.svg`,
+          {
+            followRedirect: false,
+          }
+        )
+
+        expect(statusCode).to.equal(301)
+        expect(headers.location).to.equal(
+          '/new/service/hello-world.svg?token=abc123'
+        )
+      })
+
+      it('should forward the specified and transformed query params', async function() {
+        const { statusCode, headers } = await got(
+          `${baseUrl}/another/old/service/token/abc123/hello-world.svg?color=123&style=flat-square`,
+          {
+            followRedirect: false,
+          }
+        )
+
+        expect(statusCode).to.equal(301)
+        expect(headers.location).to.equal(
+          '/new/service/hello-world.svg?color=123&style=flat-square&token=abc123'
+        )
+      })
+
+      it('should use transformed query params on param conflicts by default', async function() {
+        const { statusCode, headers } = await got(
+          `${baseUrl}/another/old/service/token/abc123/hello-world.svg?color=123&style=flat-square&token=def456`,
+          {
+            followRedirect: false,
+          }
+        )
+
+        expect(statusCode).to.equal(301)
+        expect(headers.location).to.equal(
+          '/new/service/hello-world.svg?color=123&style=flat-square&token=abc123'
+        )
+      })
+
+      it('should use specified query params on param conflicts when configured', async function() {
+        const route = {
+          base: 'override/service',
+          pattern: 'token/:token/:namedParamA',
+        }
+        const ServiceClass = redirector({
+          category,
+          route,
+          transformPath,
+          transformQueryParams,
+          overrideTransformedQueryParams: true,
+          dateAdded,
+        })
+        ServiceClass.register({ camp }, {})
+        const { statusCode, headers } = await got(
+          `${baseUrl}/override/service/token/abc123/hello-world.svg?style=flat-square&token=def456`,
+          {
+            followRedirect: false,
+          }
+        )
+
+        expect(statusCode).to.equal(301)
+        expect(headers.location).to.equal(
+          '/new/service/hello-world.svg?style=flat-square&token=def456'
+        )
+      })
+    })
+  })
+})

core/base-service/route.js

@@ -0,0 +1,88 @@
+'use strict'
+
+const Joi = require('joi')
+const pathToRegexp = require('path-to-regexp')
+
+function makeFullUrl(base, partialUrl) {
+  return `/${[base, partialUrl].filter(Boolean).join('/')}`
+}
+
+const isValidRoute = Joi.object({
+  base: Joi.string()
+    .allow('')
+    .required(),
+  pattern: Joi.string().allow(''),
+  format: Joi.string(),
+  capture: Joi.alternatives().when('format', {
+    is: Joi.string().required(),
+    then: Joi.array().items(Joi.string().required()),
+  }),
+  queryParamSchema: Joi.object().schema(),
+})
+  .xor('pattern', 'format')
+  .required()
+
+function assertValidRoute(route, message = undefined) {
+  Joi.assert(route, isValidRoute, message)
+}
+
+function prepareRoute({ base, pattern, format, capture }) {
+  let regex, captureNames
+  if (pattern === undefined) {
+    regex = new RegExp(
+      `^${makeFullUrl(base, format)}\\.(svg|png|gif|jpg|json)$`
+    )
+    captureNames = capture || []
+  } else {
+    const fullPattern = `${makeFullUrl(
+      base,
+      pattern
+    )}.:ext(svg|png|gif|jpg|json)`
+    const keys = []
+    regex = pathToRegexp(fullPattern, keys, {
+      strict: true,
+      sensitive: true,
+    })
+    captureNames = keys.map(item => item.name).slice(0, -1)
+  }
+  return { regex, captureNames }
+}
+
+function namedParamsForMatch(captureNames = [], match, ServiceClass) {
+  // Assume the last match is the format, and drop match[0], which is the
+  // entire match.
+  const captures = match.slice(1, -1)
+
+  if (captureNames.length !== captures.length) {
+    throw new Error(
+      `Service ${
+        ServiceClass.name
+      } declares incorrect number of named params ` +
+        `(expected ${captures.length}, got ${captureNames.length})`
+    )
+  }
+
+  const result = {}
+  captureNames.forEach((name, index) => {
+    result[name] = captures[index]
+  })
+  return result
+}
+
+function getQueryParamNames({ queryParamSchema }) {
+  if (queryParamSchema) {
+    const { children, renames = [] } = Joi.describe(queryParamSchema)
+    return Object.keys(children).concat(renames.map(({ from }) => from))
+  } else {
+    return []
+  }
+}
+
+module.exports = {
+  makeFullUrl,
+  isValidRoute,
+  assertValidRoute,
+  prepareRoute,
+  namedParamsForMatch,
+  getQueryParamNames,
+}

core/base-service/route.spec.js

@@ -0,0 +1,124 @@
+'use strict'
+
+const { expect } = require('chai')
+const Joi = require('joi')
+const { test, given, forCases } = require('sazerac')
+const {
+  prepareRoute,
+  namedParamsForMatch,
+  getQueryParamNames,
+} = require('./route')
+
+describe('Route helpers', function() {
+  context('A `pattern` with a named param is declared', function() {
+    const { regex, captureNames } = prepareRoute({
+      base: 'foo',
+      pattern: ':namedParamA',
+      queryParamSchema: Joi.object({ queryParamA: Joi.string() }).required(),
+    })
+
+    const regexExec = str => regex.exec(str)
+    test(regexExec, () => {
+      forCases([
+        given('/foo/bar.bar.bar.zip'),
+        given('/foo/bar/bar.svg'),
+        // This is a valid example with the wrong extension separator, to
+        // test that we only accept a `.`.
+        given('/foo/bar.bar.bar_svg'),
+      ]).expect(null)
+    })
+
+    const namedParams = str =>
+      namedParamsForMatch(captureNames, regex.exec(str))
+    test(namedParams, () => {
+      forCases([
+        given('/foo/bar.bar.bar.svg'),
+        given('/foo/bar.bar.bar.png'),
+        given('/foo/bar.bar.bar.gif'),
+        given('/foo/bar.bar.bar.jpg'),
+        given('/foo/bar.bar.bar.json'),
+      ]).expect({ namedParamA: 'bar.bar.bar' })
+    })
+  })
+
+  context('A `format` with a named param is declared', function() {
+    const { regex, captureNames } = prepareRoute({
+      base: 'foo',
+      format: '([^/]+)',
+      capture: ['namedParamA'],
+    })
+
+    const regexExec = str => regex.exec(str)
+    test(regexExec, () => {
+      forCases([
+        given('/foo/bar.bar.bar.zip'),
+        given('/foo/bar/bar.svg'),
+        // This is a valid example with the wrong extension separator, to
+        // test that we only accept a `.`.
+        given('/foo/bar.bar.bar_svg'),
+      ]).expect(null)
+    })
+
+    const namedParams = str =>
+      namedParamsForMatch(captureNames, regex.exec(str))
+    test(namedParams, () => {
+      forCases([
+        given('/foo/bar.bar.bar.svg'),
+        given('/foo/bar.bar.bar.png'),
+        given('/foo/bar.bar.bar.gif'),
+        given('/foo/bar.bar.bar.jpg'),
+        given('/foo/bar.bar.bar.json'),
+      ]).expect({ namedParamA: 'bar.bar.bar' })
+    })
+  })
+
+  context('No named params are declared', function() {
+    const { regex, captureNames } = prepareRoute({
+      base: 'foo',
+      format: '(?:[^/]+)',
+    })
+
+    const namedParams = str =>
+      namedParamsForMatch(captureNames, regex.exec(str))
+    test(namedParams, () => {
+      forCases([
+        given('/foo/bar.bar.bar.svg'),
+        given('/foo/bar.bar.bar.png'),
+        given('/foo/bar.bar.bar.gif'),
+        given('/foo/bar.bar.bar.jpg'),
+        given('/foo/bar.bar.bar.json'),
+      ]).expect({})
+    })
+  })
+
+  context('The wrong number of params are declared', function() {
+    const { regex, captureNames } = prepareRoute({
+      base: 'foo',
+      format: '([^/]+)/([^/]+)',
+      capture: ['namedParamA'],
+    })
+
+    expect(() =>
+      namedParamsForMatch(captureNames, regex.exec('/foo/bar/baz.svg'), {
+        name: 'MyService',
+      })
+    ).to.throw(
+      'Service MyService declares incorrect number of named params (expected 2, got 1)'
+    )
+  })
+
+  it('getQueryParamNames', function() {
+    expect(
+      getQueryParamNames({
+        queryParamSchema: Joi.object({ foo: Joi.string() }).required(),
+      })
+    ).to.deep.equal(['foo'])
+    expect(
+      getQueryParamNames({
+        queryParamSchema: Joi.object({ foo: Joi.string() })
+          .rename('bar', 'foo', { ignoreUndefined: true, override: true })
+          .required(),
+      })
+    ).to.deep.equal(['foo', 'bar'])
+  })
+})

core/base-service/service-definitions.js

@@ -0,0 +1,86 @@
+'use strict'
+
+const Joi = require('joi')
+
+// This should be kept in sync with the schema in
+// `frontend/lib/service-definitions/service-definition-prop-types.js`.
+
+const arrayOfStrings = Joi.array()
+  .items(Joi.string())
+  .allow([])
+  .required()
+
+const objectOfKeyValues = Joi.object()
+  .pattern(/./, Joi.string().allow(null))
+  .required()
+
+const serviceDefinition = Joi.object({
+  category: Joi.string().required(),
+  name: Joi.string().required(),
+  isDeprecated: Joi.boolean().required(),
+  route: Joi.alternatives().try(
+    Joi.object({
+      pattern: Joi.string().required(),
+      queryParams: arrayOfStrings,
+    }),
+    Joi.object({
+      format: Joi.string().required(),
+      queryParams: arrayOfStrings,
+    })
+  ),
+  examples: Joi.array()
+    .items(
+      Joi.object({
+        title: Joi.string().required(),
+        example: Joi.object({
+          pattern: Joi.string(),
+          namedParams: objectOfKeyValues,
+          queryParams: objectOfKeyValues,
+        }).required(),
+        preview: Joi.object({
+          label: Joi.string(),
+          message: Joi.string()
+            .allow('')
+            .required(),
+          color: Joi.string().required(),
+          style: Joi.string(),
+          namedLogo: Joi.string(),
+        }).required(),
+        keywords: arrayOfStrings,
+        documentation: Joi.object({
+          __html: Joi.string().required(), // Valid HTML.
+        }),
+      })
+    )
+    .default([]),
+}).required()
+
+function assertValidServiceDefinition(example, message = undefined) {
+  Joi.assert(example, serviceDefinition, message)
+}
+
+const serviceDefinitionExport = Joi.object({
+  schemaVersion: Joi.equal('0').required(),
+  categories: Joi.array()
+    .items(
+      Joi.object({
+        id: Joi.string().required(),
+        name: Joi.string().required(),
+      })
+    )
+    .required(),
+  services: Joi.array()
+    .items(serviceDefinition)
+    .required(),
+}).required()
+
+function assertValidServiceDefinitionExport(examples, message = undefined) {
+  Joi.assert(examples, serviceDefinitionExport, message)
+}
+
+module.exports = {
+  serviceDefinition,
+  assertValidServiceDefinition,
+  serviceDefinitionExport,
+  assertValidServiceDefinitionExport,
+}

core/base-service/to-array.js

@@ -0,0 +1,11 @@
+'use strict'
+
+module.exports = function toArray(val) {
+  if (val === undefined) {
+    return []
+  } else if (Object(val) instanceof Array) {
+    return val
+  } else {
+    return [val]
+  }
+}

core/base-service/trace.js

@@ -0,0 +1,42 @@
+'use strict'
+
+const chalk = require('chalk')
+const config = require('config').util.toObject()
+
+// Config is loaded globally but it would be better to inject it. To do that,
+// there needs to be one instance of the service created at registration time,
+// which gets the config injected into it, instead of one instance per request.
+// That way most of the current static methods could become instance methods,
+// thereby gaining access to the injected config.
+const {
+  services: { trace: enableTraceLogging },
+} = config.public
+
+function _formatLabelForStage(stage, label) {
+  const colorFn = {
+    inbound: chalk.black.bgBlue,
+    fetch: chalk.black.bgYellow,
+    validate: chalk.black.bgGreen,
+    unhandledError: chalk.white.bgRed,
+    outbound: chalk.black.bgBlue,
+  }[stage]
+  return colorFn(` ${label} `)
+}
+
+function logTrace(stage, symbol, label, content, { deep = false } = {}) {
+  if (enableTraceLogging) {
+    if (deep) {
+      console.log(_formatLabelForStage(stage, label), symbol)
+      console.dir(content, { depth: null })
+    } else {
+      console.log(_formatLabelForStage(stage, label), symbol, '\n', content)
+    }
+    return true
+  } else {
+    return false
+  }
+}
+
+module.exports = {
+  logTrace,
+}

core/base-service/validate.js

@@ -0,0 +1,54 @@
+'use strict'
+
+const emojic = require('emojic')
+const Joi = require('joi')
+const trace = require('./trace')
+
+function validate(
+  {
+    ErrorClass,
+    prettyErrorMessage = 'data does not match schema',
+    includeKeys = false,
+    traceErrorMessage = 'Data did not match schema',
+    traceSuccessMessage = 'Data after validation',
+    allowAndStripUnknownKeys = true,
+  },
+  data,
+  schema
+) {
+  if (!schema || !schema.isJoi) {
+    throw Error('A Joi schema is required')
+  }
+  const options = allowAndStripUnknownKeys
+    ? {
+        allowUnknown: true,
+        stripUnknown: true,
+      }
+    : undefined
+  const { error, value } = Joi.validate(data, schema, options)
+  if (error) {
+    trace.logTrace(
+      'validate',
+      emojic.womanShrugging,
+      traceErrorMessage,
+      error.message
+    )
+
+    let prettyMessage = prettyErrorMessage
+    if (includeKeys) {
+      const keys = error.details.map(({ path }) => path)
+      if (keys) {
+        prettyMessage = `${prettyErrorMessage}: ${keys.join(', ')}`
+      }
+    }
+
+    throw new ErrorClass({ prettyMessage, underlyingError: error })
+  } else {
+    trace.logTrace('validate', emojic.bathtub, traceSuccessMessage, value, {
+      deep: true,
+    })
+    return value
+  }
+}
+
+module.exports = validate