feat(project_transfert): add new endpoints

Gemfile.lock

@@ -16,19 +16,19 @@ GEM
     base64 (0.3.0)
     bigdecimal (3.3.1)
     colorator (1.1.0)
-    concurrent-ruby (1.3.5)
+    concurrent-ruby (1.3.6)
     csv (3.3.5)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
     eventmachine (1.2.7)
-    ffi (1.17.2)
+    ffi (1.17.3)
     forwardable-extended (2.6.0)
     google-protobuf (4.33.2)
       bigdecimal
       rake (>= 13)
     http_parser.rb (0.8.0)
-    i18n (1.14.7)
+    i18n (1.14.8)
       concurrent-ruby (~> 1.0)
     jekyll (4.4.1)
       addressable (~> 2.4)
@@ -60,7 +60,7 @@ GEM
       nokogiri (~> 1.12)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    json (2.17.1)
+    json (2.18.0)
     kramdown (2.5.1)
       rexml (>= 3.3.9)
     kramdown-parser-gfm (1.1.0)
@@ -74,7 +74,7 @@ GEM
     mercenary (0.4.0)
     mini_portile2 (2.8.9)
     nio4r (2.7.5)
-    nokogiri (1.18.10)
+    nokogiri (1.19.0)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     parallel (1.27.0)
@@ -83,7 +83,7 @@ GEM
       racc
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    prism (1.6.0)
+    prism (1.7.0)
     public_suffix (7.0.0)
     puma (7.1.0)
       nio4r (~> 2.0)
@@ -97,7 +97,7 @@ GEM
       ffi (~> 1.0)
     regexp_parser (2.11.3)
     rexml (3.4.4)
-    rouge (4.6.1)
+    rouge (4.7.0)
     rubocop (1.81.7)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
@@ -109,13 +109,13 @@ GEM
       rubocop-ast (>= 1.47.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.48.0)
+    rubocop-ast (1.49.0)
       parser (>= 3.3.7.2)
