reflex-xpw 0.1__tar.gz

reflex_xpw-0.1/LICENSE

@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

reflex_xpw-0.1/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.1
+Name: reflex-xpw
+Version: 0.1
+Summary: Simple access control for Reflex applications based on xpw
+Home-page: https://github.com/bondbox/reflex-xpw/
+Author: Mingzhe Zou
+Author-email: zoumingzhe@outlook.com
+License: GPLv2
+Project-URL: Source Code, https://github.com/bondbox/reflex-xpw/
+Project-URL: Bug Tracker, https://github.com/bondbox/reflex-xpw/issues
+Project-URL: Documentation, https://github.com/bondbox/reflex-xpw/
+Keywords: command-line,argparse,argcomplete
+Platform: any
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: xkits-config>=0.4
+Requires-Dist: reflex>=0.8.1
+Requires-Dist: xpw>=0.15.1
+
+# reflex-xpw
+
+> Simple access control for Reflex applications based on xpw

reflex_xpw-0.1/README.md

@@ -0,0 +1,3 @@
+# reflex-xpw
+
+> Simple access control for Reflex applications based on xpw

reflex_xpw-0.1/reflex_xpw/__init__.py

@@ -0,0 +1,15 @@
+from .backend import LoginState
+from .backend import LogoutState
+from .frontend import LoginPage
+from .frontend import LogoutPage
+from .frontend import require_login
+from .settings import CONFIG
+
+__all__ = [
+    "CONFIG",
+    "LoginPage",
+    "LogoutPage",
+    "LoginState",
+    "LogoutState",
+    "require_login",
+]

reflex_xpw-0.1/reflex_xpw/attribute.py

@@ -0,0 +1,10 @@
+# coding:utf-8
+
+__project__ = "reflex-xpw"
+__version__ = "0.1"
+__urlhome__ = "https://github.com/bondbox/reflex-xpw/"
+__description__ = "Simple access control for Reflex applications based on xpw"
+
+# author
+__author__ = "Mingzhe Zou"
+__author_email__ = "zoumingzhe@outlook.com"

reflex_xpw-0.1/reflex_xpw/backend.py

@@ -0,0 +1,110 @@
+from datetime import timedelta
+from typing import Any
+from typing import Dict
+from typing import Optional
+
+import reflex as rx
+from xpw import Pass
+from xpw import Profile
+from xpw import SessionUser
+
+from .settings import CONFIG
+
+
+class AuthState(rx.State):
+    K_SESSION_ID = "SESSION_ID"
+    K_SECRET_KEY = "SECRET_KEY"
+
+    session_id: str = rx.Cookie(name=K_SESSION_ID)
+    secret_key: str = rx.Cookie(name=K_SECRET_KEY)
+
+    def activate(self, username: str, password: str) -> Optional[SessionUser]:  # noqa:E501
+        if user := CONFIG.access.login(username, password, self.session_id, self.secret_key):  # noqa:E501
+            self.session_id = user.session_id
+            self.secret_key = user.secret_key
+            return user
+
+        return None
+
+    def deactivate(self) -> bool:
+        if CONFIG.access.logout(session_id=self.session_id, secret_key=self.secret_key):  # noqa:E501
+            self.secret_key = Pass.random_generate(64).value
+            return True
+
+        return False
+
+    @property
+    def identify(self) -> Optional[Profile]:
+        return CONFIG.access.fetch(session_id=self.session_id, secret_key=self.secret_key)  # noqa:E501
+
+    @rx.var(cache=True, interval=timedelta(seconds=180), initial_value=False)
+    def authenticated(self) -> bool:
+        return CONFIG.access.check(session_id=self.session_id, secret_key=self.secret_key)  # noqa:E501
+
+
+class LoginState(AuthState):
+    """Handle login form"""
+
+    error_message: str = ""
+
+    @rx.event
+    def on_submit(self, form_data: Dict[str, Any]):
+        """Handle login form on_submit.
+
+        Args:
+            form_data: A dict of form fields and values.
+        """
+        if isinstance(self.identify, Profile):
+            self.error_message = ""  # pragma: no cover
+            return self.redirect()  # pragma: no cover
+
+        # self.error_message = ""
+        username: str = form_data["username"]
+        password: str = form_data["password"]
+
+        def alert(error_message: str):
+            self.error_message = error_message
+            return rx.set_value("password", "")
+
+        if not username:
+            return alert("The username is empty.")
+
+        if not password:
+            return alert("The password is empty.")
+
+        if self.activate(username, password) is None:
+            return alert("There was a problem logging in, please try again.")
+
+        self.error_message = ""
+        return self.redirect()
+
+    @rx.event
+    def redirect(self):
+        """Redirect to the page if logged in, or to the login page if not."""
+        if not self.is_hydrated:
+            # wait until after hydration to ensure auth_token is known
+            return self.redirect()  # pragma: no cover
+
+        if (active_path := self.router.url.path) == CONFIG.routes.login and self.authenticated:  # noqa:E501
+            source_path: str = self.router.url.query_parameters.get("src", "/")
+            return rx.redirect(source_path)
+
+        if active_path != CONFIG.routes.login and not self.authenticated:
+            return rx.redirect(f"{CONFIG.routes.login}?src={active_path}")
+
+        return None
+
+
+class LogoutState(AuthState):
+
+    @rx.event
+    def on_submit(self):
+        assert self.deactivate()
+
+    @rx.event
+    def on_load(self):
+        if self.router.url.path == CONFIG.routes.logout and self.deactivate():
+            source_path: str = self.router.url.query_parameters.get("src", "/")
+            return rx.redirect(source_path)
+
+        return None

