Github Mock Event Emitter

The Github Mock Event Emitter is a simple service that is intended to be used in conjunction with the Github Scoring Service.

The intention of the Github Mock Event Emitter service is to act as a means of testing the Github Scoring Service by serving as a source of events to be consumed by the scoring service.

The Github Mock Event Emitter is a simple http server that listens for certain requests.

When receiving a correct request the service will send another http request to the scoring service in a format it expects.

Thus, by utilizing this service you can populate the database for the Github Scoring Service without having to be plugged into live github webhooks.

---

Running

This service is intended to be run in conjunction with the Github Scoring Service. See the documentation for the Github Scoring Service for more information on running the service in this fashion.

---

If you would like to compile this source code directly then you will need Leiningen 2.0.0 or above installed.

To start a web server for the application, run:

lein ring server-headless

The app should start up on port 8010

Environment

The service only needs one environment variable in order to function:

SCORING-SERVICE-URL=

which, as the name suggests, is the URL to the Github Scoring Service that this service will push events to via http.

If you run this service in conjunction with the Github Scoring Service, as intended, then you will not need to worry about setting the environment because the docker build process will handle that for us.

If you wish to run the service as a stand alone application then you can set the environment in your profiles.clj.

---

API

There are two ways of interacting with the Github Mock Event Emitter.

1. You can trigger individual events to be pushed to the Github Scoring Service

   To trigger individual events you need to send a POST request to the following endpoint:

   /event

   with a JSON POST body of the following form:

     {
        "type": "<some-event-type-name>",
        "user": "<some-user-name>",
        "repository": "<some-repository-name>"
     }

---

2. You can trigger a batch of events to be pushed to the Github Scoring Service with one request

   It can be a real pain to have to trigger enough events manually using the /event endpoint.

   To trigger many events at once you need to send a POST request to the following endpoint:

   /simulator

   with a JSON POST body of the following form:

     {
        "number_of_events": 42,
        "types": ["<some-event-type-name>", "<some-other-event-type-name>", ...],
        "users": ["<some-user-name>", "<some-other-user-name>", ... ],
        "repositories": ["<some-repository-name>", "<some-other-repository-name>", ...]
     }

   This will cause a number of events to be pushed to the Github Scoring Service.

   The total number of events is equal to the value passed in the POST body for the number_of_events key.

   For each event an event-type, user, and repository are selected at random from the entries in JSON arrays passed in the POST body for the respective entries.