go-musthave-diploma-tpl

Шаблон репозитория для индивидуального дипломного проекта курса «Go-разработчик»

Начало работы

1. Склонируйте репозиторий в любую подходящую директорию на вашем компьютере.
2. В корне репозитория выполните команду go mod init <name> (где <name> — адрес вашего репозитория на GitHub без префикса https://) для создания модуля

Обновление шаблона

Чтобы иметь возможность получать обновления автотестов и других частей шаблона, выполните команду:

git remote add -m master template https://github.com/yandex-praktikum/go-musthave-diploma-tpl.git

Для обновления кода автотестов выполните команду:

git fetch template && git checkout template/master .github

Затем добавьте полученные изменения в свой репозиторий.

Development

Run Database

The database can be started via docker container using this command:

docker run --name gophermart-postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=gophermart -p 5432:5432 -d postgres

Build App

cd cmd/gophermart && go build -o gophermart *.go

or

make build

Run App

Database connection is required to run the app. Some examples of how you can run the app (see Configuration below):

Run app with database URI

./cmd/gophermart/gophermart -d 'postgres://postgres:postgres@localhost:5432/gophermart?sslmode=disable'

or

make run

Configuration

App can be configured via flags and/or environment variables. If both flag and environment variable are set for the same parameter, environment variable prevails.

-a, RUN_ADDRESS

Address and port to run server in the form of host:port.

-d, DATABASE_URI

Database URI.

-r, ACCRUAL_SYSTEM_ADDRESS

Accrual system address.

--token-secret, TOKEN_SECRET_KEY

Authentication token secret key.

--token-duration, TOKEN_DURATION

Authentication token duration (in the format of Golang duration string).

Migrations

Migrations are implemented with bun. You can run migrations using CLI app.

CLI command

Create migration:

go run ./cmd/gophermart-cli/main.go -d 'postgres://postgres:postgres@localhost:5432/gophermart?sslmode=disable' db create_sql <migration_name>

Run migrations:

go run ./cmd/gophermart-cli/main.go -d 'postgres://postgres:postgres@localhost:5432/gophermart?sslmode=disable' db migrate

Rollback migrations:

go run ./cmd/gophermart-cli/main.go -d 'postgres://postgres:postgres@localhost:5432/gophermart?sslmode=disable' db rollback

Makefile

Create migration:

make name="create_users" db_create_sql

Run migrations:

make db_migrate

Rollback migrations:

make db_rollback

API Examples

Public API

Register A New User

After successful registration, automatic user authentication should occur.

curl -i -X POST http://localhost:8080/api/user/register \
   -H "Content-Type: application/json" \
   -d '{
      "login":"john_doe",
      "password":"my_secret_password"
   }'

# Response:
HTTP/1.1 200 OK
Set-Cookie: auth_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnb3BoZXJtYXJ0IiwiZXhwIjoxNzMwNjQyOTI4LCJVc2VySUQiOiIyMDA2OGZkZC0yNjk2LTQwNWEtODZlMS1hZjAyZTUyMzI1NzEifQ.R9bO1F5c3LiIAa_IVWHzzLl3rJtLK4LZW8ix1sQ1xM4
Date: Sun, 03 Nov 2024 13:09:12 GMT
Content-Length: 0

User Authentication

curl -i -X POST http://localhost:8080/api/user/login \
   -H "Content-Type: application/json" \
   -d '{
      "login":"john_doe",
      "password":"my_secret_password"
   }'

# Response:
HTTP/1.1 200 OK
Set-Cookie: auth_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnb3BoZXJtYXJ0IiwiZXhwIjoxNzMwNjQyNDE3LCJVc2VySUQiOiIyOTcxMDQzYy03NDNmLTQ3MmMtOTY4MS0yNzUzZjkyMzBmNDIifQ.grdF5wTR-E4uq6ogI_LDTzyFO7gc-m6OlR8cJwoqtoA
Date: Sun, 03 Nov 2024 13:00:33 GMT
Content-Length: 0

Private API

Private API requires auth_token cookie to be set and contain JWT token.

Create Order

curl -i -X POST http://localhost:8080/api/user/orders \
   -b "auth_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnb3BoZXJtYXJ0IiwiZXhwIjoxNzMwNjUzMzI0LCJVc2VySUQiOiIxMWE4YjAzMi02NmM0LTQ1YWQtYTlhZS0xYjkwMWMxZDIzZmUifQ.wS9OUOD9WY0eI17G1q9puqusYf3UxMSdEF3_AA_hexI" \
   -H "Content-Type: text/plain" \
   -d '12345678903'

# Response:
HTTP/1.1 200 OK
Date: Sun, 03 Nov 2024 16:06:05 GMT
Content-Length: 0

Get Orders

curl -i -X GET http://localhost:8080/api/user/orders \
   -b "auth_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnb3BoZXJtYXJ0IiwiZXhwIjoxNzMwNjUzMzI0LCJVc2VySUQiOiIxMWE4YjAzMi02NmM0LTQ1YWQtYTlhZS0xYjkwMWMxZDIzZmUifQ.wS9OUOD9WY0eI17G1q9puqusYf3UxMSdEF3_AA_hexI"

# Response:
HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 04 Nov 2024 13:35:10 GMT
Content-Length: 102

[
   {
      "number":"1234567890003",
      "status":"NEW",
      "accrual":0,
      "uploaded_at":"2024-11-03T17:32:43.936343Z"
   }
]

Get Balance

curl -i -X GET http://localhost:8080/api/user/balance \
   -b "auth_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnb3BoZXJtYXJ0IiwiZXhwIjoxNzMwNjUzMzI0LCJVc2VySUQiOiIxMWE4YjAzMi02NmM0LTQ1YWQtYTlhZS0xYjkwMWMxZDIzZmUifQ.wS9OUOD9WY0eI17G1q9puqusYf3UxMSdEF3_AA_hexI"

# Response:
HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 04 Nov 2024 14:16:53 GMT
Content-Length: 32

{
   "current":0,
   "withdrawn":0
}

Withdraw Balance

curl -i -X POST http://localhost:8080/api/user/balance/withdraw \
   -b "auth_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnb3BoZXJtYXJ0IiwiZXhwIjoxNzMwNjUzMzI0LCJVc2VySUQiOiIxMWE4YjAzMi02NmM0LTQ1YWQtYTlhZS0xYjkwMWMxZDIzZmUifQ.wS9OUOD9WY0eI17G1q9puqusYf3UxMSdEF3_AA_hexI" \
   -H "Content-Type: application/json" \
   -d '{
      "order": "2377225624",
      "sum": 700
   }'

# Response:
HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 05 Nov 2024 13:54:21 GMT
Content-Length: 37

{
   "current":100,
   "withdrawn":1400
}

Get Withdrawals

curl -i -X GET http://localhost:8080/api/user/withdrawals \
   -b "auth_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnb3BoZXJtYXJ0IiwiZXhwIjoxNzMwNjUzMzI0LCJVc2VySUQiOiIxMWE4YjAzMi02NmM0LTQ1YWQtYTlhZS0xYjkwMWMxZDIzZmUifQ.wS9OUOD9WY0eI17G1q9puqusYf3UxMSdEF3_AA_hexI"

# Response:
HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 05 Nov 2024 15:12:42 GMT
Content-Length: 164

[
   {
      "sum":45.23,
      "order":"12345678903",
      "processed_at":"2024-11-05T15:12:36.772813Z"
   },
   {
      "sum":10,
      "order":"2377225624",
      "processed_at":"2024-11-05T15:11:24.553115Z"
   }
]