aa-intel-tool 0.0.1a13__py3-none-any.whl → 1.0.0__py3-none-any.whl

aa_intel_tool/templates/aa_intel_tool/views/scan/fleetcomp.html

@@ -0,0 +1,47 @@
+{% extends "aa_intel_tool/base.html" %}
+
+{% load i18n %}
+
+{% block page_title %}{{ parser_title|title }} » {% translate "Intel Parser" %}{% endblock %}
+
+{% block aa_intel_tool_header %}
+    <header>
+        <h1>{{ parser_title|title }}</h1>
+    </header>
+
+    {% include "aa_intel_tool/partials/scan/evetime.html" %}
+    {% include "aa_intel_tool/partials/scan/buttons.html" %}
+{% endblock %}
+
+{% block aa_intel_tool_body %}
+    {% include "aa_intel_tool/partials/scan/fleetcomp/fleet-details.html" %}
+
+    {% if app_settings.INTELTOOL_ENABLE_MODULE_CHATSCAN %}
+        {% include "aa_intel_tool/partials/scan/fleetcomp/participation.html" %}
+    {% endif %}
+{% endblock %}
+
+{% block extra_css %}
+    {% include "bundles/datatables-css.html" %}
+    {% include "aa_intel_tool/bundles/aa-intel-tool-css.html" %}
+{% endblock %}
+
+{% block extra_javascript %}
+    <script>
+        const aaIntelToolJsOptions = {
+            ajax: {
+                getShipClasses: '{% url "aa_intel_tool:ajax_get_scan_data" scan_hash scan_data_section.SHIPLIST.value %}',
+                getShipTypes: '{% url "aa_intel_tool:ajax_get_scan_data" scan_hash scan_data_section.SHIPTYPES.value %}',
+                getFleetComposition: '{% url "aa_intel_tool:ajax_get_scan_data" scan_hash scan_data_section.FLEETCOMPOSITION.value %}',
+                getPilotList: '{% url "aa_intel_tool:ajax_get_scan_data" scan_hash scan_data_section.PILOTLIST.value %}',
+                getCorporationList: '{% url "aa_intel_tool:ajax_get_scan_data" scan_hash scan_data_section.CORPORATIONLIST.value %}',
+                getAllianceList: '{% url "aa_intel_tool:ajax_get_scan_data" scan_hash scan_data_section.ALLIANCELIST.value %}'
+            }
+        }
+    </script>
+
+    {% include "bundles/datatables-js.html" %}
+    {% include "bundles/clipboard-js.html" %}
+    {% include "aa_intel_tool/bundles/aa-intel-tool-js-l10n.html" %}
+    {% include "aa_intel_tool/bundles/aa-intel-tool-fleetcomp-js.html" %}
+{% endblock extra_javascript %}

aa_intel_tool/tests/test-data/fleetcomp.txt

@@ -1,2 +1,3 @@
 Rounon Dax	DO6H-Q	Metamorphosis	Frigate	Fleet Commander (Boss)	5 - 5 - 5
 Arodem Artemis	Perimeter	Leopard	Shuttle	Squad Member	0 - 0 - 5	Wing 1 / Squad 1
+Nero Tal'aura	Perimeter	Leopard	Shuttle	Squad Member	0 - 0 - 5	Wing 1 / Squad 1

aa_intel_tool/tests/test_access.py

@@ -9,8 +9,8 @@ from http import HTTPStatus
 from django.test import TestCase
 from django.urls import reverse
 
-# AA Intel Tool
-from aa_intel_tool.tests.utils import create_fake_user
+# Alliance Auth (External Libs)
+from app_utils.testing import create_fake_user
 
 
 class TestAccess(TestCase):
@@ -35,7 +35,7 @@ class TestAccess(TestCase):
             <li>
                 <a class="active" href="{reverse('aa_intel_tool:intel_tool_index')}">
                     <i class="fas fa-clipboard-list fa-fw"></i>
