ritikmishra / anacreonlib Goto Github PK

The exhaustive list of API entry points can be found in this Ministry record. The following are not implemented in this package:

INFORMATIO
/api/getGameJoinInfo
/api/getGameLog
/api/openGameList
/api/scenarioList

COMMANDS
/api/abdicate
/api/abortAttack
/api/buyItem
/api/createGame
/api/destroyImprovement
/api/disbandFleet
/api/joinGame
/api/launchLAMs
/api/leaveGame
/api/sellFleet
/api/sendMessage
/api/setDoctrine
/api/setHistoryRead
/api/setIndustryAlloc
/api/setProductAlloc
/api/setUIOptions
/api/stopTradeRoute
/api/tacticalOrder

Unit tests should be there for

• dataclass JSON serialization and deserialization
  • Convert a getObjects response to our dataclasses and back again
  • getObjects response should contain
    • A fleet in battle on a world, such that there is a battlePlan in place
    • A number (e.g in resources) that is so large it gets encoded as an ipinteger on both serialization and deserialization
  • Iterate through all of the objects and see if any key/value got dropped in getObjects
    • (it is OK to expect extra fields to get added that are null/None because that is just representing the fact that the field is expected to be there for items of that object class)
• AEON ipInteger conversion

People may be interested in using other languages for scripting. To help make it easier for them to reach their goals, it would be helpful if we could generate JSON Schema / OpenAPI spec files, given how pervasive code generation tools for such files are.

blocking HTTP methods -> multithreading required for concurrency -> :/

async -> single threaded event loop -> nice when you have to block for a minute waiting for a fleet to get somewhere, and python GIL means that multithreading was usually non-parallel anyways

For extra type safety, we could use newtypes for world id's and fleet id's

Unit tests should be there for

• dataclass JSON serialization and deserialization
  • Convert a getObjects response to our dataclasses and back again
  • getObjects response should contain
    • A fleet in battle on a world, such that there is a battlePlan in place
    • A number (e.g in resources) that is so large it gets encoded as an ipinteger on both serialization and deserialization
  • Iterate through all of the objects and see if any key/value got dropped in getObjects
    • (it is OK to expect extra fields to get added that are null/None because that is just representing the fact that the field is expected to be there for items of that object class)
• AEON ipInteger conversion

World has resources_dict, but Fleet does not