Skip to content
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.

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

first release api #12

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
99 changes: 96 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,98 @@
# Файлы для итогового задания
# Task Scheduler

В директории `tests` находятся тесты для проверки API, которое должно быть реализовано в веб-сервере.
Task Scheduler - это веб-приложение на Go для управления задачами с поддержкой повторяющихся событий. Приложение использует SQLite для хранения задач и предоставляет API для взаимодействия с задачами.

Директория `web` содержит файлы фронтенда.
## Установка

### Требования

- Go 1.16 или новее
- SQLite3

### Склонируйте репозиторий

```
git clone https://github.com/ваш-репозиторий/task-scheduler.git
cd task-scheduler
go mod tidy
```

## Настройка
### Параметры окружения
Приложение использует два параметра окружения:

TODO_PORT: Порт, на котором будет работать сервер. По умолчанию используется порт 7540.
TODO_DBFILE: Путь к файлу базы данных SQLite. По умолчанию используется ./scheduler.db.

## Инициализация базы данных

Приложение автоматически создаст файл базы данных и необходимые таблицы при первом запуске, если файл базы данных не существует.

## Запуск приложения
### Запуск сервера

```
go run main.go
```
Сервер будет доступен по адресу http://localhost:7540

### Примеры использования API
## Добавление задачи

```
curl -X POST "http://localhost:7540/api/task" -H "Content-Type: application/json" -d '{
"date": "20240201",
"title": "Подвести итог",
"comment": "Мой комментарий",
"repeat": "d 5"
}'
```

## Получение всех задач

```
curl -X GET "http://localhost:7540/api/tasks"
```

## Получение задачи по идентификатору
```
curl -X GET "http://localhost:7540/api/task?id=185"
```
## Обновление задачи
```
curl -X PUT "http://localhost:7540/api/task" -H "Content-Type: application/json" -d '{
"id": 185,
"date": "20240201",
"title": "Обновленный заголовок",
"comment": "Обновленный комментарий",
"repeat": "d 10"
}'
```

## Пометка задачи как выполненной
```
curl -X POST "http://localhost:7540/api/task/done?id=185"
```

## Удаление задачи

```
curl -X DELETE "http://localhost:7540/api/task?id=185"
```

### Тестирование
Для запуска тестов выполните следующую команду:

```
go test ./...
```

Эта команда запустит все тесты в проекте и выведет результаты.

### Структура проекта
- main.go: Главный файл приложения, точка входа сервера.
- database/: Пакет для инициализации базы данных.
- handlers/: Пакет с обработчиками API запросов.
- models/: Пакет с моделями данных.
- tasks/: Пакет с логикой обработки задач и вычисления следующей даты выполнения.
- web/: Директория для статических файлов (HTML, CSS, JS).
52 changes: 52 additions & 0 deletions database/add_task.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
package database

import (
"errors"
"github.com/jmoiron/sqlx"
"github.com/qavaleria/go_final_project/models"
"github.com/qavaleria/go_final_project/tasks"
"time"
)

func AddTask(db *sqlx.DB, task models.Task) (int64, error) {
if task.Title == "" {
return 0, errors.New("Не указан заголовок задачи")
}

if task.Date == "" {
task.Date = time.Now().Format(tasks.FormatDate)
} else {
_, err := time.Parse(tasks.FormatDate, task.Date)
if err != nil {
return 0, errors.New("Дата представлена в неправильном формате")
}
}

now := time.Now()
if task.Date < now.Format(tasks.FormatDate) {
if task.Repeat == "" {
task.Date = now.Format(tasks.FormatDate)
} else {
nextDate, err := tasks.NextDate(now, task.Date, task.Repeat)
if err != nil {
return 0, err
}
task.Date = nextDate
}
}

result, err := db.Exec(
`INSERT INTO scheduler (date, title, comment, repeat) VALUES (?, ?, ?, ?)`,
task.Date, task.Title, task.Comment, task.Repeat,
)
if err != nil {
return 0, err
}

id, err := result.LastInsertId()
if err != nil {
return 0, err
}

return id, nil
}
47 changes: 47 additions & 0 deletions database/database.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
package database

import (
"github.com/jmoiron/sqlx"
_ "github.com/mattn/go-sqlite3"
"os"
)

const dbFileName = "scheduler.db"

// InitializeDatabase проверяет существование файла базы данных и создает таблицу, если необходимо
func InitializeDatabase() (*sqlx.DB, error) {
if _, err := os.Stat(dbFileName); os.IsNotExist(err) {
file, err := os.Create(dbFileName)
if err != nil {
return nil, err
}
file.Close()
}

db, err := sqlx.Connect("sqlite3", dbFileName)
if err != nil {
return nil, err
}

createTableSQL := `CREATE TABLE IF NOT EXISTS scheduler (
id INTEGER PRIMARY KEY AUTOINCREMENT,
date CHAR(8) NOT NULL DEFAULT "",
title VARCHAR(128) NOT NULL DEFAULT "",
comment TEXT NOT NULL DEFAULT "",
repeat VARCHAR(128) NOT NULL DEFAULT ""
);`

_, err = db.Exec(createTableSQL)
if err != nil {
return nil, err
}

// Создаем индекс по полю date для сортировки задач по дате
createIndexSQL := `CREATE INDEX IF NOT EXISTS idx_scheduler_date ON scheduler(date);`
_, err = db.Exec(createIndexSQL)
if err != nil {
return nil, err
}

return db, nil
}
29 changes: 29 additions & 0 deletions database/delete_task.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package database

