Merge pull request #31 from Xpirix/switch_to_payrexx

Xpirix · web-flow · commit 3c7320a01ea6 · 2025-05-09T11:43:49.000+03:00
Fix the payment system for credits top up
diff --git a/.flake8 b/.flake8
@@ -5,4 +5,4 @@ max-line-length = 79
 # E12x continuation line indentation
 # E251 no spaces around keyword / parameter equals
 # E303 too many blank lines (3)
-ignore = E125,E126,E251,E303,W504,W60,F405,E501,E128
+ignore = E125,E126,E251,E303,W504,W60,F405,E501,E128,E111,E114,E121
diff --git a/deployment/.env.example b/deployment/.env.example
@@ -77,4 +77,8 @@ SENTRY_RATE=0.2
 WEB_ENV=prod-ssl
 
 # UWSGI Docker Image
-UWSGI_DOCKER_IMAGE=qgis/qgis-certification-uwsgi:latest
+UWSGI_DOCKER_IMAGE=qgis/qgis-certification-uwsgi:latest
+
+# Payrexx
+PAYREXX_INSTANCE='qgis'
+PAYREXX_API_SECRET='your_payrexx_api_secret'
diff --git a/deployment/docker-compose.yml b/deployment/docker-compose.yml
@@ -66,6 +66,8 @@ services:
       - ADMIN_EMAIL=${ADMIN_EMAIL}
       - SENTRY_DSN=${SENTRY_DSN}
       - SENTRY_RATE=${SENTRY_RATE}
+      - PAYREXX_INSTANCE=${PAYREXX_INSTANCE}
+      - PAYREXX_API_SECRET=${PAYREXX_API_SECRET}
     volumes:
       - static-data:/home/web/static:rw
       - media-data:/home/web/media:rw
diff --git a/django_project/certification/admin.py b/django_project/certification/admin.py
@@ -18,6 +18,7 @@
 from certification.models.checklist import Checklist
 from certification.models.organisation_checklist import OrganisationChecklist
 from certification.models.external_reviewer import ExternalReviewer
+from certification.models.credits_order import CreditsOrder
 
 
 class CertificateAdmin(admin.ModelAdmin):
@@ -195,6 +196,18 @@ class ExternalReviewerAdmin(admin.ModelAdmin):
     )
 
 
+class CreditsOrderAdmin(admin.ModelAdmin):
+    list_display = (
+        'organisation',
+        'credits_requested',
+        'credits_issued',
+        'created_at',
+        'updated_at'
+    )
+    list_filter = ('organisation', 'credits_issued')
+    search_fields = ('organisation__name',)
+
+
 admin.site.register(Certificate, CertificateAdmin)
 admin.site.register(CertificateType, CertificateTypeAdmin)
 admin.site.register(Attendee, AttendeeAdmin)
@@ -210,3 +223,4 @@ class ExternalReviewerAdmin(admin.ModelAdmin):
 admin.site.register(Checklist, ChecklistAdmin)
 admin.site.register(OrganisationChecklist, OrganisationChecklistAdmin)
 admin.site.register(ExternalReviewer, ExternalReviewerAdmin)
