Skip to content

correct readme and version bump #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 27, 2022
Merged

correct readme and version bump #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b9e26cb
correct readme and version bump
marcag3 Sep 27, 2022
2cfb55d
change owner
marcag3 Sep 27, 2022
a3bf064
Merge branch 'dev' into correct-readme
marcag3 Sep 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 34 additions & 29 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,18 +58,18 @@ const mongoose = require('mongoose');
const Widget = mongoose.Model('Widget');
const Rest = require('mongoose-rest-api');

const endpoints = Rest(Widget, 'widget_id'); // 'widget_id' is used to identify the ID parameter in our route definitions
const restApi = Rest(Widget, 'widget_id'); // 'widget_id' is used to identify the ID parameter in our route definitions

router.get('/', function(req, res, next) {
methods.get(req, res).then(result => {
restApi.get(req, res).then(result => {
return res.status(200).json(result);
}, err => {
return next(err);
});
});

router.get('/:widget_id', function(req, res, next) { // note that :widget_id matches the second argument of Rest()
endpoints.get(req, res).then(result => {
restApi.get(req, res).then(result => {
if(result) {
return res.status(200).json(result);
} else {
Expand All @@ -81,15 +81,15 @@ router.get('/:widget_id', function(req, res, next) { // note that :widget_id mat
});

router.post('/', function(req, res, next) {
endpoints.post(req, res).then(result => {
restApi.post(req, res).then(result => {
return res.status(201).json(result);
}, err => {
return next(err);
});
});

router.patch('/:widget_id', function(req, res, next) {
endpoints.patch(req, res).then(result => {
restApi.patch(req, res).then(result => {
if(result) {
return res.status(200).json(result);
} else {
Expand All @@ -101,7 +101,7 @@ router.patch('/:widget_id', function(req, res, next) {
});

router.delete('/:widget_id', function(req, res, next) {
endpoints.delete(req, res).then(result => {
restApi.delete(req, res).then(result => {
return res.status(200).json(result);
}, err => {
return res.sendStatus(200);
Expand All @@ -117,23 +117,22 @@ const express = require('express');
const router = express.Router();
const mongoose = require('mongoose');
const Widget = mongoose.Model('Widget');
const Q = require('q');
const Rest = require('mongoose-rest-api');

const endpoints = Rest(Widget, 'widget_id');
const restApi = Rest(Widget, 'widget_id');

const myPost = function(req, res) {
let deferred = Q.defer();
validate_widget(req.body).then(result => { // validate_widget() defined elsewhere
endpoints.post(req, res).then(result => deferred.resolve(result), err => deferred.reject(err));
}, err => {
deferred.reject(err);
});
return deferred.promise;
const myPost = async function(req, res, next) {
try{
let result = await validate_widget(req.body) // validate_widget() defined elsewhere
result = await restApi.post(req, res)
return result
}catch(e){
next(e)
}
}

router.post('/', function(req, res, next) {
myPost(req, res).then(result => { // Note we use myPost here instead of endpoints.post
myPost(req, res).then(result => { // Note we use myPost here instead of restApi.post
return res.status(200).json(result);
}, err => {
return next(err);
Expand All @@ -143,7 +142,7 @@ router.post('/', function(req, res, next) {

### Endpoint Composition

Using the generated endpoints, it is simple to compose them in combinations. In the following
Using the generated restApi, it is simple to compose them in combinations. In the following
Example, a Widget has a one-to-many relationship with Doodads.

```js
Expand All @@ -155,19 +154,19 @@ const Widget = mongoose.Model('Widget');
const Doodad = mongoose.Model('Doodad');
const Rest = require('mongoose-rest-api');

const widget_endpoints = Rest(Widget, 'widget_id'); // 'widget_id' is used to identify the ID parameter in our route definitions
const doodad_endpoints = Rest(Doodad, 'doodad_id'); // 'doodad_id' is used to identify the ID parameter in our route definitions
const widget_restApi = Rest(Widget, 'widget_id'); // 'widget_id' is used to identify the ID parameter in our route definitions
const doodad_restApi = Rest(Doodad, 'doodad_id'); // 'doodad_id' is used to identify the ID parameter in our route definitions

router.get('/', function(req, res, next) {
widget_endpoints.get(req, res).then(result => {
widget_restApi.get(req, res).then(result => {
return res.status(200).json(result);
}, err => {
return next(err);
});
});

router.get('/:widget_id', function(req, res, next) { // note that :widget_id matches the second argument of Rest()
widget_endpoints.get(req, res).then(result => {
widget_restApi.get(req, res).then(result => {
if(result) {
return res.status(200).json(result);
} else {
Expand All @@ -182,15 +181,15 @@ router.get('/:widget_id/doodads', function(req, res, next) {
req.query.widget = req.params.widget_id; // Here we add a query parameter which filters the results to
// Doodads with the attribute widget equal to the specified
// :widget_id
doodad_endpoints.get(req, res).then(result => {
doodad_restApi.get(req, res).then(result => {
return res.status(200).json(result);
}, err => {
return next(err);
});
});

router.get('/:widget_id/doodads/:doodad_id', function(req, res, next) {
doodad_endpoints.get(req, res).then(result => {
doodad_restApi.get(req, res).then(result => {
if(result) {
if(result.widget != req.params.widget_id) return res.status(400).json({"error": "Doodad does not belong to specified Widget!"})
return res.status(200).json(result);
Expand All @@ -203,7 +202,7 @@ router.get('/:widget_id/doodads/:doodad_id', function(req, res, next) {
});

router.post('/', function(req, res, next) {
widget_endpoints.post(req, res).then(result => {
widget_restApi.post(req, res).then(result => {
return res.status(201).json(result);
}, err => {
return next(err);
Expand All @@ -213,9 +212,9 @@ router.post('/', function(req, res, next) {
// In this example, each widget is only allowed a maximum number of Doodads. Our logic ensures this limit is not exceeded

router.post('/:widget_id/doodads', function(req, res, next) {
widget_endpoints.get(req, res).then(result => {
widget_restApi.get(req, res).then(result => {
if(widget.max_doodads == widget.doodads.length) return res.status(400).json({"error": "Widget is already at Doodad limit"})
doodad_endpoints.post(req, res).then(result => {
doodad_restApi.post(req, res).then(result => {
return res.status(201).json(result);
}, err => {
return next(err);
Expand All @@ -228,7 +227,7 @@ router.post('/:widget_id/doodads', function(req, res, next) {
});

router.patch('/:widget_id', function(req, res, next) {
widget_endpoints.patch(req, res).then(result => {
widget_restApi.patch(req, res).then(result => {
if(result) {
return res.status(200).json(result);
} else {
Expand All @@ -240,7 +239,7 @@ router.patch('/:widget_id', function(req, res, next) {
});

router.delete('/:widget_id', function(req, res, next) {
widget_endpoints.delete(req, res).then(result => {
widget_restApi.delete(req, res).then(result => {
return res.status(200).json(result);
}, err => {
return res.sendStatus(200);
Expand All @@ -250,6 +249,12 @@ router.delete('/:widget_id', function(req, res, next) {

## Changelog

**1.3.0**

- Replace usage of count for countDocuments
- Update dependencies
- remove Q dependency

**1.2.5**

- Security update. Updated mongodb-memory-server to version 8.0.1
Expand Down
8 changes: 4 additions & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "mongoose-rest-api",
"version": "1.2.5",
"version": "1.3.0",
"description": "REST API generator for Mongoose models",
"main": "index.js",
"scripts": {
"test": "mocha"
},
"repository": {
"type": "git",
"url": "git+https://github.com/jurassic-c/mongoose-rest-api.git"
"url": "git+https://github.com/DevActif/mongoose-rest-api.git"
},
"keywords": [
"mongoose",
Expand All @@ -18,9 +18,9 @@
"author": "Colby Sollars",
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/jurassic-c/mongoose-rest-api/issues"
"url": "https://github.com/DevActif/mongoose-rest-api/issues"
},
"homepage": "https://github.com/jurassic-c/mongoose-rest-api#readme",
"homepage": "https://github.com/DevActif/mongoose-rest-api#readme",
"engines" : {
"npm" : ">=8.0.0",
"node" : ">=16.0.0"
Expand Down