[MIG] fastapi_auth_jwt_demo: Migration to 18.0

Author: kobros-tech

fastapi_auth_jwt_demo/README.rst

@@ -1,13 +1,13 @@
-=====================
-FastAPI Auth JWT Test
-=====================
+======================
+FastAPI Auth JWT Model
+======================
 
 .. 
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! source digest: sha256:0808c6ada00df4f17e6f45cad7b22796dec0e945b1dddf2814d39a484e976b78
+   !! source digest: sha256:7e014d71c6caa0eee959cdf9b1153e4ef259b88623dbdac5ff634a95ccfd0695
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -17,47 +17,111 @@ FastAPI Auth JWT Test
     :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
     :alt: License: LGPL-3
 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github
-    :target: https://github.com/OCA/rest-framework/tree/16.0/fastapi_auth_jwt_demo
+    :target: https://github.com/OCA/rest-framework/tree/18.0/fastapi_auth_jwt_model
     :alt: OCA/rest-framework
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
-    :target: https://translation.odoo-community.org/projects/rest-framework-16-0/rest-framework-16-0-fastapi_auth_jwt_demo
+    :target: https://translation.odoo-community.org/projects/rest-framework-18-0/rest-framework-18-0-fastapi_auth_jwt_model
     :alt: Translate me on Weblate
 .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
-    :target: https://runboat.odoo-community.org/builds?repo=OCA/rest-framework&target_branch=16.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/rest-framework&target_branch=18.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
 
-Tests and demo routes for ``fastapi_auth_jwt``.
-
-The tests and routes are almost identical to those in ``auth_jwt_demo``, and
-the JWT validators used are those from ``auth_jwt_demo``.
+A prototype routes for ``fastapi_auth_jwt``.
 
 **Table of contents**
 
 .. contents::
    :local:
 
+Usage
+=====
+
+Example on using the API as a URL having arguments
+--------------------------------------------------
+
+.. code:: Bash
+
+   curl -X 'GET' \
+     'http://localhost:8069/fastapi_auth_http_model/whoami' \
+     -H 'accept: application/json' \
+     -H 'Authorization: Basic ZGVtbzpkZW1v'
+
+To get Access Key via headers API
+
+.. code:: Bash
+
+   curl -X 'POST' \
+     'http://localhost:8069/fastapi_auth_http_model/get_access_token' \
+     -H 'accept: application/json' \
+     -H 'Content-Type: application/json' \
+     -H 'Authorization: Basic ZGVtbzpkZW1v' \
+     -d '{
+     "aud": "auth_jwt_test_api",
+     "iss": "theissuer",
+     "exp": 1734650709.8363235,
+     "email": "string",
+     "key": "thesecret",
+     "algorithm": "HS256",
+     "access_key": "string"
+   }'
+
+To get Access Key via agumental API
+
+.. code:: Bash
+
+   curl -X 'GET' \
+     'http://localhost:8069/fastapi_auth_http_model/get_access_token/args?aud=auth_jwt_test_api&iss=theissuer&exp=1734651126.588449&email=mark.brown23%40example.com&key=thesecret&algorithm=HS256' \
+     -H 'accept: application/json' \
+     -H 'Authorization: Basic ZGVtbzpkZW1v' \
+
+.. code:: Bash
+
+   curl -X 'GET' \
+     'http://localhost:8069/fastapi_auth_http_model/customer' \
+     -H 'accept: application/json' \
+     -H 'Authorization: Basic ZGVtbzpkZW1v' \
+
+The encryption is from ``demo:demo``, to test:
+
+encode
+
+.. code:: Bash
+
+   echo -n 'demo:demo' | base64
+
+decode
+
+.. code:: Bash
+
+   echo -n 'demo:demo' | base64 -d
+
 Bug Tracker
 ===========
 
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/rest-framework/issues>`_.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us to smash it by providing a detailed and welcomed
-`feedback <https://github.com/OCA/rest-framework/issues/new?body=module:%20fastapi_auth_jwt_demo%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/rest-framework/issues/new?body=module:%20fastapi_auth_jwt_model%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
 
 Do not contact contributors directly about support or help with technical issues.
 
 Credits
 =======
 
 Authors
