add initial

Author: ArefMousakhani

.gitignore

@@ -0,0 +1,132 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Other
+.idea

README.md

@@ -1 +1,16 @@
-# django_rest_structure_sample
+## This is sample project that use `django-rest-structure`
+
+### install requirements:
+
+`pip install requirements.txt`
+
+### run project
+
+`python manage.py runserver`
+
+### then call this urls:
+`/api/v1/profile/`
+
+`/api/v1/exception/`
+
+then see what happen

api/urls.py

@@ -0,0 +1,6 @@
+
+from django.urls import path, include
+
+urlpatterns = [
+    path('v1/', include('api.v1.urls')),
+]

api/v1/serializers.py

@@ -0,0 +1,41 @@
+from django_rest_structure.api.serializers import BaseSerializer
+from rest_framework import serializers
+from django_rest_structure.api.validations import StrFieldValidation
+from django_rest_structure.results.response import ResponseStructure
+from django_rest_structure.requests.tools import get_client_ip
+
+from core.exception import ResultMessages
+
+
+def first_name_validation(value, **extra_params):
+    return value.capitalize()
+
+
+def last_name_validation(value, **extra_params):
+    return value.capitalize()
+
+
+class ProfileSerializer(BaseSerializer):
+    first_name = serializers.CharField(validators=[StrFieldValidation(
+        regex=r'^[A-Za-z]+$',
+        error_message='just enter alphabet',
+        extra_function=first_name_validation
+    )])
+    last_name = serializers.CharField(validators=[StrFieldValidation(
+        regex=r'^[A-Za-z]+$',
+        error_message='just enter alphabet',
+        extra_function=last_name_validation
+    )])
+
+    age = serializers.IntegerField()
+
+    def get_detail(self):
+        response_data = {
+            'request_id': self.request.request_uid,
+            'ip_address': get_client_ip(self.request),
+            'first_name': self.validated_data['first_name'],
+            'last_name': self.validated_data['last_name'],
+            'full_name': f"{self.validated_data['first_name']} {self.validated_data['last_name']}",
+            'age': self.validated_data['age']
+        }
+        return ResponseStructure(ResultMessages.GET_SUCCESSFULLY, response_data)

api/v1/urls.py

@@ -0,0 +1,10 @@
+
+from django.urls import path, include
+
+from api.v1.views import ProfileView, TestExceptionView
+
+urlpatterns = [
+    path('profile/', ProfileView.as_view()),
+    path('exception/', TestExceptionView.as_view()),
+
+]

api/v1/views.py

@@ -0,0 +1,15 @@
+from django_rest_structure.api.views import BaseApiView
+from django_rest_structure.results.response import ResponseStructure
+
+from api.v1.serializers import ProfileSerializer
+from core.exception import ResultMessages, Ex
+
+
+class ProfileView(BaseApiView):
+    def post_method(self, request, *args, **kwargs):
+        return ProfileSerializer(data=request.data, check_is_valid=True, request=request).get_detail()
+
+
+class TestExceptionView(BaseApiView):
+    def post_method(self, request, *args, **kwargs):
+        raise Ex(Ex.TEST_RESULT)

core/exception.py

@@ -0,0 +1,12 @@
+from django_rest_structure.results.exception import Err, ResultMessages
+from django_rest_structure.results.codes import ResultMessageStructure
+from rest_framework import status
+
+
+class CustomResultMessages(ResultMessages):
+    TEST_RESULT = ResultMessageStructure(10, 'this is my test error', False, status.HTTP_400_BAD_REQUEST)
+
+
+class Ex(CustomResultMessages, Err):
+    def __init__(self, *args, **kwargs):
+        super(Ex, self).__init__(*args, **kwargs)

core/response.py

@@ -0,0 +1,8 @@
+def response_handler(response):
+    return {
+        'status': {
+            'code': response.message.code,
+            'message': response.message.message,
+        },
+        'result': response.body
+    }

django_rest_structure_sample/__init__.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for django_rest_structure_sample project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_rest_structure_sample.settings')
+
+application = get_asgi_application()