aa-ledger 1.0.4__py3-none-any.whl → 2.0.0__py3-none-any.whl

ledger/api/schema.py

@@ -1,25 +1,198 @@
 # Standard Library
 from datetime import datetime
-from typing import Any
 
 # Third Party
 from ninja import Schema
 
+# Django
+from django.utils import timezone
 
-class EveName(Schema):
-    id: int
+# AA Ledger
+from ledger.helpers.billboard import BillboardData
+
+
+class OwnerSchema(Schema):
+    """
+    Schema for Character or Character Owner.
+
+    Attributes:
+        character_id (int): The ID of the character.
+        character_name (str): The name of the character.
+        icon (str | None): The URL of the character's icon, if available.
+    """
+
+    character_id: int
+    character_name: str
+    icon: str | None = None
+
+
+class EntitySchema(Schema):
+    """
+    Schema for Entity or Corporation Owner.
+
+    Attributes:
+        entity_id (int): The ID of the entity.
+        entity_name (str): The name of the entity.
+        icon (str | None): The URL of the entity's icon, if available.
+    """
+
+    entity_id: int
+    entity_name: str
+    alt_ids: list[int] = []
+    icon: str = ""
+    popover: str = ""
+
+
+class CategorySchema(Schema):
     name: str
-    cat: str | None = None
+    amount: float = 0.00
+    average: float = 0.00
+    average_tick: float = 0.00
+    ref_types: str | None = None
 
 
-class CharacterPlanet(Schema):
-    character_id: int | None = None
-    character_name: str | None = None
-    planet: str | None = None
-    planet_id: int | None = None
-    upgrade_level: int | None = None
-    num_pins: int | None = None
+class UpdateStatusSchema(Schema):
     last_update: datetime | None = None
+    last_run: datetime | None = None
+    status: str | None = None
+    icon: str | None = None
+
+
+class BillboardSchema(Schema):
+    xy_chart: BillboardData | None = None
+    chord_chart: BillboardData | None = None
+
+
+class LedgerResponse(Schema):
+    """
+    Schema for Ledger Response.
+
+    Attributes:
+        owner (OwnerSchema): The owner of the ledger.
+        billboard (BillboardSchema): Billboard data.
+        actions (str, optional): HTML string for actions.
+    """
+
+    owner: OwnerSchema
+    billboard: BillboardSchema
+    actions: str = ""
+
+
+class LedgerSchema(Schema):
+    """
+
+    Schema for Ledger Summary.
+
+    Attributes:
+        bounty (float): Amount related to bounties.
+        ess (float): Amount related to ESS activities.
+        costs (float): Amount related to costs.
+        miscellaneous (float): Miscellaneous amount.
+        total (float): Total amount.
+    """
+
+    bounty: float = 0.00
+    ess: float = 0.00
+    costs: float = 0.00
+    miscellaneous: float = 0.00
+    total: float = 0.00
+
+
+class CharacterLedgerSchema(LedgerSchema):
+    """
+    Schema for Character Ledger extending LedgerSchema.
+
+    Subclass of :class:`LedgerSchema`.
+
+    Attributes:
+        mining (float): Amount related to mining activities.
+    """
+
+    mining: float = 0.00
+
+
+class OwnerLedgerRequestInfo(Schema):
+    """Schema for Owner Ledger Request Information."""
+
+    owner_id: int
+    year: int
+    month: int | None = None
+    day: int | None = None
+    section: str = "summary"
+    dropdown_html: str | None = None
+    footer_html: str | None = None
+
+    def to_date_query(self) -> dict:
+        date_query = {"date__year": self.year}
+        if self.month is not None:
+            date_query["date__month"] = self.month
+        if self.day is not None:
+            date_query["date__day"] = self.day
+        return date_query
+
+
+class CorporationLedgerRequestInfo(OwnerLedgerRequestInfo):
+    """
+    Schema for Corporation Ledger Request Information.
+
+    Subclass of :class:`OwnerLedgerRequestInfo`.
+
+    Attributes:
+        entity_id (int | None): The ID of the entity.
+        division_id (int | None): The ID of the division.
+    """
+
+    entity_id: int | None = None
+    division_id: int | None = None
+
+    def to_division_query(self) -> dict:
+        division_query = {}
+        if self.division_id is not None:
+            division_query["division__division_id"] = self.division_id
+        return division_query
+
+
+class AllianceLedgerRequestInfo(OwnerLedgerRequestInfo):
+    """
+    Schema for Alliance Ledger Request Information.
+
+    Subclass of :class:`OwnerLedgerRequestInfo`.
+
+    Attributes:
+        corporation_id (int | None): The ID of the corporation.
+    """
+
+    corporation_id: int | None = None
+
+
+class LedgerDetailsSummary(Schema):
+    """
+    Schema for summary of ledger details.
+
+    Attributes:
+        summary (str): Summary of all categories.
+        daily (str): Daily breakdown of categories.
+        hourly (str): Hourly breakdown of categories.
+    """
+
+    summary: str = ""
+    daily: str = ""
+    hourly: str = ""
+
+
+class LedgerDetailsResponse(Schema):
+    """Flexible schema for detailed ledger categories.
+
+    Attributes:
+        summary (CategorySchema): Summary of all categories.
+        daily (CategorySchema): Daily breakdown of categories.
+        hourly (CategorySchema): Hourly breakdown of categories.
+    """
+
+    summary: list[CategorySchema]
+    daily: list[CategorySchema]
+    hourly: list[CategorySchema]
+    total: LedgerDetailsSummary
 
 
 class CharacterAdmin(Schema):
