Views

AccountAPIDetail

Bases: APIView

Representação da API que lida com operações detalhadas relacionadas a uma conta financeira específica do usuário.

Atributos

Nenhum atributo específico nesta classe.

Métodos

get_account: Obtém uma conta financeira específica com base no ID. get_permissions: Retorna as permissões apropriadas com base no método da solicitação. get: Retorna detalhes de uma conta financeira específica. patch_balance: Atualiza valor monetário de uma conta financeira específica. delete: Exclui uma conta financeira específica.

Endpoint Base

/api/account//

Source code in finances/views.py

class AccountAPIDetail(APIView):
    """
    Representação da API que lida com operações detalhadas relacionadas a uma
    conta financeira específica do usuário.

    Atributos:
        Nenhum atributo específico nesta classe.

    Métodos:
        get_account: Obtém uma conta financeira específica com base no ID.
        get_permissions: Retorna as permissões apropriadas com base no método
        da solicitação.
        get: Retorna detalhes de uma conta financeira específica.
        patch_balance: Atualiza valor monetário de uma conta financeira
        específica.
        delete: Exclui uma conta financeira específica.

    Endpoint Base:
        /api/account/<pk>/
    """

    def get_account(self, pk):
        """
        Método auxiliar para obter uma conta financeira com base no ID.

        Parâmetros:
            pk: O ID da conta a ser obtida.

        Retorna:
            Account: A conta financeira encontrada com base no ID fornecido.

        Raises:
            PermissionDenied: Se o usuário autenticado não for o proprietário
            da conta, a exceção será levantada.

        Exemplo de Uso:
            account = self.get_account(1)
        """

        account = get_object_or_404(
            Account.objects.all(),
            pk=pk
        )

        if account.owner != self.request.user:
            raise PermissionDenied(
                'Você não tem permissão para executar essa ação.'
            )

        return account

    def get_permissions(self):
        """
        Método para definir as permissões necessárias para cada tipo de
        solicitação.
        Retorna a permissão 'IsOwner' para os métodos GET, PATCH e DELETE, que
        permitem que o proprietário da transação
        acesse ou modifique os dados. Para outros métodos de solicitação, a
        permissão padrão é aplicada.

        Retorna:
            List: Uma lista de permissões específicas com base no tipo de
            método da solicitação.
        """

        if self.request.method in ['GET', 'PATCH', 'DELETE']:
            return [IsOwner(), ]
        return super().get_permissions()

    def get(self, request, pk):
        """
        Método HTTP GET para obter detalhes de uma conta financeira específica.

        Parâmetros:
            request: O objeto de solicitação HTTP.
            pk: O ID da conta a ser obtida.

        Retorna:
            Response: Uma resposta HTTP contendo os detalhes da conta em
            formato JSON.
        """

        account = self.get_account(pk)

        owner_serializer = OwnerSerializer(account.owner)

        transactions = account.transaction_set.all()
        transaction_serializer = TransactionSerializer(transactions, many=True)

        budgets = account.budget_set.all()
        budget_serializer = BudgetSerializer(budgets, many=True)

        return Response({
            'owner': owner_serializer.data,
            'transactions': transaction_serializer.data,
            'budgets': budget_serializer.data
        })

    def patch(self, request, pk):
        """
        Método HTTP PATCH para atualizar os dados de uma conta financeira
        específica.

        Parâmetros:
            request: O objeto de solicitação contendo os dados a serem
            atualizados.
            pk: O ID da conta a ser atualizada.

        Retorna:
            Response: Uma resposta HTTP contendo os detalhes da conta
            atualizada em formato JSON.
        """

        account = self.get_account(pk)

        serializer = AccountSerializer(
            instance=account,
            data=request.data,
            many=False,
            context={'request': request},
            partial=True
        )

        serializer.is_valid(raise_exception=True)

        serializer.save()

        return Response(serializer.data)

    def delete(self, request, pk):
        """
        Método HTTP DELETE para excluir uma conta financeira específica.

        Parâmetros:
            request: O objeto de solicitação HTTP.
            pk: O ID da conta a ser excluída.

        Retorna:
            Response: Uma resposta HTTP com status 204 No Content como
            confirmação.
        """

        account = self.get_account(pk)

        account.delete()

        return Response(status=status.HTTP_204_NO_CONTENT)

delete(request, pk)

Método HTTP DELETE para excluir uma conta financeira específica.

Parâmetros

request: O objeto de solicitação HTTP. pk: O ID da conta a ser excluída.

Retorna

Response: Uma resposta HTTP com status 204 No Content como confirmação.

Source code in finances/views.py

def delete(self, request, pk):
    """
    Método HTTP DELETE para excluir uma conta financeira específica.

    Parâmetros:
        request: O objeto de solicitação HTTP.
        pk: O ID da conta a ser excluída.

    Retorna:
        Response: Uma resposta HTTP com status 204 No Content como
        confirmação.
    """

    account = self.get_account(pk)

    account.delete()

    return Response(status=status.HTTP_204_NO_CONTENT)

get(request, pk)

Método HTTP GET para obter detalhes de uma conta financeira específica.

Parâmetros

request: O objeto de solicitação HTTP. pk: O ID da conta a ser obtida.

Retorna

Response: Uma resposta HTTP contendo os detalhes da conta em formato JSON.

Source code in finances/views.py

def get(self, request, pk):
    """
    Método HTTP GET para obter detalhes de uma conta financeira específica.

    Parâmetros:
        request: O objeto de solicitação HTTP.
        pk: O ID da conta a ser obtida.

    Retorna:
        Response: Uma resposta HTTP contendo os detalhes da conta em
        formato JSON.
    """

    account = self.get_account(pk)

    owner_serializer = OwnerSerializer(account.owner)

    transactions = account.transaction_set.all()
    transaction_serializer = TransactionSerializer(transactions, many=True)

    budgets = account.budget_set.all()
    budget_serializer = BudgetSerializer(budgets, many=True)

    return Response({
        'owner': owner_serializer.data,
        'transactions': transaction_serializer.data,
        'budgets': budget_serializer.data
    })

get_account(pk)

Método auxiliar para obter uma conta financeira com base no ID.

Parâmetros

pk: O ID da conta a ser obtida.

Retorna

Account: A conta financeira encontrada com base no ID fornecido.

Raises:

Type	Description
PermissionDenied	Se o usuário autenticado não for o proprietário

Exemplo de Uso

account = self.get_account(1)

Source code in finances/views.py

def get_account(self, pk):
    """
    Método auxiliar para obter uma conta financeira com base no ID.

    Parâmetros:
        pk: O ID da conta a ser obtida.

    Retorna:
        Account: A conta financeira encontrada com base no ID fornecido.

    Raises:
        PermissionDenied: Se o usuário autenticado não for o proprietário
        da conta, a exceção será levantada.

    Exemplo de Uso:
        account = self.get_account(1)
    """

    account = get_object_or_404(
        Account.objects.all(),
        pk=pk
    )

    if account.owner != self.request.user:
        raise PermissionDenied(
            'Você não tem permissão para executar essa ação.'
        )

    return account

get_permissions()

Método para definir as permissões necessárias para cada tipo de solicitação. Retorna a permissão 'IsOwner' para os métodos GET, PATCH e DELETE, que permitem que o proprietário da transação acesse ou modifique os dados. Para outros métodos de solicitação, a permissão padrão é aplicada.

Retorna

List: Uma lista de permissões específicas com base no tipo de método da solicitação.

Source code in finances/views.py

def get_permissions(self):
    """
    Método para definir as permissões necessárias para cada tipo de
    solicitação.
    Retorna a permissão 'IsOwner' para os métodos GET, PATCH e DELETE, que
    permitem que o proprietário da transação
    acesse ou modifique os dados. Para outros métodos de solicitação, a
    permissão padrão é aplicada.

    Retorna:
        List: Uma lista de permissões específicas com base no tipo de
        método da solicitação.
    """

    if self.request.method in ['GET', 'PATCH', 'DELETE']:
        return [IsOwner(), ]
    return super().get_permissions()

patch(request, pk)

Método HTTP PATCH para atualizar os dados de uma conta financeira específica.

Parâmetros

request: O objeto de solicitação contendo os dados a serem atualizados. pk: O ID da conta a ser atualizada.

Retorna

Response: Uma resposta HTTP contendo os detalhes da conta atualizada em formato JSON.

Source code in finances/views.py

def patch(self, request, pk):
    """
    Método HTTP PATCH para atualizar os dados de uma conta financeira
    específica.

    Parâmetros:
        request: O objeto de solicitação contendo os dados a serem
        atualizados.
        pk: O ID da conta a ser atualizada.

    Retorna:
        Response: Uma resposta HTTP contendo os detalhes da conta
        atualizada em formato JSON.
    """

    account = self.get_account(pk)

    serializer = AccountSerializer(
        instance=account,
        data=request.data,
        many=False,
        context={'request': request},
        partial=True
    )

    serializer.is_valid(raise_exception=True)

    serializer.save()

    return Response(serializer.data)

AccountAPIList

Bases: APIView

Representação da API para gerenciar contas financeiras dos usuários.

Atributos

Nenhum atributo específico nesta classe.

Métodos

get_permissions: Retorna as permissões apropriadas com base no método da solicitação. get: Retorna uma lista de todas as contas financeiras registradas. post: Cria uma nova conta financeira.

Endpoint Base

/api/accounts/

Source code in finances/views.py