-      prism (~> 1.4)
-    rubocop-performance (1.25.0)
+      prism (~> 1.7)
+    rubocop-performance (1.26.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.75.0, < 2.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
     ruby-progressbar (1.13.0)
     safe_yaml (1.0.5)
     sass-embedded (1.94.2)
@@ -130,9 +130,9 @@ GEM
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.8.0)
+    standard-performance (1.9.0)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.25.0)
+      rubocop-performance (~> 1.26.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     unicode-display_width (2.6.0)

_scalingo_api/events.md

@@ -2111,6 +2111,200 @@ Example object:
 
 --- row ---
 
+* **Project transfer invitation event base**
+
+_When:_ Common attributes for project transfer invitation events.
+
+{:.table}
+| field                         | type   | description                                   |
+| ----------------------------- | ------ | --------------------------------------------- |
+| transfer_invitation_id        | string | ID of the transfer invitation                 |
+| invited_user.id               | string | ID of the invited collaborator                |
+| invited_user.email            | string | Email of the invited collaborator             |
+| invited_user.username         | string | Username of the invited collaborator          |
+| inviter.id                    | string | ID of the inviter                             |
+| inviter.email                 | string | Email of the inviter                          |
+| inviter.username              | string | Username of the inviter                       |
+| status                        | string | Invitation status                             |
+| status_reason                 | string | Optional status rationale                     |
+| expires_at                    | date   | Expiration date of the invitation             |
+
+--- row ---
+
+* **Accept project transfer invitation event**
+
+_When:_ A project transfer invitation is accepted
+`type=accept_project_transfer_invitation`
+
+||| col |||
+
+Example object:
+
+```json
+{
+  "id": "650312574002c001afcdf988",
+  "created_at": "2023-09-14T14:01:59.916Z",
+  "project_id": "649e9d0389bca600016ea61b",
+  "project_name": "project-1",
+  "type": "accept_project_transfer_invitation",
+  "user": {
+    "username": "alice",
+    "email": "alice@example.com",
+    "id": "us-0e6d8e46-5cd0-42a4-acba-372b2be605ac"
+  },
+  "type_data": {
+    "transfer_invitation_id": "tin-01234567-89ab-cdef-0123-456789abcdef",
+    "invited_user": {
+      "id": "54100245736f7563d5000000",
+      "username": "alice",
+      "email": "alice@example.com"
+    },
+    "inviter": {
+      "id": "54100245736f7563d5000000",
+      "username": "john",
+      "email": "user@example.com"
+    },
+    "status": "accepted",
+    "status_reason": "Confirmed ownership transfer",
+    "expires_at": "2014-09-13T10:17:52.690+02:00"
+  }
+}
+```
+
+--- row ---
+
+* **Accept project transfer invitation error event**
+
+_When:_ Accepting a project transfer invitation fails
+`type=accept_project_transfer_invitation_error`
+
+{:.table}
+| field | type   | description                      |
+| ----- | ------ | -------------------------------- |
+| error | string | Error message for the failure    |
+
+||| col |||
+
+Example object:
+
+```json
+{
+  "id": "650312574002c001afcdf988",
+  "created_at": "2023-09-14T14:01:59.916Z",
+  "project_id": "649e9d0389bca600016ea61b",
+  "project_name": "project-1",
+  "type": "accept_project_transfer_invitation_error",
+  "user": {
+    "username": "alice",
+    "email": "alice@example.com",
+    "id": "us-0e6d8e46-5cd0-42a4-acba-372b2be605ac"
+  },
+  "type_data": {
+    "transfer_invitation_id": "tin-01234567-89ab-cdef-0123-456789abcdef",
+    "invited_user": {
+      "id": "54100245736f7563d5000000",
+      "username": "alice",
+      "email": "alice@example.com"
+    },
+    "inviter": {
+      "id": "54100245736f7563d5000000",
+      "username": "john",
+      "email": "user@example.com"
+    },
+    "status": "failed",
+    "status_reason": "Transfer ownership failed",
+    "expires_at": "2014-09-13T10:17:52.690+02:00",
+    "error": "Project transfer invitation already expired."
+  }
+}
+```
+
+--- row ---
+
+* **Cancel project transfer invitation event**
+
+_When:_ A project transfer invitation is canceled by the inviter
+`type=cancel_project_transfer_invitation`
+
+||| col |||
+
+Example object:
+
+```json
+{
+  "id": "650312574002c001afcdf988",
+  "created_at": "2023-09-14T14:01:59.916Z",
+  "project_id": "649e9d0389bca600016ea61b",
+  "project_name": "project-1",
+  "type": "cancel_project_transfer_invitation",
+  "user": {
+    "username": "john",
+    "email": "user@example.com",
+    "id": "us-0e6d8e46-5cd0-42a4-acba-372b2be605ac"
+  },
+  "type_data": {
+    "transfer_invitation_id": "tin-01234567-89ab-cdef-0123-456789abcdef",
+    "invited_user": {
+      "id": "54100245736f7563d5000000",
+      "username": "alice",
+      "email": "alice@example.com"
+    },
+    "inviter": {
+      "id": "54100245736f7563d5000000",
+      "username": "john",
+      "email": "user@example.com"
+    },
+    "status": "canceled",
+    "status_reason": "Canceled by inviter",
+    "expires_at": "2014-09-13T10:17:52.690+02:00"
+  }
+}
+```
+
+--- row ---
+
+* **Decline project transfer invitation event**
+
+_When:_ A project transfer invitation is declined by the invited collaborator
+`type=decline_project_transfer_invitation`
+
+||| col |||
+
+Example object:
+
+```json
+{
+  "id": "650312574002c001afcdf988",
+  "created_at": "2023-09-14T14:01:59.916Z",
+  "project_id": "649e9d0389bca600016ea61b",
+  "project_name": "project-1",
+  "type": "decline_project_transfer_invitation",
+  "user": {
+    "username": "alice",
+    "email": "alice@example.com",
+    "id": "us-0e6d8e46-5cd0-42a4-acba-372b2be605ac"
+  },
+  "type_data": {
+    "transfer_invitation_id": "tin-01234567-89ab-cdef-0123-456789abcdef",
+    "invited_user": {
+      "id": "54100245736f7563d5000000",
+      "username": "alice",
+      "email": "alice@example.com"
+    },
+    "inviter": {
+      "id": "54100245736f7563d5000000",
+      "username": "john",
+      "email": "user@example.com"
+    },
+    "status": "declined",
+    "status_reason": "Declined by invited collaborator",
+    "expires_at": "2014-09-13T10:17:52.690+02:00"
+  }
+}
+```
+
+--- row ---
+
 * **Project Deleted**
 
 _When:_ A project has been deleted