{"id":17651815,"url":"https://github.com/diegovictor/pipedeals","last_synced_at":"2025-05-07T07:17:37.589Z","repository":{"id":38991282,"uuid":"248888932","full_name":"DiegoVictor/pipedeals","owner":"DiegoVictor","description":"Listen to Pipedrive's deals events and send it to Bling, also expose a few endpoints that aggregates deals by day and total amout, retrieve reports and opportunities","archived":false,"fork":false,"pushed_at":"2025-01-12T14:01:55.000Z","size":3601,"stargazers_count":3,"open_issues_count":7,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-07T07:17:01.046Z","etag":null,"topics":["api","bling","coverage-report","docker","javascript","js","mongodb","node","nodejs","pipedeals","pipedrive","redis"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DiegoVictor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-21T01:59:57.000Z","updated_at":"2025-01-12T14:01:58.000Z","dependencies_parsed_at":"2024-11-26T00:18:08.348Z","dependency_job_id":null,"html_url":"https://github.com/DiegoVictor/pipedeals","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiegoVictor%2Fpipedeals","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiegoVictor%2Fpipedeals/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiegoVictor%2Fpipedeals/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DiegoVictor%2Fpipedeals/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DiegoVictor","download_url":"https://codeload.github.com/DiegoVictor/pipedeals/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252831271,"owners_count":21810784,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","bling","coverage-report","docker","javascript","js","mongodb","node","nodejs","pipedeals","pipedrive","redis"],"created_at":"2024-10-23T11:43:47.794Z","updated_at":"2025-05-07T07:17:37.550Z","avatar_url":"https://github.com/DiegoVictor.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pipedeals\n[![AppVeyor](https://img.shields.io/appveyor/build/diegovictor/pipedeals?logo=appveyor\u0026style=flat-square)](https://ci.appveyor.com/project/DiegoVictor/pipedeals)\n[![mongo](https://img.shields.io/badge/mongodb-5.6.0-13aa52?style=flat-square\u0026logo=mongodb\u0026logoColor=white)](https://www.mongodb.com/)\n[![nodemon](https://img.shields.io/badge/nodemon-2.0.22-76d04b?style=flat-square\u0026logo=nodemon)](https://nodemon.io/)\n[![eslint](https://img.shields.io/badge/eslint-8.43.0-4b32c3?style=flat-square\u0026logo=eslint)](https://eslint.org/)\n[![airbnb-style](https://flat.badgen.net/badge/style-guide/airbnb/ff5a5f?icon=airbnb)](https://github.com/airbnb/javascript)\n[![jest](https://img.shields.io/badge/jest-29.5.3-brightgreen?style=flat-square\u0026logo=jest)](https://jestjs.io/)\n[![coverage](https://img.shields.io/codecov/c/gh/DiegoVictor/pipedeals?logo=codecov\u0026style=flat-square)](https://codecov.io/gh/DiegoVictor/pipedeals)\n[![MIT License](https://img.shields.io/badge/license-MIT-green?style=flat-square)](https://raw.githubusercontent.com/DiegoVictor/pipedeals/main/LICENSE)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)\u003cbr\u003e\n[![Run in Insomnia}](https://insomnia.rest/images/run.svg)](https://insomnia.rest/run/?label=Pipedeals\u0026uri=https%3A%2F%2Fraw.githubusercontent.com%2FDiegoVictor%2Fpipedeals%2Fmain%2FInsomnia_2024-11-23.json)\n\nThe main purpose of Pipedeals is listen to [Pipedrive](https://www.pipedrive.com) deal's `won` update event, prepare buy order data, save it on a database and finally send it to [Bling](https://www.bling.com.br)'s API. Also expose two resources, `opportunities` that are buy orders sent to Bling and `reports` that aggregates opportunities by day and amount (sum of products' prices in that day).\n\n# Table of Contents\n* [Installing](#installing)\n  * [Configuring](#configuring)\n    * [MongoDB](#mongodb)\n    * [.env](#env)\n    * [Pipedrive](#pipedrive)\n      * [Webhook](#webhook)\n      * [Custom Fields](#custom-fields)\n      * [Product](#product)\n    * [Bling's API Key](#blings-api-key)\n      * [Permissions](#permissions)\n* [Usage](#usage)\n  * [Error Handling](#error-handling)\n    * [Errors Reference](#errors-reference)\n  * [Pagination](#pagination)\n    * [Link Header](#link-header)\n    * [X-Total-Count](#x-total-count)\n  * [Bearer Token](#bearer-token)\n  * [Versioning](#versioning)\n  * [Routes](#routes)\n    * [Requests](#requests)\n* [Running the tests](#running-the-tests)\n  * [Coverage report](#coverage-report)\n\n# Installing\nEasy peasy lemon squeezy:\n```\n$ yarn\n```\nOr:\n```\n$ npm install\n```\n\u003e Was installed and configured the [`eslint`](https://eslint.org) and [`prettier`](https://prettier.io) to keep the code clean and patterned.\n\n## Configuring\nThe application uses just one database: [MongoDB](https://www.mongodb.com). For the fastest setup is recommended to use [docker-compose](https://docs.docker.com/compose/), you just need to up all services:\n```\n$ docker-compose up -d\n```\n\n### MongoDB\nStore opportunities sent to Bling, reports and the users utilized by application. If for any reason you would like to create a MongoDB container instead of use `docker-compose`, you can do it by running the following command:\n```\n$ docker run --name pipedeals-mongo -d -p 27017:27017 mongo\n```\n\n### .env\nIn this file you may configure your MongoDB and Redis database connection, JWT settings, the environment, app's port, url to documentation (this will be returned with error responses, see [error section](#error-handling)) and Pipedrive and Bling's keys. Rename the `.env.example` in the root directory to `.env` then just update with your settings.\n\n|key|description|default\n|---|---|---\n|APP_PORT|Port number where the app will run.|`3333`\n|NODE_ENV|App environment.|`development`\n|JWT_SECRET|An alphanumeric random string. Used to create signed tokens.| -\n|JWT_EXPIRATION_TIME|How long time will be the token valid. See [jsonwebtoken](https://github.com/auth0/node-jsonwebtoken#usage) repo for more information.|`7d`\n|MONGO_URL|MongoDB's server url.|`mongodb://mongo:27017/pipedeals`\n|PIPEDRIVE_API_TOKEN|Pipedrive API's token. See [How to find the API token](https://pipedrive.readme.io/docs/how-to-find-the-api-token) for more information.| -\n|PIPEDRIVE_DOMAIN_NAME|Pipedrive domain name (company name), see [How to get the company domain](https://pipedrive.readme.io/docs/how-to-get-the-company-domain).| -\n|PIPEDRIVE_USER and PIPEDRIVE_PWD|Basic auth's user and password (respectively). Used to ensure that the deal's event is coming from Pipedrive webhook, see [Webhook](#webhook) for more information about it.| -\n|BLING_API_KEY|Bling's api key. See [Bling's API key](#blings-api-key) section.| -\n|DOCS_URL|An url to docs where users can find more information about the app's internal code errors.|`https://github.com/DiegoVictor/pipedeals#errors-reference`\n\n### Pipedrive\nInstructions to configure the Pipedrive's webhook, custom fields and products.\n\n#### Webhook\nCreate a webhook to listen `updated.deal` event, remember to set a user (`PIPEDRIVE_USER`) and password (`PIPEDRIVE_PWD`), for more information see:\n* [Guide for Webhooks](https://pipedrive.readme.io/docs/guide-for-webhooks)\n\nThe webhook's url should be something like:\n```\nhttps://\u003cyour-domain\u003e/v1/pipedrive/events\n```\n\u003e If you are running the application local I recommend you to use [ngrok](https://ngrok.com) to export a url to access the application. (e.g. `https://25752eff.ngrok.io/v1/pipedrive/events`)\n\n![webhook](https://raw.githubusercontent.com/DiegoVictor/pipedeals/main/screenshots/webhook.png)\n\n#### Custom Fields\nBling make some fields mandatory, they are: [`Payment Method`](#payment-method) and [`Supplier`](#supplier), this application makes [`Parcels`](#parcels) mandatory too. To create custom fields to deal on Pipedrive see [Adding Custom Fields](https://support.pipedrive.com/hc/en-us/articles/207228075-Custom-Fields#C1).\n\n![custom fields](https://raw.githubusercontent.com/DiegoVictor/pipedeals/main/screenshots/custom_fields.png)\n\n##### Parcels\nJust create a field named Parcels, must be a number.\n\n![parcels](https://raw.githubusercontent.com/DiegoVictor/pipedeals/main/screenshots/parcels.png)\n\n##### Supplier\nSupplier, must be free text field.\n\n![supplier](https://raw.githubusercontent.com/DiegoVictor/pipedeals/main/screenshots/supplier.png)\n\n##### Payment Method\nPayment Method, must be unique option field.\n\n![payment method](https://raw.githubusercontent.com/DiegoVictor/pipedeals/main/screenshots/payment_method.png)\n\u003e Payments methods that not exists in Bling will be created before the opportunity be sent to it.\n\n#### Product\nAlso you need to create a product and attach to deal, fill only the mandatory fields is enough (`Product name` and `Unit price`). For more information see [Adding New Products](https://support.pipedrive.com/hc/en-us/articles/206759569-Products#C2).\n\n![create product](https://raw.githubusercontent.com/DiegoVictor/pipedeals/main/screenshots/create_product.png)\n\nRemember to link the product to deals, see how to do it in this article [How can I link products to a deal?](https://support.pipedrive.com/hc/en-us/articles/115001109169-How-can-I-link-products-to-a-deal-).\n\n![add deal product](https://raw.githubusercontent.com/DiegoVictor/pipedeals/main/screenshots/add_deal_product.png)\n\n### Bling's API Key\nTo get a Bling's API key, go to user list:\n* [Users](https://www.bling.com.br/b/usuarios.php#list)\n\nThen create a new user, select `USUÁRIO API`, copy the `API key` (maybe be necessary click on `GERAR`), [configure the permissions](#permissions), save the user, paste the `API key` in the `BLING_API_KEY` key in the `.env` file.\n\n![Bling user](https://raw.githubusercontent.com/DiegoVictor/pipedeals/main/screenshots/bling_user.png)\n\n#### Permissions\nThe following permissions are necessary to the API user:\n\n|permissions|menu|description\n|---|---|---\n|`Contas Contábeis`, `Notas Fiscais`, `NFCe` and `Pedidos de Venda`|Vendas|Enable just one is enough. Allow to get lists and create payment methods.\n|`Pedidos de Compra`|Suprimentos|Allow to create new buy orders.\n\n![permissions buy order](https://raw.githubusercontent.com/DiegoVictor/pipedeals/main/screenshots/permissions_buy_order.png)\u003cbr\u003e\n![permissions sales](https://raw.githubusercontent.com/DiegoVictor/pipedeals/main/screenshots/permissions_sales.png)\n\n# Usage\nTo start up the app run:\n```\n$ yarn start\n```\nOr:\n```\n$ npm run start\n```\nThen create new deals, make it pass through your funnel, etc, when you mark that deal as `won` the magic will happens :)\n\n## Error Handling\nInstead of only throw a simple message and HTTP Status Code this API return friendly errors:\n```json\n{\n  \"statusCode\": 401,\n  \"error\": \"Unauthorized\",\n  \"message\": \"You are not authorized!\",\n  \"code\": 741,\n  \"docs\": \"https://github.com/DiegoVictor/pipedeals#errors-reference\"\n}\n```\n\u003e Errors are implemented with [@hapi/boom](https://github.com/hapijs/boom).\n\u003e As you can see a url to errors docs are returned too. To configure this url update the `DOCS_URL` key from `.env` file.\n\u003e In the next sub section ([Errors Reference](#errors-reference)) you can see the errors `code` description.\n\n### Errors Reference\n|code|message|description\n|---|---|---\n|531|An error occurred while trying to retrieve the deal from Pipedrive|An error occurred during the request to get the deal in Pipedrive API, look the `details` key for more information.\n|532|An error occurred while trying to retrieve the deal's custom fields from Pipedrive|The request to get custom fields from Pipedrive API throw an error. Look the `details` key for more information.\n|533|An error occurred while trying to retrieve the deal's products from Pipedrive|Occurred an error while trying to retrieve deal's products, in `details` key will be more information about the error.\n|534|An error occurred while trying to save the order at Bling|Something goes wrong when tried to send the opportunity to Bling. There are two steps here: payment method verification and buy order creation. For more information see the `details` key in the response.\n|244|Report not found|The `id` sent not references an existing report in the database.\n|344|Opportunity not found|The `id` sent not references an existing opportunity in the database.\n|440|User not exists|The `email` sent not references an existing user in the database.\n|450|User and/or password not match|User and/or password is incorrect.\n|140|Email already in use|Already exists an user with the same email.\n|640|Missing authorization|Pipedrive's webhook is not sending the Basic auth's user and password.\n|641|You are not authorized!|Pipedrive's webhook is sending wrong Basic credentials.\n|740|Missing authorization token|The Bearer Token was not sent.\n|741|You are not authorized!|The Bearer Token provided is invalid or expired.\n\n## Pagination\nAll the routes with pagination returns 10 records per page, to navigate to other pages just send the `page` query parameter with the number of the page.\n\n* To get the third page of opportunities:\n```\nGET http://localhost:3333/v1/opportunities?page=3\n```\n\n### Link Header\nAlso in the headers of every route with pagination the `Link` header is returned with links to `first`, `last`, `next` and `prev` (previous) page.\n```\n\u003chttp://localhost:3333/v1/opportunities?page=7\u003e; rel=\"last\",\n\u003chttp://localhost:3333/v1/opportunities?page=4\u003e; rel=\"next\",\n\u003chttp://localhost:3333/v1/opportunities?page=1\u003e; rel=\"first\",\n\u003chttp://localhost:3333/v1/opportunities?page=2\u003e; rel=\"prev\"\n```\n\u003e See more about this header in this MDN doc: [Link - HTTP](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link).\n\n### X-Total-Count\nAnother header returned in routes with pagination, this bring the total records amount.\n\n## Bearer Token\nAll reports and oppotunities routes expect a Bearer Token in an `Authorization` header.\n\u003e You can see these routes in the [routes](#routes) section.\n```\nGET http://localhost:3333/v1/reports?page=1 Authorization: Bearer \u003ctoken\u003e\n```\n\u003e To achieve this token you just need authenticate through the `/sessions` route and it will return the `token` key with a valid Bearer Token.\n\n## Versioning\nA simple versioning was made. Just remember to set after the `host` the `/v1/` string to your requests.\n```\nGET http://localhost:3333/v1/reports\n```\n\n## Routes\n|route|HTTP Method|pagination|params|description|auth method\n|:---|:---:|:---:|:---:|:---|:---:\n|`/sessions`|POST|:x:|Body with user's `email` and `password`.|Authenticates user, return a Bearer Token and user's id and email.|:x:\n|`/users`|POST|:x:|Body with user's `email` and `password`.|Create new users.|:x:\n|`/pipedrive/events`|POST|:x:|Body with event's `event`, `current.id` and `current.status`.|Receive Piedrive deal's won event.|Basic\n|`/reports`|GET|:heavy_check_mark:|`page` query parameter.|List reports.|Bearer\n|`/reports/:id`|GET|:x:|`:id` of the report.|Return one report.|Bearer\n|`/reports/:id/opportunities`|GET|:heavy_check_mark:|`:id` of the report and `page` query parameter.|List report's opportunities.|Bearer\n|`/reports/:report_id/opportunities/:id`|GET|:x:|`:report_id` of the report and `:id` of the opportunity.|Return one report's opportunity.|Bearer\n\n\u003e Routes with `Bearer` as auth method expect an `Authorization` header. See [Bearer Token](#bearer-token) section for more information. `Basic` authentication is a base64 encoding of `PIPEDRIVE_USER` and `PIPEDRIVE_PWD` joined by a `:`, but you should not make manual requests to this endpoint (this will be responsability of the Pipedrive's [webhook](#webhook)).\n\n### Requests\n* `POST /session`\n\nRequest body:\n```json\n{\n  \"email\": \"diegovictorgonzaga@gmail.com\",\n  \"password\": \"123456\"\n}\n```\n\n* `POST /users`\n\nRequest body:\n```json\n{\n  \"email\": \"diegovictorgonzaga@gmail.com\",\n  \"password\": \"123456\"\n}\n```\n\n* `POST /pipedrive/events`\n\nRequest body:\n```json\n{\n  \"current\": {\n    \"id\": 1,\n    \"status\": \"won\"\n  },\n  \"event\": \"updated.deal\"\n}\n```\n\n# Running the tests\n[Jest](https://jestjs.io) was the choice to test the app, to run:\n```\n$ yarn test\n```\nOr:\n```\n$ npm run test\n```\n\n## Coverage report\nYou can see the coverage report inside `tests/coverage`. They are automatically created after the tests run.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiegovictor%2Fpipedeals","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdiegovictor%2Fpipedeals","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiegovictor%2Fpipedeals/lists"}