About

Links

Team Members

Maxime Dore Gabrielle Williams Zhu Chen Jana Ryndin

Tasks

Make an app that can be used to create custom surveys and collect the responses on a dashboard for that particular survey. Use MongoDB and Express to build an API and create 2 related models. Include all crud functions in RESTful API for the survey model

User Stories

####As a user I want to:

Create a survey
Add questions to my sureys
Anwer anyone's survey questions
Have a statistic about surveys

About

Thank you for visiting our back end repository! This app was built as part of the course's team project.

Our team has seen a survey as a great tool to gather information about business ideas - how well could be taken before even starting the business planning. Our back end repository allows it's front end to have authorization, and to create, read, update, and delete users, surveys, questions, and answers.

The model we have agreed on was that the user creates many surveys, survey creates many questions. Questions will have only 2 bulean answers that can be easily tracked for statistics.

We designed this app with a friendly user flow while not forgetting a clean responsive design and functionality without user errors. As a result, a user can comfortably sign up/sign in, create an own survey or fill a survey of others. Each survey can have an unlimited number of closed type questions therefore the answers are always yes/no. We decided to go this direction for better collecting of responses from users.

This survey team project back end allows it's front end to have authorization, and to create, read, update, and delete users, surveys, questions, and answers. The surveys are created using a nested schema, which has questions nested inside the survey schema and answers nested inside of the quesstion schema. Having schemas nested like this made the project difficult because information was being stored in an array, inside an array, inside an array etc.

The survey model is as follows,

const answerSchema = new mongoose.Schema({
  response: {
    type: Boolean,
    required: false,
  }
});

const questionSchema = new mongoose.Schema({
  problem: {
    type: String,
    required: false,
  },
  answers: [answerSchema]
});

const surveySchema = new mongoose.Schema({
  title: {
    type: String,
    required: true,
    unique: true,
  },
  _owner: {
    type: mongoose.Schema.Types.ObjectId,
    ref: 'User',
    required: true,
  },
  questions: [questionSchema]
}, {
  timestamps: true,
  toJSON: {
    virtuals: true,
    transform: function (doc, ret, options) {
      let userId = (options.user && options.user._id) || false;
      ret.editable = userId && userId.equals(doc._owner);
      return ret;
    },
  },
});

The Create, Read, and Destroy actions were easy to tackle but our team worked on the update survey action for hours. To add questions to a survey and to submit answers for the survey require the update action, so our team needed to spend a lot of time on viewing how information that was stored in arrays inside of arrays could be accessed and also updated. We had to log different parts of the array to find out where the information was being stored and what piece of the array we needed.

We started with an update function like this,

const update = (req, res, next) => {
  // console.log('UPDATE');
    // disallow owner reassignment.

  Survey.findById(req.params.id, function(err, survey) {
    // Handle any possible database errors
    // console.log(survey.questions.length);
    // console.log((survey.questions).push(req.body.survey.questions));
    if (err) {
      res.status(422).send(err);
    } else {
      // Update each attribute with any possible attribute that may have been submitted in the body of the request
      // If that attribute isn't in the request body, default back to whatever it was before.

      // make an if to see if ownership is needed. If so, only create question

      // console.log(survey.questions[0].answers[0]);
      // console.log("survey answer is ", survey.questions[0].answers[0]);
      // console.log("request answer is ", req.body.survey.questions[0].answers);


      // console.log(survey._owner == req.user.id);

      if (survey._owner == req.user.id) {
        survey.questions[survey.questions.length] = req.body.survey.questions;

      } else {

        for (let i = 0; i < survey.questions.length; i++) {
          let newAnswers = survey.questions[i].answers.length;
          survey.questions[i].answers[newAnswers] = survey.questions[i].answers[newAnswers] || req.body.survey.questions[i].answers;
        }

      }
    }

    // Save the updated document back to the database
    survey.save(function(err, survey) {
      if (err) {
        res.status(500).send(err);
      }
      res.send(survey);
    });

  });
};

but this was causing errors and crashing the server because there were undefined pieces of the array we were trying to pull information from. In the end, our final update function was as follows,