-                    Intel Tool
+                    Intel Parser
                 </a>
             </li>
         """

aa_intel_tool/tests/test_admin.py

@@ -0,0 +1,86 @@
+"""
+Test for admin.py
+"""
+
+# Django
+from django.test import TestCase
+from django.urls import reverse
+
+# Alliance Auth (External Libs)
+from app_utils.testing import create_fake_user
+
+# AA Intel Tool
+from aa_intel_tool.admin import BaseReadOnlyAdminMixin
+
+
+class TestAdmin(TestCase):
+    """
+    The tests
+    """
+
+    @classmethod
+    def setUpClass(cls) -> None:
+        """
+        Set up groups and users
+        """
+
+        super().setUpClass()
+
+        # User
+        cls.user_1001 = create_fake_user(
+            character_id=1001, character_name="Peter Parker"
+        )
+
+    def test_has_add_permission_returns_false(self):
+        """
+        Test if admin.BaseReadOnlyAdminMixin.has_add_permission returns False
+
+        :return:
+        :rtype:
+        """
+
+        self.client.force_login(user=self.user_1001)
+
+        response = self.client.get(
+            path=reverse(viewname="aa_intel_tool:intel_tool_index")
+        )
+
+        has_permission = BaseReadOnlyAdminMixin.has_add_permission(request=response)
+
+        self.assertFalse(expr=has_permission)
+
+    def test_has_change_permission_returns_false(self):
+        """
+        Test if admin.BaseReadOnlyAdminMixin.has_change_permission returns False
+
+        :return:
+        :rtype:
+        """
+
+        self.client.force_login(user=self.user_1001)
+
+        response = self.client.get(
+            path=reverse(viewname="aa_intel_tool:intel_tool_index")
+        )
+
+        has_permission = BaseReadOnlyAdminMixin.has_change_permission(request=response)
+
+        self.assertFalse(expr=has_permission)
+
+    def test_has_delete_permission_returns_false(self):
+        """
+        Test if admin.BaseReadOnlyAdminMixin.has_delete_permission returns False
+
+        :return:
+        :rtype:
+        """
+
+        self.client.force_login(user=self.user_1001)
+
+        response = self.client.get(
+            path=reverse(viewname="aa_intel_tool:intel_tool_index")
+        )
+
+        has_permission = BaseReadOnlyAdminMixin.has_delete_permission(request=response)
+
+        self.assertFalse(expr=has_permission)

aa_intel_tool/tests/test_auth_hooks.py

@@ -9,8 +9,8 @@ from http import HTTPStatus
 from django.test import TestCase
 from django.urls import reverse
 
-# AA Intel Tool
-from aa_intel_tool.tests.utils import create_fake_user
+# Alliance Auth (External Libs)
+from app_utils.testing import create_fake_user
 
 
 class TestHooks(TestCase):
@@ -35,7 +35,7 @@ class TestHooks(TestCase):
             <li>
                 <a class href="{reverse('aa_intel_tool:intel_tool_index')}">
                     <i class="fas fa-clipboard-list fa-fw"></i>
-                    Intel Tool
+                    Intel Parser
                 </a>
             </li>
         """

aa_intel_tool/tests/test_helper_data_structures.py

@@ -1,5 +1,5 @@
 """
-Test for the data_structures helper
+Test for the data_structures helper => aa_intel_tool/helper/data_structure.py
 """
 
 # Django

aa_intel_tool/tests/test_parser.py

@@ -8,8 +8,9 @@ from django.test import TestCase
 # AA Intel Tool
 from aa_intel_tool.exceptions import ParserError
 from aa_intel_tool.parser.general import check_intel_type, parse_intel
