zimash/hrenovina

hrenovina's Issues

Add endpoint for bulk serial keys parsing POST /parse/bulk

Accepts body (JSON object):

• items: array of serial keys (see limits for serial key string in issue #3 )

Response (JSON):

In case of any invalid data - 400 status code and JSON object:

• items: array of serial key parsing errors.

In case of OK - 200 status code and JSON object:

• items: array of parsed serial keys

Add tests running to CI

Add ability to run tests in Github Actions
You can use https://github.com/stretchr/testify and https://pkg.go.dev/net/http/httptest for HTTP handlers testing.

Prometheus metrics

Implement several simple prometheus metrics (kind of http response count and duration split by HTTP method, URL and status_code).
All of them should be available via GET /metrics endpoint

Add endpoint POST /parse endpoint

Input parameters, JSON object:

• key: string, required, not null, min len == max len == 40

Success response: 200 status code, JSON object (let's name it Parsed Serial Key)

• feature_name: string, not empty, max len = 40
• quota: int
• expiration: datetime
• language: string, len 5

Invalid serial key string, parsing error: 400 response, JSON object (let's call it Parsing Serial Key Error):

• serial_key: string
• code: string or int, short code for error reason (InvalidSerialKeyString, ParsingError and etc)
• details: Human readable details of error

Add logging with verbose levels

Log verbose level can be set in a configuration file.
You can try some third-party libraries.

Add database layer for storing generated keys

On start it will contain one table for generated keys with following fields:

• id: int, primary key, auto increment
• ... fields from parsed serial key structure (see #3)
• created_dt: date time
• deleted_dt: date time

It's supposed to use goqu (http://doug-martin.github.io/goqu/) for building SQL queries. So don't use any ORM for it.
You need to add database migrations tool. I know about two:

• https://github.com/golang-migrate/migrate
• https://github.com/pressly/goose
  I did not use any of it. So you can try any or find another one. The main requirement is ability to work with Sqlite, MySQL and Postgres.
• add docker-compose file for running required DB locally (example can be found here: https://github.com/doug-martin/goqu/blob/master/docker-compose.yml)

Database access should be configured via connection string parameter (it can be a server parameter, environment variable or taken from configuration file)

Library for parsing and generating serial key

We need a library which can be used both in handlers or in any console tools for parsing, verifying or generating a new serial keys. It's just a kind of mock so it should be pretty simple. See issue #3 for structure of serial key data.

Minimal http-server layout using go mod

With endpoint GET /healthz responding with empty JSON object

Add golang linter config (golangci-lint or metalinter)

Add linter checks to CI (Github Actions)

Add API endpoint for POST /keys for generating a new serial key

Input - JSON body (similar to response method in issue #3)

Success response: 200 status code, JSON object:

• serial_key: string

Validation error response: 400 status code, JSON object:

• details: Human readable error details
• code: should be ValidationError
• fields: array of objects having two fields - field_name and error

Add ability to run application with configuration file

It's enough to have there a port to listen. Let's use YAML for configuration file.

• You can look at such tools for loading parameters like https://github.com/spf13/viper or any other. But it's not required.