class AccountAPIList(APIView):
    """
    Representação da API para gerenciar contas financeiras dos usuários.

    Atributos:
        Nenhum atributo específico nesta classe.

    Métodos:
        get_permissions: Retorna as permissões apropriadas com base no método
        da solicitação.
        get: Retorna uma lista de todas as contas financeiras registradas.
        post: Cria uma nova conta financeira.

    Endpoint Base:
        /api/accounts/
    """

    permission_classes = [IsAdminUser, ]

    def get_permissions(self):
        """
        Retorna as permissões apropriadas com base no método da solicitação.

        Verifica o método da solicitação e retorna as permissões apropriadas de
        acordo com a lógica implementada.
        Para o método POST, retorna a permissão IsOwner, que verifica se o
        usuário autenticado é o proprietário.
        Para outros métodos, retorna as permissões de superclasse padrão.

        Parâmetros:
            self: A própria instância da classe.

        Retorna:
            List[permissions.BasePermission]: Lista de permissões a serem
            aplicadas à solicitação.
        """

        if self.request.method == 'POST':
            return [IsOwner()]
        return super().get_permissions()

    def get(self, request):
        """
        Método HTTP GET para listar todas as contas registradas.

        Parâmetros:
            request: O objeto de solicitação HTTP.

        Exemplo de Uso:
            GET /api/accounts/

        Exemplo de Resposta JSON:
            [
                {
                    "id": 1,
                    "name": "Tipo_de_Conta",
                    "balance": "850.00",
                    "created_at": "2023-08-16T15:44:33.227307-03:00",
                    "owner": 1
                },
                {
                    "id": 2,
                    "name": "Outro_Tipo_de_Conta",
                    "balance": "750.00",
                    "created_at": "2023-08-19T19:58:43.550259-03:00",
                    "owner": 2
                }
            ]

        Retorna:
            Response: Uma resposta HTTP contendo uma lista de contas em formato
            JSON.
        """

        accounts = Account.objects.all()

        if not accounts.exists():
            return Response({'message': 'There are no registered accounts.'})

        serializer = AccountSerializer(
            instance=accounts,
            many=True,
            context={'request': request}
        )

        return Response(serializer.data)

    def post(self, request):
        """
        Método HTTP POST para criar uma nova conta.
        Envia os dados da nova conta em formato JSON no corpo da solicitação.

        Parâmetros:
            request: O objeto de solicitação HTTP.

        Exempo de Uso:
            POST /api/accounts/

        Exemplo Request Body:
            {
                "name": "Tipo_de_Conta",
                "balance": 1000,
                "owner": 1
            }

        Retorna:
            Response: Uma resposta HTTP com status 201 Created como
            confirmação. Os detalhes da nova contasão retornados no corpo da
            resposta em formato JSON.
        """

        serializer = AccountSerializer(
            data=request.data,
            context={'request': request}
        )

        serializer.is_valid(raise_exception=True)

        serializer.save()

        return Response(
            serializer.data,
            status=status.HTTP_201_CREATED
        )

get(request)

Método HTTP GET para listar todas as contas registradas.

Parâmetros

request: O objeto de solicitação HTTP.

Exemplo de Uso

GET /api/accounts/

Exemplo de Resposta JSON

[ { "id": 1, "name": "Tipo_de_Conta", "balance": "850.00", "created_at": "2023-08-16T15:44:33.227307-03:00", "owner": 1 }, { "id": 2, "name": "Outro_Tipo_de_Conta", "balance": "750.00", "created_at": "2023-08-19T19:58:43.550259-03:00", "owner": 2 } ]

Retorna

Response: Uma resposta HTTP contendo uma lista de contas em formato JSON.

Source code in finances/views.py

def get(self, request):
    """
    Método HTTP GET para listar todas as contas registradas.

    Parâmetros:
        request: O objeto de solicitação HTTP.

    Exemplo de Uso:
        GET /api/accounts/

    Exemplo de Resposta JSON:
        [
            {
                "id": 1,
                "name": "Tipo_de_Conta",
                "balance": "850.00",
                "created_at": "2023-08-16T15:44:33.227307-03:00",
                "owner": 1
            },
            {
                "id": 2,
                "name": "Outro_Tipo_de_Conta",
                "balance": "750.00",
                "created_at": "2023-08-19T19:58:43.550259-03:00",
                "owner": 2
            }
        ]

    Retorna:
        Response: Uma resposta HTTP contendo uma lista de contas em formato
        JSON.
    """

    accounts = Account.objects.all()

    if not accounts.exists():
        return Response({'message': 'There are no registered accounts.'})

    serializer = AccountSerializer(
        instance=accounts,
        many=True,
        context={'request': request}
    )

    return Response(serializer.data)

get_permissions()

Retorna as permissões apropriadas com base no método da solicitação.

Verifica o método da solicitação e retorna as permissões apropriadas de acordo com a lógica implementada. Para o método POST, retorna a permissão IsOwner, que verifica se o usuário autenticado é o proprietário. Para outros métodos, retorna as permissões de superclasse padrão.

Parâmetros

self: A própria instância da classe.

Retorna

List[permissions.BasePermission]: Lista de permissões a serem aplicadas à solicitação.

Source code in finances/views.py

def get_permissions(self):
    """
    Retorna as permissões apropriadas com base no método da solicitação.

    Verifica o método da solicitação e retorna as permissões apropriadas de
    acordo com a lógica implementada.
    Para o método POST, retorna a permissão IsOwner, que verifica se o
    usuário autenticado é o proprietário.
    Para outros métodos, retorna as permissões de superclasse padrão.

    Parâmetros:
        self: A própria instância da classe.

    Retorna:
        List[permissions.BasePermission]: Lista de permissões a serem
        aplicadas à solicitação.
    """

    if self.request.method == 'POST':
        return [IsOwner()]
    return super().get_permissions()

post(request)

Método HTTP POST para criar uma nova conta. Envia os dados da nova conta em formato JSON no corpo da solicitação.

Parâmetros

request: O objeto de solicitação HTTP.

Exempo de Uso

POST /api/accounts/

Exemplo Request Body

{ "name": "Tipo_de_Conta", "balance": 1000, "owner": 1 }

Retorna

Response: Uma resposta HTTP com status 201 Created como confirmação. Os detalhes da nova contasão retornados no corpo da resposta em formato JSON.

Source code in finances/views.py

def post(self, request):
    """
    Método HTTP POST para criar uma nova conta.
    Envia os dados da nova conta em formato JSON no corpo da solicitação.

    Parâmetros:
        request: O objeto de solicitação HTTP.

    Exempo de Uso:
        POST /api/accounts/

    Exemplo Request Body:
        {
            "name": "Tipo_de_Conta",
            "balance": 1000,
            "owner": 1
        }

    Retorna:
        Response: Uma resposta HTTP com status 201 Created como
        confirmação. Os detalhes da nova contasão retornados no corpo da
        resposta em formato JSON.
    """

    serializer = AccountSerializer(
        data=request.data,
        context={'request': request}
    )

    serializer.is_valid(raise_exception=True)

    serializer.save()

    return Response(
        serializer.data,
        status=status.HTTP_201_CREATED
    )

BudgetAPIDetail

Bases: APIView

Representação da API que lida com operações detalhadas relacionadas a um orçamento específico do titular.

Atributos

Nenhum atributo específico nesta classe.

Métodos

get_budget: Obtém um orçamento específico com base no ID. get_permissions: Retorna as permissões apropriadas com base no método da solicitação. get: Retorna os detalhes de um orçamento específico. patch: Atualiza os dados do orçamento de forma parcial. delete: Exclui um orçamento específico.

Source code in finances/views.py

class BudgetAPIDetail(APIView):
    """
    Representação da API que lida com operações detalhadas relacionadas a um
    orçamento específico do titular.

    Atributos:
        Nenhum atributo específico nesta classe.

    Métodos:
        get_budget: Obtém um orçamento específico com base no ID.
        get_permissions: Retorna as permissões apropriadas com base no método
        da solicitação.
        get: Retorna os detalhes de um orçamento específico.
        patch: Atualiza os dados do orçamento de forma parcial.
        delete: Exclui um orçamento específico.
    """

    def get_budget(self, pk):
        """
        Método auxilixar para obter um orçamento específico com base no ID.

        Parâmetros:
            request: O objeto da solicitação HTTP.
            pk: O ID do orçamento a ser obtido.

        Retorna:
            Response: Uma resposta HTTP contendo os detalhes do orçamento em
            formato JSON.
        """

        budget = get_object_or_404(
            Budget.objects.all(),
            pk=pk
        )

        self.check_object_permissions(self.request, budget)

        return budget

    def get_permissions(self):
        """
        Método para definir as permissões necessárias para cada tipo de
        solicitação.
        Retorna a permissão 'IsOwner' para os métodos GET, PUT e DELETE, que
        permitem que o proprietário da transação
        acesse ou modifique os dados. Para outros métodos de solicitação, a
        permissão padrão é aplicada.

        Retorna:
            List: Uma lista de permissões específicas com base no tipo de
            método da solicitação.
        """

        if self.request.method in ['GET', 'PUT', 'DELETE']:
            return [IsOwner(), ]
        return super().get_permissions()

    def get(self, request, pk):
        """
        Método HTTP GET para obter detalhes de um orçamento específico.

        Parâmetros:
            request: O objeto da solicitação HTTP.
            pk: O ID do orçamento a ser obtido.

        Retorna:
            Response: Uma resposta HTTP contendo os detalhes do orçamento em
            formato JSON.
        """

        budget = self.get_budget(pk)

        serializer = BudgetSerializer(
            instance=budget,
            many=False,
            context={'request': request}
        )

        return Response(serializer.data)

    def put(self, request, pk):
        """
        Método HTTP PUT para atualizar os dados de um orçamento específico.

        Parâmetros:
            request: O objeto da soicitação HTTP.
            pk: O ID do orçamento a ser obtido.

        Retorna:
            Response: Uma resposta HTTP contendo os detalhes do orçamento
            atualizado em formato JSON.
        """

        budget = self.get_budget(pk)
        serializer = BudgetSerializer(
            instance=budget,
            data=request.data,
            context={'request': request}
        )

        try:
            serializer.is_valid(raise_exception=True)
            serializer.update(budget, serializer.validated_data)
        except ValidationError as e:
            return Response(
                {'error': e.detail},
                status=status.HTTP_400_BAD_REQUEST
            )

        return Response(serializer.data, status=status.HTTP_200_OK)

    def delete(self, request, pk):
        """
        Método HTTP DELETE para excluir um orçamento específico.

        Parâmetros:
            request: O objeto da solicitação HTTP.
            pk: O ID do orçamento a ser obtido.

        Retorna:
            Response: Uma resposta HTTP com status 204 No Content como
            confirmação.
        """

        budget = self.get_budget(pk)

        budget.delete()

        return Response(status=status.HTTP_204_NO_CONTENT)