reflex_xpw-0.1/reflex_xpw/frontend.py

@@ -0,0 +1,132 @@
+from functools import wraps
+from typing import Optional
+
+import reflex as rx
+
+from .backend import LoginState
+from .backend import LogoutState
+from .settings import CONFIG
+
+
+def require_login(page: rx.app.ComponentCallable) -> rx.app.ComponentCallable:
+    """Decorator to require authentication before rendering a page.
+
+    If the user is not authenticated, then redirect to the login page.
+
+    Args:
+        page: The page to wrap.
+
+    Returns:
+        The wrapped page component.
+    """
+
+    @wraps(page)
+    def protected_page(*args, **kwargs):
+        return rx.cond(
+            LoginState.is_hydrated & LoginState.authenticated,
+            page(*args, **kwargs),
+            rx.fragment(on_mount=LoginState.redirect),
+        )
+
+    return protected_page
+
+
+class BasePage():  # pylint: disable=too-few-public-methods
+
+    def center(self, *children: rx.Component) -> rx.Component:
+        return rx.center(*children, height="100vh")
+
+
+class LoginPage(BasePage):
+    TITLE: str = "Login"
+
+    class LoginForm():  # pylint: disable=too-few-public-methods
+
+        @classmethod
+        def build(cls) -> rx.Component:
+            return rx.form(
+                rx.vstack(
+                    rx.heading(
+                        "Login",
+                        size="7",
+                        width="100%",
+                        text_align="center",
+                    ),
+                    rx.cond(
+                        LoginState.error_message != "",
+                        rx.callout(
+                            LoginState.error_message,
+                            icon="triangle_alert",
+                            color_scheme="red",
+                            role="alert",
+                            width="100%",
+                        ),
+                    ),
+                    rx.input(
+                        size="3",
+                        width="100%",
+                        id="username",
+                        name="username",
+                        text_align="center",
+                        placeholder="Username",
+                    ),
+                    rx.input(
+                        size="3",
+                        width="100%",
+                        id="password",
+                        name="password",
+                        type="password",
+                        text_align="center",
+                        placeholder="Password",
+                    ),
+                    rx.button(
+                        "Sign in",
+                        size="3",
+                        width="100%",
+                        id="submit",
+                        type="submit",
+                    ),
+                    # rx.center(
+                    #     rx.link(
+                    #         "Register",
+                    #         on_click=RegistrationState.redir,
+                    #     ),
+                    #     width="100%",
+                    # ),
+                    spacing="3",
+                ),
+                on_submit=LoginState.on_submit,
+            )
+
+    def mount(self, app: rx.App, title: Optional[str] = None) -> None:
+        app.add_page(self.build, route=CONFIG.routes.login, title=title or self.TITLE)  # noqa:E501
+
+    def build(self) -> rx.Component:
+        return rx.cond(
+            LoginState.is_hydrated & LoginState.authenticated,
+            rx.fragment(on_mount=LoginState.redirect),
+            self.center(
+                rx.card(
+                    self.LoginForm.build(),
+                    width=["80%", "50%", "20%"],   # mobile / tablet / desktop
+                ),
+            ),
+        )
+
+
+class LogoutPage(BasePage):
+    TITLE: str = "Logout"
+
+    def mount(self, app: rx.App, title: Optional[str] = None) -> None:
+        app.add_page(self.build, route=CONFIG.routes.logout,
+                     title=title or self.TITLE,
+                     on_load=LogoutState.on_load)
+
+    def build(self) -> rx.Component:
+        return self.center(
+            rx.cond(
+                LoginState.is_hydrated & LoginState.authenticated,
+                rx.heading("Unable to log out. Please try again.", id="prompt"),  # noqa:E501
+                rx.heading("Successfully logged out.", id="prompt"),
+            ),
+        )