@@ -34,7 +207,59 @@ class AllianceAdmin(Schema):
     alliance: dict | None = None
 
 
-class Ledger(Schema):
-    ratting: list | None = None
-    billboard: Any | None = None
-    total: dict | None = None
+class EveTypeSchema(Schema):
+    """
+    Schema for EVE Online item types.
+
+    Attributes:
+        id (int): The ID of the item type.
+        name (str): The name of the item type.
+        description (str | None): The description of the item type, if available.
+        group_id (int | None): The group ID of the item type, if available.
+        group_name (str | None): The group name of the item type, if available.
+        market_group_id (int | None): The market group ID of the item type, if available.
+        market_group_name (str | None): The market group name of the item type, if available.
+        icon (str | None): The URL of the item type's icon, if available.
+    """
+
+    id: int
+    name: str
+    description: str | None = None
+    group_id: int | None = None
+    group_name: str | None = None
+    market_group_id: int | None = None
+    market_group_name: str | None = None
+    icon: str | None = None
+
+
+class PlanetSchema(Schema):
+    id: int
+    name: str
+    type: EveTypeSchema
+    upgrade_level: int
+    num_pins: int
+    last_update: timezone.datetime
+
+
+class CharacterPlanet(Schema):
+    character_id: int | None = None
+    character_name: str | None = None
+    planet: str | None = None
+    planet_id: int | None = None
+    upgrade_level: int | None = None
+    num_pins: int | None = None
+    last_update: datetime | None = None
+
+
+class ProgressBarSchema(Schema):
+    percentage: str
+    html: str
+
+
+class ExtractorSchema(Schema):
+    item_id: int
+    item_name: str
+    icon: str | None = None
+    install_time: str
+    expiry_time: str
+    progress: ProgressBarSchema

ledger/app_settings.py