delete(request, pk)

Método HTTP DELETE para excluir um orçamento específico.

Parâmetros

request: O objeto da solicitação HTTP. pk: O ID do orçamento a ser obtido.

Retorna

Response: Uma resposta HTTP com status 204 No Content como confirmação.

Source code in finances/views.py

def delete(self, request, pk):
    """
    Método HTTP DELETE para excluir um orçamento específico.

    Parâmetros:
        request: O objeto da solicitação HTTP.
        pk: O ID do orçamento a ser obtido.

    Retorna:
        Response: Uma resposta HTTP com status 204 No Content como
        confirmação.
    """

    budget = self.get_budget(pk)

    budget.delete()

    return Response(status=status.HTTP_204_NO_CONTENT)

get(request, pk)

Método HTTP GET para obter detalhes de um orçamento específico.

Parâmetros

request: O objeto da solicitação HTTP. pk: O ID do orçamento a ser obtido.

Retorna

Response: Uma resposta HTTP contendo os detalhes do orçamento em formato JSON.

Source code in finances/views.py

def get(self, request, pk):
    """
    Método HTTP GET para obter detalhes de um orçamento específico.

    Parâmetros:
        request: O objeto da solicitação HTTP.
        pk: O ID do orçamento a ser obtido.

    Retorna:
        Response: Uma resposta HTTP contendo os detalhes do orçamento em
        formato JSON.
    """

    budget = self.get_budget(pk)

    serializer = BudgetSerializer(
        instance=budget,
        many=False,
        context={'request': request}
    )

    return Response(serializer.data)

get_budget(pk)

Método auxilixar para obter um orçamento específico com base no ID.

Parâmetros

request: O objeto da solicitação HTTP. pk: O ID do orçamento a ser obtido.

Retorna

Response: Uma resposta HTTP contendo os detalhes do orçamento em formato JSON.

Source code in finances/views.py

def get_budget(self, pk):
    """
    Método auxilixar para obter um orçamento específico com base no ID.

    Parâmetros:
        request: O objeto da solicitação HTTP.
        pk: O ID do orçamento a ser obtido.

    Retorna:
        Response: Uma resposta HTTP contendo os detalhes do orçamento em
        formato JSON.
    """

    budget = get_object_or_404(
        Budget.objects.all(),
        pk=pk
    )

    self.check_object_permissions(self.request, budget)

    return budget

get_permissions()

Método para definir as permissões necessárias para cada tipo de solicitação. Retorna a permissão 'IsOwner' para os métodos GET, PUT e DELETE, que permitem que o proprietário da transação acesse ou modifique os dados. Para outros métodos de solicitação, a permissão padrão é aplicada.

Retorna

List: Uma lista de permissões específicas com base no tipo de método da solicitação.

Source code in finances/views.py

def get_permissions(self):
    """
    Método para definir as permissões necessárias para cada tipo de
    solicitação.
    Retorna a permissão 'IsOwner' para os métodos GET, PUT e DELETE, que
    permitem que o proprietário da transação
    acesse ou modifique os dados. Para outros métodos de solicitação, a
    permissão padrão é aplicada.

    Retorna:
        List: Uma lista de permissões específicas com base no tipo de
        método da solicitação.
    """

    if self.request.method in ['GET', 'PUT', 'DELETE']:
        return [IsOwner(), ]
    return super().get_permissions()

put(request, pk)

Método HTTP PUT para atualizar os dados de um orçamento específico.

Parâmetros

request: O objeto da soicitação HTTP. pk: O ID do orçamento a ser obtido.

Retorna

Response: Uma resposta HTTP contendo os detalhes do orçamento atualizado em formato JSON.

Source code in finances/views.py

def put(self, request, pk):
    """
    Método HTTP PUT para atualizar os dados de um orçamento específico.

    Parâmetros:
        request: O objeto da soicitação HTTP.
        pk: O ID do orçamento a ser obtido.

    Retorna:
        Response: Uma resposta HTTP contendo os detalhes do orçamento
        atualizado em formato JSON.
    """

    budget = self.get_budget(pk)
    serializer = BudgetSerializer(
        instance=budget,
        data=request.data,
        context={'request': request}
    )

    try:
        serializer.is_valid(raise_exception=True)
        serializer.update(budget, serializer.validated_data)
    except ValidationError as e:
        return Response(
            {'error': e.detail},
            status=status.HTTP_400_BAD_REQUEST
        )

    return Response(serializer.data, status=status.HTTP_200_OK)

BudgetAPIList

Bases: APIView

Representação da API para gerenciar os orçamentos realizados pelo titular.

Atributos

Nenhum atrbibuto específico nesta classe.

Métodos

get_permissions: Retorna as permissões apropriadas com base no método da solicitação. get: Obtém uma lista de todos os orçamentos realizados. post: Cria um novo orçamento.

Endpoint Base

/api/budgets/

Source code in finances/views.py

class BudgetAPIList(APIView):
    """
    Representação da API para gerenciar os orçamentos realizados pelo titular.

    Atributos:
        Nenhum atrbibuto específico nesta classe.

    Métodos:
        get_permissions: Retorna as permissões apropriadas com base no método
        da solicitação.
        get: Obtém uma lista de todos os orçamentos realizados.
        post: Cria um novo orçamento.

    Endpoint Base:
        /api/budgets/
    """

    permission_classes = [IsAdminUser, ]

    def get_permissions(self):
        """
        Retorna as permissões apropriadas com base no método da solicitação.

        Verifica o método da solicitação e retorna as permissões apropriadas de
        acordo com a lógica implementada.
        Para o método POST, retorna a permissão IsOwner, que verifica se o
        usuário autenticado é o proprietário.
        Para outros métodos, retorna as permissões de superclasse padrão.

        Parâmetros:
            self: A própria instância da classe.

        Retorna:
            List[permissions.BasePermission]: Lista de permissões a serem
            aplicadas à solicitação.
        """

        if self.request.method == 'POST':
            return [IsOwner()]
        return super().get_permissions()

    def get(self, request):
        """
        Método HTTP GET para listar todos os orçamentos registrados.

        Parâmetros:
            request: O objeto da solicitação.

        Exemplo de Uso:
            GET /api/budgets/

        Exemplo de Resposta JSON:
            [
                {
                    "id": 1,
                    "account": 3,
                    "category": 1,
                    "amount": "500.00",
                    "start_date": "2023-08-01",
                    "end_date": "2023-08-31"
                }
            ]

        Retorna:
            Response: Uma resposta HTTP contendo uma lista de orçamentos em
            formato JSON.
        """

        budgets = Budget.objects.all()

        if not budgets.exists():
            return Response({'message': 'There are no registered budgets.'})

        serializer = BudgetSerializer(
            instance=budgets,
            many=True,
            context={'request': request}
        )

        return Response(serializer.data)

    def post(self, request):
        """
        Método HTTP POST para criar um novo orçamento.
        Envia os dados do novo orçamento em formato JSON no corpo da
        solicitação.

        Parâmetros:
            request: O objeto da solicitação.

        Exemplo de Uso:
            POST /api/budgets/

        Exemplo de Request Body:
            [
                {
                    "account": 3,
                    "category": 1,
                    "amount": "500.00",
                    "start_date": "Data_de_Início_do_Orçamento",
                    "end_date": "Data_de_Término_do_Orçamento"
                },
            ]

        Retorna:
            Response: Uma resposta HTTP com status 201 Created como
            confirmação. Os detalhes do novo orçamento são retornados no corpo
            da resposta em formato JSON.
        """

        serializer = BudgetSerializer(
            data=request.data,
            context={'request': request}
        )

        serializer.is_valid(raise_exception=True)

        serializer.save()

        return Response(serializer.data, status=status.HTTP_201_CREATED)

get(request)

Método HTTP GET para listar todos os orçamentos registrados.

Parâmetros

request: O objeto da solicitação.

Exemplo de Uso

GET /api/budgets/

Exemplo de Resposta JSON

[ { "id": 1, "account": 3, "category": 1, "amount": "500.00", "start_date": "2023-08-01", "end_date": "2023-08-31" } ]

Retorna

