Development

.gitignore

@@ -0,0 +1,130 @@
+# Django #
+*.log
+*.pot
+*.pyc
+__pycache__
+db.sqlite3
+media
+
+# Backup files #
+*.bak
+
+# If you are using PyCharm #
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/dictionaries
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.xml
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/gradle.xml
+.idea/**/libraries
+*.iws /out/
+
+# Python #
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+.pytest_cache/
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery
+celerybeat-schedule.*
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# Sublime Text #
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+*.sublime-workspace
+*.sublime-project
+
+# sftp configuration file
+sftp-config.json
+
+# Package control specific files Package
+Control.last-run
+Control.ca-list
+Control.ca-bundle
+Control.system-ca-bundle
+GitHub.sublime-settings
+
+# Visual Studio Code #
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+.history
+
+# Personal additions
+__pycache__/
+*.pyc
+__localcode
+venv
+env
+.DS_Store
+local_settings.py
+_local_settings.py
+gunicorn-error-log
+db.sqlite3
+db copy.sqlite3
+static/

README.md

@@ -1,88 +1,21 @@
-# Back End Test Project <img src="https://coderockr.com/assets/images/coderockr.svg" align="right" height="50px" />
-
-You should see this challenge as an opportunity to create an application following modern development best practices (given the stack of your choice), but also feel free to use your own architecture preferences (coding standards, code organization, third-party libraries, etc). It’s perfectly fine to use vanilla code or any framework or libraries.
-
-## Scope
-
-In this challenge you should build an API for an application that stores and manages investments, it should have the following features:
-
-1. __Creation__ of an investment with an owner, a creation date and an amount.
-    1. The creation date of an investment can be today or a date in the past.
-    2. An investment should not be or become negative.
-2. __View__ of an investment with its initial amount and expected balance.
-    1. Expected balance should be the sum of the invested amount and the [gains][].
-    2. If an investment was already withdrawn then the balance must reflect the gains of that investment
-3. __Withdrawal__ of a investment.
-    1. The withdraw will always be the sum of the initial amount and its gains,
-       partial withdrawn is not supported.
-    2. Withdrawals can happen in the past or today, but can't happen before the investment creation or the future.
-    3. [Taxes][taxes] need to be applied to the withdrawals before showing the final value.
-4. __List__ of a person's investments
-    1. This list should have pagination.
-
-__NOTE:__ the implementation of an interface will not be evaluated.
-
-### Gain Calculation
-
-The investment will pay 0.52% every month in the same day of the investment creation.
-
-Given that the gain is paid every month, it should be treated as [compound gain][], which means that every new period (month) the amount gained will become part of the investment balance for the next payment.
-
-### Taxation
-
-When money is withdrawn, tax is triggered. Taxes apply only to the profit/gain portion of the money withdrawn. For example, if the initial investment was 1000.00, the current balance is 1200.00, then the taxes will be applied to the 200.00.
-
-The tax percentage changes according to the age of the investment:
-* If it is less than one year old, the percentage will be 22.5% (tax = 45.00).
-* If it is between one and two years old, the percentage will be 18.5% (tax = 37.00).
-* If older than two years, the percentage will be 15% (tax = 30.00).
-
-## Requirements
-1. Create project using any technology of your preference. It’s perfectly OK to use vanilla code or any framework or libraries;
-2. Although you can use as many dependencies as you want, you should manage them wisely;
-3. It is not necessary to send the notification emails, however, the code required for that would be welcome;
-4. The API must be documented in some way.
-
-## Deliverables
-The project source code and dependencies should be made available in GitHub. Here are the steps you should follow:
-1. Fork this repository to your GitHub account (create an account if you don't have one, you will need it working with us).
-2. Create a "development" branch and commit the code to it. Do not push the code to the main branch.
-3. Include a README file that describes:
-    - Special build instructions, if any
-    - List of third-party libraries used and short description of why/how they were used
-    - A link to the API documentation.
-4. Once the work is complete, create a pull request from "development" into "main" and send us the link.
-5. Avoid using huge commits hiding your progress. Feel free to work on a branch and use `git rebase` to adjust your commits before submitting the final version.
-
-## Coding Standards
-When working on the project be as clean and consistent as possible.
-
-## Project Deadline
-Ideally you'd finish the test project in 5 days. It shouldn't take you longer than a entire week.
-
-## Quality Assurance
-Use the following checklist to ensure high quality of the project.
-
-### General
-- First of all, the application should run without errors.
-- Are all requirements set above met?
-- Is coding style consistent?
-- The API is well documented?
-- The API has unit tests?
-
-## Submission
-1. A link to the Github repository.
-2. Briefly describe how you decided on the tools that you used.
-
-## Have Fun Coding 🤘
-- This challenge description is intentionally vague in some aspects, but if you need assistance feel free to ask for help.
-- If any of the seems out of your current level, you may skip it, but remember to tell us about it in the pull request.
-
-## Credits
-
-This coding challenge was inspired on [kinvoapp/kinvo-back-end-test](https://github.com/kinvoapp/kinvo-back-end-test/blob/2f17d713de739e309d17a1a74a82c3fd0e66d128/README.md)
-
-[gains]: #gain-calculation
-[taxes]: #taxation
-[interest]: #interest-calculation
-[compound gain]: https://www.investopedia.com/terms/g/gain.asp
+<h1 align="center"> # investment-management </h1>
+<p align="center">
+<img src="http://img.shields.io/static/v1?label=STATUS&message=%20CONCLUIDO&color=GREEN&style=for-the-badge"/>
+<img src="https://img.shields.io/badge/Django-REST%20FRAMEWORK-green"/>
+</p>
+<hr>
+API para gerenciamento e armazenamento de investimentos. Feita para o projeto de teste de back-end da coderockr.
+
+## :hammer: Instalação do projeto
+
+- `1º passo`: Clone o repostorio na sua maquina.
+- `2º passo`: Dentro do diretorio do projeto crie um ambiente virtual -> "python3 -m venv venv"
+- `3º passo`: Ative o ambiente virtual -> "source venv/bin/activate"
+- `4º passo`: instale as dependencias com o pip -> "pip install -r requirements.txt"
+- `5º passo`: Rode as migrações -> "python3 manage.py migrate"
+- `6º passo`: Crie um Superusuário -> "python3 manage.py createsuperuser"
+- `7º passo`: Suba o servidor -> "python3 manage.py runserver"
+
+## ✔️ Acessar admin e Documentação da API como o swagger
+-> Para acessar a pagina de admin do projeto apenas acesse a rota "localhost:8000/admin" e insira o login e senha que criou no passo 6<br>
+-> Para acessar a documentação swagger do projeto acesse a rota "localhost:8000/api/"

investment/admin.py

@@ -0,0 +1,11 @@
+from django.contrib import admin
+from .models import Investments, Owner
+
+@admin.register(Investments)
+class InvestmentsAdmin(admin.ModelAdmin):
+    list_display = ("owner", "creation_date", "amount")
+
+@admin.register(Owner)
+class OwnerAdmin(admin.ModelAdmin):
+    list_display = ("name",)
+

investment/api/serializers.py

@@ -0,0 +1,50 @@
+from rest_framework import serializers
+from decimal import Decimal
+from datetime import date, timedelta
+from investment.models import Investments, Owner
+
+class OwnerSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Owner
+        fields = "__all__"
+        depth = 1
+
+class InvestmentSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = Investments
+        fields = "__all__"
+
+    # @staticmethod
+    # def calc_investment_date(update_date):
+    #     today = date.today()
+    #     days = (today - update_date).days
+    #     months_in_days = days - (days % 30)
+    #     new_update_date = update_date + timedelta(days=months_in_days)
+    #     months = days // 30
+    #     return months, new_update_date
+
+    # def create(self, validated_data): 
+    #     calc = self.calc_investment_date(validated_data.get('update_date'))
+    #     gain = validated_data.get('amount') * (1 + Decimal(0.0052))**calc[0]
+    #     # id = self.id
+    #     validated_data.update({'amount':gain})
+    #     validated_data.update({'update_date':calc[1]})
+    #     # value = gain*(1+Decimal(0.0052))**1
+    #     investment = InvestmentSerializer(**validated_data)
+    #     return investment
+
+
+class InvestmentNestedSerializer(serializers.ModelSerializer):
+    owner = OwnerSerializer()
+
+    class Meta:
+        model = Investments
+        fields = ('id', 'owner', 'creation_date', 'balance', 'expected_balance')
+
+class InvestmentGetNestedSerializer(serializers.ModelSerializer):
+    owner = OwnerSerializer()
+
+    class Meta:
+        model = Investments
+        fields = ('id', 'owner', 'creation_date', 'amount', 'balance', 'expected_balance', 'income', 'withdrawal_date')

investment/api/urls.py

@@ -0,0 +1,9 @@
+from rest_framework.routers import SimpleRouter
+
+from investment.api.views import InvestmentsViewSet, OwnerViewSet
+
+router = SimpleRouter(trailing_slash=False)
+
+router.register(r"investments", InvestmentsViewSet)
+router.register(r"owners", OwnerViewSet)
+

investment/api/views.py

@@ -0,0 +1,68 @@
+from rest_framework import viewsets, filters
+from rest_framework.decorators import action
+from rest_framework.response import Response
+from datetime import date
+from decimal import Decimal
+from django.shortcuts import get_object_or_404
+
+from django_filters.rest_framework import DjangoFilterBackend
+
+from investment.api.serializers import OwnerSerializer, InvestmentSerializer, InvestmentNestedSerializer, \
+InvestmentGetNestedSerializer
+
+from investment.models import Investments, Owner
+
+class OwnerViewSet(viewsets.ModelViewSet):
+    queryset = Owner.objects.all()
+    serializer_class = OwnerSerializer
+
+class InvestmentsViewSet(viewsets.ModelViewSet):
+    queryset = Investments.objects.all()
+    serializer_class = InvestmentSerializer
+    filter_backends = [DjangoFilterBackend, filters.SearchFilter]
+    filterset_fields = ["owner__id"]
+    search_fields = ["owner__name"]
+
+    def create(self, request, *args, **kwargs):
+        request.data.update({'update_date':request.data.get('creation_date')})
+        request.data.update({'balance':request.data.get('amount')})
+        return super().create(request, *args, **kwargs)
+
+
+    def retrieve(self, request, *args, **kwargs):
+        self.serializer_class = InvestmentGetNestedSerializer
+        return super().retrieve(request, *args, **kwargs,)
+
+    def list(self, request, *args, **kwargs):
+        self.serializer_class = InvestmentNestedSerializer
+        return super().list(request, *args, **kwargs)
+
+    @action(detail=True, methods=['get'])
+    def withdraw(self, request, pk=None):
+        def investment_age(creation_date):
+            today = date.today()
+            diff_days = today - creation_date
+            years = diff_days.days//365
+            return years
+
+        investment = get_object_or_404(Investments, pk=pk)
+        income = investment.income
+        balance = investment.balance
+        years = investment_age(investment.creation_date)
+        if years < 1:
+            taxation = (income*Decimal(0.225))
+        elif years >= 1 and years <= 2:
+            taxation = (income*Decimal(0.185))
+        elif years > 2:
+            taxation = (income*Decimal(0.15))
+        amount_withdrawn = balance-taxation
+        if not investment.withdrawal_date:
+            investment.withdrawal_date = date.today()
+            investment.balance = investment.income
+            investment.save()
+            return Response({'valor do saque: ':amount_withdrawn})
+        else:
+            return Response({'valor do saque: ':amount_withdrawn+investment.amount})
+
+
+

investment/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class InvestmentConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'investment'