Домашнее задание 2

GoIT Node.js Course Template Homework

Выполните форк этого репозитория для выполнения домашних заданий (2-6) Форк создаст репозиторий на вашем http://github.com

Добавьте ментора в коллаборацию

Для каждой домашней работы создавайте свою ветку.

hw02
hw03
hw04
hw05
hw06

Каждая новая ветка для дз должна делаться с master

После того как вы закончили выполнять домашнее задание в своей ветке, необходимо сделать пулл-реквест (PR). Потом добавить ментора для ревью кода. Только после того как ментор заапрувит PR, вы можете выполнить мердж ветки с домашним заданием в мастер.

Внимательно читайте комментарии ментора. Исправьте замечания и сделайте коммит в ветке с домашним заданием. Изменения подтянуться в PR автоматически после того как вы отправите коммит с исправлениями на github После исправления снова добавьте ментора на ревью кода.

При сдаче домашней работы есть ссылка на PR
JS-код чистый и понятный, для форматирования используется Prettier

Команды:

npm start — старт сервера в режиме production
npm run start:dev — старт сервера в режиме разработки (development)
npm run lint — запустить выполнение проверки кода с eslint, необходимо выполнять перед каждым PR и исправлять все ошибки линтера
npm lint:fix — та же проверка линтера, но с автоматическими исправлениями простых ошибок

Домашнее задание 2

Создай форк репозитория в свой github аккаунт.

Посмотри поясняющее видео как это сделать и сдавать ДЗ правильно.

Написать REST API для работы с коллекцией контактов. Для работы с REST API используй Postman.

Прочитай внимательно readme в клонированном бойлерплейте, там описан механизм сдачи домашних заданий. Приступай к выполнению ДЗ

Шаг 1

Создай ветку hw02-express из ветки master.

Установи модули командой:

npm i

Следующие модули уже есть в проекте:

Шаг 2

В app.js – веб сервер на express, добавлены прослойки morgan и cors. Начни настраивать раутинг для работы с коллекцией контактов.

REST API должен поддерживать следующие рауты.

@ GET /api/contacts

ничего не получает
вызывает функцию listContacts для работы с json-файлом contacts.json
возвращает массив всех контактов в json-формате со статусом 200

@ GET /api/contacts/:id

Не получает body
Получает параметр id
вызывает функцию getById для работы с json-файлом contacts.json
если такой id есть, возвращает объект контакта в json-формате со статусом 200
если такого id нет, возвращает json с ключом "message": "Not found" и статусом 404

@ POST /api/contacts

Получает body в формате {name, email, phone} (все поля обязательны)
Если в body нет каких-то обязательных полей, возвращает json с ключом {"message": "missing required name field"} и статусом 400
Если с body все хорошо, добавляет уникальный идентификатор в объект контакта
Вызывает функцию addContact(body) для сохранения контакта в файле contacts.json
По результату работы функции возвращает объект с добавленным id {id, name, email, phone} и статусом 201

@ DELETE /api/contacts/:id

Не получает body
Получает параметр id
вызывает функцию removeContact для работы с json-файлом contacts.json
если такой id есть, возвращает json формата {"message": "contact deleted"} и статусом 200
если такого id нет, возвращает json с ключом "message": "Not found" и статусом 404

@ PUT /api/contacts/:id

Получает параметр id
Получает body в json-формате c обновлением любых полей name, email и phone
Если body нет, возвращает json с ключом {"message": "missing fields"} и статусом 400
Если с body все хорошо, вызывает функцию updateContact(contactId, body) (напиши ее) для обновления контакта в файле contacts.json
По результату работы функции возвращает обновленный объект контакта и статусом 200. В противном случае, возвращает json с ключом "message": "Not found" и статусом 404

Шаг 3

Для маршрутов, что принимают данные (POST, PUT, PATCH), продумайте проверку (валидацию) принимаемых данных. Для валидации принимаемых данных используйте пакет joi

Критерии приема дз #2-6

Создан репозиторий с домашним заданием — REST API приложение
При создании репозитория использован бойлерплейт
Пулл-реквест (PR) с соответствующим дз отправлен ментору в schoology на проверку (ссылка на PR)
Код соответствует техническому заданию проекта
При выполнении кода не возникает необработанных ошибок
Название переменных, свойств и методов начинается со строчной буквы и записываются в нотации CamelCase. Используются английские существительные
Название функции или метода содержит глагол
В коде нет закомментированных участков кода
Проект корректно работает в актуальной LTS-версии Node

