Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elken/blitzcrank
Clojure version of the League of Legends API
https://github.com/elken/blitzcrank
clojure league-of-legends leagueoflegends
Last synced: 4 months ago
JSON representation
Clojure version of the League of Legends API
- Host: GitHub
- URL: https://github.com/elken/blitzcrank
- Owner: elken
- License: bsd-3-clause
- Archived: true
- Created: 2017-06-08T16:38:36.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-01T12:14:43.000Z (almost 7 years ago)
- Last Synced: 2024-08-15T10:19:43.715Z (5 months ago)
- Topics: clojure, league-of-legends, leagueoflegends
- Language: Clojure
- Homepage: https://elken.github.io/blitzcrank
- Size: 163 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# blitzcrank [](https://clojars.org/blitzcrank) [](https://travis-ci.org/elken/blitzcrank)
A Clojure implementation of the public [League of Legends API](https://developer.riotgames.com/). No access to tournament API yet.
# Usage
Add the library to your project as below:
### Leiningen/Boot
```
[blitzcrank "0.1.5"]
```
### Gradle
```groovy
compile "blitzcrank:blitzcrank:0.1.5"
```
### Maven
```xml
blitzcrank
blitzcrank
0.1.5
```
API methods are located in the `blitzcrank.endpoints` namespace.
### Example
```clojure
user=> (require '[blitzcrank.endpoints.summoner :as summoner])
=> nil
user=> (summoner/by-name "Instadrone" {:api-key "AVALIDKEY"})
Attempting to get https://euw1.api.riotgames.com/lol/summoner/v3/summoners/by-name/Instadrone
=>
{:id 44040660,
:accountId 37951631,
:name "Instadrone",
:profileIconId 1666,
:revisionDate 1497913390000,
:summonerLevel 30}
```
## Feature parity
| Feature| Status|
| -------- | -------- |
| [champion-mastery-v3](https://developer.riotgames.com/api-methods/#champion-mastery-v3) | [Implemented](https://github.com/elken/blitzcrank/blob/master/src/blitzcrank/endpoints/champion_mastery.clj)
| [champion-v3](https://developer.riotgames.com/api-methods/#champion-v3) | [Implemented](https://github.com/elken/blitzcrank/blob/master/src/blitzcrank/endpoints/champion.clj)
| [league-v3](https://developer.riotgames.com/api-methods/#league-v3) | [Implemented](https://github.com/elken/blitzcrank/blob/master/src/blitzcrank/endpoints/leagues.clj) |
| [static-data-v3](https://developer.riotgames.com/api-methods/#lol-static-data-v3) | Not yet implemented |
| [lol-status-v3](https://developer.riotgames.com/api-methods/#lol-status-v3) | [Implemented](https://github.com/elken/blitzcrank/blob/master/src/blitzcrank/endpoints/status.clj)
| [masteries-v3](https://developer.riotgames.com/api-methods/#masteries-v3) | [Implemented](https://github.com/elken/blitzcrank/blob/master/src/blitzcrank/endpoints/masteries.clj)
| [match-v3](https://developer.riotgames.com/api-methods/#match-v3) | Not yet implemented |
| [runes-v3](https://developer.riotgames.com/api-methods/#runes-v3) | [Implemented](https://github.com/elken/blitzcrank/blob/master/src/blitzcrank/endpoints/runes.clj)
| [spectator-v3](https://developer.riotgames.com/api-methods/#spectator-v3) | Not yet implemented |
| [summoner-v3](https://developer.riotgames.com/api-methods/#summoner-v3) | [Implemented](https://github.com/elken/blitzcrank/blob/master/src/blitzcrank/endpoints/summoner.clj)
## Config
Default configuration can be provided by supplying a `config.edn` file within a resource-path
(the top-level `resources` directory is provided) by default. Further paths can be adding by adding a `:profile` map to
`project.clj` as below:
```clojure
:profiles {:prod {:resource-paths ["config/prod"]}
:dev {:resource-paths ["config/dev"]}}
```
Currently supported options are:
### `api-key`
Primarily used for testing, but can also be used to simplify the application. Every call to an API method will attempt
to read this value if no argument is passed.
Default: None, must be entered by user if desired.
### `region`
Default region to use for API calls. As before, every call to an API method can be called with a region. Setting this
to your largest projected userbase would be a sensible idea.
Default: `euw1`
### `locale`
This is used by the `lol-status` endpoint in order to attempt to get a localized version of a status message.
Default: `en_GB`
## Development
Run in a REPL with `lein repl`.
### Documentation
API documentation is available [online](https://elken.github.io/blitzcrank/) and [offline](https://github.com/elken/blitzcrank/docs),
generated using [codox](https://github.com/weavejester/codox). Generate using `lein codox`, which by default will output
the docs to `docs`.
## License
Copyright © 2017 Ellis Kenyő
Distributed under the BSD 3 Clause.