autom 0.1.0

data/sig/autom.rbs

@@ -0,0 +1,101 @@
+module Autom
+  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 bing_search: (query: String, ?page: Numeric, ?num: Numeric, ?location: String, ?lat: Numeric, ?lon: Numeric, ?mkt: String, ?cc: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def brave_images: (query: String, ?page: Numeric, ?gl: String, ?hl: String, ?safe: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def brave_search: (query: String, ?page: Numeric, ?gl: String, ?hl: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def brave_videos: (query: String, ?page: Numeric, ?gl: String, ?hl: String, ?safe: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def duckduckgo_search: (query: String, ?page: Numeric, ?gl: String, ?hl: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def finder_google_countries: (query: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def finder_google_languages: (query: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def finder_google_locations: (query: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def google_images: (query: String, ?page: Numeric, ?google_domain: String, ?gl: String, ?hl: String, ?cr: String, ?lr: String, ?async: bool, ?safe: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def google_jobs: (query: String, ?uds: String, ?lrad: Numeric, ?ltype: Numeric, ?location: String, ?uule: String, ?google_domain: String, ?gl: String, ?hl: String, ?cr: String, ?lr: String, ?next_page_token: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def google_maps: (query: String, ?page: Numeric, ?google_domain: String, ?gl: String, ?hl: String, ?cr: String, ?lr: String, ?ll: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def google_news: (query: String, ?page: Numeric, ?num: Numeric, ?google_domain: String, ?gl: String, ?hl: String, ?cr: String, ?lr: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def google_search: (query: String, ?tbs: String, ?safe: String, ?location: String, ?uule: String, ?google_domain: String, ?gl: String, ?hl: String, ?cr: String, ?lr: String, ?page: Numeric, ?num: Numeric, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def google_search_ai: (query: String, ?location: String, ?uule: String, ?google_domain: String, ?gl: String, ?hl: String, ?cr: String, ?lr: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def google_search_autocomplete: (query: String, ?cp: Numeric, ?google_domain: String, ?gl: String, ?hl: String, ?cr: String, ?lr: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def google_search_light: (query: String, ?google_domain: String, ?gl: String, ?hl: String, ?cr: String, ?lr: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def google_shopping: (query: String, ?page: Numeric, ?location: String, ?uule: String, ?google_domain: String, ?gl: String, ?hl: String, ?cr: String, ?lr: String, ?safe: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def google_videos: (query: String, ?location: String, ?uule: String, ?google_domain: String, ?gl: String, ?hl: String, ?cr: String, ?lr: String, page: Numeric, ?num: Numeric, ?safe: String, ?fields: String, ?is_async: bool, ?soft_fail: bool, ?request_options: request_options?) -> JsonResponse
+    def jobs: (id: String, ?request_options: request_options?) -> JsonResponse
+    def search: (query: String, ?engines: String, ?gl: String, ?hl: 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 yahoo_search: (query: String, ?page: Numeric, ?gl: String, ?hl: 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: autom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Autom
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-11-06 00:00:00.000000000 Z
+dependencies: []
+description: Google, Bing and Brave search results as structured JSON — web, maps,
+  news, shopping, images, jobs and AI Mode.
+email:
+- contact@autom.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- examples/README.md
+- examples/json.rb
+- examples/request.rb
+- examples/wait_for_job.rb
+- lib/autom.rb
+- lib/autom/client.rb
+- lib/autom/endpoints.rb
+- lib/autom/errors.rb
+- lib/autom/operations.rb
+- lib/autom/responses.rb
+- lib/autom/serialization.rb
+- lib/autom/transport.rb
+- lib/autom/version.rb
+- sig/autom.rbs
+homepage: https://www.autom.dev
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/automdev/autom-ruby/issues
+  documentation_uri: https://docs.autom.dev
+  homepage_uri: https://www.autom.dev
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/automdev/autom-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 Autom SERP API.
+test_files: []