Response: Uma resposta HTTP contendo uma lista de orçamentos em formato JSON.

Source code in finances/views.py

def get(self, request):
    """
    Método HTTP GET para listar todos os orçamentos registrados.

    Parâmetros:
        request: O objeto da solicitação.

    Exemplo de Uso:
        GET /api/budgets/

    Exemplo de Resposta JSON:
        [
            {
                "id": 1,
                "account": 3,
                "category": 1,
                "amount": "500.00",
                "start_date": "2023-08-01",
                "end_date": "2023-08-31"
            }
        ]

    Retorna:
        Response: Uma resposta HTTP contendo uma lista de orçamentos em
        formato JSON.
    """

    budgets = Budget.objects.all()

    if not budgets.exists():
        return Response({'message': 'There are no registered budgets.'})

    serializer = BudgetSerializer(
        instance=budgets,
        many=True,
        context={'request': request}
    )

    return Response(serializer.data)

get_permissions()

Retorna as permissões apropriadas com base no método da solicitação.

Verifica o método da solicitação e retorna as permissões apropriadas de acordo com a lógica implementada. Para o método POST, retorna a permissão IsOwner, que verifica se o usuário autenticado é o proprietário. Para outros métodos, retorna as permissões de superclasse padrão.

Parâmetros

self: A própria instância da classe.

Retorna

List[permissions.BasePermission]: Lista de permissões a serem aplicadas à solicitação.

Source code in finances/views.py

def get_permissions(self):
    """
    Retorna as permissões apropriadas com base no método da solicitação.

    Verifica o método da solicitação e retorna as permissões apropriadas de
    acordo com a lógica implementada.
    Para o método POST, retorna a permissão IsOwner, que verifica se o
    usuário autenticado é o proprietário.
    Para outros métodos, retorna as permissões de superclasse padrão.

    Parâmetros:
        self: A própria instância da classe.

    Retorna:
        List[permissions.BasePermission]: Lista de permissões a serem
        aplicadas à solicitação.
    """

    if self.request.method == 'POST':
        return [IsOwner()]
    return super().get_permissions()

post(request)

Método HTTP POST para criar um novo orçamento. Envia os dados do novo orçamento em formato JSON no corpo da solicitação.

Parâmetros

request: O objeto da solicitação.

Exemplo de Uso

POST /api/budgets/

Exemplo de Request Body

[ { "account": 3, "category": 1, "amount": "500.00", "start_date": "Data_de_Início_do_Orçamento", "end_date": "Data_de_Término_do_Orçamento" }, ]

Retorna

Response: Uma resposta HTTP com status 201 Created como confirmação. Os detalhes do novo orçamento são retornados no corpo da resposta em formato JSON.

Source code in finances/views.py

def post(self, request):
    """
    Método HTTP POST para criar um novo orçamento.
    Envia os dados do novo orçamento em formato JSON no corpo da
    solicitação.

    Parâmetros:
        request: O objeto da solicitação.

    Exemplo de Uso:
        POST /api/budgets/

    Exemplo de Request Body:
        [
            {
                "account": 3,
                "category": 1,
                "amount": "500.00",
                "start_date": "Data_de_Início_do_Orçamento",
                "end_date": "Data_de_Término_do_Orçamento"
            },
        ]

    Retorna:
        Response: Uma resposta HTTP com status 201 Created como
        confirmação. Os detalhes do novo orçamento são retornados no corpo
        da resposta em formato JSON.
    """

    serializer = BudgetSerializer(
        data=request.data,
        context={'request': request}
    )

    serializer.is_valid(raise_exception=True)

    serializer.save()

    return Response(serializer.data, status=status.HTTP_201_CREATED)

CategoryAPIDetail

Bases: APIView

Representação da API que lida com operações detalhadas relacionadas a uma categoria específica.

Atributos

Nenhum atributo específico nesta classe.

Métodos

get_category: Obtém uma categoria específica com base no ID. get: Retorna detalhes sobre uma categoria específica. put: Atualiza o nome da categoria. delete: Exclui uma categoria específica.

Endpoint Base

/api/category//

Source code in finances/views.py

class CategoryAPIDetail(APIView):
    """
    Representação da API que lida com operações detalhadas relacionadas a uma
    categoria específica.

    Atributos:
        Nenhum atributo específico nesta classe.

    Métodos:
        get_category: Obtém uma categoria específica com base no ID.
        get: Retorna detalhes sobre uma categoria específica.
        put: Atualiza o nome da categoria.
        delete: Exclui uma categoria específica.

    Endpoint Base:
        /api/category/<pk>/
    """

    permission_classes = [IsAdminUser, ]

    def get_category(self, pk):
        """
        Método auxiliar para obter uma categoria com base no ID.

        Parâmetros:
            pk: O ID da categoria a ser obtida.

        Retorna:
            Category: A categoria encontrada com base no ID fornecido.

        Exemplo de Uso:
            category = self.get_category(1)
        """

        category = get_object_or_404(
            Category.objects.all(),
            pk=pk
        )

        return category

    def get(self, request, pk):
        """
        Método HTTP GET para obter detalhes de uma categoria específica.

        Parâmetros:
            request: O objeto da solicitação HTTP.
            pk: O ID da categoria a ser obtida.

        Retorna:
            Response: Uma resposta HTTP contendo os detalhes da categoria em
            formato JSON.
        """

        category = self.get_category(pk)

        serializer = CategorySerializer(
            instance=category,
            many=False,
            context={'request': request}
        )

        return Response(serializer.data)

    def put(self, request, pk):
        """
        Método HTTP PUT para atualizar o nome de uma categoria específica.

        Parâmetros:
            request: O objeto da solicitação HTTP.
            pk: O ID da cateogira a ser obtida.

        Retorna:
            Response: Uma resposta HTTP contendo os detalhes da categoria
            atualizida em formato JSON.
        """

        category = self.get_category(pk)

        serializer = CategorySerializer(
            instance=category,
            data=request.data,
            many=False,
            context={'request': request}
        )

        serializer.is_valid(raise_exception=True)

        serializer.save()

        return Response(serializer.data)

    def delete(self, request, pk):
        """
        Método HTTP DELETE para excluir uma categoria específica e, se houver
        transações ou orçamentos associados a ela, eles serão excluídos.

        Parâmetros:
            request: O objeto da solicitação HTTP.
            pk: O ID da categoria a ser obtida.

        Retorna:
            Response: Uma resposta HTTP com status 204 No Content como
            confirmação.
        """

        category = self.get_category(pk)

        transactions = Transaction.objects.filter(category=category)
        budgets = Budget.objects.filter(category=category)

        for transaction in transactions:
            transaction.delete()

        for budget in budgets:
            budget.delete()

        category.delete()

        return Response(status=status.HTTP_204_NO_CONTENT)

delete(request, pk)

Método HTTP DELETE para excluir uma categoria específica e, se houver transações ou orçamentos associados a ela, eles serão excluídos.

Parâmetros

request: O objeto da solicitação HTTP. pk: O ID da categoria a ser obtida.

Retorna

Response: Uma resposta HTTP com status 204 No Content como confirmação.

Source code in finances/views.py

def delete(self, request, pk):
    """
    Método HTTP DELETE para excluir uma categoria específica e, se houver
    transações ou orçamentos associados a ela, eles serão excluídos.

    Parâmetros:
        request: O objeto da solicitação HTTP.
        pk: O ID da categoria a ser obtida.

    Retorna:
        Response: Uma resposta HTTP com status 204 No Content como
        confirmação.
    """

    category = self.get_category(pk)

    transactions = Transaction.objects.filter(category=category)
    budgets = Budget.objects.filter(category=category)

    for transaction in transactions:
        transaction.delete()

    for budget in budgets:
        budget.delete()

    category.delete()

    return Response(status=status.HTTP_204_NO_CONTENT)

get(request, pk)

Método HTTP GET para obter detalhes de uma categoria específica.

Parâmetros

request: O objeto da solicitação HTTP. pk: O ID da categoria a ser obtida.

Retorna

Response: Uma resposta HTTP contendo os detalhes da categoria em formato JSON.

Source code in finances/views.py

def get(self, request, pk):
    """
    Método HTTP GET para obter detalhes de uma categoria específica.

    Parâmetros:
        request: O objeto da solicitação HTTP.
        pk: O ID da categoria a ser obtida.

    Retorna:
        Response: Uma resposta HTTP contendo os detalhes da categoria em
        formato JSON.
    """

    category = self.get_category(pk)

    serializer = CategorySerializer(
        instance=category,
        many=False,
        context={'request': request}
    )

    return Response(serializer.data)

get_category(pk)

Método auxiliar para obter uma categoria com base no ID.

Parâmetros

pk: O ID da categoria a ser obtida.

Retorna

Category: A categoria encontrada com base no ID fornecido.

Exemplo de Uso

category = self.get_category(1)

Source code in finances/views.py

def get_category(self, pk):
    """
    Método auxiliar para obter uma categoria com base no ID.

    Parâmetros:
        pk: O ID da categoria a ser obtida.

    Retorna:
        Category: A categoria encontrada com base no ID fornecido.

    Exemplo de Uso:
        category = self.get_category(1)
    """

    category = get_object_or_404(
        Category.objects.all(),
        pk=pk
    )

    return category

put(request, pk)

Método HTTP PUT para atualizar o nome de uma categoria específica.

Parâmetros

request: O objeto da solicitação HTTP. pk: O ID da cateogira a ser obtida.

Retorna