reflex_xpw-0.1/reflex_xpw/settings.py

@@ -0,0 +1,29 @@
+from dataclasses import dataclass
+from dataclasses import field
+from functools import cached_property
+from typing import Optional
+
+from xkits_config import Settings
+from xpw import Account
+
+
+@dataclass
+class Routes(Settings):
+    login: str = "/login"
+    logout: str = "/logout"
+
+
+@dataclass
+class Configuration(Settings):
+    # Environment Variable Prefix
+    ENVAR_PREFIX = "REFLEX_XPW"
+
+    config: Optional[str] = None
+    routes: Routes = field(default_factory=Routes)
+
+    @cached_property
+    def access(self) -> Account:
+        return Account.from_file(config=self.config)
+
+
+CONFIG: Configuration = Configuration()

reflex_xpw-0.1/reflex_xpw.egg-info/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.1
+Name: reflex-xpw
+Version: 0.1
+Summary: Simple access control for Reflex applications based on xpw
+Home-page: https://github.com/bondbox/reflex-xpw/
+Author: Mingzhe Zou
+Author-email: zoumingzhe@outlook.com
+License: GPLv2
+Project-URL: Source Code, https://github.com/bondbox/reflex-xpw/
+Project-URL: Bug Tracker, https://github.com/bondbox/reflex-xpw/issues
+Project-URL: Documentation, https://github.com/bondbox/reflex-xpw/
+Keywords: command-line,argparse,argcomplete
+Platform: any
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: xkits-config>=0.4
+Requires-Dist: reflex>=0.8.1
+Requires-Dist: xpw>=0.15.1
+
+# reflex-xpw
+
+> Simple access control for Reflex applications based on xpw

reflex_xpw-0.1/reflex_xpw.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE
+README.md
+setup.cfg
+setup.py
+reflex_xpw/__init__.py
+reflex_xpw/attribute.py
+reflex_xpw/backend.py
+reflex_xpw/frontend.py
+reflex_xpw/settings.py
+reflex_xpw.egg-info/PKG-INFO
+reflex_xpw.egg-info/SOURCES.txt
+reflex_xpw.egg-info/dependency_links.txt
+reflex_xpw.egg-info/requires.txt
+reflex_xpw.egg-info/top_level.txt
+reflex_xpw.egg-info/zip-safe
+tests/test_integration.py

