Merge pull request #17 from NLipatov/feature/1

Feature/1

Author: NLipatov

README.md

@@ -5,4 +5,56 @@
 ![Forks](https://img.shields.io/github/forks/NLipatov/goproxy.svg)
 ![Issues](https://img.shields.io/github/issues/NLipatov/goproxy.svg)
 
-Working on it - ReadMe file will be completed in few more days :-)
+goproxy is an HTTP(S)-proxy server.
+
+It has a microservice architecture, with each microservice running in a separate container.
+Microservices use a Kafka bus to transmit events to one another.
+
+# Services
+
+Check the docker-compose.yml file in the project's root directory
+
+## proxy
+The core service, used as an HTTP-proxy server.
+
+The proxy uses an auth database to authorize clients to access the proxy service.
+Only existing users can use the proxy.
+
+### Domain events
+Consumes:
+1) `UserExceededTrafficLimitEvent` - triggers user restrictions;
+2) `UserConsumedTrafficWithoutPlan` - triggers user restrictions.
+
+Produces:
+1) `UserConsumedTrafficEvent`
+
+## rest-api 
+Used to get, create, update, and delete users
+
+## plan-controller
+Consumes `UserConsumedTrafficEvent`, which is produced by proxy when a user has used it.
+
+### Domain events
+Consumes:
+1) `UserConsumedTrafficEvent` - triggers updates to user traffic stats and validates user plans. 
+
+Produces:
+1) `UserExceededTrafficLimitEvent` - triggers user restrictions;
+2) `UserConsumedTrafficWithoutPlan` - triggers user restrictions.
+
+# Databases
+
+There are 3 separate databases:
+1) postgres - used for user authentication;
+2) plan-postgres - used to store plans and user-plan affiliations.
+
+## Migrations
+
+The migration process is handled by migrator.go, located in the Data Access Layer (DAL).
+All migration files are placed in directories with the same name as the corresponding database. 
+
+For example:
+- Proxy database migrations are stored in the proxydb directory;
+- Plan database migrations are stored in the plans directory.
+
+

src/infrastructure/services/lava_top_billing_service_test.go

@@ -285,16 +285,6 @@ func TestGetOffers(t *testing.T) {
 		apiKey:       "test-api-key",
 	}
 
-	offers, err := service.GetOffers()
-	if err != nil {
-		t.Fatalf("GetOffers returned error: %v", err)
-	}
-
-	expectedOfferCount := 1
-	if len(offers) != expectedOfferCount {
-		t.Errorf("Expected %d offers, got %d", expectedOfferCount, len(offers))
-	}
-
 	eurPrice := lavatopvalueobjects.NewPrice(48, lavatopvalueobjects.EUR, lavatopvalueobjects.ONE_TIME)
 	rubPrice := lavatopvalueobjects.NewPrice(5000, lavatopvalueobjects.RUB, lavatopvalueobjects.ONE_TIME)
 	usdPrice := lavatopvalueobjects.NewPrice(49, lavatopvalueobjects.USD, lavatopvalueobjects.ONE_TIME)
@@ -306,24 +296,36 @@ func TestGetOffers(t *testing.T) {
 		prices,
 	)
 
-	if offers[0].ExtId() != expectedOffer.ExtId() {
-		t.Errorf("Expected offer ID %s, got %s", expectedOffer.ExtId(), offers[0].ExtId())
+	offers, err := service.GetOffers()
+	if err != nil {
+		t.Fatalf("GetOffers returned error: %v", err)
+	}
+
+	expectedOfferCount := 1
+	if len(offers) != expectedOfferCount {
+		t.Errorf("Expected %d offers, got %d", expectedOfferCount, len(offers))
+	}
+
+	actualOffer := offers[0]
+
+	if actualOffer.ExtId() != expectedOffer.ExtId() {
+		t.Errorf("Expected offer ID %s, got %s", expectedOffer.ExtId(), actualOffer.ExtId())
 	}
 
-	if offers[0].Name() != expectedOffer.Name() {
-		t.Errorf("Expected offer name %s, got %s", expectedOffer.Name(), offers[0].Name())
+	if actualOffer.Name() != expectedOffer.Name() {
+		t.Errorf("Expected offer name %s, got %s", expectedOffer.Name(), actualOffer.Name())
 	}
 
-	if offers[0].Prices()[0].Cents() != expectedOffer.Prices()[0].Cents() {
-		t.Errorf("Expected price %d, got %d", expectedOffer.Prices()[0].Cents(), offers[0].Prices()[0].Cents())
+	if actualOffer.Prices()[0].Cents() != expectedOffer.Prices()[0].Cents() {
+		t.Errorf("Expected price %d, got %d", expectedOffer.Prices()[0].Cents(), actualOffer.Prices()[0].Cents())
 	}
 
-	if offers[0].Prices()[0].Currency() != expectedOffer.Prices()[0].Currency() {
-		t.Errorf("Expected currency %s, got %s", expectedOffer.Prices()[0].Currency(), offers[0].Prices()[0].Currency())
+	if actualOffer.Prices()[0].Currency() != expectedOffer.Prices()[0].Currency() {
+		t.Errorf("Expected currency %s, got %s", expectedOffer.Prices()[0].Currency(), actualOffer.Prices()[0].Currency())
 	}
 
-	if offers[0].Prices()[0].Periodicity() != expectedOffer.Prices()[0].Periodicity() {
-		t.Errorf("Expected periodicity %s, got %s", expectedOffer.Prices()[0].Periodicity(), offers[0].Prices()[0].Periodicity())
+	if actualOffer.Prices()[0].Periodicity() != expectedOffer.Prices()[0].Periodicity() {
+		t.Errorf("Expected periodicity %s, got %s", expectedOffer.Prices()[0].Periodicity(), actualOffer.Prices()[0].Periodicity())
 	}
 
 	expectedPrices := make(map[string]lavatopvalueobjects.Price)