enconvert 0.0.1

data/lib/enconvert/v2_results.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+# V2 response types, returned as plain read-only Structs with snake_case
+# readers. Fields documented as optional may be `nil` — the API omits
+# unset fields entirely (response_model_exclude_none) and every mapper
+# guards each access.
+module Enconvert
+  class V2
+    # ------------------------------------------------------------------
+    # Enumerations (documented as frozen constants; not runtime-enforced —
+    # the wire values are plain strings, mirroring the Node SDK's
+    # compile-time-only string union types).
+    # ------------------------------------------------------------------
+    module Enums
+      PERCEIVE_OUTPUTS = %w[
+        markdown markdown_fit html_cleaned html_raw screenshot screenshot_full_page
+        pdf links images structured
+      ].freeze
+      PERCEIVE_EXTRACT_NAMES = %w[
+        tables prices contacts metadata main_content headings structured_data technologies all
+      ].freeze
+      PERCEIVE_RESOURCE_TYPES = %w[
+        image media font stylesheet script xhr fetch websocket manifest other
+      ].freeze
+      PERCEIVE_CACHE_MODES = %w[enabled bypass refresh].freeze
+      PERCEIVE_STATUSES = %w[queued processing completed failed].freeze
+      PERCEIVE_EXTRACTION_TIERS = %w[heuristic css llm].freeze
+      PERCEIVE_BATCH_OUTPUT_MODES = %w[manifest zip].freeze
+      PERCEIVE_BATCH_STATUSES = %w[queued processing completed failed partial].freeze
+      DISCOVER_MODES = %w[sitemap crawl hybrid].freeze
+      LOOKUP_CATEGORIES = %w[web news images scholar patents maps].freeze
+      LOOKUP_TIME_FILTERS = %w[hour day week month year].freeze
+      CSS_FIELD_TYPES = %w[text attribute html regex nested list nested_list].freeze
+      DISTILL_EXTRACTION_TIERS = %w[css llm mixed none].freeze
+      INGEST_MODES = %w[urls sitemap crawl files].freeze
+      INGEST_STATUSES = %w[queued discovering processing completed failed canceled].freeze
+      WATCH_DIFF_MODES = %w[auto text structured tables metadata].freeze
+      WATCHER_STATUSES = %w[active paused deleted].freeze
+    end
+
+    V2Tokens = Struct.new(:input, :output, keyword_init: true)
+
+    # A rendered output stored server-side, addressed by signed URL.
+    V2OutputArtifact = Struct.new(:url, :object_key, :size_bytes, :content_type, :expires_in, keyword_init: true)
+
+    PerceiveResult = Struct.new(
+      :operation_id, :status, :url, :url_final, :content_hash, :render_quality, :cache_hit,
+      :outputs, :structured, :extraction_tier, :tokens, :cost_cents, :duration_ms, :error, :warnings,
+      keyword_init: true
+    )
+
+    PerceiveBatchResult = Struct.new(
+      :job_id, :status, :output_mode, :total, :completed, :failed, :pending, :zip, :items, :warnings,
+      keyword_init: true
+    )
+
+    DiscoverResult = Struct.new(
+      :url, :mode, :total, :urls, :pages_crawled, :truncated, :robots_respected, :sources, :warnings,
+      keyword_init: true
+    )
+
+    # One search hit, optionally carrying its full perceive result.
+    LookupItem = Struct.new(
+      :title, :url, :snippet, :position, :source, :date, :image_url, :thumbnail_url, :extra, :perceive,
+      keyword_init: true
+    )
+
+    LookupResult = Struct.new(
+      :lookup_id, :query, :category, :country, :locale, :time_filter, :total, :results,
+      :perceive_top, :perceive_operation_ids, :answer_box, :knowledge_graph, :credits, :cost_cents, :warnings,
+      keyword_init: true
+    )
+
+    DistillItem = Struct.new(
+      :url, :url_final, :status, :data, :extraction_tier, :fields_from_css, :fields_from_llm,
+      :render_quality, :tokens, :cost_cents, :error, :warnings,
+      keyword_init: true
+    )
+
+    DistillResult = Struct.new(
+      :operation_id, :total, :completed, :failed, :results, :total_cost_cents, :warnings,
+      keyword_init: true
+    )
+
+    IngestJob = Struct.new(
+      :job_id, :status, :mode, :pages_discovered, :pages_processed, :pages_failed, :total_chunks,
+      :output_url, :error_message, :webhook_url, :webhook_delivered, :created_at, :completed_at, :warnings,
+      keyword_init: true
+    )
+
+    # Compact job row from list_ingest_jobs (webhook_url replaced by a flag).
+    IngestJobSummary = Struct.new(
+      :job_id, :status, :mode, :pages_discovered, :pages_processed, :pages_failed, :total_chunks,
+      :output_url, :error_message, :webhook_configured, :webhook_delivered, :created_at, :completed_at,
+      keyword_init: true
+    )
+
+    IngestJobList = Struct.new(:jobs, :skip, :limit, :has_more, keyword_init: true)
+
+    WebhookSecret = Struct.new(
+      :secret, :signature_header, :timestamp_header, :signature_scheme, :replay_tolerance_seconds, :rotated,
+      keyword_init: true
+    )
+
+    WebhookRetryResult = Struct.new(:job_id, :delivered, :attempts, :status_code, :detail, keyword_init: true)
+
+    Watcher = Struct.new(
+      :watcher_id, :url, :status, :frequency_minutes, :diff_mode, :track_fields, :webhook_url,
+      :notify_email, :consecutive_errors, :checks_count, :last_check_at, :next_check_at,
+      :last_change_at, :created_at, :updated_at,
+      keyword_init: true
+    )
+
+    # Compact watcher row from list_watchers.
+    WatcherSummary = Struct.new(
+      :watcher_id, :url, :status, :frequency_minutes, :checks_count, :consecutive_errors,
+      :last_check_at, :next_check_at, :last_change_at, :created_at,
+      keyword_init: true
+    )
+
+    WatcherList = Struct.new(:watchers, :skip, :limit, :has_more, keyword_init: true)
+
+    WatcherSnapshot = Struct.new(
+      :checked_at, :has_changes, :similarity, :render_quality, :change_count, :changes,
+      keyword_init: true
+    )
+
+    WatcherSnapshotList = Struct.new(:watcher_id, :snapshots, :limit, keyword_init: true)
+  end
+end

