chromate-rb 0.0.1.pre → 0.0.2.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76c6ae8c74c3238f41db246836afd03b20c8bbb19a706575a424be2de6b84d41
-  data.tar.gz: 9b07855d6fb9139e0c0a223bffa40f1558de7e82d4ca62ec20039ad22ceabfce
+  metadata.gz: 8d230805cd031a51b1d63131bf6dfba4692d46e7d1d8789a949c4767e461911e
+  data.tar.gz: 408a79332c2fdd4d96b28e53b149bbda859bcc1e621186a7911a3264d1673363
 SHA512:
-  metadata.gz: 2701dc1057b0f038f53aea6e42a34dc5a6a222900c61b2f1004f58dbb00453467d31ec8f8acb0e6a6545e4f32af5d2461873abdd898a0a47c05339dc65e038f6
-  data.tar.gz: b8ef6aba60741c21570c36e68f4a3e6e9e4aa4fa52335284b8aef97f63fa3da7d5849bac44bc2c64db2436fd42f81adda365a5e00f63f60f119dc3e54dcb2533
+  metadata.gz: cfe50cf45e2261fe0bcc7c03a0b66aa91f54c787a7688133b4722dde1bc22f86bcc0379b3b396efc2ea3c8257ac6d2755879d68796d637dd77025cc28b871e01
+  data.tar.gz: 2b7b59b031a8302f716abb8405bc9e7d67fce3077493b368924d53865e31475ee6356bd0c617a74ea32ac97ca600f572e306d62887aa40236bf87bc10e6ac4a4

data/.rubocop.yml

@@ -5,6 +5,7 @@ AllCops:
     - 'Rakefile'
     - 'bin/**/*'
     - 'vendor/**/*'
+    - 'docker_root/**/*'
 
 Style/StringLiterals:
   EnforcedStyle: single_quotes

data/CHANGELOG.md

@@ -1,5 +1,56 @@
-## [Unreleased]
+# [Unreleased]
 
-## [0.1.0] - 2024-10-26
+## 🚀 Features
+- **Add keyboard actions**: Implemented keyboard interactions, including typing and key pressing.
+- **Add drag and drop action**: Implemented drag and drop bewteen elements
 