reflex_xpw-0.1/reflex_xpw.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

reflex_xpw-0.1/reflex_xpw.egg-info/requires.txt

@@ -0,0 +1,3 @@
+xkits-config>=0.4
+reflex>=0.8.1
+xpw>=0.15.1

reflex_xpw-0.1/reflex_xpw.egg-info/top_level.txt

@@ -0,0 +1 @@
+reflex_xpw

reflex_xpw-0.1/reflex_xpw.egg-info/zip-safe

@@ -0,0 +1 @@
+

reflex_xpw-0.1/setup.cfg

@@ -0,0 +1,20 @@
+[metadata]
+keywords = command-line, argparse, argcomplete
+long_description = file: README.md
+long_description_content_type = text/markdown
+license = GPLv2
+license_files = LICENSE
+platforms = any
+classifiers = 
+	Programming Language :: Python
+	Programming Language :: Python :: 3
+
+[options]
+zip_safe = True
+include_package_data = True
+python_requires = >=3.10
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

reflex_xpw-0.1/setup.py

@@ -0,0 +1,56 @@
+# coding=utf-8
+
+from os.path import dirname
+from os.path import join
+from urllib.parse import urljoin
+
+from setuptools import find_packages
+from setuptools import setup
+from setuptools.command.install import install
+
+from reflex_xpw.attribute import __author__
+from reflex_xpw.attribute import __author_email__
+from reflex_xpw.attribute import __description__
+from reflex_xpw.attribute import __project__
+from reflex_xpw.attribute import __urlhome__
+from reflex_xpw.attribute import __version__
+
+__urlcode__ = __urlhome__
+__urldocs__ = __urlhome__
+__urlbugs__ = urljoin(__urlhome__, "issues")
+
+
+def all_requirements():
+    def read_requirements(path: str):
+        with open(path, "r", encoding="utf-8") as rhdl:
+            return rhdl.read().splitlines()
+
+    path: str = join(dirname(__file__), "requirements.txt")
+    requirements = read_requirements(path)
+    return requirements
+
+
+class CustomInstallCommand(install):
+    """Customized setuptools install command"""
+
+    def run(self):
+        install.run(self)  # Run the standard installation
+        # Execute your custom code after installation
+
+
+setup(
+    name=__project__,
+    version=__version__,
+    description=__description__,
+    url=__urlhome__,
+    author=__author__,
+    author_email=__author_email__,
+    project_urls={"Source Code": __urlcode__,
+                  "Bug Tracker": __urlbugs__,
+                  "Documentation": __urldocs__},
+    packages=find_packages(include=["reflex_xpw*"], exclude=["reflex_xpw.unittest"]),  # noqa:E501
+    install_requires=all_requirements(),
+    cmdclass={
+        "install": CustomInstallCommand,
+    }
+)

reflex_xpw-0.1/tests/test_integration.py