@@ -2,33 +2,17 @@
 App Settings
 """
 
-# Standard Library
-import sys
-
-# Alliance Auth (External Libs)
-from app_utils.app_settings import clean_setting
-
-IS_TESTING = sys.argv[1:2] == ["test"]
-
-# Set Test Mode True or False
+# Django
+from django.conf import settings
 
 # Set Naming on Auth Hook
-LEDGER_APP_NAME = clean_setting("LEDGER_APP_NAME", "Ledger")
-
-# zKillboard - https://zkillboard.com/
-EVE_BASE_URL = "https://esi.evetech.net/"
-EVE_API_URL = "https://esi.evetech.net/latest/"
-EVE_BASE_URL_REGEX = r"^http[s]?:\/\/esi.evetech\.net\/"
-
-# fuzzwork
-FUZZ_BASE_URL = "https://www.fuzzwork.co.uk/"
-FUZZ_API_URL = "https://www.fuzzwork.co.uk/api/"
-FUZZ_BASE_URL_REGEX = r"^http[s]?:\/\/(www\.)?fuzzwork\.co\.uk\/"
+LEDGER_APP_NAME = getattr(settings, "LEDGER_APP_NAME", "Ledger")
 
 # Global timeout for tasks in seconds to reduce task accumulation during outages.
-LEDGER_TASKS_TIME_LIMIT = clean_setting("LEDGER_TASKS_TIME_LIMIT", 600)
+LEDGER_TASKS_TIME_LIMIT = getattr(settings, "LEDGER_TASKS_TIME_LIMIT", 600)
 
-LEDGER_STALE_TYPES = clean_setting(
+LEDGER_STALE_TYPES = getattr(
+    settings,
     "LEDGER_STALE_TYPES",
     {
         "wallet_journal": 30,
@@ -41,13 +25,13 @@ LEDGER_STALE_TYPES = clean_setting(
 )
 
 # Mining Price Calculation
-LEDGER_USE_COMPRESSED = clean_setting("LEDGER_USE_COMPRESSED", True)
-LEDGER_PRICE_PERCENTAGE = clean_setting("LEDGER_PRICE_PERCENTAGE", 0.9)
+LEDGER_USE_COMPRESSED = getattr(settings, "LEDGER_USE_COMPRESSED", True)
+LEDGER_PRICE_PERCENTAGE = getattr(settings, "LEDGER_PRICE_PERCENTAGE", 0.9)
 
 # Ledger Cache System
-LEDGER_CACHE_STALE = 60 * 60 * 168  # 168 hours
+LEDGER_CACHE_STALE = 60 * 60 * 24 * 30  # 30 days
 LEDGER_CACHE_KEY = "LEDGER"
-LEDGER_CACHE_ENABLED = True
+LEDGER_CACHE_ENABLED = getattr(settings, "LEDGER_CACHE_ENABLED", True)
 
 # Maximum Number of Objects processed per run of DJANGO Batch Method
 # Controls how many database records are inserted in a single batch operation.
@@ -55,4 +39,4 @@ LEDGER_CACHE_ENABLED = True
 # reduce this value (e.g., to 250 or 100).
 # Can be increased for better performance if your MySQL max_allowed_packet setting
 # is configured higher (default is usually 16-64MB).
-LEDGER_BULK_BATCH_SIZE = clean_setting("LEDGER_BULK_BATCH_SIZE", 500)
+LEDGER_BULK_BATCH_SIZE = getattr(settings, "LEDGER_BULK_BATCH_SIZE", 500)

ledger/auth_hooks.py

@@ -10,7 +10,7 @@ from allianceauth.services.hooks import MenuItemHook, UrlHook
 
 # AA Ledger
 from ledger import app_settings, urls
-from ledger.models.characteraudit import CharacterAudit
+from ledger.models.characteraudit import CharacterOwner
 
 
 class LedgerMenuItem(MenuItemHook):
@@ -27,7 +27,7 @@ class LedgerMenuItem(MenuItemHook):
     def render(self, request):
         if request.user.has_perm("ledger.basic_access"):
             self.count = (
-                CharacterAudit.objects.annotate_total_update_status_user(
+                CharacterOwner.objects.annotate_total_update_status_user(
                     user=request.user
                 )
                 .aggregate(total_failed=Sum("num_sections_failed"))

ledger/constants.py

@@ -2,6 +2,10 @@
 Constants
 """
 
+# Django
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
 # Embed colors
 DISCORD_EMBED_COLOR_INFO = 0x5BC0DE
 DISCORD_EMBED_COLOR_SUCCESS = 0x5CB85C
@@ -16,188 +20,57 @@ DISCORD_EMBED_COLOR_MAP = {
     "danger": DISCORD_EMBED_COLOR_DANGER,
 }
 
