https://github.com/aguxez/godfist

Wrapper for League of Legends' ReST API written in Elixir!
https://github.com/aguxez/godfist

elixir league-of-legends leagueoflegends legends lol riot-games

Last synced: 2 months ago
JSON representation

Wrapper for League of Legends' ReST API written in Elixir!

• Host: GitHub
• URL: https://github.com/aguxez/godfist
• Owner: aguxez
• License: mit
• Created: 2017-05-30T01:18:38.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-11-07T23:34:00.000Z (about 6 years ago)
• Last Synced: 2024-04-24T18:54:58.516Z (9 months ago)
• Topics: elixir, league-of-legends, leagueoflegends, legends, lol, riot-games
• Language: Elixir
• Homepage: https://hexdocs.pm/godfist/Godfist.html
• Size: 522 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Godfist [![Build Status](https://travis-ci.org/aguxez/godfist.svg?branch=master)](https://travis-ci.org/aguxez/godfist)

## Godfist is a wrapper for League of Legends' ReST API written in Elixir.

#### Don't forget to check the [documentation](https://hexdocs.pm/godfist/Godfist.html) for a complete reference to the library.



## Installation

First include `godfist` in your `mix.exs` and add it to your applications.

```elixir

[extra_applications: :godfist, ...]

...

{:godfist, "~> 0.5.0"}

```

You can use `{:godfist, github: "aguxez/godfist"}` for the development version.

#### Note: if a function is in the docs but not available in your package version, use Github's instead.

## Usage

Remember to set your api key on your `config.exs` with the next params.

```elixir

config :godfist,

  token: "YOUR API KEY",

  rates: :dev # or :prod

```

Or export the api key as "RIOT_TOKEN": `export RIOT_TOKEN="token"` and start making calls.

## Changes

### 0.5.0 - 03/04/18

1. Deprecated some masteries and runes functions in favor of reforged runes.

2. Removed `passive/2` from `Godfist.DataDragon`.

### 0.3.0 - 13/01/18

1. Deprecated `Godfist.League.get_all/2` for `Godfist.League.league_by_id/2`.

### 0.3.0

1. Deprecated `Godfist.League.get_entry/2` for `Godfist.League.positions/2`.

2. Rate limit options are not given to `config.exs` anymore, just `:token`.

3. Implemented a different way of handling rate limits, soon to be overridable for your own solution.

4. Removed some queues from the `Godfist.League` module.

### TODO

- [ ] Add tournament endpoints.

- [ ] Let users implement their own rate limit solutions instead of the built-in.