[update] first commit

Author: NatLee

.editorconfig

@@ -0,0 +1,20 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.py]
+charset = utf-8
+indent_style = space
+indent_size = 4
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{md,mdx}]
+trim_trailing_whitespace = false

.github/workflows/release.yml

@@ -0,0 +1,26 @@
+name: Release
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel twine
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          python setup.py sdist bdist_wheel
+          twine upload --repository pypi dist/*

.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+    branches:
+      - main
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: [3.7, 3.8, 3.9, 3.10, 3.11]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install Tox and other packages
+        run: pip install tox
+      - name: Run Tox
+        # Run tox using the version of Python in `PATH`
+        run: tox -e py

.gitignore

@@ -0,0 +1,143 @@
+
+# Trash by OS
+.DS_Store
+desktop.ini
+
+# 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/
+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/
+cover/
+
+# 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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true,
+  "python.envFile": "${workspaceRoot}/vscode.env"
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Nat Lee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MANIFEST.in

@@ -0,0 +1,5 @@
+include pyproject.toml
+include *.md
+include LICENSE
+recursive-include tests test*.py
+recursive-include example *.py

README.md

@@ -0,0 +1,129 @@
+# Django Proxy API
+
+This is a tool for proxying any APIs on Django server.
+
+You can use it as middleware to make a layer for user authorization or something.
+
+## Installation
+
+```bash
+pip install djangoapiproxy
+```
+
+## Quick Start
+
+1. Add `django_api_proxy` to your `INSTALLED_APPS` in `settings.py` like this:
+
+```py
+INSTALLED_APPS = [
+...
+'django_api_proxy',
+]
+```
+
+2. Add APP settings to your `settings.py` like this:
+
+```py
+TARGET_API_URL = 'https://httpbin.org'
+PROXY_ROUTE_PATH = 'my_test_route'
+PROXY_TARGET_PATH = ''
+```
+
+3. Include the `django_api_proxy` URL settings in your project `urls.py` like this:
+
+```py
+from django.conf import settings
+from django.urls import include
+urlpatterns += [
+    path(settings.PROXY_ROUTE_PATH, include('django_api_proxy.urls'))
+]
+```
+
+4. Test on your server.
+
+```bash
+python manage.py runserver
+```
+
+Here's an example you success proxy an API by visit the following URLs.
+
+- http://127.0.0.1:8000/my_test_route/
+- http://127.0.0.1:8000/my_test_route
+
+And the result will be as below.
+
+```log
+[06/Sep/2022 01:26:04] "GET /my_test_route/ HTTP/1.1" 200 314
+2022-09-06 01:26:06.338 | DEBUG    | django_api_proxy.views:get:73 - ----- Proxy GET
+2022-09-06 01:26:06.339 | DEBUG    | django_api_proxy.views:get_proxy_path:37 - URL: /get
+2022-09-06 01:26:06.340 | DEBUG    | django_api_proxy.views:update_payload:49 - Username: #anonymous
+```
+
+```json
+{
+  "args": { "username": "#anonymous" },
+  "headers": {
+    "Accept": "*/*",
+    "Accept-Encoding": "gzip, deflate, br",
+    "Host": "httpbin.org",
+    "User-Agent": "python-requests/2.27.1",
+    "X-Amzn-Trace-Id": "Root=1-6316360c-2308560261599de4071127ac"
+  },
+  "origin": "xxx.xxx.xxx.xxx",
+  "url": "https://httpbin.org/get?username=%23anonymous"
+}
+```
+
+But when you visit `http://127.0.0.1:8000/my_test_route/123`, you'll get error.
+
+Cause this URL is not found on target API server.
+
+So, this proxy server will return this for you.
+
+```json
+{ "status": "error" }
+```
+
+## Usage
+
+After the quick start, you may want to change some methods with your API server like making an authorization.
+
+You can do it with inheriting the `APIProxy` class.
+
+Here is an example:
+
+```py
+
+import requests
+
+from rest_framework.authentication import SessionAuthentication
+from rest_framework_simplejwt.authentication import JWTAuthentication
+from rest_framework.permissions import IsAuthenticated
+
+from django_api_proxy.views import APIProxy
+
+class MyAPIProxy(APIProxy):
+    # give custom authentication
+    authentication_classes = [SessionAuthentication, JWTAuthentication]
+
+    # give custom permission
+    permission_classes = [IsAuthenticated]
+
+    def get(self, request, *args, **kwargs):
+        """Get."""
+        # your new `GET` logic here
+
+        logger.debug("----- Proxy GET Heyyaya")
+        response = {"status": "default error!!"}
+        try:
+            params = dict(request.GET)
+            path = self.get_proxy_path(request)
+            params = self.update_payload(request, params)
+            middle_resp_ = self.send_request("GET", path, params=params)
+            response = middle_resp_.json()
+        except Exception as e:
+            print('yooooo error occurs!!')
+            print(e)
+        return self.response(response)
+
+```