crawlora 1.5.0.pre.sdk.2

data/lib/crawlora/pagination.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Crawlora
+  # Pagination helpers shared by the client's #paginate / #paginate_items.
+  module Pagination
+    PAGE_PARAM_NAMES = %w[page offset].freeze
+
+    module_function
+
+    # First page/offset query parameter an operation exposes, or nil.
+    def detect_page_param(operation)
+      names = (operation["queryParams"] || []).map { |p| p["name"] }
+      PAGE_PARAM_NAMES.find { |candidate| names.include?(candidate) }
+    end
+
+    # A page is empty when its `data` array (Crawlora envelope) or the page
+    # itself is empty/blank.
+    def page_empty?(response)
+      data = response.is_a?(Hash) && response.key?("data") ? response["data"] : response
+      return true if data.nil?
+      return data.empty? if data.respond_to?(:empty?)
+
+      !data
+    end
+
+    def default_start(page_param)
+      page_param == "offset" ? 0 : 1
+    end
+
+    # Default item extractor: the response's `data` list (Crawlora envelope), or
+    # the response itself when it is already an array.
+    def default_items(response)
+      return response["data"] if response.is_a?(Hash) && response["data"].is_a?(Array)
+      return response if response.is_a?(Array)
+
+      []
+    end
+  end
+end

data/lib/crawlora/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Crawlora
+  # SDK release version, in the shared `MAJOR.MINOR.PATCH-sdk.N` tag form (same
+  # as the Go/Java/PHP SDKs). RubyGems treats it as a prerelease and normalizes
+  # the published gem version to `1.5.0.pre.sdk.2`. Bumped across all SDK repos
+  # by the API repo's tools/sdkgen/bump_version.py.
+  VERSION = "1.5.0-sdk.2"
+end

data/lib/crawlora.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "crawlora/version"
+require_relative "crawlora/errors"
+require_relative "crawlora/pagination"
+require_relative "crawlora/operations"
+require_relative "crawlora/client"
+
+# Ruby SDK for the public Crawlora API.
+#
+# Quick start:
+#
+#   require "crawlora"
+#
+#   client = Crawlora.client(api_key: ENV["CRAWLORA_API_KEY"])
+#   result = client.bing.search(q: "web scraping")
+#   puts result["data"]
+module Crawlora
+  # Build a Client. When a block is given, the client is yielded and closed
+  # afterwards (releasing pooled connections).
+  def self.client(**options)
+    client = Client.new(**options)
+    return client unless block_given?
+
+    begin
+      yield client
+    ensure
+      client.close
+    end
+  end
+end