✨ 0.3

Author: zachlagden

.github/workflows/python-package.yml

@@ -0,0 +1,26 @@
+name: Python package
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository code
+        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 pytest
+          pip install .
+
+      - name: Run tests
+        run: |
+          pytest tests

.gitignore

@@ -159,4 +159,8 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+#.idea/
+
+# Project Specific
+
+private/

MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md
+include LICENSE

README.md

@@ -0,0 +1,90 @@
+# Flask-Obfuscate
+
+Flask-Obfuscate is a Flask extension that obfuscates HTML responses to help protect your HTML content from easy inspection or copying. This extension processes all HTML responses and converts them into obfuscated JavaScript that writes the HTML content when executed in a browser.
+
+## Features
+
+- Obfuscates HTML responses by converting them to JavaScript
+- Easy to integrate into existing Flask applications
+- Simple usage with minimal configuration
+
+## Installation
+
+You can install Flask-Obfuscate via pip:
+
+```sh
+pip install Flask-Obfuscate
+```
+
+## Usage
+
+### Basic Usage
+
+Integrate Flask-Obfuscate into your Flask application with minimal setup:
+
+```python
+from flask import Flask
+from flask_obfuscate import Obfuscate
+
+app = Flask(__name__)
+obfuscate = Obfuscate(app)
+
+@app.route('/')
+def index():
+    return '<div>Hello, World!</div>'
+
+if __name__ == '__main__':
+    app.run(debug=True)
+```
+
+### Advanced Usage
+
+You can also initialize Flask-Obfuscate later using the `init_app` method:
+
+```python
+from flask import Flask
+from flask_obfuscate import Obfuscate
+
+app = Flask(__name__)
+obfuscate = Obfuscate()
+obfuscate.init_app(app)
+
+@app.route('/')
+def index():
+    return '<div>Hello, World!</div>'
+
+if __name__ == '__main__':
+    app.run(debug=True)
+```
+
+## Running Tests
+
+To run the tests, first install the test dependencies:
+
+```sh
+pip install pytest
+```
+
+Then you can run the tests using pytest:
+
+```sh
+pytest tests
+```
+
+## Contributing
+
+Contributions are welcome! Please submit a pull request or open an issue to discuss improvements or fixes.
+
+1. Fork the repository.
+2. Create a new branch: `git checkout -b my-feature-branch`
+3. Make your changes and commit them: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-feature-branch`
+5. Submit a pull request.
+
+## License
+
+This project is licensed under the MIT License.
+
+## Acknowledgments
+
+Inspired by the need to protect HTML content in Flask applications.

flask_obfuscate/obfuscate.py

@@ -50,8 +50,15 @@ def obfuscate_response(response: Response) -> Response:
             Returns:
                 Response: The modified response with obfuscated HTML content.
             """
-            if response.content_type == "text/html; charset=utf-8":
+
+            # Check if the response is an HTML document and contains content
+
+            if (
+                response.content_type == "text/html; charset=utf-8"
+                and response.get_data(as_text=True).strip()
+            ):
                 response.set_data(self.obfuscate_html(response.get_data(as_text=True)))
+
             return response
 
     def obfuscate_html(self, html_str: str) -> str:

setup.py

@@ -1,8 +1,11 @@
 from setuptools import setup, find_packages
 
+with open("README.md", "r") as f:
+    long_description = f.read()
+
 setup(
     name="Flask-Obfuscate",
-    version="0.1",
+    version="0.3",
     packages=find_packages(),
     include_package_data=True,
     install_requires=[
@@ -11,7 +14,7 @@
     author="Zachariah Michael Lagden",
     author_email="zach@zachlagden.uk",
     description="A Flask extension to obfuscate HTML responses.",
-    long_description=open("README.md").read(),
+    long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/Lagden-Development/flask-obfuscate",
     classifiers=[

tests/__init__.py

@@ -0,0 +1,88 @@
+import pytest
+from flask import Flask, Blueprint
+from flask_obfuscate import Obfuscate
+
+
+@pytest.fixture
+def app():
+    app = Flask(__name__)
+    obfuscate = Obfuscate(app)
+    return app
+
+
+def test_obfuscate(app):
+    @app.route("/")
+    def index():
+        return "<div>Hello, World!</div>"
+
+    with app.test_client() as client:
+        response = client.get("/")
+        assert response.status_code == 200
+        assert "document.write(unescape" in response.get_data(as_text=True)
+        assert "<div>Hello, World!</div>" not in response.get_data(as_text=True)
+
+
+def test_non_html_response(app):
+    @app.route("/json")
+    def json_route():
+        return {"message": "Hello, World!"}
+
+    with app.test_client() as client:
+        response = client.get("/json")
+        assert response.status_code == 200
+        assert response.is_json
+        assert response.get_json() == {"message": "Hello, World!"}
+
+
+def test_large_html_document(app):
+    @app.route("/large")
+    def large_route():
+        large_html = "<div>" + "Hello, World! " * 1000 + "</div>"
+        return large_html
+
+    with app.test_client() as client:
+        response = client.get("/large")
+        assert response.status_code == 200
+        assert "document.write(unescape" in response.get_data(as_text=True)
+        assert "Hello, World!" not in response.get_data(as_text=True)
+
+
+def test_special_characters(app):
+    @app.route("/special")
+    def special_route():
+        return "<div>Special characters: <>&'\"</div>"
+
+    with app.test_client() as client:
+        response = client.get("/special")
+        assert response.status_code == 200
+        assert "document.write(unescape" in response.get_data(as_text=True)
+        assert "<div>Special characters: <>&'\"</div>" not in response.get_data(
+            as_text=True
+        )
+
+
+def test_empty_html(app):
+    @app.route("/empty")
+    def empty_route():
+        return ""
+
+    with app.test_client() as client:
+        response = client.get("/empty")
+        assert response.status_code == 200
+        assert response.get_data(as_text=True) == ""
+
+
+def test_blueprint_integration(app):
+    bp = Blueprint("bp", __name__)
+
+    @bp.route("/bp")
+    def bp_route():
+        return "<div>Blueprint route</div>"
+
+    app.register_blueprint(bp, url_prefix="/bp")
+
+    with app.test_client() as client:
+        response = client.get("/bp/bp")
+        assert response.status_code == 200
+        assert "document.write(unescape" in response.get_data(as_text=True)
+        assert "<div>Blueprint route</div>" not in response.get_data(as_text=True)