Домашнее задание 3

Создай ветку hw03-mongodb из ветки master.

Продолжи создание REST API для работы с коллекцией контактов.

Шаг 1

Создай аккаунт на MongoDB Atlas. После чего в аккаунте создай новый проект и настрой бесплатный кластер. Во время настройки кластера выбери провайдера и регион как на скриншоте ниже. Если выбрать слишком удаленный регион, скорость ответа сервера будет дольше.

Шаг 2

Установи графический редактор MongoDB Compass для удобной работы с базой данных для MongoDB. Настрой подключение своей облачной базы данных к Compass. В MongoDB Atlas не забудь создать пользователя с правами администратора.

Шаг 3

Через Compass создай базу данных db-contacts и в ней коллекцию contacts. Возьми ссылка на json и при помощи Compass наполни коллекцию contacts (сделай импорт) его содержимым.

Если вы все сделали правильно, данные должны появиться в вашей базе в коллекции contacts

Шаг 4

Используйте исходный код домашней работы #2 и замените хранение контактов из json-файла на созданную вами базу данных.

Напишите код для создания подключения к MongoDB при помощи Mongoose.
При успешном подключении выведите в консоль сообщение "Database connection successful".
Обязательно обработайте ошибку подключения. Выведите в консоль сообщение ошибки и завершите процесс используя process.exit(1).
В функциях обработки запросов замените код CRUD-операций над контактами из файла, на Mongoose-методы для работы с коллекцией контактов в базе данных.

Схема модели для коллекции contacts:

  {
    name: {
      type: String,
      required: [true, 'Set name for contact'],
    },
    email: {
      type: String,
    },
    phone: {
      type: String,
    },
    favorite: {
      type: Boolean,
      default: false,
    },
  }

Шаг 5

У нас появилось в контактах дополнительное поле статуса favorite, которое принимает логическое значение true или false. Оно отвечает за то, что в избранном или нет находится указанный контакт. Реализуй для обновления статуса контакта новый маршрут

@ PATCH /api/contacts/:contactId/favorite

Получает параметр contactId
Получает body в json-формате c обновлением поля favorite
Если body нет, возвращает json с ключом {"message": "missing field favorite"} и статусом 400
Если с body все хорошо, вызывает функцию updateStatusContact(contactId, body) (напиши ее) для обновления контакта в базе
По результату работы функции возвращает обновленный объект контакта и статусом 200. В противном случае, возвращает json с ключом "message": "Not found" и статусом 404

Для роута POST /api/contacts внесите изменения: если поле favorite не указали в body, то при сохранении в базу нового контакта, сделайте поле favorite равным по умолчанию false. Не забываем про валидацию данных!

Домашнее задание 4

Создайте ветку hw04-auth из ветки master.

Продолжите создание REST API для работы с коллекцией контактов. Добавьте логику аутентификации/авторизации пользователя с помощью JWT.

Шаг 1

В коде создайте схему и модель пользователя для коллекции users.

{
  password: {
    type: String,
    required: [true, 'Password is required'],
  },
  email: {
    type: String,
    required: [true, 'Email is required'],
    unique: true,
  },
  subscription: {
    type: String,
    enum: ["starter", "pro", "business"],
    default: "starter"
  },
  token: {
    type: String,
    default: null,
  },
}

Чтобы каждый пользователь работал и видел только свои контакты в схеме контактов добавьте свойство owner

    owner: {
      type: SchemaTypes.ObjectId,
      ref: 'user',
    }

Примечание: 'user' - название коллекции (в единственном числе), в которой хранятся пользователи.

Шаг 2

Регистрация

Создайте эндпоинт /users/signup

Сделать валидацию всех обязательных полей (email и password). При ошибке валидации вернуть Ошибку валидации.

В случае успешной валидации в модели User создать пользователя по данным которые прошли валидацию. Для засолки паролей используй bcrypt или bcryptjs

Если почта уже используется кем-то другим, вернуть Ошибку Conflict.
В противном случае вернуть Успешный ответ.

Registration request

POST /users/signup
Content-Type: application/json
RequestBody: {
  "email": "example@example.com",
  "password": "examplepassword"
}

