huntapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e7f7e050c1983582869212106f7d46e0898870a24fd4c4f633ac26aaf83b9934
+  data.tar.gz: cd738b628fc0edd34537b91dd6fff43dec86bd6bd1451f6788613488a577ace6
+SHA512:
+  metadata.gz: 0b0c0c781495d581c1db165a5c85624ea73b2d85024d2d9fabd7397ecc2c62e7d04a6c0bda28a6ef76399613bb982645690e28e66d3817c30d1bf36708b59042
+  data.tar.gz: '0260196eadc62b31554e6ba5cab5ada142a0e2991f3045d6597e2857497832b8ae481e60e4bed26bdc7cc0711604989d89f100b9896c8ab74d56020f703e823c'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 HuntAPI
+
+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,144 @@
+# HuntAPI Ruby SDK
+
+The official Ruby SDK for the [HuntAPI](https://www.huntapi.com) media download API.
+
+Download video and audio from public media URLs, or extract their metadata, with one async REST API.
+
+The SDK exposes **6 methods**, one per documented endpoint, plus a generic `request`. It only uses the Ruby standard library.
+
+## Requirements
+
+- Ruby 3.1 or newer
+
+## Installation
+
+```sh
+gem install huntapi
+```
+
+Or in your `Gemfile`:
+
+```ruby
+gem "huntapi"
+```
+
+## Get your API key
+
+[Sign up for HuntAPI](https://app.huntapi.com/register) or sign in, then copy your API key from the [dashboard](https://app.huntapi.com). The client reads `ENV["HUNTAPI_API_KEY"]` when no key is passed.
+
+## Quick start
+
+```ruby
+require "huntapi"
+
+client = HuntApi::Client.new(api_key: ENV.fetch("HUNTAPI_API_KEY"))
+response = client.media_metadata(query: "https://www.youtube.com/watch?v=Z5YP8kznWZs")
+puts response.data
+```
+
+Keyword arguments use the parameter names of the [API reference](https://docs.huntapi.com). Unknown names raise `HuntApi::SerializationError`; use `request` for undocumented parameters.
+
+## Async jobs
+
+Download endpoints are asynchronous: they return a `job_id`, and jobs can run for up to 12 hours. `wait_for_job` polls `GET /v1/jobs/{id}` until a terminal status (`CompletedJob`, `Error`, `NotFound`, `BadRequest`):
+
+```ruby
+submitted = client.video_download(query: "https://www.youtube.com/watch?v=Z5YP8kznWZs", video_quality: "720p")
+job = client.wait_for_job(submitted.data["job_id"]) { |j| puts "#{j['status']} #{j['progress']}%" }
+puts job.data
+```
+
+## GET or POST
+
+Methods use GET when the endpoint supports it (query string). POST sends the same parameters as JSON:
+
+```ruby
+client.audio_download(query: "test", request_options: { method: "POST" })
+```
+
+`nil` values are omitted, `false` and `0` are sent, and arrays repeat the parameter name.
+
+## Any endpoint
+
+```ruby
+response = client.request("GET", "/v1/usage")
+```
+
+## Errors
+
+```ruby
+begin
+  client.media_metadata(query: "https://www.youtube.com/watch?v=Z5YP8kznWZs")
+rescue HuntApi::APIError => e
+  warn "HTTP #{e.status}: #{e.message}"
+end
+```
+
+| Error | When |
+| --- | --- |
+| `HuntApi::ConfigurationError` | Missing API key, invalid options or unsupported method. |
+| `HuntApi::SerializationError` | A required parameter is missing, unknown or can't be sent. |
+| `HuntApi::TransportError` | Network failure or timeout. |
+| `HuntApi::APIError` | Non-2xx status (`status`, `error_message`, `response_body`, `raw_response`). |
+| `HuntApi::ResponseDecodingError` | A success response could not be decoded. |
+
+All of them inherit from `HuntApi::Error`.
+
+## Retries
+
+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.
+
+```ruby
+client = HuntApi::Client.new(max_retries: 5, retry_delay: 0.5)
+client.media_metadata(query: "https://www.youtube.com/watch?v=Z5YP8kznWZs", request_options: { max_retries: 0 }) # one request without retries
+```
+
+## Batch requests
+
+`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.
+
+```ruby
+inputs = ["https://www.youtube.com/watch?v=Z5YP8kznWZs", "https://www.youtube.com/watch?v=jNQXAC9IVRw"]
+results = client.batch(inputs, concurrency: 5) { |value| client.media_metadata(query: value) }
+results.each do |result|
+  if result.ok?
+    puts result.value.data
+  else
+    warn "#{inputs[result.index]}: #{result.error.message}"
+  end
+end
+```
+
+| Constant | Default | Description |
+| --- | --- | --- |
+| `HuntApi::Client::DEFAULT_CONCURRENCY` | `10` | Tasks run at the same time by batch |
+| `HuntApi::Client::DEFAULT_TIMEOUT` | `120` | Request timeout (seconds) |
+| `HuntApi::Client::MAX_RETRIES` | `3` | Retry attempts after a network error, a 408/5xx or a rate limit |
+| `HuntApi::Client::RETRY_BACKOFF_FACTOR` | `1.5` | Exponential backoff multiplier |
+| `HuntApi::Client::DEFAULT_RETRY_DELAY` | `1.0` | Delay before the first retry (seconds) |
+
+## Timeouts and custom transports
+
+```ruby
+client = HuntApi::Client.new(timeout: 60) # seconds, default 120
+client.media_metadata(query: "https://www.youtube.com/watch?v=Z5YP8kznWZs", request_options: { timeout: 30 })
+```
+
+A transport is any object with `call(method:, url:, headers:, body:, timeout:)` returning `[status, headers, body]`; the default is `HuntApi::NetHTTPTransport`.
+
+## Endpoints
+
+6 methods, generated from the [OpenAPI document](https://app.huntapi.com/openapi).
+
+| Method | HTTP | Description |
+| --- | --- | --- |
+| `audio_download` | GET / POST `/v1/audio/download` | Download audio from a URL via HuntAPI and receive a job id. |
+| `jobs` | GET `/v1/jobs/{id}` | Poll status, progress (0–100), and result of an async HuntAPI job. |
+| `media_metadata` | GET `/v1/media/metadata` | Extract metadata from a media URL without downloading the file. |
+| `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… |
+| `usage` | GET `/v1/usage` | Retrieve real-time usage statistics and credit balance for your Huntapi account. |
+| `video_download` | GET / POST `/v1/video/download` | Video Download |
+
+## License
+
+MIT — see [LICENSE](LICENSE).

data/examples/README.md

@@ -0,0 +1,11 @@
+# Examples
+
+```sh
+gem install huntapi
+export HUNTAPI_API_KEY="YOUR_API_KEY"
+ruby examples/json.rb
+```
+
+- `json.rb` — call the featured endpoint and print the JSON result.
+- `request.rb` — call any path with `request` and handle API errors.
+- `wait_for_job.rb` — start an async job and wait for its result.

data/examples/json.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "json"
+require "huntapi"
+
+client = HuntApi::Client.new # reads HUNTAPI_API_KEY
+response = client.media_metadata(query: "https://www.youtube.com/watch?v=Z5YP8kznWZs")
+puts JSON.pretty_generate(response.data)

data/examples/request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "huntapi"
+
+client = HuntApi::Client.new # reads HUNTAPI_API_KEY
+begin
+  response = client.request("GET", "/v1/usage")
+  puts response.data if response.json?
+rescue HuntApi::APIError => e
+  warn "HTTP #{e.status}: #{e.message}"
+end

data/examples/wait_for_job.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "huntapi"
+
+client = HuntApi::Client.new # reads HUNTAPI_API_KEY
+submitted = client.video_download(query: "https://www.youtube.com/watch?v=Z5YP8kznWZs", video_quality: "720p")
+job = client.wait_for_job(submitted.data["job_id"]) { |j| puts "#{j['status']} #{j['progress']}%" }
+puts job.data

data/lib/huntapi/client.rb

@@ -0,0 +1,266 @@
+# frozen_string_literal: true
+
+require "json"
+
+module HuntApi
+  # Official HuntAPI API client. Create one instance and reuse it.
+  class Client
+    include Operations
+
+    DEFAULT_BASE_URL = "https://api.huntapi.com"
+    DEFAULT_TIMEOUT = 120
+    # Tasks run at the same time by #batch.
+    DEFAULT_CONCURRENCY = 10
+    # Retries after a network error or a 408, 429, 500, 502, 503 or 504 response.
+    MAX_RETRIES = 3
+    # Each retry waits this many times longer than the previous one (a Retry-After header wins).
+    RETRY_BACKOFF_FACTOR = 1.5
+    # Seconds before the first retry.
+    DEFAULT_RETRY_DELAY = 1.0
+    MAX_RETRY_DELAY = 30.0
+    RETRYABLE_STATUSES = [408, 500, 502, 503, 504].freeze
+    API_KEY_ENVIRONMENT_VARIABLE = "HUNTAPI_API_KEY"
+    JOB_TERMINAL_STATUSES = %w[CompletedJob Error NotFound BadRequest].freeze
+    ERROR_MESSAGE_KEYS = %w[error message error_message detail].freeze
+
+    # @param api_key [String, nil] defaults to ENV["HUNTAPI_API_KEY"]
+    # @param base_url [String] API origin
+    # @param timeout [Numeric, nil] seconds per request; nil disables it
+    # @param headers [Hash] extra headers for every request
+    # @param max_retries [Integer] retries after a network error or a 408/429/5xx response; 0 disables them
+    # @param retry_delay [Numeric] seconds before the first retry, growing 1.5x per retry
+    # @param transport [#call] custom transport, see {NetHTTPTransport}
+    def initialize(api_key: nil, base_url: DEFAULT_BASE_URL, timeout: DEFAULT_TIMEOUT, headers: {},
+                   max_retries: MAX_RETRIES, retry_delay: DEFAULT_RETRY_DELAY, transport: nil)
+      api_key = ENV.fetch(API_KEY_ENVIRONMENT_VARIABLE, nil) if api_key.nil?
+      if !api_key.is_a?(String) || api_key.strip.empty?
+        raise ConfigurationError,
+              "A non-blank HuntAPI API key is required. Pass api_key: or set #{API_KEY_ENVIRONMENT_VARIABLE}."
+      end
+      raise ConfigurationError, "The HuntAPI API key cannot be used in an HTTP header." if api_key.match?(/[\r\n]/)
+
+      uri = URI.parse(base_url.to_s)
+      unless %w[http https].include?(uri.scheme) && uri.host
+        raise ConfigurationError, "base_url must be an absolute http or https URL."
+      end
+      raise ConfigurationError, "timeout must be a positive number or nil." if timeout && !(timeout.is_a?(Numeric) && timeout.positive?)
+      raise ConfigurationError, "transport must respond to #call." if transport && !transport.respond_to?(:call)
+
+      @api_key = api_key
+      @base_url = base_url.to_s.sub(%r{/+\z}, "")
+      @timeout = timeout
+      @headers = headers.to_h { |name, value| [name.to_s, value.to_s] }.freeze
+      raise ConfigurationError, "max_retries must be a non-negative Integer." unless max_retries.is_a?(Integer) && max_retries >= 0
+      raise ConfigurationError, "retry_delay must be a non-negative number." unless retry_delay.is_a?(Numeric) && retry_delay >= 0
+
+      @max_retries = max_retries
+      @retry_delay = retry_delay
+      @transport = transport || NetHTTPTransport.new
+    end
+
+    def inspect
+      "#<#{self.class.name} base_url=#{@base_url.inspect}>"
+    end
+
+    # Sends any request, including endpoints released after this SDK version.
+    # GET parameters travel in the query string; POST parameters travel in a JSON body.
+    # @return [JsonResponse, BinaryResponse]
+    def request(method, path, params = nil, timeout: nil, headers: nil, max_retries: nil)
+      send_request(method.to_s.upcase, path, params, { timeout: timeout, headers: headers, max_retries: max_retries }, :any)
+    end
+
+    # Runs the block for every item on +concurrency+ threads (default 10) and returns one {BatchResult} per item,
+    # in input order. A failing item never stops the others; the client is thread-safe.
+    #
+    #   results = client.batch(ids, concurrency: 5) { |id| client.some_endpoint(query: id) }
+    # @return [Array<BatchResult>]
+    def batch(items, concurrency: DEFAULT_CONCURRENCY)
+      raise ConfigurationError, "concurrency must be a positive Integer." unless concurrency.is_a?(Integer) && concurrency.positive?
+      raise ArgumentError, "batch needs a block" unless block_given?
+
+      list = items.to_a
+      results = Array.new(list.size)
+      queue = Queue.new
+      list.each_with_index { |item, index| queue << [item, index] }
+      queue.close
+      workers = Array.new([concurrency, list.size].min) do
+        Thread.new do
+          while (job = queue.pop)
+            item, index = job
+            results[index] = begin
+              BatchResult.new(index: index, value: yield(item), error: nil)
+            rescue StandardError => e
+              BatchResult.new(index: index, value: nil, error: e)
+            end
+          end
+        end
+      end
+      workers.each(&:join)
+      results
+    end
+
+    # Polls GET /v1/jobs/{id} until the job reaches a terminal status. The delay starts at +interval+ seconds
+    # and grows 1.5x per poll up to 60 s; +timeout+ defaults to 12 hours.
+    # @yieldparam job [Hash] the latest job document after every poll
+    # @return [JsonResponse]
+    def wait_for_job(job_id, interval: 3, timeout: 43_200)
+      raise SerializationError.new("A non-blank job id is required.", "id") if job_id.to_s.strip.empty?
+
+      started = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      loop do
+        last = request("GET", "/v1/jobs/{id}", { "id" => job_id })
+        yield last.data if block_given?
+        return last if last.data.is_a?(Hash) && JOB_TERMINAL_STATUSES.include?(last.data["status"])
+
+        elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - started
+        raise JobTimeoutError.new(job_id, last) if elapsed + interval > timeout
+
+        sleep(interval)
+        interval = (interval * 1.5).clamp(interval, [interval, 60].max)
+      end
+    end
+
+    private
+
+    def call_operation(name, params, options)
+      endpoint = ENDPOINTS.fetch(name)
+      options = (options || {}).transform_keys(&:to_sym)
+      method = (options[:method] || endpoint[:methods].first).to_s.upcase
+      unless endpoint[:methods].include?(method)
+        raise ConfigurationError, "#{endpoint[:path]} supports #{endpoint[:methods].join(', ')}, not #{method}."
+      end
+
+      params = params.transform_keys(&:to_s)
+      unknown = params.keys - endpoint[:params]
+      unless unknown.empty?
+        raise SerializationError.new(
+          "Unknown parameter(s) for #{name}: #{unknown.join(', ')}. Use #request for undocumented parameters.",
+          unknown.first
+        )
+      end
+      endpoint[:required].each do |required|
+        raise SerializationError.new("The \"#{required}\" parameter is required.", required) if params[required].nil?
+      end
+      send_request(method, endpoint[:path], params, options, endpoint[:response])
+    end
+
+    def send_request(method, path, params, options, expected)
+      raise ConfigurationError, "Unsupported HTTP method: #{method.inspect}." unless %w[GET POST].include?(method)
+      raise ConfigurationError, 'The request path must start with "/".' unless path.is_a?(String) && path.start_with?("/")
+
+      path, pairs, body = Serialization.serialize(method, path, params)
+      url = @base_url + path
+      url += "?#{Serialization.encode_query(pairs)}" unless pairs.empty?
+      headers = {
+        "Accept" => "application/json, */*;q=0.8",
+        "User-Agent" => "huntapi-ruby/#{VERSION}"
+      }.merge(@headers).merge((options[:headers] || {}).to_h { |k, v| [k.to_s, v.to_s] })
+      headers["x-api-key"] = @api_key
+      payload = nil
+      if body
+        headers["Content-Type"] = "application/json"
+        payload = JSON.generate(body)
+      end
+
+      max_retries = options[:max_retries] || @max_retries
+      attempt = 0
+      loop do
+        begin
+          status, response_headers, response_body = @transport.call(
+            method: method, url: url, headers: headers, body: payload, timeout: options[:timeout] || @timeout
+          )
+        rescue Timeout::Error => e
+          raise TransportError, "HuntAPI request timed out: #{e.message}"
+        rescue StandardError => e
+          raise TransportError, "HuntAPI request failed before an HTTP response was received: #{e.message}" if attempt >= max_retries
+
+          sleep(retry_delay(attempt, nil))
+          attempt += 1
+          next
+        end
+        raw = build_raw_response(status, response_headers, response_body)
+        return decode(raw, expected) if (200..299).cover?(raw.status)
+        raise api_error(raw) unless retryable?(raw) && attempt < max_retries
+
+        sleep(retry_delay(attempt, raw.headers["retry-after"]&.first))
+        attempt += 1
+      end
+    end
+
+    # Server errors and plan rate limits (401/429 "Rate limit exceeded") are retried; per-key quotas are not.
+    def retryable?(raw)
+      return true if RETRYABLE_STATUSES.include?(raw.status)
+      return false unless [401, 429].include?(raw.status)
+
+      message = api_error(raw).error_message.to_s.downcase
+      return false if message.include?("quota")
+
+      message.include?("rate limit") || (raw.status == 429 && message.empty?)
+    end
+
+    def retry_delay(attempt, retry_after)
+      seconds = Float(retry_after, exception: false) if retry_after
+      return [seconds, 60].min if seconds && seconds >= 0
+
+      [@retry_delay * (RETRY_BACKOFF_FACTOR**attempt), MAX_RETRY_DELAY].min
+    end
+
+    def build_raw_response(status, headers, body)
+      normalized = {}
+      (headers || {}).each { |name, values| normalized[name.to_s.downcase] = Array(values).map(&:to_s).freeze }
+      RawResponse.new(
+        status: status.to_i,
+        headers: normalized.freeze,
+        content_type: normalized["content-type"]&.first,
+        body: body.to_s.b
+      )
+    end
+
+    def api_error(raw)
+      parsed = parse_json(raw.body)
+      message = nil
+      if parsed.is_a?(Hash)
+        ERROR_MESSAGE_KEYS.each do |key|
+          value = parsed[key]
+          if value.is_a?(String) && !value.empty?
+            message = value
+            break
+          end
+        end
+      end
+      APIError.new(raw_response: raw, response_body: parsed == NOT_JSON ? nil : parsed, error_message: message)
+    end
+
+    def decode(raw, expected)
+      unless json_media_type?(raw.content_type)
+        if expected == :json
+          raise ResponseDecodingError.new("HuntAPI returned a successful non-JSON response for a JSON operation.", raw)
+        end
+
+        return BinaryResponse.new(bytes: raw.body, content_type: raw.content_type, raw_response: raw)
+      end
+      data = parse_json(raw.body)
+      if data == NOT_JSON
+        raise ResponseDecodingError.new("HuntAPI returned a successful JSON response that could not be decoded.", raw)
+      end
+
+      JsonResponse.new(data: data, raw_response: raw)
+    end
+
+    NOT_JSON = Object.new.freeze
+    private_constant :NOT_JSON
+
+    def parse_json(body)
+      JSON.parse(body.dup.force_encoding(Encoding::UTF_8))
+    rescue JSON::ParserError, EncodingError
+      NOT_JSON
+    end
+
+    def json_media_type?(content_type)
+      return false if content_type.nil?
+
+      media_type = content_type.split(";", 2).first.strip.downcase
+      media_type == "application/json" || media_type.end_with?("+json")
+    end
+  end
+end

data/lib/huntapi/endpoints.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Generated from the HuntAPI OpenAPI document. Do not edit by hand.
+
+module HuntApi
+  # Path, methods, response kind and parameter names of every documented operation.
+  ENDPOINTS = {
+    "audio_download" => {
+      path: "/v1/audio/download",
+      methods: ["GET", "POST"].freeze,
+      response: :json,
+      required: ["query"].freeze,
+      params: ["query", "download_type", "max_duration", "audio_quality", "audio_format", "webhook_url", "webhook_authorization", "fields", "is_async", "soft_fail"].freeze
+    }.freeze,
+    "jobs" => {
+      path: "/v1/jobs/{id}",
+      methods: ["GET"].freeze,
+      response: :json,
+      required: ["id"].freeze,
+      params: ["id"].freeze
+    }.freeze,
+    "media_metadata" => {
+      path: "/v1/media/metadata",
+      methods: ["GET"].freeze,
+      response: :json,
+      required: ["query"].freeze,
+      params: ["query", "fields", "is_async", "soft_fail"].freeze
+    }.freeze,
+    "stats" => {
+      path: "/v1/stats",
+      methods: ["GET"].freeze,
+      response: :json,
+      required: [].freeze,
+      params: ["engine", "path"].freeze
+    }.freeze,
+    "usage" => {
+      path: "/v1/usage",
+      methods: ["GET"].freeze,
+      response: :json,
+      required: [].freeze,
+      params: [].freeze
+    }.freeze,
+    "video_download" => {
+      path: "/v1/video/download",
+      methods: ["GET", "POST"].freeze,
+      response: :json,
+      required: ["query"].freeze,
+      params: ["query", "download_type", "max_duration", "video_quality", "video_format", "webhook_url", "webhook_authorization", "fields", "is_async", "soft_fail"].freeze
+    }.freeze
+  }.freeze
+end

data/lib/huntapi/errors.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module HuntApi
+  # Base class for every SDK-defined error.
+  class Error < StandardError; end
+
+  # The client configuration is missing or unusable.
+  class ConfigurationError < Error; end
+
+  # A request value cannot be represented safely on the wire.
+  class SerializationError < Error
+    attr_reader :param
+
+    def initialize(message, param = nil)
+      super(message)
+      @param = param
+    end
+  end
+
+  # The request failed before a complete HTTP response was received.
+  class TransportError < Error; end
+
+  # HuntAPI returned a non-success HTTP status.
+  class APIError < Error
+    attr_reader :status, :error_message, :response_body, :raw_response
+
+    def initialize(raw_response:, response_body: nil, error_message: nil)
+      super(error_message || "HuntAPI API request failed with status #{raw_response.status}.")
+      @status = raw_response.status
+      @error_message = error_message
+      @response_body = response_body
+      @raw_response = raw_response
+    end
+  end
+
+  # A successful response could not be decoded as the documented representation.
+  class ResponseDecodingError < Error
+    attr_reader :raw_response
+
+    def initialize(message, raw_response)
+      super(message)
+      @raw_response = raw_response
+    end
+  end
+
+  # An async job did not reach a terminal status before the deadline.
+  class JobTimeoutError < Error
+    attr_reader :job_id, :last_response
+
+    def initialize(job_id, last_response = nil)
+      super("Job #{job_id} did not finish before the deadline.")
+      @job_id = job_id
+      @last_response = last_response
+    end
+  end
+end

data/lib/huntapi/operations.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+# Generated from the HuntAPI OpenAPI document. Do not edit by hand.
+
+module HuntApi
+  # One method per documented endpoint. Mixed into {Client}.
+  module Operations
+    # Audio Download. Download audio from a URL via HuntAPI and receive a job id. Credit cost: 1 credit per call.
+    #
+    # +GET / POST /v1/audio/download+
+    #
+    # @param query [String] (required) URL to download audio from.
+    # @param download_type [String] Desired download type. Supported values: audio (default).
+    # @param max_duration [Numeric] Maximum duration of the downloaded content in seconds. If the audio is longer than this value, only the content up to this duration will be downloaded.
+    # @param audio_quality [String] Desired audio quality.
+    # @param audio_format [String] Desired output format for the audio.
+    # @param webhook_url [String] URL of the webhook where results will be sent. When specified, the system will attempt to send the response to this URL up to 3 times with a 5-second delay between each attempt. The results will be s…
+    # @param webhook_authorization [String] Authorization header for the webhook. This parameter allows you to add authentication to your webhook endpoint.
+    # @param fields [String] Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
+    # @param is_async [Boolean] Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob).
+    # @param soft_fail [Boolean] Return HTTP 200 even when an error occurs; the error is then in the response body.
+    # @param request_options [Hash, nil] +:method+ ("GET"/"POST"), +:timeout+ (seconds), +:headers+
+    # @return [JsonResponse]
+    def audio_download(request_options: nil, **params)
+      call_operation("audio_download", params, request_options)
+    end
+
+    # Jobs. Poll status, progress (0–100), and result of an async HuntAPI job.
+    #
+    # +GET /v1/jobs/{id}+
+    #
+    # @param id [String] (required) Job UUID returned as job_id by async endpoints such as /v1/video/download and /v1/audio/download.
+    # @param request_options [Hash, nil] +:method+ ("GET"/"POST"), +:timeout+ (seconds), +:headers+
+    # @return [JsonResponse]
+    def jobs(request_options: nil, **params)
+      call_operation("jobs", params, request_options)
+    end
+
+    # Media Metadata. Extract metadata from a media URL without downloading the file. Credit cost: 1 credit per call.
+    #
+    # +GET /v1/media/metadata+
+    #
+    # @param query [String] (required) Media URL to inspect (YouTube, Instagram, TikTok, Vimeo, X, Facebook, Twitch, Reddit, etc.).
+    # @param fields [String] Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
+    # @param is_async [Boolean] Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob).
+    # @param soft_fail [Boolean] Return HTTP 200 even when an error occurs; the error is then in the response body.
+    # @param request_options [Hash, nil] +:method+ ("GET"/"POST"), +:timeout+ (seconds), +:headers+
+    # @return [JsonResponse]
+    def media_metadata(request_options: nil, **params)
+      call_operation("media_metadata", params, request_options)
+    end
+
+    # Stats. Infrastructure health for an engine or endpoint over the last hour. Not scoped to your account or tenant. Enabled per account: HTTP 403 means contact support to activate it.
+    #
+    # +GET /v1/stats+
+    #
+    # @param engine [String] API family to check, for example video. Provide at least engine or path.
+    # @param path [String] Specific endpoint to check, for example /v1/video/download. If you also pass engine, use an endpoint from that API.
+    # @param request_options [Hash, nil] +:method+ ("GET"/"POST"), +:timeout+ (seconds), +:headers+
+    # @return [JsonResponse]
+    def stats(request_options: nil, **params)
+      call_operation("stats", params, request_options)
+    end
+
+    # Usage. Retrieve real-time usage statistics and credit balance for your Huntapi account.
+    #
+    # +GET /v1/usage+
+    #
+    # @param request_options [Hash, nil] +:method+ ("GET"/"POST"), +:timeout+ (seconds), +:headers+
+    # @return [JsonResponse]
+    def usage(request_options: nil, **params)
+      call_operation("usage", params, request_options)
+    end
+
+    # Video Download. Credit cost: 1 credit per call.
+    #
+    # +GET / POST /v1/video/download+
+    #
+    # @param query [String] (required) Video URL to download.
+    # @param download_type [String] Desired download type. You have three options:
+    # @param max_duration [Numeric] Maximum duration of the downloaded content in seconds. If the video/audio is longer than this value, only the content up to this duration will be downloaded.
+    # @param video_quality [String] Desired video quality. Available options:
+    # @param video_format [String] Desired output format for the video. Available options:
+    # @param webhook_url [String] URL of the webhook where results will be sent. When specified, the system will attempt to send the response to this URL up to 3 times with a 5-second delay between each attempt. The results will be s…
+    # @param webhook_authorization [String] Authorization header for the webhook. This parameter allows you to add authentication to your webhook endpoint. This value will be included in the Authorization header when making the webhook request…
+    # @param fields [String] Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
+    # @param is_async [Boolean] Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob).
+    # @param soft_fail [Boolean] Return HTTP 200 even when an error occurs; the error is then in the response body.
+    # @param request_options [Hash, nil] +:method+ ("GET"/"POST"), +:timeout+ (seconds), +:headers+
+    # @return [JsonResponse]
+    def video_download(request_options: nil, **params)
+      call_operation("video_download", params, request_options)
+    end
+  end
+end

data/lib/huntapi/responses.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module HuntApi
+  # Buffered HTTP response: status, lower-cased multi-value headers, content type and body bytes.
+  RawResponse = Struct.new(:status, :headers, :content_type, :body, keyword_init: true)
+
+  # Outcome of one Client#batch item: +value+ when +ok?+, else +error+.
+  BatchResult = Struct.new(:index, :value, :error, keyword_init: true) do
+    def ok? = error.nil?
+  end
+
+  # A successful JSON response; +data+ is the parsed body (string keys).
+  class JsonResponse
+    attr_reader :data, :raw_response
+
+    def initialize(data:, raw_response:)
+      @data = data
+      @raw_response = raw_response
+    end
+
+    def kind = :json
+    def json? = true
+    def binary? = false
+  end
+
+  # A successful non-JSON response (image, PDF, HTML…).
+  class BinaryResponse
+    attr_reader :bytes, :content_type, :raw_response
+
+    def initialize(bytes:, content_type:, raw_response:)
+      @bytes = bytes
+      @content_type = content_type
+      @raw_response = raw_response
+    end
+
+    def kind = :binary
+    def json? = false
+    def binary? = true
+
+    # Writes the body to +path+ and returns the number of bytes written.
+    def save(path)
+      File.binwrite(path, bytes)
+    end
+  end
+end

data/lib/huntapi/serialization.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "json"
+require "uri"
+
+module HuntApi
+  # Request serialization: path filling, query pairs and JSON bodies.
+  module Serialization
+    QUERY_STRING_PARAMS = %w[fields is_async soft_fail].freeze
+
+    module_function
+
+    # Fills {name} path segments, then returns [path, query_pairs, body].
+    # nil values are omitted; false and 0 are sent.
+    def serialize(method, path_template, params)
+      raise SerializationError, "Request parameters must be a Hash." unless params.nil? || params.is_a?(Hash)
+
+      remaining = {}
+      (params || {}).each { |name, value| remaining[name.to_s] = value unless value.nil? }
+      path = path_template.gsub(/\{([^}]+)\}/) do
+        name = Regexp.last_match(1)
+        raise SerializationError.new("The \"#{name}\" path parameter is required.", name) unless remaining.key?(name)
+
+        URI.encode_www_form_component(wire_string(name, remaining.delete(name))).gsub("+", "%20")
+      end
+
+      if method == "POST"
+        # The API reads the global parameters from the query string, whatever the method.
+        globals = QUERY_STRING_PARAMS.filter_map { |name| [name, wire_string(name, remaining.delete(name))] if remaining.key?(name) }
+        return [path, globals, remaining]
+      end
+
+      pairs = []
+      remaining.each do |name, value|
+        if value.is_a?(Array)
+          value.each { |item| pairs << [name, wire_string(name, item)] unless item.nil? }
+        else
+          pairs << [name, wire_string(name, value)]
+        end
+      end
+      [path, pairs, nil]
+    end
+
+    def wire_string(name, value)
+      case value
+      when String then value
+      when true, false, Integer, Symbol then value.to_s
+      when Float
+        raise SerializationError.new("The \"#{name}\" parameter must be a finite number.", name) unless value.finite?
+
+        value == value.floor ? value.to_i.to_s : value.to_s
+      when Hash, Array then JSON.generate(value)
+      else
+        raise SerializationError.new("The \"#{name}\" parameter has an unsupported type (#{value.class}).", name)
+      end
+    end
+
+    def encode_query(pairs)
+      pairs.map { |name, value| "#{escape(name)}=#{escape(value)}" }.join("&")
+    end
+
+    def escape(value)
+      URI.encode_www_form_component(value).gsub("+", "%20")
+    end
+  end
+end

data/lib/huntapi/transport.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+
+module HuntApi
+  # Default transport on Net::HTTP. A custom transport is any object with
+  # +call(method:, url:, headers:, body:, timeout:)+ returning +[status, headers, body]+,
+  # where headers is a Hash of lower-cased names to arrays of values.
+  class NetHTTPTransport
+    def call(method:, url:, headers:, body:, timeout:)
+      uri = URI(url)
+      request = (method == "POST" ? Net::HTTP::Post : Net::HTTP::Get).new(uri)
+      headers.each { |name, value| request[name] = value }
+      request.body = body if body
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      if timeout
+        http.open_timeout = timeout
+        http.read_timeout = timeout
+        http.write_timeout = timeout
+      end
+      response = http.start { |connection| connection.request(request) }
+      [response.code.to_i, response.to_hash, response.body || ""]
+    end
+  end
+end

data/lib/huntapi/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HuntApi
+  VERSION = "0.1.0"
+end

data/lib/huntapi.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "huntapi/version"
+require_relative "huntapi/errors"
+require_relative "huntapi/responses"
+require_relative "huntapi/serialization"
+require_relative "huntapi/transport"
+require_relative "huntapi/endpoints"
+require_relative "huntapi/operations"
+require_relative "huntapi/client"
+
+# Official Ruby SDK for the HuntAPI API (https://www.huntapi.com).
+module HuntApi
+end

data/sig/huntapi.rbs

@@ -0,0 +1,84 @@
+module HuntApi
+  VERSION: String
+  ENDPOINTS: Hash[String, Hash[Symbol, untyped]]
+
+  class Error < StandardError
+  end
+  class ConfigurationError < Error
+  end
+  class SerializationError < Error
+    attr_reader param: String?
+    def initialize: (String message, ?String? param) -> void
+  end
+  class TransportError < Error
+  end
+  class APIError < Error
+    attr_reader status: Integer
+    attr_reader error_message: String?
+    attr_reader response_body: untyped
+    attr_reader raw_response: RawResponse
+  end
+  class ResponseDecodingError < Error
+    attr_reader raw_response: RawResponse
+  end
+  class JobTimeoutError < Error
+    attr_reader job_id: String
+    attr_reader last_response: JsonResponse?
+  end
+
+  class RawResponse < Struct[untyped]
+    attr_accessor status: Integer
+    attr_accessor headers: Hash[String, Array[String]]
+    attr_accessor content_type: String?
+    attr_accessor body: String
+  end
+
+  class JsonResponse
+    attr_reader data: untyped
+    attr_reader raw_response: RawResponse
+    def kind: () -> :json
+    def json?: () -> true
+    def binary?: () -> false
+  end
+  class BinaryResponse
+    attr_reader bytes: String
+    attr_reader content_type: String?
+    attr_reader raw_response: RawResponse
+    def kind: () -> :binary
+    def json?: () -> false
+    def binary?: () -> true
+    def save: (String path) -> Integer
+  end
+
+  class BatchResult < Struct[untyped]
+    attr_accessor index: Integer
+    attr_accessor value: untyped
+    attr_accessor error: StandardError?
+    def ok?: () -> bool
+  end
+
+  type response = JsonResponse | BinaryResponse
+  type request_options = { ?method: String, ?timeout: Numeric?, ?headers: Hash[String, String], ?max_retries: Integer }
+
+  module Operations
+    def audio_download: (query: String, ?download_type: String, ?max_duration: Numeric, ?audio_quality: String, ?audio_format: String, ?webhook_url: String, ?webhook_authorization: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def jobs: (id: String, ?request_options: request_options?) -> JsonResponse
+    def media_metadata: (query: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def stats: (?engine: String, ?path: String, ?request_options: request_options?) -> JsonResponse
+    def usage: (?request_options: request_options?) -> JsonResponse
+    def video_download: (query: String, ?download_type: String, ?max_duration: Numeric, ?video_quality: String, ?video_format: String, ?webhook_url: String, ?webhook_authorization: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+  end
+
+  class Client
+    include Operations
+    DEFAULT_CONCURRENCY: Integer
+    MAX_RETRIES: Integer
+    RETRY_BACKOFF_FACTOR: Float
+    DEFAULT_RETRY_DELAY: Float
+    DEFAULT_TIMEOUT: Integer
+    def initialize: (?api_key: String?, ?base_url: String, ?timeout: Numeric?, ?headers: Hash[untyped, untyped], ?max_retries: Integer, ?retry_delay: Numeric, ?transport: untyped) -> void
+    def request: (String | Symbol method, String path, ?Hash[untyped, untyped]? params, ?timeout: Numeric?, ?headers: Hash[untyped, untyped]?, ?max_retries: Integer?) -> response
+    def batch: [I, T] (Enumerable[I] items, ?concurrency: Integer) { (I item) -> T } -> Array[BatchResult]
+    def wait_for_job: (String job_id, ?interval: Numeric, ?timeout: Numeric) ?{ (untyped job) -> void } -> JsonResponse
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: huntapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- HuntAPI
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-11-06 00:00:00.000000000 Z
+dependencies: []
+description: Download video and audio from public media URLs, or extract their metadata,
+  with one async REST API.
+email:
+- contact@huntapi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- examples/README.md
+- examples/json.rb
+- examples/request.rb
+- examples/wait_for_job.rb
+- lib/huntapi.rb
+- lib/huntapi/client.rb
+- lib/huntapi/endpoints.rb
+- lib/huntapi/errors.rb
+- lib/huntapi/operations.rb
+- lib/huntapi/responses.rb
+- lib/huntapi/serialization.rb
+- lib/huntapi/transport.rb
+- lib/huntapi/version.rb
+- sig/huntapi.rbs
+homepage: https://www.huntapi.com
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/huntapi/huntapi-ruby/issues
+  documentation_uri: https://docs.huntapi.com
+  homepage_uri: https://www.huntapi.com
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/huntapi/huntapi-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Official Ruby SDK for the HuntAPI media download API.
+test_files: []