reflex-google-auth 0.0.4__py3-none-any.whl → 0.0.6__py3-none-any.whl

reflex_google_auth/state.py

@@ -10,7 +10,7 @@ from google.oauth2.id_token import verify_oauth2_token
 import reflex as rx
 
 
-CLIENT_ID = os.environ.get("GOOGLE_CLIENT_ID", "")
+CLIENT_ID = None
 
 
 def set_client_id(client_id: str):
@@ -25,11 +25,11 @@ class GoogleAuthState(rx.State):
     def on_success(self, id_token: dict):
         self.id_token_json = json.dumps(id_token)
 
-    @rx.cached_var
+    @rx.var(cache=True)
     def client_id(self) -> str:
-        return CLIENT_ID
+        return CLIENT_ID or os.environ.get("GOOGLE_CLIENT_ID", "")
 
-    @rx.cached_var
+    @rx.var(cache=True)
     def tokeninfo(self) -> dict[str, str]:
         try:
             return verify_oauth2_token(
@@ -54,10 +54,10 @@ class GoogleAuthState(rx.State):
         except Exception:
             return False
 
-    @rx.cached_var
+    @rx.var(cache=True)
     def user_name(self) -> str:
         return self.tokeninfo.get("name", "")
 
-    @rx.cached_var
+    @rx.var(cache=True)
     def user_email(self) -> str:
         return self.tokeninfo.get("email", "")

reflex_google_auth-0.0.6.dist-info/METADATA

@@ -0,0 +1,91 @@
+Metadata-Version: 2.1
+Name: reflex-google-auth
+Version: 0.0.6
+Summary: Sign in with Google
+Author-email: Masen Furer <m_github@0x26.net>
+License: Apache-2.0
+Project-URL: homepage, https://github.com/masenf/reflex-google-auth
+Keywords: reflex,reflex-custom-components
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: reflex>=0.4.6
+Requires-Dist: google-auth[requests]
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+
+# google-auth
+
+Sign in with Google.
+
+## Installation
+
+```bash
+pip install reflex-google-auth
+```
+
+## Usage
+
+### Create Google OAuth2 Client ID
+
+Head over to https://console.developers.google.com/apis/credentials and sign in with the Google account that should manage the app and credential tokens.
+
+- Click "Create Project" and give it a name. After creation the new project should be selected.
+- Click "Configure Consent Screen", Choose "External", then Create.
+  - Enter App Name and User Support Email -- these will be shown to users when logging in
+  - Scroll all the way down to "Developer contact information" and add your email address, click "Save and Continue"
+  - Click "Add or Remove Scopes"
+    - Select "Email", "Profile", and "OpenID Connect"
+    - Click "Update", then "Save and Continue"
+  - Add any test users that should be able to log in during development.
+- From the "Credentials" page, click "+ Create Credentials", then "OAuth client ID"
+  - Select Application Type: "Web Application"
+  - Add Authorized Javascript Origins: http://localhost, http://localhost:3000, https://example.com (prod domain must be HTTPS)
+  - Click "Save"
+- Copy the OAuth "Client ID" and save it for later. Mine looks like 309209880368-4uqd9e44h7t4alhhdqn48pvvr63cc5j5.apps.googleusercontent.com
+
+https://github.com/reflex-dev/reflex-examples/assets/1524005/af2499a6-0bda-4d60-b52b-4f51b7322fd5
+
+### Integrate with Reflex app
+
+The `GoogleAuthState` provided by this component has a `token_is_valid` var that
+should be checked before returning any protected content.
+
+Additionally the `GoogleAuthState.tokeninfo` dict contains the user's profile information.
+
+```python
+from reflex_google_auth import GoogleAuthState, require_google_login
+
+
+class State(GoogleAuthState):
+    @rx.var(cache=True)
+    def protected_content(self) -> str:
+        if self.token_is_valid:
+            return f"This content can only be viewed by a logged in User. Nice to see you {self.tokeninfo['name']}"
+        return "Not logged in."
+```
+
+The convenience decorator, `require_google_login`, can wrap an existing component, and
+show the "Sign in with Google" button if the user is not already authenticated. It can be
+used on a page function or any subcomponent function of the page.
+
+The "Sign in with Google" button can also be displayed via `google_login()`:
+
+```python
+from reflex_google_auth import google_login, google_oauth_provider
+
+def page():
+    return rx.div(
+        google_oauth_provider(
+            google_login(),
+        ),
+    )
+```
+
+To uniquely identify a user, the `GoogleAuthState.tokeninfo['sub']` field can be used.
+
+See the example in
+[masenf/rx_shout](https://github.com/masenf/rx_shout/blob/main/rx_shout/state.py)
+for how to integrate an authenticated Google user with other app-specific user
+data.

reflex_google_auth-0.0.6.dist-info/RECORD

@@ -0,0 +1,8 @@
+reflex_google_auth/__init__.py,sha256=StBRDVUPCsMwOVRRgvb_WdzoDkSZoq2RLOoe-YsBExE,291
+reflex_google_auth/decorator.py,sha256=70gaOYTupWTE1m0hd2D8TvcoP0CUNVxtBdezurzXtMM,594
+reflex_google_auth/google_auth.py,sha256=gEL68F4M77gS5bfG4GVojvIuq8fKx8XpAQ1cIIU6-pk,794
+reflex_google_auth/state.py,sha256=IVsHpaI-ahcVNWTCyZGzA9g9mbcansKH3wrxGCV17R0,1514
+reflex_google_auth-0.0.6.dist-info/METADATA,sha256=LThWAPOIhA7ujUweuhOIefAcDKnAVD1iBjI_cb1stYI,3337
+reflex_google_auth-0.0.6.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+reflex_google_auth-0.0.6.dist-info/top_level.txt,sha256=JB7Letu_7VOfOx5EhyGn_bElQjzSq43-LHafE90wqyM,19
+reflex_google_auth-0.0.6.dist-info/RECORD,,

{reflex_google_auth-0.0.4.dist-info → reflex_google_auth-0.0.6.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: setuptools (75.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

reflex_google_auth/google_auth.pyi

@@ -1,24 +0,0 @@
-from typing import Any, Dict, Literal, Optional, Union, overload
-from reflex.vars import Var, BaseVar, ComputedVar
-from reflex.event import EventChain, EventHandler, EventSpec
-from reflex.style import Style
-import reflex as rx
-from .state import GoogleAuthState
-
-class GoogleOAuthProvider(rx.Component):
-
-    @overload
-    @classmethod
-    def create(cls, *children, client_id: Optional[Union[Var[str], str]]=None, style: Optional[Style]=None, key: Optional[Any]=None, id: Optional[Any]=None, class_name: Optional[Any]=None, autofocus: Optional[bool]=None, custom_attrs: Optional[Dict[str, Union[Var, str]]]=None, on_blur: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_click: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_context_menu: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_double_click: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_focus: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_mount: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_mouse_down: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_mouse_enter: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_mouse_leave: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_mouse_move: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_mouse_out: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_mouse_over: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_mouse_up: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_scroll: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_unmount: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, **props) -> 'GoogleOAuthProvider':
-        """"""
-        ...
-google_oauth_provider = GoogleOAuthProvider.create
-
-class GoogleLogin(rx.Component):
-
-    @overload
-    @classmethod
-    def create(cls, *children, on_success: Optional[EventHandler[Any]]=None, style: Optional[Style]=None, key: Optional[Any]=None, id: Optional[Any]=None, class_name: Optional[Any]=None, autofocus: Optional[bool]=None, custom_attrs: Optional[Dict[str, Union[Var, str]]]=None, on_blur: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_click: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_context_menu: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_double_click: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_focus: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_mount: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_mouse_down: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_mouse_enter: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_mouse_leave: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_mouse_move: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_mouse_out: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_mouse_over: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_mouse_up: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_scroll: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_success: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, on_unmount: Optional[Union[EventHandler, EventSpec, list, function, BaseVar]]=None, **props) -> 'GoogleLogin':
-        """"""
-        ...
-google_login = GoogleLogin.create

reflex_google_auth-0.0.4.dist-info/METADATA

@@ -1,26 +0,0 @@
-Metadata-Version: 2.1
-Name: reflex-google-auth
-Version: 0.0.4
-Summary: Reflex custom component google-auth
-Author-email: Masen Furer <m_github@0x26.net>
-License: Apache-2.0
-Project-URL: Homepage, https://github.com/martinxu9/reflex-google-auth
-Keywords: reflex,reflex-custom-components
-Classifier: Development Status :: 4 - Beta
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: reflex >=0.4.6a
-Requires-Dist: google-auth[requests]
-Provides-Extra: dev
-Requires-Dist: build ; extra == 'dev'
-Requires-Dist: twine ; extra == 'dev'
-
-# google-auth
-
-A Reflex custom component google-auth.
-
-## Installation
-
-```bash
-pip install reflex-google-auth
-```

reflex_google_auth-0.0.4.dist-info/RECORD

@@ -1,9 +0,0 @@
-reflex_google_auth/__init__.py,sha256=StBRDVUPCsMwOVRRgvb_WdzoDkSZoq2RLOoe-YsBExE,291
-reflex_google_auth/decorator.py,sha256=70gaOYTupWTE1m0hd2D8TvcoP0CUNVxtBdezurzXtMM,594
-reflex_google_auth/google_auth.py,sha256=gEL68F4M77gS5bfG4GVojvIuq8fKx8XpAQ1cIIU6-pk,794
-reflex_google_auth/google_auth.pyi,sha256=qXp-LeMhQ-pt0JjHb2zTCn8oLU8YMt28gMYZTBvcdDE,3800
-reflex_google_auth/state.py,sha256=q3C-tb4z4wfKCbRLsJ6JJuVy1MrTGptYnobo1jyKmuU,1486
-reflex_google_auth-0.0.4.dist-info/METADATA,sha256=SgpLp2os4fTa0Bt7CYztgi2_E-c82jMVnXMGctJ7v1A,672
-reflex_google_auth-0.0.4.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-reflex_google_auth-0.0.4.dist-info/top_level.txt,sha256=JB7Letu_7VOfOx5EhyGn_bElQjzSq43-LHafE90wqyM,19
-reflex_google_auth-0.0.4.dist-info/RECORD,,