firecrawl-sdk 1.17.5 → 1.17.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53e3ea073fe92f4844413816b5ead8af79b4592e0739fbeb1e29830cb46171b4
-  data.tar.gz: d5618aa818aee77b578d67cad9e3efdf4e9c0fa8e14cac20c336be9dbf726f09
+  metadata.gz: 22543b5053874d9d1a815949df7212abbcca9a72738a23ecfc696194696b6ad6
+  data.tar.gz: a53387ffdbb11b21ce357368f617dd83fdf341619a022db5997b8a4e3bfab6b1
 SHA512:
-  metadata.gz: 57e6f05f940ac44ccbe1ba89ca094a5901dc52933ac101faf7ff7c6b554517e520afe9d8cfdca5ce730df867a2c03e2427f3e92201a10e5935d5036f01f3934e
-  data.tar.gz: 63ee5fd6751e00f6fc3006a778c9b0664f8118142192d64a427c2a0509c19f4c1090375095f610c79d1fcea56210448779353e708648c9641dec6bef9f9ce3c0
+  metadata.gz: 7345b8e668fd1ece22c0de23408a7f99e6e5da42f2a573973cb32b4db18cd5bb2d8f61f505e0de5df4e0a0c96fd11af8c35531cd98bcdaa2aab470227678a9ac
+  data.tar.gz: 7a4ec95b23cd3e767e93742600a01c8a51123d9c9589823bf62f6a2fb2561ad77fb05c95a45324e44a0ef7322aea4fcd94a46ce6e3b705f61ec5831901ff27ec

data/README.md

@@ -1,6 +1,6 @@
 # Firecrawl Ruby SDK
 