Response: Uma resposta HTTP contendo os detalhes da categoria atualizida em formato JSON.

Source code in finances/views.py

def put(self, request, pk):
    """
    Método HTTP PUT para atualizar o nome de uma categoria específica.

    Parâmetros:
        request: O objeto da solicitação HTTP.
        pk: O ID da cateogira a ser obtida.

    Retorna:
        Response: Uma resposta HTTP contendo os detalhes da categoria
        atualizida em formato JSON.
    """

    category = self.get_category(pk)

    serializer = CategorySerializer(
        instance=category,
        data=request.data,
        many=False,
        context={'request': request}
    )

    serializer.is_valid(raise_exception=True)

    serializer.save()

    return Response(serializer.data)

CategoryAPIList

Bases: APIView

Representação da API para gerenciar categorias de gastos.

Atributos

Nenhum atributo específico nesta classe.

Métodos

get: Retorna uma lista de todas as categorias registradas. post: Cria uma nova categoria.

Endpoint Base

/api/categories/

Source code in finances/views.py

class CategoryAPIList(APIView):
    """
    Representação da API para gerenciar categorias de gastos.

    Atributos:
        Nenhum atributo específico nesta classe.

    Métodos:
        get: Retorna uma lista de todas as categorias registradas.
        post: Cria uma nova categoria.

    Endpoint Base:
        /api/categories/
    """

    permission_classes = [IsAuthenticated, ]

    def get(self, request):
        """
        Método HTTP GET para listar todas as categorias registradas.

        Parâmetros:
            request: O objeto da solicitação HTTP.

        Exemplo de Uso:
            GET /api/categories/

        Exemplo de Resposta JSON:
            [
                {
                    "id": 1,
                    "name": "Nome_da_Categoria",
                },
                {
                    "id": 2,
                    "name": "Nome_da_Categoria",
                },
            ]

        Retorna:
            Response: Uma resposta HTTP contendo uma lista de categorias em
            formato JSON.
        """

        categories = Category.objects.all()

        if not categories.exists():
            return Response({'message': 'There are no registered categories.'})

        serializer = CategorySerializer(
            instance=categories,
            many=True,
            context={'request': request}
        )

        return Response(serializer.data)

    def post(self, request):
        """
        Método HTTP POST para criar uma nova categoria.

        Parâmetros:
            request: O objeto da solicitação HTTP.

        Exemplo de Uso:
            POST /api/categories/

        Exemplo de Request Body:
            {
                "name": "Nome_da_Categoria"
            }

        Retorna:
            Response: Uma resposta HTTP com status 201 Created como
            confirmação. Os detalhes da nova categoria são retornados no corpo
            da resposta em formato JSON.

        Erros:
            Se os dados enviados no corpo da solicitação forem inválidos, uma
            resposta HTTP com status 400 Bad Request é retornada contendo
            informações detalhadas sobre os erros.
        """

        serializer = CategorySerializer(
            data=request.data,
            context={'request': request}
        )

        if serializer.is_valid():

            category = serializer.save()

            return Response(
                CategorySerializer(instance=category).data,
                status=status.HTTP_201_CREATED
            )

        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

get(request)

Método HTTP GET para listar todas as categorias registradas.

Parâmetros

request: O objeto da solicitação HTTP.

Exemplo de Uso

GET /api/categories/

Exemplo de Resposta JSON

[ { "id": 1, "name": "Nome_da_Categoria", }, { "id": 2, "name": "Nome_da_Categoria", }, ]

Retorna

Response: Uma resposta HTTP contendo uma lista de categorias em formato JSON.

Source code in finances/views.py

def get(self, request):
    """
    Método HTTP GET para listar todas as categorias registradas.

    Parâmetros:
        request: O objeto da solicitação HTTP.

    Exemplo de Uso:
        GET /api/categories/

    Exemplo de Resposta JSON:
        [
            {
                "id": 1,
                "name": "Nome_da_Categoria",
            },
            {
                "id": 2,
                "name": "Nome_da_Categoria",
            },
        ]

    Retorna:
        Response: Uma resposta HTTP contendo uma lista de categorias em
        formato JSON.
    """

    categories = Category.objects.all()

    if not categories.exists():
        return Response({'message': 'There are no registered categories.'})

    serializer = CategorySerializer(
        instance=categories,
        many=True,
        context={'request': request}
    )

    return Response(serializer.data)

post(request)

Método HTTP POST para criar uma nova categoria.

Parâmetros

request: O objeto da solicitação HTTP.

Exemplo de Uso

POST /api/categories/

Exemplo de Request Body

{ "name": "Nome_da_Categoria" }

Retorna

Response: Uma resposta HTTP com status 201 Created como confirmação. Os detalhes da nova categoria são retornados no corpo da resposta em formato JSON.

Erros

Se os dados enviados no corpo da solicitação forem inválidos, uma resposta HTTP com status 400 Bad Request é retornada contendo informações detalhadas sobre os erros.

Source code in finances/views.py

def post(self, request):
    """
    Método HTTP POST para criar uma nova categoria.

    Parâmetros:
        request: O objeto da solicitação HTTP.

    Exemplo de Uso:
        POST /api/categories/

    Exemplo de Request Body:
        {
            "name": "Nome_da_Categoria"
        }

    Retorna:
        Response: Uma resposta HTTP com status 201 Created como
        confirmação. Os detalhes da nova categoria são retornados no corpo
        da resposta em formato JSON.

    Erros:
        Se os dados enviados no corpo da solicitação forem inválidos, uma
        resposta HTTP com status 400 Bad Request é retornada contendo
        informações detalhadas sobre os erros.
    """

    serializer = CategorySerializer(
        data=request.data,
        context={'request': request}
    )

    if serializer.is_valid():

        category = serializer.save()

        return Response(
            CategorySerializer(instance=category).data,
            status=status.HTTP_201_CREATED
        )

    return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

OnwerAPIDetail

Bases: APIView

Representação da API que lida com operações detalhadas relacionadas a um titular específico.

Atributos

Nenhum atributo específico nesta classe.

Métodos

get_owner: Obtém um titula específico com base no iD. get_permissions: Retorna as permissões apropriadas com base no método da solicitação. get: Retorna detalhes de um titular específico. patch: Atualiza campos de forma parcial, ou total, de um titular específico. delete: Exclui um titular específico junto com a(s) conta(s) associada(s) à ele.

Endpoint Base

/api/owner//

Source code in finances/views.py

class OnwerAPIDetail(APIView):
    """
    Representação da API que lida com operações detalhadas relacionadas a um
    titular específico.

    Atributos:
        Nenhum atributo específico nesta classe.

    Métodos:
        get_owner: Obtém um titula específico com base no iD.
        get_permissions: Retorna as permissões apropriadas com base no método
        da solicitação.
        get: Retorna detalhes de um titular específico.
        patch: Atualiza campos de forma parcial, ou total, de um titular
        específico.
        delete: Exclui um titular específico junto com a(s) conta(s)
        associada(s) à ele.

    Endpoint Base:
        /api/owner/<pk>/
    """

    permission_classes = [IsAuthenticated, ]

    def get_owner(self, pk):
        """
        Método auxiliar para obter um titular com base no ID.

        Parâmetros:
            pk: O ID do titular a ser obtido.

        Retorna:
            Owner: O titular enconrtrado com base no ID fornecido.

        Raises:
            PermissionDenied: Se o usuário autenticado não for o proprietário
            do titular, a exceção será levantada.

        Exemplo de Uso:
            owner = self.get_owner(1)
        """

        owner = get_object_or_404(
            User.objects.all(),
            pk=pk
        )

        if owner != self.request.user:
            raise PermissionDenied(
                'Você não tem permissão para executar essa ação.'
            )

        return owner

    def get_permissions(self):
        """
        Método para definir as permissões necessárias para cada tipo de
        solicitação.
        Retorna a permissão 'IsOwner' para os métodos GET, PUT e DELETE, que
        permitem que o proprietário da transação
        acesse ou modifique os dados. Para outros métodos de solicitação, a
        permissão padrão é aplicada.

        Retorna:
            List: Uma lista de permissões específicas com base no tipo de
            método da solicitação.
        """

        if self.request.method in ['GET', 'PATCH', 'DELETE']:
            return [IsOwner(), ]
        return super().get_permissions()

    def get(self, request, pk):
        """
        Método HTTP GET para obter detalhes de um titular específico.

        Parâmetros:
            request: O objeto de solicitação HTTP.
            pk: O ID do titular a ser obtido.

        Retorna:
            Response: Uma resposta HTTP contendo os detalhes do titular em
            formato JSON.
        """

        owner = self.get_owner(pk)

        serializer = OwnerSerializer(
            instance=owner,
            many=False,
            context={'request': request}
        )

        return Response(serializer.data)

    def patch(self, request, pk):
        """
        Método HTTP PATCH para atualizar os dados de um titular específico.

        Parâmetros:
            request: O objeto de solicitação contendo os dados a serem
            atualizados.
            pk: O ID do titular a ser atualizado.

        Retorna:
            Response: Uma resposta HTTP contendo os detalhes do titular
            atualizada em formato JSON.
        """

        owner = self.get_owner(pk)

        serializer = OwnerSerializer(
            instance=owner,
            data=request.data,
            many=False,
            context={'request': request},
            partial=True
        )

        serializer.is_valid(raise_exception=True)

        serializer.save()

        return Response(serializer.data)

    def delete(self, request, pk):
        """
        Método HTTP DELETE para excluir um titular específico e, caso tenha uma
        conta associada a ele, será excluída.

        Parâmetros:
            request: O objeto da solicitação HTTP.
            pk: O ID do titular a ser excluído.

        Retorna:
            Response: Uma resposta HTTP com status 204 No Content como
            confirmação.
        """

        owner = self.get_owner(pk)

        try:
            account = Account.objects.get(owner=owner)

            account.delete()
        except Account.DoesNotExist:
            pass

        owner.delete()

        return Response(status=status.HTTP_204_NO_CONTENT)

