* feat: add initial crates readmes
* feat: add initial CLI readme
* fix: some links
* feat: fix node badge, split changelogs, fix some other links add docs in cli
* feat: feature the gamedig site in the lib
* feat: fill in cli package fields
* feat: set CLI version to 0.1.0
* feat: update changelogs to set vers
* feat: update the release workflow
* feat: initial http and eco support
* http: Replace reqwest with ureq and add HTTPS support
ureq markets itself as a lightweight blocking HTTP client which might be
a good choice for rust-gamedig at the moment. However the main reason
for changing to ureq is that it allows setting a "resolver" function
which overrides the IP address to connect to. This is useful because it
allows us to pass a URL with the desired hostname without the HTTP
library doing an extra DNS lookup (this allows HTTPS to work when we
specify the exact IP and port to connect to external to the URL).
Other changes in this commit are:
- Feature gated things that depend on serde: this means that the eco
game won't be available if the library is compiled without serde
- Added the TLS feature to enable TLS support in the HTTP library
- Added HTTPSettings to set the protocol (HTTP/HTTPS) and the hostname
- Setting a user-agent string on HTTP requests (allows the server to see
what program is being used to query them)
- Store the address as a parsed Url so we don't re-parse it on every
request
- Add a method to POST JSON data and parse response
- Renamed the request() method to get_json() in anticipation of a future
method that will send a GET request and handle the raw bytes instead
of using serde
- Improved documentation
* eco: Add generic impls
* eco: fixes
* http: Add headers to HttpSettings and rename from HTTPSettings
* eco: Add extra request settings
* http: Add support for querying raw bytes
* http: Add unit-tests
* http: Rename HttpProtocol
* crate: Make serde dependency non-optional
The serde feature now only enable serde derivations for our types that
don't need it for the library to function.
* http: Add helper for creating HttpClients to query APIs
Adds the from_url helper that should make working with master server web
APIs easier.
* Add/Update badge
* crate: Require games feature for eco example
* docs: Update changelog
---------
Co-authored-by: Douile <douile@douile.com>
* protocols: Add more control over gathering additional information
Adds GatherToggle which allows choosing the behaviour for how the query
handles fetching additional information. The choices are:
- DontGather - Don't attempt to fetch information
- AttemptGather - Try to fetch the information but ignore errors
- Required - Try to fetch information and fail if it errors
A handy macro was also added to utils to dispatch additional queries
based on a GatherToggle value.
* Add/Update badge
* protocols: Improve GatherToggle enum names
Co-Authored-By: Cain <75994858+cainthebest@users.noreply.github.com>
Co-Authored-By: CosminPerRam <cosmin.p@live.com>
* Add/Update badge
---------
Co-authored-by: GitHub Action <action@github.com>
Co-authored-by: Cain <75994858+cainthebest@users.noreply.github.com>
Co-authored-by: CosminPerRam <cosmin.p@live.com>
* crate: Set default binary to gamedig-cli
* crate: Fix bad no-default-features option on gamedig-id dependency
* ci: Run tests when Cargo.toml changes
* id-tests: Clippy fixes
* buffer: Add UTF8LengthPrefixed string decoder
* games: Use expression for default port
This allows us to refer to constants for the default ports if we want to
(literals will still work).
* games: Add support for mindustry
* fix: ID tests not in correct directory
* refactor: Move game-id test logic into its own crate
* id-tests: Add CLI that reads JSON input
* id-tests: Update crate docs
* Remove node ID test
* id-tests: Don't try to parse unneeded info
* id-tests: Enable cli feature by default
* tidy: Move TimeoutSettings out of protocol types
* tidy: Move game type to a types file
* tidy: Move generic query functions to own file
* tidy: Move ExtraRequestSettings to game types
* tidy: Move generic query functions into games module
* Revert "tidy: Move ExtraRequestSettings to game types"
This reverts commit aa0d23fc2acc12d68f03265a9caff6f98bf25054.
* Revert "tidy: Move TimeoutSettings out of protocol types"
This reverts commit 7ee10711ed11f17cc06565d4cc9102040d53a319.
* tidy: Re-export types needed for query at the root
* Add/Update badge
---------
Co-authored-by: GitHub Action <action@github.com>
* [Test] Add best effort test to validate game ID rules
An attempt to implement the rules specified in #108 as a programmatic
test.
* [Test] Refactor ID rules to check if a mod exists after - in game name
This allows fivem to pass the check following rule 8, but could also
cause a false pass in some cases.
* [Test] Add unit tests for ID rule checker
Adds unit tests based on the examples in CONTRIBUTING.md to confirm in
those cases we would allow ID to pass. However these tests don't check
any error cases.
* test/id: Correctly extract protocol names
* games/defs: Fix unreal tournament IDs
* tests: Require game definitions to run ID tests
* tests: Improve comments on ID tests
* tests/id: Combine - seperated numbers
* games/defs: Fix darkest hour ID
* Add/Update badge
---------
Co-authored-by: GitHub Action <action@github.com>