Registration validation error

Status: 400 Bad Request
Content-Type: application/json
ResponseBody: <Ошибка от Joi или другой библиотеки валидации>

Registration conflict error

Status: 409 Conflict
Content-Type: application/json
ResponseBody: {
  "message": "Email in use"
}

Registration success response

Status: 201 Created
Content-Type: application/json
ResponseBody: {
  "user": {
    "email": "example@example.com",
    "subscription": "starter"
  }
}

Логин

Создайте эндпоинт /users/login

В модели User найти пользователя по email.

Сделать валидацию всех обязательных полей (email и password). При ошибке валидации вернуть Ошибку валидации.

В противном случае, сравнить пароль для найденного юзера, если пароли совпадают создать токен, сохранить в текущем юзере и вернуть Успешный ответ.
Если пароль или email неверный, вернуть Ошибку Unauthorized.

Login request

POST /users/login
Content-Type: application/json
RequestBody: {
  "email": "example@example.com",
  "password": "examplepassword"
}

Login validation error

Status: 400 Bad Request
Content-Type: application/json
ResponseBody: <Ошибка от Joi или другой библиотеки  валидации>

Login success response

Status: 200 OK
Content-Type: application/json
ResponseBody: {
  "token": "exampletoken",
  "user": {
    "email": "example@example.com",
    "subscription": "starter"
  }
}

Login auth error

Status: 401 Unauthorized
ResponseBody: {
  "message": "Email or password is wrong"
}

Шаг 3

Проверка токена

Создайте мидлвар для проверки токена и добавь его ко всем маршрутам, которые должны быть защищены.

Мидлвар берет токен из заголовков Authorization, проверяет токен на валидность.
В случае ошибки вернуть Ошибку Unauthorized.
Если валидация прошла успешно, получить из токена id пользователя. Найти пользователя в базе данных по этому id.
Если пользователь существует и токен совпадает с тем, что находится в базе, записать его данные в req.user и вызвать методnext().
Если пользователя с таким id не существует или токены не совпадают, вернуть Ошибку Unauthorized

Middleware unauthorized error

Status: 401 Unauthorized
Content-Type: application/json
ResponseBody: {
  "message": "Not authorized"
}

Шаг 4

Логаут

Создайте ендпоинт /users/logout

Добавьте в маршрут мидлвар проверки токена.

В модели User найти пользователя по _id.
Если пользователя не существует вернуть Ошибку Unauthorized.
В противном случае, удалить токен в текущем юзере и вернуть Успешный ответ.

Logout request

GET /users/logout
Authorization: "Bearer {{token}}"

Logout unauthorized error

Status: 401 Unauthorized
Content-Type: application/json
ResponseBody: {
  "message": "Not authorized"
}

Logout success response

Status: 204 No Content

Шаг 5

Текущий пользователь - получить данные юзера по токену

Создайте эндпоинт /users/current

Добавьте в маршрут мидлвар проверки токена.

Если пользователя не существует вернуть Ошибку Unauthorized
В противном случае вернуть Успешный ответ

Current user request

GET /users/current
Authorization: "Bearer {{token}}"

Current user unauthorized error

Status: 401 Unauthorized
Content-Type: application/json
ResponseBody: {
  "message": "Not authorized"
}

Current user success response

Status: 200 OK
Content-Type: application/json
ResponseBody: {
  "email": "example@example.com",
  "subscription": "starter"
}

Дополнительное задание - необязательное

Сделать пагинацию для коллекции контактов (GET /contacts?page=1&limit=20).
Сделать фильтрацию контактов по полю избранного (GET /contacts?favorite=true)
Обновление подписки (subscription) пользователя через эндпоинт PATCH /users. Подписка должна иметь одно из следующих значений ['starter', 'pro', 'business']

Домашнее задание 5

Создай ветку hw05-avatars из ветки master.

Продолжи создание REST API для работы с коллекцией контактов. Добавь возможность загрузки аватарки пользователя через Multer.

Шаг 1

Создай папку public для раздачи статики. В этой папке сделай папку avatars. Настрой Express на раздачу статических файлов из папки public.

Положи любое изображение в папку public/avatars и проверь что раздача статики работает. При переходе по такому URL браузер отобразит изображение.

http://localhost:<порт>/avatars/<имя файла с расширением>

Шаг 2

