DJiRData

DrJackyl's Swift Package for iRacing-Data provides models and logic to decode data available for iRacing. Its scope is to specify raw decodable models and convenience-logic to decode respective data into such models. Retrieving and querying the data should be part of other packages.

Supported Data

In the following table you can see all disocvered endpoints, their respective type in DJiRData (if it already exists), the format of the response-body as well as the URL, the endpoint has been discovered on. The latter does not mean, this is only URL to find the endpoint. It's just the one, I saw it at.

Contribution

Extension

You're welcome to contribute by picking one of the endpoints, which do not yet have a respective type in DJiRData, extend the package analogue to the already existing ones and create a pull request.

Requirements:

• Model-type in respective folder (CSV, JSON, JSONGeneric) analogue to the existing ones.
  • Doc-comment (Xcode markup), providing specialties, where the data can be found on the website, as well as the backend-endpoint with required parameters.
  • Explicit CodingKeys, even if all property-names would be sufficient.
  • Public initializer with default-value of nil for arguments of optional type.
  • Nested types for non-primitive properties.
  • Leafs may only be of primitive type (String, Bool, Int, Double).
  • Doc-comment (Xcode markup) on properties, which have specialties to their value-range or formatting, like POSIX-time or percent-escaped strings.
  • Eventually more meaningful names for properties, like "categoryID" for the coding-key "catid".
• API-method in IRData.swift to decode data to the respective model-type or an array of it.
• Update of README.md listing the model-type for the respective endpoint.

I'm picky on pull requests, mostly for the reason of consististency, please don't mind that. If you spot anything, like inconsistencies, please let me know as well.

Unit Tests & Bugs

Most of the unit tests have been removed, as they were using fetched real data, which exposed information about members, like real names and customer-IDs.

Remaining unit tests cover logic or document resolution of bugs in the models.

Example

IRData is the entry-point to decode data, for example event results, exported as CSV-file:

do {
    let csvData = try Data(contentsOf: URL(fileURLWithPath: "path/to/exported.csv"))
    let eventResult = try IRData().createCSVEventResultFromData(csvData)
    print("\(eventResult.summary.series) at \(eventResult.summary.track)")
    print(eventResult.results.map { "\($0.finPos): \($0.name) (\($0.car))"}.joined(separator: "\n") )
} catch let error {
    print(error)
}

Future

• All data listed in the table under "Supported Data".
• JSON-data available on the website.
• Usability of the package on other platforms than Apple, gating types, which require NSFoundation to be present.

Breaking Changes

< v0.3

The test-resources (DJiRDataTestResources) for testing decoding of real data have been removed, because they exposed member-data, like real names and customer-IDs, wich are otherwise only visible to members.

Hence, the respective unit-tests have been removed as well. I now set this up locally on my machine, where I run the tests.

v0.1 to v0.2

In an effort to improve the type-names of API-types, mostly the main entry-points, the prefix "DJ" and, if defined, the suffix "API" is removed. While not having the "DJ"-prefix anyways seems a good idea to me, not naming it DJiRData comes from Swift's inability to fully qualify a type, which has the same name as the module, despite the Swift Package-template creating one by exactly that name.

• The main entry-point of the API has been renamed from DJiRDataAPI to IRData.