crawlora-lolesports 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +5 -0
- data/LICENSE +21 -0
- data/README.md +53 -0
- data/lib/crawlora/lolesports/client.rb +248 -0
- data/lib/crawlora/lolesports/version.rb +5 -0
- data/lib/crawlora/lolesports.rb +2 -0
- metadata +52 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 60d1de8b0560079907e22e752a8c6859850dea1fa0aa5b6237d4d31ac6882433
|
|
4
|
+
data.tar.gz: 24c68a8dca459cabb467dd1bca80951a23938cafef36bff18980ed33f84623b4
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: cc9f9be8c0dccb9f136699dec21481d9d5e42aee2d0630c4eb1900681db1c332a614fdddc6891e1703587b92a9cb7d629128ee7456f32c3f0a5589616869df5b
|
|
7
|
+
data.tar.gz: 7c8eb1ae533fec5b8b3742fd83375e64970ee4e92668c0a233c38923138aff4e026dee28b7172eca245e720da915681cf17e678243aa110c6886a00b4e636b3f
|
data/CHANGELOG.md
ADDED
data/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Crawlora
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# Crawlora LoL Esports API client for Ruby (`crawlora-lolesports`)
|
|
2
|
+
|
|
3
|
+
This Ruby gem calls Crawlora's hosted LoL Esports API at `https://api.crawlora.net/api/v1`. It exposes 13 endpoints covering leagues, schedules, live and completed events, teams, players, and game details; it does not call or scrape LoL Esports directly. Requests require your Crawlora API key and use your account's service plan.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```ruby
|
|
8
|
+
gem "crawlora-lolesports"
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Create an account at [crawlora.net](https://crawlora.net/signup?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=lolesports-ruby-signup), open the [Crawlora console](https://crawlora.net/app?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=lolesports-ruby-console) to get an API key, and set `CRAWLORA_API_KEY` before running the client:
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require "json"
|
|
15
|
+
require "crawlora/lolesports"
|
|
16
|
+
|
|
17
|
+
client = Crawlora::Lolesports::Client.new
|
|
18
|
+
result = client.request("lolesports-completed-events", JSON.parse("{\"tournament_id\": \"sample\"}"))
|
|
19
|
+
puts result
|
|
20
|
+
client.close
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Use an operation-specific method for normal calls. `request(operation_id, params = {}, response_type: :auto)` is available for every operation. `response_type: :text` returns raw response text. This gem includes 13 API operations.
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
client = Crawlora::Lolesports::Client.new(api_key: ENV.fetch("CRAWLORA_API_KEY"), timeout: 30)
|
|
27
|
+
# client.<operation_method>(<endpoint parameters>)
|
|
28
|
+
client.close
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Client options include `api_key`, `base_url`, and `timeout`. Ruby stdlib provides the HTTP and JSON support.
|
|
32
|
+
|
|
33
|
+
## Supported LoL Esports API endpoints
|
|
34
|
+
|
|
35
|
+
Browse every route included in this gem. The [endpoint reference](https://github.com/Crawlora-org/crawlora-lolesports/blob/main/docs/usage.md) includes parameter and response details.
|
|
36
|
+
|
|
37
|
+
| Method | Endpoint | API operation | Description |
|
|
38
|
+
| --- | --- | --- | --- |
|
|
39
|
+
| `GET` | `/lolesports/completed-events` | `lolesports-completed-events` | League of Legends Esports completed matches |
|
|
40
|
+
| `GET` | `/lolesports/event` | `lolesports-event` | League of Legends Esports match detail |
|
|
41
|
+
| `GET` | `/lolesports/game-details` | `lolesports-game-details` | League of Legends Esports player game details |
|
|
42
|
+
| `GET` | `/lolesports/game-window` | `lolesports-game-window` | League of Legends Esports live game window |
|
|
43
|
+
| `GET` | `/lolesports/gpr` | `lolesports-gpr` | League of Legends Global Power Rankings |
|
|
44
|
+
| `GET` | `/lolesports/leagues` | `lolesports-leagues` | League of Legends Esports leagues |
|
|
45
|
+
| `GET` | `/lolesports/live` | `lolesports-live` | League of Legends Esports live matches |
|
|
46
|
+
| `GET` | `/lolesports/news` | `lolesports-news` | League of Legends Esports news |
|
|
47
|
+
| `GET` | `/lolesports/schedule` | `lolesports-schedule` | League of Legends Esports schedule |
|
|
48
|
+
| `GET` | `/lolesports/seasons` | `lolesports-seasons` | League of Legends Esports seasons and splits |
|
|
49
|
+
| `GET` | `/lolesports/standings` | `lolesports-standings` | League of Legends Esports standings |
|
|
50
|
+
| `GET` | `/lolesports/teams` | `lolesports-teams` | League of Legends Esports teams and rosters |
|
|
51
|
+
| `GET` | `/lolesports/tournaments` | `lolesports-tournaments` | League of Legends Esports tournaments |
|
|
52
|
+
|
|
53
|
+
See [Crawlora](https://crawlora.net/?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=lolesports-ruby-homepage), the [API documentation](https://crawlora.net/docs?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=lolesports-ruby-api-docs), and [the package repository](https://github.com/Crawlora-org/crawlora-lolesports) for account setup, the API operation reference, and release history.
|
|
@@ -0,0 +1,248 @@
|
|
|
1
|
+
require "json"
|
|
2
|
+
require "net/http"
|
|
3
|
+
require "uri"
|
|
4
|
+
|
|
5
|
+
module Crawlora
|
|
6
|
+
module Lolesports
|
|
7
|
+
module Errors
|
|
8
|
+
class Error < StandardError
|
|
9
|
+
attr_reader :status, :operation_id, :body
|
|
10
|
+
|
|
11
|
+
def initialize(message, status: nil, operation_id: nil, body: nil)
|
|
12
|
+
super(message)
|
|
13
|
+
@status, @operation_id, @body = status, operation_id, body
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
class ClientError < Error; end
|
|
17
|
+
class ServerError < Error; end
|
|
18
|
+
class NetworkError < Error; end
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
OPERATIONS = JSON.parse(<<~'JSON').freeze
|
|
22
|
+
{"lolesports-completed-events": {"bodyParam": null, "bodyRequired": false, "id": "lolesports-completed-events", "method": "GET", "params": [{"description": "Language for names and labels; one of cs-CZ, de-DE, en-US, es-ES, es-MX, fr-FR, hu-HU, ja-JP, ko-KR, pl-PL, pt-BR, th-TH, tr-TR, vi-VN, zh-TW; defaults to en-US", "enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}, {"description": "Numeric tournament id from lolesports-tournaments", "in": "query", "name": "tournament_id", "required": true, "type": "string", "x-example": "115548681802226458"}], "path": "/lolesports/completed-events", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}, {"in": "query", "name": "tournament_id", "required": true, "type": "string"}], "security": ["ApiKeyAuth"]}, "lolesports-event": {"bodyParam": null, "bodyRequired": false, "id": "lolesports-event", "method": "GET", "params": [{"description": "Language for names and labels; one of cs-CZ, de-DE, en-US, es-ES, es-MX, fr-FR, hu-HU, ja-JP, ko-KR, pl-PL, pt-BR, th-TH, tr-TR, vi-VN, zh-TW; defaults to en-US", "enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}, {"description": "Numeric match id from lolesports-schedule, lolesports-live or lolesports-standings", "in": "query", "name": "match_id", "required": true, "type": "string", "x-example": "117133816701918802"}], "path": "/lolesports/event", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}, {"in": "query", "name": "match_id", "required": true, "type": "string"}], "security": ["ApiKeyAuth"]}, "lolesports-game-details": {"bodyParam": null, "bodyRequired": false, "id": "lolesports-game-details", "method": "GET", "params": [{"description": "Numeric game id from lolesports-event", "in": "query", "name": "game_id", "required": true, "type": "string", "x-example": "117133816701918803"}, {"description": "RFC 3339 UTC timestamp whose seconds are divisible by 10; frames begin there", "in": "query", "name": "starting_time", "type": "string", "x-example": "2026-10-07T11:30:00.000Z"}, {"description": "Participant numbers 1 to 10 joined by underscores, for example 1_2_3", "in": "query", "name": "participant_ids", "type": "string", "x-example": "1_2"}], "path": "/lolesports/game-details", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "game_id", "required": true, "type": "string"}, {"in": "query", "name": "starting_time", "type": "string"}, {"in": "query", "name": "participant_ids", "type": "string"}], "security": ["ApiKeyAuth"]}, "lolesports-game-window": {"bodyParam": null, "bodyRequired": false, "id": "lolesports-game-window", "method": "GET", "params": [{"description": "Numeric game id from lolesports-event", "in": "query", "name": "game_id", "required": true, "type": "string", "x-example": "117133816701918803"}, {"description": "RFC 3339 UTC timestamp whose seconds are divisible by 10; frames begin there", "in": "query", "name": "starting_time", "type": "string", "x-example": "2026-10-07T10:20:00.000Z"}], "path": "/lolesports/game-window", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "game_id", "required": true, "type": "string"}, {"in": "query", "name": "starting_time", "type": "string"}], "security": ["ApiKeyAuth"]}, "lolesports-gpr": {"bodyParam": null, "bodyRequired": false, "id": "lolesports-gpr", "method": "GET", "params": [{"description": "Ranking snapshot; one of current, 2025, 2024; defaults to current", "enum": ["current", "2025", "2024"], "in": "query", "name": "season", "type": "string"}, {"description": "Home league slug from the leagues list of the response, for example lck", "in": "query", "name": "league", "type": "string"}, {"description": "Number of teams to return, 1 to 200, best rank first; defaults to all", "in": "query", "maximum": 200, "minimum": 1, "name": "limit", "type": "integer"}, {"description": "Add each team's GPR history points", "in": "query", "name": "history", "type": "boolean"}], "path": "/lolesports/gpr", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["current", "2025", "2024"], "in": "query", "name": "season", "type": "string"}, {"in": "query", "name": "league", "type": "string"}, {"in": "query", "name": "limit", "type": "integer"}, {"in": "query", "name": "history", "type": "boolean"}], "security": ["ApiKeyAuth"]}, "lolesports-leagues": {"bodyParam": null, "bodyRequired": false, "id": "lolesports-leagues", "method": "GET", "params": [{"description": "Language for names and labels; one of cs-CZ, de-DE, en-US, es-ES, es-MX, fr-FR, hu-HU, ja-JP, ko-KR, pl-PL, pt-BR, th-TH, tr-TR, vi-VN, zh-TW; defaults to en-US", "enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}], "path": "/lolesports/leagues", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}], "security": ["ApiKeyAuth"]}, "lolesports-live": {"bodyParam": null, "bodyRequired": false, "id": "lolesports-live", "method": "GET", "params": [{"description": "Language for names and labels; one of cs-CZ, de-DE, en-US, es-ES, es-MX, fr-FR, hu-HU, ja-JP, ko-KR, pl-PL, pt-BR, th-TH, tr-TR, vi-VN, zh-TW; defaults to en-US", "enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}], "path": "/lolesports/live", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}], "security": ["ApiKeyAuth"]}, "lolesports-news": {"bodyParam": null, "bodyRequired": false, "id": "lolesports-news", "method": "GET", "params": [{"description": "Site language; one of cs-CZ, de-DE, el-GR, en-AU, en-GB, en-PH, en-SG, en-US, es-ES, es-MX, fr-FR, hu-HU, id-ID, it-IT, ja-JP, ko-KR, pl-PL, pt-BR, ro-RO, ru-RU, th-TH, tr-TR, vi-VN, zh-TW; defaults to en-US", "enum": ["cs-CZ", "de-DE", "el-GR", "en-AU", "en-GB", "en-PH", "en-SG", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "id-ID", "it-IT", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "ro-RO", "ru-RU", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}, {"description": "Number of newest articles to return, 1 to 100; defaults to all the page lists", "in": "query", "maximum": 100, "minimum": 1, "name": "limit", "type": "integer"}], "path": "/lolesports/news", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["cs-CZ", "de-DE", "el-GR", "en-AU", "en-GB", "en-PH", "en-SG", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "id-ID", "it-IT", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "ro-RO", "ru-RU", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}, {"in": "query", "name": "limit", "type": "integer"}], "security": ["ApiKeyAuth"]}, "lolesports-schedule": {"bodyParam": null, "bodyRequired": false, "id": "lolesports-schedule", "method": "GET", "params": [{"description": "Language for names and labels; one of cs-CZ, de-DE, en-US, es-ES, es-MX, fr-FR, hu-HU, ja-JP, ko-KR, pl-PL, pt-BR, th-TH, tr-TR, vi-VN, zh-TW; defaults to en-US", "enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}, {"description": "Numeric league id from lolesports-leagues, or up to 10 comma-separated ids to combine leagues; omit for all leagues", "in": "query", "name": "league_id", "type": "string", "x-example": "98767991302996019"}, {"description": "older_page_token or newer_page_token copied from a previous response", "in": "query", "name": "page_token", "type": "string"}], "path": "/lolesports/schedule", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}, {"in": "query", "name": "league_id", "type": "string"}, {"in": "query", "name": "page_token", "type": "string"}], "security": ["ApiKeyAuth"]}, "lolesports-seasons": {"bodyParam": null, "bodyRequired": false, "id": "lolesports-seasons", "method": "GET", "params": [{"description": "Language for names and labels; one of cs-CZ, de-DE, en-US, es-ES, es-MX, fr-FR, hu-HU, ja-JP, ko-KR, pl-PL, pt-BR, th-TH, tr-TR, vi-VN, zh-TW; defaults to en-US", "enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}, {"description": "Numeric season id from an earlier lolesports-seasons response; omit for every season", "in": "query", "name": "season_id", "type": "string", "x-example": "115547545029543948"}, {"description": "Split region, case-insensitive; one of AMERICAS, BRAZIL, CHINA, COMMONWEALTH OF INDEPENDENT STATES, EMEA, EUROPE, GLOBAL, HONG KONG, MACAU, TAIWAN, INTERNATIONAL, JAPAN, KOREA, LATIN AMERICA, LATIN AMERICA NORTH, LATIN AMERICA SOUTH, NORTH AMERICA, OCEANIA, REGIONAL, SOUTHEAST ASIA, TURKEY, VIETNAM", "in": "query", "name": "region", "type": "string", "x-example": "KOREA"}, {"description": "Numeric league id from lolesports-leagues; keeps only that league's tournaments", "in": "query", "name": "league_id", "type": "string", "x-example": "98767991302996019"}], "path": "/lolesports/seasons", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}, {"in": "query", "name": "season_id", "type": "string"}, {"in": "query", "name": "region", "type": "string"}, {"in": "query", "name": "league_id", "type": "string"}], "security": ["ApiKeyAuth"]}, "lolesports-standings": {"bodyParam": null, "bodyRequired": false, "id": "lolesports-standings", "method": "GET", "params": [{"description": "Language for names and labels; one of cs-CZ, de-DE, en-US, es-ES, es-MX, fr-FR, hu-HU, ja-JP, ko-KR, pl-PL, pt-BR, th-TH, tr-TR, vi-VN, zh-TW; defaults to en-US", "enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}, {"description": "Numeric tournament id from lolesports-tournaments", "in": "query", "name": "tournament_id", "required": true, "type": "string", "x-example": "115548681802226458"}, {"description": "true adds each section's id and type (group or bracket) and bracket round names with their match ids; costs a second upstream call; false or omitted keeps the default response", "enum": [true, false], "in": "query", "name": "rounds", "type": "boolean"}], "path": "/lolesports/standings", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}, {"in": "query", "name": "tournament_id", "required": true, "type": "string"}, {"enum": ["True", "False"], "in": "query", "name": "rounds", "type": "boolean"}], "security": ["ApiKeyAuth"]}, "lolesports-teams": {"bodyParam": null, "bodyRequired": false, "id": "lolesports-teams", "method": "GET", "params": [{"description": "Language for names and labels; one of cs-CZ, de-DE, en-US, es-ES, es-MX, fr-FR, hu-HU, ja-JP, ko-KR, pl-PL, pt-BR, th-TH, tr-TR, vi-VN, zh-TW; defaults to en-US", "enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}, {"description": "Exact team slug such as t1 or g2-esports; takes precedence over q", "in": "query", "name": "slug", "type": "string", "x-example": "t1"}, {"description": "Case-insensitive substring of team name, code or slug", "in": "query", "name": "q", "type": "string"}, {"description": "Team status filter: active or archived", "enum": ["active", "archived"], "in": "query", "name": "status", "type": "string"}, {"description": "1-based page number; defaults to 1", "in": "query", "minimum": 1, "name": "page", "type": "integer"}, {"description": "Page size 1 to 100; defaults to 25", "in": "query", "maximum": 100, "minimum": 1, "name": "limit", "type": "integer"}], "path": "/lolesports/teams", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}, {"in": "query", "name": "slug", "type": "string"}, {"in": "query", "name": "q", "type": "string"}, {"enum": ["active", "archived"], "in": "query", "name": "status", "type": "string"}, {"in": "query", "name": "page", "type": "integer"}, {"in": "query", "name": "limit", "type": "integer"}], "security": ["ApiKeyAuth"]}, "lolesports-tournaments": {"bodyParam": null, "bodyRequired": false, "id": "lolesports-tournaments", "method": "GET", "params": [{"description": "Language for names and labels; one of cs-CZ, de-DE, en-US, es-ES, es-MX, fr-FR, hu-HU, ja-JP, ko-KR, pl-PL, pt-BR, th-TH, tr-TR, vi-VN, zh-TW; defaults to en-US", "enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}, {"description": "Numeric league id from lolesports-leagues", "in": "query", "name": "league_id", "required": true, "type": "string", "x-example": "98767991302996019"}], "path": "/lolesports/tournaments", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["cs-CZ", "de-DE", "en-US", "es-ES", "es-MX", "fr-FR", "hu-HU", "ja-JP", "ko-KR", "pl-PL", "pt-BR", "th-TH", "tr-TR", "vi-VN", "zh-TW"], "in": "query", "name": "hl", "type": "string"}, {"in": "query", "name": "league_id", "required": true, "type": "string"}], "security": ["ApiKeyAuth"]}}
|
|
23
|
+
JSON
|
|
24
|
+
OPERATION_IDS = JSON.parse(<<~'JSON').freeze
|
|
25
|
+
["lolesports-completed-events", "lolesports-event", "lolesports-game-details", "lolesports-game-window", "lolesports-gpr", "lolesports-leagues", "lolesports-live", "lolesports-news", "lolesports-schedule", "lolesports-seasons", "lolesports-standings", "lolesports-teams", "lolesports-tournaments"]
|
|
26
|
+
JSON
|
|
27
|
+
OPERATION_COUNT = OPERATION_IDS.length
|
|
28
|
+
|
|
29
|
+
class Client
|
|
30
|
+
attr_reader :base_url
|
|
31
|
+
|
|
32
|
+
def initialize(api_key: ENV["CRAWLORA_API_KEY"], base_url: "https://api.crawlora.net/api/v1", timeout: 30, user_agent: "crawlora-lolesports-ruby/0.1.0", transport: nil)
|
|
33
|
+
@api_key = api_key
|
|
34
|
+
@base_url = base_url.to_s.sub(%r{/+$}, "")
|
|
35
|
+
@timeout = Float(timeout)
|
|
36
|
+
@user_agent = user_agent
|
|
37
|
+
@transport = transport
|
|
38
|
+
@closed = false
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
def request(operation_id, params = {}, response_type: :auto)
|
|
42
|
+
raise Errors::ClientError, "client is closed" if @closed
|
|
43
|
+
operation_id = operation_id.to_s
|
|
44
|
+
operation = OPERATIONS[operation_id]
|
|
45
|
+
raise Errors::ClientError.new("unknown operation: #{operation_id}", operation_id: operation_id) unless operation
|
|
46
|
+
raise Errors::ClientError.new("Crawlora API key is required", operation_id: operation_id) if @api_key.nil? || @api_key.to_s.empty?
|
|
47
|
+
normalized = params.each_with_object({}) { |(key, value), out| out[key.to_s] = value }
|
|
48
|
+
payload = request_body(operation, normalized)
|
|
49
|
+
url = build_url(operation, normalized)
|
|
50
|
+
uri = URI.parse(url)
|
|
51
|
+
request = operation["method"] == "POST" ? Net::HTTP::Post.new(uri) : Net::HTTP::Get.new(uri)
|
|
52
|
+
unless payload.nil?
|
|
53
|
+
request.body = payload
|
|
54
|
+
request["Content-Type"] = "application/json"
|
|
55
|
+
end
|
|
56
|
+
request["x-api-key"] = @api_key
|
|
57
|
+
request["User-Agent"] = @user_agent
|
|
58
|
+
request["Accept"] = operation["produces"].include?("text/plain") ? "application/json, text/plain" : "application/json"
|
|
59
|
+
begin
|
|
60
|
+
if @transport
|
|
61
|
+
response = if operation["method"] == "POST"
|
|
62
|
+
@transport.call(url, request.to_hash, @timeout, "POST", payload)
|
|
63
|
+
else
|
|
64
|
+
@transport.call(url, request.to_hash, @timeout)
|
|
65
|
+
end
|
|
66
|
+
status = Integer(response.fetch(:status) { response.fetch("status") })
|
|
67
|
+
body = response.fetch(:body) { response.fetch("body", "") }
|
|
68
|
+
headers = response.fetch(:headers) { response.fetch("headers", {}) }
|
|
69
|
+
content_type = headers["content-type"] || headers["Content-Type"]
|
|
70
|
+
else
|
|
71
|
+
http = Net::HTTP.new(uri.host, uri.port)
|
|
72
|
+
http.use_ssl = uri.scheme == "https"
|
|
73
|
+
http.open_timeout = @timeout
|
|
74
|
+
http.read_timeout = @timeout
|
|
75
|
+
response = http.start { |connection| connection.request(request) }
|
|
76
|
+
status = response.code.to_i
|
|
77
|
+
body = response.body
|
|
78
|
+
content_type = response["content-type"]
|
|
79
|
+
end
|
|
80
|
+
rescue Timeout::Error, SocketError, SystemCallError, IOError, EOFError, Net::HTTPBadResponse, Net::ProtocolError, OpenSSL::SSL::SSLError => error
|
|
81
|
+
raise Errors::NetworkError.new("Crawlora request failed: #{error.message}", operation_id: operation_id)
|
|
82
|
+
end
|
|
83
|
+
unless status >= 200 && status < 300
|
|
84
|
+
klass = status >= 500 ? Errors::ServerError : Errors::ClientError
|
|
85
|
+
raise klass.new("Crawlora returned HTTP #{status}", status: status, operation_id: operation_id, body: body)
|
|
86
|
+
end
|
|
87
|
+
parse_response(body, content_type, operation, normalized, response_type)
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
def close
|
|
91
|
+
@closed = true
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
def closed?
|
|
95
|
+
@closed
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
def with
|
|
99
|
+
return self unless block_given?
|
|
100
|
+
yield self
|
|
101
|
+
ensure
|
|
102
|
+
close if block_given?
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
def self.operation_count
|
|
106
|
+
OPERATION_COUNT
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
def self.operation_ids
|
|
110
|
+
OPERATION_IDS
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
def self.operations
|
|
114
|
+
OPERATIONS
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
define_method('completed_events') do |**params|
|
|
118
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
119
|
+
request('lolesports-completed-events', params, response_type: response_type)
|
|
120
|
+
end
|
|
121
|
+
define_method('event') do |**params|
|
|
122
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
123
|
+
request('lolesports-event', params, response_type: response_type)
|
|
124
|
+
end
|
|
125
|
+
define_method('game_details') do |**params|
|
|
126
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
127
|
+
request('lolesports-game-details', params, response_type: response_type)
|
|
128
|
+
end
|
|
129
|
+
define_method('game_window') do |**params|
|
|
130
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
131
|
+
request('lolesports-game-window', params, response_type: response_type)
|
|
132
|
+
end
|
|
133
|
+
define_method('gpr') do |**params|
|
|
134
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
135
|
+
request('lolesports-gpr', params, response_type: response_type)
|
|
136
|
+
end
|
|
137
|
+
define_method('leagues') do |**params|
|
|
138
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
139
|
+
request('lolesports-leagues', params, response_type: response_type)
|
|
140
|
+
end
|
|
141
|
+
define_method('live') do |**params|
|
|
142
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
143
|
+
request('lolesports-live', params, response_type: response_type)
|
|
144
|
+
end
|
|
145
|
+
define_method('news') do |**params|
|
|
146
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
147
|
+
request('lolesports-news', params, response_type: response_type)
|
|
148
|
+
end
|
|
149
|
+
define_method('schedule') do |**params|
|
|
150
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
151
|
+
request('lolesports-schedule', params, response_type: response_type)
|
|
152
|
+
end
|
|
153
|
+
define_method('seasons') do |**params|
|
|
154
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
155
|
+
request('lolesports-seasons', params, response_type: response_type)
|
|
156
|
+
end
|
|
157
|
+
define_method('standings') do |**params|
|
|
158
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
159
|
+
request('lolesports-standings', params, response_type: response_type)
|
|
160
|
+
end
|
|
161
|
+
define_method('teams') do |**params|
|
|
162
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
163
|
+
request('lolesports-teams', params, response_type: response_type)
|
|
164
|
+
end
|
|
165
|
+
define_method('tournaments') do |**params|
|
|
166
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
167
|
+
request('lolesports-tournaments', params, response_type: response_type)
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
private
|
|
171
|
+
|
|
172
|
+
# POST operations take their JSON body under the body parameter name or "body".
|
|
173
|
+
def request_body(operation, params)
|
|
174
|
+
name = operation["bodyParam"]
|
|
175
|
+
return nil if name.nil?
|
|
176
|
+
value = params.key?(name) ? params[name] : params["body"]
|
|
177
|
+
if value.nil?
|
|
178
|
+
raise Errors::ClientError.new("missing request body: #{name}", operation_id: operation["id"]) if operation["bodyRequired"]
|
|
179
|
+
return nil
|
|
180
|
+
end
|
|
181
|
+
value.is_a?(String) ? value : JSON.generate(value)
|
|
182
|
+
end
|
|
183
|
+
|
|
184
|
+
def build_url(operation, params)
|
|
185
|
+
known = operation["params"].map { |param| param["name"] }
|
|
186
|
+
known << "body" if operation["bodyParam"]
|
|
187
|
+
unknown = params.keys - known
|
|
188
|
+
raise Errors::ClientError.new("unknown parameters: #{unknown.join(', ')}", operation_id: operation["id"]) unless unknown.empty?
|
|
189
|
+
path = operation["path"].dup
|
|
190
|
+
operation["params"].select { |param| param["in"] == "path" }.each do |param|
|
|
191
|
+
value = params[param["name"]]
|
|
192
|
+
raise Errors::ClientError.new("missing path parameter: #{param['name']}", operation_id: operation["id"]) if value.nil?
|
|
193
|
+
path.sub!("{" + param["name"] + "}", percent_encode(value.to_s))
|
|
194
|
+
end
|
|
195
|
+
pairs = []
|
|
196
|
+
operation["queryParams"].each do |param|
|
|
197
|
+
name = param["name"]
|
|
198
|
+
value = params.key?(name) ? params[name] : param["default"]
|
|
199
|
+
if value.nil?
|
|
200
|
+
raise Errors::ClientError.new("missing query parameter: #{name}", operation_id: operation["id"]) if param["required"]
|
|
201
|
+
next
|
|
202
|
+
end
|
|
203
|
+
enum_values = param["enum"] || (param["items"] && param["items"]["enum"])
|
|
204
|
+
if enum_values && !(value.is_a?(Array) ? value : [value]).all? { |item| enum_values.map(&:to_s).include?(item.to_s) }
|
|
205
|
+
raise Errors::ClientError.new("invalid value for #{name}", operation_id: operation["id"])
|
|
206
|
+
end
|
|
207
|
+
if value.is_a?(Array)
|
|
208
|
+
format = param["collectionFormat"] || "csv"
|
|
209
|
+
if format == "multi"
|
|
210
|
+
value.each { |item| pairs << [name, scalar(item)] }
|
|
211
|
+
else
|
|
212
|
+
separator = {"csv" => ",", "ssv" => " ", "tsv" => "\t", "pipes" => "|"}[format] || ","
|
|
213
|
+
pairs << [name, value.map { |item| scalar(item) }.join(separator)]
|
|
214
|
+
end
|
|
215
|
+
else
|
|
216
|
+
pairs << [name, scalar(value)]
|
|
217
|
+
end
|
|
218
|
+
end
|
|
219
|
+
query = pairs.map { |name, value| "#{percent_encode(name)}=#{percent_encode(value)}" }.join("&")
|
|
220
|
+
@base_url + path + (query.empty? ? "" : "?" + query)
|
|
221
|
+
end
|
|
222
|
+
|
|
223
|
+
def scalar(value)
|
|
224
|
+
value == true ? "true" : (value == false ? "false" : value.to_s)
|
|
225
|
+
end
|
|
226
|
+
|
|
227
|
+
def percent_encode(value)
|
|
228
|
+
URI::DEFAULT_PARSER.escape(value.to_s, /[^A-Za-z0-9\-._~]/)
|
|
229
|
+
end
|
|
230
|
+
|
|
231
|
+
def parse_response(body, content_type, operation, params, response_type)
|
|
232
|
+
type = response_type.to_s
|
|
233
|
+
raise Errors::ClientError.new("response_type must be auto, json, or text", operation_id: operation["id"]) unless %w[auto json text].include?(type)
|
|
234
|
+
format = operation["params"].find { |param| param["name"] == "format" }
|
|
235
|
+
text_formats = format && format["enum"] ? format["enum"].reject { |value| %w[json application/json].include?(value.to_s.downcase) } : []
|
|
236
|
+
raw_format = params["format"] && text_formats.include?(params["format"].to_s)
|
|
237
|
+
json_format = format && format["enum"] && format["enum"].any? { |value| %w[json application/json].include?(value.to_s.downcase) } && %w[json application/json].include?(params["format"].to_s.downcase)
|
|
238
|
+
is_json = json_format || content_type.to_s.downcase.include?("json") || operation["produces"] == ["application/json"]
|
|
239
|
+
return body if type == "text" || raw_format || (type == "auto" && !is_json)
|
|
240
|
+
JSON.parse(body)
|
|
241
|
+
rescue JSON::ParserError => error
|
|
242
|
+
raise Errors::Error.new("invalid JSON response from Crawlora: #{error.message}", operation_id: operation["id"], body: body)
|
|
243
|
+
end
|
|
244
|
+
|
|
245
|
+
public
|
|
246
|
+
end
|
|
247
|
+
end
|
|
248
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: crawlora-lolesports
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.1.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Crawlora
|
|
8
|
+
autorequire:
|
|
9
|
+
bindir: bin
|
|
10
|
+
cert_chain: []
|
|
11
|
+
date: 2026-11-04 00:00:00.000000000 Z
|
|
12
|
+
dependencies: []
|
|
13
|
+
description: Ruby client for Crawlora's hosted LoL Esports API. Covers leagues, schedules,
|
|
14
|
+
live and completed events, teams, players, and game details across 13 endpoints.
|
|
15
|
+
email:
|
|
16
|
+
executables: []
|
|
17
|
+
extensions: []
|
|
18
|
+
extra_rdoc_files: []
|
|
19
|
+
files:
|
|
20
|
+
- CHANGELOG.md
|
|
21
|
+
- LICENSE
|
|
22
|
+
- README.md
|
|
23
|
+
- lib/crawlora/lolesports.rb
|
|
24
|
+
- lib/crawlora/lolesports/client.rb
|
|
25
|
+
- lib/crawlora/lolesports/version.rb
|
|
26
|
+
homepage: https://crawlora.net/?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=lolesports-ruby-homepage
|
|
27
|
+
licenses:
|
|
28
|
+
- MIT
|
|
29
|
+
metadata:
|
|
30
|
+
source_code_uri: https://github.com/Crawlora-org/crawlora-lolesports
|
|
31
|
+
documentation_uri: https://github.com/Crawlora-org/crawlora-lolesports/blob/main/ruby/README.md
|
|
32
|
+
rubygems_mfa_required: 'true'
|
|
33
|
+
post_install_message:
|
|
34
|
+
rdoc_options: []
|
|
35
|
+
require_paths:
|
|
36
|
+
- lib
|
|
37
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
38
|
+
requirements:
|
|
39
|
+
- - ">="
|
|
40
|
+
- !ruby/object:Gem::Version
|
|
41
|
+
version: '2.6'
|
|
42
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
43
|
+
requirements:
|
|
44
|
+
- - ">="
|
|
45
|
+
- !ruby/object:Gem::Version
|
|
46
|
+
version: '0'
|
|
47
|
+
requirements: []
|
|
48
|
+
rubygems_version: 3.4.19
|
|
49
|
+
signing_key:
|
|
50
|
+
specification_version: 4
|
|
51
|
+
summary: LoL Esports API client for Crawlora (13 endpoints)
|
|
52
|
+
test_files: []
|