{"_id":"@byrdware/rester","_rev":"4-1e0517345ff1358e618d6b957de8d63a","name":"@byrdware/rester","dist-tags":{"latest":"0.1.3"},"versions":{"0.1.0":{"name":"@byrdware/rester","version":"0.1.0","description":"CLI REST API Test Runner","main":"app.js","bin":{"@byrdware/rester":"bin/rester","rester":"bin/rester"},"publishConfig":{"access":"public"},"engine":{"node":">=6.0.0"},"scripts":{"start":"node bin/rester postman ./test/test-suite.js","test":"mocha --reporter spec"},"repository":{"type":"git","url":"git+https://github.com/byrdware/rester.git"},"keywords":["cli","rester","rest","rest api","testing","unit testing"],"author":{"name":"ByrdWare","email":"support@byrdware.org","url":"https://github.com/byrdware"},"license":"MIT","bugs":{"url":"https://github.com/byrdware/rester/issues"},"homepage":"https://github.com/byrdware/rester#readme","dependencies":{"async":"^3.1.0","commander":"^3.0.0","debug":"^4.1.1","performance-now":"^2.1.0","superagent":"^5.1.0"},"devDependencies":{"chai":"^4.2.0","mocha":"^6.2.0","express":"~4.16.1","http-errors":"^1.7.3","uuid":"^3.3.3"},"gitHead":"abd06beedf49e89d65f80223280149f87d2d6745","_id":"@byrdware/rester@0.1.0","_nodeVersion":"10.16.3","_npmVersion":"6.11.2","dist":{"integrity":"sha512-Dxh74XE+rAkxtY/TEnPnJ1IEllGQxcDMZvFCodjLhspjzdASMJml5v5Bjj8EZBEqQCy9h0PNrF/icDAfYFJgHw==","shasum":"c0705b7db4a173cba071013158cffec6ada9690e","tarball":"https://registry.npmjs.org/@byrdware/rester/-/rester-0.1.0.tgz","fileCount":11,"unpackedSize":26057,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdZ1ssCRA9TVsSAnZWagAAJRoP/j7vpfZvvx/lSALYZOXi\nk7Ip5QralE5kkr/6MhtljX1axPK3FjxqVpwh8rOtGoSs2pQidA9etQrbr3EL\nccwgQW9H20+8WMbTdfg9NqHx5hfQiylt3tPPjtV+3ehmLIzzDgbDaGqnOycL\nI2pHqUdaD9rYA9yNhfGz1h3IO+KQ9bDIaPjcf7/GWQISVlv15lQyQwyLint/\nfMLOrdamW6xBnLMNDtrxGy0u3b6oXY52cysgDv2hiaE4plPyi7oSHZIJvtMe\n7U3R1tAqzxaOhGXEon7vb0T7q1wBYfFJdn52xzqxEK8+XCd+xeupe2tn76G8\ne7vsKKLEJE3sSB6d7cHxwdTEH3NzQ4GnBWXkbFHrK5VDxKB+iT56fa9djPq1\nTVtW7g2gzqINXk6DTVKd8RX8TT4NzMtpRd9YOda5AnCfLyKgox3OGAd8q2Df\n+k6WajCkMjfP1PKhRZ3bySqI7WRX+wtZW9g+xSJHokXpvq/ca2bSA+Y2Zs+k\n2dd1AeoWQNIq+jBtMIIx6gL8BennpIarIEnoKUIqMnYLuRTuFrnFlSffPgkh\n41+ZsiFLnUlq7PuTex7pef4GRieT8vnaBJau6moYtnvZRLc3UGOQ5Ea+IctV\n9P5BE3BN86JUyNIvs+N/hI/VgcR5HFVLB4DM8OMD3FEv4gzqVk6IRvC+RQHo\nNDFM\r\n=pCsg\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCvaD07BpHFSGMFcoZT7Qaep2Zhj92INzrsLpEaFJwcSgIhAKf2Di+OYdN55bwjxJG0J2flGzO05X4vumx9rhGgkHo6"}]},"maintainers":[{"name":"byrdware","email":"support@byrdware.org"}],"_npmUser":{"name":"byrdware","email":"support@byrdware.org"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/rester_0.1.0_1567054635964_0.3764115539427131"},"_hasShrinkwrap":false},"0.1.1":{"name":"@byrdware/rester","version":"0.1.1","description":"REST API Test Runner","main":"app.js","bin":{"@byrdware/rester":"bin/rester","rester":"bin/rester"},"publishConfig":{"access":"public"},"engine":{"node":">=6.0.0"},"scripts":{"start":"node bin/rester postman ./test/test-suite.js","test":"mocha -R spec","cover":"node ./node_modules/istanbul/lib/cli.js cover ./node_modules/mocha/bin/_mocha -- -R spec test/*-test.js"},"repository":{"type":"git","url":"git+https://github.com/byrdware/rester.git"},"keywords":["cli","rester","rest","rest api","testing","unit testing"],"author":{"name":"ByrdWare","email":"support@byrdware.org","url":"https://github.com/byrdware"},"license":"MIT","bugs":{"url":"https://github.com/byrdware/rester/issues"},"homepage":"https://github.com/byrdware/rester#readme","dependencies":{"async":"^3.1.0","commander":"^3.0.0","debug":"^4.1.1","performance-now":"^2.1.0","superagent":"^5.1.0"},"devDependencies":{"chai":"^4.2.0","coveralls":"^3.0.6","express":"~4.16.1","http-errors":"^1.7.3","istanbul":"^0.4.5","mocha":"^6.2.0","uuid":"^3.3.3"},"gitHead":"121ef9314e55bb1132f99b76df410f39e008836a","_id":"@byrdware/rester@0.1.1","_nodeVersion":"10.16.3","_npmVersion":"6.11.2","dist":{"integrity":"sha512-4ofC5awE9baTMqhPf69h5LNTVnxYsJOlm0ghpdtDW3Urx4lJpdvQ7v1goQUYbb+MAYwKpu1FfFnFxcEBKrRzbQ==","shasum":"3db1264bca9a3e463020855a01c53da8cd7c5eac","tarball":"https://registry.npmjs.org/@byrdware/rester/-/rester-0.1.1.tgz","fileCount":13,"unpackedSize":38072,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdaBNrCRA9TVsSAnZWagAAiL8P/juxo0h5d07RGRP+rK1T\nOMHPHc6Q7LdFVRdWSXB0BHtJ01/vQM0+KSbl+1pTIRPa74he/+KPZOvSQsyy\n6P/R8lYaIgFYE75gqCyWuSkf5Z6lQ8pqNO+vuthjTeHMIMVFU9mAGTnUI6Bj\nfTYH2zNCN0eVUX9yJeYgTGfDLmugfNWGcDIP78E0h/sBb/7Gl/mMqhxjEucA\nSvEF1Nbjos3pqeS7rWnkHk2oVzVNoO+AgK/F/lPPjN62zuTILE3tTDMytKM0\nMCsntaWIJMXp7D9CDXCmEBfDb4sVh0SNYPO0k74jIti2xOUak0Rg1P9L9MHz\n0ta6Hr+CVXFi8c+McuiGUy4cXT5P52Xzh3RfFOoxM00Sr5H+Lr9Mwh5EdVOL\nrMG7OPEfn+daTxrnAcXaeLFQqt7IPJL1veFKqeQSv3hSfq0qP9gb1mChSesz\nuidLhRgEhIAM46s0K46Fum/YVRJPHxBclY20Nj5uKQwODjO610Qd8IRMnUhw\n5+3qUgPN5HYSn9FOp9ijX5Q4BCZOkYLSweAYn06mmiOLfYS+cYf53T9BOCZL\nvcMm/rpdMzCZpN42zqduc4xq9W8peogPjagCfpLrYHSI0o0MMriGesGGxSXw\nKk4Cukz5WQC7PN9AtRBZuqDWr+n9o23dmW0mz9dPQB75eju4ncsSqELj7/n4\nrIgz\r\n=CBX5\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCqdnVxq0uJGUkPlNovyHUKkkLJnyjcXf+amMTwPXVAzgIhAOt7Na4yf+h3TPkzSyaAG2UpjzGROJjFA3lbPAlmRWsf"}]},"maintainers":[{"name":"byrdware","email":"support@byrdware.org"}],"_npmUser":{"name":"byrdware","email":"support@byrdware.org"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/rester_0.1.1_1567101801754_0.14629422572694506"},"_hasShrinkwrap":false},"0.1.2":{"name":"@byrdware/rester","version":"0.1.2","description":"REST API Test Runner","main":"app.js","bin":{"@byrdware/rester":"bin/rester","rester":"bin/rester"},"publishConfig":{"access":"public"},"engine":{"node":">=6.0.0"},"scripts":{"start":"node bin/rester postman ./test/test-suite.js","test":"mocha -R spec","cover":"node ./node_modules/istanbul/lib/cli.js cover ./node_modules/mocha/bin/_mocha -- -R spec test/*-test.js"},"repository":{"type":"git","url":"git+https://github.com/byrdware/rester.git"},"keywords":["cli","rester","rest","rest api","testing","unit testing"],"author":{"name":"ByrdWare","email":"support@byrdware.org","url":"https://github.com/byrdware"},"license":"MIT","bugs":{"url":"https://github.com/byrdware/rester/issues"},"homepage":"https://github.com/byrdware/rester#readme","dependencies":{"async":"^3.1.0","commander":"^3.0.0","debug":"^4.1.1","performance-now":"^2.1.0","superagent":"^5.1.0"},"devDependencies":{"chai":"^4.2.0","coveralls":"^3.0.6","express":"~4.16.1","http-errors":"^1.7.3","istanbul":"^0.4.5","mocha":"^6.2.0","uuid":"^3.3.3"},"gitHead":"b0372351350f759d563501a2ee3420f511a9fb7e","_id":"@byrdware/rester@0.1.2","_nodeVersion":"10.16.3","_npmVersion":"6.11.2","dist":{"integrity":"sha512-03eIjvwaEKZQdlfAAKiSiAuiIN7vBk5n0jBK2jYAlyZqv44OSOCOrcBjUDnttJnqGFPXvk/70k2p8n3JW9xg8Q==","shasum":"7d4739ed4daec2f6347526ba8da14221535bc8b7","tarball":"https://registry.npmjs.org/@byrdware/rester/-/rester-0.1.2.tgz","fileCount":13,"unpackedSize":38811,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdaCxoCRA9TVsSAnZWagAA094P+QAkVAmm2apzpFBVon+/\nEysROOSq+MjGPEDZ/62iYUuovqresrITBuZHuYGlML+WmzaYT32eixNAHf1j\n+jpfUlN672suF+3sWqjXdbMmL2N3Owk89cGCFwrezSxRXVcjSfvkl7z4V0a1\n+IxPE96A2l6KhFF2joSDectbIQVfA9ImZppt7Ku5RvwUsrV/S3937QL/lFLl\nDcv8UjJBQxjE3YUPYurQKTCvR/QFoJzGNro9i37a1wLM66ymhsknd64lYoAB\nbykW7uycsrVjyHpika6G4NFLdGYa0UTPkWfxSFPJy+WFd3FiicBPO6OQRuPb\nEdabgKB1uCoAJTSoBQaUnLDnUKuNwBICKryzr9aMA3yOr7nHKAjiDyf9wQQc\n1dD5ki2SvphSH2QP8FjxsZezgw1DSqrmRHgsnZ4I86mQam5uxqSwAANs55AZ\nshjHiJzZwDV1Ls+3ul/YK6GMie6+21vAz8EJP5DQOtrqVkb9FXPEDcyn2DE4\nA7tqLAw8pFJVil9pgNpLyLtUZhQ+IiwoaUNVQ2ruqMdtbLC0M9omCZySsu9U\n4loRKIO2OLOvVKObDLKZiFv/vot0uB6sCoEXjUGL13+8udrIilGALrzIyCMV\nB80kXPa+nXLu+KfzTSn1Cxre3li7Y2LnQELN2LMU/RLTe4eONK8RLNVIC9e4\njuGY\r\n=jk6W\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDk5LOb1hJiyfm6rEz9TSaCH/OW/7BBreoQQGm2Mn8WPQIgRI/o6trGygd89vYARukI6OyqipEgSgU6egxSvKJ9S1U="}]},"maintainers":[{"name":"byrdware","email":"support@byrdware.org"}],"_npmUser":{"name":"byrdware","email":"support@byrdware.org"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/rester_0.1.2_1567108199836_0.17653696617633763"},"_hasShrinkwrap":false},"0.1.3":{"name":"@byrdware/rester","version":"0.1.3","description":"REST API Test Runner","main":"app.js","bin":{"@byrdware/rester":"bin/rester","rester":"bin/rester"},"publishConfig":{"access":"public"},"engine":{"node":">=6.0.0"},"scripts":{"start":"node bin/rester postman ./test/test-suite.js","test":"mocha -R spec","cover":"node ./node_modules/istanbul/lib/cli.js cover ./node_modules/mocha/bin/_mocha -- -R spec test/*-test.js"},"repository":{"type":"git","url":"git+https://github.com/byrdware/rester.git"},"keywords":["cli","rester","rest","rest api","testing","unit testing"],"author":{"name":"ByrdWare","email":"support@byrdware.org","url":"https://github.com/byrdware"},"license":"MIT","bugs":{"url":"https://github.com/byrdware/rester/issues"},"homepage":"https://github.com/byrdware/rester#readme","dependencies":{"async":"^3.1.0","commander":"^3.0.0","debug":"^4.1.1","performance-now":"^2.1.0","superagent":"^5.1.0"},"devDependencies":{"chai":"^4.2.0","coveralls":"^3.0.6","express":"~4.16.1","http-errors":"^1.7.3","istanbul":"^0.4.5","mocha":"^6.2.0","uuid":"^3.3.3"},"gitHead":"358b8c81e3833af55c9f79426fb5b47b0600cdbc","_id":"@byrdware/rester@0.1.3","_nodeVersion":"10.16.3","_npmVersion":"6.11.2","dist":{"integrity":"sha512-YPmjG5WjeDMk9rFjbiiKiBLBPustP0/QCHXBKe/ghUCXmOKQg3jcjjL+/qKHD4vJy55EKtncfXSkMJoVj2SkPQ==","shasum":"f26d3391c74d6e9eab872c77948008f49d687301","tarball":"https://registry.npmjs.org/@byrdware/rester/-/rester-0.1.3.tgz","fileCount":13,"unpackedSize":41306,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdaVTqCRA9TVsSAnZWagAAr+0P/Av6H+YDmxXW7q/lZdKf\ndF9VSJv6ZJmXlUcScu9eGiSjTU9supKDQ3XdyJs6r/UQNCwV28F2LngkHAhu\nuCGHoapkGmGAInFIRrLEme50QsEbfbk87ZxsuFX0mW/MPgmfWz8xSSCJbzYM\nl2N/B6eJQL6lJj5RwR+31fv2fjMpEXIdKWEOkrFA5CrIuLLAMCLIKRJh0Ru5\n0PbUCOww0E9oquxk5B7yNcGE1U34Zo1DXPhwc2ySOzYir3y6eAagNVbncvcB\ns7cHSLhNUTdqqcemf9LD98WAAKZxoKowTjvr3v9uNjVVd7gzsH6X733t+Gh0\n9yHE2SMKCzb/6StcbCGnqua/Ub+BbSEEEd9z/gsU2gwPYrsBnqUXKmzm4vcs\n6BBSgIumyqM2FpQBre+Kbis34NOMMId4BS3Y9xletlAP16LsIqA6owrUuxXJ\nukBj9ZjunYnav+ytf6RGhEVGCjBPQPYGAc7AQdTFmjguU71+DqL7WDtUI3rm\nZTvwe7I4HNtLQTTcspkyzybslBPvpkcIOOJRG/schHczjJBVnGsb7NbGQ+uQ\nlYpOVXEQUItEgp+XkueGWoS9EtoO/btWbENYttbqb1vleOFN6Rgh9qrgBNDR\nIJpJ2X4R4f/Fza8I8k+/UlF4YhINLieRuMIQim7/0Me216nRoFyNfCgvCUhm\nWMb2\r\n=2mno\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDDMNiKC8r1lyUQnjGCn8D6cdpyYgUgcNW8NvDxPzrChgIgJGHHIoeqIEMWN9SYSBJp1nwu7K/J/x0NqPOnVLQOZls="}]},"maintainers":[{"name":"byrdware","email":"support@byrdware.org"}],"_npmUser":{"name":"byrdware","email":"support@byrdware.org"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/rester_0.1.3_1567184106214_0.580756346881532"},"_hasShrinkwrap":false}},"time":{"created":"2019-08-29T04:57:15.696Z","0.1.0":"2019-08-29T04:57:16.135Z","modified":"2022-04-04T21:20:22.896Z","0.1.1":"2019-08-29T18:03:21.847Z","0.1.2":"2019-08-29T19:50:00.115Z","0.1.3":"2019-08-30T16:55:06.300Z"},"maintainers":[{"name":"byrdware","email":"support@byrdware.org"}],"description":"REST API Test Runner","homepage":"https://github.com/byrdware/rester#readme","keywords":["cli","rester","rest","rest api","testing","unit testing"],"repository":{"type":"git","url":"git+https://github.com/byrdware/rester.git"},"author":{"name":"ByrdWare","email":"support@byrdware.org","url":"https://github.com/byrdware"},"bugs":{"url":"https://github.com/byrdware/rester/issues"},"license":"MIT","readme":"# Rester\n\nREST API Test Runner\n\n[![NPM Version](https://badge.fury.io/js/%40byrdware%2Frester.svg)](https://www.npmjs.com/package/@byrdware/rester)\n[![Build Status](https://travis-ci.org/byrdware/rester.svg?branch=master)](https://travis-ci.org/byrdware/rester)\n[![Coverage Status](https://coveralls.io/repos/github/byrdware/rester/badge.svg?branch=master)](https://coveralls.io/github/byrdware/rester?branch=master)\n[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)\n\n## Synopsis\n\nAn experimental REST API test runner that consumes a postman export file (in\nJSON or JavaScript format), then runs each and every test item in the file in\nsequential order, or optionally, a single, named item from the test.\n\n## Installation\n\n  `npm install @byrdware/rester`\n\n## Motivation\n\nTesting REST API's and microservices is tedious and time-consuming. Perhaps a\nmore thorough search is required, but no good tools have been found to easily\nand quickly automate a test script for checking and validating an API while\nunder development. This project is an attempt to solve this problem by\nproviding a simple tool, driven by an easily configured JSON/JavaScript file.\n\nInitially the format of this configuration file is simply a postman export\nfile. I am currently reviewing Insomnia export files and planning support in\na future release, pull requests are welcome.\n\n## Usage\n\n    $ rester postman ./test/test-suite.js\n    \n      Login User\n        √ POST http://localhost:3369/user/login\n      Create Records\n        √ POST http://localhost:3369/create/\n      Retrieve All Records\n        √ GET http://localhost:3369/\n      Retrieve N Records\n        √ GET http://localhost:3369/10/\n      Search for Records\n        √ GET http://localhost:3369/search\n      Update Record\n        √ PUT http://localhost:3369/update/L1SEzUhTQ3WNPyKMO1vA\n      Delete Record\n        √ DELETE http://localhost:3369/delete/uLAkVuFVWvLN1OGp21RQ\n      Logout User\n        √ GET http://localhost:3369/user/logout\n\n      Tests complete\n        8 passing (61 ms)\n\n## Command Line Options\n\nThe CLI is further configured with the following command line options:\n\n    Usage: rester [options] [command]\n\n    General Options:\n      -V, --version             Output the version number\n      -h, --help                Output usage information\n\n    Commands:\n      postman [options] <file>  Send test items from a postman export file\n\n    Postman Options:\n      -t, --test <name>         Send only named test\n\n## Getting Started\n\n```bash\nnpm install '@byrdware/rester' -D\nmkdir rest\n$EDITOR rest/simple-rest.js\n```\n\nIn your editor:\n\n```javascript\nmodule.exports = {\n  info: {\n    name: 'My Test Suite'\n  },\n  item: [{\n    name: 'Login',\n    request: {\n      method: 'POST',\n      header: [{\n        key: 'Content-Type',\n        value: 'application/json',\n      }],\n      body: {\n        raw: '{ \"email\": \"nobody@nowhere.net\", \"password\": \"0123456789abcdef\" }'\n      },\n      url: {\n        protocol: 'http',\n        host: [ 'localhost' ],\n        port: '80',\n        path: [ 'login' ]\n      }\n    }\n  }]\n};\n```\n\nRun tests from a shell:\n\n```bash\n$ ./node_modules/.bin/rester postman rest/simple-rest.js\n\n  Login\n    √ POST http://localhost:80/login\n\n  Tests complete\n    1 passing (283 ms)\n```\n\nAdd a \"rest\" script to package.json:\n\n```javascript\n\"scripts\": {\n  \"test\": \"mocha\",\n  ...\n  \"rest\": \"rester postman ./rest/simple-rest.js\"\n}\n```\n\nThen run your tests with:\n\n```bash\nnpm run rest\n```\n\n## File Format\n\nThis tool currently supports a file format with a minimal subset of the schema\ndescribed here:\n\n[https://schema.getpostman.com/json/collection/v2.1.0/collection.json](https://schema.getpostman.com/json/collection/v2.1.0/collection.json)\n\n## Unit Testing the Rester Distribution\n\nClone the github repository:\n\n```\ngit clone https://github.com/byrdware/rester.git\n```\n\nand then:\n\n```\nnpm test\n```\n\nor, alternately:\n\n```\nnode test/www\nnpm start\n```\n\n## Contributing\n\nIn lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.\n","readmeFilename":"README.md"}