+admin.site.register(CreditsOrder, CreditsOrderAdmin)
diff --git a/django_project/certification/api_views/invite_reviewer.py b/django_project/certification/api_views/invite_reviewer.py
@@ -79,7 +79,7 @@ def post(self, request, slug):
                 'session_key': s.session_key
             }
             send_mail(
-                u'Certification - You have been invited as a reviewer',
+                u'QGIS Certification - You have been invited as a reviewer',
                 u'Dear {name},\n\n'
                 u'{invitation_text}'
                 u'\n\n'
diff --git a/django_project/certification/migrations/0029_creditsorder.py b/django_project/certification/migrations/0029_creditsorder.py
@@ -0,0 +1,25 @@
+# Generated by Django 4.2.20 on 2025-05-08 16:09
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('certification', '0028_certifyingorganisation_is_archived_and_more'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='CreditsOrder',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('credits_requested', models.IntegerField(help_text='Number of credits requested in the order')),
+                ('credits_issued', models.BooleanField(default=False, help_text='Flag to indicate if credits have been issued')),
+                ('created_at', models.DateTimeField(auto_now_add=True, help_text='Timestamp when the payment was created')),
+                ('updated_at', models.DateTimeField(auto_now=True, help_text='Timestamp when the payment was last updated')),
+                ('organisation', models.ForeignKey(help_text='The certifying organisation that placed the order', on_delete=django.db.models.deletion.CASCADE, related_name='credits_orders', to='certification.certifyingorganisation')),
+            ],
+        ),
+    ]
diff --git a/django_project/certification/models/__init__.py b/django_project/certification/models/__init__.py
@@ -16,3 +16,4 @@
 from certification.models.checklist import *
 from certification.models.organisation_checklist import *
 from certification.models.external_reviewer import *
+from certification.models.credits_order import *
diff --git a/django_project/certification/models/credits_order.py b/django_project/certification/models/credits_order.py
@@ -0,0 +1,15 @@
+from django.db import models
+from .certifying_organisation import CertifyingOrganisation
+
+
+class CreditsOrder(models.Model):
+  organisation = models.ForeignKey(
+    CertifyingOrganisation,
+    on_delete=models.CASCADE,
+    related_name='credits_orders',
+    help_text="The certifying organisation that placed the order"
+  )
+  credits_requested = models.IntegerField(help_text="Number of credits requested in the order")
+  credits_issued = models.BooleanField(default=False, help_text="Flag to indicate if credits have been issued")
+  created_at = models.DateTimeField(auto_now_add=True, help_text="Timestamp when the payment was created")
+  updated_at = models.DateTimeField(auto_now=True, help_text="Timestamp when the payment was last updated")
diff --git a/django_project/certification/templates/certificate/top_up.html b/django_project/certification/templates/certificate/top_up.html
@@ -48,14 +48,14 @@ <h1 >Top up credits for {{ cert_organisation }}</h1>
                     </div>
                     <div class="column">
                         <button type="submit" class="button is-success is-fullwidth" id="buy" disabled>
-                            PAY WITH STRIPE
+                            PAY WITH PAYREXX
                         </button>
                     </div>
                 </div>
             </div>
         </form>
     </div>
-    {% include "stripe.html" %}
+    {% comment %} {% include "stripe.html" %} {% endcomment %}
 
     <script>
 
@@ -104,7 +104,7 @@ <h1 >Top up credits for {{ cert_organisation }}</h1>
         updateTotal(this)
     });
 
-    $payButton.click(function (e) {
+    {% comment %} $payButton.click(function (e) {
        e.preventDefault();
        let creditAmount = $creditAmount.val();
        if (!creditAmount) {
@@ -118,9 +118,9 @@ <h1 >Top up credits for {{ cert_organisation }}</h1>
            alert('error calculating total payment');
        }
        window.location = `{% url 'checkout' %}?unit=${creditAmount}&total=${totalToPay}&org=${org}`;
-    });
+    }); {% endcomment %}
 
-    function stripeSourceHandler(source) {
+    {% comment %} function stripeSourceHandler(source) {
         // Insert the source ID into the form so it gets submitted to the
         // server
         $('<input>').attr({
@@ -129,7 +129,7 @@ <h1 >Top up credits for {{ cert_organisation }}</h1>
             name: 'stripe-source-id'
         }).appendTo($form).val(source.id);
         $form.submit();
-    }
+    } {% endcomment %}
 
     </script>
 {% endblock %}
diff --git a/django_project/certification/urls.py b/django_project/certification/urls.py
@@ -82,7 +82,9 @@
     ValidateCertificate,
     ValidateCertificateOrganisation,
 
-    TopUpView,
+    # TopUpView,
+    PayrexxTopUpView,
+    PayrexxWebhookView,
 
     CheckoutSessionSuccessView,
     CreateCheckoutSessionView
