resource-watch/document-adapter

# Resource Watch document adapter microservice

[![Build Status](https://travis-ci.com/resource-watch/document-adapter.svg?branch=dev)](https://travis-ci.com/resource-watch/document-adapter)
[![Test Coverage](https://api.codeclimate.com/v1/badges/381fe72ebbdaaeb9aff4/test_coverage)](https://codeclimate.com/github/resource-watch/document-adapter/test_coverage)

## Dependencies

You will need [Control Tower](https://github.com/control-tower/control-tower) up and running - either natively or with Docker. Refer to the project's README for information on how to set it up.

The document adapter microservice is built using [Node.js](https://nodejs.org/en/), and can be executed either natively or using Docker, each of which has its own set of requirements.

Native execution requires:
- [Node.js](https://nodejs.org/en/)
- [Elasticsearch](https://www.elastic.co/)
- [RabbitMQ](https://www.rabbitmq.com/)

Execution using Docker requires:
- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)

Dependencies on other Microservices:

- [Dataset](https://github.com/resource-watch/dataset/)
- [Converter](https://github.com/resource-watch/converter)
- [Document orchestrator](https://github.com/resource-watch/doc-orchestrator/)

## Getting started

Start by cloning the repository from github to your execution environment

```
git clone https://github.com/resource-watch/document-adapter.git && cd document-adapter
```

After that, follow one of the instructions below:

### Using native execution

1 - Set up your environment variables. See `dev.env.sample` for a list of variables you should set, which are described in detail in [this section](#configuration-environment-variables) of the documentation. Native execution will NOT load the `dev.env` file content, so you need to use another way to define those values

2 - Install node dependencies using YARN:
```
yarn install
```

3 - Start the application server:
```
yarn start
```

The endpoints provided by this microservice should now be available through Control Tower's URL.

### Using Docker

1 - Create and complete your `dev.env` file with your configuration. The meaning of the variables is available in this [section](#configuration-environment-variables). You can find an example `dev.env.sample` file in the project root.

2 - Execute the following command to run Control tower:

```
./adapterDoc.sh develop
```

The endpoints provided by this microservice should now be available through Control Tower's URL.

## Testing

There are two ways to run the included tests:

### Using native execution

Follow the instruction above for setting up the runtime environment for native execution, then run:
```
yarn test
```

### Using Docker

Follow the instruction above for setting up the runtime environment for Docker execution, then run:
```
./adapterDoc.sh test
```

## Configuration

### Environment variables

- **PORT** => TCP port in which the service will run
- **NODE_PATH** => relative path to the source code. Should be `app/src`
- **MICROSERVICE_TOKEN** => 
- **MONGO_PORT_27017_TCP_ADDR** => IP/Address of the MongoDB server
- **GATEWAY_URL** => Control Tower URL
- **RABBITMQ_URL** => RabbitMQ connection URL - if using RabbitMQ with default configurations, you should set this variable to something like `amqp://0.0.0.0:5672/`
- **ELASTIC_URL** => Elasticsearch connection URL - if using ES with default configurations, you should set this variable to something like `127.0.0.1:9200`

You can optionally set other variables, see [this file](config/custom-environment-variables.json) for an extended list.