django-powcaptcha 0.0.1__tar.gz → 0.0.3__tar.gz

django_powcaptcha-0.0.3/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Jean-Philippe Bidegain
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

django_powcaptcha-0.0.3/MANIFEST.in

@@ -0,0 +1,3 @@
+include LICENSE
+include README.md
+recursive-include django_powcaptcha/templates *

{django-powcaptcha-0.0.1 → django_powcaptcha-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-powcaptcha
-Version: 0.0.1
+Version: 0.0.3
 Summary: Django PowCaptcha form field/widget app.
 Home-page: https://github.com/aeyoll/django-powcaptcha
 Author: Jean-Philippe Bidegain
@@ -24,6 +24,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: django
 
 # Django PowCaptcha
@@ -50,20 +51,19 @@ For example:
 
 ```python
 POWCAPTCHA_API_URL = 'https://captcha.yourdomain.com'
-POWCAPTCHA_API_KEY = 'MyPOWCAPTCHAPrivateKey456'
+POWCAPTCHA_API_TOKEN = 'MyPOWCAPTCHAPrivateKey456'
 ```
 
 ## Usage
 
-### Fields
+### Form
 
 The quickest way to add PowCaptcha to a form is to use the included
-`PowCaptchaField` field class. For example:
+`PowCaptchaForm` class. For example:
 
 ```python
-from django import forms
-from django_powcaptcha.fields import PowCaptchaField
+from django_powcaptcha.forms import PowCaptchaForm
 
-class FormWithCaptcha(forms.Form):
-    captcha = PowCaptchaField()
+class FormWithCaptcha(PowCaptchaForm):
+    ...
 ```

{django-powcaptcha-0.0.1 → django_powcaptcha-0.0.3}/README.md

@@ -22,20 +22,19 @@ For example:
 
 ```python
 POWCAPTCHA_API_URL = 'https://captcha.yourdomain.com'
-POWCAPTCHA_API_KEY = 'MyPOWCAPTCHAPrivateKey456'
+POWCAPTCHA_API_TOKEN = 'MyPOWCAPTCHAPrivateKey456'
 ```
 
 ## Usage
 
-### Fields
+### Form
 
 The quickest way to add PowCaptcha to a form is to use the included
-`PowCaptchaField` field class. For example:
+`PowCaptchaForm` class. For example:
 
 ```python
-from django import forms
-from django_powcaptcha.fields import PowCaptchaField
+from django_powcaptcha.forms import PowCaptchaForm
 
-class FormWithCaptcha(forms.Form):
-    captcha = PowCaptchaField()
+class FormWithCaptcha(PowCaptchaForm):
+    ...
 ```

{django-powcaptcha-0.0.1 → django_powcaptcha-0.0.3}/django_powcaptcha/__init__.py

@@ -4,7 +4,7 @@ from django.core.exceptions import ImproperlyConfigured
 
 SETTINGS_TYPES = {
     'POWCAPTCHA_API_URL': str,
-    'POWCAPTCHA_API_KEY': str,
+    'POWCAPTCHA_API_TOKEN': str,
 }
 
 # Validate settings types.

{django-powcaptcha-0.0.1 → django_powcaptcha-0.0.3}/django_powcaptcha/client.py

@@ -1,3 +1,4 @@
+from django.core.cache import cache
 import json
 from urllib.error import HTTPError
 from urllib.request import Request, build_opener
@@ -14,7 +15,7 @@ def powcaptcha_request(path, params):
     token = getattr(settings, 'POWCAPTCHA_API_TOKEN')
 
     request_object = Request(
-        url=f'https://{domain}/{path}',
+        url=f'{domain}/{path}',
         data=params,
         headers={
             'Authorization': f'Bearer {token}',
@@ -31,13 +32,18 @@ def powcaptcha_request(path, params):
 
 
 def get_challenge():
-    path = 'GetChallenges?difficultyLevel=5'
-    response = powcaptcha_request(path, [])
-    challenges = json.loads(response.read().decode('utf-8'))
+    challenges = cache.get('powcaptcha_challenges')
 
-    # @Todo: implement caching
+    if not challenges or len(challenges) == 0:
+        path = 'GetChallenges?difficultyLevel=5'
+        response = powcaptcha_request(path, [])
+        challenges = json.loads(response.read().decode('utf-8'))
 
-    return challenges[0]
+    challenge = challenges[0]
+    challenges.pop(0)
+    cache.set('powcaptcha_challenges', challenges, 3600)
+
+    return challenge
 
 
 def validate_captcha(challenge: str, nonce: str):

django_powcaptcha-0.0.3/django_powcaptcha/fields.py

@@ -0,0 +1,8 @@
+from django import forms
+
+from django_powcaptcha.widgets import PowCaptchaChallengeWidget
+
+
+class PowCaptchaChallengeField(forms.CharField):
+    required = True
+    widget = PowCaptchaChallengeWidget

django_powcaptcha-0.0.3/django_powcaptcha/forms.py

@@ -0,0 +1,22 @@
+from django import forms
+
+from django_powcaptcha.client import validate_captcha, PowCaptchaValidationException
+from django_powcaptcha.fields import PowCaptchaChallengeField
+
+
+class PowCaptchaForm(forms.Form):
+    powcaptcha_challenge = PowCaptchaChallengeField()
+    powcaptcha_nonce = forms.CharField(widget=forms.HiddenInput(), required=True)
+
+    def clean(self):
+        cleaned_data = super().clean()
+
+        challenge = cleaned_data.get('powcaptcha_challenge', '')
+        nonce = cleaned_data.get('powcaptcha_nonce', '')
+
+        try:
+            validate_captcha(challenge, nonce)
+        except PowCaptchaValidationException:
+            raise forms.ValidationError('Failed to validate captcha')
+
+        return cleaned_data

django_powcaptcha-0.0.3/django_powcaptcha/templates/django_powcaptcha/widget.html

@@ -0,0 +1,29 @@
+<input type="hidden" name="powcaptcha_challenge" value="{{ captcha_challenge }}" />
+
+<div
+    class="captcha-container"
+    data-sqr-captcha-url="{{ captcha_url }}"
+    data-sqr-captcha-challenge="{{ captcha_challenge }}"
+    data-sqr-captcha-callback="myCaptchaCallback">
+</div>
+
+<script src="{{ captcha_url }}/static/captcha.js"></script>
+<script>
+document.addEventListener('DOMContentLoaded', function() {
+    if (typeof window.myCaptchaCallback === 'function') {
+        return;
+    }
+
+    window.myCaptchaCallback = (nonce) => {
+        Array.from(document.querySelectorAll("input[name='powcaptcha_nonce']")).forEach(e => e.value = nonce);
+        Array.from(document.querySelectorAll("input[type='submit']")).forEach(e => e.disabled = false);
+        Array.from(document.querySelectorAll("button[type='submit']")).forEach(e => e.disabled = false);
+    };
+});
+</script>
+
+<style>
+.sqr-captcha-hidden {
+    display: none !important;
+}
+</style>

{django-powcaptcha-0.0.1 → django_powcaptcha-0.0.3}/django_powcaptcha/widgets.py

@@ -4,9 +4,9 @@ from django.forms import widgets
 from django_powcaptcha.client import get_challenge
 
 
-class PowCaptchaWidget(widgets.Widget):
+class PowCaptchaChallengeWidget(widgets.Widget):
     input_type = 'hidden'
-    template_name = 'django_recaptcha/widget.html'
+    template_name = 'django_powcaptcha/widget.html'
 
     def get_context(self, name, value, attrs):
         context = super().get_context(name, value, attrs)
@@ -18,10 +18,3 @@ class PowCaptchaWidget(widgets.Widget):
             }
         )
         return context
-
-    # def build_attrs(self, base_attrs, extra_attrs=None):
-    #     attrs = super().build_attrs(base_attrs, extra_attrs)
-    #     attrs['data-sqr-captcha-url'] = settings.POWCAPTCHA_API_URL
-    #     attrs['data-sqr-captcha-challenge'] = self.get_challenge()
-    #     attrs['data-sqr-captcha-callback'] = 'myCaptchaCallback'
-    #     return attrs

{django-powcaptcha-0.0.1 → django_powcaptcha-0.0.3}/django_powcaptcha.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-powcaptcha
-Version: 0.0.1
+Version: 0.0.3
 Summary: Django PowCaptcha form field/widget app.
 Home-page: https://github.com/aeyoll/django-powcaptcha
 Author: Jean-Philippe Bidegain
@@ -24,6 +24,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: django
 
 # Django PowCaptcha
@@ -50,20 +51,19 @@ For example:
 
 ```python
 POWCAPTCHA_API_URL = 'https://captcha.yourdomain.com'
-POWCAPTCHA_API_KEY = 'MyPOWCAPTCHAPrivateKey456'
+POWCAPTCHA_API_TOKEN = 'MyPOWCAPTCHAPrivateKey456'
 ```
 
 ## Usage
 
-### Fields
+### Form
 
 The quickest way to add PowCaptcha to a form is to use the included
-`PowCaptchaField` field class. For example:
+`PowCaptchaForm` class. For example:
 
 ```python
-from django import forms
-from django_powcaptcha.fields import PowCaptchaField
+from django_powcaptcha.forms import PowCaptchaForm
 
-class FormWithCaptcha(forms.Form):
-    captcha = PowCaptchaField()
+class FormWithCaptcha(PowCaptchaForm):
+    ...
 ```

{django-powcaptcha-0.0.1 → django_powcaptcha-0.0.3}/django_powcaptcha.egg-info/SOURCES.txt

@@ -1,3 +1,5 @@
+LICENSE
+MANIFEST.in
 README.md
 setup.cfg
 setup.py
@@ -5,10 +7,12 @@ django_powcaptcha/__init__.py
 django_powcaptcha/apps.py
 django_powcaptcha/client.py
 django_powcaptcha/fields.py
+django_powcaptcha/forms.py
 django_powcaptcha/widgets.py
 django_powcaptcha.egg-info/PKG-INFO
 django_powcaptcha.egg-info/SOURCES.txt
 django_powcaptcha.egg-info/dependency_links.txt
 django_powcaptcha.egg-info/not-zip-safe
 django_powcaptcha.egg-info/requires.txt
-django_powcaptcha.egg-info/top_level.txt
+django_powcaptcha.egg-info/top_level.txt
+django_powcaptcha/templates/django_powcaptcha/widget.html

{django-powcaptcha-0.0.1 → django_powcaptcha-0.0.3}/setup.py

@@ -4,7 +4,7 @@ long_desc = open("README.md").read()
 
 setup(
     name="django-powcaptcha",
-    version="0.0.1",
+    version="0.0.3",
     description="Django PowCaptcha form field/widget app.",
     long_description=long_desc,
     long_description_content_type="text/markdown",

django-powcaptcha-0.0.1/django_powcaptcha/fields.py

@@ -1,42 +0,0 @@
-import logging
-
-from django import forms
-from django.conf import settings
-from django.core.exceptions import ValidationError
-from django.utils.translation import gettext_lazy as _
-
-from django_powcaptcha import client
-from django_powcaptcha.client import PowCaptchaValidationException
-from django_powcaptcha.widgets import PowCaptchaWidget
-
-logger = logging.getLogger(__name__)
-
-
-class PowCaptchaField(forms.CharField):
-    widget = PowCaptchaWidget
-    default_error_messages = {
-        'captcha_invalid': _('Error verifying reCAPTCHA, please try again.'),
-        'captcha_error': _('Error verifying reCAPTCHA, please try again.'),
-    }
-
-    def __init__(self, api_key=None, api_url=None, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-
-        self.required = True
-
-        # Setup instance variables.
-        self.api_key = api_key or getattr(settings, 'POWCAPTCHA_API_KEY')
-        self.api_url = api_url or getattr(settings, 'POWCAPTCHA_API_URL')
-
-    def validate(self, value):
-        super().validate(value)
-
-        try:
-            client.validate_captcha(
-                challenge='',
-                nonce='',
-            )
-        except PowCaptchaValidationException:
-            raise ValidationError(
-                self.error_messages['captcha_error'], code='captcha_error'
-            )