const update = (req, res, next) => {
    // disallow owner reassignment.

  Survey.findById(req.params.id, function(err, survey) {
    // Handle any possible database errors
    if (err) {
      res.status(422).send(err);
    } else {

      // Update each attribute with any possible attribute that may have been submitted in the body of the request
      // If that attribute isn't in the request body, default back to whatever it was before.
      if (survey._owner == req.user.id) {

        survey.questions[survey.questions.length] = req.body.survey.questions;

      } else {

        if ('survey' in req.body) {
          if ('questions' in req.body.survey) {

            if (survey.questions.length===req.body.survey.questions.length) {

              let allDefined = 0;
              for (let k = 0; k < survey.questions.length; k++) {
                if (req.body.survey.questions[k].answers.response!==undefined){
                  allDefined++;
                }
              }

              if (allDefined === survey.questions.length){
                for (let i = 0; i < survey.questions.length; i++) {
                  let newAnswers = survey.questions[i].answers.length;
                  survey.questions[i].answers[newAnswers] = survey.questions[i].answers[newAnswers] || req.body.survey.questions[i].answers;
                }
              }
            }

          }
        }

      }
    }

    // Save the updated document back to the database
    survey.save(function(err, survey) {
      if (err) {
        res.status(500).send(err);
      }
      res.send(survey);
    });

  });
};

API Structure

The MongoDB database has two tables: users and surveys. The users table covers authentication and provides user ID for ownership of individual users' surveys. The surveys table takes a name, address, type, and notes fields. All newly created surveys have an "achieved" field that defaults to "false", but can be updated to "true" when the restaurant is visited.

Authentication

Verb	URI Pattern	Controller#Action
POST	`/sign-up`	`users#signup`
POST	`/sign-in`	`users#signin`
PATCH	`/change-password/:id`	`users#changepw`
DELETE	`/sign-out/:id`	`users#signout`

POST / sign-up

API="http://localhost:4741"
URL_PATH="/sign-up"

curl "${API}${URL_PATH}" \
  --include \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{
    "credentials": {
      "email": "'"${EMAIL}"'",
      "password": "'"${PASSWORD}"'",
      "password_confirmation": "'"${PASSWORD}"'"
    }
  }'

response

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8

{
  "user": {
    "id": 58c9b10638cd05fc5caa07ba,
    "email": "[email protected]"
  }
}

POST / sign-in

API="http://localhost:4741"
URL_PATH="/sign-in"

curl "${API}${URL_PATH}" \
  --include \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{
    "credentials": {
      "email": "'"${EMAIL}"'",
      "password": "'"${PASSWORD}"'"
    }
  }'

EMAIL='[email protected]' PASSWORD='max' sh scripts/sign-in.sh

response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "user": {
    "id": 58c9b10638cd05fc5caa07ba,
    "email": "[email protected]"
    "token": "YrNiW55CmLrhXR75TVeYMwOKBFOhqQ1e6FfmUCdgJWg=--wKFI9JQP1nfLCW7+4VluW1NUq45mK5slQtnSRf5IqXA="
  }
}

DELETE / sign-out

API="http://localhost:4741"
URL_PATH="/sign-out"

curl "${API}${URL_PATH}/${ID}" \
  --include \
  --request DELETE \
  --header "Content-Type: application/json" \
  --header "Authorization: Token token=$TOKEN"

ID=58c9b10638cd05fc5caa07ba TOKEN='YrNiW55CmLrhXR75TVeYMwOKBFOhqQ1e6FfmUCdgJWg=--wKFI9JQP1nfLCW7+4VluW1NUq45mK5slQtnSRf5IqXA=' sh scripts/sign-out.sh

response

HTTP/1.1 204 No Content

PATCH / change password

API="http://localhost:4741"
URL_PATH="/change-password"

curl "${API}${URL_PATH}/${ID}" \
  --include \
  --request PATCH \
  --header "Authorization: Token token=${TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{
    "passwords": {
      "old": "'"${OLDPW}"'",
      "new": "'"${NEWPW}"'"
    }
  }'

ID=58c9b10638cd05fc5caa07ba OLDPW='max' NEWPW='m' TOKEN='YrNiW55CmLrhXR75TVeYMwOKBFOhqQ1e6FfmUCdgJWg=--wKFI9JQP1nfLCW7+4VluW1NUq45mK5slQtnSRf5IqXA=' sh scripts/change-password.sh

response

HTTP/1.1 204 No Content

Surveys

Verb	URI Pattern	Controller#Action
POST	`/surveys`	`survey#create`
GET	`/surveys`	`surveys#index`
GET	`/surveys/:id`	`surveys#show`
PATCH	`/surveys/:id`	`surveys#update`
DELETE	`/surveys/:id`	`surveys#destroy`

