Bug fixes for 0.2.0 release Fixes #225 (#226)

Joe Gasewicz · web-flow · commit fe3e79468d2a · 2021-07-22T12:57:18.000+01:00
* Big fixes for 0.2.0 release Fixes #225 * Bug fixes for 0.2.0 release Fixes #225 * Bug fixes for 0.2.0 release Fixes #225 * Bug fixes for 0.2.0 release Fixes #225
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,13 +2,18 @@
 
 ### Changed
 
+**Releases 0.2.0** - 2021-07-21
+- 🎁 Remove testing logic from library's `Routing` & `Entity` classes  [Issue #219](https://github.com/joegasewicz/flask-jwt-router/issues/219)
+- 🎁 Testing mixin for Google class  [Issue #220](https://github.com/joegasewicz/flask-jwt-router/issues/220)
+- 🪲 Bug fixes for 0.2.0 release Fixes [Issue #225](https://github.com/joegasewicz/flask-jwt-router/issues/225)
+
 **Releases 0.1.9** - 2021-03-16
--   🎁 Allow for multiple tablenames for Google OAuth  [Issue #206](https://github.com/joegasewicz/flask-jwt-router/issues/206)
+- 🎁 Allow for multiple tablenames for Google OAuth  [Issue #206](https://github.com/joegasewicz/flask-jwt-router/issues/206)
 
 **Releases 0.1.8** - 2021-03-16
--   📝 Outdated docstring - nice easy fix for a beginner developer! [Issue #192](https://github.com/joegasewicz/flask-jwt-router/issues/192)
--   🎁 Bump cryptography from 3.3.1 to 3.3.2 #197
--   🎁 Multiple redirect URI's for Google OAuth #203 [Issue #203](https://github.com/joegasewicz/flask-jwt-router/issues/203)
+- 📝 Outdated docstring - nice easy fix for a beginner developer! [Issue #192](https://github.com/joegasewicz/flask-jwt-router/issues/192)
+- 🎁 Bump cryptography from 3.3.1 to 3.3.2 #197
+- 🎁 Multiple redirect URI's for Google OAuth #203 [Issue #203](https://github.com/joegasewicz/flask-jwt-router/issues/203)
 
 **Releases 0.1.7** - 2021-01-27
 - 🎁 Test utils for OAuth users should handle multiple user states. [Issue #188](https://github.com/joegasewicz/flask-jwt-router/pull/188)
@@ -40,24 +45,22 @@
 
 **Release 0.0.27** - 2020-09-14
 
--   🪲 Secret Key now must be set [Issue #137](https://github.com/joegasewicz/flask-jwt-router/issues/137)
--   🪲 Fixes ModuleNotFoundError: No module named 'dateutil' [Issue #138](https://github.com/joegasewicz/flask-jwt-router/issues/138)
--   🎁 Removes strategy design pattern from project [Issue #141](https://github.com/joegasewicz/flask-jwt-router/issues/141)
--   🎁 Renamed extensions to Config [Issue #143](https://github.com/joegasewicz/flask-jwt-router/issues/143)
--   🎁 Added token expire duration option [Issue #44](https://github.com/joegasewicz/flask-jwt-router/issues/44)
+- 🪲 Secret Key now must be set [Issue #137](https://github.com/joegasewicz/flask-jwt-router/issues/137)
+- 🪲 Fixes ModuleNotFoundError: No module named 'dateutil' [Issue #138](https://github.com/joegasewicz/flask-jwt-router/issues/138)
+- 🎁 Removes strategy design pattern from project [Issue #141](https://github.com/joegasewicz/flask-jwt-router/issues/141)
+- 🎁 Renamed extensions to Config [Issue #143](https://github.com/joegasewicz/flask-jwt-router/issues/143)
+- 🎁 Added token expire duration option [Issue #44](https://github.com/joegasewicz/flask-jwt-router/issues/44)
 
 **Release 0.0.26** - 2019-12-11
 
--   🪲 Preflight OPTIONS bug fix [Issue #125](https://github.com/joegasewicz/Flask-JWT-Router/issues/125)
+- 🪲 Preflight OPTIONS bug fix [Issue #125](https://github.com/joegasewicz/Flask-JWT-Router/issues/125)
 
 **Release 0.0.25** - 2019-12-10
 
--   🎁 Replaced the the `entity_type` kwarg to `table_name` in the public method `register_entity` [Issue #111](https://github.com/joegasewicz/Flask-JWT-Router/issues/111)
--   🎁 Renamed the `update_entity` public method to be called `update_token` [Issue #114](https://github.com/joegasewicz/Flask-JWT-Router/issues/114)
--   🎁 Renamed the `register_entity` public method to be called `create_token` [Issue #113](https://github.com/joegasewicz/Flask-JWT-Router/issues/113)
--   🎁 Add Models to JWTRoutes class & init_app method [Issue #119](https://github.com/joegasewicz/Flask-JWT-Router/issues/119)
+- 🎁 Replaced the the `entity_type` kwarg to `table_name` in the public method `register_entity` [Issue #111](https://github.com/joegasewicz/Flask-JWT-Router/issues/111)
+- 🎁 Renamed the `update_entity` public method to be called `update_token` [Issue #114](https://github.com/joegasewicz/Flask-JWT-Router/issues/114)
+- 🎁 Renamed the `register_entity` public method to be called `create_token` [Issue #113](https://github.com/joegasewicz/Flask-JWT-Router/issues/113)
+- 🎁 Add Models to JWTRoutes class & init_app method [Issue #119](https://github.com/joegasewicz/Flask-JWT-Router/issues/119)
 
 ## Unreleased
-**Releases 0.2.0** - 2021-07-21
--   🎁 Remove testing logic from library's `Routing` & `Entity` classes  [Issue #219](https://github.com/joegasewicz/flask-jwt-router/issues/219)
--   🎁 Testing mixin for Google class  [Issue #220](https://github.com/joegasewicz/flask-jwt-router/issues/220)
+
diff --git a/README.md b/README.md
@@ -15,25 +15,21 @@ Read the docs: [Flask-JWT-Router](https://flask-jwt-router.readthedocs.io/en/lat
 Flask JWT Router is a Python library that adds authorised routes to a Flask app. Both basic & Google's OAuth2.0 authentication
 is supported.
 
+## ![Google-Cloud](assets/Google-Cloud1.png) Google's OAuth2.0 supported
 
-## ![Google-Cloud](assets/Google-Cloud1.png) Google's OAuth2.0 supported 
 
-### Google OAuth 2.0 Quick Start
-
-Read the detailed instructions here: [Flask-JWT-Router](https://flask-jwt-router.readthedocs.io/en/latest/google.html)
+## Quik Start
 ```python
-oauth_options = {
-    "client_id": "<CLIENT_ID>",
-    "client_secret": "<CLIENT_SECRET>",
-    "redirect_uri": "http://localhost:3000",
-    "tablename": "users",
-    "email_field": "email",
-    "expires_in": 3600,
-}
+from flask_jwt_router import JwtRoutes
 
-jwt_routes.init_app(app, google_oauth=oauth_options)
+jwt_routes = JwtRoutes()
+jwt_routes.init_app(
+    app,
+    entity_models=[MyModel],
+)
 ```
 
+
 Now your front end needs a token. Create an endpoint &
 return a new access token from the clients header *code*.
 For Example::
@@ -262,6 +258,30 @@ If you require calling a resource without passing headers, then you can use the
     url = "http://example.com/cars?auth=my_token"
 ```
 
+### Google OAuth 2.0 Quick Start
+
+Read the detailed instructions here: [Flask-JWT-Router](https://flask-jwt-router.readthedocs.io/en/latest/google.html)
+```python
+from flask_jwt_router import Google, JwtRoutes
+
+oauth_options = {
+    "client_id": "<CLIENT_ID>",
+    "client_secret": "<CLIENT_SECRET>",
+    "redirect_uri": "http://localhost:3000",
+    "tablename": "users",
+    "email_field": "email",
+    "expires_in": 3600,
+}
+
+jwt_routes = JwtRoutes()
+jwt_routes.init_app(
+    app,
+    google_oauth=oauth_options,
+    strategies=[Google],
+    entity_models=[MyModel],
+)
+```
+
 ## Google OAuth 2.0 with ReactJS
 Flask-JWT-Router supports auth Google's OAuth 2.0 Single Sign On strategy if you are using React only.
 (We will provide Google's OAuth 2.0 Single Sign On strategy for server to server as soon as possible!).
@@ -271,15 +291,17 @@ Create a login route for Google's OAuth 2.0
 ```python
    @app.route("/api/v1/google_login", methods=["POST"])
     def google_login():
-        data = jwt_routes.google.oauth_login(request)
+        google = jwt_routes.get_strategy("Google")
+        data = google.oauth_login(request)
         return data, 200
 ```
 
 If your app requires multiple redirect uri's then
 you can use the `redirect_uri` kwarg to assign a uri for the current
 request handler. For example:
 ```python
-data = jwt_routes.google.oauth_login(request, redirect="http://another_redirect.com")
+google = jwt_routes.get_strategy("Google")
+data = google.oauth_login(request, redirect="http://another_redirect.com")
 ```
 
 We have created a ReactJS library specifically for Flask-JWT-Router - [react-google-oauth2.0](https://github.com/joegasewicz/react-google-oauth2.0)
@@ -294,6 +316,39 @@ Testing OAuth2.0 in a Flask app is non-trivial, especially if you rely on Flask-
 to append your user onto Flask's global context (or `g`). Therefore we have provided a
 utility method that returns a headers Dict that you can then use in your test view handler
 request. This example is using the Pytest library:
+```python
+    from flask_jwt_router import (
+        BaseJwtRoutes,
+        JwtRoutes,
+        Google,
+        GoogleTestUtil,
+        TestRoutingMixin,
+    )
+
+    class TestJwtRoutes(TestRoutingMixin, BaseJwtRoutes):
+        pass
+    
+    
+    if not Config.E2E_TEST:
+        jwt_routes = JwtRoutes()
+    else:
+        jwt_routes = TestJwtRoutes()
+
+    if not config.E2E_TEST:
+        jwt_routes.init_app(
+            app,
+            google_oauth=oauth_options,
+            strategies=[Google],
+            entity_models=[MyModel],
+        )
+    else:
+        jwt_routes.init_app(
+            app,
+            google_oauth=oauth_options,
+            strategies=[GoogleTestUtil],
+            entity_models=[MyModel],
+        )
+```
 
 ```python
     @pytest.fixture()
@@ -302,7 +357,8 @@ request. This example is using the Pytest library:
 
 
     def test_blogs(client):
-        user_headers = jwt_routes.google.create_test_headers(email="user@gmail.com")
+        google = jwt_routes.get_strategy("GoogleTestUtil")
+        user_headers = google.create_test_headers(email="user@gmail.com")
         rv = client.get("/blogs", headers=user_headers)
 ```
 
@@ -311,7 +367,8 @@ For example:
 
 ```python
 # user is an instantiated SqlAlchemy object
-user_headers = jwt_routes.google.create_test_headers(email="user@gmail.com", entity=user)
+google = jwt_routes.get_strategy("GoogleTestUtil")
+user_headers = google.create_test_headers(email="user@gmail.com", entity=user)
 # user_headers: { "X-Auth-Token": "Bearer <GOOGLE_OAUTH2_TEST>" }
 ```
 If you require more than one request to a Flask view handler in a single unit test, then set
@@ -320,7 +377,8 @@ entities within a single unit test method or function then you must pass in your
 For example:
 ```python
 my_entity = User(email="user@gmail.com") # If you're testing against a real db, make sure this is an entry in the db
-_ = jwt_routes.google.create_test_headers(email="user@gmail.com", scope="application", entity=my_entity)
+google = jwt_routes.get_strategy("GoogleTestUtil")
+_ = google.create_test_headers(email="user@gmail.com", scope="application", entity=my_entity)
 
 ```
 
diff --git a/flask_jwt_router/_routing.py b/flask_jwt_router/_routing.py
@@ -184,17 +184,21 @@ def handle_token(self):
         :return None:
         """
         strategy: Optional[BaseOAuth] = None
+        oauth_key: str = ""
         try:
             # TODO update docs
             resource_headers = request.headers.get("X-Auth-Resource")
             oauth_headers = request.headers.get("X-Auth-Token")
+            if oauth_headers:
+                # TODO When we have more than one strategy then `oauth_key` should derive the key dynamically
+                oauth_key = "X-Auth-Token"
             if request.args.get("auth"):
                 token = request.args.get("auth")
             # Strategies --------------------------------------------------------- #
 
             elif oauth_headers is not None and len(self.strategy_dict.keys()):
                 for s in self.strategy_dict.values():
-                    if s.header_name == oauth_headers:
+                    if s.header_name == oauth_key:
                         strategy = s
                 if not strategy:
                     abort(401)
@@ -261,6 +265,9 @@ def handle_token(self):
 
 
 class _TestMixin(Routing):
+    """
+    TODO https://github.com/joegasewicz/flask-jwt-router/issues/224 - Router test mixin should not duplicate any code from the Router class #224
+    """
 
     strategies: List[TestBaseOAuth]
 
@@ -289,7 +296,7 @@ def handle_token(self):
                     abort(401)
                 try:
                     if not strategy.test_metadata:
-                        raise Exception("You didn't create your test headers with create_test_headers()")
+                        strategy.create_test_headers(email=token)
                     email, entity = strategy.update_test_metadata(token)
 
                     self.entity.oauth_entity_key = self.config.oauth_entity
