parrot-core v5.0.0

parrot-core abstracts the matching, logging, and resolving functionality of Parrot away from each implementation. parrot-middleware and parrot-fetch use parrot-core and any new implementations could extend parrot-core in a similar way.

Example Implementation

import Parrot from 'parrot-core';

class ParrotNew extends Parrot {
  constructor(scenarios) {
    super(scenarios);
    // any constructor logic that is needed
  }

  normalizeRequest = request => {
    // conform incoming requests to match the scenarios structure
  };

  resolver = request => response => {
    // resolve the matched response to the implementation platform
  };
}

export default ParrotNew;

Access Methods

parrot-core also defines several methods that can be used to interact with the scenarios that are passed in.

getActiveScenario()

Returns the name of the currently active scenario.

setActiveScenario(name)

Sets the currently active scenario.

Arguments

• name (String): Scenario name.

getScenarios()

Returns an array of scenario objects.

setScenarios(scenarios)

Sets scenarios as the array of available scenarios.

Arguments

• scenarios (Array or Object): Scenarios descriptor.

getScenario(name)

Returns the scenario object with matching name.

Arguments

• name (String): Scenario name.

setScenario(name, mocks)

Sets the mocks for scenario with matching name.

Arguments

• name (String): Scenario name.
• mocks (Array): Array of mock objects.

getMock(name, index)

Returns the mock at index for scenario with matching name.

Arguments

• name (String): Scenario name.
• index (Number): Mock index.

setMock(name, index, mock)

Sets the mock at index for scenario with matching name.

Arguments

• name (String): Scenario name.
• index (Number): Mock index.
• mock (Object): Mock object.

Utility Methods

getParams(path, route)

Extracts the route parameters from a given path, using the specified route.

This is useful when using the manual match function.

Arguments

• path (String): Requested URL path.
• route (String): Express-style route with route parameters.

Example Usage

const { getParams } = require('parrot-core');

const getBook = ({ url }, match) => {
  const path = '/books/:bookId';
  if (match({ path, method: 'GET' })) {
    const { bookId } = getParams(url, path);
    const requestedBook = books.find(book => book.bookId === bookId);
    if (!requestedBook) {
      return { status: 404 };
    }
    return { status: 200, body: requestedBook };
  }
  return null;
};