@@ -253,7 +255,7 @@
         view=update_paid_status,
         name='paid-certificate'),
     url(r'^certifyingorganisation/(?P<organisation_slug>[\w-]+)/top-up/$',
-        view=TopUpView.as_view(),
+        view=PayrexxTopUpView.as_view(),
         name='top-up'),
     url(r'^certificate/(?P<id>[\w-]+)/$',
         view=CertificateDetailView.as_view(),
@@ -332,4 +334,9 @@
     url("^checkout-success/$",
         CheckoutSessionSuccessView.as_view(),
         name="checkout-success"),
+
+    # Payrexx webhook
+    url(r'^payrexx-hook/$',
+        view=PayrexxWebhookView.as_view(),
+        name='payrexx-webhook'),
 ]
diff --git a/django_project/certification/utilities.py b/django_project/certification/utilities.py
@@ -1,6 +1,12 @@
 # coding=utf-8
 """Tools for Certification app."""
+import base64
+import hashlib
+import hmac
+import requests
+from django.conf import settings
 from django.contrib.gis.serializers.geojson import Serializer
+from urllib.parse import urlencode, quote, quote_plus
 
 
 def check_slug(queryset, slug):
@@ -42,3 +48,119 @@ def end_object(self, obj):
                 except AttributeError:
                     pass
         super(CustomSerializer, self).end_object(obj)
+
+
+class PayrexxService:
+    def __init__(self):
+        self.instance_name = settings.PAYREXX_INSTANCE
+        self.api_secret = settings.PAYREXX_API_SECRET
+        self.base_url = "https://api.payrexx.com/v1.0/"
+
+    def generate_signature(self, query_string):
+        signature = hmac.new(self.api_secret.encode('utf-8'), query_string.encode('utf-8'), hashlib.sha256)
+        return base64.b64encode(signature.digest()).decode('utf-8')
+
+    def flatten_dict(self, dictionary, parent_key=''):
+        flattened_data = {}
+        for key, value in dictionary.items():
+            new_key = f"{parent_key}[{key}]" if parent_key else key
+            if isinstance(value, dict):
+                flattened_data.update(self.flatten_dict(value, new_key))
+            elif isinstance(value, list):
+                for i, item in enumerate(value):
+                    if isinstance(item, dict):
+                        flattened_data.update(self.flatten_dict(item, f"{new_key}[{i}]"))
+                    else:
+                        flattened_data[f"{new_key}[{i}]"] = item
+            else:
+                flattened_data[new_key] = value
+        return flattened_data
+
+    def encode_query_string(self, data):
+        encoded_pairs = []
+        for key, value in data.items():
+            encoded_key = quote(key, safe='')
+            if isinstance(value, list):
+                for item in value:
+                    encoded_pairs.append(f"{encoded_key}={quote(str(item), safe='')}")
+            else:
+                encoded_pairs.append(f"{encoded_key}={quote(str(value), safe='')}")
+        return '&'.join(encoded_pairs)
+
+    def prepare_data(self, raw_data):
+        # Flatten the rawData
+        data = self.flatten_dict(raw_data)
+
+        # Create Query String
+        query_string = urlencode(data, quote_via=quote_plus)
+
+        # Generate the API Signature
+        api_signature = self.generate_signature(query_string)
+
+        # Add the API signature to the data payload
+        data['ApiSignature'] = api_signature
+
+        # Generate QueryString for the Request
+        return self.encode_query_string(data)
+
+    def create_gateway(
+            self,
+            reference_id,
+            amount,
+            currency,
+            purpose,
+            redirect_url,
+            firstname: str = '',
+            lastname: str = '',
+            email: str = '',
+            **kwargs
+        ):
+        """Create a payment gateway"""
+        endpoint = "Gateway/"
+        url = f"{self.base_url}{endpoint}?instance={self.instance_name}"
+
+        amount = amount * 100  # Convert to cents
+        raw_data = {
+            'amount': str(amount),
+            'currency': currency,
+            'purpose': purpose,
+            'successRedirectUrl': redirect_url,
+            'fields': {
+                'forename': {'value': firstname},
+                'surname': {'value': lastname},
+                'email': {'value': email}
+            },
+            'referenceId': str(reference_id),
+        }
+
+        # Generate QueryString for the Request
+        request_query_string = self.prepare_data(raw_data)
+
+        # Make the POST request
+        response = requests.post(f"{url}", data=request_query_string)
+        return response.json()
+
+    def get_gateway(self, gateway_id):
+        """Retrieve gateway information"""
+        endpoint = f"Gateway/{gateway_id}/"
+        url = f"{self.base_url}{endpoint}?instance={self.instance_name}"
+        raw_data = {}
+        # Generate QueryString for the Request
+        request_query_string = self.prepare_data(raw_data)
+        # Make the GET request
+        response = requests.get(f"{url}", data=request_query_string)
+        return response.json()
+
+    def get_transaction(self, transaction_id):
+        """Retrieve transaction information"""
+        endpoint = f"Transaction/{transaction_id}/"
+        url = f"{self.base_url}{endpoint}?instance={self.instance_name}"
+        raw_data = {}
+        # Generate QueryString for the Request
+        request_query_string = self.prepare_data(raw_data)
+        # Make the GET request
+        response = requests.get(f"{url}", data=request_query_string)
+        result = response.json()
+        if result.get('status') == 'success':
+            return result['data'][0]
+        raise Exception(f"Error retrieving transaction: {result.get('message', 'Unknown error')}")
diff --git a/django_project/certification/views/__init__.py b/django_project/certification/views/__init__.py
@@ -12,4 +12,5 @@
 from .certificate_organisation import *
 from .certification_management import *
 from .certificate_checlist import *