-COMMAND_CENTER = [
-    2129,
-    2130,
-    2131,
-    2132,
-    2136,
-    2137,
-    2138,
-    2139,
-    2140,
-    2141,
-    2142,
-    2143,
-    2144,
-    2145,
-    2146,
-    2147,
-    2148,
-    2149,
-    2150,
-    2151,
-    2152,
-    2153,
-    2154,
-    2155,
-    2156,
-    2157,
-    2158,
-    2159,
-    2160,
-    2254,
-    2524,
-    2525,
-    2533,
-    2534,
-    2549,
-    2550,
-    2551,
-    2574,
-    2576,
-    2577,
-    2568,
-    2581,
-    2582,
-    2585,
-    2586,
-]
-SPACEPORTS = [2256, 2542, 2543, 2544, 2552, 2555, 2556, 2557]
-STORAGE_FACILITY = [2257, 2535, 2536, 2541, 2558, 2560, 2561, 2562]
-EXTRACTOR_CONTROL_UNIT = [2848, 3060, 3061, 3062, 3063, 3064, 3067, 3068]
-P0_PRODUCTS_SOLID = [2267, 2270, 2272, 2306, 2307]
-P0_PRODUCTS_LIQUID_GAS = [2268, 2308, 2309, 2310, 2311]
-P0_PRODUCTS_ORGANIC = [2073, 2286, 2287, 2288, 2305]
-P0_PRODUCTS = P0_PRODUCTS_SOLID + P0_PRODUCTS_LIQUID_GAS + P0_PRODUCTS_ORGANIC
-P1_PRODUCTS = [
-    2389,
-    2390,
-    2392,
-    2393,
-    2395,
-    2396,
-    2397,
-    2398,
-    2399,
-    2400,
-    2401,
-    3645,
-    3683,
-    3779,
-    9828,
-]
-P2_PRODUCTS = [
-    44,
-    2312,
-    2317,
-    2319,
-    2321,
-    2327,
-    2328,
-    2329,
-    2463,
-    3689,
-    3691,
-    3693,
-    3695,
-    3697,
-    3725,
-    3775,
-    3828,
-    983,
-    9832,
-    9836,
-    9838,
-    9840,
-    9842,
-    15317,
-]
-P3_PRODUCTS = [
-    2344,
-    2345,
-    2346,
-    2348,
-    2349,
-    2351,
-    2352,
-    2354,
-    2358,
-    2360,
-    2361,
-    2366,
-    2367,
-    9834,
-    9846,
-    9848,
-    12836,
-    17136,
-    17392,
-    17898,
-    28974,
-]
-P4_PRODUCTS = [2867, 2868, 2869, 2870, 2871, 2872, 2875, 2876]
-P5_PRODUCTS = []
-
 NPC_ENTITIES = [
     1000125,  # Concord Bounties (Bounty Prizes, ESS
     1000132,  # Secure Commerce Commission (Market Fees)
     1000413,  # Air Laboratories (Daily Login Rewards, etc.)
 ]
 
-BOUNTY_PRIZES = ["bounty_prizes"]
-ESS_TRANSFER = ["ess_escrow_transfer"]
-MISSION_REWARD = ["agent_mission_reward", "agent_mission_time_bonus_reward"]
-INCURSION = ["corporate_reward_payout"]
 
-# Cost Ref Types
-CONTRACT = [
-    "contract_price",
-    "contract_collateral",
-    "contract_reward_deposited",
-    "contract_brokers_fee",
-    "contract_sales_tax",
-    "contract_price_payment_corp",
-    "contract_reward",
-    "contract_reward_refund",
-    "contract_collateral_refund",
-    "contract_deposit_refund",
-]
-MARKET = [
-    "market_escrow",
-    "transaction_tax",
-    "market_provider_tax",
-    "brokers_fee",
-    "market_transaction",
-]
-ASSETS = ["asset_safety_recovery_tax"]
-TRAVELING = [
-    "structure_gate_jump",
-    "jump_clone_activation_fee",
-    "jump_clone_installation_fee",
-]
-PRODUCTION = [
-    "industry_job_tax",
-    "manufacturing",
-    "researching_time_productivity",
-    "researching_material_productivity",
-    "copying",
-    "reprocessing_tax",
-    "reaction",
-]
-SKILL = ["skill_purchase"]
-PLANETARY = [
-    "planetary_export_tax",
-    "planetary_import_tax",
-    "planetary_construction",
-]
-LP = ["lp_store"]
-# Trading
-DONATION = ["player_donation"]
-INSURANCE = ["insurance"]
-# MISC
-MILESTONE_REWARD = ["milestone_reward_payment"]
-DAILY_GOAL_REWARD = ["daily_goal_payouts"]
+class MonthChoice(models.TextChoices):
+    JANUARY = 1, _("January")
+    FEBRUARY = 2, _("February")
+    MARCH = 3, _("March")
+    APRIL = 4, _("April")
+    MAY = 5, _("May")
+    JUNE = 6, _("June")
+    JULY = 7, _("July")
+    AUGUST = 8, _("August")
+    SEPTEMBER = 9, _("September")
+    OCTOBER = 10, _("October")
+    NOVEMBER = 11, _("November")
+    DECEMBER = 12, _("December")
+
 