-- Initial release
+## 🛠 Core Enhancements
+- **Improve mouse movements**: Keep mouse position between interaction during browser session
+- **Improve mouse movements**: Improving Bézier curve usage for more human like behavior
+
+# Changelog v0.0.1.pre
+
+## 🚀 Features
+- **Add virtual mouse on macOS**: Introduced a virtual mouse controller for macOS. (commit `9cb095b`)
+- **Abstract mouse control**: Unified mouse control across different operating systems with an abstraction layer. (commit `a7e0732`)
+- **Add shadow interactor**: Added support for interacting with elements inside shadow DOM. (commit `6cdea5c`)
+
+## 🛠 Core Enhancements
+- **Add debug_url spec**: Introduced debug specifications for better error tracking. (commit `4c06c75`)
+- **Add client specs**: Comprehensive tests for the core client functionality. (commits `1e17955`, `18f0bf1`)
+- **Add config spec**: Added configuration testing specs. (commit `588407f`)
+- **Add MPEG for recording**: Integrated MPEG support for screen recording (currently experimental). (commit `d149a14`)
+- **Improve arguments priority**: Refined the argument handling mechanism for better control. (commit `9849d0f`)
+- **Add Dockerfile for testing**: Included a Docker setup for running tests in isolated environments. (commit `57f334e`)
+- **Use xdotool for Linux and add X screenshot**: Enhanced Linux support using `xdotool` for mouse control and added X screenshot capability. (commit `80ef37f`)
+- **Improve wait for load**: Improved logic for waiting until the page is fully loaded before proceeding. (commit `28e9371`)
+- **Improve DOM events**: Enhanced handling of DOM events for better interaction. (commit `36a425c`)
+- **Improve nested elements handling**: Enhanced support for working with nested and complex elements. (commit `ad03ec3`)
+- **Get element attributes**: Added method to retrieve element attributes as a hash. (commit `b71e1f7`)
+- **Add WEBrick for testing server**: Added a simple WEBrick server for testing purposes. (commit `fc70006`)
+- **Improve element interactions**: Various improvements in element manipulation methods. (commit `5430d8c`)
+- **Start native mouse support**: Began implementation of native mouse interactions. (commit `fce1aef`)
+- **Improve undetection mechanisms**: Enhanced techniques to bypass bot detection. (commit `7ff622a`)
+
+## 🐛 Bug Fixes
+- **Fix bad stop method**: Corrected an issue with the stopping method that caused unexpected behavior. (commit `4b45d6d`)
+- **Fix Docker X size**: Resolved issues with the size of the X window in Docker environments. (commit `41edece`)
+
+## 📝 Documentation
+- **Update README**: Updated the README file with new instructions and examples. (commit `8118913`)
+- **Add logo**: Added a logo to the project for better branding. (commit `2a5cbb9`)
+
+## 🧪 CI/CD
+- **Enable CI pipeline**: Added continuous integration (CI) setup for automated testing. (commit `4160aa1`)
+
+## 🧹 Refactor
+- **Rename mouse hardware**: Refactored the naming conventions for mouse-related classes. (commit `89d6ae1`)
+- **Remove record notion (temporary)**: Temporarily removed the recording feature for further refinement. (commit `fdb3e0e`)
+
+## 🛠 Infrastructure
+- **Start adding Xvfb support**: Introduced Xvfb support for headless testing. (commit `678a8a5`)
+- **Improve spec servers**: Made enhancements to the testing servers for more robust specs. (commit `51e64f4`)
+
+## 🏁 Project Initialization
+- **Initialize project**: Set up the initial project structure. (commit `3ec91f4`)
+- **Start element development**: Began the implementation of the `Element` class. (commit `adadef0`)

data/README.md

@@ -1,9 +1,11 @@
 # Chromate
