crawlora-reelshort 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 +51 -0
- data/lib/crawlora/reelshort/client.rb +240 -0
- data/lib/crawlora/reelshort/version.rb +5 -0
- data/lib/crawlora/reelshort.rb +2 -0
- metadata +52 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 4a96a1c5ffe0d2e3ff33869a1e027b75ebfa5717a329e7e49852c9dca874830d
|
|
4
|
+
data.tar.gz: 83ec94ee57609f55d6ebed3b63b30c1de1530472e4ab11a6a0bd4aecb14ecb88
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 077d13e30b5bb1c75e05905b537aa532d4cc6233e7ede985058b01eccca8f585efad1e340b35f78d932314ba8cc0ddd75bd61a0ee7d96c2f38f4eec11f7a1007
|
|
7
|
+
data.tar.gz: 86e22ca3790dd23b321403eda3853f407f8dc02a1391e9317b1aaf49676abb07239b883c1a9909071f23159ad624e9797ec389ab8ccec334e653dc9448cda0cb
|
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,51 @@
|
|
|
1
|
+
# Crawlora ReelShort API client for Ruby (`crawlora-reelshort`)
|
|
2
|
+
|
|
3
|
+
This Ruby gem calls Crawlora's hosted ReelShort API at `https://api.crawlora.net/api/v1`. It exposes 11 endpoints covering title discovery, search, movie details, new releases, and public Fandom articles; it does not call or scrape ReelShort directly. Requests require your Crawlora API key and use your account's service plan.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```ruby
|
|
8
|
+
gem "crawlora-reelshort"
|
|
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=reelshort-ruby-signup), open the [Crawlora console](https://crawlora.net/app?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=reelshort-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/reelshort"
|
|
16
|
+
|
|
17
|
+
client = Crawlora::Reelshort::Client.new
|
|
18
|
+
result = client.request("reelshort-search", JSON.parse("{\"keywords\": \"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 11 API operations.
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
client = Crawlora::Reelshort::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 ReelShort API endpoints
|
|
34
|
+
|
|
35
|
+
Browse every route included in this gem. The [endpoint reference](https://github.com/Crawlora-org/crawlora-reelshort/blob/main/docs/usage.md) includes parameter and response details.
|
|
36
|
+
|
|
37
|
+
| Method | Endpoint | API operation | Description |
|
|
38
|
+
| --- | --- | --- | --- |
|
|
39
|
+
| `GET` | `/reelshort/fandom-categories` | `reelshort-fandom-categories` | List ReelShort Fandom's article categories |
|
|
40
|
+
| `GET` | `/reelshort/fandom-post` | `reelshort-fandom-post` | Get a ReelShort Fandom article |
|
|
41
|
+
| `GET` | `/reelshort/fandom-posts` | `reelshort-fandom-posts` | List ReelShort Fandom articles |
|
|
42
|
+
| `GET` | `/reelshort/home` | `reelshort-home` | List ReelShort's home page shelves |
|
|
43
|
+
| `GET` | `/reelshort/movie` | `reelshort-movie` | Get a ReelShort short drama and its episodes |
|
|
44
|
+
| `GET` | `/reelshort/new-releases` | `reelshort-new-releases` | List ReelShort's curated New Release titles |
|
|
45
|
+
| `GET` | `/reelshort/search` | `reelshort-search` | Search ReelShort short dramas by title |
|
|
46
|
+
| `GET` | `/reelshort/shelf` | `reelshort-shelf` | Get a whole ReelShort shelf |
|
|
47
|
+
| `GET` | `/reelshort/tag-books` | `reelshort-tag-books` | List the ReelShort titles carrying a tag |
|
|
48
|
+
| `GET` | `/reelshort/tag-search` | `reelshort-tag-search` | Search ReelShort tags by text |
|
|
49
|
+
| `GET` | `/reelshort/tags` | `reelshort-tags` | List ReelShort's featured tags in one category |
|
|
50
|
+
|
|
51
|
+
See [Crawlora](https://crawlora.net/?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=reelshort-ruby-homepage), the [API documentation](https://crawlora.net/docs?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=reelshort-ruby-api-docs), and [the package repository](https://github.com/Crawlora-org/crawlora-reelshort) for account setup, the API operation reference, and release history.
|
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
require "json"
|
|
2
|
+
require "net/http"
|
|
3
|
+
require "uri"
|
|
4
|
+
|
|
5
|
+
module Crawlora
|
|
6
|
+
module Reelshort
|
|
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
|
+
{"reelshort-fandom-categories": {"bodyParam": null, "bodyRequired": false, "id": "reelshort-fandom-categories", "method": "GET", "params": [], "path": "/reelshort/fandom-categories", "pathParams": [], "produces": ["application/json"], "queryParams": [], "security": ["ApiKeyAuth"]}, "reelshort-fandom-post": {"bodyParam": null, "bodyRequired": false, "id": "reelshort-fandom-post", "method": "GET", "params": [{"description": "Article id (digits), article slug, or a reelshort.com/fandom URL", "in": "query", "name": "id", "required": true, "type": "string", "x-example": "54181"}], "path": "/reelshort/fandom-post", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "id", "required": true, "type": "string"}], "security": ["ApiKeyAuth"]}, "reelshort-fandom-posts": {"bodyParam": null, "bodyRequired": false, "id": "reelshort-fandom-posts", "method": "GET", "params": [{"description": "Text to search articles for, up to 100 characters", "in": "query", "name": "search", "type": "string", "x-example": "alpha"}, {"description": "Category slug: general-topic, movie-cast-list, top-movie-stories, where-to-watch or where-to-watch-2", "enum": ["general-topic", "movie-cast-list", "top-movie-stories", "where-to-watch", "where-to-watch-2"], "in": "query", "name": "category", "type": "string", "x-example": "movie-cast-list"}, {"description": "Page number, 1 to 10000; defaults to 1", "in": "query", "name": "page", "type": "integer", "x-example": 2}, {"description": "Page size, 1 to 100; defaults to 10", "in": "query", "name": "limit", "type": "integer", "x-example": 10}], "path": "/reelshort/fandom-posts", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "search", "type": "string"}, {"enum": ["general-topic", "movie-cast-list", "top-movie-stories", "where-to-watch", "where-to-watch-2"], "in": "query", "name": "category", "type": "string"}, {"in": "query", "name": "page", "type": "integer"}, {"in": "query", "name": "limit", "type": "integer"}], "security": ["ApiKeyAuth"]}, "reelshort-home": {"bodyParam": null, "bodyRequired": false, "id": "reelshort-home", "method": "GET", "params": [{"description": "Site locale, one of: en, es, pt, fr, de, it, ja, ko, th, id, tr, ar, ru, pl, ro, cs, bg, vi, zh-TW; defaults to en. Titles and tags are translated", "enum": ["en", "es", "pt", "fr", "de", "it", "ja", "ko", "th", "id", "tr", "ar", "ru", "pl", "ro", "cs", "bg", "vi", "zh-TW"], "in": "query", "name": "language", "type": "string", "x-example": "es"}], "path": "/reelshort/home", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["en", "es", "pt", "fr", "de", "it", "ja", "ko", "th", "id", "tr", "ar", "ru", "pl", "ro", "cs", "bg", "vi", "zh-TW"], "in": "query", "name": "language", "type": "string"}], "security": ["ApiKeyAuth"]}, "reelshort-movie": {"bodyParam": null, "bodyRequired": false, "id": "reelshort-movie", "method": "GET", "params": [{"description": "Title id (24 hex characters) from reelshort-home, reelshort-shelf or reelshort-search, or a reelshort.com movie or episode URL", "in": "query", "name": "id", "required": true, "type": "string", "x-example": "6a8752ac7c23cb02b40f062b"}], "path": "/reelshort/movie", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "id", "required": true, "type": "string"}], "security": ["ApiKeyAuth"]}, "reelshort-new-releases": {"bodyParam": null, "bodyRequired": false, "id": "reelshort-new-releases", "method": "GET", "params": [{"description": "A 24-character title id, from reelshort-movie, reelshort-shelf or reelshort-home; required by ReelShort but not observed to change the result", "in": "query", "name": "book_id", "required": true, "type": "string", "x-example": "6aac85383511c0b6df0eec87"}, {"description": "Site language, one of en, es, pt, fr, de, it, ja, ko, th, id, tr, ar, ru, pl, ro, cs, bg, vi, zh-TW; defaults to en", "enum": ["en", "es", "pt", "fr", "de", "it", "ja", "ko", "th", "id", "tr", "ar", "ru", "pl", "ro", "cs", "bg", "vi", "zh-TW"], "in": "query", "name": "language", "type": "string", "x-example": "en"}], "path": "/reelshort/new-releases", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "book_id", "required": true, "type": "string"}, {"enum": ["en", "es", "pt", "fr", "de", "it", "ja", "ko", "th", "id", "tr", "ar", "ru", "pl", "ro", "cs", "bg", "vi", "zh-TW"], "in": "query", "name": "language", "type": "string"}], "security": ["ApiKeyAuth"]}, "reelshort-search": {"bodyParam": null, "bodyRequired": false, "id": "reelshort-search", "method": "GET", "params": [{"description": "Title text to search for, up to 100 characters", "in": "query", "name": "keywords", "required": true, "type": "string", "x-example": "billionaire"}, {"description": "Page number, 1 to 200; defaults to 1. Each page holds 12 titles", "in": "query", "name": "page", "type": "integer", "x-example": 2}, {"description": "Site locale, one of: en, es, pt, fr, de, it, ja, ko, th, id, tr, ar, ru, pl, ro, cs, bg, vi, zh-TW; defaults to en. Titles and tags are translated", "enum": ["en", "es", "pt", "fr", "de", "it", "ja", "ko", "th", "id", "tr", "ar", "ru", "pl", "ro", "cs", "bg", "vi", "zh-TW"], "in": "query", "name": "language", "type": "string", "x-example": "es"}], "path": "/reelshort/search", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "keywords", "required": true, "type": "string"}, {"in": "query", "name": "page", "type": "integer"}, {"enum": ["en", "es", "pt", "fr", "de", "it", "ja", "ko", "th", "id", "tr", "ar", "ru", "pl", "ro", "cs", "bg", "vi", "zh-TW"], "in": "query", "name": "language", "type": "string"}], "security": ["ApiKeyAuth"]}, "reelshort-shelf": {"bodyParam": null, "bodyRequired": false, "id": "reelshort-shelf", "method": "GET", "params": [{"description": "Shelf id from reelshort-home (for example 51003506), or a reelshort.com shelf URL", "in": "query", "name": "id", "required": true, "type": "string", "x-example": "51003506"}], "path": "/reelshort/shelf", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "id", "required": true, "type": "string"}], "security": ["ApiKeyAuth"]}, "reelshort-tag-books": {"bodyParam": null, "bodyRequired": false, "id": "reelshort-tag-books", "method": "GET", "params": [{"description": "Tag id, 24 lowercase hex characters, from reelshort-tags, reelshort-tag-search or reelshort-movie", "in": "query", "name": "tag_id", "required": true, "type": "string", "x-example": "676d210e4582b53a14081aab"}, {"description": "Page number, 1 to 10000; defaults to 1", "in": "query", "name": "page", "type": "integer", "x-example": 1}, {"description": "Page size, 1 to 100; defaults to 20", "in": "query", "name": "limit", "type": "integer", "x-example": 20}, {"description": "Site language, one of en, es, pt, fr, de, it, ja, ko, th, id, tr, ar, ru, pl, ro, cs, bg, vi, zh-TW; defaults to en", "enum": ["en", "es", "pt", "fr", "de", "it", "ja", "ko", "th", "id", "tr", "ar", "ru", "pl", "ro", "cs", "bg", "vi", "zh-TW"], "in": "query", "name": "language", "type": "string", "x-example": "en"}], "path": "/reelshort/tag-books", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "tag_id", "required": true, "type": "string"}, {"in": "query", "name": "page", "type": "integer"}, {"in": "query", "name": "limit", "type": "integer"}, {"enum": ["en", "es", "pt", "fr", "de", "it", "ja", "ko", "th", "id", "tr", "ar", "ru", "pl", "ro", "cs", "bg", "vi", "zh-TW"], "in": "query", "name": "language", "type": "string"}], "security": ["ApiKeyAuth"]}, "reelshort-tag-search": {"bodyParam": null, "bodyRequired": false, "id": "reelshort-tag-search", "method": "GET", "params": [{"description": "Tag text to search for, up to 100 characters", "in": "query", "name": "word", "required": true, "type": "string", "x-example": "Billionaire"}, {"description": "Page number, 1 to 10000; defaults to 1", "in": "query", "name": "page", "type": "integer", "x-example": 1}, {"description": "Site language, one of en, es, pt, fr, de, it, ja, ko, th, id, tr, ar, ru, pl, ro, cs, bg, vi, zh-TW; defaults to en", "enum": ["en", "es", "pt", "fr", "de", "it", "ja", "ko", "th", "id", "tr", "ar", "ru", "pl", "ro", "cs", "bg", "vi", "zh-TW"], "in": "query", "name": "language", "type": "string", "x-example": "en"}], "path": "/reelshort/tag-search", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "word", "required": true, "type": "string"}, {"in": "query", "name": "page", "type": "integer"}, {"enum": ["en", "es", "pt", "fr", "de", "it", "ja", "ko", "th", "id", "tr", "ar", "ru", "pl", "ro", "cs", "bg", "vi", "zh-TW"], "in": "query", "name": "language", "type": "string"}], "security": ["ApiKeyAuth"]}, "reelshort-tags": {"bodyParam": null, "bodyRequired": false, "id": "reelshort-tags", "method": "GET", "params": [{"description": "Tag category: actor, actress, identity or trope", "enum": ["actor", "actress", "identity", "trope"], "in": "query", "name": "category", "required": true, "type": "string", "x-example": "identity"}, {"description": "Site language, one of en, es, pt, fr, de, it, ja, ko, th, id, tr, ar, ru, pl, ro, cs, bg, vi, zh-TW; defaults to en", "enum": ["en", "es", "pt", "fr", "de", "it", "ja", "ko", "th", "id", "tr", "ar", "ru", "pl", "ro", "cs", "bg", "vi", "zh-TW"], "in": "query", "name": "language", "type": "string", "x-example": "en"}], "path": "/reelshort/tags", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["actor", "actress", "identity", "trope"], "in": "query", "name": "category", "required": true, "type": "string"}, {"enum": ["en", "es", "pt", "fr", "de", "it", "ja", "ko", "th", "id", "tr", "ar", "ru", "pl", "ro", "cs", "bg", "vi", "zh-TW"], "in": "query", "name": "language", "type": "string"}], "security": ["ApiKeyAuth"]}}
|
|
23
|
+
JSON
|
|
24
|
+
OPERATION_IDS = JSON.parse(<<~'JSON').freeze
|
|
25
|
+
["reelshort-fandom-categories", "reelshort-fandom-post", "reelshort-fandom-posts", "reelshort-home", "reelshort-movie", "reelshort-new-releases", "reelshort-search", "reelshort-shelf", "reelshort-tag-books", "reelshort-tag-search", "reelshort-tags"]
|
|
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-reelshort-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('fandom_categories') do |**params|
|
|
118
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
119
|
+
request('reelshort-fandom-categories', params, response_type: response_type)
|
|
120
|
+
end
|
|
121
|
+
define_method('fandom_post') do |**params|
|
|
122
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
123
|
+
request('reelshort-fandom-post', params, response_type: response_type)
|
|
124
|
+
end
|
|
125
|
+
define_method('fandom_posts') do |**params|
|
|
126
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
127
|
+
request('reelshort-fandom-posts', params, response_type: response_type)
|
|
128
|
+
end
|
|
129
|
+
define_method('home') do |**params|
|
|
130
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
131
|
+
request('reelshort-home', params, response_type: response_type)
|
|
132
|
+
end
|
|
133
|
+
define_method('movie') do |**params|
|
|
134
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
135
|
+
request('reelshort-movie', params, response_type: response_type)
|
|
136
|
+
end
|
|
137
|
+
define_method('new_releases') do |**params|
|
|
138
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
139
|
+
request('reelshort-new-releases', params, response_type: response_type)
|
|
140
|
+
end
|
|
141
|
+
define_method('search') do |**params|
|
|
142
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
143
|
+
request('reelshort-search', params, response_type: response_type)
|
|
144
|
+
end
|
|
145
|
+
define_method('shelf') do |**params|
|
|
146
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
147
|
+
request('reelshort-shelf', params, response_type: response_type)
|
|
148
|
+
end
|
|
149
|
+
define_method('tag_books') do |**params|
|
|
150
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
151
|
+
request('reelshort-tag-books', params, response_type: response_type)
|
|
152
|
+
end
|
|
153
|
+
define_method('tag_search') do |**params|
|
|
154
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
155
|
+
request('reelshort-tag-search', params, response_type: response_type)
|
|
156
|
+
end
|
|
157
|
+
define_method('tags') do |**params|
|
|
158
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
159
|
+
request('reelshort-tags', params, response_type: response_type)
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
private
|
|
163
|
+
|
|
164
|
+
# POST operations take their JSON body under the body parameter name or "body".
|
|
165
|
+
def request_body(operation, params)
|
|
166
|
+
name = operation["bodyParam"]
|
|
167
|
+
return nil if name.nil?
|
|
168
|
+
value = params.key?(name) ? params[name] : params["body"]
|
|
169
|
+
if value.nil?
|
|
170
|
+
raise Errors::ClientError.new("missing request body: #{name}", operation_id: operation["id"]) if operation["bodyRequired"]
|
|
171
|
+
return nil
|
|
172
|
+
end
|
|
173
|
+
value.is_a?(String) ? value : JSON.generate(value)
|
|
174
|
+
end
|
|
175
|
+
|
|
176
|
+
def build_url(operation, params)
|
|
177
|
+
known = operation["params"].map { |param| param["name"] }
|
|
178
|
+
known << "body" if operation["bodyParam"]
|
|
179
|
+
unknown = params.keys - known
|
|
180
|
+
raise Errors::ClientError.new("unknown parameters: #{unknown.join(', ')}", operation_id: operation["id"]) unless unknown.empty?
|
|
181
|
+
path = operation["path"].dup
|
|
182
|
+
operation["params"].select { |param| param["in"] == "path" }.each do |param|
|
|
183
|
+
value = params[param["name"]]
|
|
184
|
+
raise Errors::ClientError.new("missing path parameter: #{param['name']}", operation_id: operation["id"]) if value.nil?
|
|
185
|
+
path.sub!("{" + param["name"] + "}", percent_encode(value.to_s))
|
|
186
|
+
end
|
|
187
|
+
pairs = []
|
|
188
|
+
operation["queryParams"].each do |param|
|
|
189
|
+
name = param["name"]
|
|
190
|
+
value = params.key?(name) ? params[name] : param["default"]
|
|
191
|
+
if value.nil?
|
|
192
|
+
raise Errors::ClientError.new("missing query parameter: #{name}", operation_id: operation["id"]) if param["required"]
|
|
193
|
+
next
|
|
194
|
+
end
|
|
195
|
+
enum_values = param["enum"] || (param["items"] && param["items"]["enum"])
|
|
196
|
+
if enum_values && !(value.is_a?(Array) ? value : [value]).all? { |item| enum_values.map(&:to_s).include?(item.to_s) }
|
|
197
|
+
raise Errors::ClientError.new("invalid value for #{name}", operation_id: operation["id"])
|
|
198
|
+
end
|
|
199
|
+
if value.is_a?(Array)
|
|
200
|
+
format = param["collectionFormat"] || "csv"
|
|
201
|
+
if format == "multi"
|
|
202
|
+
value.each { |item| pairs << [name, scalar(item)] }
|
|
203
|
+
else
|
|
204
|
+
separator = {"csv" => ",", "ssv" => " ", "tsv" => "\t", "pipes" => "|"}[format] || ","
|
|
205
|
+
pairs << [name, value.map { |item| scalar(item) }.join(separator)]
|
|
206
|
+
end
|
|
207
|
+
else
|
|
208
|
+
pairs << [name, scalar(value)]
|
|
209
|
+
end
|
|
210
|
+
end
|
|
211
|
+
query = pairs.map { |name, value| "#{percent_encode(name)}=#{percent_encode(value)}" }.join("&")
|
|
212
|
+
@base_url + path + (query.empty? ? "" : "?" + query)
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
def scalar(value)
|
|
216
|
+
value == true ? "true" : (value == false ? "false" : value.to_s)
|
|
217
|
+
end
|
|
218
|
+
|
|
219
|
+
def percent_encode(value)
|
|
220
|
+
URI::DEFAULT_PARSER.escape(value.to_s, /[^A-Za-z0-9\-._~]/)
|
|
221
|
+
end
|
|
222
|
+
|
|
223
|
+
def parse_response(body, content_type, operation, params, response_type)
|
|
224
|
+
type = response_type.to_s
|
|
225
|
+
raise Errors::ClientError.new("response_type must be auto, json, or text", operation_id: operation["id"]) unless %w[auto json text].include?(type)
|
|
226
|
+
format = operation["params"].find { |param| param["name"] == "format" }
|
|
227
|
+
text_formats = format && format["enum"] ? format["enum"].reject { |value| %w[json application/json].include?(value.to_s.downcase) } : []
|
|
228
|
+
raw_format = params["format"] && text_formats.include?(params["format"].to_s)
|
|
229
|
+
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)
|
|
230
|
+
is_json = json_format || content_type.to_s.downcase.include?("json") || operation["produces"] == ["application/json"]
|
|
231
|
+
return body if type == "text" || raw_format || (type == "auto" && !is_json)
|
|
232
|
+
JSON.parse(body)
|
|
233
|
+
rescue JSON::ParserError => error
|
|
234
|
+
raise Errors::Error.new("invalid JSON response from Crawlora: #{error.message}", operation_id: operation["id"], body: body)
|
|
235
|
+
end
|
|
236
|
+
|
|
237
|
+
public
|
|
238
|
+
end
|
|
239
|
+
end
|
|
240
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: crawlora-reelshort
|
|
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-10-30 00:00:00.000000000 Z
|
|
12
|
+
dependencies: []
|
|
13
|
+
description: Ruby client for Crawlora's hosted ReelShort API. Covers title discovery,
|
|
14
|
+
search, movie details, new releases, and public Fandom articles across 11 endpoints.
|
|
15
|
+
email:
|
|
16
|
+
executables: []
|
|
17
|
+
extensions: []
|
|
18
|
+
extra_rdoc_files: []
|
|
19
|
+
files:
|
|
20
|
+
- CHANGELOG.md
|
|
21
|
+
- LICENSE
|
|
22
|
+
- README.md
|
|
23
|
+
- lib/crawlora/reelshort.rb
|
|
24
|
+
- lib/crawlora/reelshort/client.rb
|
|
25
|
+
- lib/crawlora/reelshort/version.rb
|
|
26
|
+
homepage: https://crawlora.net/?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=reelshort-ruby-homepage
|
|
27
|
+
licenses:
|
|
28
|
+
- MIT
|
|
29
|
+
metadata:
|
|
30
|
+
source_code_uri: https://github.com/Crawlora-org/crawlora-reelshort
|
|
31
|
+
documentation_uri: https://github.com/Crawlora-org/crawlora-reelshort/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: ReelShort API client for Crawlora (11 endpoints)
|
|
52
|
+
test_files: []
|