hawks-atlanta / proxy-python

Capyfile proxy for the web client

proxy-python

Description

Proxy service intended to forward traffic between clients and gateway-java so they don't need to suffer SOAP

Development

You will follow this guide as you are in the root of repository.

Python environment

First of all you need to setup your python environment.

python -m venv venv

Once created, activate it:

• Windows

# If you prefer CMD
./venv/Scripts/activate.bat

# If you prefer PowerShell
./venv/Scripts/Activate/ps1

• Linux

source ./venv/bin/activate

Finally install the dependencies

pip install -r requirements.txt

Services

Make sure you setup the needed services.

docker compose up -d

Testing

coverage run -m pytest

Formatting and linting

If you installed the recommended extensions for VSCode, you may have the formatting and linting configured out of the box.

Additionally, you may need to configure black to format python files with the following steps:

• Open the command palette (Ctrl + Shift + P)
• Search Format Document With...
• Search Configure Default Formatter...
• Select "Black Formatter"

You can also run the following commands to format and lint the code from the console:

# Check format
black --check .

# Format all python files
black .

# Check lint
ruff check .

# Fix lint (if possible)
ruff check --fix .

Coverage

proxy-python's Issues

feat: Move a file

feat: Endpoint to check if a file is ready

• Endpoint
• Tests

feat: Endpoint to rename a file

feat: Remove a file

docs: README

Write a readme with:

• Tittle
• Badges
• Development environment setup
• Coverage report

feat: Unshare a file

feat: Endpoint to update the password

docs: Openapi specification

feat: Endpoint to verify and / or refresh the session

This is the /challenge endpoint.

cd: Set proxy address from the Dockerfile

feat: Get the users with whom a file is being shared

This is the /file/shared-with-who endpoint

feat: Endpoint to get the files shared with the user

This is the /file/shared endpoint

feat: Login endpoint

feat: List the user files

cd: add missing dependencies to the development docker compose

• Gateway environment variables
  • AUTHENTICATION_BASEURL
  • METADATA_BASEURL
  • WORKER_HOST
  • WORKER_PORT
• Missing worker service

fix: Do not remove "extension" from file name

As said in one of the comments in gateway-java/#74:

Users are responsible for their files, and the .ext is considered part of the name; they can remove it if they want to.

feat: Register endpoint

ci: Proposal to add a linter and formatter

Hi @MiguelMRojas, @andre154 👋.

Currently, your project doesn't have any code formatting or linting tools configured. What do you think about adding the following packages to your project:

• black: It's a Python code formatter, similar to prettier in JavaScript. There's even a VsCode extension available to automatically format files when you save changes.
• Pylint: It's a Python code linter, similar to eslint in JavaScript. It also offers a VsCode extension. While I haven't personally used it, it can help detect issues like unused imports, variables, and more, as mentioned on their website.

Please note that this isn't mandatory, but it can assist in maintaining a consistent code style and catching errors early in the development process.

fix: Directory location should be a valid UUID

docs: Update openapi spec

Remember that you should update your specification to align with the .NET proxy.

For instance, it appears that you're receiving the user token in the JSON body, while the .NET proxy is receiving it as a Bearer token.

feat: Download a file

refactor: Update existing endpoints

Update the following endpoints to be alike with the .net ones:

feat: Share a file

feat: Get file by its UUID

• Include endpoint in the spec
• Implement endpoint
• Add tests

feat: Endpoint to refresh the session

• Implemente the endpoint
• Add the endpoint to the openapi spec

ci-cd: frontend python

Continuous integration

• On push to main: build and release and coverage
• On pull request to dev: test
• On push to dev: Versioning

feat: Endpoint to create a folder

ci: rename repository

docs: Add bruno collections

Bruno is a Git friendly and Open Source alternative to insomnia and postman.

fix: CORS is not working when using the Dockerfile

How to reproduce?

Run the following command from the react repository.

docker-compose up

Now, try, to send any request from the react client. All the request should be rejected by CORS.

Possible solution

Enable all host by default in the CORS configuration.

fix: Cannot move files to the root directory

Uses should be able to move their files to their root directory by sending a null UUID to the Proxy. Just validate if the target_directory_uuid is a valid UUID if its not null.

feat: Endpoint to upload a file