-Ruby SDK for the [Firecrawl](https://firecrawl.dev) v2 web scraping API.
+Ruby SDK for [Firecrawl](https://firecrawl.dev), the context API for AI agents. Search, scrape, parse, crawl, map, and interact with the web, and run Agent and Monitor jobs on the v2 API.
 
 ## Prerequisites
 
@@ -193,6 +193,25 @@ results = client.search("latest news",
   Firecrawl::Models::SearchOptions.new(limit: 5, location: "US"))
 ```
 
+### Developer Search
+
+Search public repositories, GitHub issues, merged pull requests, READMEs and code documentation. `developer_search` replaces the deprecated `search_github`.
+
+```ruby
+response = client.developer_search(
+  "retry an http request with exponential backoff",
+  Firecrawl::Models::DeveloperSearchOptions.new(
+    k: 5,
+    types: ["issue", "pull_request"],
+    repos: ["square/okhttp"]
+  )
+)
+
+response.results.each do |result|
+  puts "#{result.title} #{result.url}"
+end
+```
+
 ### Agent
 
 ```ruby

data/lib/firecrawl/client.rb

@@ -133,10 +133,9 @@ module Firecrawl
 
     # Search GitHub research content.
     #
-    # @deprecated Stops responding after 2026-11-03. Use the developer index at
-    #   GET or POST /v2/search/developer, which this SDK does not wrap yet, so
-    #   call it directly. It does not carry over the score breakdown or the
-    #   web fallback results.
+    # @deprecated Stops responding after 2026-11-03. Use {#developer_search},
+    #   which does not carry over the score breakdown or the web fallback
+    #   results.
     # @param query_text [String] GitHub query
     # @param options [Hash] optional query parameters
     # @return [Hash]
@@ -144,6 +143,22 @@ module Firecrawl
       @http.get("/v2/search/research/github#{query(options.merge("query" => query_text, "origin" => "ruby-sdk@#{Firecrawl::VERSION}"))}")
     end
 
+    # Searches the developer index: public repositories, GitHub issues, merged
+    # pull requests, READMEs and code documentation.
+    #
+    # @param query [String] the search query
+    # @param options [Models::DeveloperSearchOptions, nil] developer search filters
+    # @return [Models::DeveloperSearchResponse]
+    # @raise [ArgumentError] if the query is blank
+    def developer_search(query, options = nil)
+      raise ArgumentError, "Query is required" if query.nil? || query.to_s.strip.empty?
+
+      body = { "query" => query }
+      body.merge!(options.to_h) if options
+      body["origin"] ||= "ruby-sdk@#{Firecrawl::VERSION}"
+      Models::DeveloperSearchResponse.new(@http.post("/v2/search/developer", body))
+    end
+
     # Interacts with the scrape-bound browser session for a scrape job.
     #
     # @param job_id [String] the scrape job ID
@@ -222,6 +237,7 @@ module Firecrawl
 
       body = { "url" => url }
       body.merge!(options.to_h) if options
+      body["origin"] ||= "ruby-sdk@#{Firecrawl::VERSION}"
       raw = @http.post("/v2/crawl", body)
       Models::CrawlResponse.new(raw)
     end
@@ -296,6 +312,7 @@ module Firecrawl
         body.merge!(opts_hash)
         body.merge!(nested) if nested
       end
+      body["origin"] ||= "ruby-sdk@#{Firecrawl::VERSION}"
       raw = @http.post("/v2/batch/scrape", body, extra_headers: extra_headers)
       Models::BatchScrapeResponse.new(raw)
     end
@@ -347,6 +364,7 @@ module Firecrawl
 
       body = { "url" => url }
       body.merge!(options.to_h) if options
+      body["origin"] ||= "ruby-sdk@#{Firecrawl::VERSION}"
       raw = @http.post("/v2/map", body)
       data = raw["data"] || raw
       Models::MapData.new(data)

data/lib/firecrawl/models/developer_search_options.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Firecrawl
+  module Models
+    # Options for a developer search request. Unset fields are omitted.
+    #
+    # - k: total ranked results, 1 to 100 (default 10)
+    # - passages: passages per result, 1 to 5 (default 1)
+    # - types: result kinds, any of "doc", "issue", "pull_request", "readme"
+    # - repos: GitHub owner/name filters, at most 20
+    # - sources: developer documentation source IDs, at most 20
+    # - language: one case-insensitive GitHub Linguist primary language
+    # - topic: repository topics that must all match, at most 8
+    # - license: one case-insensitive SPDX repository license identifier
+    # - min_stars, max_stars, archived, fork: repository filters
+    # - skills: "only" returns packaged agent-skill evidence only
+    class DeveloperSearchOptions
+      FIELDS = %i[
+        k passages types repos sources language topic license
+        min_stars max_stars archived fork skills
+      ].freeze
+
+      attr_reader(*FIELDS)
+
+      def initialize(**kwargs)
+        unknown = kwargs.keys - FIELDS
+        raise ArgumentError, "unknown developer search option(s): #{unknown.join(", ")}" unless unknown.empty?
+
+        FIELDS.each { |f| instance_variable_set(:"@#{f}", kwargs[f]) }
+      end
+
+      def to_h
+        FIELDS.to_h { |f| [f.to_s, public_send(f)] }.compact
+      end
+    end
+  end
+end

data/lib/firecrawl/models/developer_search_response.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Firecrawl
+  module Models
+    # One matched passage of a developer search result.
+    class DeveloperSearchPassage
+      attr_reader :text, :citation_url
+
+      def initialize(data)
+        @text = data["text"]
+        @citation_url = data["citation_url"]
+      end
+    end
+
+    # One ranked developer search result. `license` is either an SPDX string or
+    # a disclosure object (Hash), so it is kept as returned.
+    class DeveloperSearchResult
+      attr_reader :id, :url, :title, :passages, :license
+
+      def initialize(data)
+        @id = data["id"]
+        @url = data["url"]
+        @title = data["title"]
+        @passages = (data["passages"] || []).map { |p| DeveloperSearchPassage.new(p) }
+        @license = data["license"]
+      end
+    end
+
+    # Whether a requested repository is indexed, and which result types it has.
+    class DeveloperSearchRepoStatus
+      attr_reader :repo, :indexed, :types
+
+      def initialize(data)
+        @repo = data["repo"]
+        @indexed = data["indexed"] == true
+        @types = data["types"] || {}
+      end
+
+      def indexed?
+        indexed
+      end
+    end
+
+    # Whether a requested documentation source is indexed.
+    class DeveloperSearchSourceStatus
+      attr_reader :source, :indexed
+
+      def initialize(data)
+        @source = data["source"]
+        @indexed = data["indexed"] == true
+      end
+
+      def indexed?
+        indexed
+      end
+    end
+
+    # Response from a developer search. `repos` and `sources` are present only
+    # when those filters were requested.
+    class DeveloperSearchResponse
+      attr_reader :success, :partial, :results, :repos, :sources
+
+      def initialize(data)
+        @success = data["success"] == true
+        @partial = data["partial"] == true
+        @results = (data["results"] || []).map { |r| DeveloperSearchResult.new(r) }
+        @repos = data["repos"]&.map { |r| DeveloperSearchRepoStatus.new(r) }
+        @sources = data["sources"]&.map { |s| DeveloperSearchSourceStatus.new(s) }
+      end
+
+      def to_s
+        "DeveloperSearchResponse{results=#{results.size}}"
+      end
+    end
+  end
+end

data/lib/firecrawl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Firecrawl
-  VERSION = "1.17.5"
+  VERSION = "1.17.7"
 end

data/lib/firecrawl.rb

@@ -20,6 +20,8 @@ require_relative "firecrawl/models/map_options"
 require_relative "firecrawl/models/map_data"
 require_relative "firecrawl/models/search_options"
 require_relative "firecrawl/models/search_data"
+require_relative "firecrawl/models/developer_search_options"
+require_relative "firecrawl/models/developer_search_response"
 require_relative "firecrawl/models/parse_file"
 require_relative "firecrawl/models/parse_options"
 require_relative "firecrawl/models/parse_format"

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: firecrawl-sdk
 version: !ruby/object:Gem::Version
-  version: 1.17.5
+  version: 1.17.7
 platform: ruby
 authors:
 - Firecrawl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-18 00:00:00.000000000 Z
+date: 2026-10-20 00:00:00.000000000 Z
 dependencies: []
-description: A type-safe Ruby client for the Firecrawl v2 API. Supports scraping,
-  crawling, batch scraping, URL mapping, web search, and AI agent operations.
+description: 'A type-safe Ruby client for the Firecrawl v2 API: search, scrape, parse,
+  crawl, map, and interact with the web, run batch scrapes, and run Agent and Monitor
+  jobs.'
 email:
 - hello@firecrawl.dev
 executables: []
@@ -42,6 +43,8 @@ files:
 - lib/firecrawl/models/crawl_options.rb
 - lib/firecrawl/models/crawl_response.rb
 - lib/firecrawl/models/credit_usage.rb
+- lib/firecrawl/models/developer_search_options.rb
+- lib/firecrawl/models/developer_search_response.rb
 - lib/firecrawl/models/document.rb
 - lib/firecrawl/models/map_data.rb
 - lib/firecrawl/models/map_options.rb
@@ -83,5 +86,5 @@ requirements: []
 rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: Ruby SDK for the Firecrawl v2 web scraping API
+summary: Ruby SDK for Firecrawl, the context API for AI agents
 test_files: []