delete(request, pk)

Método HTTP DELETE para excluir um titular específico e, caso tenha uma conta associada a ele, será excluída.

Parâmetros

request: O objeto da solicitação HTTP. pk: O ID do titular a ser excluído.

Retorna

Response: Uma resposta HTTP com status 204 No Content como confirmação.

Source code in finances/views.py

def delete(self, request, pk):
    """
    Método HTTP DELETE para excluir um titular específico e, caso tenha uma
    conta associada a ele, será excluída.

    Parâmetros:
        request: O objeto da solicitação HTTP.
        pk: O ID do titular a ser excluído.

    Retorna:
        Response: Uma resposta HTTP com status 204 No Content como
        confirmação.
    """

    owner = self.get_owner(pk)

    try:
        account = Account.objects.get(owner=owner)

        account.delete()
    except Account.DoesNotExist:
        pass

    owner.delete()

    return Response(status=status.HTTP_204_NO_CONTENT)

get(request, pk)

Método HTTP GET para obter detalhes de um titular específico.

Parâmetros

request: O objeto de solicitação HTTP. pk: O ID do titular a ser obtido.

Retorna

Response: Uma resposta HTTP contendo os detalhes do titular em formato JSON.

Source code in finances/views.py

def get(self, request, pk):
    """
    Método HTTP GET para obter detalhes de um titular específico.

    Parâmetros:
        request: O objeto de solicitação HTTP.
        pk: O ID do titular a ser obtido.

    Retorna:
        Response: Uma resposta HTTP contendo os detalhes do titular em
        formato JSON.
    """

    owner = self.get_owner(pk)

    serializer = OwnerSerializer(
        instance=owner,
        many=False,
        context={'request': request}
    )

    return Response(serializer.data)

get_owner(pk)

Método auxiliar para obter um titular com base no ID.

Parâmetros

pk: O ID do titular a ser obtido.

Retorna

Owner: O titular enconrtrado com base no ID fornecido.

Raises:

Type	Description
PermissionDenied	Se o usuário autenticado não for o proprietário

Exemplo de Uso

owner = self.get_owner(1)

Source code in finances/views.py

def get_owner(self, pk):
    """
    Método auxiliar para obter um titular com base no ID.

    Parâmetros:
        pk: O ID do titular a ser obtido.

    Retorna:
        Owner: O titular enconrtrado com base no ID fornecido.

    Raises:
        PermissionDenied: Se o usuário autenticado não for o proprietário
        do titular, a exceção será levantada.

    Exemplo de Uso:
        owner = self.get_owner(1)
    """

    owner = get_object_or_404(
        User.objects.all(),
        pk=pk
    )

    if owner != self.request.user:
        raise PermissionDenied(
            'Você não tem permissão para executar essa ação.'
        )

    return owner

get_permissions()

Método para definir as permissões necessárias para cada tipo de solicitação. Retorna a permissão 'IsOwner' para os métodos GET, PUT e DELETE, que permitem que o proprietário da transação acesse ou modifique os dados. Para outros métodos de solicitação, a permissão padrão é aplicada.

Retorna

List: Uma lista de permissões específicas com base no tipo de método da solicitação.

Source code in finances/views.py

def get_permissions(self):
    """
    Método para definir as permissões necessárias para cada tipo de
    solicitação.
    Retorna a permissão 'IsOwner' para os métodos GET, PUT e DELETE, que
    permitem que o proprietário da transação
    acesse ou modifique os dados. Para outros métodos de solicitação, a
    permissão padrão é aplicada.

    Retorna:
        List: Uma lista de permissões específicas com base no tipo de
        método da solicitação.
    """

    if self.request.method in ['GET', 'PATCH', 'DELETE']:
        return [IsOwner(), ]
    return super().get_permissions()

patch(request, pk)

Método HTTP PATCH para atualizar os dados de um titular específico.

Parâmetros

request: O objeto de solicitação contendo os dados a serem atualizados. pk: O ID do titular a ser atualizado.

Retorna

Response: Uma resposta HTTP contendo os detalhes do titular atualizada em formato JSON.

Source code in finances/views.py

def patch(self, request, pk):
    """
    Método HTTP PATCH para atualizar os dados de um titular específico.

    Parâmetros:
        request: O objeto de solicitação contendo os dados a serem
        atualizados.
        pk: O ID do titular a ser atualizado.

    Retorna:
        Response: Uma resposta HTTP contendo os detalhes do titular
        atualizada em formato JSON.
    """

    owner = self.get_owner(pk)

    serializer = OwnerSerializer(
        instance=owner,
        data=request.data,
        many=False,
        context={'request': request},
        partial=True
    )

    serializer.is_valid(raise_exception=True)

    serializer.save()

    return Response(serializer.data)

OwnerAPIList

Bases: APIView

Representação da API para gerar titulares das contas financeiras.

Atributos

Nenhum atributo específico nesta classe.

Métodos

get_permissions: Define as permissões necessárias para cada tipo de solicitação. get: Retorna uma lista de todos os titulares registrados. post: Cria um novo titular.

Endpoint Base

/api/owners/

Source code in finances/views.py

class OwnerAPIList(APIView):
    """
    Representação da API para gerar titulares das contas financeiras.

    Atributos:
        Nenhum atributo específico nesta classe.

    Métodos:
        get_permissions: Define as permissões necessárias para cada tipo de
        solicitação.
        get: Retorna uma lista de todos os titulares registrados.
        post: Cria um novo titular.

    Endpoint Base:
        /api/owners/
    """

    def get_permissions(self):
        """
        Método para definir as permissões necessárias para cada tipo de
        solicitação.
        Retorna permissões diferentes dependendo do método da solicitação,
        permitindo apenas o administrador
        para o método GET e permitindo qualquer pessoa para o método POST.

        Retorna:
            List: Uma lista de permissões específicas com base no tipo de
            método da solicitação.
        """

        if self.request.method == 'POST':
            return [IsOwner()]
        return super().get_permissions()

    def get(self, request):
        """
        Método HTTP GET para listar todo os titulares registrados.

        Parâmetros:
            request: O objeto da solicitação HTTP.

        Exemplo de Uso:
            GET /api/owners/

        Exemplo de Resposta JSON:
            [
                {
                    "id": 1,
                    "username": "Username_do_Titular",
                    "first_name": "Nome",
                    "last_name": "Sobrenome",
                    "email": "E-mail"
                },
                {
                    "id": 2,
                    "username": "Username_do_Titular",
                    "first_name": "Nome",
                    "last_name": "Sobrenome",
                    "email": "E-mail"
                },
            ]

        Retorna:
            Response: Uma resposta HTTP contendo uma lista dos titulares em
            formato JSON.
        """

        owners = User.objects.all()

        if not owners.exists():
            return Response({'message': 'There are no registered owners.'})

        serializer = OwnerSerializer(
            instance=owners,
            many=True,
            context={'request': request}
        )

        return Response(serializer.data)

    def post(self, request):
        """
        Método HTTP POST para criar um novo titular.
        Envia os dados do novo titular em formato JSON no corpo da solicitação.

        Parâmetros:
            request: O objeto de solicitação HTTP.

        Exemplos de Uso:
            POST /api/owners/

        Exemplo de Request Body:
            {
                "username": "Username",
                "first_name": "Nome",
                "last_name": "Sobrenome",
                "email": "E-mail"
            }

        Retorna:
            Response: Uma resposta HTTP com status 201 Created como
            confirmação. Os detalhes do novo titular são retornados no corpo da
            resposta em formato JSON.

        Erros:
            Se os dados enviados no corpo da solicitação forem inválidos, uma
            resposta HTTP com status 400 Bad Request é retornada, contendo
            informações detalhadas sobre os erros.
        """

        serializer = OwnerSerializer(
            data=request.data,
            context={'request': request}
        )

        if serializer.is_valid():

            owner = User.objects.create_user(**serializer.validated_data)

            return Response(
                OwnerSerializer(instance=owner).data,
                status=status.HTTP_201_CREATED
            )

        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

get(request)

Método HTTP GET para listar todo os titulares registrados.

Parâmetros

request: O objeto da solicitação HTTP.

Exemplo de Uso

GET /api/owners/

Exemplo de Resposta JSON

[ { "id": 1, "username": "Username_do_Titular", "first_name": "Nome", "last_name": "Sobrenome", "email": "E-mail" }, { "id": 2, "username": "Username_do_Titular", "first_name": "Nome", "last_name": "Sobrenome", "email": "E-mail" }, ]

Retorna

Response: Uma resposta HTTP contendo uma lista dos titulares em formato JSON.

Source code in finances/views.py

