charai 0.2.0.beta2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bfb144fd502f114e8749abd5cc23188a99014ad30e47452e81a5b2aa755028a
-  data.tar.gz: 5210f942e451c57aaae8bfa72cd803dc77ec8cffc5c517ac7b2da56498d70b9e
+  metadata.gz: e29c5d04584453bf1c1c6058a1409eab97233add4ea62d46f3b845831fcd52fa
+  data.tar.gz: f52cc6f53cd78ccf09ef90e58c5e530675c3e4e5c3b19857e48dff2987b25f51
 SHA512:
-  metadata.gz: e900017b056d4f0d58e3895a4364a575b1925b10ca41d5fa50066d2394329f8f5de897deadafe6b5cd8767b506021f373bebe6bbea2f3df7d9c9b1a6cbe7c06f
-  data.tar.gz: d11259eb89c00fa35a76125ab8c339b697de67f538865a7d8df6d1a497cf1bb51770d0654097527e318e20d864f19a4412278577814d2e0134f800eb468371a8
+  metadata.gz: 3cca134105baa5085a7554311408af3acc33ee5543efab1d62f78bd4a1a28530c3f0dcd8309cbab21f983d7acc734c72b1c78cee30587dfcb03e366847e16293
+  data.tar.gz: 5a6c5dc76e397125bba78a0685a65c638e276c83ced2fb732fb1d64138c28c9b74151cbac55626fb6ae3b18cdac0a157a4f5e8a8f8af61ab4b482f6edf628f97

data/README.md

@@ -5,6 +5,14 @@
 
 Chat + Ruby + AI = Charai
 
+Charai is an AI-powered Capybara driver that enables natural language web testing. Write your E2E tests by describing what you want to test in plain language, and let AI handle the browser interactions.
+
+## Requirements
+
+- Ruby 2.7 or higher
+- Firefox Developer Edition
+- OpenAI API key or compatible AI service (Azure OpenAI, Gemini, Ollama)
+
 ## Setup
 
 Add `gem 'charai'` into your project's Gemfile, and then `bundle install`
@@ -41,16 +49,75 @@ config = Charai::OpenaiConfiguration.new(
 
 ### Azure OpenAI (Recommended)
 
-```
+```ruby
 config = Charai::AzureOpenaiConfiguration.new(
   endpoint_url: 'https://YOUR-APP.openai.azure.com/openai/deployments/gpt-4o/chat/completions?api-version=2024-05-01-preview',
   api_key: 'aabbcc00112233445566'
 )
 ```
 
+**⚠️ Important Note for Azure OpenAI Environment Variables:**
+
+When setting the endpoint URL via environment variables, you must include the full path with `/deployments/{model}/chat/completions`:
+
+```bash
+# ❌ This will NOT work
+export AZURE_OPENAI_ENDPOINT_URL="https://your-resource.cognitiveservices.azure.com/openai/responses?api-version=2025-04-01-preview"
+
+# ✅ This works correctly
+export AZURE_OPENAI_ENDPOINT_URL="https://your-resource.cognitiveservices.azure.com/openai/deployments/gpt-4o-mini/chat/completions?api-version=2025-04-01-preview"
+```
+
+The endpoint URL must specify:
+1. Your Azure resource endpoint
+2. The deployment name (e.g., `gpt-4o-mini`, `gpt-4o`)
+3. The `/chat/completions` path
+4. The API version parameter
+
+### Gemini
+
+```ruby
+config = Charai::GeminiOpenaiConfiguration.new(
+  model: 'gemini-2.0-flash-exp',
+  api_key: 'your-gemini-api-key'
+)
+```
+
+### Ollama (Local AI)
+
+```ruby
+config = Charai::OllamaConfiguration.new(
+  endpoint_url: 'http://localhost:11434',
+  model: 'llama3.2'
+)
+```
+
 ## Usage
 
-Since this driver works with the OpenAI service, we can easily describe E2E test like below :)
+### Basic Example
+
+```ruby
+RSpec.describe "Login test", type: :feature do
+  before do
+    Capybara.current_driver = :charai
+  end
+
+  it "should login successfully" do
+    page.driver << <<~MARKDOWN
+    * Navigate to the login page
+    * Enter "user@example.com" in the email field
+    * Enter "password123" in the password field
+    * Click the login button
+    * Verify that you're redirected to the dashboard page
+    * Check that the username "John Doe" is displayed in the header
+    MARKDOWN
+  end
+end
+```
+
+### Advanced Example with Instructions
+
+You can provide additional context about your application to help the AI better understand the page structure:
 
 ```ruby
 before do
@@ -165,7 +232,47 @@ config.around(:each, type: :feature) do |example|
 end
 ```
 
-With this report, we can check evidences for each test and investigate failed tests (postmotem).
+With this report, we can check evidences for each test and investigate failed tests (postmortem).
+
+## Troubleshooting
+
+### Firefox Developer Edition not found
+
+Make sure Firefox Developer Edition is installed in the correct location:
+- macOS: `/Applications/Firefox Developer Edition.app`
+- Linux: `/usr/bin/firefox-devedition`
+
+You can also set a custom path:
+```ruby
+Charai::Driver.new(app,
+  openai_configuration: config,
+  firefox_path: '/path/to/firefox-dev'
+)
+```
+
+### AI not understanding the page
+
+Provide more context using `additional_instruction`:
+```ruby
+page.driver.additional_instruction = <<~MARKDOWN
+  * This is a single-page application (SPA)
+  * Wait for elements to load before interacting
+  * The main navigation is in a hamburger menu on mobile
+MARKDOWN
+```
+
+### Tests running slowly
+
+Consider using a faster AI model or running in headless mode:
+```ruby
+Capybara.current_driver = :charai_headless
+```
+
+## Links
+
+- [GitHub Repository](https://github.com/YusukeIwaki/charai)
+- [RubyGems Page](https://rubygems.org/gems/charai)
+- [Report Issues](https://github.com/YusukeIwaki/charai/issues)
 
 ## License
 

data/charai.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email = ["q7w8e9w8q7w8e9@yahoo.co.jp"]
 
   spec.summary = "charai(Chat + Ruby + AI) Capybara driver"
-  spec.description = "Prototype impl for Kaigi on Rails 2024 presentation."
+  spec.description = "Prototype impl for Kaigi on Rails 2024 & 2025 presentation."
   spec.homepage = "https://github.com/YusukeIwaki/charai"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.2.0"

data/lib/charai/input_tool.rb

@@ -60,7 +60,6 @@ module Charai
       trigger_callback(:on_action_start, 'capture_screenshot', {})
 
       current_url = @browsing_context.url
-          binding.irb
       @browsing_context.capture_screenshot(format: { type: 'png' }).tap do |binary|
         if @message_sender
           message = Agent::Message.new(

data/lib/charai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Charai
-  VERSION = "0.2.0.beta2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: charai
 version: !ruby/object:Gem::Version
-  version: 0.2.0.beta2
+  version: 0.2.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-13 00:00:00.000000000 Z
+date: 2025-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.1
-description: Prototype impl for Kaigi on Rails 2024 presentation.
+description: Prototype impl for Kaigi on Rails 2024 & 2025 presentation.
 email:
 - q7w8e9w8q7w8e9@yahoo.co.jp
 executables: []