@@ -0,0 +1,174 @@
+# coding:utf-8
+
+import os
+from pathlib import Path
+from unittest import TestCase
+from unittest import main
+from unittest import mock
+from urllib.parse import urljoin
+
+from reflex.testing import AppHarness
+from selenium import webdriver
+from selenium.webdriver.chrome.options import Options
+from selenium.webdriver.common.by import By
+from selenium.webdriver.remote.webdriver import WebDriver
+from selenium.webdriver.support.expected_conditions import \
+    presence_of_element_located
+from selenium.webdriver.support.ui import WebDriverWait
+
+from reflex_xpw.settings import CONFIG
+
+os.environ["APP_HARNESS_HEADLESS"] = "true"
+
+
+class TestApp(TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        cls.harness = AppHarness.create(root=Path(__file__).parent.parent)
+        cls.harness.start()
+
+        assert (frontend_url := cls.harness.frontend_url) is not None
+        cls.logout_url = urljoin(frontend_url, CONFIG.routes.logout)
+        cls.login_url = urljoin(frontend_url, CONFIG.routes.login)
+        cls.index_url = urljoin(frontend_url, "index")
+        cls.frontend_url = frontend_url
+
+        cls.options = Options()
+        cls.options.add_argument("--no-sandbox")
+        cls.options.add_argument("--disable-gpu")
+        cls.options.add_argument("--headless=new")
+        cls.options.add_argument("--disable-dev-shm-usage")
+        cls.options.add_argument("--window-size=1920,1080")
+
+        cls.save_dir = Path(__file__).parent / "screenshots"
+        cls.save_dir.mkdir(parents=True, exist_ok=True)
+
+        cls.username = "demo"
+        cls.password = "test"
+
+    @classmethod
+    def tearDownClass(cls):
+        cls.harness.stop()
+
+    def setUp(self):
+        self.driver = self.harness.frontend(
+            driver_clz=webdriver.Chrome,
+            driver_options=self.options,
+        )
+        self.assertIsInstance(self.driver, WebDriver)
+
+    def tearDown(self):
+        self.driver.quit()
+
+    def save_screenshot(self, filename: str):
+        self.assertTrue(self.driver.save_screenshot(self.save_dir / filename))
+
+    def test_instance(self):
+        self.assertIsNotNone(self.harness.app_instance)
+        self.assertIsNotNone(self.harness.frontend_url)
+        self.assertIsNotNone(self.harness.backend)
+
+    def test_about_page(self):
+        self.driver.get(urljoin(self.frontend_url, "about"))
+        WebDriverWait(self.driver, 10).until(presence_of_element_located((By.ID, "text")))  # noqa:E501
+        self.save_screenshot("about_page.png")
+
+    def test_hello_page(self):
+        self.driver.get(url := urljoin(self.frontend_url, "hello"))
+        WebDriverWait(self.driver, 10).until(lambda d: d.current_url != url)
+        self.assertEqual(self.driver.current_url, f"{self.login_url}?src=/hello")  # noqa:E501
+        self.save_screenshot("hello_page_redirect_to_login.png")
+
+    def test_index_page(self):
+        self.driver.get(url := self.frontend_url)
+        WebDriverWait(self.driver, 10).until(lambda d: d.current_url != url)
+        self.assertEqual(self.driver.current_url, f"{self.login_url}?src=/")  # noqa:E501
+        self.save_screenshot("index_page_redirect_to_login.png")
+
+    def test_login_input_username_is_empty(self):
+        self.driver.get(self.login_url)
+        WebDriverWait(self.driver, 10).until(presence_of_element_located((By.ID, "username"))).clear()  # noqa:E501
+        WebDriverWait(self.driver, 10).until(presence_of_element_located((By.ID, "password"))).send_keys(self.password)  # noqa:E501
+        self.save_screenshot("login_only_input_password.png")
+        WebDriverWait(self.driver, 10).until(presence_of_element_located((By.ID, "submit"))).click()  # noqa:E501
+        self.save_screenshot("login_prompt_username_is_empty.png")
+
+    def test_login_input_password_is_empty(self):
+        self.driver.get(self.login_url)
+        WebDriverWait(self.driver, 10).until(presence_of_element_located((By.ID, "username"))).send_keys(self.username)  # noqa:E501
+        WebDriverWait(self.driver, 10).until(presence_of_element_located((By.ID, "password"))).clear()  # noqa:E501
+        self.save_screenshot("login_only_input_username.png")
+        WebDriverWait(self.driver, 10).until(presence_of_element_located((By.ID, "submit"))).click()  # noqa:E501
+        self.save_screenshot("login_prompt_password_is_empty.png")
+
+    def test_login_and_logout_click_button(self):
+        self.driver.get(url := self.frontend_url)
+        WebDriverWait(self.driver, 10).until(lambda d: d.current_url != url)
+        self.assertEqual(self.driver.current_url, f"{self.login_url}?src=/")
+
+        self.driver.find_element(By.ID, "username").send_keys(self.username)
+        self.driver.find_element(By.ID, "password").send_keys(self.password)
+        self.save_screenshot("login_input.png")
+        self.driver.find_element(By.ID, "submit").click()
+
+        WebDriverWait(self.driver, 10).until(lambda d: d.current_url == url)
+        self.assertEqual(self.driver.current_url, url)
+        self.save_screenshot("login_successful.png")
+
+        WebDriverWait(self.driver, 10).until(presence_of_element_located((By.ID, "logout"))).click()  # noqa:E501
+        WebDriverWait(self.driver, 10).until(lambda d: d.current_url != url)
+        self.assertEqual(self.driver.current_url, f"{self.login_url}?src=/")
+        self.save_screenshot("login_page.png")
+
+    def test_login_and_logout_url(self):
+        self.driver.get(url := self.frontend_url)
+        WebDriverWait(self.driver, 10).until(lambda d: d.current_url != url)
+        self.assertEqual(self.driver.current_url, f"{self.login_url}?src=/")
+
+        self.driver.find_element(By.ID, "username").send_keys(self.username)
+        self.driver.find_element(By.ID, "password").send_keys(self.password)
+        self.driver.find_element(By.ID, "submit").click()
+
+        WebDriverWait(self.driver, 10).until(lambda d: d.current_url == url)
+        self.assertEqual(self.driver.current_url, url)
+
+        self.driver.get(url := urljoin(self.frontend_url, "hello"))
+        WebDriverWait(self.driver, 10).until(presence_of_element_located((By.ID, "text")))  # noqa:E501
+        self.assertEqual(self.driver.current_url, url)
+        self.save_screenshot("hello_page.png")
+
+        self.driver.get(url := self.login_url)
+        WebDriverWait(self.driver, 10).until(lambda d: d.current_url != url)
+        self.assertEqual(self.driver.current_url, self.frontend_url)
+        self.save_screenshot("index_page.png")
+
+        self.driver.get(url := self.logout_url)
+        WebDriverWait(self.driver, 10).until(lambda d: d.current_url != url)
+        self.assertEqual(self.driver.current_url, f"{self.login_url}?src=/")
+
+    @mock.patch.object(CONFIG.access, "logout", mock.MagicMock(return_value=False))  # noqa:E501
+    def test_logout(self):
+        self.driver.get(self.logout_url)
+        WebDriverWait(self.driver, 10).until(presence_of_element_located((By.ID, "prompt")))  # noqa:E501
+        self.assertEqual(self.driver.current_url, self.logout_url)
+        self.save_screenshot("logout_page.png")
+
+    @mock.patch.object(CONFIG.access, "logout", mock.MagicMock(return_value=False))  # noqa:E501
+    def test_logout_error(self):
+        self.driver.get(self.login_url)
+        WebDriverWait(self.driver, 10).until(presence_of_element_located((By.ID, "username"))).send_keys(self.username)  # noqa:E501
+        WebDriverWait(self.driver, 10).until(presence_of_element_located((By.ID, "password"))).send_keys(self.password)  # noqa:E501
+        WebDriverWait(self.driver, 10).until(presence_of_element_located((By.ID, "submit"))).click()  # noqa:E501
+        WebDriverWait(self.driver, 10).until(lambda d: d.current_url != self.login_url)  # noqa:E501
+        self.assertEqual(self.driver.current_url, self.frontend_url)
+        self.save_screenshot("logout_error_logged_in.png")
+
+        self.driver.get(self.logout_url)
+        WebDriverWait(self.driver, 10).until(presence_of_element_located((By.ID, "prompt")))  # noqa:E501
+        self.assertEqual(self.driver.current_url, self.logout_url)
+        self.save_screenshot("logout_error_uable_to_log_out.png")
+
+
+if __name__ == "__main__":
+    main()