POST / survey create

#!/bin/bash

API="http://localhost:4741"
URL_PATH="/surveys"

curl "${API}${URL_PATH}" \
  --include \
  --request POST \
  --header "Content-Type: application/json" \
  --header "Authorization: Token token=${TOKEN}" \
  --data '{
    "survey":{
      "title": "ananan"
    }
  }'

echo

TOKEN="aHkOLxDmOlUawYaPDFJZx/LZM77rYLx/rc6tXb1sp2c=--7XJ1hXhSE17ghaYrHRrs/GFVmoRVd/BNptpd6uEOMoc=" sh scripts/survey-create.sh

response

HTTP/1.1 201 Created

{"survey":{"__v":0,"updatedAt":"2017-03-22T21:20:09.792Z","createdAt":"2017-03-22T21:20:09.792Z","title":"ananan","_owner":"58c049f433600f6cbd2589bf","_id":"58d2ea89ee5b1e78c7990165","questions":[],"id":"58d2ea89ee5b1e78c7990165","editable":true}}

GET / survey index

API="http://localhost:4741"
URL_PATH="/surveys"

curl "${API}${URL_PATH}" \
  --include \
  --request GET \
  --header "Authorization: Token token=${TOKEN}"

TOKEN="3fj7+6/gndFDGBaH/heDRYxnqhVdX5yfQC92BcPI4E4=--oQB/Y4jk0/UxUzvOUAh2+iI5nms+m1IQkusy6792bl0=" sh scripts/survey-index.sh

response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"surveys":[{"_id":"58d2ef91ee5b1e78c799016c","updatedAt":"2017-03-22T21:41:37.676Z","createdAt":"2017-03-22T21:41:37.676Z","title":"ananan","_owner":"58c049f433600f6cbd2589bf","__v":0,"questions":[],"id":"58d2ef91ee5b1e78c799016c","editable":true}]}

GET / survey show

API="http://localhost:4741"
URL_PATH="/surveys"

curl "${API}${URL_PATH}/${ID}" \
  --include \
  --request GET \
  --header "Authorization: Token token=${TOKEN}" \

TOKEN="3fj7+6/gndFDGBaH/heDRYxnqhVdX5yfQC92BcPI4E4=--oQB/Y4jk0/UxUzvOUAh2+iI5nms+m1IQkusy6792bl0=" ID="58d2ef91ee5b1e78c799016c" sh scripts/survey-show.sh

response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"survey":{"_id":"58d2ef91ee5b1e78c799016c","updatedAt":"2017-03-22T21:41:37.676Z","createdAt":"2017-03-22T21:41:37.676Z","title":"ananan","_owner":"58c049f433600f6cbd2589bf","__v":0,"questions":[],"id":"58d2ef91ee5b1e78c799016c","editable":true}}

PATCH / survey update, add question

Ran same script but changed questions and both questions were added to the survey

#!/bin/bash

API="http://localhost:4741"
URL_PATH="/surveys"

curl "${API}${URL_PATH}/${ID}" \
  --include \
  --request PATCH \
  --header "Content-Type: application/json" \
  --header "Authorization: Token token=${TOKEN}" \
  --data '{
    "survey": {
      "questions": {
        "problem": "Is it raining?"
      }
    }
  }'

echo

#!/bin/bash

API="http://localhost:4741"
URL_PATH="/surveys"

curl "${API}${URL_PATH}/${ID}" \
  --include \
  --request PATCH \
  --header "Content-Type: application/json" \
  --header "Authorization: Token token=${TOKEN}" \
  --data '{
    "survey": {
      "questions": {
        "problem": "Is it sunny?"
      }
    }
  }'

echo

TOKEN="aHkOLxDmOlUawYaPDFJZx/LZM77rYLx/rc6tXb1sp2c=--7XJ1hXhSE17ghaYrHRrs/GFVmoRVd/BNptpd6uEOMoc=" ID="58d2ea89ee5b1e78c7990165" sh scripts/survey-question-update.sh