-[![eth3rnit3 - chromate](https://img.shields.io/static/v1?label=eth3rnit3&message=chromate&color=red&logo=github)](https://github.com/eth3rnit3/chromate "Go to GitHub repo")
-[![GitHub release](https://img.shields.io/github/release/eth3rnit3/chromate?include_prereleases=&sort=semver&color=red)](https://github.com/eth3rnit3/chromate/releases/)
+[![eth3rnit3 - chromate](https://img.shields.io/static/v1?label=eth3rnit3&message=chromate&color=a8a9ad&logo=ruby&labelColor=9b111e)](https://github.com/eth3rnit3/chromate "Go to GitHub repo")
+[![GitHub release](https://img.shields.io/github/release/eth3rnit3/chromate?include_prereleases=&sort=semver&color=a8a9ad)](https://github.com/eth3rnit3/chromate/releases/)
+[![License](https://img.shields.io/badge/License-MIT-a8a9ad)](#license)
 [![Ruby](https://github.com/Eth3rnit3/chromate/actions/workflows/main.yml/badge.svg)](https://github.com/Eth3rnit3/chromate/actions/workflows/main.yml)
 [![issues - chromate](https://img.shields.io/github/issues/eth3rnit3/chromate)](https://github.com/eth3rnit3/chromate/issues)
-[![License](https://img.shields.io/badge/License-MIT-red)](#license)
+
+![logo](logo.png)
 
 Chromate is a custom driver for Chrome using the Chrome DevTools Protocol (CDP) to create undetectable bots with human-like behavior. The ultimate goal is to enable the creation of AI agents capable of navigating and performing actions on the web on behalf of the user. This gem is the first step towards achieving that goal.
 
@@ -12,13 +14,30 @@ Chromate is a custom driver for Chrome using the Chrome DevTools Protocol (CDP)
 Add gem to your application's Gemfile:
 
 ```sh
-bundle add chromate
+# Github pkgs
+bundle add chromate --source https://rubygems.pkg.github.com/eth3rnit3
+
+# Or add manualy within a block
+# source "https://rubygems.pkg.github.com/eth3rnit3" do
+#   gem "chromate"
+# end
+
+# or
+
+# Rubygems
+bundle add chromate-rb
+
 ```
 
 Or install it yourself as:
 
 ```sh
-gem install chromate
+# Github pkgs
+gem install chromate --source https://rubygems.pkg.github.com/eth3rnit3
+
+# or
+
+gem install chromate-rb
 ```
 
 ## Usage
@@ -36,7 +55,7 @@ browser.start
 url = 'http://example.com'
 browser.navigate_to(url)
 browser.find_element('#some-element').click
-browser.screenshot_to_file('screenshot.png')
+browser.screenshot('screenshot.png')
 
 browser.stop
 ```
@@ -106,6 +125,14 @@ ruby your_script.rb # or bundle exec rspec
 
 This setup ensures that all necessary dependencies are installed and configured correctly, allowing you to focus on writing your automation scripts without worrying about the underlying environment.
 
+## Disclaimer
+
+**Chromate** is an open-source project designed to provide a solid foundation for the creation of autonomous AI agents, fostering innovation and development in the field of artificial intelligence. This project is developed with an educational and collaborative spirit, aiming to promote responsible and ethical usage.
+
+Under no circumstances is **Chromate** intended to be used for creating automated bots, scraping tools, or any other activities that violate platform policies or applicable laws. The author disclaims any responsibility for improper or illegal use of this project.
+
+Users are encouraged to comply with platform terms of service and to adopt practices that adhere to ethical and legal standards.
+
 ## Contribution
 
 Contributions are welcome! If you have suggestions for improvements or new features, please open an issue or submit a pull request on GitHub.

data/Rakefile

@@ -12,9 +12,12 @@ RuboCop::RakeTask.new
 task default: %i[spec rubocop]
 
 require_relative "lib/chromate"
+require_relative 'spec/support/modes'
 
 namespace :chromate do
   namespace :test do
+    include Support::Modes
+
     task :open do
       browser = Chromate::Browser.new(headless: false)
       browser.start
@@ -25,46 +28,75 @@ namespace :chromate do
       browser.stop
     end
 
+    # Xfvb mode
+    # docker run -it --rm -v $(pwd):/app --env CHROMATE_MODE=docker-xvfb chromate:latest bundle exec rake chromate:test:all
+
+    # BotBrowser mode
+    # docker run -it --rm -v $(pwd):/app --env CHROMATE_MODE=bot-browser chromate:latest bundle exec rake chromate:test:all
+
+    # Default mode
+    # docker run -it --rm -v $(pwd):/app chromate:latest bundle exec rake chromate:test:all
+    task :all do
+      Rake::Task["chromate:test:pixelscan"].invoke
+      Rake::Task["chromate:test:brotector"].invoke
+      Rake::Task["chromate:test:bot"].invoke
+      Rake::Task["chromate:test:cloudflare"].invoke
+    end
+
     task :pixelscan do
-      browser = Chromate::Browser.new
+      browser = Chromate::Browser.new(browser_args)
       browser.start
       browser.navigate_to("https://pixelscan.net")
       sleep 10
-      browser.screenshot_to_file("results/pixelscan.png")
+      browser.screenshot("results/pixelscan.png")
       browser.stop
     end
 
     task :brotector do
-      require "chromate/native/mouse_controller"
-      browser = Chromate::Browser.new
+      browser = Chromate::Browser.new(browser_args)
       browser.start
-      browser.navigate_to("https://kaliiiiiiiiii.github.io/brotector?crash=false")
+      browser.navigate_to("https://kaliiiiiiiiii.github.io/brotector")
       sleep 2
-      # browser.click_element("#clickHere")
-      mouse = Chromate::Native::MouseController.new(browser.client)
-      mouse.click(100, 100)
-      browser.screenshot_to_file("results/brotector.png")
+      browser.click_element("#clickHere")
+      sleep 3
+      browser.screenshot("results/brotector.png")
       browser.stop
     end
 
     task :bot do
-      browser = Chromate::Browser.new
+      browser = Chromate::Browser.new(browser_args)
       browser.start
       browser.navigate_to("https://bot.sannysoft.com")
       sleep 2
-      browser.screenshot_to_file("results/bot.png")
+      browser.screenshot("results/bot.png")
       browser.stop
     end
 
     task :cloudflare do
-      Chromate.configure do |config|
-        config.headless = false
-      end
-      browser = Chromate::Browser.new
+      browser = Chromate::Browser.new(browser_args)
       browser.start
       browser.navigate_to("https://2captcha.com/fr/demo/cloudflare-turnstile-challenge")
       sleep 10
-      browser.screenshot_to_file("results/cloudflare.png")
+      browser.screenshot("results/cloudflare.png")
+      browser.stop
+    end
+
+    task :my_ip do
+      browser = Chromate::Browser.new(browser_args)
+      browser.start
+      browser.navigate_to("https://whatismyipaddress.com")
+      sleep 2
+      browser.click_element('//*[@id="qc-cmp2-ui"]/div[2]/div/button[3]')
+      browser.screenshot("results/my_ip.png")
+      browser.stop
+    end
+
+    task :headers do
+      browser = Chromate::Browser.new(browser_args)
+      browser.start
+      browser.navigate_to("https://httpbin.org/headers")
+      sleep 2
+      browser.screenshot("results/headers.png")
       browser.stop
     end
   end

data/docker_root/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'chromate', path: '/chromate'
+gem 'webrick'

data/docker_root/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: /chromate
+  specs:
+    chromate (0.0.1.pre)
+      ffi (~> 1.17.0)
+      websocket-client-simple (~> 0.8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    event_emitter (0.2.6)
+    ffi (1.17.0)
+    webrick (1.8.2)
+    websocket (1.2.11)
+    websocket-client-simple (0.8.0)
+      event_emitter
+      websocket
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  chromate!
+  webrick
+
+BUNDLED WITH
+   2.5.21

data/docker_root/app.rb

@@ -0,0 +1,92 @@
+require 'bundler/setup'
+require 'chromate'
+require '/chromate/spec/support/server'
+
+class TestInDocker
+  include Support::Server
+
+  attr_reader :browser
+
+  def initialize
+    start_servers
+
+    @browser = Chromate::Browser.new(headless: false, xfvb: true, record: 'record.mp4', native_control: false)
+    @browser.start
+
+    trap('INT') { stop }
+    trap('TERM') { stop }
+
+    at_exit { stop }
+  end
+
+  def stop
+    @browser.stop
+    stop_servers
+    # Convert the video to a gif
+    pid = spawn('ffmpeg -i record.mp4 -vf "fps=10,scale=640:-1:flags=lanczos,palettegen" palette.png')
+    Process.wait(pid)
+    pid = spawn('ffmpeg -i record.mp4 -i palette.png -filter_complex "fps=10,scale=640:-1:flags=lanczos[x];[x][1:v]paletteuse" TestInDocker.gif')
+    Process.wait(pid)
+  end
+
+  def run
+    click_features
+    move_features
+    drag_and_drop_features
+    fill_form_features
+    shadow_dom_features
+  end
+
+  def click_features
+    url = server_urls['where_clicked']
+    browser.navigate_to(url)
+    browser.refresh
+    browser.click_element('#interactive-button')
+    sleep 1
+  end
+
+  def move_features
+    url = server_urls['where_moved']
+    browser.navigate_to(url)
+    browser.refresh
+    browser.hover_element('#red')
+    browser.hover_element('#yellow')
+    browser.hover_element('#green')
+    browser.hover_element('#blue')
+    sleep 1
+  end
+
+  def drag_and_drop_features
+    url = server_urls['drag_and_drop']
+    browser.navigate_to(url)
+    browser.refresh
+    blue_square = browser.find_element('#draggable')
+    green_square = browser.find_element('#dropzone')
+    blue_square.drop_to(green_square)
+    sleep 1
+  end
+
+  def fill_form_features
+    url = server_urls['fill_form']
+    browser.navigate_to(url)
+    browser.refresh
+    browser.find_element('#first-name').type('John')
+    browser.find_element('#last-name').type('Doe')
+    browser.select_option('#gender', 'female')
+    browser.find_element('#option-2').click
+    browser.find_element('#submit-button').click
+    sleep 1
+  end
+
+  def shadow_dom_features
+    url = server_urls['shadow_checkbox']
+    browser.navigate_to(url)
+    browser.refresh
+    shadow_container = browser.find_element('#shadow-container')
+    checkbox = shadow_container.find_shadow_child('#shadow-checkbox')
+    checkbox.click
+    sleep 1
+  end
+end
+
+TestInDocker.new.run

data/dockerfiles/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:3.2-slim
+FROM --platform=linux/amd64 ruby:3.2-slim
 
 RUN apt-get update && apt-get install -y \
     nano \
@@ -51,18 +51,23 @@ RUN apt-get update && apt-get install -y \
     psmisc \
     --no-install-recommends && rm -rf /var/lib/apt/lists/*
 
-# Donwload and install Chrome
+# Préparer le système
+RUN apt-get update && apt-get install -y wget gnupg2 lsb-release && rm -rf /var/lib/apt/lists/*
 
-RUN apt-get update && apt-get install -y wget gnupg gnupg2 gnupg1 && rm -rf /var/lib/apt/lists/*
-RUN wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - \ 
-    && echo "deb http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list
-RUN apt-get update && apt-get -y install google-chrome-stable
+# Télécharger et ajouter la clé GPG
+RUN wget -q -O- https://dl.google.com/linux/linux_signing_key.pub | gpg --dearmor -o /usr/share/keyrings/google-chrome.gpg
+
+# Ajouter le dépôt Google Chrome
+RUN echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/google-chrome.gpg] http://dl.google.com/linux/chrome/deb/ stable main" | tee /etc/apt/sources.list.d/google-chrome.list
+
+# Mise à jour et installation de Google Chrome
+RUN apt-get update && apt-get install -y google-chrome-stable
 
 ENV CHROME_BIN=/usr/bin/google-chrome
 
 RUN gem install bundler -v 2.5.21
 
-WORKDIR /app
+WORKDIR /chromate
 
 COPY Gemfile Gemfile.lock chromate.gemspec ./
 COPY lib/chromate/version.rb ./lib/chromate/version.rb
@@ -77,9 +82,18 @@ COPY . .
 
 ENV DISPLAY=:99
 
+WORKDIR /app
+
+COPY docker_root/ /app/
+
 ENTRYPOINT ["/usr/local/bin/docker-entrypoint.sh"]
 
 CMD [ "bash" ]
 
 # docker build -f dockerfiles/Dockerfile -t chromate .
+
+# Run the container for testing chromate
+# docker run -v $(pwd)/docker_root:/app -it chromate
+
+# Run the container for development
 # docker run -v $(pwd):/app -it chromate

data/dockerfiles/README.md

@@ -0,0 +1,49 @@
+# Chromate Docker Configuration
+
+This section explains how to configure and test the Chromate gem using Docker with xvfb support.
+
+![TestInDocker.gif](../docker_root/TestInDocker.gif)
+
+## Docker Setup
+
+To simplify the setup process, Chromate includes a Dockerfile and an entrypoint script that handle the installation and configuration of necessary dependencies, including xvfb.
+
+### Dockerfile
+
+The Dockerfile sets up a minimal environment with all the necessary dependencies to run Chromate in headless mode with xvfb. It installs Chrome, xvfb, and other required libraries.
+
+### 
+
+docker-entrypoint.sh
+
+
+
+The entrypoint script ensures that xvfb is running before starting the main process. It removes any existing lock files, starts xvfb and a window manager (fluxbox), and waits for xvfb to initialize.
+
+### How to Use
+
+1. **Build the Docker Image**
+
+   ```sh
+   docker build -f dockerfiles/Dockerfile -t chromate .
+   ```
+
+2. **Run the Docker Container**
+
+   ```sh
+   docker run -v $(pwd)/docker_root:/app -it chromate
+   ```
+
+   This command mounts the current directory to `/app` inside the container and starts an interactive bash session.
+
+3. **Run the Test Script**
+
+   Inside the Docker container, run the test script:
+
+   ```sh
+   ruby app.rb
+   ```
+
+## Conclusion
+
+This setup ensures that all necessary dependencies are installed and configured correctly, allowing you to focus on writing your automation scripts without worrying about the underlying environment.

data/docs/README.md

@@ -0,0 +1,74 @@
+# Chromate Documentation Index
+
+Welcome to the Chromate Documentation! This index provides an overview of the main classes and their detailed documentation, covering public methods, usage examples, and key features.
+
+## 📚 Table of Contents
+
+1. [Introduction](#introduction)
+2. [Classes Overview](#classes-overview)
+3. [Detailed Documentation](#detailed-documentation)
+   - [Chromate::Browser](#1-chromatebrowser-class)
+   - [Chromate::Element](#2-chromateelement-class)
+
+---
+
+## Introduction
+
+Chromate is a Ruby-based library designed to interact with the Chrome DevTools Protocol (CDP). It allows you to control a headless Chrome browser, manipulate DOM elements, and perform automated tasks such as navigation, screenshot capture, and form submissions.
+
+This documentation provides a comprehensive guide for the core components of Chromate:
+
+- **Chromate::Browser**: Manages the browser instance, providing methods for starting, stopping, navigation, and executing browser actions.
+- **Chromate::Element**: Represents a DOM element, enabling actions like clicking, typing, and attribute manipulation.
+
+## Classes Overview
+
+| Class              | Description                                           |
+| ------------------ | ----------------------------------------------------- |
+| `Chromate::Browser`| A class for controlling the Chrome browser instance.  |
+| `Chromate::Element`| A class for interacting with individual DOM elements. |
+
+## Detailed Documentation
+
+### 1. `Chromate::Browser` Class
+
+The `Browser` class is responsible for managing the lifecycle of a Chrome browser instance. It provides methods for navigation, screenshot capture, and DOM interaction. It also includes features for headless mode, native control, and video recording of sessions.
+
+- **Features:**
+  - Start and stop the browser instance.
+  - Navigate to URLs, refresh, and go back in browser history.
+  - Capture full-page and Xvfb screenshots.
+  - Execute JavaScript code and interact with DOM elements.
+
+For the full documentation and usage examples, refer to [Chromate::Browser Documentation](#chromatebrowser-class).
+
+### 2. `Chromate::Element` Class
+
+The `Element` class provides a robust interface for interacting with DOM elements in the browser. It includes methods for text extraction, attribute manipulation, and user interaction simulation (click, hover, type).
+
+- **Features:**
+  - Retrieve text and HTML content of an element.
+  - Set and get element attributes.
+  - Simulate user interactions (click, hover, type).
+  - Interact with shadow DOM elements.
+
+For the full documentation and usage examples, refer to [Chromate::Element Documentation](#chromateelement-class).
+
+---
+
+## How to Get Started
+
+To start using Chromate in your project, ensure that you have a working installation of Google Chrome and Ruby. Follow the setup instructions provided in the README file of the project.
+
+Example usage:
+
+```ruby
+require 'chromate'
+
+browser = Chromate::Browser.new(headless: true)
+browser.start
+browser.navigate_to('https://example.com')
+element = browser.find_element('#header')
+puts element.text
+browser.stop
+```