Merge pull request #849 from MasoniteFramework/4.0

v4 to v5

Author: josephmancuso

README.md

@@ -3,7 +3,7 @@
   <h1 align="center">Masonite</h1>
 </p>
 <p align="center">
-  <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/MasoniteFramework/masonite/pythonapp.yml?branch=develop">
+  <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/MasoniteFramework/masonite/pythonapp.yml">
 
   <img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/MasoniteFramework/masonite?include_prereleases">
   <img src="https://img.shields.io/github/license/MasoniteFramework/masonite.svg" alt="License">

requirements.txt

@@ -13,7 +13,7 @@ jinja2<3.2
 masonite-orm>=2,<3
 pendulum>=2,<3
 pwnedapi
-vonage
+vonage>=3,<4
 pytest
 python-dotenv>=0.15,<0.16
 responses
@@ -23,4 +23,4 @@ werkzeug>=2,<3; python_version < '3.8'
 werkzeug>=3,<4; python_version >= '3.8'
 watchdog>=2,<3
 whitenoise>=5.2,<5.3
-pyjwt>=2.4,<2.5
+pyjwt>=2.4,<2.5

setup.py

@@ -60,6 +60,7 @@
         "watchdog>=2<3",
         "multipart>=0.2,<0.3",
         "watchdog>=2,<=4",