def get(self, request):
    """
    Método HTTP GET para listar todo os titulares registrados.

    Parâmetros:
        request: O objeto da solicitação HTTP.

    Exemplo de Uso:
        GET /api/owners/

    Exemplo de Resposta JSON:
        [
            {
                "id": 1,
                "username": "Username_do_Titular",
                "first_name": "Nome",
                "last_name": "Sobrenome",
                "email": "E-mail"
            },
            {
                "id": 2,
                "username": "Username_do_Titular",
                "first_name": "Nome",
                "last_name": "Sobrenome",
                "email": "E-mail"
            },
        ]

    Retorna:
        Response: Uma resposta HTTP contendo uma lista dos titulares em
        formato JSON.
    """

    owners = User.objects.all()

    if not owners.exists():
        return Response({'message': 'There are no registered owners.'})

    serializer = OwnerSerializer(
        instance=owners,
        many=True,
        context={'request': request}
    )

    return Response(serializer.data)

get_permissions()

Método para definir as permissões necessárias para cada tipo de solicitação. Retorna permissões diferentes dependendo do método da solicitação, permitindo apenas o administrador para o método GET e permitindo qualquer pessoa para o método POST.

Retorna

List: Uma lista de permissões específicas com base no tipo de método da solicitação.

Source code in finances/views.py

def get_permissions(self):
    """
    Método para definir as permissões necessárias para cada tipo de
    solicitação.
    Retorna permissões diferentes dependendo do método da solicitação,
    permitindo apenas o administrador
    para o método GET e permitindo qualquer pessoa para o método POST.

    Retorna:
        List: Uma lista de permissões específicas com base no tipo de
        método da solicitação.
    """

    if self.request.method == 'POST':
        return [IsOwner()]
    return super().get_permissions()

post(request)

Método HTTP POST para criar um novo titular. Envia os dados do novo titular em formato JSON no corpo da solicitação.

Parâmetros

request: O objeto de solicitação HTTP.

Exemplos de Uso

POST /api/owners/

Exemplo de Request Body

{ "username": "Username", "first_name": "Nome", "last_name": "Sobrenome", "email": "E-mail" }

Retorna

Response: Uma resposta HTTP com status 201 Created como confirmação. Os detalhes do novo titular são retornados no corpo da resposta em formato JSON.

Erros

Se os dados enviados no corpo da solicitação forem inválidos, uma resposta HTTP com status 400 Bad Request é retornada, contendo informações detalhadas sobre os erros.

Source code in finances/views.py

def post(self, request):
    """
    Método HTTP POST para criar um novo titular.
    Envia os dados do novo titular em formato JSON no corpo da solicitação.

    Parâmetros:
        request: O objeto de solicitação HTTP.

    Exemplos de Uso:
        POST /api/owners/

    Exemplo de Request Body:
        {
            "username": "Username",
            "first_name": "Nome",
            "last_name": "Sobrenome",
            "email": "E-mail"
        }

    Retorna:
        Response: Uma resposta HTTP com status 201 Created como
        confirmação. Os detalhes do novo titular são retornados no corpo da
        resposta em formato JSON.

    Erros:
        Se os dados enviados no corpo da solicitação forem inválidos, uma
        resposta HTTP com status 400 Bad Request é retornada, contendo
        informações detalhadas sobre os erros.
    """

    serializer = OwnerSerializer(
        data=request.data,
        context={'request': request}
    )

    if serializer.is_valid():

        owner = User.objects.create_user(**serializer.validated_data)

        return Response(
            OwnerSerializer(instance=owner).data,
            status=status.HTTP_201_CREATED
        )

    return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

TransactionAPIDetail

Bases: APIView

Representação da API que lida com operações detalhadas relacionadas a uma transação específica do titular.

Atributos

Nenhum atributo específico nesta classe.

Métodos

get_transaction: Obtém uma transação específica com base no ID. get_permissions: Retorna as permissões apropriadas com base no método da solicitação. get: Retorna detalhes de uma transação específica. patch: Atualiza os dados da transação de forma parcial. delete: Exclui uma transação específica.

Endpoint Base

/api/transaction//

Source code in finances/views.py

class TransactionAPIDetail(APIView):
    """
    Representação da API que lida com operações detalhadas relacionadas a uma
    transação específica do titular.

    Atributos:
        Nenhum atributo específico nesta classe.

    Métodos:
        get_transaction: Obtém uma transação específica com base no ID.
        get_permissions: Retorna as permissões apropriadas com base no método
        da solicitação.
        get: Retorna detalhes de uma transação específica.
        patch: Atualiza os dados da transação de forma parcial.
        delete: Exclui uma transação específica.

    Endpoint Base:
        /api/transaction/<pk>/
    """

    permission_classes = [IsAuthenticated, ]

    def get_transaction(self, pk):
        """
        Método auxilixar para obter uma transação específica com base no ID.

        Parâmetros:
            request: O objeto da solicitação HTTP.
            pk: O ID da categoria a ser obtida.

        Retorna:
            Response: Uma resposta HTTP contendo os detalhes da transação em
            formato JSON.
        """

        transactions = get_object_or_404(
            Transaction.objects.all(),
            pk=pk
        )

        self.check_object_permissions(self.request, transactions)

        return transactions

    def get_permissions(self):
        """
        Método para definir as permissões necessárias para cada tipo de
        solicitação.
        Retorna a permissão 'IsOwner' para os métodos GET, PUT e DELETE, que
        permitem que o proprietário da transação
        acesse ou modifique os dados. Para outros métodos de solicitação, a
        permissão padrão é aplicada.

        Retorna:
            List: Uma lista de permissões específicas com base no tipo de
            método da solicitação.
        """

        if self.request.method in ['GET', 'PUT', 'DELETE']:
            return [IsOwner(), ]
        return super().get_permissions()

    def get(self, request, pk):
        """
        Método HTTP GET para obter detalhes de uma transação específica.

        Parâmetros:
            request: O objeto da solicitação HTTP.
            pk: O ID da transação a ser obtida.

        Retorna:
            Response: Uma resposta HTTP contendo os detalhes da transação em
            formato JSON.
        """

        transaction = self.get_transaction(pk)

        serializer = TransactionSerializer(
            instance=transaction,
            many=False,
            context={'request': request}
        )

        return Response(serializer.data)

    def put(self, request, pk):
        """
        Método HTTP PATCH para atualizar os dados de uma transação específica.

        Parâmetros:
            request: O objeto da soicitação HTTP.
            pk: O ID da trasação a ser atualizada.

        Retorna:
            Response: Uma resposta HTTP contendo os detalhes da categoria
            atualizada em formato JSON.
        """

        transaction = self.get_transaction(pk)

        serializer = TransactionSerializer(
            instance=transaction,
            data=request.data,
            many=False,
            context={'request': request},
            partial=True
        )

        serializer.is_valid(raise_exception=True)

        serializer.save()

        return Response(serializer.data)

    def delete(self, request, pk):
        """
        Método HTTP DELETE para excluir uma transação específica.

        Parâmetros:
            request: O objeto da solicitação HTTP.
            pk: O ID da transação a ser excluída.

        Retorna:
            Response: Uma resposta HTTP com status 204 No Content como
            confirmação.
        """

        try:
            transaction = Transaction.objects.get(pk=pk)
        except Transaction.DoesNotExist:
            return Response(status=status.HTTP_404_NOT_FOUND)

        category = transaction.category

        if category and category.budget_set.exists():
            budget = category.budget_set.first()
            budget.spent -= transaction.amount
            budget.save()

        transaction.delete()

        return Response(status=status.HTTP_204_NO_CONTENT)

delete(request, pk)

Método HTTP DELETE para excluir uma transação específica.

Parâmetros

request: O objeto da solicitação HTTP. pk: O ID da transação a ser excluída.

Retorna

Response: Uma resposta HTTP com status 204 No Content como confirmação.

Source code in finances/views.py

def delete(self, request, pk):
    """
    Método HTTP DELETE para excluir uma transação específica.

    Parâmetros:
        request: O objeto da solicitação HTTP.
        pk: O ID da transação a ser excluída.

    Retorna:
        Response: Uma resposta HTTP com status 204 No Content como
        confirmação.
    """

    try:
        transaction = Transaction.objects.get(pk=pk)
    except Transaction.DoesNotExist:
        return Response(status=status.HTTP_404_NOT_FOUND)

    category = transaction.category

    if category and category.budget_set.exists():
        budget = category.budget_set.first()
        budget.spent -= transaction.amount
        budget.save()

    transaction.delete()

    return Response(status=status.HTTP_204_NO_CONTENT)

get(request, pk)

Método HTTP GET para obter detalhes de uma transação específica.

Parâmetros

request: O objeto da solicitação HTTP. pk: O ID da transação a ser obtida.

Retorna

Response: Uma resposta HTTP contendo os detalhes da transação em formato JSON.

Source code in finances/views.py

def get(self, request, pk):
    """
    Método HTTP GET para obter detalhes de uma transação específica.

    Parâmetros:
        request: O objeto da solicitação HTTP.
        pk: O ID da transação a ser obtida.

    Retorna:
        Response: Uma resposta HTTP contendo os detalhes da transação em
        formato JSON.
    """

    transaction = self.get_transaction(pk)

    serializer = TransactionSerializer(
        instance=transaction,
        many=False,
        context={'request': request}
    )

    return Response(serializer.data)

get_permissions()

Método para definir as permissões necessárias para cada tipo de solicitação. Retorna a permissão 'IsOwner' para os métodos GET, PUT e DELETE, que permitem que o proprietário da transação acesse ou modifique os dados. Para outros métodos de solicitação, a permissão padrão é aplicada.

Retorna

List: Uma lista de permissões específicas com base no tipo de método da solicitação.

Source code in finances/views.py