response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"_id":"58d2ea89ee5b1e78c7990165","updatedAt":"2017-03-22T21:23:14.321Z","createdAt":"2017-03-22T21:20:09.792Z","title":"ananan","_owner":"58c049f433600f6cbd2589bf","__v":2,"questions":[{"problem":"Is it sunny?","_id":"58d2eb2fee5b1e78c7990166","answers":[]},{"problem":"Is it raining?","_id":"58d2eb42ee5b1e78c7990167","answers":[]}],"id":"58d2ea89ee5b1e78c7990165","editable":false}

PATCH / same survey, answer update

To answer survey questions, need to sign in as different user because the author of the survey cannot answer the questions.

#!/bin/bash

API="http://localhost:4741"
URL_PATH="/surveys"

curl "${API}${URL_PATH}/${ID}" \
  --include \
  --request PATCH \
  --header "Content-Type: application/json" \
  --header "Authorization: Token token=${TOKEN}" \
  --data '{
    "survey": {
      "questions": [{
        "answers": {
          "response": false
        }
      },
      {
        "answers": {
          "response": false
        }
      }

      ]
    }
  }'

echo

 TOKEN="hB5EzZ534us5Ri0qHB/3PJ9dIAHn8SMG9Tzmp51s3b8=--Zm3f+C1QHyAkc8H/zMH8vLD2LyWMGI6MwMldx0t7tPA=" ID="58d2ea89ee5b1e78c7990165" sh scripts/survey-answer-update.sh

response

HTTP/1.1 200 OK

{"_id":"58d2ea89ee5b1e78c7990165","updatedAt":"2017-03-22T21:25:48.280Z","createdAt":"2017-03-22T21:20:09.792Z","title":"ananan","_owner":"58c049f433600f6cbd2589bf","__v":3,"questions":[{"problem":"Is it sunny?","_id":"58d2eb2fee5b1e78c7990166","answers":[{"response":false,"_id":"58d2ebdcee5b1e78c799016a"}]},{"problem":"Is it raining?","_id":"58d2eb42ee5b1e78c7990167","answers":[{"response":false,"_id":"58d2ebdcee5b1e78c799016b"}]}],"id":"58d2ea89ee5b1e78c7990165","editable":false}

DELETE / survey destroy

API="http://localhost:4741"
URL_PATH="/surveys"

curl "${API}${URL_PATH}/${ID}" \
  --include \
  --request DELETE \
  --header "Authorization: Token token=${TOKEN}"

TOKEN="3fj7+6/gndFDGBaH/heDRYxnqhVdX5yfQC92BcPI4E4=--oQB/Y4jk0/UxUzvOUAh2+iI5nms+m1IQkusy6792bl0=" ID="58d2ea89ee5b1e78c7990165" sh scripts/survey-destroy.sh

response

HTTP/1.1 204 No Content

Routes

GET - Index, Show POST - Create PATCH - update DELETE - Destroy

Users are only: ['index', 'show'] Surveys are only: ['index', 'create', 'show', 'update', 'destroy']

Name		Name	Last commit message	Last commit date
Latest commit History 65 Commits
app		app
bin		bin
config		config
grunt		grunt
lib		lib
public		public
scripts		scripts
spec		spec
.editorconfig		.editorconfig
.gitignore		.gitignore
.jscsrc		.jscsrc
.jshintignore		.jshintignore
.jshintrc		.jshintrc
.remarkrc		.remarkrc
CONTRIBUTING.md		CONTRIBUTING.md
ERD1.jpg		ERD1.jpg
ERD2.JPG		ERD2.JPG
Gruntfile.js		Gruntfile.js
LICENSE		LICENSE
README.md		README.md
STYLE.md		STYLE.md
package.json		package.json
server.js		server.js
settings		settings

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Links

Team Members

Tasks

User Stories

About

API Structure

Authentication

POST / sign-up

POST / sign-in

DELETE / sign-out

PATCH / change password

Surveys

POST / survey create

GET / survey index

GET / survey show

PATCH / survey update, add question

PATCH / same survey, answer update

DELETE / survey destroy

Routes

About

Releases

Packages

Contributors 2

Languages

License

GZMJ-Survey/express-api-survey

Folders and files

Latest commit

History

Repository files navigation

Links

Team Members

Tasks

User Stories

About

API Structure

Authentication

POST / sign-up

POST / sign-in

DELETE / sign-out

PATCH / change password

Surveys

POST / survey create

GET / survey index

GET / survey show

PATCH / survey update, add question

PATCH / same survey, answer update

DELETE / survey destroy

Routes

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Contributors 2

Languages

Packages