+        "phonenumbers>=8.12,<9",
     ],
     # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
     classifiers=[

src/masonite/__init__.py

@@ -1 +1 @@
-__version__ = "4.20.1"
+__version__ = "4.20.3"

src/masonite/authorization/Gate.py

@@ -101,6 +101,7 @@ def inspect(self, permission, *args):
         if boolean_result:
             return AuthorizationResponse.allow()
         else:
+            self.application.make("response").status(403)
             return AuthorizationResponse.deny()
 
     def check(self, permission, *args):

src/masonite/dumps/Dumper.py

@@ -16,11 +16,13 @@ def clear(self):
 
     def dd(self, *objects):
         """Dump all provided args and die, raising a DumpException."""
+        self.app.make('response').status(200)
         self._dump(*objects)
         raise DumpException()
 
     def dump(self, *objects):
         """Dump all provided args and continue code execution. This does not raise a DumpException."""
+        self.app.make('response').status(200)
         dumps = self._dump(*objects)
         # output dumps in console
         for dump in dumps:

src/masonite/exceptions/handlers/ModelNotFoundHandler.py

@@ -9,4 +9,5 @@ def handle(self, exception):
         masonite_exception = ModelNotFoundException(
             "No record found with the given primary key"
         )
+        self.application.make("response").status(404)
         self.application.make("exception_handler").handle(masonite_exception)

src/masonite/middleware/route/SessionMiddleware.py

@@ -21,6 +21,8 @@ def before(self, request, response):
         # actually clears them out of the session
         errors = Session.get("errors")
         request.app.make("view").share({"errors": MessageBag(errors or {}).helper})
+        # TODO: remove this in Masonite 5
+        request.app.make("view").share({"bag": MessageBag(errors or {}).helper})
         # if any errors then re-add them to the session
         if errors:
             Session.flash("errors", errors)

src/masonite/notification/Notifiable.py

@@ -6,24 +6,28 @@
 
 
 class Notifiable:
-    """Notifiable mixin allowing to send notification to a model. It's often used with the
+    """Notifiable mixin allowing to send
+    notification to a model. It's often used with the
     User model.
 
     Usage:
         user.notify(WelcomeNotification())
     """
-
     def notify(self, notification, drivers=[], dry=False, fail_silently=False):
         """Send the given notification."""
         from wsgi import application
 
+        if hasattr(notification, "send"):
+            notification.send(notification, drivers, dry, fail_silently)
+
         return application.make("notification").send(
             self, notification, drivers, dry, fail_silently
         )
 
     def route_notification_for(self, driver):
-        """Get the notification routing information for the given driver. If method has not been
-        defined on the model: for mail driver try to use 'email' field of model."""
+        """Get the notification routing information for the given driver.
+        If method has not been defined on the model:
+        for mail driver try to use 'email' field of model."""
         # check if routing has been specified on the model
         method_name = "route_notification_for_{0}".format(driver)
 
@@ -39,7 +43,8 @@ def route_notification_for(self, driver):
                 return self.email
             else:
                 raise NotificationException(
-                    "Notifiable model does not implement {}".format(method_name)
+                    "Notifiable model "
+                    "does not implement {}".format(method_name)
                 )
 
     @has_many("id", "notifiable_id")

src/masonite/notification/drivers/vonage/VonageDriver.py

@@ -40,7 +40,11 @@ def send(self, notifiable, notification):
         sms = self.build(notifiable, notification)
         client = self.get_sms_client()
         recipients = sms._to
+        if not isinstance(recipients, list):
+            recipients = [recipients]
         for recipient in recipients:
+            if not self.is_valid_phone_number(recipient):
+                raise NotificationException(f"Invalid phone number: {recipient}")
             payload = sms.to(recipient).build().get_options()
             response = client.send_message(payload)
             self._handle_errors(response)
@@ -67,3 +71,11 @@ def _handle_errors(self, response):
                         status, message["error-text"]
                     )
                 )
+
+    def is_valid_phone_number(self, phone_number):
+        import phonenumbers
+        try:
+            parsed_number = phonenumbers.parse(phone_number, None)
+            return phonenumbers.is_valid_number(parsed_number)
+        except phonenumbers.NumberParseException:
+            return False

src/masonite/providers/RouteProvider.py

@@ -56,6 +56,8 @@ def boot(self):
                     else:
                         response.view(data)
                 except Exception as e:
+                    if not response.get_status_code():
+                        response.status(500)
                     exception = e
 
                 self.application.make("middleware").run_route_middleware(

src/masonite/queues/Queueable.py

@@ -7,6 +7,9 @@ class Queueable:
     run_again_on_fail = True
     run_times = 3
 
+    def queue(self):
+        return "default"
+
     def handle(self):
         pass
 
@@ -15,3 +18,8 @@ def failed(self, obj, e):
 
     def __repr__(self):
         return self.__class__.__name__
+
+    def send(self, notification, driver="", dry=False, fail_silently=False):
+        from ..facades.Queue import Queue
+        Queue.push(notification, queue=self.queue())
+        print('Sending to queue', notification)

src/masonite/rates/RateLimiter.py

@@ -46,8 +46,8 @@ def too_many_attempts(self, key: str, max_attempts: int) -> bool:
         key = self.clean_key(key)
         if self.attempts(key) >= max_attempts:
             # trigger remove of cache value if needed
-            self.cache.get(f"{key}:timer")
-            if self.cache.has(f"{key}:timer"):
+            self.cache.get(f"{key}-timer")
+            if self.cache.has(f"{key}-timer"):
                 return True
             self.reset_attempts(key)
         return False
@@ -56,7 +56,7 @@ def hit(self, key: str, delay: int) -> int:
         key = self.clean_key(key)
         # store timestamp when key limit be available again
         available_at = pendulum.now().add(seconds=delay).int_timestamp
-        self.cache.add(f"{key}:timer", available_at, delay)
+        self.cache.add(f"{key}-timer", available_at, delay)
         # ensure key exists
         self.cache.add(key, 0, delay)
         hits = self.cache.increment(key)
@@ -69,12 +69,12 @@ def reset_attempts(self, key: str) -> bool:
     def clear(self, key: str):
         key = self.clean_key(key)
         self.cache.forget(key)
-        self.cache.forget(f"{key}:timer")
+        self.cache.forget(f"{key}-timer")
 
     def available_at(self, key: str) -> int:
         """Get UNIX integer timestamp at which key will be available again."""
         key = self.clean_key(key)
-        timestamp = int(self.cache.get(f"{key}:timer", 0))
+        timestamp = int(self.cache.get(f"{key}-timer", 0))
         return timestamp
 
     def available_in(self, key: str) -> int:

src/masonite/response/response.py

@@ -4,6 +4,7 @@
 import mimetypes
 from pathlib import Path
 from typing import TYPE_CHECKING, Any
+import types
 
 if TYPE_CHECKING:
     from ..foundation import Application
@@ -119,6 +120,8 @@ def data(self) -> bytes:
         """Get the response content as bytes."""
         if isinstance(self.content, str):
             return bytes(self.content, "utf-8")
+        if isinstance(self.content, types.GeneratorType):
+            return b"".join(self.content)
 
         return self.content
 
@@ -137,6 +140,10 @@ def view(self, view: Any, status: int = 200) -> "bytes|Response":
             view, status = view
             self.status(status)
 
+        if isinstance(view, types.GeneratorType):
+            self.status(status)
+            return self
+
         if not self.get_status_code():
             self.status(status)
 
@@ -218,3 +225,28 @@ def download(self, name: str, location: str, force: bool = False) -> "Response":
             data = filelike.read()
 
         return self.view(data)
+
+    def stream(self, name: str, location: str, force: bool = True, chunk_size: int = 8192) -> "Response":
+        """Set the response as a file download response using streaming."""
+        self.status(200)
+
+        # Set content type and disposition headers
+        self.header_bag.add(Header("Content-Type", "application/octet-stream"))
+        self.header_bag.add(Header("Content-Disposition", f'attachment; filename="{name}{Path(location).suffix}"'))
+
+        # Get the file size and set the Content-Length header
+        file_size = Path(location).stat().st_size
+        self.header_bag.add(Header("Content-Length", str(file_size)))
+
+        # Define the generator to stream the file in chunks
+        def file_generator():
+            with open(location, "rb") as file:
+                while True:
+                    chunk = file.read(chunk_size)
+                    if not chunk:
+                        break
+                    yield chunk
+
+        # Set the response content as the file generator and return
+        self.content = file_generator()
+        return self

src/masonite/stubs/templates/auth/login.html

@@ -58,15 +58,15 @@ <h2 class="text-center font-semibold text-3xl lg:text-4xl text-gray-800">
 
                 <!-- Another Auth Routes -->
                 <div class="sm:flex sm:flex-wrap mt-8 sm:mb-4 text-sm text-center">
-                    <a href="password_reset" class="flex-2 underline">
+                    <a href="{{ route('password_reset') }}" class="flex-2 underline">
                         Forgot password?
                     </a>
 
                     <p class="flex-1 text-gray-500 text-md mx-4 my-1 sm:my-auto">
                         or
                     </p>
 
-                    <a href="register" class="flex-2 underline">
+                    <a href="{{ route('register') }}" class="flex-2 underline">
                         Create an Account
                     </a>
                 </div>

src/masonite/utils/str.py

@@ -1,4 +1,5 @@
 """String generators and helpers"""
+
 import random
 import string
 from urllib import parse
@@ -80,7 +81,9 @@ def add_query_params(url: str, query_params: dict) -> str:
     """Add query params dict to a given url (which can already contain some query parameters)."""
     path_result = parse.urlsplit(url)
 
-    base_url = f"{path_result.scheme}://{path_result.hostname}" if path_result.hostname else ""
+    base_url = (
+        f"{path_result.scheme}://{path_result.hostname}" if path_result.hostname else ""
+    )
     base_path = path_result.path
 
     # parse existing query parameters if any
@@ -91,7 +94,13 @@ def add_query_params(url: str, query_params: dict) -> str:
     if all_query_params:
         base_path += "?" + parse.urlencode(all_query_params)
 
-    return f"{base_url}{base_path}"
+    result_url = f"{base_url}{base_path}"
+
+    # add fragment if exists
+    if path_result.fragment:
+        result_url = f"{result_url}#{path_result.fragment}"
+
+    return result_url
 
 
 def get_controller_name(controller: "str|Any") -> str:

tests/core/response/test_response.py

@@ -15,3 +15,9 @@ def test_encoding_chinese_characters(self):
         response = Response(self.application)
         content = response.json({"test": "我"})
         self.assertEqual(content.decode("utf-8"), '{"test": "我"}')
+
+    def test_redirect_external(self):
+        response = Response(self.application)
+        response = response.redirect("https://google.com")
+        self.assertEqual(response._status, "302 Found")
+        self.assertEqual(response.header_bag.get("Location").value, "https://google.com")

tests/core/utils/test_str.py

@@ -5,6 +5,7 @@
     removeprefix,
     removesuffix,
     get_controller_name,
+    add_query_params,
 )
 
 from tests.integrations.controllers.api.TestController import TestController
@@ -35,3 +36,39 @@ def test_get_controller_name(self):
         )
         controller = TestController()
         self.assertEqual(get_controller_name(controller), "TestController@__call__")
+
+    def test_add_query_params_not_break_urls(self):
+        test_urls = [
+            "https://example.com/c/pay/cs_teAIXs#fid2cGd2ZndsdXFsamtQa2x0cGBrYHZ2QGtkZ2lgYSc%2FY2RpdmApJ2R1bE5gfCc%2FJ3VuWnFgdnFac2FiQF9fbWppSTxkc01tcWRTMzA9fVdgNTVHfXJWcGhUPCcpJ2N3amhWYHdzYHcnP3F3cGApJ2lkfGpwcVF8dWAnPyd2bGtiaWBabHFgaCcpJ2BrZGdpYFVpZGZgbWppYWB3dic%2FcXdwYHgl",
+            "https://example.com?a=b",
+            "https://example.com/",
+        ]
+
+        for url in test_urls:
+            self.assertEqual(url, add_query_params(url, {}))
+
+    def test_add_query_params_add_params(self):
+        test_urls = [
+            {
+                "input": "https://example.com/c/pay/cs_teAIXs#fidx22wwe",
+                "result": "https://example.com/c/pay/cs_teAIXs?test_param=1&test_param_2=2#fidx22wwe",
+            },
+            {
+                "input": "https://example.com?a=b&",
+                "result": "https://example.com?a=b&test_param=1&test_param_2=2",
+            },
+            {
+                "input": "https://example.com",
+                "result": "https://example.com?test_param=1&test_param_2=2",
+            },
+            {
+                "input": "https://example.com/",
+                "result": "https://example.com/?test_param=1&test_param_2=2",
+            },
+        ]
+
+        for url in test_urls:
+            self.assertEqual(
+                url["result"],
+                add_query_params(url["input"], {"test_param": 1, "test_param_2": 2}),
+            )

tests/features/rates/test_rate_limiter.py

@@ -24,9 +24,9 @@ def test_attempt(self):
     def test_clear_remove_cache_keys(self):
         RateLimiter.attempt("test_key", my_function, 2)
         assert Cache.store().has("test_key")
-        assert Cache.store().has("test_key:timer")
+        assert Cache.store().has("test_key-timer")
         RateLimiter.clear("test_key")
-        assert not Cache.store().has("test_key:timer")
+        assert not Cache.store().has("test_key-timer")
         assert not Cache.store().has("test_key")
 
     def test_reset_attempts(self):
@@ -50,7 +50,7 @@ def test_hit(self):
         should_be_available_at = now.add(seconds=40)
         RateLimiter.hit("test_key", 40)
         assert Cache.store().get("test_key") == "1"
-        assert Cache.store().get("test_key:timer") == str(
+        assert Cache.store().get("test_key-timer") == str(
             should_be_available_at.int_timestamp
         )