ask-web-search 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb54630bbd045d98988c9c09a75de1034b661f58557ca2382341b457410afbcb
+  data.tar.gz: 16528fa60924c43f4492028ee1f7d91a8f4b834253473501cbc2536bd401e2cc
+SHA512:
+  metadata.gz: 7e9b65c07f603682f3ce93b9a6056296f71e066f842b7aa3abefbe83a7a9783ce443b566d1dfc2ecf1bb5c11abdd3b406227e5db3846f10578152b4398bcb9bf
+  data.tar.gz: 1a46d1527807fb70a4169961fa0e5b56efb5a96e696c1d2d1c465ee8f4911bfaa2591c45220e6574b1d6bddfa2538ea57e21ed9e6d160d9c3feb8eb4e721cd8a

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kaka Ruto
+
+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,104 @@
+# ask-web-search
+
+A web search tool for the ask-rb ecosystem. Provides `Ask::Tools::WebSearch`, which
+searches the web via a local [SearXNG](https://docs.searxng.org/) instance and returns
+formatted results for LLM consumption.
+
+## Prerequisites
+
+A running SearXNG instance. The default is `http://localhost:8888`.
+
+Start one with Docker:
+
+```sh
+docker run -d --name searxng -p 8888:8080 searxng/searxng
+```
+
+Or use the provided `docker-compose.yml`:
+
+```sh
+cd searxng
+docker compose up -d
+```
+
+## Installation
+
+```sh
+gem install ask-web-search
+```
+
+Or in your Gemfile:
+
+```ruby
+gem "ask-web-search"
+```
+
+## Configuration
+
+Set the `SEARXNG_URL` environment variable to point to your SearXNG instance:
+
+```sh
+export SEARXNG_URL=http://localhost:8888
+```
+
+Defaults to `http://localhost:8888`.
+
+## Usage
+
+```ruby
+require "ask/web_search"
+
+tool = Ask::Tools::WebSearch.new
+result = tool.execute(query: "ruby programming language")
+puts result
+# => 1. Ruby — A Programmer's Best Friend
+#     https://www.ruby-lang.org
+#     Ruby is a dynamic, open-source programming language...
+```
+
+### With ask-rb Chat
+
+```ruby
+chat = Ask::Agent::Chat.new(
+  model: "deepseek-v4-flash",
+  tools: [Ask::Tools::WebSearch.new]
+)
+
+chat.ask("What's the latest on AI? Search the web.")
+```
+
+### With ask-rb Agent
+
+```ruby
+agent = Ask::Agent.new(tools: [Ask::Tools::WebSearch])
+agent.run("Find recent news about SpaceX")
+```
+
+## Output Format
+
+Results are returned as a numbered markdown-like string:
+
+```
+1. Ruby — A Programmer's Best Friend
+   https://www.ruby-lang.org
+   Ruby is a dynamic, open-source programming language...
+
+2. Ruby on Rails
+   https://rubyonrails.org
+   Rails is a web application framework...
+```
+
+If no results are found, returns `"No results found."`.
+
+## Development
+
+```sh
+git clone https://github.com/ask-rb/ask-web-search
+cd ask-web-search
+bundle install
+bundle exec rake test
+```
+
+## License
+
+MIT

data/lib/ask/web_search/tool.rb

@@ -0,0 +1,67 @@
+require "ask/tools"
+require "net/http"
+require "uri"
+require "json"
+
+module Ask
+  module Tools
+    class WebSearch < Ask::Tool
+      SEARXNG_URL = ENV.fetch("SEARXNG_URL", "http://localhost:8888")
+
+      description "Search the web for current information. Use this to get up-to-date results, recent events, or facts that may have changed."
+
+      params(
+        type: "object",
+        properties: {
+          query: { type: "string", description: "The search query" }
+        },
+        required: ["query"]
+      )
+
+      def execute(query:)
+        results = search(query)
+        format_results(results)
+      end
+
+      private
+
+      def search(query)
+        uri = URI("#{SEARXNG_URL}/search?q=#{URI.encode_www_form_component(query)}&format=json")
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.open_timeout = 5
+        http.read_timeout = 10
+        req = Net::HTTP::Get.new(uri)
+        req["User-Agent"] = "ask-web-search/1.0"
+        res = http.request(req)
+        raise "SearXNG returned #{res.code}: #{res.body}" unless res.code.start_with?("2")
+
+        data = JSON.parse(res.body)
+        parse_results(data)
+      end
+
+      def parse_results(data)
+        results = []
+        data.fetch("results", []).each do |r|
+          results << { url: r["url"], title: r["title"], content: r["content"] }
+        end
+        data.fetch("infoboxes", []).each do |ib|
+          results << { url: ib["id"], title: ib["infobox"], content: ib["content"] }
+        end
+        results.uniq { |r| r[:url] }
+      end
+
+      def format_results(results)
+        return "No results found." if results.empty?
+
+        results.each_with_index.map do |r, i|
+          line = "#{i + 1}. #{r[:title]}"
+          line += "\n   #{r[:url]}"
+          line += "\n   #{r[:content]}" if r[:content] && !r[:content].empty?
+          line
+        end.join("\n\n")
+      end
+    end
+  end
+end
+
+Ask::Tools.register(Ask::Tools::WebSearch) if defined?(Ask::Tools)

data/lib/ask/web_search/version.rb

@@ -0,0 +1,5 @@
+module Ask
+  module WebSearch
+    VERSION = "0.2.0"
+  end
+end

data/lib/ask/web_search.rb

@@ -0,0 +1,2 @@
+require_relative "web_search/version"
+require_relative "web_search/tool"

data/lib/ask-web-search.rb

@@ -0,0 +1 @@
+require_relative "ask/web_search"

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: ask-web-search
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Kaka Ruto
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ask-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Provides Ask::Tools::WebSearch, a tool that searches the web via SearXNG
+  (local instance). Works with any ask-rb chat or agent. Configure endpoint via SEARXNG_URL
+  env var.
+email:
+- kaka@myrrlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/ask-web-search.rb
+- lib/ask/web_search.rb
+- lib/ask/web_search/tool.rb
+- lib/ask/web_search/version.rb
+homepage: https://github.com/ask-rb/ask-web-search
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ask-rb/ask-web-search
+  source_code_uri: https://github.com/ask-rb/ask-web-search
+  changelog_uri: https://github.com/ask-rb/ask-web-search/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Web search tool for the ask-rb ecosystem
+test_files: []