omniai-tools 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbc1dae9ab7fe238fadd4c48d660f342e851b1803e3e33e22c487ceabd3bf32b
-  data.tar.gz: cf37310371a1711adaedea7609ce340552c7858faab4d9b60c6d26919864490a
+  metadata.gz: d27871f61c1d70be893cce085bf33c0b3d9280686ff1a0ba64f35835b7bf10d4
+  data.tar.gz: 6dfddb639a3cbb99069cbb890bb5d8529bf152e5c246bcc90aaf344505758ea9
 SHA512:
-  metadata.gz: 766b80d9ab2b3bf459eeee00473c69f352fd4e61b70a4be9531a76b164d1e1fbc7373fe634033f19c519dc56098b77e536431d53a46bd91bde017887ed91f61a
-  data.tar.gz: 1fc747fda798976e4c13e4c0fd208a83253b61d8f1b473029e085308f7603f7d20e616f32c9b0e564952e6f48cf4e1eb10cc5570d8d6525c6c4a9728449e5b08
+  metadata.gz: ff02138674bc5176e869badb4268530d025e5543ca993eaea8aa74ee2ad114592bd5ac3e8ecd8ad8a882ec0af6dd57b9d74448b04669d3fe8295db3c9176e7b8
+  data.tar.gz: c8a79aa2542b81475148b878ab7785d8bea1b32e4649718bd2a5d4684ba897e010da3d392ce9f3da38374f51e10ea2fc074a3a07a2392172a6c68e93f9298aa5

data/Gemfile

@@ -6,6 +6,11 @@ gemspec
 
 gem "factory_bot"
 gem "irb"
+gem "nokogiri"
+gem "omniai-anthropic"
+gem "omniai-google"
+gem "omniai-mistral"
+gem "omniai-openai"
 gem "rake"
 gem "redcarpet"
 gem "rspec"
@@ -16,4 +21,6 @@ gem "rubocop-factory_bot"
 gem "rubocop-rake"
 gem "rubocop-rspec"
 gem "simplecov"
+gem "sqlite3"
+gem "watir"
 gem "yard"

data/README.md

