{"analyzedAt":"2022-08-05T22:45:40.189Z","collected":{"metadata":{"name":"gators","scope":"unscoped","version":"2.2.3","description":"Free and easy texting framework for node using SMS gateways.","keywords":["gators","gator","node","sms","gateways","text","free"],"date":"2022-08-05T22:45:10.810Z","author":{"name":"jdtzmn","email":"jdtzmn@gmail.com","username":"jdtzmn"},"publisher":{"username":"jdtzmn","email":"jdtzmn@gmail.com"},"maintainers":[{"username":"jdtzmn","email":"jdtzmn@gmail.com"}],"repository":{"type":"git","url":"git+https://github.com/jdtzmn/gators.git"},"links":{"npm":"https://www.npmjs.com/package/gators","homepage":"https://github.com/jdtzmn/gators#readme","repository":"https://github.com/jdtzmn/gators","bugs":"https://github.com/jdtzmn/gators/issues"},"license":"MIT","dependencies":{"html-to-text":"^5.1.1","imap":"^0.8.19","lodash":"^4.17.19","mailparser":"^2.8.0","nodemailer":"^6.7.7"},"devDependencies":{"@types/html-to-text":"^5.1.1","@types/imap":"^0.8.29","@types/lodash":"^4.14.158","@types/mailparser":"^2.0.2","@types/node":"^14.0.27","@types/nodemailer":"^6.4.0","@types/nodemailer-sendgrid":"^1.0.0","elizabot":"0.0.3","husky":"^4.2.5","lint-staged":"^10.2.11","nodemailer-sendgrid":"^1.0.3","rimraf":"^3.0.2","ts-loader":"^8.0.2","ts-node":"^8.10.2","tslint":"^6.1.3","tslint-config-standard":"^9.0.0","typescript":"^3.9.7"},"releases":[{"from":"2022-07-06T00:00:00.000Z","to":"2022-08-05T00:00:00.000Z","count":0},{"from":"2022-05-07T00:00:00.000Z","to":"2022-08-05T00:00:00.000Z","count":0},{"from":"2022-02-06T00:00:00.000Z","to":"2022-08-05T00:00:00.000Z","count":0},{"from":"2021-08-05T00:00:00.000Z","to":"2022-08-05T00:00:00.000Z","count":0},{"from":"2020-08-05T00:00:00.000Z","to":"2022-08-05T00:00:00.000Z","count":7}],"hasTestScript":true,"hasSelectiveFiles":true,"readme":"# gators\n\nFree and easy texting framework for node using [SMS gateways][SMS-article].\n\n[![GitHub stars][stars-image]][stars-url]\n[![GitHub forks][forks-image]][forks-url]\n[![GitHub issues][issues-image]][issues-url]\n[![License][license-image]][license-url]\n\n```js\nimport Gators from 'gators'\n\nconst emailAuthentication = {\n  account: { /* ... */ },\n  smtp: { /* ... */ },\n  imap: { /* ... */ }\n}\nconst gators = new Gators(emailAuthentication)\n\ngators.on('connected', () => console.log('connected!'))\n\ngators.on('message', (details, sendReply) => {\n  const text = details.text.toLowerCase()\n  console.log(`> Received message: ${text}`)\n\n  // send reply\n  if (text === 'ping') sendReply('pong')\n})\n\ngator.on('error', (err: any) => console.log(err))\n\ngator.connect()\n```\n\n[![NPM](https://nodei.co/npm/gators.png)](https://nodei.co/npm/gators/)\n\n## Getting Started\n\n> DISCLAIMER: This package has not been tested with all SMS gateway providers nor phone operating systems.\n\n> For a list of supported providers, see [SUPPORT.md](SUPPORT.md).\n\n> For instructions on how you can contribute, see [CONTRIBUTE.md](CONTRIBUTE.md).\n\nThis is a module from npm.\n\nBefore installing, download and install [node.js](https://nodejs.org/) and [npm](https://npmjs.com).\n\n### Install gators\n\n```bash\n$ npm i -s gators\n# or yarn add gators\n```\n\n### Create auth file from template\n\n```bash\n$ touch auth.js\n```\n\nauth.js\n\n```js\nmodule.exports = {\n  account: {\n    user: '****@****.com',\n    pass: '$!J$#LK#K'\n  },\n  smtp: {\n    host: 'smtp.*****.com',\n    port: 465,\n    secure: true\n  },\n  imap: {\n    host: 'imap.*****.com',\n    port: 993,\n    secure: true\n  }\n}\n```\n\n### Manually test with one of the included examples\n\n```bash\n$ ts-node ./examples/ping\n```\n\n## Built With\n\n* [node-imap](https://github.com/mscdex/node-imap) - IMAP Client\n* [Nodemailer](https://nodemailer.com/) - SMTP Client\n* [Mailparser](https://nodemailer.com/extras/mailparser/) - Elegantly parse emails\n* [html-to-text](https://github.com/werk85/node-html-to-text) - HTML interpreter\n\n## Versioning\n\nWe use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/jdtzmn/gators/tags).\n\n## Coding Style\n\n[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)\n\n## Authors\n\n* **jdtzmn** - *Initial work* - [jdtzmn](https://github.com/jdtzmn)\n\nSee also the list of [contributors](https://github.com/jdtzmn/gators/contributors) who participated in this project.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details\n\n## Acknowledgments\n\n* This amazing [README template](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2).\n* [NodeICO](https://nodei.co) for the npm badge.\n* [gitignore.io](https://gitignore.io) for .gitignore\n\n[SMS-article]: https://en.wikipedia.org/wiki/SMS_gateway#Email_clients\n[stars-image]: https://img.shields.io/github/stars/jdtzmn/gators.svg\n[stars-url]: https://github.com/jdtzmn/gators/stargazers\n[forks-image]: https://img.shields.io/github/forks/jdtzmn/gators.svg\n[forks-url]: https://github.com/jdtzmn/gators/network\n[issues-image]: https://img.shields.io/github/issues/jdtzmn/gators.svg\n[issues-url]: https://github.com/jdtzmn/gators/issues\n[license-image]: https://img.shields.io/github/license/jdtzmn/gators.svg\n[license-url]: https://github.com/jdtzmn/gators/blob/master/LICENSE.md"},"npm":{"downloads":[{"from":"2022-08-04T00:00:00.000Z","to":"2022-08-05T00:00:00.000Z","count":0},{"from":"2022-07-29T00:00:00.000Z","to":"2022-08-05T00:00:00.000Z","count":0},{"from":"2022-07-06T00:00:00.000Z","to":"2022-08-05T00:00:00.000Z","count":18},{"from":"2022-05-07T00:00:00.000Z","to":"2022-08-05T00:00:00.000Z","count":81},{"from":"2022-02-06T00:00:00.000Z","to":"2022-08-05T00:00:00.000Z","count":219},{"from":"2021-08-05T00:00:00.000Z","to":"2022-08-05T00:00:00.000Z","count":395}],"starsCount":0},"github":{"starsCount":0,"forksCount":0,"subscribersCount":2,"issues":{"count":10,"openCount":6,"distribution":{"3600":3,"10800":0,"32400":0,"97200":0,"291600":0,"874800":0,"2624400":0,"7873200":1,"23619600":1,"70858800":4,"212576400":1},"isDisabled":false},"contributors":[{"username":"jdtzmn","commitsCount":35}],"commits":[{"from":"2022-07-29T00:00:00.000Z","to":"2022-08-05T00:00:00.000Z","count":5},{"from":"2022-07-06T00:00:00.000Z","to":"2022-08-05T00:00:00.000Z","count":5},{"from":"2022-05-07T00:00:00.000Z","to":"2022-08-05T00:00:00.000Z","count":5},{"from":"2022-02-06T00:00:00.000Z","to":"2022-08-05T00:00:00.000Z","count":5},{"from":"2021-08-05T00:00:00.000Z","to":"2022-08-05T00:00:00.000Z","count":5}]},"source":{"files":{"readmeSize":3465,"testsSize":0,"hasChangelog":true},"badges":[{"urls":{"original":"https://nodei.co/npm/gators.png","shields":"https://img.shields.io/npm/v/gators.svg","content":"https://img.shields.io/npm/v/gators.json"},"info":{"service":"npm","type":"version"}}],"linters":["tslint"],"outdatedDependencies":{"html-to-text":{"required":"^5.1.1","stable":"8.2.1","latest":"8.2.1"},"mailparser":{"required":"^2.8.0","stable":"3.5.0","latest":"3.5.0"}}}},"evaluation":{"quality":{"carefulness":0.9999999999999999,"tests":0,"health":0.5,"branding":0.15},"popularity":{"communityInterest":3,"downloadsCount":27,"downloadsAcceleration":-0.08692922374429232,"dependentsCount":0},"maintenance":{"releasesFrequency":0.9,"commitsFrequency":0.9,"openIssues":0.9,"issuesDistribution":0.9}},"score":{"final":0.5333679877061397,"detail":{"quality":0.5766937028523489,"popularity":0.02971881418643159,"maintenance":0.9998808339576686}}}