Merge pull request #3 from bobturanov/feature/task-3

Feature/task 3

Author: bobturanov

DOCS.md

@@ -78,7 +78,7 @@ deps-go:
 	go install github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger@latest
 
 .deps-python:
-	python -m pip install grpcio-tools grpclib protobuf
+	python3 -m pip install grpcio-tools grpclib protobuf # python3 for my machine
 
 .PHONY: build
 build: generate .build

Makefile

@@ -1,19 +1,143 @@
-### Задание 2
+# Ozon Marketplace Verification API
 
-1. Создать репозиторий именование которого указано в таблице прогресса ✅
+---
 
-2. Описать сущность `{domain}.{Subdomain}` и `{domain}.{Subdomain}Event` в **internal/model/{subdomain}.go** ✅
+## Build project
 
-3. Реализовать паттерн consumer-producer из **db** в **kafka** на основе интерфейсов [EventRepo](https://github.com/ozonmp/omp-demo-api/blob/b847b3ae4a3c9e1d25e31e077c847a22f8b7aa99/internal/app/repo/event.go#L7) и [EventSender](https://github.com/ozonmp/omp-demo-api/blob/b847b3ae4a3c9e1d25e31e077c847a22f8b7aa99/internal/app/sender/event.go#L7) для одного типа события **Created** ✅
+### Local
 
-4. Написать тесты ✅
+For local assembly you need to perform
 
-5. Синхронизацию работы потоков сделать через `context` 💎 ⌛️
+```zsh
+$ make deps # Installation of dependencies
+$ make build # Build project
+```
+## Running
 
-6. Создавать задачи у workerpool по обработке батчевых идентификаторов записей событий 💎 ⌛️
+### For local development
 
-7. Поддержать несколько типов событий учитывая корректный порядок 💎 🤔
+```zsh
+$ docker-compose up -d
+```
 
-8. Реализовать гарантию доставки **At-least-once** 💎 🤔
+---
 
-9. Найти скрытые ошибки в коде 💎 🤔
+## Services
+
+### Swagger UI
+
+The Swagger UI is an open source project to visually render documentation for an API defined with the OpenAPI (Swagger) Specification
+
+- http://localhost:8080/swagger
+
+### Grafana:
+
+- http://localhost:3000
+- - login `admin`
+- - password `MYPASSWORT`
+
+### gRPC:
+
+- http://localhost:8082
+
+```sh
+[I] ➜ grpc_cli call localhost:8082 DescribeVerificationV1 "id: 1"
+connecting to localhost:8082
+Rpc failed with status code 5, error message: verification not found
+```
+
+### Gateway:
+
+It reads protobuf service definitions and generates a reverse-proxy server which translates a RESTful HTTP API into gRPC
+
+- http://localhost:8080/api'
+
+```sh
+[I] ➜ curl -s -X 'POST' \
+  'http://localhost:8080/api/v1/verifications'' \
+  -H 'accept: application/json' \
+  -H 'Content-Type: application/json' \
+  -d '{
+  "id": "1"
+}' | jq .
+{
+  "code": 5,
+  "message": "verification not found",
+  "details": []
+}
+```
+
+### Metrics:
+
+Metrics GRPC Server
+
+- http://localhost:9100/metrics
+
+### Status:
+
+Service condition and its information
+
+- http://localhost:8000
+- - `/live`- Layed whether the server is running
+- - `/ready` - Is it ready to accept requests
+- - `/version` - Version and assembly information
+
+### Prometheus:
+
+Prometheus is an open-source systems monitoring and alerting toolkit
+
+- http://localhost:9090
+
+### Kafka
+
+Apache Kafka is an open-source distributed event streaming platform used by thousands of companies for high-performance data pipelines, streaming analytics, data integration, and mission-critical applications.
+
+- http://localhost:9094
+
+### Kafka UI
+
+UI for Apache Kafka is a simple tool that makes your data flows observable, helps find and troubleshoot issues faster and deliver optimal performance. Its lightweight dashboard makes it easy to track key metrics of your Kafka clusters - Brokers, Topics, Partitions, Production, and Consumption.
+
+- http://localhost:9001
+
+### Jaeger UI
+
+Monitor and troubleshoot transactions in complex distributed systems.
+
+- http://localhost:16686
+
+### Graylog
+
+Graylog is a leading centralized log management solution for capturing, storing, and enabling real-time analysis of terabytes of machine data.
+
+- http://localhost:9000
+- - login `admin`
+- - password `admin`
+
+### PostgreSQL
+
+For the convenience of working with the database, you can use the [pgcli](https://github.com/dbcli/pgcli) utility. Migrations are rolled out when the service starts. migrations are located in the **./migrations** directory and are created using the [goose](https://github.com/pressly/goose) tool.
+
+```sh
+$ pgcli "postgresql://docker:docker@localhost:5432/srv_verification_api"
+```
+
+### Python client
+
+```shell
+$ python -m venv .venv
+$ . .venv/bin/activate
+$ make deps
+$ make generate
+$ cd pypkg/srv-verification-api
+$ python setup.py install
+$ cd ../..
+$ docker-compose up -d
+$ python scripts/grpc_client.py
+```
+
+
+### Thanks
+
+- [Evald Smalyakov](https://github.com/evald24)
+- [Michael Morgoev](https://github.com/zerospiel)

README.md

@@ -4,7 +4,6 @@ package ozonmp.srv_verification_api.v1;
 
 import "validate/validate.proto";
 import "google/api/annotations.proto";
-import "google/protobuf/timestamp.proto";
 
 option go_package = "github.com/ozonmp/srv-verification-api/pkg/srv-verification-api;srv_verification_api";
 
@@ -16,12 +15,27 @@ service SrvVerificationApiService {
       get: "/v1/verifications/{verification_id}"
     };
   }
+  rpc CreateVerificationV1(CreateVerificationV1Request) returns (CreateVerificationV1Response) {
+    option (google.api.http) = {
+      post: "/v1/verifications/create"
+      body: "*"
+    };
+  }
+  rpc ListVerificationV1(ListVerificationV1Request) returns (ListVerificationV1Response) {
+    option (google.api.http) = {
+      get: "/v1/verifications/list"
+    };
+  }
+  rpc RemoveVerificationV1(RemoveVerificationV1Request) returns (RemoveVerificationV1Response) {
+    option (google.api.http) = {
+      delete: "/v1/verifications/remove/{verification_id}"
+    };
+  }
 }
 
 message Verification {
   uint64 id  = 1;
-  uint64 foo = 2;
-  google.protobuf.Timestamp created = 3;
+  string name = 2;
 }
 
 message DescribeVerificationV1Request {
@@ -31,3 +45,27 @@ message DescribeVerificationV1Request {
 message DescribeVerificationV1Response {
   Verification value = 1;
 }
+
+message CreateVerificationV1Request {
+  string verification_name = 2 [(validate.rules).string.min_len = 2];
+}
+
+message CreateVerificationV1Response {
+  uint64 verification_id = 1 [(validate.rules).uint64.gt = 0];
+}
+
+message ListVerificationV1Request {
+}
+
+message ListVerificationV1Response {
+  repeated Verification verification = 1;
+}
+
+message RemoveVerificationV1Request {
+  uint64 verification_id = 1 [(validate.rules).uint64.gt = 0];
+}
+
+message RemoveVerificationV1Response {
+  bool result = 1;
+}
+