@@ -8,6 +8,108 @@
 
 `OmniAI::Tools` is a library of pre-built tools to simplify integrating common tasks with [OmniAI](https://github.com/ksylvest/omniai).
 
+## Browser
+
+Database tools are focused on running SQL statements:
+
+```ruby
+require "omniai/openai"
+require "omniai/tools"
+
+require "watir"
+
+browser = Watir::Browser.new(:chrome)
+
+client = OmniAI::OpenAI::Client.new
+logger = Logger.new($stdout)
+
+tools = [
+  OmniAI::Tools::Browser::VisitTool,
+  OmniAI::Tools::Browser::InspectTool,
+  OmniAI::Tools::Browser::ButtonClickTool,
+  OmniAI::Tools::Browser::LinkClickTool,
+  OmniAI::Tools::Browser::TextFieldAreaSetTool,
+].map { |klass| klass.new(browser:, logger:) }
+
+puts "Type 'exit' or 'quit' to leave."
+
+prompt = OmniAI::Chat::Prompt.build do |builder|
+  builder.system <<~TEXT
+    You are tasked with assisting a user in browsing the web.
+  TEXT
+end
+
+loop do
+  print "# "
+  text = gets.strip
+  break if %w[exit quit].include?(text)
+
+  prompt.user(text)
+  response = client.chat(prompt, stream: $stdout, tools:)
+  prompt.assistant(response.text)
+end
+```
+
+```
+Type 'exit' or 'quit' to leave.
+# Visit news.ycombinator.com and list the top 5 posts.
+
+[browser] OmniAI::Tools::Browser::VisitTool#execute url="https://news.ycombinator.com"
+[browser] OmniAI::Tools::Browser::InspectTool#execute
+
+Here are the top 5 posts on Hacker News right now:
+
+...
+```
+
+## Database
+
+Database tools are focused on running SQL statements:
+
+```ruby
+require "omniai/openai"
+require "omniai/tools"
+
+require "sqlite3"
+
+db = SQLite3::Database.new(":memory:")
+
+client = OmniAI::OpenAI::Client.new
+logger = Logger.new($stdout)
+
+tools = [
+  OmniAI::Tools::Database::SqliteTool.new(logger:, db:),
+]
+
+puts "Type 'exit' or 'quit' to leave."
+
+prompt = OmniAI::Chat::Prompt.build do |builder|
+  builder.system "Use tools to manage a database as requested."
+end
+
+loop do
+  print "# "
+  text = gets.strip
+  break if %w[exit quit].include?(text)
+
+  prompt.user(text)
+  response = client.chat(prompt, stream: $stdout, tools:)
+  prompt.assistant(response.text)
+end
+```
+
+```
+Type 'exit' or 'quit' to leave.
+# Generate tables for artists, albums, songs, bands, members and populate it with data surrounding the Beatles.
+
+CREATE TABLE artists (id INTEGER PRIMARY KEY, name TEXT NOT NULL)
+CREATE TABLE bands (id INTEGER PRIMARY KEY, name TEXT NOT NULL)
+CREATE TABLE members (id INTEGER PRIMARY KEY, artist_id INTEGER, band_id INTEGER, FOREIGN KEY(artist_id) REFERENCES artists(id), FOREIGNKEY(band_id) REFERENCES bands(id))"
+CREATE TABLE albums (id INTEGER PRIMARY KEY, title TEXT NOT NULL, band_id INTEGER, FOREIGN KEY(band_id) REFERENCES bands(id))
+CREATE TABLE songs (id INTEGER PRIMARY KEY, title TEXT NOT NULL, album_id INTEGER, FOREIGN KEY(album_id) REFERENCES albums(id))
+...
+```
+
 ## Disk
 
 Disk tools are focused on creating, updating, and deleting files and directories within a "root":

data/lib/omniai/tools/browser/base_tool.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "watir"
+
+module OmniAI
+  module Tools
+    module Browser
+      # @example
+      #   class SeleniumTool < BaseTool
+      #     # ...
+      #   end
+      class BaseTool < OmniAI::Tool
+        # @param logger [IO] An optional logger for debugging executed commands.
+        # @param browser [Watir::Browser]
+        def initialize(browser:, logger: Logger.new(IO::NULL))
+          super()
+          @logger = logger
+          @browser = browser
+        end
+      end
+    end
+  end
+end

data/lib/omniai/tools/browser/button_click_tool.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "sqlite3"
+
+module OmniAI
+  module Tools
+    module Browser
+      # @example
+      #   browser = Watir::Browser.new(:chrome)
+      #   tool = OmniAI::Tools::Browser::VisitTool.new(browser:)
+      #   tool.click_link(selector: "link_id")
+      class ButtonClickTool < BaseTool
+        description "A browser automation tool for clicking a specific button."
+
+        parameter :selector, :string, description: "The ID or text of the button to interact with."
+
+        required %i[selector]
+
+        # @param to [String] The URL to navigate to.
+        def execute(selector:)
+          @logger.info("#{self.class.name}##{__method__} selector=#{selector.inspect}")
+
+          element = find(text: selector) || find(id: selector)
+
+          return { error: "unknown selector=#{selector}" } if element.nil?
+
+          element.click
+        end
+
+      protected
+
+        # @return [Watir::Anchor, nil]
+        def find(selector)
+          element = @browser.button(selector)
+          element if element.exists?
+        end
+      end
+    end
+  end
+end

data/lib/omniai/tools/browser/inspect_tool.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module OmniAI
+  module Tools
+    module Browser
+      # @example
+      #   browser = Watir::Browser.new(:chrome)
+      #   tool = OmniAI::Tools::Browser::InspectTool.new(browser:)
+      #   tool.execute
+      class InspectTool < BaseTool
+        description "A browser automation tool for viewing the HTML for the browser."
+
+        # @return [String]
+        def execute
+          @logger.info("#{self.class.name}##{__method__}")
+
+          html = @browser.html
+          doc = Nokogiri::HTML(html)
+
+          doc.css("link").each(&:remove)
+          doc.css("style").each(&:remove)
+          doc.css("script").each(&:remove)
+
+          doc.to_html
+        end
+      end
+    end
+  end
+end

data/lib/omniai/tools/browser/link_click_tool.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "sqlite3"
+
+module OmniAI
+  module Tools
+    module Browser
+      # @example
+      #   browser = Watir::Browser.new(:chrome)
+      #   tool = OmniAI::Tools::Browser::VisitTool.new(browser:)
+      #   tool.click_link(selector: "link_id")
+      class LinkClickTool < BaseTool
+        description "A browser automation tool for clicking a specific link."
+
+        parameter :selector, :string, description: "The ID or text of the link to interact with."
+
+        # @param to [String] The ID or text of the link to interact with.
+        def execute(selector:)
+          @logger.info("#{self.class.name}##{__method__} selector=#{selector.inspect}")
+
+          element = find(text: selector) || find(value: selector) || find(id: selector)
+
+          return { error: "unknown selector=#{selector}" } if element.nil?
+
+          element.click
+        end
+
+      protected
+
+        # @return [Watir::Anchor, nil]
+        def find(selector)
+          element = @browser.a(selector)
+          element if element.exists?
+        end
+      end
+    end
+  end
+end

data/lib/omniai/tools/browser/text_field_area_set_tool.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "sqlite3"
+
+module OmniAI
+  module Tools
+    module Browser
+      # @example
+      #   browser = Watir::Browser.new(:chrome)
+      #   tool = OmniAI::Tools::Browser::TextFieldSetTool.new(browser:)
+      #   tool.execute(selector: "...", text: "...")
+      class TextFieldAreaSetTool < BaseTool
+        description "A browser automation tool for clicking a specific link."
+
+        parameter :selector, :string, description: "The ID / name of the text field / area to interact with."
+        parameter :text, :string, description: "The text to set."
+
+        required %i[selector]
+
+        # @param selector [String] The ID / name of the text field / text area to interact with.
+        # @param text [String] The text to set.
+        def execute(selector:, text:)
+          @logger.info("#{self.class.name}##{__method__} selector=#{selector.inspect} text=#{text.inspect}")
+
+          element = find(id: selector) || find(name: selector)
+
+          return { error: "unknown selector=#{selector}" } if element.nil?
+
+          element.set(text)
+        end
+
+      protected
+
+        # @param selector [Hash]
+        #
+        # @return [Watir::TextArea, Watir::TextField, nil]
+        def find(selector)
+          find_text_area(selector) || find_text_field(selector)
+        end
+
+        # @param selector [Hash]
+        #
+        # @return [Watir::TextArea, nil]
+        def find_text_area(selector)
+          element = @browser.textarea(selector)
+          element if element.exists?
+        end
+
+        # @param selector [Hash]
+        #
+        # @return [Watir::TextField, nil]
+        def find_text_field(selector)
+          element = @browser.text_field(selector)
+          element if element.exists?
+        end
+      end
+    end
+  end
+end

data/lib/omniai/tools/browser/visit_tool.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "sqlite3"
+
+module OmniAI
+  module Tools
+    module Browser
+      # @example
+      #   driver = Selenium::WebDriver.for :chrome
+      #   tool = OmniAI::Tools::Browser::VisitTool.new(driver:)
+      #   tool.execute(to: "https://news.ycombinator.com")
+      class VisitTool < BaseTool
+        description "A browser automation tool for navigating to a specific URL."
+
+        parameter :url, :string, description: "A URL (e.g. https://news.ycombinator.com)."
+
+        required %i[url]
+
+        # @param url [String] A URL (e.g. https://news.ycombinator.com).
+        def execute(url:)
+          @logger.info("#{self.class.name}##{__method__} url=#{url.inspect}")
+
+          @browser.goto(url)
+        end
+      end
+    end
+  end
+end

data/lib/omniai/tools/database/base_tool.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "sqlite3"
+
+module OmniAI
+  module Tools
+    module Database
+      # @example
+      #   tool = OmniAI::Tools::Database::SqliteTool.new
+      #   tool.execute(path: "./foo/bar")
+      class BaseTool < OmniAI::Tool
+        # @param logger [IO] An optional logger for debugging executed commands.
+        def initialize(logger: Logger.new(IO::NULL))
+          super()
+          @logger = logger
+        end
+
+        # @example
+        #   tool = OmniAI::Tools::Database::BaseTool.new
+        #   tool.execute(statements: ["SELECT * FROM people"])
+        #
+        # @param statements [Array<String>]
+        #
+        # @return [Array<Hash>]
+        def execute(statements:)
+          [].tap do |executions|
+            statements.map do |statement|
+              execution = perform(statement:)
+              executions << execution
+              break unless execution[:status].eql?(:ok)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omniai/tools/database/sqlite_tool.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "sqlite3"
+
+module OmniAI
+  module Tools
+    module Database
+      # @example
+      #   tool = OmniAI::Tools::Database::SqliteTool.new
+      #   tool.execute(path: "./foo/bar")
+      class SqliteTool < BaseTool
+        description <<~TEXT
+          Executes SQL commands (INSERT / UPDATE / SELECT / etc) on a database.
+
+          Example:
+
+          STATEMENTS:
+
+              [
+                'CREATE TABLE people (id INTEGER PRIMARY KEY, name TEXT NOT NULL)',
+                'INSERT INTO people (name) VALUES ('John')',
+                'INSERT INTO people (name) VALUES ('Paul')',
+                'SELECT * FROM people',
+                'DROP TABLE people'
+              ]
+
+          RESULT:
+
+              [
+                {
+                  "status": "OK",
+                  "statement": "CREATE TABLE people (id INTEGER PRIMARY KEY, name TEXT NOT NULL)",
+                  "result": "..."
+                },
+                {
+                  "status": "OK",
+                  "statement": "INSERT INTO people (name) VALUES ('John')"
+                  "result": "..."
+                },
+                {
+                  "status": "OK",
+                  "statement": "INSERT INTO people (name) VALUES ('Paul')",
+                  "result": "..."
+                },
+                {
+                  "status": "OK",
+                  "statement": "SELECT * FROM people",
+                  "result": "..."
+                },
+                {
+                  "status": "OK",
+                  "statement": "DROP TABLE people",
+                  "result": "..."
+                }
+              ]
+        TEXT
+
+        parameter(
+          :statements,
+          :array,
+          description: "A list of SQL statements to run sequentially.",
+          items: OmniAI::Schema.string(description: 'A SQL statement to run (e.g. "SELECT * FROM ...").')
+        )
+
+        required %i[statements]
+
+        # @param logger [IO] An optional logger for debugging executed commands.
+        # @param db [SQLite3::Database] A sqlite database.
+        def initialize(db:, logger: Logger.new(IO::NULL))
+          super(logger:)
+          @db = db
+        end
+
+        # @example
+        #   tool = OmniAI::Tools::Database::BaseTool.new
+        #   tool.execute(statements: ["SELECT * FROM people"])
+        #
+        # @param statements [Array<String>]
+        #
+        # @return [Array<Hash>]
+        def execute(statements:)
+          @logger.info("#{self.class.name}#{__method__} statements=#{statements.inspect}")
+
+          [].tap do |executions|
+            statements.map do |statement|
+              execution = perform(statement:)
+              executions << execution
+              break unless execution[:status].eql?(:ok)
+            end
+          end
+        end
+
+      protected
+
+        # @param statement [String]
+        #
+        # @return [Hash]
+        def perform(statement:)
+          result = @db.execute2(statement)
+
+          { status: :ok, statement:, result: }
+        rescue ::SQLite3::Exception => e
+          @logger.warn("ERROR: #{e.message}")
+
+          { status: :error, statement:, result: e.message }
+        end
+      end
+    end
+  end
+end

data/lib/omniai/tools/disk/directory_move_tool.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Tools
+    module Disk
+      # @example
+      #   tool = OmniAI::Tools::Disk::DirectoryCreateTool.new(root: "./project")
+      #   tool.execute(path: "./foo/bar")
+      class DirectoryCreateTool < BaseTool
+        description "Creates a directory."
+
+        parameter :old_path, :string, description: "a path (e.g. `./old`)"
+        parameter :new_path, :string, description: "a path (e.g. `./new`)"
+
+        required %i[old_path new_path]
+
+        # @param old_path [String]
+        # @param new_path [String]
+        #
+        # @return [String]
+        def execute(old_path:, new_path:)
+          @logger.info("#{self.class.name}#execute path=#{path.inspect}")
+
+          FileUtils.mv(old_path, new_path)
+        rescue SecurityError => e
+          @logger.error(e.message)
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/omniai/tools/docker/compose_run_tool.rb

@@ -14,7 +14,7 @@ module OmniAI
         parameter :service, :string, description: "The service to run the command on (e.g. `app`)."
         parameter :command, :string, description: "The command to run (e.g. `rspec`)."
         parameter :args, :array, description: "The arguments for the command.",
-          items: OmniAI::Tool::Property.string(description: "An argument for the command (e.g. `spec/main_spec.rb`).")
+          items: OmniAI::Schema.string(description: "An argument for the command (e.g. `spec/main_spec.rb`).")
 
         # @param service [String]
         # @param command [String]

data/lib/omniai/tools/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module Tools
-    VERSION = "0.3.0"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: omniai-tools
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 bindir: exe
 cert_chain: []
-date: 2025-04-23 00:00:00.000000000 Z
+date: 2025-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniai
@@ -49,9 +49,18 @@ files:
 - bin/console
 - bin/setup
 - lib/omniai/tools.rb
+- lib/omniai/tools/browser/base_tool.rb
+- lib/omniai/tools/browser/button_click_tool.rb
+- lib/omniai/tools/browser/inspect_tool.rb
+- lib/omniai/tools/browser/link_click_tool.rb
+- lib/omniai/tools/browser/text_field_area_set_tool.rb
+- lib/omniai/tools/browser/visit_tool.rb
+- lib/omniai/tools/database/base_tool.rb
+- lib/omniai/tools/database/sqlite_tool.rb
 - lib/omniai/tools/disk/base_tool.rb
 - lib/omniai/tools/disk/directory_create_tool.rb
 - lib/omniai/tools/disk/directory_delete_tool.rb
+- lib/omniai/tools/disk/directory_move_tool.rb
 - lib/omniai/tools/disk/file_create_tool.rb
 - lib/omniai/tools/disk/file_delete_tool.rb
 - lib/omniai/tools/disk/file_move_tool.rb