crawlora-fortnite 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 +50 -0
- data/lib/crawlora/fortnite/client.rb +236 -0
- data/lib/crawlora/fortnite/version.rb +5 -0
- data/lib/crawlora/fortnite.rb +2 -0
- metadata +52 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: a0f04af4c866534085de95a58458d0354e094b4042eae06bab871e1ea5e156ea
|
|
4
|
+
data.tar.gz: b68a0410ec7271871b614c84a5b9ac637b1ec18f3c5e360a45bbbbccc6a09a7a
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 60947dbf11eb0a28975277b1bff6f064e14e52d8b6ac9d0d74230d6fe6fc57420298379e5b5116cc2fa7e9410cd0d60c437a2c024cf94e741617c6b4bed912f2
|
|
7
|
+
data.tar.gz: 87dbafb6d3b156005e4c54d61204c713e9bbfbd4bfbb3e16ef23c97677f777faed6fdb933f248c982707818c3808592cfdd818179fef77a1163b12c57c33d146
|
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,50 @@
|
|
|
1
|
+
# Crawlora Fortnite API client for Ruby (`crawlora-fortnite`)
|
|
2
|
+
|
|
3
|
+
This Ruby gem calls Crawlora's hosted Fortnite API at `https://api.crawlora.net/api/v1`. It exposes 10 endpoints covering public island discovery, genres, rankings, and engagement metrics; it does not call or scrape Fortnite directly. Requests require your Crawlora API key and use your account's service plan.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```ruby
|
|
8
|
+
gem "crawlora-fortnite"
|
|
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=fortnite-ruby-signup), open the [Crawlora console](https://crawlora.net/app?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=fortnite-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/fortnite"
|
|
16
|
+
|
|
17
|
+
client = Crawlora::Fortnite::Client.new
|
|
18
|
+
result = client.request("fortnite-ecosystem-metric", JSON.parse("{\"interval\": \"day\", \"metric\": \"in-client-peak-ccu\"}"))
|
|
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 10 API operations.
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
client = Crawlora::Fortnite::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 Fortnite API endpoints
|
|
34
|
+
|
|
35
|
+
Browse every route included in this gem. The [endpoint reference](https://github.com/Crawlora-org/crawlora-fortnite/blob/main/docs/usage.md) includes parameter and response details.
|
|
36
|
+
|
|
37
|
+
| Method | Endpoint | API operation | Description |
|
|
38
|
+
| --- | --- | --- | --- |
|
|
39
|
+
| `GET` | `/fortnite/ecosystem-metric` | `fortnite-ecosystem-metric` | Get one Fortnite ecosystem metric |
|
|
40
|
+
| `GET` | `/fortnite/ecosystem-metrics` | `fortnite-ecosystem-metrics` | Get Fortnite ecosystem metrics |
|
|
41
|
+
| `GET` | `/fortnite/enums` | `fortnite-enums` | List Fortnite metric enums |
|
|
42
|
+
| `GET` | `/fortnite/genre-rankings` | `fortnite-genre-rankings` | Get rankings for a Fortnite genre |
|
|
43
|
+
| `GET` | `/fortnite/genres` | `fortnite-genres` | List Fortnite genres |
|
|
44
|
+
| `GET` | `/fortnite/island` | `fortnite-island` | Get a Fortnite island |
|
|
45
|
+
| `GET` | `/fortnite/island-metric` | `fortnite-island-metric` | Get one Fortnite island metric |
|
|
46
|
+
| `GET` | `/fortnite/island-metrics` | `fortnite-island-metrics` | Get Fortnite island metrics |
|
|
47
|
+
| `GET` | `/fortnite/island-rankings` | `fortnite-island-rankings` | Get Fortnite island rankings |
|
|
48
|
+
| `GET` | `/fortnite/islands` | `fortnite-islands` | Discover Fortnite islands |
|
|
49
|
+
|
|
50
|
+
See [Crawlora](https://crawlora.net/?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=fortnite-ruby-homepage), the [API documentation](https://crawlora.net/docs?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=fortnite-ruby-api-docs), and [the package repository](https://github.com/Crawlora-org/crawlora-fortnite) for account setup, the API operation reference, and release history.
|
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
require "json"
|
|
2
|
+
require "net/http"
|
|
3
|
+
require "uri"
|
|
4
|
+
|
|
5
|
+
module Crawlora
|
|
6
|
+
module Fortnite
|
|
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
|
+
{"fortnite-ecosystem-metric": {"bodyParam": null, "bodyRequired": false, "id": "fortnite-ecosystem-metric", "method": "GET", "params": [{"description": "Bucket size", "enum": ["day", "hour", "minute"], "in": "query", "name": "interval", "required": true, "type": "string", "x-example": "day"}, {"description": "Native metric path variant", "enum": ["in-client-peak-ccu", "in-match-peak-ccu"], "in": "query", "name": "metric", "required": true, "type": "string", "x-example": "in-client-peak-ccu"}, {"description": "Inclusive ISO-8601 start time, within seven days", "in": "query", "name": "from", "type": "string"}, {"description": "Exclusive ISO-8601 end time", "in": "query", "name": "to", "type": "string"}], "path": "/fortnite/ecosystem-metric", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["day", "hour", "minute"], "in": "query", "name": "interval", "required": true, "type": "string"}, {"enum": ["in-client-peak-ccu", "in-match-peak-ccu"], "in": "query", "name": "metric", "required": true, "type": "string"}, {"in": "query", "name": "from", "type": "string"}, {"in": "query", "name": "to", "type": "string"}], "security": ["ApiKeyAuth"]}, "fortnite-ecosystem-metrics": {"bodyParam": null, "bodyRequired": false, "id": "fortnite-ecosystem-metrics", "method": "GET", "params": [{"description": "Bucket size", "enum": ["day", "hour", "minute"], "in": "query", "name": "interval", "required": true, "type": "string", "x-example": "day"}, {"collectionFormat": "csv", "description": "Optional repeatable metric filter", "in": "query", "items": {"enum": ["inMatchPeakCCU", "inClientPeakCCU"], "type": "string"}, "name": "metrics", "type": "array"}, {"description": "Inclusive ISO-8601 start time, within seven days", "in": "query", "name": "from", "type": "string"}, {"description": "Exclusive ISO-8601 end time", "in": "query", "name": "to", "type": "string"}], "path": "/fortnite/ecosystem-metrics", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["day", "hour", "minute"], "in": "query", "name": "interval", "required": true, "type": "string"}, {"collectionFormat": "csv", "enum": ["inMatchPeakCCU", "inClientPeakCCU"], "in": "query", "name": "metrics", "type": "array"}, {"in": "query", "name": "from", "type": "string"}, {"in": "query", "name": "to", "type": "string"}], "security": ["ApiKeyAuth"]}, "fortnite-enums": {"bodyParam": null, "bodyRequired": false, "id": "fortnite-enums", "method": "GET", "params": [], "path": "/fortnite/enums", "pathParams": [], "produces": ["application/json"], "queryParams": [], "security": ["ApiKeyAuth"]}, "fortnite-genre-rankings": {"bodyParam": null, "bodyRequired": false, "id": "fortnite-genre-rankings", "method": "GET", "params": [{"description": "Genre slug from fortnite_genres", "in": "query", "name": "slug", "required": true, "type": "string"}, {"description": "Hourly point-in-time snapshot, at most seven days old", "in": "query", "name": "at", "type": "string"}, {"description": "Return results after this upstream cursor", "in": "query", "name": "after", "type": "string"}, {"description": "Return results before this upstream cursor", "in": "query", "name": "before", "type": "string"}, {"description": "Upstream page size, 1 through 1000", "in": "query", "name": "size", "type": "integer"}], "path": "/fortnite/genre-rankings", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "slug", "required": true, "type": "string"}, {"in": "query", "name": "at", "type": "string"}, {"in": "query", "name": "after", "type": "string"}, {"in": "query", "name": "before", "type": "string"}, {"in": "query", "name": "size", "type": "integer"}], "security": ["ApiKeyAuth"]}, "fortnite-genres": {"bodyParam": null, "bodyRequired": false, "id": "fortnite-genres", "method": "GET", "params": [], "path": "/fortnite/genres", "pathParams": [], "produces": ["application/json"], "queryParams": [], "security": ["ApiKeyAuth"]}, "fortnite-island": {"bodyParam": null, "bodyRequired": false, "id": "fortnite-island", "method": "GET", "params": [{"description": "Island code or first-party display name", "in": "query", "name": "code", "required": true, "type": "string"}], "path": "/fortnite/island", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "code", "required": true, "type": "string"}], "security": ["ApiKeyAuth"]}, "fortnite-island-metric": {"bodyParam": null, "bodyRequired": false, "id": "fortnite-island-metric", "method": "GET", "params": [{"description": "Island code or first-party display name", "in": "query", "name": "code", "required": true, "type": "string"}, {"description": "Bucket size", "enum": ["day", "hour", "minute"], "in": "query", "name": "interval", "required": true, "type": "string", "x-example": "day"}, {"description": "Native metric path variant", "enum": ["peak-ccu", "favorites", "minutes-played", "average-minutes-per-player", "recommendations", "unique-players", "plays", "retention"], "in": "query", "name": "metric", "required": true, "type": "string", "x-example": "peak-ccu"}, {"description": "Inclusive ISO-8601 start time, within seven days", "in": "query", "name": "from", "type": "string"}, {"description": "Exclusive ISO-8601 end time", "in": "query", "name": "to", "type": "string"}], "path": "/fortnite/island-metric", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "code", "required": true, "type": "string"}, {"enum": ["day", "hour", "minute"], "in": "query", "name": "interval", "required": true, "type": "string"}, {"enum": ["peak-ccu", "favorites", "minutes-played", "average-minutes-per-player", "recommendations", "unique-players", "plays", "retention"], "in": "query", "name": "metric", "required": true, "type": "string"}, {"in": "query", "name": "from", "type": "string"}, {"in": "query", "name": "to", "type": "string"}], "security": ["ApiKeyAuth"]}, "fortnite-island-metrics": {"bodyParam": null, "bodyRequired": false, "id": "fortnite-island-metrics", "method": "GET", "params": [{"description": "Island code or first-party display name", "in": "query", "name": "code", "required": true, "type": "string"}, {"description": "Optional bucket size", "enum": ["day", "hour", "minute"], "in": "query", "name": "interval", "type": "string"}, {"collectionFormat": "csv", "description": "Optional repeatable metric filter", "in": "query", "items": {"enum": ["averageMinutesPerPlayer", "peakCCU", "favorites", "minutesPlayed", "recommendations", "plays", "uniquePlayers", "retention"], "type": "string"}, "name": "metrics", "type": "array"}, {"description": "Inclusive ISO-8601 start time, within seven days", "in": "query", "name": "from", "type": "string"}, {"description": "Exclusive ISO-8601 end time", "in": "query", "name": "to", "type": "string"}], "path": "/fortnite/island-metrics", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "code", "required": true, "type": "string"}, {"enum": ["day", "hour", "minute"], "in": "query", "name": "interval", "type": "string"}, {"collectionFormat": "csv", "enum": ["averageMinutesPerPlayer", "peakCCU", "favorites", "minutesPlayed", "recommendations", "plays", "uniquePlayers", "retention"], "in": "query", "name": "metrics", "type": "array"}, {"in": "query", "name": "from", "type": "string"}, {"in": "query", "name": "to", "type": "string"}], "security": ["ApiKeyAuth"]}, "fortnite-island-rankings": {"bodyParam": null, "bodyRequired": false, "id": "fortnite-island-rankings", "method": "GET", "params": [{"description": "Island code or first-party display name", "in": "query", "name": "code", "required": true, "type": "string"}, {"description": "Inclusive ISO-8601 start time, within seven days", "in": "query", "name": "from", "type": "string"}, {"description": "Exclusive ISO-8601 end time", "in": "query", "name": "to", "type": "string"}], "path": "/fortnite/island-rankings", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "code", "required": true, "type": "string"}, {"in": "query", "name": "from", "type": "string"}, {"in": "query", "name": "to", "type": "string"}], "security": ["ApiKeyAuth"]}, "fortnite-islands": {"bodyParam": null, "bodyRequired": false, "id": "fortnite-islands", "method": "GET", "params": [{"description": "Return islands after this upstream cursor", "in": "query", "name": "after", "type": "string"}, {"description": "Return islands before this upstream cursor", "in": "query", "name": "before", "type": "string"}, {"description": "Upstream page size, 1 through 1000", "in": "query", "name": "size", "type": "integer"}], "path": "/fortnite/islands", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "after", "type": "string"}, {"in": "query", "name": "before", "type": "string"}, {"in": "query", "name": "size", "type": "integer"}], "security": ["ApiKeyAuth"]}}
|
|
23
|
+
JSON
|
|
24
|
+
OPERATION_IDS = JSON.parse(<<~'JSON').freeze
|
|
25
|
+
["fortnite-ecosystem-metric", "fortnite-ecosystem-metrics", "fortnite-enums", "fortnite-genre-rankings", "fortnite-genres", "fortnite-island", "fortnite-island-metric", "fortnite-island-metrics", "fortnite-island-rankings", "fortnite-islands"]
|
|
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-fortnite-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('ecosystem_metric') do |**params|
|
|
118
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
119
|
+
request('fortnite-ecosystem-metric', params, response_type: response_type)
|
|
120
|
+
end
|
|
121
|
+
define_method('ecosystem_metrics') do |**params|
|
|
122
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
123
|
+
request('fortnite-ecosystem-metrics', params, response_type: response_type)
|
|
124
|
+
end
|
|
125
|
+
define_method('enums') do |**params|
|
|
126
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
127
|
+
request('fortnite-enums', params, response_type: response_type)
|
|
128
|
+
end
|
|
129
|
+
define_method('genre_rankings') do |**params|
|
|
130
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
131
|
+
request('fortnite-genre-rankings', params, response_type: response_type)
|
|
132
|
+
end
|
|
133
|
+
define_method('genres') do |**params|
|
|
134
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
135
|
+
request('fortnite-genres', params, response_type: response_type)
|
|
136
|
+
end
|
|
137
|
+
define_method('island') do |**params|
|
|
138
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
139
|
+
request('fortnite-island', params, response_type: response_type)
|
|
140
|
+
end
|
|
141
|
+
define_method('island_metric') do |**params|
|
|
142
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
143
|
+
request('fortnite-island-metric', params, response_type: response_type)
|
|
144
|
+
end
|
|
145
|
+
define_method('island_metrics') do |**params|
|
|
146
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
147
|
+
request('fortnite-island-metrics', params, response_type: response_type)
|
|
148
|
+
end
|
|
149
|
+
define_method('island_rankings') do |**params|
|
|
150
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
151
|
+
request('fortnite-island-rankings', params, response_type: response_type)
|
|
152
|
+
end
|
|
153
|
+
define_method('islands') do |**params|
|
|
154
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
155
|
+
request('fortnite-islands', params, response_type: response_type)
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
private
|
|
159
|
+
|
|
160
|
+
# POST operations take their JSON body under the body parameter name or "body".
|
|
161
|
+
def request_body(operation, params)
|
|
162
|
+
name = operation["bodyParam"]
|
|
163
|
+
return nil if name.nil?
|
|
164
|
+
value = params.key?(name) ? params[name] : params["body"]
|
|
165
|
+
if value.nil?
|
|
166
|
+
raise Errors::ClientError.new("missing request body: #{name}", operation_id: operation["id"]) if operation["bodyRequired"]
|
|
167
|
+
return nil
|
|
168
|
+
end
|
|
169
|
+
value.is_a?(String) ? value : JSON.generate(value)
|
|
170
|
+
end
|
|
171
|
+
|
|
172
|
+
def build_url(operation, params)
|
|
173
|
+
known = operation["params"].map { |param| param["name"] }
|
|
174
|
+
known << "body" if operation["bodyParam"]
|
|
175
|
+
unknown = params.keys - known
|
|
176
|
+
raise Errors::ClientError.new("unknown parameters: #{unknown.join(', ')}", operation_id: operation["id"]) unless unknown.empty?
|
|
177
|
+
path = operation["path"].dup
|
|
178
|
+
operation["params"].select { |param| param["in"] == "path" }.each do |param|
|
|
179
|
+
value = params[param["name"]]
|
|
180
|
+
raise Errors::ClientError.new("missing path parameter: #{param['name']}", operation_id: operation["id"]) if value.nil?
|
|
181
|
+
path.sub!("{" + param["name"] + "}", percent_encode(value.to_s))
|
|
182
|
+
end
|
|
183
|
+
pairs = []
|
|
184
|
+
operation["queryParams"].each do |param|
|
|
185
|
+
name = param["name"]
|
|
186
|
+
value = params.key?(name) ? params[name] : param["default"]
|
|
187
|
+
if value.nil?
|
|
188
|
+
raise Errors::ClientError.new("missing query parameter: #{name}", operation_id: operation["id"]) if param["required"]
|
|
189
|
+
next
|
|
190
|
+
end
|
|
191
|
+
enum_values = param["enum"] || (param["items"] && param["items"]["enum"])
|
|
192
|
+
if enum_values && !(value.is_a?(Array) ? value : [value]).all? { |item| enum_values.map(&:to_s).include?(item.to_s) }
|
|
193
|
+
raise Errors::ClientError.new("invalid value for #{name}", operation_id: operation["id"])
|
|
194
|
+
end
|
|
195
|
+
if value.is_a?(Array)
|
|
196
|
+
format = param["collectionFormat"] || "csv"
|
|
197
|
+
if format == "multi"
|
|
198
|
+
value.each { |item| pairs << [name, scalar(item)] }
|
|
199
|
+
else
|
|
200
|
+
separator = {"csv" => ",", "ssv" => " ", "tsv" => "\t", "pipes" => "|"}[format] || ","
|
|
201
|
+
pairs << [name, value.map { |item| scalar(item) }.join(separator)]
|
|
202
|
+
end
|
|
203
|
+
else
|
|
204
|
+
pairs << [name, scalar(value)]
|
|
205
|
+
end
|
|
206
|
+
end
|
|
207
|
+
query = pairs.map { |name, value| "#{percent_encode(name)}=#{percent_encode(value)}" }.join("&")
|
|
208
|
+
@base_url + path + (query.empty? ? "" : "?" + query)
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
def scalar(value)
|
|
212
|
+
value == true ? "true" : (value == false ? "false" : value.to_s)
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
def percent_encode(value)
|
|
216
|
+
URI::DEFAULT_PARSER.escape(value.to_s, /[^A-Za-z0-9\-._~]/)
|
|
217
|
+
end
|
|
218
|
+
|
|
219
|
+
def parse_response(body, content_type, operation, params, response_type)
|
|
220
|
+
type = response_type.to_s
|
|
221
|
+
raise Errors::ClientError.new("response_type must be auto, json, or text", operation_id: operation["id"]) unless %w[auto json text].include?(type)
|
|
222
|
+
format = operation["params"].find { |param| param["name"] == "format" }
|
|
223
|
+
text_formats = format && format["enum"] ? format["enum"].reject { |value| %w[json application/json].include?(value.to_s.downcase) } : []
|
|
224
|
+
raw_format = params["format"] && text_formats.include?(params["format"].to_s)
|
|
225
|
+
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)
|
|
226
|
+
is_json = json_format || content_type.to_s.downcase.include?("json") || operation["produces"] == ["application/json"]
|
|
227
|
+
return body if type == "text" || raw_format || (type == "auto" && !is_json)
|
|
228
|
+
JSON.parse(body)
|
|
229
|
+
rescue JSON::ParserError => error
|
|
230
|
+
raise Errors::Error.new("invalid JSON response from Crawlora: #{error.message}", operation_id: operation["id"], body: body)
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
public
|
|
234
|
+
end
|
|
235
|
+
end
|
|
236
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: crawlora-fortnite
|
|
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-13 00:00:00.000000000 Z
|
|
12
|
+
dependencies: []
|
|
13
|
+
description: Ruby client for Crawlora's hosted Fortnite API. Covers public island
|
|
14
|
+
discovery, genres, rankings, and engagement metrics across 10 endpoints.
|
|
15
|
+
email:
|
|
16
|
+
executables: []
|
|
17
|
+
extensions: []
|
|
18
|
+
extra_rdoc_files: []
|
|
19
|
+
files:
|
|
20
|
+
- CHANGELOG.md
|
|
21
|
+
- LICENSE
|
|
22
|
+
- README.md
|
|
23
|
+
- lib/crawlora/fortnite.rb
|
|
24
|
+
- lib/crawlora/fortnite/client.rb
|
|
25
|
+
- lib/crawlora/fortnite/version.rb
|
|
26
|
+
homepage: https://crawlora.net/?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=fortnite-ruby-homepage
|
|
27
|
+
licenses:
|
|
28
|
+
- MIT
|
|
29
|
+
metadata:
|
|
30
|
+
source_code_uri: https://github.com/Crawlora-org/crawlora-fortnite
|
|
31
|
+
documentation_uri: https://github.com/Crawlora-org/crawlora-fortnite/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: Fortnite API client for Crawlora (10 endpoints)
|
|
52
|
+
test_files: []
|