release: v0.13.0 (#79)

* docs: Add bruno collection (#77) * fix: move a file (#78) * feat: Shared with who (#75) * feat: Get the users with whom a file is being shared Endpoint to get the users with whom a file is shared. * refactor: Endpoint correction in addition to updating the spec * feat: The init and view are added for the endpoint shared with whom, in addition to implementing the tests The tests exceed the required 70% * docs(openapi): Update spec --------- Co-authored-by: Andvelavi <[email protected]> Co-authored-by: Pedro Andrés Chaparro Quintero <[email protected]>
hawks-atlanta · Oct 20, 2023 · bcf8e3c · bcf8e3c
1 parent 14ef24a
commit bcf8e3c
Show file tree

Hide file tree

Showing 29 changed files with 512 additions and 29 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,46 +1,45 @@
-# [0.12.0](https://github.com/hawks-atlanta/proxy-python/compare/v0.11.0...v0.12.0) (2023-10-20)
+# [0.13.0](https://github.com/hawks-atlanta/proxy-python/compare/v0.12.1...v0.13.0) (2023-10-20)
 
 
 ### Features
 
-* move a file ([#68](https://github.com/hawks-atlanta/proxy-python/issues/68)) ([b0a585c](https://github.com/hawks-atlanta/proxy-python/commit/b0a585c89c8ae09a49fa0549858d73f51ea6976a))
+* Shared with who ([#75](https://github.com/hawks-atlanta/proxy-python/issues/75)) ([3281cca](https://github.com/hawks-atlanta/proxy-python/commit/3281cca3edd3c702b2077bf1efc2d100c7cefe32))
 
 
 
-# [0.11.0](https://github.com/hawks-atlanta/proxy-python/compare/v0.10.0...v0.11.0) (2023-10-15)
+## [0.12.1](https://github.com/hawks-atlanta/proxy-python/compare/v0.12.0...v0.12.1) (2023-10-20)
 
 
-### Features
+### Bug Fixes
 
-* Get file by UUID ([#66](https://github.com/hawks-atlanta/proxy-python/issues/66)) ([b292621](https://github.com/hawks-atlanta/proxy-python/commit/b2926217b2e4cc03ea59525e1f59c0f2167b6791))
+* move a file ([#78](https://github.com/hawks-atlanta/proxy-python/issues/78)) ([80cb0eb](https://github.com/hawks-atlanta/proxy-python/commit/80cb0eb37675d67ead3349836fae2cac0cec167f))
 
 
 
-# [0.10.0](https://github.com/hawks-atlanta/proxy-python/compare/v0.9.0...v0.10.0) (2023-10-15)
+# [0.12.0](https://github.com/hawks-atlanta/proxy-python/compare/v0.11.0...v0.12.0) (2023-10-20)
 
 
 ### Features
 
-* list user files ([#64](https://github.com/hawks-atlanta/proxy-python/issues/64)) ([6daf51f](https://github.com/hawks-atlanta/proxy-python/commit/6daf51f7860e49bdd5d48c2878a525e14bb08c9a))
+* move a file ([#68](https://github.com/hawks-atlanta/proxy-python/issues/68)) ([b0a585c](https://github.com/hawks-atlanta/proxy-python/commit/b0a585c89c8ae09a49fa0549858d73f51ea6976a))
 
 
 
-# [0.9.0](https://github.com/hawks-atlanta/proxy-python/compare/v0.8.2...v0.9.0) (2023-10-15)
+# [0.11.0](https://github.com/hawks-atlanta/proxy-python/compare/v0.10.0...v0.11.0) (2023-10-15)
 
 
 ### Features
 
-* download file ([#60](https://github.com/hawks-atlanta/proxy-python/issues/60)) ([9bf0cdb](https://github.com/hawks-atlanta/proxy-python/commit/9bf0cdb8b7d4901fdcad1991c4a88766bf1a3bf2))
-* share a file with another user ([#61](https://github.com/hawks-atlanta/proxy-python/issues/61)) ([a6f7074](https://github.com/hawks-atlanta/proxy-python/commit/a6f7074c3e69edda8bc3c91c370b917c14cc3cc6))
+* Get file by UUID ([#66](https://github.com/hawks-atlanta/proxy-python/issues/66)) ([b292621](https://github.com/hawks-atlanta/proxy-python/commit/b2926217b2e4cc03ea59525e1f59c0f2167b6791))
 
 
 
-## [0.8.2](https://github.com/hawks-atlanta/proxy-python/compare/v0.8.1...v0.8.2) (2023-10-15)
+# [0.10.0](https://github.com/hawks-atlanta/proxy-python/compare/v0.9.0...v0.10.0) (2023-10-15)
 
 
-### Bug Fixes
+### Features
 
-* Add extra validations for UUIDs ([#65](https://github.com/hawks-atlanta/proxy-python/issues/65)) ([7c41c70](https://github.com/hawks-atlanta/proxy-python/commit/7c41c70445858a3e46e162d59692605375a2ec42))
+* list user files ([#64](https://github.com/hawks-atlanta/proxy-python/issues/64)) ([6daf51f](https://github.com/hawks-atlanta/proxy-python/commit/6daf51f7860e49bdd5d48c2878a525e14bb08c9a))
 
 
 
diff --git a/docs/bruno/README.md b/docs/bruno/README.md
@@ -0,0 +1,21 @@
+# Bruno
+
+Bruno is an OpenSource IDE for exploring and testing APIS ([usebruno/bruno](https://github.com/usebruno/bruno)).
+
+## How to use 🤔
+
+1. Install Bruno from [usebruno.com/downloads](https://www.usebruno.com/downloads).
+
+2. Click on the `Open Collection` option and search for the `bruno/` folder in this repository.
+
+3. Click on the `No Environment` option and select the `development`environment to set the base URL.
+
+4. Register and login as a user and set the `AUTH_TOKEN` environment variable to the token you received:
+
+![Graphic instructions to setup the bruno environment](https://github.com/hawks-atlanta/proxy-python/assets/62714297/bdaecab0-547c-4787-b410-d116419ae5ff)
+
+5. Run the request you want to test.
+
+## Notes 📝
+
+- The feature to upload files via `multipart/form-data` is not supported yet in Bruno. you can use `Insomnia` or `Postman` to test this feature.
diff --git a/docs/bruno/account/register.bru b/docs/bruno/account/register.bru
@@ -0,0 +1,18 @@
+meta {
+  name: register
+  type: http
+  seq: 1
+}
+
+post {
+  url: {{API_BASE_URL}}/account/register
+  body: json
+  auth: none
+}
+
+body:json {
+  {
+    "username": "woynert", 
+    "password": "password"
+  }
+}
diff --git a/docs/bruno/account/update-password.bru b/docs/bruno/account/update-password.bru
@@ -0,0 +1,22 @@
+meta {
+  name: update-password
+  type: http
+  seq: 2
+}
+
+patch {
+  url: {{API_BASE_URL}}/account/password
+  body: json
+  auth: bearer
+}
+
+auth:bearer {
+  token: {{AUTH_TOKEN}}
+}
+
+body:json {
+  {
+    "oldPassword": "password",
+    "newPassword": "secure"
+  }
+}
diff --git a/docs/bruno/auth/challenge-and-refresh.bru b/docs/bruno/auth/challenge-and-refresh.bru
@@ -0,0 +1,15 @@
+meta {
+  name: challenge-and-refresh
+  type: http
+  seq: 2
+}
+
+post {
+  url: {{API_BASE_URL}}/auth/refresh
+  body: none
+  auth: bearer
+}
+
+auth:bearer {
+  token: {{AUTH_TOKEN}}
+}
diff --git a/docs/bruno/auth/login.bru b/docs/bruno/auth/login.bru
@@ -0,0 +1,18 @@
+meta {
+  name: login
+  type: http
+  seq: 1
+}
+
+post {
+  url: {{API_BASE_URL}}/auth/login
+  body: json
+  auth: none
+}
+
+body:json {
+  {
+    "username": "woynert", 
+    "password": "password"
+  }
+}
diff --git a/docs/bruno/bruno.json b/docs/bruno/bruno.json
@@ -0,0 +1,5 @@
+{
+  "version": "1",
+  "name": "Proxy Python",
+  "type": "collection"
+}
diff --git a/docs/bruno/environments/development.bru b/docs/bruno/environments/development.bru
@@ -0,0 +1,6 @@
+vars {
+  API_BASE_URL: http://127.0.0.1:5000
+}
+vars:secret [
+  AUTH_TOKEN
+]
diff --git a/docs/bruno/files/create-folder-in-folder.bru b/docs/bruno/files/create-folder-in-folder.bru
@@ -0,0 +1,22 @@
+meta {
+  name: create-folder-in-folder
+  type: http
+  seq: 6
+}
+
+post {
+  url: {{API_BASE_URL}}/folders
+  body: json
+  auth: bearer
+}
+
+auth:bearer {
+  token: {{AUTH_TOKEN}}
+}
+
+body:json {
+  {
+    "directoryName": "nested", 
+    "location": "25d8cec5-f2d4-4b9e-90b9-06c7093bf027"
+  }
+}
diff --git a/docs/bruno/files/create-folder-in-root.bru b/docs/bruno/files/create-folder-in-root.bru
@@ -0,0 +1,22 @@
+meta {
+  name: create-folder-in-root
+  type: http
+  seq: 2
+}
+
+post {
+  url: {{API_BASE_URL}}/folders
+  body: json
+  auth: bearer
+}
+
+auth:bearer {
+  token: {{AUTH_TOKEN}}
+}
+
+body:json {
+  {
+    "directoryName": "university", 
+    "location": null
+  }
+}
diff --git a/docs/bruno/files/download-file.bru b/docs/bruno/files/download-file.bru
@@ -0,0 +1,15 @@
+meta {
+  name: download-file
+  type: http
+  seq: 9
+}
+
+get {
+  url: {{API_BASE_URL}}/file/download/ac682ad3-e525-49af-a257-2697c80fe15a
+  body: none
+  auth: bearer
+}
+
+auth:bearer {
+  token: {{AUTH_TOKEN}}
+}
diff --git a/docs/bruno/files/ger-file-status.bru b/docs/bruno/files/ger-file-status.bru
@@ -0,0 +1,15 @@
+meta {
+  name: ger-file-status
+  type: http
+  seq: 10
+}
+
+get {
+  url: {{API_BASE_URL}}/file/ac682ad3-e525-49af-a257-2697c80fe15a/status
+  body: none
+  auth: bearer
+}
+
+auth:bearer {
+  token: {{AUTH_TOKEN}}
+}
diff --git a/docs/bruno/files/get-file-metadata.bru b/docs/bruno/files/get-file-metadata.bru
@@ -0,0 +1,15 @@
+meta {
+  name: get-file-metadata
+  type: http
+  seq: 11
+}
+
+get {
+  url: {{API_BASE_URL}}/file/ac682ad3-e525-49af-a257-2697c80fe15a
+  body: none
+  auth: bearer
+}
+
+auth:bearer {
+  token: {{AUTH_TOKEN}}
+}
diff --git a/docs/bruno/files/list-files-in-folder.bru b/docs/bruno/files/list-files-in-folder.bru
@@ -0,0 +1,19 @@
+meta {
+  name: list-files-in-folder
+  type: http
+  seq: 8
+}
+
+get {
+  url: {{API_BASE_URL}}/file/list?directoryUUID=25d8cec5-f2d4-4b9e-90b9-06c7093bf027
+  body: none
+  auth: bearer
+}
+
+query {
+  directoryUUID: 25d8cec5-f2d4-4b9e-90b9-06c7093bf027
+}
+
+auth:bearer {
+  token: {{AUTH_TOKEN}}
+}
diff --git a/docs/bruno/files/list-files-in-root.bru b/docs/bruno/files/list-files-in-root.bru
@@ -0,0 +1,15 @@
+meta {
+  name: list-files-in-root
+  type: http
+  seq: 4
+}
+
+get {
+  url: {{API_BASE_URL}}/file/list
+  body: none
+  auth: bearer
+}
+
+auth:bearer {
+  token: {{AUTH_TOKEN}}
+}
diff --git a/docs/bruno/files/move-file-to-folder.bru b/docs/bruno/files/move-file-to-folder.bru
@@ -0,0 +1,17 @@
+meta {
+  name: move-file-to-folder
+  type: http
+  seq: 7
+}
+
+patch {
+  url: {{API_BASE_URL}}/file/ac682ad3-e525-49af-a257-2697c80fe15a/move
+  body: json
+  auth: none
+}
+
+body:json {
+  {
+    "targetDirectoryUUID": "25d8cec5-f2d4-4b9e-90b9-06c7093bf027",
+  }
+}
diff --git a/docs/bruno/files/move-file-to-root.bru b/docs/bruno/files/move-file-to-root.bru
@@ -0,0 +1,17 @@
+meta {
+  name: move-file-to-root
+  type: http
+  seq: 3
+}
+
+patch {
+  url: {{API_BASE_URL}}/file/ac682ad3-e525-49af-a257-2697c80fe15a/move
+  body: json
+  auth: none
+}
+
+body:json {
+  {
+    "targetDirectoryUUID": null,
+  }
+}
diff --git a/docs/bruno/files/rename-file.bru b/docs/bruno/files/rename-file.bru
@@ -0,0 +1,17 @@
+meta {
+  name: rename-file
+  type: http
+  seq: 12
+}
+
+patch {
+  url: {{API_BASE_URL}}/file/ac682ad3-e525-49af-a257-2697c80fe15a/rename
+  body: json
+  auth: none
+}
+
+body:json {
+  {
+    "newName": "renamed"
+  }
+}
diff --git a/docs/bruno/files/share-file.bru b/docs/bruno/files/share-file.bru
@@ -0,0 +1,22 @@
+meta {
+  name: share-file
+  type: http
+  seq: 12
+}
+
+post {
+  url: {{API_BASE_URL}}/file/share
+  body: json
+  auth: bearer
+}
+
+auth:bearer {
+  token: {{AUTH_TOKEN}}
+}
+
+body:json {
+  {
+    "fileUUID": "ac682ad3-e525-49af-a257-2697c80fe15a",
+    "otherUsername": "miguel"
+  }
+}
diff --git a/docs/bruno/files/shared-with-who.bru b/docs/bruno/files/shared-with-who.bru
@@ -0,0 +1,15 @@
+meta {
+  name: shared-with-who
+  type: http
+  seq: 13
+}
+
+get {
+  url: {{API_BASE_URL}}/file/ac682ad3-e525-49af-a257-2697c80fe15a/shared-with-who
+  body: none
+  auth: bearer
+}
+
+auth:bearer {
+  token: {{AUTH_TOKEN}}
+}