fix #73: add GET /api/v1/license/{license}/workplaces

env/api/license.proto

@@ -25,6 +25,12 @@ message Rate {
     Unit unit = 2;
 }
 
+message Workplace {
+    string id = 1;
+    google.protobuf.Timestamp created_at = 2;
+    google.protobuf.Timestamp updated_at = 3;
+}
+
 message RegisterLicenseRequest {
     string id = 1;
     Contract contract = 2;
@@ -147,33 +153,46 @@ service License {
             put: "/api/v1/license/{id}/workplace/{workplace}"
         };
     }
+    rpc Workplaces (WorkplaceListRequest) returns (WorkplaceListResponse) {
+        option (google.api.http) = {
+            get: "/api/v1/license/{license}/workplaces"
+        };
+    }
 }
 
 message EmptyResponse {}
 
 message AddEmployeeRequest {
-    string id = 1;
+    string id = 1; // TODO issue#refactoring rename to license
     string employee = 2;
 }
 
 message DeleteEmployeeRequest {
-    string id = 1;
+    string id = 1; // TODO issue#refactoring rename to license
     string employee = 2;
 }
 
 message AddWorkplaceRequest {
-    string id = 1;
+    string id = 1; // TODO issue#refactoring rename to license
     string workplace = 2;
 }
 
 message DeleteWorkplaceRequest {
-    string id = 1;
+    string id = 1; // TODO issue#refactoring rename to license
     string workplace = 2;
 }
 
 message PushWorkplaceRequest {
-    string id = 1;
+    string id = 1; // TODO issue#refactoring rename to license
     string workplace = 2;
 }
 
+message WorkplaceListRequest {
+    string license = 1;
+}
+
+message WorkplaceListResponse {
+    repeated Workplace workplaces = 1;
+}
+
 // issue#draft }

env/api/swagger.json

@@ -340,6 +340,30 @@
           "License"
         ]
       }
+    },
+    "/api/v1/license/{license}/workplaces": {
+      "get": {
+        "operationId": "Workplaces",
+        "responses": {
+          "200": {
+            "description": "",
+            "schema": {
+              "$ref": "#/definitions/protobufWorkplaceListResponse"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "license",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "License"
+        ]
+      }
     }
   },
   "definitions": {
@@ -648,6 +672,33 @@
           "format": "date-time"
         }
       }
+    },
+    "protobufWorkplace": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "created_at": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "updated_at": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
+    "protobufWorkplaceListResponse": {
+      "type": "object",
+      "properties": {
+        "workplaces": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/protobufWorkplace"
+          }
+        }
+      }
     }
   },
   "securityDefinitions": {

env/client/rest.http

@@ -77,6 +77,12 @@ X-Request-ID:  10000000-2000-4000-8000-160000000000
 
 ###
 
+GET http://localhost:8093/api/v1/license/10000000-2000-4000-8000-160000000004/workplaces
+Authorization: Bearer 10000000-2000-4000-8000-160000000003
+X-Request-ID:  10000000-2000-4000-8000-160000000000
+
+###
+
 DELETE http://localhost:8093/api/v1/license/10000000-2000-4000-8000-160000000004/workplace/10000000-2000-4000-8000-160000000006
 Authorization: Bearer 10000000-2000-4000-8000-160000000003
 X-Request-ID:  10000000-2000-4000-8000-160000000000

pkg/storage/internal/executor.go

@@ -79,6 +79,8 @@ type LicenseManager interface {
 	DeleteWorkplace(*types.Token, query.LicenseWorkplace) error
 	// PushWorkplace TODO issue#docs
 	PushWorkplace(*types.Token, query.LicenseWorkplace) error
+	// Workplaces TODO issue#docs
+	Workplaces(*types.Token, query.WorkplaceList) ([]types.Workplace, error)
 
 	// issue#draft }
 }

pkg/storage/internal/postgres/license.go

@@ -327,4 +327,31 @@ func (scope licenseManager) PushWorkplace(token *types.Token, data query.License
 	return nil
 }
 
+// Workplaces TODO issue#docs
+func (scope licenseManager) Workplaces(token *types.Token, data query.WorkplaceList) ([]types.Workplace, error) {
+	license, readErr := scope.Read(token, query.ReadLicense{ID: data.License})
+	if readErr != nil {
+		return nil, readErr
+	}
+	q := `SELECT "license", "workplace", "created_at", "updated_at"
+	        FROM "license_workplace"
+	       WHERE "license" = $1`
+	rows, queryErr := scope.conn.QueryContext(scope.ctx, q, license.ID)
+	if queryErr != nil {
+		return nil, queryErr
+	}
+	workplaces := make([]types.Workplace, 0, 4)
+	for rows.Next() {
+		var workplace types.Workplace
+		if scanErr := rows.Scan(&workplace.License, &workplace.ID,
+			&workplace.CreatedAt, &workplace.UpdatedAt); scanErr != nil {
+			return nil, errors.Wrapf(scanErr,
+				"user %q of account %q with token %q tried to read workplaces of license %q",
+				token.UserID, token.User.AccountID, token.ID, license.ID)
+		}
+		workplaces = append(workplaces, workplace)
+	}
+	return workplaces, nil
+}
+
 // issue#draft }

pkg/storage/protected.go

@@ -258,4 +258,23 @@ func (storage *Storage) PushWorkplace(ctx context.Context, id domain.Token, data
 	return storage.exec.LicenseManager(ctx, conn).PushWorkplace(token, data)
 }
 
+// LicenseWorkplaces TODO issue#docs
+func (storage *Storage) LicenseWorkplaces(ctx context.Context, id domain.Token, data query.WorkplaceList) (
+	[]types.Workplace,
+	error,
+) {
+	conn, closer, connErr := storage.connection(ctx)
+	if connErr != nil {
+		return nil, connErr
+	}
+	defer func() { _ = closer() }()
+
+	token, authErr := storage.exec.UserManager(ctx, conn).AccessToken(id)
+	if authErr != nil {
+		return nil, authErr
+	}
+
+	return storage.exec.LicenseManager(ctx, conn).Workplaces(token, data)
+}
+
 // issue#draft }

pkg/storage/query/license.go

@@ -59,6 +59,11 @@ type LicenseWorkplace struct {
 	Workplace domain.ID
 }
 
+// WorkplaceList TODO issue#docs
+type WorkplaceList struct {
+	License domain.ID
+}
+
 // issue#draft }
 
 /*

pkg/storage/types/license.go

@@ -16,3 +16,11 @@ type License struct {
 	DeletedAt *time.Time      `db:"deleted_at"`
 	Account   *Account        `db:"-"`
 }
+
+// Workplace TODO issue#docs
+type Workplace struct {
+	ID        domain.ID  `db:"workplace"`
+	License   domain.ID  `db:"license"`
+	CreatedAt time.Time  `db:"created_at"`
+	UpdatedAt *time.Time `db:"updated_at"`
+}