crawlora 1.5.0.pre.sdk.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d5df185ab17cbdb8ee244385b900049f2209efe980e1a672f39a7f61d18bfd35
+  data.tar.gz: af839794521c83c882affd859e4929ec76225144e45bb3f29141795b0fbb9b69
+SHA512:
+  metadata.gz: ffd5f36fde004299e22e4f07d4c19e9904032d0ff78ee7c9a57b9d4d49964a2fba2fc0e7e14f412e9814b1c64e3d599c63259b69a6173dfbf50a71414354bd87
+  data.tar.gz: 2d529c261a355e69021267c41f520db47c0a8a399d107108ba08d3fe839158ef6929ef88986c6205592a144980a2f977af4eceeb42fa20ee2a2eb74568232874

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+## 1.5.0-sdk.2
+
+- Packaging: point the gem homepage at https://crawlora.net/, expand the gem
+  description, and add `documentation_uri` / `source_code_uri` / `bug_tracker_uri`
+  metadata for a richer RubyGems listing. No client or API changes.
+
+## 1.5.0-sdk.1
+
+- Initial release of the Crawlora Ruby SDK.
+- Grouped helpers (`client.<group>.<method>`) and dynamic `request`/`operation`
+  calls for every public operation, generated from the shared OpenAPI contract.
+- Configurable retries with exponential backoff, jitter, and `Retry-After`
+  support; `on_retry` hook.
+- Numeric and cursor pagination (`paginate` / `paginate_items`).
+- `before_request` / `after_response` middleware, opt-in `request_id` and
+  `idempotency_keys`, client-side `rate_limit` / `max_concurrency`.
+- `auto` / `json` / `text` / `stream` response modes.
+- Typed error hierarchy: `Crawlora::Error`, `ClientError`, `ServerError`,
+  `NetworkError`.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Crawlora
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,123 @@
+# Crawlora Ruby SDK
+
+Ruby client for the public [Crawlora](https://crawlora.net) web-scraping API. It
+wraps every public endpoint with grouped helpers and a dynamic call interface,
+plus retries, pagination, middleware hooks, and client-side rate limiting.
+
+- **Base URL:** `https://api.crawlora.net/api/v1`
+- **Auth:** API key (`x-api-key`) or JWT (`Authorization`)
+- **Ruby:** 3.0+
+- Operation reference: [`docs/operations.md`](docs/operations.md) · recipes: [`docs/recipes.md`](docs/recipes.md)
+
+## Install
+
+```ruby
+# Gemfile
+gem "crawlora"
+```
+
+```sh
+gem install crawlora
+```
+
+## Quick start
+
+```ruby
+require "crawlora"
+
+# Reads CRAWLORA_API_KEY from the environment if api_key: is omitted.
+client = Crawlora.client(api_key: ENV["CRAWLORA_API_KEY"])
+
+result = client.bing.search(q: "web scraping")
+result["data"].each { |item| puts item["title"] }
+
+client.close # release pooled keep-alive connections
+```
+
+Pass a block to auto-close:
+
+```ruby
+Crawlora.client do |client|
+  puts client.amazon.product(asin: "B07FZ8S74R", language: "en_US")
+end
+```
+
+## Calling operations
+
+Grouped helpers map directly to the API (`client.<group>.<method>`):
+
+```ruby
+client.youtube.video(id: "dQw4w9WgXcQ")
+client.google.search(q: "crawlora", country: "US")
+```
+
+Or call any operation dynamically by its id — handy for metaprogramming:
+
+```ruby
+client.request("bing-search", { q: "web scraping", page: 2 })
+
+# Discover operations:
+Crawlora::OPERATION_COUNT            # => total operations
+Crawlora::GROUPS["bing"]             # => { "search" => "bing-search", ... }
+Crawlora::OperationId::BING_SEARCH   # => "bing-search"
+```
+
+## Configuration
+
+```ruby
+Crawlora.client(
+  api_key: "…",
+  timeout: 30,             # seconds per request
+  retries: 2,              # retry attempts on retryable failures
+  retry_delay: 0.25,       # base backoff (exponential + jitter, honors Retry-After)
+  request_id: true,        # attach an x-request-id to every call
+  idempotency_keys: true,  # stable Idempotency-Key on POST/PATCH
+  rate_limit: 5,           # max requests/second (client-side)
+  max_concurrency: 4,      # max in-flight requests across threads
+  headers: { "X-Tenant" => "acme" }
+)
+```
+
+Per-request overrides use the reserved `_`-prefixed keyword on grouped calls, or
+keyword args on `request`:
+
+```ruby
+client.bing.search(q: "x", _timeout: 5, _headers: { "X-Trace" => "1" })
+client.request("bing-search", { q: "x" }, response_type: "text", retries: 0)
+```
+
+## Pagination
+
+```ruby
+# Numeric (page/offset) — stops on the first empty page:
+client.paginate_items("airbnb-room-reviews", { id: "123" }, max_pages: 5).each do |review|
+  puts review["text"]
+end
+
+# Cursor mode — supply the cursor param and a next-cursor extractor:
+client.paginate("producthunt-leaderboard", {},
+                cursor_param: "cursor", next_cursor: ->(page) { page["next_cursor"] }) do |page|
+  puts page["data"]
+end
+```
+
+## Error handling
+
+```ruby
+begin
+  client.bing.search(q: "x")
+rescue Crawlora::ClientError => e   # 4xx
+  warn "rejected (#{e.status}): #{e.message} #{e.code}"
+rescue Crawlora::ServerError => e   # 5xx
+  warn "server error: #{e.status}"
+rescue Crawlora::NetworkError => e  # timeout / transport failure
+  warn "network: #{e.message}"
+end
+```
+
+All inherit from `Crawlora::Error`, which exposes `status`, `code`, `body`,
+`raw_body`, `headers`, and `request_id`.
+
+## License
+
+MIT. See [LICENSE](LICENSE).