В схему пользователя добавь новое свойство avatarURL для хранения изображения.

{
  ...
  avatarURL: String,
  ...
}

Используй пакет gravatar для того чтобы при регистрации нового пользователя сразу сгенерить ему аватар по его email.

Шаг 3

При регистрации пользователя:

Создавай ссылку на аватарку пользователя с помощью gravatar
Полученный URL сохрани в поле avatarURL во время создания пользователя

Шаг 4

Добавь возможность обновления аватарки, создав эндпоинт /users/avatars и используя метод PATCH.

# Запрос
PATCH /users/avatars
Content-Type: multipart/form-data
Authorization: "Bearer {{token}}"
RequestBody: загруженный файл

# Успешный ответ
Status: 200 OK
Content-Type: application/json
ResponseBody: {
  "avatarURL": "тут будет ссылка на изображение"
}

# Неуспешный ответ
Status: 401 Unauthorized
Content-Type: application/json
ResponseBody: {
  "message": "Not authorized"
}

Создай папку tmp в корне проекта и сохраняй в неё загруженную аватарку.
Обработай аватарку пакетом jimp и задай для нее размеры 250 на 250
Перенеси аватарку пользователя из папки tmp в папку public/avatars и дай ей уникальное имя для конкретного пользователя.
Полученный URL /avatars/<имя файла с расширением> сохрани в поле avatarURL пользователя

Дополнительное задание - необязательное

1. Написать unit-тесты для контроллера входа (login/signin)

При помощи Jest

ответ должен иметь статус-код 200
в ответе должен возвращаться токен
в ответе должен возвращаться объект user с 2 полями email и subscription, имеющие тип данных String

Домашнее задание 6

Создай ветку hw06-email из ветки master.

Продолжаем создание REST API для работы с коллекцией контактов. Добавьте верификацию email пользователя после регистрации при помощи сервиса SendGrid.

Как процесс верификации должен работать

После регистрации, пользователь должен получить письмо на указанную при регистрации почту с ссылкой для верификации своего email
Пройдя ссылке в полученном письме, в первый раз, пользователь должен получить Ответ со статусом 200, что будет подразумевать успешную верификацию email
Пройдя по ссылке повторно пользователь должен получить Ошибку со статусом 404

Шаг 1

Подготовка интеграции с SendGrid API

Зарегистрируйся на SendGrid.
Создай email-отправителя. Для это в административной панели SendGrid зайдите в меню Marketing в подменю senders и в правом верхнем углу нажмите кнопку "Create New Sender". Заполните необходимые поля в предложенной форме. Сохраните. Должен получится следующий как на картинке результат, только с вашим email:

На указанный email должно прийти письмо верификации (проверьте спам если не видите письма). Кликните на ссылку в нем и завершите процесс. Результат должен изменится на:

Теперь необходимо создать API токен доступа. Выбираем меню "Email API", и подменю "Integration Guide". Здесь выбираем "Web API"

Дальше необходимо выбрать технологию Node.js

На третьем шаге даем имя нашему токену. Например systemcats, нажимаем кнопку сгенерировать и получаем результат как на скриншоте ниже. Необходимо скопировать этот токен (это важно, так как больше вы не сможете его посмотреть). После завершить процесс создания токена

Полученный API-токен надо добавить в .env файл в нашем проекте

Шаг 2

Создание ендпоинта для верификации email'а

добавить в модель User два поля verificationToken и verify. Значение поля verify равное false будет означать, что его email еще не прошел верификацию

{
  verify: {
    type: Boolean,
    default: false,
  },
  verificationToken: {
    type: String,
    required: [true, 'Verify token is required'],
  },
}

создать эндпоинт GET /users/verify/:verificationToken, где по параметру verificationToken мы будем искать пользователя в модели User
если пользователь с таким токеном не найден, необходимо вернуть Ошибку 'Not Found'
если пользователь найден - устанавливаем verificationToken в null, а поле verify ставим равным true в документе пользователя и возвращаем Успешный ответ

Verification request

GET /auth/verify/:verificationToken

Verification user Not Found

Status: 404 Not Found
ResponseBody: {
  message: 'User not found'
}

Verification success response

Status: 200 OK
ResponseBody: {
  message: 'Verification successful',
}

Шаг 3

Добавление отправки email пользователю с ссылкой для верификации