data/lib/enconvert/version.rb

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

data/lib/enconvert.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "enconvert/version"
+require_relative "enconvert/errors"
+require_relative "enconvert/formats"
+require_relative "enconvert/internal"
+require_relative "enconvert/results"
+require_relative "enconvert/v2_results"
+require_relative "enconvert/v2"
+require_relative "enconvert/client"
+
+# Enconvert — Ruby SDK for the Enconvert file conversion API.
+#
+# @example
+#   client = Enconvert::Client.new(api_key: "sk_...")
+#   result = client.convert_url_to_pdf("https://example.com", save_to: "page.pdf")
+#   puts result.presigned_url
+module Enconvert
+  # The 43 implemented `{input}-to-{output}` conversion endpoints.
+  # See Enconvert::Formats for the full format tables and helpers.
+  IMPLEMENTED_CONVERSIONS = Formats::IMPLEMENTED_CONVERSIONS
+
+  # List the output formats the API implements for a given input format.
+  #
+  # @example
+  #   Enconvert.valid_outputs_for("json") # => ["csv", "toml", "xml", "yaml"]
+  def self.valid_outputs_for(input_format)
+    Formats.valid_outputs_for(input_format)
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: enconvert
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Enconvert
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-07-15 00:00:00.000000000 Z
+dependencies: []
+description: 'Enconvert reads any web page or file into agent-ready Markdown, JSON,
+  or screenshots -- every read scored 0.0-1.0 for render quality, so blocked or empty-shell
+  pages never pass as real content. V2 API: perceive, discover, lookup, distill, ingest
+  (URLs or files), and watch. Also converts 40+ file and document formats -- URL-to-PDF/screenshot/markdown,
+  whole-site batch conversion, image conversion (jpeg/png/svg/heic/webp), and document
+  conversion (docx/pptx/xlsx/odt/html/markdown/csv/json/xml/yaml/toml).'
+email:
+- support@enconvert.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- enconvert.gemspec
+- lib/enconvert.rb
+- lib/enconvert/client.rb
+- lib/enconvert/errors.rb
+- lib/enconvert/formats.rb
+- lib/enconvert/internal.rb
+- lib/enconvert/results.rb
+- lib/enconvert/v2.rb
+- lib/enconvert/v2_results.rb
+- lib/enconvert/version.rb
+homepage: https://enconvert.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://enconvert.com
+  source_code_uri: https://github.com/conversionapi/ruby-sdk
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+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: Ruby SDK for Enconvert -- read any page or file into agent-ready Markdown,
+  JSON, or screenshots, every read scored. V2 perception + file conversion.
+test_files: []