import (
"errors"
"github.com/jmoiron/sqlx"
"log"
)

// DeleteTask удаляет задачу из базы данных по идентификатору
func DeleteTask(db *sqlx.DB, id string) error {
deleteQuery := `DELETE FROM scheduler WHERE id = ?`
res, err := db.Exec(deleteQuery, id)
if err != nil {
log.Printf("Ошибка выполнения запроса: %v", err)
return errors.New("Ошибка выполнения запроса")
}

rowsAffected, err := res.RowsAffected()
if err != nil {
log.Printf("Ошибка получения результата запроса: %v", err)
return errors.New("Ошибка получения результата запроса")
}

if rowsAffected == 0 {
return errors.New("задача не найдена")
}

return nil
}
24 changes: 24 additions & 0 deletions database/get_task.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package database

import (
"database/sql"
"errors"
"github.com/jmoiron/sqlx"
"github.com/qavaleria/go_final_project/models"
"log"
)

// GetTaskByID извлекает задачу из базы данных по идентификатору
func GetTaskByID(db *sqlx.DB, id string) (models.Task, error) {
var task models.Task
query := `SELECT id, date, title, comment, repeat FROM scheduler WHERE id = ?`
err := db.QueryRow(query, id).Scan(&task.ID, &task.Date, &task.Title, &task.Comment, &task.Repeat)
if err != nil {
if errors.Is(err, sql.ErrNoRows) {
return task, errors.New("задача не найдена")
}
log.Printf("Ошибка выполнения запроса: %v", err)
return task, errors.New("Ошибка выполнения запроса")
}
return task, nil
}
80 changes: 80 additions & 0 deletions database/get_tasks.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
package database

import (
"github.com/jmoiron/sqlx"
"github.com/qavaleria/go_final_project/models"
"github.com/qavaleria/go_final_project/tasks"
"log"
"strings"
"time"
)

func GetTasks(db *sqlx.DB, search string, limit int) ([]models.Task, error) {
var rows *sqlx.Rows
var err error

// Убираем лишние пробелы в поисковой строке
search = strings.TrimSpace(search)
if search != "" {
// Проверяем, является ли поисковая строка датой в формате "02.01.2006"
if searchDate, err := time.Parse("02.01.2006", search); err == nil {
searchDateStr := searchDate.Format(tasks.FormatDate)
rows, err = db.NamedQuery(`SELECT id, date, title, comment, repeat FROM scheduler WHERE date = :searchDate ORDER BY date LIMIT :limit`, map[string]interface{}{
"searchDate": searchDateStr,
"limit": limit,
})
if err != nil {
log.Printf("Ошибка выполнения запроса с датой: %v", err)
return nil, err
}
} else {
//search = "%" + strings.ToLower(search) + "%"
rows, err = db.NamedQuery(`SELECT id, date, title, comment, repeat FROM scheduler WHERE LOWER(title) LIKE :search OR LOWER(comment) LIKE :search ORDER BY date LIMIT :limit`, map[string]interface{}{
"search": "%" + search + "%",
"limit": limit,
})
if err != nil {
log.Printf("Ошибка выполнения запроса с поиском: %v", err)
return nil, err
}
}
} else {
// Если поисковая строка пустая, просто выбираем все задачи
rows, err = db.NamedQuery(`SELECT id, date, title, comment, repeat FROM scheduler ORDER BY date LIMIT :limit`, map[string]interface{}{
"limit": limit,
})
if err != nil {
log.Printf("Ошибка выполнения запроса без поиска: %v", err)
return nil, err
}
}

defer func() {
if err := rows.Close(); err != nil {
log.Printf("Ошибка закрытия rows: %v", err)
}
}()

var tasks []models.Task
for rows.Next() {
var task models.Task
err := rows.StructScan(&task)
if err != nil {
log.Printf("Ошибка сканирования строки: %v", err)
return nil, err
}
tasks = append(tasks, task)
}

if err = rows.Err(); err != nil {
log.Printf("Ошибка чтения строк: %v", err)
return nil, err
}

// Возвращаем пустой массив задач, если ни одной задачи не найдено
if tasks == nil {
tasks = []models.Task{}
}

return tasks, nil
}
30 changes: 30 additions & 0 deletions database/update_task.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
package database

import (
"errors"
"github.com/jmoiron/sqlx"
"github.com/qavaleria/go_final_project/models"
"log"
)

// UpdateTask обновляет задачу в базе данных
func UpdateTask(db *sqlx.DB, task models.Task) error {
query := `UPDATE scheduler SET date = ?, title = ?, comment = ?, repeat = ? WHERE id = ?`
res, err := db.Exec(query, task.Date, task.Title, task.Comment, task.Repeat, task.ID)
if err != nil {
log.Printf("Ошибка выполнения запроса: %v", err)
return errors.New("ошибка выполнения запроса")
}

rowsAffected, err := res.RowsAffected()
if err != nil {
log.Printf("Ошибка получения результата запроса: %v", err)
return errors.New("ошибка получения результата запроса")
}

if rowsAffected == 0 {
return errors.New("задача не найдена")
}

return nil
}
16 changes: 16 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
module github.com/qavaleria/go_final_project

go 1.21

require (
github.com/go-chi/chi/v5 v5.0.12
github.com/jmoiron/sqlx v1.4.0
github.com/mattn/go-sqlite3 v1.14.22
github.com/stretchr/testify v1.9.0
)

require (
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
Loading