Проект dogsHelp

Общая информация

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

Для чего нужны ошейники?

1. Для отслеживания местоположения собаки.
2. По их id будут записаны характеристики собаки. Порода, размер и т.д.
3. По их id будут записаны задания пользователей.

Что должен делать персонал?

1. Мониторить как долго находиться ошейник на одном месте. Либо собака как-то его потеряла, либо с ней что-то случилось.
2. Мониторить приходит ли сигнал от ошейника. Сломался ли ошейник.
3. Мониторить задания от пользователей. Мало ли там что то жестокое придумают.
4. При добавлении новой собаки в эту систему, нужно добавлять ошейник с собакой в базу данных.

Что может делать пользователь(Сценарии)?

После того как пользователь зарегиструется он может:

1. Посмотреть на карте, где находяться собаки.
2. Посмотреть характеристики собаки.
3. Дать задание для других пользователей по определенной собаке.
4. Может взять задание для выполнения.

Клиент-сервер

Примерная схема запросов-ответов

Ошейник-сервер

1. При регистрации новой собаки на сервер посылается запрос с данными о собаке. Соответственно эти данные фиксируется в базе данных.

Регистрация новой собаки

/dogs/register

• Запрос

{
    "accessToken": "JusOh2nRK1kZpxzK",
    "characteristic": "Рыжий корги, рост 25 см, вес 10кг, дружелюбный и обаятельный"
}

• Ответ

{
    "success": "true",
    "dog_id": 44
}

2. Ошейник посылает раз в какое то время запрос с данными о местоположении. Местоположение и время последнего сигнала фиксируется в базе данных.

Обновить данные

/dogs/update

• Запрос

{
    "accessToken": "JusOh2nRK1kZpxzK",
    "time": "2024.11.04T11:44:12",
    "dog_id": 44,
    "coordinates": "52.250323, 104.264442"
}

• Ответ

{
    "success": "true",
}

Пользователь-сервер

1. При регистрации нового пользователя посылается запрос на сервер. Проверяются данные и записываются в базу данных.

Регистрация

/user/register

• Запрос

{
    "nickname":"Andrey",
    "password":"strongpassword1337"
}

• Ответ

{
    "success": "true",
    "accessToken": "JusOh2nRK1kZpxzK"
}

2. При авторизации пользователя посылается запрос на сервер. Проверяются данные и отправляется разрешение на вход.

Авторизация

/user/login

• Запрос

{
    "nickname":"Andrey",
    "password":"strongpassword1337"
}

• Ответ

{
    "success": "true",
    "accessToken": "JusOh2nRK1kZpxzK"
}

3. При прогрузке страницы с картой собак серверу посылается запрос для получения координат ошейников.

Получение координат собак

/dogs/coordinates

• Запрос

{
    "accessToken": "JusOh2nRK1kZpxzK",
    "place": "Irkutsk"
}

• Ответ

{
    "success": "true",
    "dogs": [
    {
        "dog_id": 3,
        "coordinates": "52.250323, 104.264442"
    },
    {
        "dog_id": 12,
        "coordinates": "52.250884, 104.263155"
    }]
}

4. При выборе определенной собаки серверу посылается запрос для получения характеристик собаки.

Получение характеристики собаки

/dogs/characteristic

• Запрос

{
    "accessToken": "JusOh2nRK1kZpxzK",
    "dog_id": 3
}

• Ответ

{
    "success": "true",
    "characteristic": "Рыжий корги, рост 25 см, вес 10кг, дружелюбный и обаятельный"
}

5. При выборе текущих заданий у собаки.

Получение заданий собаки

/dogs/task/list

• Запрос

{
    "accessToken": "JusOh2nRK1kZpxzK",
    "dog_id": 3
}

• Ответ

{
    "success": "true",
    "tasks": [
        {
            "goal_id": 34,
            "asked_user": "Glebus",
            "goal": "Принести собаку в шаурмечную"
        },
        {
            "goal_id": 3,
            "asked_user": "Danny",
            "goal": "Вытащить собаку из шаурмечной"
        }
    ]
}

6. При составлении задания серверу посылается запрос. Задание записывается в базу данных.

Создание задания

/dogs/task/create

• Запрос

{
    "accessToken": "JusOh2nRK1kZpxzK",
    "dog_id": 3,
    "goal": "Покормить собаку"
}

• Ответ

{
    "success": "true",
    "goal_id": 12
}

7. Если пользователь решает взять задание, то отправляется запрос. В базе данных фиксируется исполнитель задания.

Взять задание

/dogs/task/take

• Запрос

{
    "accessToken": "JusOh2nRK1kZpxzK",
    "goal_id": 12
}

• Ответ

{
    "success": "true"
}

8. Если пользователь хочет приложить отклик к взятому заданию, отправляется запрос и в базе данных всё это фиксируется.

Приложить отклик

/dogs/task/response/give

• Запрос

{
    "accessToken": "JusOh2nRK1kZpxzK",
    "goal_id": 12,
    "comments": "Всё сделал как надо",
    "photo": "dog.img",
    "done": "true"
}

• Ответ

{
    "success": "true"
}

9. Если создатель задания захочет посмотреть отклики.

Просмотреть отклики

/dogs/task/response/list

• Запрос

{
    "accessToken": "JusOh2nRK1kZpxzK",
    "goal_id": 12
}

• Ответ

{
    "success": "true"
    "responses": [
    {
        "response_user": "Danny",
        "response_id": 3,
        "comment": "Всё сделал как надо",
        "photo": "dog.img"
    },
    {
        "response_user": "Danny",
        "response_id": 21,
        "comment": "Отвез в шаурменко",
        "photo": "dog2.img"
    }]
}

10. Подтверждение, что задание выполнено или отменить задание.

Подтверждение, что задание выполнено

/dogs/task/response/confirm

• Запрос

{
    "accessToken": "JusOh2nRK1kZpxzK",
    "goal_id": 12,
    "done": "true" 
}

• Ответ

{
    "success": "true"
}

Админ-сервер

1. Посылается запрос, чтобы получить дату последнего сигнала и координаты.

Получить данные

/dogs/info

• Запрос

{
    "accessToken": "JusOh2nRK1kZpxzK",
    "dog_id": 12,
}

• Ответ

{
    "lastsend": "2024.11.04T11:44:12",
    "coordinates": "52.250323, 104.264442"
}

Базы данных:

Таблица с пользователями

users(user_id BIGINT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY, login VARCHAR(255), password VARCHAR(255)(хэшированный), is_deleted BOOLEAN)

Таблица с собаками

dogs(dog_id BIGINT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY, characteristic VARCHAR(255), coords VARCHAR(255), last_send DATETIME, is_deleted BOOLEAN)

Таблица с собаками

dogs(dog_id BIGINT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY, characteristic VARCHAR(255), coords VARCHAR(255), last_send DATETIME, is_deleted BOOLEAN)