При создания пользователя при регистрации:

создать verificationToken для пользователя и записать его в БД (для генерации токена используйте пакет uuid или nanoid)
отправить email на почту пользователя и указать ссылку для верификации email'а (/users/verify/:verificationToken) в сообщении
Так же необходимо учитывать, что теперь логин пользователя не разрешен при не верифицированном email

Шаг 4

Добавление повторной отправки email пользователю с ссылкой для верификации

Необходимо предусмотреть, вариант, что пользователь может случайно удалить письмо. Оно может не дойти по какой-то причине к адресату. Наш сервис отправки писем во время регистрации выдал ошибку и т.д.

@ POST /users/verify/

Получает body в формате { email }
Если в body нет обязательного поля email, возвращает json с ключом {"message": "missing required field email"} и статусом 400
Если с body все хорошо, выполняем повторную отправку письма с verificationToken на указанный email, но только если пользователь не верифицирован
Если пользователь уже прошел верификацию отправить json с ключом { message: "Verification has already been passed"} со статусом 400 Bad Request

Resending a email request

POST /users/verify
Content-Type: application/json
RequestBody: {
  "email": "example@example.com"
}

Resending a email validation error

Status: 400 Bad Request
Content-Type: application/json
ResponseBody: <Ошибка от Joi или другой библиотеки валидации>

Resending a email success response

Status: 200 Ok
Content-Type: application/json
ResponseBody: {
  "message": "Verification email sent"
}

Resend email for verified user

Status: 400 Bad Request
Content-Type: application/json
ResponseBody: {
  message: "Verification has already been passed"
}

Примечание: Как альтернативу SendGrid можно использовать пакет nodemailer

Name		Name	Last commit message	Last commit date
Latest commit History 25 Commits
bin		bin
config		config
controllers		controllers
coverage		coverage
images		images
libs		libs
middlewares		middlewares
model		model
public/avatars/61e563a474b45fdef3eefb32		public/avatars/61e563a474b45fdef3eefb32
repository		repository
routes/api		routes/api
service		service
.dockerignore		.dockerignore
.eslintignore		.eslintignore
.eslintrc.cjs		.eslintrc.cjs
.example.env		.example.env
.gitignore		.gitignore
Dockerfile		Dockerfile
app.js		app.js
jest.config.js		jest.config.js
nodemon.json		nodemon.json
package-lock.json		package-lock.json
package.json		package.json
readme.md		readme.md

Lia-Pavlova/nodejs-homeworks

Folders and files

Latest commit

History

Repository files navigation

GoIT Node.js Course Template Homework

Команды:

Домашнее задание 2

Шаг 1

Шаг 2

@ GET /api/contacts

@ GET /api/contacts/:id

@ POST /api/contacts

@ DELETE /api/contacts/:id

@ PUT /api/contacts/:id

Шаг 3

Критерии приема дз #2-6

Домашнее задание 3

Шаг 1

Шаг 2

Шаг 3

Шаг 4

Шаг 5

@ PATCH /api/contacts/:contactId/favorite

Домашнее задание 4

Шаг 1

Шаг 2

Регистрация

Registration request

Registration validation error

Registration conflict error

Registration success response

Логин

Login request

Login validation error

Login success response

Login auth error

Шаг 3

Проверка токена

Middleware unauthorized error

Шаг 4

Логаут

Logout request

Logout unauthorized error

Logout success response

Шаг 5

Текущий пользователь - получить данные юзера по токену

Current user request

Current user unauthorized error

Current user success response

Дополнительное задание - необязательное

Домашнее задание 5

Шаг 1

Шаг 2

Шаг 3

Шаг 4

Дополнительное задание - необязательное

1. Написать unit-тесты для контроллера входа (login/signin)

Домашнее задание 6

Как процесс верификации должен работать

Шаг 1

Подготовка интеграции с SendGrid API

Шаг 2

Создание ендпоинта для верификации email'а

Verification request

Verification user Not Found

Verification success response

Шаг 3

Добавление отправки email пользователю с ссылкой для верификации

Шаг 4

Добавление повторной отправки email пользователю с ссылкой для верификации

@ POST /users/verify/

Resending a email request

Resending a email validation error

Resending a email success response

Resend email for verified user

Дополнительное задание - необязательное

1. Напишите dockerfile для вашего приложения

About

Topics

Packages