Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jupiterone/graph-hubspot

A graph conversion tool for https://www.hubspot.com/
https://github.com/jupiterone/graph-hubspot

Last synced: 7 days ago
JSON representation

A graph conversion tool for https://www.hubspot.com/

Awesome Lists containing this project

README 

        
# JupiterOne Integration



Learn about the data ingested, benefits of this integration, and how to use it

with JupiterOne in the [integration documentation](docs/jupiterone.md).



## Development



### Prerequisites



1. Install [Node.js](https://nodejs.org/) using the

   [installer](https://nodejs.org/en/download/) or a version manager such as

   [nvm](https://github.com/nvm-sh/nvm) or [fnm](https://github.com/Schniz/fnm).

2. Install [`yarn`](https://yarnpkg.com/getting-started/install) or

   [`npm`](https://github.com/npm/cli#installation) to install dependencies.

3. Install dependencies with `yarn install`.

4. Register an account in the system this integration targets for ingestion and

   obtain API credentials.

5. `cp .env.example .env` and add necessary values for runtime configuration.



   When an integration executes, it needs API credentials and any other

   configuration parameters necessary for its work (provider API credentials,

   data ingestion parameters, etc.). The names of these parameters are defined

   by the `IntegrationInstanceConfigFieldMap`in `src/config.ts`. When the

   integration is executed outside the JupiterOne managed environment (local

   development or on-prem), values for these parameters are read from Node's

   `process.env` by converting config field names to constant case. For example,

   `clientId` is read from `process.env.CLIENT_ID`.



   The `.env` file is loaded into `process.env` before the integration code is

   executed. This file is not required should you configure the environment

   another way. `.gitignore` is configured to avoid committing the `.env` file.



### Running the integration



#### Running directly



1. `yarn start` to collect data

2. `yarn graph` to show a visualization of the collected data

3. `yarn j1-integration -h` for additional commands



#### Running with Docker



Create an integration instance for the integration in JupiterOne. With an

**JupiterOne API Key** scoped to the integration or an API Key with permissions

to synchronize data and the **Integration Instance ID**:



1. `docker build -t $IMAGE_NAME .`

2. `docker run -e "JUPITERONE_API_KEY=" -e "JUPITERONE_ACCOUNT= -e "INTEGRATION_INSTANCE_ID=" "JUPITERONE_API_BASE_URL=" $IMAGE_NAME`



### Making Contributions



Start by taking a look at the source code. The integration is basically a set of

functions called steps, each of which ingests a collection of resources and

relationships. The goal is to limit each step to as few resource types as

possible so that should the ingestion of one type of data fail, it does not

necessarily prevent the ingestion of other, unrelated data. That should be

enough information to allow you to get started coding!



See the

[SDK development documentation](https://github.com/JupiterOne/sdk/blob/main/docs/integrations/development.md)

for a deep dive into the mechanics of how integrations work.



See [docs/development.md](docs/development.md) for any additional details about

developing this integration.



## Testing the integration



Ideally, all major calls to the API and converter functions would be tested. You

can run the tests with `yarn test`, and you can run the tests as they execute in

the CI/CD environment with `yarn test:ci` (adds linting and type-checking to

`yarn test`). If you have a valid runtime configuration, you can run the tests

with your credentials using `yarn test:env`.



For more details on setting up tests, and specifically on using recordings to

simulate API responses, see `test/README.md`.



### Changelog



The history of this integration's development can be viewed at

[CHANGELOG.md](CHANGELOG.md).