-~~~~~~~
+-------
+
+* kobros-tech
+
+Contributors
+------------
 
-* ACSONE SA/NV
+Mohamed Alkobrosli <alkobroslymohamed@gmail.com>
 
 Maintainers
-~~~~~~~~~~~
+-----------
 
 This module is maintained by the OCA.
 
@@ -69,14 +133,14 @@ OCA, or the Odoo Community Association, is a nonprofit organization whose
 mission is to support the collaborative development of Odoo features and
 promote its widespread use.
 
-.. |maintainer-sbidoul| image:: https://github.com/sbidoul.png?size=40px
-    :target: https://github.com/sbidoul
-    :alt: sbidoul
+.. |maintainer-kobros-tech| image:: https://github.com/kobros-tech.png?size=40px
+    :target: https://github.com/kobros-tech
+    :alt: kobros-tech
 
 Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
 
-|maintainer-sbidoul| 
+|maintainer-kobros-tech| 
 
-This module is part of the `OCA/rest-framework <https://github.com/OCA/rest-framework/tree/16.0/fastapi_auth_jwt_demo>`_ project on GitHub.
+This module is part of the `OCA/rest-framework <https://github.com/OCA/rest-framework/tree/18.0/fastapi_auth_jwt_model>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

fastapi_auth_jwt_demo/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"

fastapi_auth_jwt_demo/readme/CONTRIBUTORS.md

@@ -0,0 +1 @@
+Mohamed Alkobrosli \<<alkobroslymohamed@gmail.com>\>

fastapi_auth_jwt_demo/static/description/index.html

@@ -1,18 +1,18 @@
-<?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
-<title>FastAPI Auth JWT Test</title>
+<title>FastAPI Auth JWT Model</title>
 <style type="text/css">
 
 /*
 :Author: David Goodger (goodger@python.org)
-:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
+:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
 :Copyright: This stylesheet has been placed in the public domain.
 
 Default cascading style sheet for the HTML output of Docutils.
+Despite the name, some widely supported CSS2 features are used.
 
 See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
 customize this style sheet.
@@ -275,7 +275,7 @@
   margin-left: 2em ;
   margin-right: 2em }
 
-pre.code .ln { color: grey; } /* line numbers */
+pre.code .ln { color: gray; } /* line numbers */
 pre.code, code { background-color: #eeeeee }
 pre.code .comment, code .comment { color: #5C6576 }
 pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
@@ -301,7 +301,7 @@
 span.pre {
   white-space: pre }
 
-span.problematic {
+span.problematic, pre.problematic {
   color: red }
 
 span.section-subtitle {
@@ -360,56 +360,116 @@
 </style>
 </head>
 <body>
-<div class="document" id="fastapi-auth-jwt-test">
-<h1 class="title">FastAPI Auth JWT Test</h1>
+<div class="document" id="fastapi-auth-jwt-model">
+<h1 class="title">FastAPI Auth JWT Model</h1>
 
 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-!! source digest: sha256:0808c6ada00df4f17e6f45cad7b22796dec0e945b1dddf2814d39a484e976b78
+!! source digest: sha256:7e014d71c6caa0eee959cdf9b1153e4ef259b88623dbdac5ff634a95ccfd0695
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/rest-framework/tree/16.0/fastapi_auth_jwt_demo"><img alt="OCA/rest-framework" src="https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/rest-framework-16-0/rest-framework-16-0-fastapi_auth_jwt_demo"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/rest-framework&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
-<p>Tests and demo routes for <tt class="docutils literal">fastapi_auth_jwt</tt>.</p>
-<p>The tests and routes are almost identical to those in <tt class="docutils literal">auth_jwt_demo</tt>, and
-the JWT validators used are those from <tt class="docutils literal">auth_jwt_demo</tt>.</p>
+<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/rest-framework/tree/18.0/fastapi_auth_jwt_model"><img alt="OCA/rest-framework" src="https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/rest-framework-18-0/rest-framework-18-0-fastapi_auth_jwt_model"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/rest-framework&amp;target_branch=18.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<p>A prototype routes for <tt class="docutils literal">fastapi_auth_jwt</tt>.</p>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><a class="reference internal" href="#bug-tracker" id="toc-entry-1">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="toc-entry-2">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="toc-entry-3">Authors</a></li>
-<li><a class="reference internal" href="#maintainers" id="toc-entry-4">Maintainers</a></li>
+<li><a class="reference internal" href="#usage" id="toc-entry-1">Usage</a><ul>
+<li><a class="reference internal" href="#example-on-using-the-api-as-a-url-having-arguments" id="toc-entry-2">Example on using the API as a URL having arguments</a></li>
 </ul>
 </li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-3">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-4">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-5">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-6">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-7">Maintainers</a></li>
 </ul>
+</li>
+</ul>
+</div>
+<div class="section" id="usage">
+<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
+<div class="section" id="example-on-using-the-api-as-a-url-having-arguments">
+<h2><a class="toc-backref" href="#toc-entry-2">Example on using the API as a URL having arguments</a></h2>
+<pre class="code Bash literal-block">
+curl<span class="w"> </span>-X<span class="w"> </span><span class="s1">'GET'</span><span class="w"> </span><span class="se">\
+</span><span class="w">  </span><span class="s1">'http://localhost:8069/fastapi_auth_http_model/whoami'</span><span class="w"> </span><span class="se">\
+</span><span class="w">  </span>-H<span class="w"> </span><span class="s1">'accept: application/json'</span><span class="w"> </span><span class="se">\
+</span><span class="w">  </span>-H<span class="w"> </span><span class="s1">'Authorization: Basic ZGVtbzpkZW1v'</span>
+</pre>
+<p>To get Access Key via headers API</p>
+<pre class="code Bash literal-block">
+curl<span class="w"> </span>-X<span class="w"> </span><span class="s1">'POST'</span><span class="w"> </span><span class="se">\
+</span><span class="w">  </span><span class="s1">'http://localhost:8069/fastapi_auth_http_model/get_access_token'</span><span class="w"> </span><span class="se">\
+</span><span class="w">  </span>-H<span class="w"> </span><span class="s1">'accept: application/json'</span><span class="w"> </span><span class="se">\
+</span><span class="w">  </span>-H<span class="w"> </span><span class="s1">'Content-Type: application/json'</span><span class="w"> </span><span class="se">\
+</span><span class="w">  </span>-H<span class="w"> </span><span class="s1">'Authorization: Basic ZGVtbzpkZW1v'</span><span class="w"> </span><span class="se">\
+</span><span class="w">  </span>-d<span class="w"> </span><span class="s1">'{
+  &quot;aud&quot;: &quot;auth_jwt_test_api&quot;,
+  &quot;iss&quot;: &quot;theissuer&quot;,
+  &quot;exp&quot;: 1734650709.8363235,
+  &quot;email&quot;: &quot;string&quot;,
+  &quot;key&quot;: &quot;thesecret&quot;,
+  &quot;algorithm&quot;: &quot;HS256&quot;,
+  &quot;access_key&quot;: &quot;string&quot;
+}'</span>
+</pre>
+<p>To get Access Key via agumental API</p>
+<pre class="code Bash literal-block">
+curl<span class="w"> </span>-X<span class="w"> </span><span class="s1">'GET'</span><span class="w"> </span><span class="se">\
+</span><span class="w">  </span><span class="s1">'http://localhost:8069/fastapi_auth_http_model/get_access_token/args?aud=auth_jwt_test_api&amp;iss=theissuer&amp;exp=1734651126.588449&amp;email=mark.brown23%40example.com&amp;key=thesecret&amp;algorithm=HS256'</span><span class="w"> </span><span class="se">\
+</span><span class="w">  </span>-H<span class="w"> </span><span class="s1">'accept: application/json'</span><span class="w"> </span><span class="se">\
+</span><span class="w">  </span>-H<span class="w"> </span><span class="s1">'Authorization: Basic ZGVtbzpkZW1v'</span><span class="w"> </span><span class="se">\</span>
+</pre>
+<pre class="code Bash literal-block">
+curl<span class="w"> </span>-X<span class="w"> </span><span class="s1">'GET'</span><span class="w"> </span><span class="se">\
+</span><span class="w">  </span><span class="s1">'http://localhost:8069/fastapi_auth_http_model/customer'</span><span class="w"> </span><span class="se">\
+</span><span class="w">  </span>-H<span class="w"> </span><span class="s1">'accept: application/json'</span><span class="w"> </span><span class="se">\
+</span><span class="w">  </span>-H<span class="w"> </span><span class="s1">'Authorization: Basic ZGVtbzpkZW1v'</span><span class="w"> </span><span class="se">\</span>
+</pre>
+<p>The encryption is from <tt class="docutils literal">demo:demo</tt>, to test:</p>
+<p>encode</p>
+<pre class="code Bash literal-block">
+<span class="nb">echo</span><span class="w"> </span>-n<span class="w"> </span><span class="s1">'demo:demo'</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>base64
+</pre>
+<p>decode</p>
+<pre class="code Bash literal-block">
+<span class="nb">echo</span><span class="w"> </span>-n<span class="w"> </span><span class="s1">'demo:demo'</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>base64<span class="w"> </span>-d
+</pre>
+</div>
 </div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/rest-framework/issues">GitHub Issues</a>.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us to smash it by providing a detailed and welcomed
-<a class="reference external" href="https://github.com/OCA/rest-framework/issues/new?body=module:%20fastapi_auth_jwt_demo%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<a class="reference external" href="https://github.com/OCA/rest-framework/issues/new?body=module:%20fastapi_auth_jwt_model%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
-<h1><a class="toc-backref" href="#toc-entry-2">Credits</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-4">Credits</a></h1>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#toc-entry-3">Authors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-5">Authors</a></h2>
 <ul class="simple">
-<li>ACSONE SA/NV</li>
+<li>kobros-tech</li>
 </ul>
 </div>
+<div class="section" id="contributors">
+<h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
+<p>Mohamed Alkobrosli &lt;<a class="reference external" href="mailto:alkobroslymohamed&#64;gmail.com">alkobroslymohamed&#64;gmail.com</a>&gt;</p>
+</div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-7">Maintainers</a></h2>
 <p>This module is maintained by the OCA.</p>
-<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
+<a class="reference external image-reference" href="https://odoo-community.org">
+<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
+</a>
 <p>OCA, or the Odoo Community Association, is a nonprofit organization whose
 mission is to support the collaborative development of Odoo features and
 promote its widespread use.</p>
 <p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
-<p><a class="reference external image-reference" href="https://github.com/sbidoul"><img alt="sbidoul" src="https://github.com/sbidoul.png?size=40px" /></a></p>
-<p>This module is part of the <a class="reference external" href="https://github.com/OCA/rest-framework/tree/16.0/fastapi_auth_jwt_demo">OCA/rest-framework</a> project on GitHub.</p>
+<p><a class="reference external image-reference" href="https://github.com/kobros-tech"><img alt="kobros-tech" src="https://github.com/kobros-tech.png?size=40px" /></a></p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/rest-framework/tree/18.0/fastapi_auth_jwt_model">OCA/rest-framework</a> project on GitHub.</p>
 <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
 </div>
 </div>