def get_permissions(self):
    """
    Método para definir as permissões necessárias para cada tipo de
    solicitação.
    Retorna a permissão 'IsOwner' para os métodos GET, PUT e DELETE, que
    permitem que o proprietário da transação
    acesse ou modifique os dados. Para outros métodos de solicitação, a
    permissão padrão é aplicada.

    Retorna:
        List: Uma lista de permissões específicas com base no tipo de
        método da solicitação.
    """

    if self.request.method in ['GET', 'PUT', 'DELETE']:
        return [IsOwner(), ]
    return super().get_permissions()

get_transaction(pk)

Método auxilixar para obter uma transação específica com base no ID.

Parâmetros

request: O objeto da solicitação HTTP. pk: O ID da categoria a ser obtida.

Retorna

Response: Uma resposta HTTP contendo os detalhes da transação em formato JSON.

Source code in finances/views.py

def get_transaction(self, pk):
    """
    Método auxilixar para obter uma transação específica com base no ID.

    Parâmetros:
        request: O objeto da solicitação HTTP.
        pk: O ID da categoria a ser obtida.

    Retorna:
        Response: Uma resposta HTTP contendo os detalhes da transação em
        formato JSON.
    """

    transactions = get_object_or_404(
        Transaction.objects.all(),
        pk=pk
    )

    self.check_object_permissions(self.request, transactions)

    return transactions

put(request, pk)

Método HTTP PATCH para atualizar os dados de uma transação específica.

Parâmetros

request: O objeto da soicitação HTTP. pk: O ID da trasação a ser atualizada.

Retorna

Response: Uma resposta HTTP contendo os detalhes da categoria atualizada em formato JSON.

Source code in finances/views.py

def put(self, request, pk):
    """
    Método HTTP PATCH para atualizar os dados de uma transação específica.

    Parâmetros:
        request: O objeto da soicitação HTTP.
        pk: O ID da trasação a ser atualizada.

    Retorna:
        Response: Uma resposta HTTP contendo os detalhes da categoria
        atualizada em formato JSON.
    """

    transaction = self.get_transaction(pk)

    serializer = TransactionSerializer(
        instance=transaction,
        data=request.data,
        many=False,
        context={'request': request},
        partial=True
    )

    serializer.is_valid(raise_exception=True)

    serializer.save()

    return Response(serializer.data)

TransactionAPIList

Bases: APIView

Representação da API para gerenciar as transações realizadas pelo titular.

Atributos

Nenhum atributo específico nesta classe.

Métodos

get_permissions: Retorna as permissões apropriadas com base no método da solicitação. get: Retorna uma lista de todas as transações realizadas. post: Cria uma nova transação.

Endpoint Base

/api/transactions/

Source code in finances/views.py

class TransactionAPIList(APIView):
    """
    Representação da API para gerenciar as transações realizadas pelo titular.

    Atributos:
        Nenhum atributo específico nesta classe.

    Métodos:
        get_permissions: Retorna as permissões apropriadas com base no método
        da solicitação.
        get: Retorna uma lista de todas as transações realizadas.
        post: Cria uma nova transação.

    Endpoint Base:
        /api/transactions/
    """

    permission_classes = [IsAdminUser, ]

    def get_permissions(self):
        """
        Retorna as permissões apropriadas com base no método da solicitação.

        Verifica o método da solicitação e retorna as permissões apropriadas de
        acordo com a lógica implementada.
        Para o método POST, retorna a permissão IsOwner, que verifica se o
        usuário autenticado é o proprietário.
        Para outros métodos, retorna as permissões de superclasse padrão.

        Parâmetros:
            self: A própria instância da classe.

        Retorna:
            List[permissions.BasePermission]: Lista de permissões a serem
            aplicadas à solicitação.
        """

        if self.request.method == 'POST':
            return [IsOwner()]
        return super().get_permissions()

    def get(self, request):
        """
        Método HTTP GET para listar todas as transações registradas.

        Parâmetros:
            request: O objeto da solicitação.

        Exemplo de Uso:
            GET /api/transactions/

        Exemplo de Resposta JSON:
            [
                {
                    "id": 4,
                    "amount": "200.00",
                    "description": "Compra em supermercado",
                    "account": 3,
                    "category": 1
                },
                {
                    "id": 5,
                    "amount": "200.00",
                    "description": "Pagamento de aluguel",
                    "account": 3,
                    "category": 3
                }
            ]

        Retorna:
            Response: Uma resposta HTTP contendo uma lista de transações em
            formato JSON.
        """

        transactions = Transaction.objects.all()

        if not transactions.exists():
            return Response(
                {'message': 'There are no registered transactions.'}
            )

        serializer = TransactionSerializer(
            instance=transactions,
            many=True,
            context={'request': request}
        )

        return Response(serializer.data)

    def post(self, request):
        """
        Método HTTP POST para criar uma nova transação.
        Envia os dados da nova transação em formato JSON no corpo da
        solicitação.

        Parâmetros:
            request: O objeto da solicitação.

        Exemplo de Uso:
            POST /api/transactions/

        Exemplo de Request Body:
            [
                {
                    "amount": "200.00",
                    "description": "Descrição_da_Transação",
                    "account": 3,
                    "category": 1
                },
            ]

        Retorna:
            Response: Uma resposta HTTP com status 201 Created como
            confirmação. Os detalhes da nova transação são retornados no corpo
            da resposta em formato JSON.
        """

        serializer = TransactionSerializer(
            data=request.data,
            context={'request': request}
        )

        serializer.is_valid(raise_exception=True)

        serializer.save()

        return Response(serializer.data, status=status.HTTP_201_CREATED)

get(request)

Método HTTP GET para listar todas as transações registradas.

Parâmetros

request: O objeto da solicitação.

Exemplo de Uso

GET /api/transactions/

Exemplo de Resposta JSON

[ { "id": 4, "amount": "200.00", "description": "Compra em supermercado", "account": 3, "category": 1 }, { "id": 5, "amount": "200.00", "description": "Pagamento de aluguel", "account": 3, "category": 3 } ]

Retorna

Response: Uma resposta HTTP contendo uma lista de transações em formato JSON.

Source code in finances/views.py

def get(self, request):
    """
    Método HTTP GET para listar todas as transações registradas.

    Parâmetros:
        request: O objeto da solicitação.

    Exemplo de Uso:
        GET /api/transactions/

    Exemplo de Resposta JSON:
        [
            {
                "id": 4,
                "amount": "200.00",
                "description": "Compra em supermercado",
                "account": 3,
                "category": 1
            },
            {
                "id": 5,
                "amount": "200.00",
                "description": "Pagamento de aluguel",
                "account": 3,
                "category": 3
            }
        ]

    Retorna:
        Response: Uma resposta HTTP contendo uma lista de transações em
        formato JSON.
    """

    transactions = Transaction.objects.all()

    if not transactions.exists():
        return Response(
            {'message': 'There are no registered transactions.'}
        )

    serializer = TransactionSerializer(
        instance=transactions,
        many=True,
        context={'request': request}
    )

    return Response(serializer.data)

get_permissions()

Retorna as permissões apropriadas com base no método da solicitação.

Verifica o método da solicitação e retorna as permissões apropriadas de acordo com a lógica implementada. Para o método POST, retorna a permissão IsOwner, que verifica se o usuário autenticado é o proprietário. Para outros métodos, retorna as permissões de superclasse padrão.

Parâmetros

self: A própria instância da classe.

Retorna

List[permissions.BasePermission]: Lista de permissões a serem aplicadas à solicitação.

Source code in finances/views.py

def get_permissions(self):
    """
    Retorna as permissões apropriadas com base no método da solicitação.

    Verifica o método da solicitação e retorna as permissões apropriadas de
    acordo com a lógica implementada.
    Para o método POST, retorna a permissão IsOwner, que verifica se o
    usuário autenticado é o proprietário.
    Para outros métodos, retorna as permissões de superclasse padrão.

    Parâmetros:
        self: A própria instância da classe.

    Retorna:
        List[permissions.BasePermission]: Lista de permissões a serem
        aplicadas à solicitação.
    """

    if self.request.method == 'POST':
        return [IsOwner()]
    return super().get_permissions()

post(request)

Método HTTP POST para criar uma nova transação. Envia os dados da nova transação em formato JSON no corpo da solicitação.

Parâmetros

request: O objeto da solicitação.

Exemplo de Uso

POST /api/transactions/

Exemplo de Request Body

[ { "amount": "200.00", "description": "Descrição_da_Transação", "account": 3, "category": 1 }, ]

Retorna

Response: Uma resposta HTTP com status 201 Created como confirmação. Os detalhes da nova transação são retornados no corpo da resposta em formato JSON.

Source code in finances/views.py

def post(self, request):
    """
    Método HTTP POST para criar uma nova transação.
    Envia os dados da nova transação em formato JSON no corpo da
    solicitação.

    Parâmetros:
        request: O objeto da solicitação.

    Exemplo de Uso:
        POST /api/transactions/

    Exemplo de Request Body:
        [
            {
                "amount": "200.00",
                "description": "Descrição_da_Transação",
                "account": 3,
                "category": 1
            },
        ]

    Retorna:
        Response: Uma resposta HTTP com status 201 Created como
        confirmação. Os detalhes da nova transação são retornados no corpo
        da resposta em formato JSON.
    """

    serializer = TransactionSerializer(
        data=request.data,
        context={'request': request}
    )

    serializer.is_valid(raise_exception=True)

    serializer.save()

    return Response(serializer.data, status=status.HTTP_201_CREATED)