-from aa_intel_tool.tests.utils import (  # load_chatscan_txt,
+from aa_intel_tool.tests.utils import (
     load_chatscan_faulty_txt,
+    load_chatscan_txt,
     load_dscan_txt,
     load_fleetcomp_txt,
 )
@@ -36,21 +37,21 @@ class TestParserGeneral(TestCase):
 
         self.assertEqual(first=intel_type, second=expected_intel_type)
 
-    # def test_check_intel_type_chatlist(self):
-    #     """
-    #     Test should return 'chatlist' as the expected intel type
-    #
-    #     :return:
-    #     :rtype:
-    #     """
-    #
-    #     form_data = load_chatscan_txt()
-    #     scan_data = str(form_data).splitlines()
-    #
-    #     intel_type = check_intel_type(scan_data=scan_data)
-    #     expected_intel_type = "chatlist"
-    #
-    #     self.assertEqual(first=intel_type, second=expected_intel_type)
+    def test_check_intel_type_chatlist(self):
+        """
+        Test should return 'chatlist' as the expected intel type
+
+        :return:
+        :rtype:
+        """
+
+        form_data = load_chatscan_txt()
+        scan_data = str(form_data).splitlines()
+
+        intel_type = check_intel_type(scan_data=scan_data)
+        expected_intel_type = "chatlist"
+
+        self.assertEqual(first=intel_type, second=expected_intel_type)
 
     def test_check_intel_type_fleetcomp(self):
         """

aa_intel_tool/tests/test_parser_helper_db.py

@@ -0,0 +1,60 @@
+"""
+Tests for the parsers' DB helper => aa_intel_tool/parser/helper/db.py
+"""
+
+# Django
+from django.test import TestCase
+
+# AA Intel Tool
+from aa_intel_tool.models import Scan, ScanData
+from aa_intel_tool.parser.helper.db import safe_scan_to_db
+
+
+class TestParserHelperDb(TestCase):
+    """
+    The tests
+    """
+
+    def test_safe_scan_to_db_without_associated_data(self):
+        """
+        Test that the scan is successfully saved to the DB
+
+        :return:
+        :rtype:
+        """
+
+        new_scan = safe_scan_to_db(scan_type=Scan.Type.DSCAN, parsed_data={})
+
+        from_db = Scan.objects.get(pk=new_scan.hash, scan_type__exact=Scan.Type.DSCAN)
+
+        self.assertEqual(first=new_scan.hash, second=from_db.hash)
+
+    def test_safe_scan_to_db_with_associated_data(self):
+        """
+        Test that the scan is successfully saved to the DB
+
+        :return:
+        :rtype:
+        """
+
+        parsed_data = {
+            "foobar": {
+                "section": ScanData.Section.PILOTLIST,
+                "data": {"name": "William Riker"},
+            }
+        }
+
+        new_scan = safe_scan_to_db(scan_type=Scan.Type.DSCAN, parsed_data=parsed_data)
+
+        scan_from_db = Scan.objects.get(
+            pk=new_scan.hash, scan_type__exact=Scan.Type.DSCAN
+        )
+        scan_data_from_db = ScanData.objects.get(
+            scan_id__exact=scan_from_db.hash,
+            section__exact=ScanData.Section.PILOTLIST,
+        )
+
+        self.assertEqual(first=new_scan.hash, second=scan_from_db.hash)
+        self.assertEqual(
+            first=scan_data_from_db.processed_data, second=parsed_data["foobar"]["data"]
+        )

aa_intel_tool/tests/utils.py

@@ -3,98 +3,11 @@ Helper for our tests
 """
 
 # Standard Library
-import re
 from pathlib import Path
-from typing import List
-
-# Third Party
-from faker import Faker
 
 # Django
-from django.contrib.auth.models import User
 from django.template import Context, Template
 
-# Alliance Auth
-from allianceauth.tests.auth_utils import AuthUtils
-
-fake = Faker()
-
-
-def create_fake_user(  # pylint: disable=too-many-arguments
-    character_id: int,
-    character_name: str,
-    corporation_id: int = None,
-    corporation_name: str = None,
-    corporation_ticker: str = None,
-    permissions: List[str] = None,
-    **kwargs,
-) -> User:
-    """
-    Create a fake user including its main character and (optional) permissions.
-    :param character_id:
-    :param character_name:
-    :param corporation_id:
-    :param corporation_name:
-    :param corporation_ticker:
-    :param permissions:
-    :param kwargs:
-    :return:
-    """
-
-    username = re.sub(pattern=r"[^\w\d@.+-]", repl="_", string=character_name)
-    user = AuthUtils.create_user(username=username)
-
-    if not corporation_id:
-        corporation_id = 2001
-        corporation_name = "Wayne Technologies Inc."
-        corporation_ticker = "WTE"
-
-    alliance_id = kwargs.get("alliance_id", 3001)
-    alliance_name = (
-        kwargs.get("alliance_name", "Wayne Enterprises")
-        if alliance_id is not None
-        else ""
-    )
-
-    AuthUtils.add_main_character_2(
-        user=user,
-        name=character_name,
-        character_id=character_id,
-        corp_id=corporation_id,
-        corp_name=corporation_name,
-        corp_ticker=corporation_ticker,
-        alliance_id=alliance_id,
-        alliance_name=alliance_name,
-    )
-
-    if permissions:
-        perm_objs = [
-            AuthUtils.get_permission_by_name(perm=perm) for perm in permissions
-        ]
-        user = AuthUtils.add_permissions_to_user(perms=perm_objs, user=user)
-
-    return user
-
-
-def get_or_create_fake_user(*args, **kwargs) -> User:
-    """
-    Same as create_fake_user but will not fail when user already exists.
-    """
-
-    if len(args) > 1:
-        character_name = args[1]
-    elif "character_name" in kwargs:
-        character_name = kwargs["character_name"]
-    else:
-        ValueError("character_name is not defined")
-
-    username = character_name.replace("'", "").replace(" ", "_")
-
-    try:
-        return User.objects.get(username=username)
-    except User.DoesNotExist:  # pylint: disable=no-member
-        return create_fake_user(*args, **kwargs)
-
 
 def render_template(string, context=None):
     """

aa_intel_tool/views/general.py

@@ -9,13 +9,23 @@ from django.http import HttpResponse
 from django.shortcuts import redirect, render
 from django.utils.translation import gettext_lazy as _
 
+# Alliance Auth
+from allianceauth.services.hooks import get_extension_logger
+
+# Alliance Auth (External Libs)
+from app_utils.logging import LoggerAddTag
+
 # AA Intel Tool
+from aa_intel_tool import __title__
 from aa_intel_tool.app_settings import AppSettings
+from aa_intel_tool.constants import SUPPORTED_INTEL_TYPES
 from aa_intel_tool.exceptions import ParserError
 from aa_intel_tool.form import IntelForm
 from aa_intel_tool.models import Scan, ScanData
 from aa_intel_tool.parser.general import parse_intel
 
+logger = LoggerAddTag(my_logger=get_extension_logger(name=__name__), prefix=__title__)
+
 
 def index(request: WSGIRequest) -> HttpResponse:
     """
@@ -91,6 +101,8 @@ def scan(request: WSGIRequest, scan_hash: str):
 
         return redirect(to="aa_intel_tool:intel_tool_index")
 
+    logger.debug(msg=f"Intel Type: {intel_scan.scan_type}")
+
     scan_data = {
         "scan_type": intel_scan.scan_type,
         "created": intel_scan.created,
@@ -101,17 +113,14 @@ def scan(request: WSGIRequest, scan_hash: str):
         "scan_hash": scan_hash,
         "scan": scan_data,
         "scan_data_section": ScanData.Section,
+        "parser_title": SUPPORTED_INTEL_TYPES[intel_scan.scan_type]["name"],
+        "app_settings": AppSettings,
     }
 
-    scan_type_templates = {
-        "chatlist": "aa_intel_tool/views/scan/chatlist.html",
-        "dscan": "aa_intel_tool/views/scan/dscan.html",
-    }
-
-    if intel_scan.scan_type in scan_type_templates:
+    if intel_scan.scan_type in SUPPORTED_INTEL_TYPES:
         return render(
             request=request,
-            template_name=scan_type_templates[intel_scan.scan_type],
+            template_name=SUPPORTED_INTEL_TYPES[intel_scan.scan_type]["template"],
             context=context,
         )
 

{aa_intel_tool-0.0.1a13.dist-info → aa_intel_tool-1.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aa-intel-tool
-Version: 0.0.1a13
+Version: 1.0.0
 Summary: A simple parser for D-Scans and more for Alliance Auth
 Project-URL: Changelog, https://github.com/ppfeufer/aa-intel-tool/blob/master/CHANGELOG.md
 Project-URL: Documentation, https://github.com/ppfeufer/aa-intel-tool/blob/master/README.md
@@ -692,7 +692,7 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -733,6 +733,7 @@ ______________________________________________________________________
     - [Screenshots](#screenshots)
       - [Chat Scan](#chat-scan)
       - [D-Scan](#d-scan)
+      - [Fleet Composition](#fleet-composition)
   - [Installation](#installation)
     - [Step 1: Install the Package](#step-1-install-the-package)
     - [Step 2: Configure Alliance Auth](#step-2-configure-alliance-auth)
@@ -746,26 +747,21 @@ ______________________________________________________________________
       - [Nginx](#nginx)
   - [Settings](#settings)
   - [Changelog](#changelog)
+  - [Translation Status](#translation-status)
   - [Contributing](#contributing)
 
 <!-- mdformat-toc end -->
 
 ______________________________________________________________________
 
-> **Warning**
->
-> This app is still in active development and only available as an early alpha
-> version. Do not install this app in your live environment. If you want to test
-> this app, do so in a dedicated test environment. Don't come crying if you wreck
-> your live environment.
->
-> During the alpha phase, it is highly likely that the DB migrations will be reset a
-> couple of times.
+> **Note**
 >
-> Bugs and errors are expected during this time as well, so feel free to report them
-> as early as possible, if you dare to test this app.
+> This app makes use of a feature introduced with Alliance Auth v3.6.1, meaning,
+> installing this app will pull in Alliance Auth v3.6.1 unsupervised if you haven't
+> updated yet.
 >
-> Thank you!
+> **Please make sure to update Allianceauth to version 3.6.1 or higher before you
+> install this app to avoid any complications.**
 
 ## Overview<a name="overview"></a>
 
@@ -787,6 +783,10 @@ See [Settings](#settings) section for details.
 
 ![Image: D-Scan Module]
 
+#### Fleet Composition<a name="fleet-composition"></a>
+
+![Image: Fleet Composition Module]
+
 ## Installation<a name="installation"></a>
 
 **Important**: Please make sure you meet all preconditions before you proceed:
@@ -895,8 +895,8 @@ Open your vhost configuration and add the following 2 lines right after the
 `ProxyPreserveHost On` directive:
 
 ```apache
-Timeout      600
 ProxyTimeout 600
+Timeout      600
 ```
 
 Restart your Apache2 service.
@@ -908,8 +908,8 @@ directive:
 
 ```nginx
 proxy_connect_timeout 600;
-proxy_send_timeout    600;
 proxy_read_timeout    600;
+proxy_send_timeout    600;
 send_timeout          600;
 ```
 
@@ -947,6 +947,13 @@ your `local.py`.
 
 See [CHANGELOG.md]
 
+## Translation Status<a name="translation-status"></a>
+
+[![Translation status](https://weblate.ppfeufer.de/widgets/alliance-auth-apps/-/aa-intel-tool/multi-auto.svg)](https://weblate.ppfeufer.de/engage/alliance-auth-apps/)
+
+Do you want to help translate this app into your language or improve the existing
+translation? - [Join our team of translators][weblate engage]!
+
 ## Contributing<a name="contributing"></a>
 
 Do you want to contribute to this project? That's cool!
@@ -959,7 +966,7 @@ Please make sure to read the [Contribution Guidelines]
 [aa intel tool license]: https://github.com/ppfeufer/aa-intel-tool/blob/master/LICENSE
 [aa intel tool on codecov]: https://codecov.io/gh/ppfeufer/aa-intel-tool
 [aa intel tool on pypi]: https://pypi.org/project/aa-intel-tool/
-[alliance auth]: https://gitlab.com/allianceauth/allianceauth
+[alliance auth]: https://gitlab.com/allianceauth/allianceauth "Alliance Auth on GitLab"
 [alliance auth installation guide]: https://allianceauth.readthedocs.io/en/latest/installation/allianceauth.html
 [automated tests on github]: https://github.com/ppfeufer/aa-intel-tool/actions/workflows/automated-checks.yml
 [badge: automated tests]: https://github.com/ppfeufer/aa-intel-tool/actions/workflows/automated-checks.yml/badge.svg "Automated Tests"
@@ -977,10 +984,11 @@ Please make sure to read the [Contribution Guidelines]
 [black code formatter documentation]: http://black.readthedocs.io/en/latest/
 [changelog.md]: https://github.com/ppfeufer/aa-intel-tool/blob/master/CHANGELOG.md
 [code of conduct]: https://github.com/ppfeufer/aa-intel-tool/blob/master/CODE_OF_CONDUCT.md
-[contribution guidelines]: https://github.com/ppfeufer/aa-intel-tool/blob/master/CONTRIBUTING.md
+[contribution guidelines]: https://github.com/ppfeufer/aa-intel-tool/blob/master/CONTRIBUTING.md "Contribution Guidelines"
 [eve universe]: https://gitlab.com/ErikKalkoken/django-eveuniverse "Eve Universe"
 [image: chat scan module]: https://raw.githubusercontent.com/ppfeufer/aa-intel-tool/master/docs/images/chat-scan.jpg "Chat Scan Module"
 [image: d-scan module]: https://raw.githubusercontent.com/ppfeufer/aa-intel-tool/master/docs/images/d-scan.jpg "D-Scan Module"
+[image: fleet composition module]: https://raw.githubusercontent.com/ppfeufer/aa-intel-tool/master/docs/images/fleet-composition.jpg "Fleet Composition Module"
 [ppfeufer on ko-fi]: https://ko-fi.com/ppfeufer "Buy Me a Coffee!"
-[support discord]: https://discord.gg/zmh52wnfvM
-[weblate engage]: https://weblate.ppfeufer.de/engage/alliance-auth-apps/
+[support discord]: https://discord.gg/zmh52wnfvM "Alliance Auth Community Apps Support Discord"
+[weblate engage]: https://weblate.ppfeufer.de/engage/alliance-auth-apps/ "Weblate Translations"