-from .homepage import *
+from .homepage import *
+from .payrexx import *
diff --git a/django_project/certification/views/certifying_organisation.py b/django_project/certification/views/certifying_organisation.py
@@ -718,7 +718,7 @@ def form_valid(self, form):
                 # Send email notification to project owner and
                 # certification managers
                 send_mail(
-                    u'Projecta - New Pending Organisation Approval',
+                    u'QGIS Certification - New Pending Organisation Approval',
                     u'Dear {recipient_firstname} {recipient_lastname},\n\n'
                     u'You have a new organisation registered to your '
                     u'project: {project_name}.\n'
@@ -758,7 +758,7 @@ def form_valid(self, form):
                 }
 
                 send_mail(
-                    u'Projecta - Your Organisation is Successfully Submitted',
+                    u'QGIS Certification - Your Organisation is Successfully Submitted',
                     u'Dear {applicant_firstname} {applicant_lastname},\n\n'
                     u'Your organisation is successfully submitted.\n'
                     u'It is now waiting for an approval from the project\'s '
@@ -1296,7 +1296,7 @@ def send_rejection_email(certifying_organisation, site, schema='http'):
             'schema': schema
         }
         send_mail(
-            u'Projecta - Your organisation is not approved',
+            u'QGIS Certification - Your organisation is not approved',
             u'Dear {owner_firstname} {owner_lastname},\n\n'
             u'We are sorry that your certifying organisation '
             u'has not been approved. \nThe '
diff --git a/django_project/certification/views/payrexx.py b/django_project/certification/views/payrexx.py
diff --git a/django_project/core/settings/contrib.py b/django_project/core/settings/contrib.py

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ def post(self, request, slug):`
`79`	`79`	`'session_key': s.session_key`
`80`	`80`	`}`
`81`	`81`	`send_mail(`
`82`		`- u'Certification - You have been invited as a reviewer',`
	`82`	`+ u'QGIS Certification - You have been invited as a reviewer',`
`83`	`83`	`u'Dear {name},\n\n'`
`84`	`84`	`u'{invitation_text}'`
`85`	`85`	`u'\n\n'`