Merge branch 'develop' into feature/bulk-milestone-updates

Author: Maksym Mykhailenko

.eslintignore

@@ -1,7 +1,7 @@
 config/local.js
 config/mock.local.js
 config/m2m.local.js
-local/seed/
+scripts/import-from-api/
 node_modules
 dist
 .ebextensions

README.md

@@ -2,5 +2,8 @@
   "pubsubQueueName": "dev.project.service",
   "pubsubExchangeName": "dev.projects",
   "attachmentsS3Bucket": "topcoder-dev-media",
-  "connectProjectsUrl": "https://connect.topcoder-dev.com/projects/"
+  "connectProjectsUrl": "https://connect.topcoder-dev.com/projects/",
+  "fileServiceEndpoint": "https://api.topcoder-dev.com/v3/files/",
+  "connectProjectsUrl": "https://connect.topcoder-dev.com/projects/",
+  "memberServiceEndpoint": "https://api.topcoder-dev.com/v3/members"
 }

config/development.json

@@ -73,4 +73,4 @@ payload: {
     "updatedBy": 1,
   },
 }
-```
+```

docs/guides/architercture/architecture.md

@@ -0,0 +1,76 @@
+# Permissions Guide
+
+What kind of permissions we have, how they work and how to use them.
+
+- [Overview](#overview)
+  - [Topcoder Roles](#topcoder-roles)
+  - [Project Role](#project-role)
+- [How to Use](#how-to-use)
+- [References](#references)
+
+## Overview
+
+Every user may have 2 kind of roles: **Topcoder Roles** and **Project Role**.
+
+### Topcoder Roles
+
+These roles are assigned to user accounts. User may have several **Topcoder Roles**. See [the list of all Topcoder Roles](https://github.com/topcoder-platform/tc-project-service/blob/develop/src/constants.js#L55-L69) which we use in Topcoder Project Service.
+
+<img src="./images/topcoder-roles.png" width="689">
+
+By default every user has one role `Topcoder User`, generally this means that such a user is either **customer** or **community member** (freelancer).
+
+### Project Role
+
+When user joins some project and become a member of the project, such a user has one **Project Role** inside that project. One user may have different **Project Role** in different projects. See [the list of all Project Roles](https://github.com/topcoder-platform/tc-project-service/blob/develop/src/constants.js#L23-L33) which we use in Topcoder Project Service.
+
+<img src="./images/project-roles.png" width="411">
+
+## How to Use
+
+Let's say you would like to add a new place in code where you want to check user roles/permissions. Please, follow the next guide:
+
+1. Check if we already have defined permission for your case in the [permissions list](https://htmlpreview.github.io/?https://github.com/topcoder-platform/tc-project-service/blob/develop/docs/permissions.html).
+
+2. If you cannot find the permission you need, add new permission to the file https://github.com/topcoder-platform/tc-project-service/blob/develop/src/permissions/constants.js.
+
+   - Follow the guides on how to add a new permission in the header of this file.
+
+3. After you add a new permission, regenerate [permissions list](https://htmlpreview.github.io/?https://github.com/topcoder-platform/tc-project-service/blob/develop/docs/permissions.html) by running `npm run generate:doc:permissions`.
+
+4. There are 2 places where you would usually check permissions:
+   1. Check if user can call some endpoint (https://github.com/topcoder-platform/tc-project-service/blob/develop/src/permissions/index.js):
+
+      ```js
+      Authorizer.setPolicy('projectMember.view', generalPermission(PERMISSION.READ_PROJECT_MEMBER));
+      ```
+
+      or
+
+      ```js
+      Authorizer.setPolicy('projectMember.edit', generalPermission([
+         PERMISSION.UPDATE_PROJECT_MEMBER_CUSTOMER,
+         PERMISSION.UPDATE_PROJECT_MEMBER_NON_CUSTOMER,
+      ]));
+      ```
+
+   2. Inside some endpoint code:
+
+      ```js
+      import util from '../util';
+      import { PERMISSION } from '../permissions/constants';
+
+      (req, res, next) => {
+         ...
+         if (hasPermissionByReq(permission, req)) {
+            ...
+         }
+         ...
+      }
+      ```
+
+## References
+
+- [Permissions list](https://htmlpreview.github.io/?https://github.com/topcoder-platform/tc-project-service/blob/develop/docs/permissions.html)
+
+- [Permissions list source](https://github.com/topcoder-platform/tc-project-service/blob/develop/src/permissions/constants.js)

docs/guides/permissions-guide/images/project-roles.png

@@ -1,23 +1,28 @@
 version: "2"
 services:
   jsonserver:
-    extends:
-      file: ../docker-compose.yml
-      service: jsonserver
+    build: "../mock-services"
+    ports:
+      - "3001:3001"
   db:
-    extends:
-      file: ../docker-compose.yml
-      service: db
+    build: "../postgres-db"
+    ports:
+      - "5432:5432"
     environment:
+      - POSTGRES_PASSWORD=mysecretpassword
+      - POSTGRES_USER=coder
       - POSTGRES_MULTIPLE_DATABASES=projectsdb,projectsdb_test,tc_notifications
   esearch:
-    extends:
-      file: ../docker-compose.yml
-      service: esearch
+    image: "elasticsearch:2.3"
+    ports:
+      - "9200:9200"
+      - "9300:9300"
   queue:
-    extends:
-      file: ../docker-compose.yml
-      service: queue
+    image: "rabbitmq:3-management"
+    restart: always
+    ports:
+      - "5672:5672"
+      - "15672:15672"
   zookeeper:
     image: wurstmeister/zookeeper
     ports:

docs/guides/permissions-guide/images/topcoder-roles.png

@@ -0,0 +1,23 @@
+version: "2"
+services:
+  jsonserver:
+    extends:
+      file: ../full/docker-compose.yml
+      service: jsonserver
+
+  db:
+    extends:
+      file: ../full/docker-compose.yml
+      service: db
+    environment:
+      - POSTGRES_MULTIPLE_DATABASES=projectsdb,projectsdb_test
+
+  esearch:
+    extends:
+      file: ../full/docker-compose.yml
+      service: esearch
+
+  queue:
+    extends:
+      file: ../full/docker-compose.yml
+      service: queue