-RENTAL = ["office_rental_fee"]
-CORP_WITHDRAW = ["corporation_account_withdrawal"]
+class DayChoice(models.TextChoices):
+    DAY_1 = 1, _("1")
+    DAY_2 = 2, _("2")
+    DAY_3 = 3, _("3")
+    DAY_4 = 4, _("4")
+    DAY_5 = 5, _("5")
+    DAY_6 = 6, _("6")
+    DAY_7 = 7, _("7")
+    DAY_8 = 8, _("8")
+    DAY_9 = 9, _("9")
+    DAY_10 = 10, _("10")
+    DAY_11 = 11, _("11")
+    DAY_12 = 12, _("12")
+    DAY_13 = 13, _("13")
+    DAY_14 = 14, _("14")
+    DAY_15 = 15, _("15")
+    DAY_16 = 16, _("16")
+    DAY_17 = 17, _("17")
+    DAY_18 = 18, _("18")
+    DAY_19 = 19, _("19")
+    DAY_20 = 20, _("20")
+    DAY_21 = 21, _("21")
+    DAY_22 = 22, _("22")
+    DAY_23 = 23, _("23")
+    DAY_24 = 24, _("24")
+    DAY_25 = 25, _("25")
+    DAY_26 = 26, _("26")
+    DAY_27 = 27, _("27")
+    DAY_28 = 28, _("28")
+    DAY_29 = 29, _("29")
+    DAY_30 = 30, _("30")
+    DAY_31 = 31, _("31")

ledger/decorators.py

@@ -4,59 +4,15 @@ Decorators
 
 # Standard Library
 import time
-from functools import wraps
-
-# Django
-from django.core.cache import cache
 
 # Alliance Auth
 from allianceauth.services.hooks import get_extension_logger
 
-# Alliance Auth (External Libs)
-from app_utils.esi import fetch_esi_status
-from app_utils.logging import LoggerAddTag
-
 # AA Ledger
 from ledger import __title__
-from ledger.app_settings import IS_TESTING
-
-logger = LoggerAddTag(get_extension_logger(__name__), __title__)
-
-# Use shared ESI status route rate limit from app_settings
-ESI_STATUS_ROUTE_RATE_LIMIT = 5
-ESI_STATUS_KEY = "esi-is-available-status"
-
-
-def get_esi_available_cache() -> bool:
-    """Return True if ESI availability cache is present."""
-    if cache.get(ESI_STATUS_KEY):
-        return True
-    return False
-
-
-def when_esi_is_available(func):
-    """
-    Make sure the decorated task only runs when esi is available and store the result.
-    Complete the task without running it when downtime is detected.
-    Automatically disabled during tests.
-    """
-
-    @wraps(func)
-    def outer(*args, **kwargs):
-
-        # During tests we skip ESI checks
-        if IS_TESTING or get_esi_available_cache():
-            logger.debug("Skipping ESI check (testing mode or cache present).")
-            return func(*args, **kwargs)
-
-        # Check ESI status
-        if fetch_esi_status().is_ok:
-            logger.debug("ESI is available, proceeding.")
-            cache.set(ESI_STATUS_KEY, "1", timeout=ESI_STATUS_ROUTE_RATE_LIMIT)
-            return func(*args, **kwargs)
-        return None  # function will not run
+from ledger.providers import AppLogger
 
-    return outer
+logger = AppLogger(get_extension_logger(__name__), __title__)
 
 
 def log_timing(logs):