chartquery 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 ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: faad78baa7a8810164dd45ffa145116e4eb2f450312bffdb19f162d31c2b926e
4
+ data.tar.gz: fdacaa873c7761a2b35c318a33118608090c6fd24cc79eae59c0c990c1e029a6
5
+ SHA512:
6
+ metadata.gz: 3f285d109e2aa3bcd28580d0d3fc2b1cac0d70fb2d2576a8ad4556ed27a829506784b4bfdd296476bd1ac182f10ddccb7db65c2bd0c1bee45b713809c6dfc6dc
7
+ data.tar.gz: 0c9b50792f4ffce8585a1ac1450451555304375cdb7bcc8305cf7b8c9c07c033c99ac6f56b71f51a1fdff150af7971d04eb0a3eeb929529efdd624d152f5a90c
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 ChartQuery
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,167 @@
1
+ # ChartQuery Ruby SDK
2
+
3
+ The official Ruby SDK for the [ChartQuery](https://www.chartquery.com) chart and QR code API.
4
+
5
+ Generate chart images, diagrams, barcodes, QR codes and thermal labels on demand. PNG, SVG or PDF output.
6
+
7
+ The SDK exposes **20 methods**, one per documented endpoint, plus a generic `request`. It only uses the Ruby standard library.
8
+
9
+ ## Requirements
10
+
11
+ - Ruby 3.1 or newer
12
+
13
+ ## Installation
14
+
15
+ ```sh
16
+ gem install chartquery
17
+ ```
18
+
19
+ Or in your `Gemfile`:
20
+
21
+ ```ruby
22
+ gem "chartquery"
23
+ ```
24
+
25
+ ## Get your API key
26
+
27
+ [Sign up for ChartQuery](https://app.chartquery.com/register) or sign in, then copy your API key from the [dashboard](https://app.chartquery.com). The client reads `ENV["CHARTQUERY_API_KEY"]` when no key is passed.
28
+
29
+ ## Quick start
30
+
31
+ ```ruby
32
+ require "chartquery"
33
+
34
+ client = ChartQuery::Client.new(api_key: ENV.fetch("CHARTQUERY_API_KEY"))
35
+ response = client.chart_ai(prompt: "Monthly revenue 2026 as a bar chart: Jan 10, Feb 14, Mar 18")
36
+ puts response.data
37
+ ```
38
+
39
+ Keyword arguments use the parameter names of the [API reference](https://app.chartquery.com/openapi). Unknown names raise `ChartQuery::SerializationError`; use `request` for undocumented parameters.
40
+
41
+ ## Binary responses
42
+
43
+ Endpoints that can return a file (image, PDF…) return a `JsonResponse` or a `BinaryResponse`:
44
+
45
+ ```ruby
46
+ response = client.qrcode(data: "https://chartquery.com", format: "png")
47
+ response.save("qrcode.png") if response.binary?
48
+ ```
49
+
50
+ ## Async jobs
51
+
52
+ Any call accepts `is_async: true` (useful past the 60-second server limit): the response is then a `job_id`. `wait_for_job` polls `GET /v1/jobs/{id}` until a terminal status (`CompletedJob`, `Error`, `NotFound`, `BadRequest`):
53
+
54
+ ```ruby
55
+ submitted = client.chart_ai(prompt: "Monthly revenue 2026 as a bar chart: Jan 10, Feb 14, Mar 18", is_async: true)
56
+ job = client.wait_for_job(submitted.data["job_id"]) { |j| puts "#{j['status']} #{j['progress']}%" }
57
+ puts job.data
58
+ ```
59
+
60
+ ## GET or POST
61
+
62
+ Methods use GET when the endpoint supports it (query string). POST sends the same parameters as JSON:
63
+
64
+ ```ruby
65
+ client.barcode(data: "test", request_options: { method: "POST" })
66
+ ```
67
+
68
+ `nil` values are omitted, `false` and `0` are sent, and arrays repeat the parameter name.
69
+
70
+ ## Any endpoint
71
+
72
+ ```ruby
73
+ response = client.request("GET", "/v1/usage")
74
+ ```
75
+
76
+ ## Errors
77
+
78
+ ```ruby
79
+ begin
80
+ client.chart_ai(prompt: "Monthly revenue 2026 as a bar chart: Jan 10, Feb 14, Mar 18")
81
+ rescue ChartQuery::APIError => e
82
+ warn "HTTP #{e.status}: #{e.message}"
83
+ end
84
+ ```
85
+
86
+ | Error | When |
87
+ | --- | --- |
88
+ | `ChartQuery::ConfigurationError` | Missing API key, invalid options or unsupported method. |
89
+ | `ChartQuery::SerializationError` | A required parameter is missing, unknown or can't be sent. |
90
+ | `ChartQuery::TransportError` | Network failure or timeout. |
91
+ | `ChartQuery::APIError` | Non-2xx status (`status`, `error_message`, `response_body`, `raw_response`). |
92
+ | `ChartQuery::ResponseDecodingError` | A success response could not be decoded. |
93
+
94
+ All of them inherit from `ChartQuery::Error`.
95
+
96
+ ## Retries
97
+
98
+ Requests are retried up to 3 times after a network error, a `408`, `500`, `502`, `503` or `504`, or a rate limit — which the API returns as `401` (or `429`) with a `Rate limit exceeded` message. Per-key quota errors (`…: quota daily`) are not retried, nor are `400`, `402`, `404` or client-side timeouts. The delay starts at 1 second and grows 1.5× per retry (capped at 30 seconds); a `Retry-After` header wins.
99
+
100
+ ```ruby
101
+ client = ChartQuery::Client.new(max_retries: 5, retry_delay: 0.5)
102
+ client.chart_ai(prompt: "Monthly revenue 2026 as a bar chart: Jan 10, Feb 14, Mar 18", request_options: { max_retries: 0 }) # one request without retries
103
+ ```
104
+
105
+ ## Batch requests
106
+
107
+ `batch` runs the block for every item on 10 threads (`concurrency:`) and returns one `BatchResult` per item, in input order. A failing item never stops the others.
108
+
109
+ ```ruby
110
+ inputs = ["Monthly revenue 2026 as a bar chart: Jan 10, Feb 14, Mar 18", "Market share as a pie chart: A 40, B 35, C 25"]
111
+ results = client.batch(inputs, concurrency: 5) { |value| client.chart_ai(prompt: value) }
112
+ results.each do |result|
113
+ if result.ok?
114
+ puts result.value.data
115
+ else
116
+ warn "#{inputs[result.index]}: #{result.error.message}"
117
+ end
118
+ end
119
+ ```
120
+
121
+ | Constant | Default | Description |
122
+ | --- | --- | --- |
123
+ | `ChartQuery::Client::DEFAULT_CONCURRENCY` | `10` | Tasks run at the same time by batch |
124
+ | `ChartQuery::Client::DEFAULT_TIMEOUT` | `120` | Request timeout (seconds) |
125
+ | `ChartQuery::Client::MAX_RETRIES` | `3` | Retry attempts after a network error, a 408/5xx or a rate limit |
126
+ | `ChartQuery::Client::RETRY_BACKOFF_FACTOR` | `1.5` | Exponential backoff multiplier |
127
+ | `ChartQuery::Client::DEFAULT_RETRY_DELAY` | `1.0` | Delay before the first retry (seconds) |
128
+
129
+ ## Timeouts and custom transports
130
+
131
+ ```ruby
132
+ client = ChartQuery::Client.new(timeout: 60) # seconds, default 120
133
+ client.chart_ai(prompt: "Monthly revenue 2026 as a bar chart: Jan 10, Feb 14, Mar 18", request_options: { timeout: 30 })
134
+ ```
135
+
136
+ A transport is any object with `call(method:, url:, headers:, body:, timeout:)` returning `[status, headers, body]`; the default is `ChartQuery::NetHTTPTransport`.
137
+
138
+ ## Endpoints
139
+
140
+ 20 methods, generated from the [OpenAPI document](https://app.chartquery.com/openapi).
141
+
142
+ | Method | HTTP | Description |
143
+ | --- | --- | --- |
144
+ | `barcode` | GET / POST `/v1/barcode` | Generate a barcode image via GET. Output: SVG (default) or PNG. Supports 25+ formats: EAN-13, Code 128, ITF-14, GS1-128, postal codes and m… |
145
+ | `chart` | GET / POST `/v1/chart` | Render a Chart.js image via GET. Pass the full chart object as URL-encoded JSON in query. Prefer format png for ChatGPT. POST sends the sam… |
146
+ | `chart_ai` | GET / POST `/v1/chart/ai` | Describe a chart in plain English via GET and get a rendered image back. Powered by AI. |
147
+ | `chart_render` | GET `/v1/chart/render/{id}` | Render a previously saved chart by ID. Public, no API key required. Supports URL overrides for templates (?data1=, ?labels=, ?title=…). |
148
+ | `chart_view` | GET `/v1/chart/view/{id}` | View a previously saved chart as an interactive HTML page. Public, no API key required. Iframe-embeddable. |
149
+ | `diagram` | GET / POST `/v1/diagram` | Render a diagram via GET. Use type (mermaid, d2, …), query (source code), and format=png for ChatGPT. POST uses diagram_type and diagram_so… |
150
+ | `diagram_ai` | GET / POST `/v1/diagram/ai` | Describe a diagram in plain English via GET and get a rendered image back. Powered by AI. |
151
+ | `diagram_render` | GET `/v1/diagram/render/{id}` | Render a previously saved diagram by ID. Public, no API key required. Supports ?format= and ?query= overrides. |
152
+ | `diagram_view` | GET `/v1/diagram/view/{id}` | View a previously saved diagram as an HTML page. Public, no API key required. Iframe-embeddable with inline SVG rendering. |
153
+ | `jobs` | GET `/v1/jobs/{id}` | Poll the status, progress (0–100) and result of a job started with is_async=true. Polling is free. Poll until status is terminal: Completed… |
154
+ | `label` | GET / POST `/v1/label` | Preview a thermal label via GET. Pass the same label object as a URL-encoded JSON string in query. Inside that JSON, text items use content… |
155
+ | `label_compile` | POST `/v1/label/compile` | Compile a label to printer commands (tsc, zpl, epl, …). POST width, language, and elements. Text uses content and size (1-10), not text or… |
156
+ | `label_convert` | POST `/v1/label/convert` | Convert printer commands from one language to another. POST source, from, and to. from is the source language (tsc, zpl, epl, …). to is the… |
157
+ | `label_parse` | POST `/v1/label/parse` | Parse printer commands into structured elements. POST source and language (tsc, zpl, epl, …). |
158
+ | `label_render` | GET `/v1/label/render/{id}` | Render a previously saved label by ID. Public, no API key required. Supports ?format= override. |
159
+ | `label_validate` | POST `/v1/label/validate` | Validate printer commands. POST source (the raw commands) and language (tsc, zpl, epl, …). |
160
+ | `label_view` | GET `/v1/label/view/{id}` | View a previously saved label as an HTML page. Public, no API key required. Iframe-embeddable with inline SVG rendering. |
161
+ | `qrcode` | GET / POST `/v1/qrcode` | Generate a styled QR code via GET. Output: SVG (default) or PNG. Supports dot styles, gradients, custom corners and all QR versions. |
162
+ | `stats` | GET `/v1/stats` | Infrastructure health for an engine or endpoint over the last hour. Not scoped to your account or tenant. Enabled per account: HTTP 403 mea… |
163
+ | `usage` | GET `/v1/usage` | Return this account's Chartquery usage and credit balance. No body. Requires an API key. |
164
+
165
+ ## License
166
+
167
+ MIT — see [LICENSE](LICENSE).
@@ -0,0 +1,12 @@
1
+ # Examples
2
+
3
+ ```sh
4
+ gem install chartquery
5
+ export CHARTQUERY_API_KEY="YOUR_API_KEY"
6
+ ruby examples/json.rb
7
+ ```
8
+
9
+ - `json.rb` — call the featured endpoint and print the JSON result.
10
+ - `binary.rb` — save a binary response to a file.
11
+ - `request.rb` — call any path with `request` and handle API errors.
12
+ - `wait_for_job.rb` — start an async job and wait for its result.
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "chartquery"
4
+
5
+ client = ChartQuery::Client.new # reads CHARTQUERY_API_KEY
6
+ response = client.qrcode(data: "https://chartquery.com", format: "png")
7
+ if response.binary?
8
+ response.save("qrcode.png")
9
+ puts "Saved qrcode.png (#{response.content_type}, #{response.bytes.bytesize} bytes)"
10
+ else
11
+ puts response.data
12
+ end
data/examples/json.rb ADDED
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "json"
4
+ require "chartquery"
5
+
6
+ client = ChartQuery::Client.new # reads CHARTQUERY_API_KEY
7
+ response = client.chart_ai(prompt: "Monthly revenue 2026 as a bar chart: Jan 10, Feb 14, Mar 18")
8
+ puts JSON.pretty_generate(response.data)
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "chartquery"
4
+
5
+ client = ChartQuery::Client.new # reads CHARTQUERY_API_KEY
6
+ begin
7
+ response = client.request("GET", "/v1/usage")
8
+ puts response.data if response.json?
9
+ rescue ChartQuery::APIError => e
10
+ warn "HTTP #{e.status}: #{e.message}"
11
+ end
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "chartquery"
4
+
5
+ client = ChartQuery::Client.new # reads CHARTQUERY_API_KEY
6
+ submitted = client.chart_ai(prompt: "Monthly revenue 2026 as a bar chart: Jan 10, Feb 14, Mar 18", is_async: true)
7
+ job = client.wait_for_job(submitted.data["job_id"]) { |j| puts "#{j['status']} #{j['progress']}%" }
8
+ puts job.data
@@ -0,0 +1,266 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "json"
4
+
5
+ module ChartQuery
6
+ # Official ChartQuery API client. Create one instance and reuse it.
7
+ class Client
8
+ include Operations
9
+
10
+ DEFAULT_BASE_URL = "https://api.chartquery.com"
11
+ DEFAULT_TIMEOUT = 120
12
+ # Tasks run at the same time by #batch.
13
+ DEFAULT_CONCURRENCY = 10
14
+ # Retries after a network error or a 408, 429, 500, 502, 503 or 504 response.
15
+ MAX_RETRIES = 3
16
+ # Each retry waits this many times longer than the previous one (a Retry-After header wins).
17
+ RETRY_BACKOFF_FACTOR = 1.5
18
+ # Seconds before the first retry.
19
+ DEFAULT_RETRY_DELAY = 1.0
20
+ MAX_RETRY_DELAY = 30.0
21
+ RETRYABLE_STATUSES = [408, 500, 502, 503, 504].freeze
22
+ API_KEY_ENVIRONMENT_VARIABLE = "CHARTQUERY_API_KEY"
23
+ JOB_TERMINAL_STATUSES = %w[CompletedJob Error NotFound BadRequest].freeze
24
+ ERROR_MESSAGE_KEYS = %w[error message error_message detail].freeze
25
+
26
+ # @param api_key [String, nil] defaults to ENV["CHARTQUERY_API_KEY"]
27
+ # @param base_url [String] API origin
28
+ # @param timeout [Numeric, nil] seconds per request; nil disables it
29
+ # @param headers [Hash] extra headers for every request
30
+ # @param max_retries [Integer] retries after a network error or a 408/429/5xx response; 0 disables them
31
+ # @param retry_delay [Numeric] seconds before the first retry, growing 1.5x per retry
32
+ # @param transport [#call] custom transport, see {NetHTTPTransport}
33
+ def initialize(api_key: nil, base_url: DEFAULT_BASE_URL, timeout: DEFAULT_TIMEOUT, headers: {},
34
+ max_retries: MAX_RETRIES, retry_delay: DEFAULT_RETRY_DELAY, transport: nil)
35
+ api_key = ENV.fetch(API_KEY_ENVIRONMENT_VARIABLE, nil) if api_key.nil?
36
+ if !api_key.is_a?(String) || api_key.strip.empty?
37
+ raise ConfigurationError,
38
+ "A non-blank ChartQuery API key is required. Pass api_key: or set #{API_KEY_ENVIRONMENT_VARIABLE}."
39
+ end
40
+ raise ConfigurationError, "The ChartQuery API key cannot be used in an HTTP header." if api_key.match?(/[\r\n]/)
41
+
42
+ uri = URI.parse(base_url.to_s)
43
+ unless %w[http https].include?(uri.scheme) && uri.host
44
+ raise ConfigurationError, "base_url must be an absolute http or https URL."
45
+ end
46
+ raise ConfigurationError, "timeout must be a positive number or nil." if timeout && !(timeout.is_a?(Numeric) && timeout.positive?)
47
+ raise ConfigurationError, "transport must respond to #call." if transport && !transport.respond_to?(:call)
48
+
49
+ @api_key = api_key
50
+ @base_url = base_url.to_s.sub(%r{/+\z}, "")
51
+ @timeout = timeout
52
+ @headers = headers.to_h { |name, value| [name.to_s, value.to_s] }.freeze
53
+ raise ConfigurationError, "max_retries must be a non-negative Integer." unless max_retries.is_a?(Integer) && max_retries >= 0
54
+ raise ConfigurationError, "retry_delay must be a non-negative number." unless retry_delay.is_a?(Numeric) && retry_delay >= 0
55
+
56
+ @max_retries = max_retries
57
+ @retry_delay = retry_delay
58
+ @transport = transport || NetHTTPTransport.new
59
+ end
60
+
61
+ def inspect
62
+ "#<#{self.class.name} base_url=#{@base_url.inspect}>"
63
+ end
64
+
65
+ # Sends any request, including endpoints released after this SDK version.
66
+ # GET parameters travel in the query string; POST parameters travel in a JSON body.
67
+ # @return [JsonResponse, BinaryResponse]
68
+ def request(method, path, params = nil, timeout: nil, headers: nil, max_retries: nil)
69
+ send_request(method.to_s.upcase, path, params, { timeout: timeout, headers: headers, max_retries: max_retries }, :any)
70
+ end
71
+
72
+ # Runs the block for every item on +concurrency+ threads (default 10) and returns one {BatchResult} per item,
73
+ # in input order. A failing item never stops the others; the client is thread-safe.
74
+ #
75
+ # results = client.batch(ids, concurrency: 5) { |id| client.some_endpoint(query: id) }
76
+ # @return [Array<BatchResult>]
77
+ def batch(items, concurrency: DEFAULT_CONCURRENCY)
78
+ raise ConfigurationError, "concurrency must be a positive Integer." unless concurrency.is_a?(Integer) && concurrency.positive?
79
+ raise ArgumentError, "batch needs a block" unless block_given?
80
+
81
+ list = items.to_a
82
+ results = Array.new(list.size)
83
+ queue = Queue.new
84
+ list.each_with_index { |item, index| queue << [item, index] }
85
+ queue.close
86
+ workers = Array.new([concurrency, list.size].min) do
87
+ Thread.new do
88
+ while (job = queue.pop)
89
+ item, index = job
90
+ results[index] = begin
91
+ BatchResult.new(index: index, value: yield(item), error: nil)
92
+ rescue StandardError => e
93
+ BatchResult.new(index: index, value: nil, error: e)
94
+ end
95
+ end
96
+ end
97
+ end
98
+ workers.each(&:join)
99
+ results
100
+ end
101
+
102
+ # Polls GET /v1/jobs/{id} until the job reaches a terminal status. The delay starts at +interval+ seconds
103
+ # and grows 1.5x per poll up to 60 s; +timeout+ defaults to 12 hours.
104
+ # @yieldparam job [Hash] the latest job document after every poll
105
+ # @return [JsonResponse]
106
+ def wait_for_job(job_id, interval: 3, timeout: 43_200)
107
+ raise SerializationError.new("A non-blank job id is required.", "id") if job_id.to_s.strip.empty?
108
+
109
+ started = Process.clock_gettime(Process::CLOCK_MONOTONIC)
110
+ loop do
111
+ last = request("GET", "/v1/jobs/{id}", { "id" => job_id })
112
+ yield last.data if block_given?
113
+ return last if last.data.is_a?(Hash) && JOB_TERMINAL_STATUSES.include?(last.data["status"])
114
+
115
+ elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - started
116
+ raise JobTimeoutError.new(job_id, last) if elapsed + interval > timeout
117
+
118
+ sleep(interval)
119
+ interval = (interval * 1.5).clamp(interval, [interval, 60].max)
120
+ end
121
+ end
122
+
123
+ private
124
+
125
+ def call_operation(name, params, options)
126
+ endpoint = ENDPOINTS.fetch(name)
127
+ options = (options || {}).transform_keys(&:to_sym)
128
+ method = (options[:method] || endpoint[:methods].first).to_s.upcase
129
+ unless endpoint[:methods].include?(method)
130
+ raise ConfigurationError, "#{endpoint[:path]} supports #{endpoint[:methods].join(', ')}, not #{method}."
131
+ end
132
+
133
+ params = params.transform_keys(&:to_s)
134
+ unknown = params.keys - endpoint[:params]
135
+ unless unknown.empty?
136
+ raise SerializationError.new(
137
+ "Unknown parameter(s) for #{name}: #{unknown.join(', ')}. Use #request for undocumented parameters.",
138
+ unknown.first
139
+ )
140
+ end
141
+ endpoint[:required].each do |required|
142
+ raise SerializationError.new("The \"#{required}\" parameter is required.", required) if params[required].nil?
143
+ end
144
+ send_request(method, endpoint[:path], params, options, endpoint[:response])
145
+ end
146
+
147
+ def send_request(method, path, params, options, expected)
148
+ raise ConfigurationError, "Unsupported HTTP method: #{method.inspect}." unless %w[GET POST].include?(method)
149
+ raise ConfigurationError, 'The request path must start with "/".' unless path.is_a?(String) && path.start_with?("/")
150
+
151
+ path, pairs, body = Serialization.serialize(method, path, params)
152
+ url = @base_url + path
153
+ url += "?#{Serialization.encode_query(pairs)}" unless pairs.empty?
154
+ headers = {
155
+ "Accept" => "application/json, */*;q=0.8",
156
+ "User-Agent" => "chartquery-ruby/#{VERSION}"
157
+ }.merge(@headers).merge((options[:headers] || {}).to_h { |k, v| [k.to_s, v.to_s] })
158
+ headers["x-api-key"] = @api_key
159
+ payload = nil
160
+ if body
161
+ headers["Content-Type"] = "application/json"
162
+ payload = JSON.generate(body)
163
+ end
164
+
165
+ max_retries = options[:max_retries] || @max_retries
166
+ attempt = 0
167
+ loop do
168
+ begin
169
+ status, response_headers, response_body = @transport.call(
170
+ method: method, url: url, headers: headers, body: payload, timeout: options[:timeout] || @timeout
171
+ )
172
+ rescue Timeout::Error => e
173
+ raise TransportError, "ChartQuery request timed out: #{e.message}"
174
+ rescue StandardError => e
175
+ raise TransportError, "ChartQuery request failed before an HTTP response was received: #{e.message}" if attempt >= max_retries
176
+
177
+ sleep(retry_delay(attempt, nil))
178
+ attempt += 1
179
+ next
180
+ end
181
+ raw = build_raw_response(status, response_headers, response_body)
182
+ return decode(raw, expected) if (200..299).cover?(raw.status)
183
+ raise api_error(raw) unless retryable?(raw) && attempt < max_retries
184
+
185
+ sleep(retry_delay(attempt, raw.headers["retry-after"]&.first))
186
+ attempt += 1
187
+ end
188
+ end
189
+
190
+ # Server errors and plan rate limits (401/429 "Rate limit exceeded") are retried; per-key quotas are not.
191
+ def retryable?(raw)
192
+ return true if RETRYABLE_STATUSES.include?(raw.status)
193
+ return false unless [401, 429].include?(raw.status)
194
+
195
+ message = api_error(raw).error_message.to_s.downcase
196
+ return false if message.include?("quota")
197
+
198
+ message.include?("rate limit") || (raw.status == 429 && message.empty?)
199
+ end
200
+
201
+ def retry_delay(attempt, retry_after)
202
+ seconds = Float(retry_after, exception: false) if retry_after
203
+ return [seconds, 60].min if seconds && seconds >= 0
204
+
205
+ [@retry_delay * (RETRY_BACKOFF_FACTOR**attempt), MAX_RETRY_DELAY].min
206
+ end
207
+
208
+ def build_raw_response(status, headers, body)
209
+ normalized = {}
210
+ (headers || {}).each { |name, values| normalized[name.to_s.downcase] = Array(values).map(&:to_s).freeze }
211
+ RawResponse.new(
212
+ status: status.to_i,
213
+ headers: normalized.freeze,
214
+ content_type: normalized["content-type"]&.first,
215
+ body: body.to_s.b
216
+ )
217
+ end
218
+
219
+ def api_error(raw)
220
+ parsed = parse_json(raw.body)
221
+ message = nil
222
+ if parsed.is_a?(Hash)
223
+ ERROR_MESSAGE_KEYS.each do |key|
224
+ value = parsed[key]
225
+ if value.is_a?(String) && !value.empty?
226
+ message = value
227
+ break
228
+ end
229
+ end
230
+ end
231
+ APIError.new(raw_response: raw, response_body: parsed == NOT_JSON ? nil : parsed, error_message: message)
232
+ end
233
+
234
+ def decode(raw, expected)
235
+ unless json_media_type?(raw.content_type)
236
+ if expected == :json
237
+ raise ResponseDecodingError.new("ChartQuery returned a successful non-JSON response for a JSON operation.", raw)
238
+ end
239
+
240
+ return BinaryResponse.new(bytes: raw.body, content_type: raw.content_type, raw_response: raw)
241
+ end
242
+ data = parse_json(raw.body)
243
+ if data == NOT_JSON
244
+ raise ResponseDecodingError.new("ChartQuery returned a successful JSON response that could not be decoded.", raw)
245
+ end
246
+
247
+ JsonResponse.new(data: data, raw_response: raw)
248
+ end
249
+
250
+ NOT_JSON = Object.new.freeze
251
+ private_constant :NOT_JSON
252
+
253
+ def parse_json(body)
254
+ JSON.parse(body.dup.force_encoding(Encoding::UTF_8))
255
+ rescue JSON::ParserError, EncodingError
256
+ NOT_JSON
257
+ end
258
+
259
+ def json_media_type?(content_type)
260
+ return false if content_type.nil?
261
+
262
+ media_type = content_type.split(";", 2).first.strip.downcase
263
+ media_type == "application/json" || media_type.end_with?("+json")
264
+ end
265
+ end
266
+ end
@@ -0,0 +1,149 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Generated from the ChartQuery OpenAPI document. Do not edit by hand.
4
+
5
+ module ChartQuery
6
+ # Path, methods, response kind and parameter names of every documented operation.
7
+ ENDPOINTS = {
8
+ "barcode" => {
9
+ path: "/v1/barcode",
10
+ methods: ["GET", "POST"].freeze,
11
+ response: :any,
12
+ required: ["data"].freeze,
13
+ params: ["data", "type", "height", "color", "show_text", "text_position", "text_align", "font_size", "font_family", "bar_width", "bar_gap", "background", "margin", "margin_top", "margin_bottom", "margin_left", "margin_right", "rotation", "bearer_bars", "unit", "aria_label", "title", "desc", "format", "share", "fields", "is_async", "soft_fail"].freeze
14
+ }.freeze,
15
+ "chart" => {
16
+ path: "/v1/chart",
17
+ methods: ["GET", "POST"].freeze,
18
+ response: :any,
19
+ required: ["query"].freeze,
20
+ params: ["query", "version", "share", "fields", "is_async", "soft_fail"].freeze
21
+ }.freeze,
22
+ "chart_ai" => {
23
+ path: "/v1/chart/ai",
24
+ methods: ["GET", "POST"].freeze,
25
+ response: :json,
26
+ required: ["prompt"].freeze,
27
+ params: ["prompt", "raw_data", "title", "subtitle", "legend", "format", "width", "height", "background", "device_pixel_ratio", "share", "fields", "is_async", "soft_fail"].freeze
28
+ }.freeze,
29
+ "chart_render" => {
30
+ path: "/v1/chart/render/{id}",
31
+ methods: ["GET"].freeze,
32
+ response: :any,
33
+ required: ["id"].freeze,
34
+ params: ["id", "title", "labels", "data1", "width", "height", "format", "fields", "is_async", "soft_fail"].freeze
35
+ }.freeze,
36
+ "chart_view" => {
37
+ path: "/v1/chart/view/{id}",
38
+ methods: ["GET"].freeze,
39
+ response: :json,
40
+ required: ["id"].freeze,
41
+ params: ["id", "share", "fields", "is_async", "soft_fail"].freeze
42
+ }.freeze,
43
+ "diagram" => {
44
+ path: "/v1/diagram",
45
+ methods: ["GET", "POST"].freeze,
46
+ response: :any,
47
+ required: ["type", "query"].freeze,
48
+ params: ["type", "query", "format", "share", "fields", "is_async", "soft_fail"].freeze
49
+ }.freeze,
50
+ "diagram_ai" => {
51
+ path: "/v1/diagram/ai",
52
+ methods: ["GET", "POST"].freeze,
53
+ response: :json,
54
+ required: ["prompt"].freeze,
55
+ params: ["prompt", "diagram_type", "output_format", "share", "fields", "is_async", "soft_fail"].freeze
56
+ }.freeze,
57
+ "diagram_render" => {
58
+ path: "/v1/diagram/render/{id}",
59
+ methods: ["GET"].freeze,
60
+ response: :any,
61
+ required: ["id"].freeze,
62
+ params: ["id", "format", "query", "share", "fields", "is_async", "soft_fail"].freeze
63
+ }.freeze,
64
+ "diagram_view" => {
65
+ path: "/v1/diagram/view/{id}",
66
+ methods: ["GET"].freeze,
67
+ response: :json,
68
+ required: ["id"].freeze,
69
+ params: ["id", "share", "fields", "is_async", "soft_fail"].freeze
70
+ }.freeze,
71
+ "jobs" => {
72
+ path: "/v1/jobs/{id}",
73
+ methods: ["GET"].freeze,
74
+ response: :json,
75
+ required: ["id"].freeze,
76
+ params: ["id"].freeze
77
+ }.freeze,
78
+ "label" => {
79
+ path: "/v1/label",
80
+ methods: ["GET", "POST"].freeze,
81
+ response: :any,
82
+ required: ["query"].freeze,
83
+ params: ["format", "share", "query", "fields", "is_async", "soft_fail"].freeze
84
+ }.freeze,
85
+ "label_compile" => {
86
+ path: "/v1/label/compile",
87
+ methods: ["POST"].freeze,
88
+ response: :json,
89
+ required: ["width", "elements", "language"].freeze,
90
+ params: ["width", "height", "unit", "dpi", "gap", "speed", "density", "direction", "copies", "printer", "elements", "language", "fields", "is_async", "soft_fail"].freeze
91
+ }.freeze,
92
+ "label_convert" => {
93
+ path: "/v1/label/convert",
94
+ methods: ["POST"].freeze,
95
+ response: :json,
96
+ required: ["source", "from", "to"].freeze,
97
+ params: ["source", "from", "to", "dpi", "speed", "density", "copies", "fields", "is_async", "soft_fail"].freeze
98
+ }.freeze,
99
+ "label_parse" => {
100
+ path: "/v1/label/parse",
101
+ methods: ["POST"].freeze,
102
+ response: :json,
103
+ required: ["source", "language"].freeze,
104
+ params: ["source", "language", "fields", "is_async", "soft_fail"].freeze
105
+ }.freeze,
106
+ "label_render" => {
107
+ path: "/v1/label/render/{id}",
108
+ methods: ["GET"].freeze,
109
+ response: :any,
110
+ required: ["id"].freeze,
111
+ params: ["id", "format", "fields", "is_async", "soft_fail"].freeze
112
+ }.freeze,
113
+ "label_validate" => {
114
+ path: "/v1/label/validate",
115
+ methods: ["POST"].freeze,
116
+ response: :json,
117
+ required: ["source", "language"].freeze,
118
+ params: ["source", "language", "fields", "is_async", "soft_fail"].freeze
119
+ }.freeze,
120
+ "label_view" => {
121
+ path: "/v1/label/view/{id}",
122
+ methods: ["GET"].freeze,
123
+ response: :json,
124
+ required: ["id"].freeze,
125
+ params: ["id", "fields", "is_async", "soft_fail"].freeze
126
+ }.freeze,
127
+ "qrcode" => {
128
+ path: "/v1/qrcode",
129
+ methods: ["GET", "POST"].freeze,
130
+ response: :any,
131
+ required: ["data"].freeze,
132
+ params: ["data", "size", "ec_level", "dot_type", "color", "shape", "dot_size", "background", "margin", "version", "mode", "mask", "unit", "xml_declaration", "aria_label", "title", "desc", "format", "share", "fields", "is_async", "soft_fail"].freeze
133
+ }.freeze,
134
+ "stats" => {
135
+ path: "/v1/stats",
136
+ methods: ["GET"].freeze,
137
+ response: :json,
138
+ required: [].freeze,
139
+ params: ["engine", "path"].freeze
140
+ }.freeze,
141
+ "usage" => {
142
+ path: "/v1/usage",
143
+ methods: ["GET"].freeze,
144
+ response: :json,
145
+ required: [].freeze,
146
+ params: [].freeze
147
+ }.freeze
148
+ }.freeze
149
+ end