https://github.com/openactive/rpde-validator

RPDE Validator library, used as a component of validator.openactive.io
https://github.com/openactive/rpde-validator

rpde validators

Last synced: 7 months ago
JSON representation

RPDE Validator library, used as a component of validator.openactive.io

• Host: GitHub
• URL: https://github.com/openactive/rpde-validator
• Owner: openactive
• License: mit
• Created: 2018-08-15T15:52:01.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-09-09T13:35:01.000Z (over 1 year ago)
• Last Synced: 2024-09-09T16:24:34.425Z (over 1 year ago)
• Topics: rpde, validators
• Language: JavaScript
• Homepage:
• Size: 208 KB
• Stars: 0
• Watchers: 9
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# RPDE Validator

The OpenActive RPDE validator library.

[![Tests](https://github.com/openactive/rpde-validator/actions/workflows/node.js.yml/badge.svg?branch=master)](https://github.com/openactive/rpde-validator/actions/workflows/node.js.yml)

[![Known Vulnerabilities](https://snyk.io/test/github/openactive/rpde-validator/badge.svg)](https://snyk.io/test/github/openactive/rpde-validator)

## Introduction

This library allows developers to validate RPDE feeds against the latest [Realtime Paged Data Exchange](https://www.openactive.io/realtime-paged-data-exchange/) specification.

## Using in your application

This library can be used in your own application, perhaps as part of your CI pipeline.

### Install

```shell

$ npm install @openactive/rpde-validator

```

### Usage

```js

const { RpdeValidator } = require('@openactive/rpde-validator');

RpdeValidator(

  url, // The URL of the feed to test

  {

    // A callback that is called for log messages

    // Will be provided with an object that looks like:

    // {

    //   verbosity: 1, // 1-3 (higher is more verbose)

    //   percentage: 50, // The percentage complete

    //   message: '...', // String log message

    // }

    logCallback: (log) => {

      console.log(log.message);

    },

    // User agent used by the validator

    // Default: "RPDE_Validator/version (+https://validator.openactive.io/rpde)"

    userAgent: null, 

    // The time in between requests in a feed in milliseconds

    // Default: 0

    requestDelayMs: 1000,

    // The timeout in which to give up on requesting a feed URL

    // Must be non-zero

    // Default: 10000

    timeoutMs: 10000,

    // The number of feed pages to walk through

    // Must be non-zero

    // Default: 20

    pageLimit: 10,

  }

);

```

## Development

### Getting started

```shell

$ git clone git@github.com:openactive/rpde-validator.git

$ cd rpde-validator

$ npm install

```

### Running tests

This project uses [Jasmine](https://jasmine.github.io/) for its tests. All spec files are located alongside the files that they target.

To run tests locally, run:

```shell

$ npm test

```

The test run will also include a run of [eslint](https://eslint.org/). To run the tests without these, use:

```shell

$ npm run test-no-lint

```