Merge pull request #8928 from fossasia/development

Merge dev into master

Author: mariobehling

.pre-commit-config.yaml

@@ -1,4 +1,6 @@
 exclude: '.venv|migrations'
+default_language_version:
+  python: python3.8
 repos:
   - repo: https://github.com/asottile/pyupgrade
     rev: v2.12.0
@@ -11,11 +13,11 @@ repos:
       - id: pycln
         args: [--config=pyproject.toml]
   - repo: https://github.com/pycqa/isort
-    rev: 5.8.0
+    rev: 5.12.0
     hooks:
       - id: isort
   - repo: https://github.com/psf/black
-    rev: 20.8b1
+    rev: 22.3.0
     hooks:
     - id: black
       language_version: python3.8

README.md

@@ -152,6 +152,52 @@ Read more [here](/docs/general/roles.md).
 
 ## Development
 
+### Initial setup
+
+#### Python and Poetry installatioon
+
+We use Python 3.8. If your operating system does not provide Python 3.8 out of the
+box, it is best installed using [`pyenv`](https://github.com/pyenv/pyenv/).
+
+For Mac users, see [here](https://opensource.com/article/19/5/python-3-default-mac) for more info.
+```bash
+$ brew install pyenv
+$ pyenv init # follow instructions to add run commands to your environment
+```
+After editing your environment file, reload your shell and navigate to this repo, then install `3.8.17` to be used locally:
+```bash
+$ pyenv install 3.8.17
+$ cd ...your../open-event-server/
+$ pyenv local 3.8.17
+```
+Now the Python version should automatically change when used within open-event-server.
+
+
+We also expect [poetry](https://python-poetry.org/) being available.
+
+#### Package setup
+
+Change into the `open-event-server` directory, and execute the following commands:
+
+Activate Python 3.8.17 locally
+```bash
+$ pyenv local 3.8.17
+```
+
+Install dependencies using poetry
+```bash
+$ poetry install --with dev
+```
+
+Activate the pre-commit hook
+```bash
+$ poetry run pre-commit install
+```
+
+With that every git commit will be checked/formatted with various tools before
+being actually committed. 
+
+
 ### Development Mode
 
 To enable development mode (development Flask config), set `APP_CONFIG` environment variable to "config.DevelopmentConfig".

app/api/access_codes.py

@@ -59,7 +59,7 @@ def before_create_object(self, data, view_kwargs):
                 except NoResultFound:
                     raise ConflictError(
                         {'pointer': '/data/relationships/tickets'},
-                        "Ticket with id {} does not exists".format(str(ticket)),
+                        f"Ticket with id {str(ticket)} does not exists",
                     )
 
     schema = AccessCodeSchema

app/api/attendees.py

@@ -225,9 +225,7 @@ def before_update_object(self, obj, data, kwargs):
                 'Only admin or that user itself can update attendee info',
             )
 
-        if order.status != 'initializing' and (
-            'checkin_times' not in data
-        ):
+        if order.status != 'initializing' and ('checkin_times' not in data):
             raise UnprocessableEntityError(
                 {'pointer': '/data/id'},
                 "Attendee can't be updated because the corresponding order is not in initializing state",

app/api/chat/rocket_chat.py

@@ -2,6 +2,7 @@
 import random
 import string
 from dataclasses import dataclass
+from typing import Optional
 
 import requests
 
@@ -10,7 +11,6 @@
 from app.models.event import Event
 from app.models.user import User
 from app.settings import get_settings
-from typing import Optional
 
 logger = logging.getLogger(__name__)
 

app/api/custom/invoices.py

@@ -34,9 +34,7 @@ def event_invoices(invoice_identifier):
         raise ForbiddenError({'source': ''}, 'Unauthorized Access')
     key = UPLOAD_PATHS['pdf']['event_invoices'].format(identifier=invoice_identifier)
     file_path = (
-        '../generated/invoices/{}/{}/'.format(key, generate_hash(key))
-        + invoice_identifier
-        + '.pdf'
+        f'../generated/invoices/{key}/{generate_hash(key)}/{invoice_identifier}.pdf'
     )
     try:
         return return_file('event-invoice', file_path, invoice_identifier)
@@ -56,14 +54,11 @@ def order_invoices(order_identifier):
             order = Order.query.filter_by(identifier=order_identifier).first()
         except NoResultFound:
             raise NotFoundError({'source': ''}, 'Order Invoice not found')
-        if (
-            has_access(
-                'is_coorganizer_or_user_itself',
-                event_id=order.event_id,
-                user_id=order.user_id,
-            )
-            or order.is_attendee(current_user)
-        ):
+        if has_access(
+            'is_coorganizer_or_user_itself',
+            event_id=order.event_id,
+            user_id=order.user_id,
+        ) or order.is_attendee(current_user):
             file_path = order.invoice_pdf_path
             if not os.path.isfile(file_path):
                 create_pdf_tickets_for_holder(order)

app/api/custom/orders.py

@@ -1,8 +1,6 @@
 import os
-
 from datetime import datetime
 
-
 from flask import Blueprint, jsonify, make_response, request
 from flask.helpers import send_from_directory
 from flask_jwt_extended import current_user, jwt_required
@@ -12,18 +10,20 @@
 from app.api.helpers.db import safe_query, save_to_db
 from app.api.helpers.errors import ForbiddenError, NotFoundError, UnprocessableEntityError
 from app.api.helpers.mail import send_email_to_attendees
-from app.api.helpers.order import calculate_order_amount, create_pdf_tickets_for_holder, on_order_completed
+from app.api.helpers.order import (
+    calculate_order_amount,
+    create_pdf_tickets_for_holder,
+    on_order_completed,
+)
+from app.api.helpers.payment import StripePaymentsManager
 from app.api.helpers.permission_manager import has_access
 from app.api.orders import validate_attendees
 from app.api.schema.orders import OrderSchema
 from app.extensions.limiter import limiter
 from app.models import db
-from app.models.order import Order
-from app.models.order import OrderTicket
+from app.models.order import Order, OrderTicket
 from app.models.ticket import Ticket
 from app.models.ticket_holder import TicketHolder
-from app.api.helpers.payment import StripePaymentsManager
-
 
 order_blueprint = Blueprint('order_blueprint', __name__, url_prefix='/v1/orders')
 ticket_blueprint = Blueprint('ticket_blueprint', __name__, url_prefix='/v1/tickets')
@@ -40,14 +40,11 @@ def ticket_attendee_authorized(order_identifier):
             raise NotFoundError(
                 {'source': ''}, 'This ticket is not associated with any order'
             )
-        if (
-            has_access(
-                'is_coorganizer_or_user_itself',
-                event_id=order.event_id,
-                user_id=order.user_id,
-            )
-            or order.is_attendee(current_user)
-        ):
+        if has_access(
+            'is_coorganizer_or_user_itself',
+            event_id=order.event_id,
+            user_id=order.user_id,
+        ) or order.is_attendee(current_user):
             file_path = order.ticket_pdf_path
             if not os.path.isfile(file_path):
                 create_pdf_tickets_for_holder(order)
@@ -155,7 +152,7 @@ def create_order():
         ticket_info = ticket_map[order_ticket.ticket.id]
         order_ticket.price = ticket_info.get('price')
         save_to_db(order_ticket)
-    
+
     return OrderSchema().dump(order)
 
 
@@ -184,30 +181,47 @@ def ticket_attendee_pdf(attendee_id):
         create_pdf_tickets_for_holder(ticket_holder.order)
     return send_from_directory('../', file_path, as_attachment=True)
 
+
 @order_blueprint.route('/<string:order_identifier>/verify', methods=['POST'])
 def verify_order_payment(order_identifier):
 
     order = Order.query.filter_by(identifier=order_identifier).first()
-    
+
     if order.payment_mode == 'stripe':
         try:
-            payment_intent = StripePaymentsManager.retrieve_payment_intent(order.event, order.stripe_payment_intent_id)
+            payment_intent = StripePaymentsManager.retrieve_payment_intent(
+                order.event, order.stripe_payment_intent_id
+            )
         except Exception as e:
             raise e
 
         if payment_intent['status'] == 'succeeded':
             order.status = 'completed'
             order.completed_at = datetime.utcnow()
-            order.paid_via = payment_intent['charges']['data'][0]['payment_method_details']['type']
-            order.transaction_id = payment_intent['charges']['data'][0]['balance_transaction']
-            if payment_intent['charges']['data'][0]['payment_method_details']['type'] == 'card' :
-                order.brand = payment_intent['charges']['data'][0]['payment_method_details']['card']['brand']
-                order.exp_month = payment_intent['charges']['data'][0]['payment_method_details']['card']['exp_month']
-                order.exp_year = payment_intent['charges']['data'][0]['payment_method_details']['card']['exp_year']
-                order.last4 = payment_intent['charges']['data'][0]['payment_method_details']['card']['last4']
+            order.paid_via = payment_intent['charges']['data'][0][
+                'payment_method_details'
+            ]['type']
+            order.transaction_id = payment_intent['charges']['data'][0][
+                'balance_transaction'
+            ]
+            if (
+                payment_intent['charges']['data'][0]['payment_method_details']['type']
+                == 'card'
+            ):
+                order.brand = payment_intent['charges']['data'][0][
+                    'payment_method_details'
+                ]['card']['brand']
+                order.exp_month = payment_intent['charges']['data'][0][
+                    'payment_method_details'
+                ]['card']['exp_month']
+                order.exp_year = payment_intent['charges']['data'][0][
+                    'payment_method_details'
+                ]['card']['exp_year']
+                order.last4 = payment_intent['charges']['data'][0][
+                    'payment_method_details'
+                ]['card']['last4']
             save_to_db(order)
 
             on_order_completed(order)
 
-
-    return jsonify({ 'payment_status': order.status})
+    return jsonify({'payment_status': order.status})

app/api/event_invoices.py

@@ -76,9 +76,7 @@ def before_get_object(self, view_kwargs):
         if not current_user.is_staff and event_invoice.user_id != current_user.id:
             raise ForbiddenError({'source': ''}, 'Admin access is required')
 
-    methods = [
-        'GET','PATCH'
-    ]
+    methods = ['GET', 'PATCH']
     decorators = (jwt_required,)
     schema = EventInvoiceSchema
     data_layer = {

app/api/groups.py

@@ -1,9 +1,6 @@
-from app.models.role import Role
-from app.models.user import User
 from flask import request
 from flask_jwt_extended import current_user
 from flask_rest_jsonapi import ResourceDetail, ResourceList, ResourceRelationship
-from flask_rest_jsonapi.exceptions import ObjectNotFound
 
 from app.api.bootstrap import api
 from app.api.helpers.db import safe_query_kwargs
@@ -16,6 +13,8 @@
 from app.models import db
 from app.models.event import Event
 from app.models.group import Group
+from app.models.role import Role
+from app.models.user import User
 from app.models.user_follow_group import UserFollowGroup
 from app.models.users_groups_role import UsersGroupsRoles
 

app/api/helpers/calendar/ical.py

@@ -1,13 +1,13 @@
 from urllib.parse import quote
 
 import pytz
-from app.api.helpers.utilities import remove_html_tags
 from flask import jsonify
 from flask_jwt_extended import current_user
 from icalendar import Calendar, Event, Timezone
 from sqlalchemy import or_
 from sqlalchemy.orm import joinedload
 
+from app.api.helpers.utilities import remove_html_tags
 from app.models.session import Session