moatlight 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f017b1b6fd54a94aa56c7fa61c9b14761d9717f524a29032f083aeb8cc040ad7
+  data.tar.gz: 1d10e2ae0f4e1e7ca024b7d7a58baee2d54afeeebd7f799d360337fc877ac4b4
+SHA512:
+  metadata.gz: 8472aed4ca35a36f7b6b175eb201da45ad9b5fb3149e6175daf003de963008bb018b17f4ffb06cd757bd27322d4fa27ccf179a29d0b3ccf1c6e2e4092b802807
+  data.tar.gz: bc19244dcc0f8188cd91de38108ca5feb265f85f313239aef4a4cb9490d75ef8fb067dba4e9da83c9e47c54d7a8bd0014dcc5737d5803d6da49a31cba3805e27

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Moatlight
+
+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,20 @@
+# moatlight (Ruby)
+
+Official Ruby client for the [Moatlight API](https://www.moatlight.com/docs). Standard library only.
+
+```ruby
+require "moatlight"
+
+client = Moatlight::Client.new                       # public endpoints need no token
+puts client.get_product["name"]
+
+client = Moatlight::Client.new(token: ENV["MOATLIGHT_TOKEN"])  # OAuth access token
+report = client.create_report(website: "yourcompany.com")
+client.start_report(report["id"])
+```
+
+Try it with no login against the sandbox: `Moatlight::Client.new(base_url: "https://www.moatlight.com/api/v1/sandbox")` is not needed, the sandbox shares the paths under `/api/v1/sandbox`; see https://www.moatlight.com/docs#sandbox.
+
+Writes send an `Idempotency-Key`, so a retry never starts a second report. `429` and `5xx` are retried and `Retry-After` is honoured. Errors raise `Moatlight::Error` with `status`, `code`, `message`, `hint`.
+
+Homepage: https://www.moatlight.com. Source: https://github.com/Moatlight/moatlight-agent-kit. License: MIT.

data/lib/moatlight/version.rb

@@ -0,0 +1,3 @@
+module Moatlight
+  VERSION = "1.1.0"
+end

data/lib/moatlight.rb

@@ -0,0 +1,178 @@
+# Moatlight API client. Standard library only.
+#
+# Writes carry an Idempotency-Key that stays the same across retries, and network errors, 429 and 5xx are
+# retried (Retry-After honoured), so a retry can never start a second report.
+require "json"
+require "net/http"
+require "securerandom"
+require "uri"
+require_relative "moatlight/version"
+
+module Moatlight
+  DEFAULT_BASE_URL = "https://www.moatlight.com".freeze
+
+  # An API error: HTTP status plus the code, message and hint from the JSON error body.
+  class Error < StandardError
+    attr_reader :status, :code, :hint, :retry_after, :body
+
+    def initialize(status, code, message, hint = nil, retry_after = nil, body = nil)
+      super("#{code}: #{message}")
+      @status, @code, @hint, @retry_after, @body = status, code, hint, retry_after, body
+    end
+  end
+
+  class Client
+    # RateLimit headers of the last answer: { limit:, remaining:, reset_seconds: }
+    attr_reader :last_rate_limit
+
+    def initialize(token: nil, base_url: DEFAULT_BASE_URL, max_retries: 3, timeout: 60)
+      @token = token
+      @base_url = base_url.sub(%r{/+\z}, "")
+      @max_retries = max_retries
+      @timeout = timeout
+      @last_rate_limit = {}
+    end
+
+    # ---- public ----
+    def get_product(fields: nil)
+      request("/api/v1/product", query: { fields: fields })
+    end
+    def get_pricing(fields: nil)
+      request("/api/v1/pricing", query: { fields: fields })
+    end
+    def get_sample_report
+      request("/api/v1/sample-report")
+    end
+    def list_faq(limit: nil, cursor: nil)
+      request("/api/v1/faq", query: { limit: limit, cursor: cursor })
+    end
+
+    # ---- account (OAuth token) ----
+    def get_account(fields: nil)
+      request("/api/v1/me", query: { fields: fields })
+    end
+    def list_reports(limit: nil, cursor: nil)
+      request("/api/v1/reports", query: { limit: limit, cursor: cursor })
+    end
+
+    # Every report, newest first, following next_cursor for you.
+    def each_report(limit: 50)
+      return enum_for(:each_report, limit: limit) unless block_given?
+
+      cursor = nil
+      loop do
+        page = list_reports(limit: limit, cursor: cursor)
+        page["reports"].each { |r| yield r }
+        cursor = page["next_cursor"]
+        break unless cursor
+      end
+    end
+
+    def create_report(website:, country: nil, language: nil, idempotency_key: nil)
+      body = { website: website, country: country, language: language }.compact
+      request("/api/v1/reports", method: :post, body: body, idempotency_key: idempotency_key)
+    end
+
+    def get_report(report_id, fields: nil)
+
+      request("/api/v1/reports/#{esc(report_id)}", query: { fields: fields })
+
+    end
+    def batch_get_reports(report_ids)
+      request("/api/v1/reports/batch", method: :post, body: { report_ids: report_ids })
+    end
+
+    def start_report(report_id, question_ids: nil, idempotency_key: nil)
+      body = question_ids ? { question_ids: question_ids } : {}
+      request("/api/v1/reports/#{esc(report_id)}/start", method: :post, body: body, idempotency_key: idempotency_key)
+    end
+
+    def get_report_actions(report_id)
+
+      request("/api/v1/reports/#{esc(report_id)}/actions")
+
+    end
+    def get_agent_readiness(report_id)
+      request("/api/v1/reports/#{esc(report_id)}/agent-readiness")
+    end
+
+    def scan_agent_readiness(report_id, force: false, idempotency_key: nil)
+      request("/api/v1/reports/#{esc(report_id)}/agent-readiness/scan", method: :post, body: { force: force },
+                                                                          idempotency_key: idempotency_key)
+    end
+
+    # ---- transport ----
+    def request(path, method: :get, query: nil, body: nil, idempotency_key: nil)
+      uri = URI(@base_url + path)
+      params = (query || {}).compact
+      uri.query = URI.encode_www_form(params) unless params.empty?
+      key = method == :post ? (idempotency_key || SecureRandom.uuid) : nil
+      attempt = 0
+      begin
+        res = perform(uri, method, body, key)
+        record_rate_limit(res)
+        code = res.code.to_i
+        if code.between?(200, 299)
+          return res.body.to_s.empty? ? nil : JSON.parse(res.body)
+        end
+
+        retry_after = res["Retry-After"].to_i
+        retry_after = nil if retry_after.zero?
+        if (code == 429 || code >= 500) && attempt < @max_retries
+          attempt += 1
+          sleep(retry_after ? [retry_after, 60].min : backoff(attempt - 1))
+          raise Retry
+        end
+        payload = begin
+          JSON.parse(res.body.to_s)
+        rescue JSON::ParserError
+          nil
+        end
+        err = payload.is_a?(Hash) ? (payload["error"] || {}) : {}
+        raise Error.new(code, err["code"] || "http_#{code}", err["message"] || res.message, err["hint"], retry_after, payload)
+      rescue Retry
+        retry
+      rescue SocketError, Timeout::Error, Errno::ECONNRESET, Errno::ECONNREFUSED, Net::OpenTimeout, Net::ReadTimeout
+        raise if attempt >= @max_retries
+
+        attempt += 1
+        sleep(backoff(attempt - 1))
+        retry
+      end
+    end
+
+    private
+
+    class Retry < StandardError; end
+
+    def perform(uri, method, body, key)
+      klass = method == :post ? Net::HTTP::Post : Net::HTTP::Get
+      req = klass.new(uri)
+      req["Accept"] = "application/json"
+      req["User-Agent"] = "moatlight-ruby/#{VERSION}"
+      req["Authorization"] = "Bearer #{@token}" if @token
+      req["Idempotency-Key"] = key if key
+      if body
+        req["Content-Type"] = "application/json"
+        req.body = JSON.generate(body)
+      end
+      Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https", open_timeout: @timeout, read_timeout: @timeout) do |http|
+        http.request(req)
+      end
+    end
+
+    def record_rate_limit(res)
+      num = ->(k) { (v = res[k]) && v =~ /\A\d+\z/ ? v.to_i : nil }
+      @last_rate_limit = { limit: num.("RateLimit-Limit"), remaining: num.("RateLimit-Remaining"), reset_seconds: num.("RateLimit-Reset") }
+    end
+
+    def backoff(attempt)
+
+      [0.5 * (2**attempt), 8].min + rand * 0.25
+
+    end
+    def esc(id)
+      URI.encode_www_form_component(id.to_s).gsub("+", "%20")
+    end
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: moatlight
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Moatlight
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-11-05 00:00:00.000000000 Z
+dependencies: []
+description: Measure whether ChatGPT and Google AI Overview name a business. Standard
+  library only; writes carry an Idempotency-Key and 429/5xx are retried.
+email: ceo@moatlight.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/moatlight.rb
+- lib/moatlight/version.rb
+homepage: https://www.moatlight.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.moatlight.com
+  source_code_uri: https://github.com/Moatlight/moatlight-agent-kit
+  documentation_uri: https://www.moatlight.com/docs
+  bug_tracker_uri: https://github.com/Moatlight/moatlight-agent-kit/issues
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Official Ruby client for the Moatlight API
+test_files: []