chromate-rb 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76c6ae8c74c3238f41db246836afd03b20c8bbb19a706575a424be2de6b84d41
+  data.tar.gz: 9b07855d6fb9139e0c0a223bffa40f1558de7e82d4ca62ec20039ad22ceabfce
+SHA512:
+  metadata.gz: 2701dc1057b0f038f53aea6e42a34dc5a6a222900c61b2f1004f58dbb00453467d31ec8f8acb0e6a6545e4f32af5d2461873abdd898a0a47c05339dc65e038f6
+  data.tar.gz: b8ef6aba60741c21570c36e68f4a3e6e9e4aa4fa52335284b8aef97f63fa3da7d5849bac44bc2c64db2436fd42f81adda365a5e00f63f60f119dc3e54dcb2533

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,39 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  Exclude:
+    - 'Rakefile'
+    - 'bin/**/*'
+    - 'vendor/**/*'
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 160
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/BlockLength:
+  Max: 50
+  Exclude:
+    - 'spec/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-10-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Eth3rnit3
+
+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,124 @@
+# 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/)
+[![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)
+
+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.
+
+## Installation
+
+Add gem to your application's Gemfile:
+
+```sh
+bundle add chromate
+```
+
+Or install it yourself as:
+
+```sh
+gem install chromate
+```
+
+## Usage
+
+[![view - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge)](/docs/ "Go to project documentation")
+
+### Basic Example
+
+```ruby
+require 'chromate'
+
+browser = Chromate::Browser.new # default headless: true
+browser.start
+
+url = 'http://example.com'
+browser.navigate_to(url)
+browser.find_element('#some-element').click
+browser.screenshot_to_file('screenshot.png')
+
+browser.stop
+```
+
+### Configuration
+
+You can configure Chromate using a block:
+
+```ruby
+Chromate.configure do |config|
+  config.user_data_dir = '/path/to/user/data'
+  config.headless = true
+  config.native_control = true
+  config.proxy = { host: 'proxy.example.com', port: 8080 }
+end
+```
+
+## Principle of Operation
+
+Chromate leverages the Chrome DevTools Protocol (CDP) to interact with the browser. It provides a custom driver that mimics human-like behavior to avoid detection by anti-bot systems. The gem includes native mouse controllers for macOS and Linux, which do not trigger JavaScript events, making interactions more human-like.
+
+### Features
+
+- **Headless Mode**: Run Chrome without a graphical user interface.
+- **Native Mouse Control**: Use native mouse events for macOS and Linux.
+- **Screenshot Capture**: Capture screenshots of the browser window.
+- **Form Interaction**: Fill out and submit forms.
+- **Shadow DOM Support**: Interact with elements inside Shadow DOM.
+- **Element Interaction**: Click, hover, and type text into elements.
+- **Navigation**: Navigate to URLs and wait for page load.
+- **Docker xvfb Support**: Dockerfile provided with xvfb setup for easy usage.
+
+### Limitations
+
+- **Windows Support**: Native mouse control is not yet supported on Windows.
+- **Headless Mode Complexity**: Requires xvfb for headless mode, adding complexity due to different proportions.
+- **Anti-Bot Detection**: Current systems can detect keyboard and mouse interactions via CDP.
+
+# Native controls and headless
+
+Chromate provides native mouse control for macOS and Linux, which helps in creating more human-like interactions that are harder to detect by anti-bot systems. However, using native controls in headless mode requires additional setup, such as using xvfb (X Virtual Framebuffer) to simulate a display.
+
+## 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.
+
+The [entrypoint](dockerfiles/docker-entrypoint.sh) 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.
+
+### Example Docker Usage
+
+Here is an example of how you can use Chromate inside a Docker container:
+
+```sh
+# Build the Docker image
+docker build -f dockerfiles/Dockerfile -t chromate .
+
+# Run the Docker container
+docker run -v $(pwd):/app -it chromate
+
+# Inside the container, run your Ruby script
+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.
+
+## Contribution
+
+Contributions are welcome! If you have suggestions for improvements or new features, please open an issue or submit a pull request on GitHub.
+
+### How to Contribute
+
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature-branch`).
+3. Make your changes.
+4. Commit your changes (`git commit -am 'Add new feature'`).
+5. Push to the branch (`git push origin feature-branch`).
+6. Create a new Pull Request.
+
+## License
+
+Released under [MIT](/LICENSE.txt) by [@eth3rnit3](https://github.com/eth3rnit3).

data/Rakefile

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+require_relative "lib/chromate"
+
+namespace :chromate do
+  namespace :test do
+    task :open do
+      browser = Chromate::Browser.new(headless: false)
+      browser.start
+      browser.navigate_to("https://2captcha.com/fr/demo/recaptcha-v2")
+      sleep 2
+      element = browser.find_element("#root")
+      binding.irb
+      browser.stop
+    end
+
+    task :pixelscan do
+      browser = Chromate::Browser.new
+      browser.start
+      browser.navigate_to("https://pixelscan.net")
+      sleep 10
+      browser.screenshot_to_file("results/pixelscan.png")
+      browser.stop
+    end
+
+    task :brotector do
+      require "chromate/native/mouse_controller"
+      browser = Chromate::Browser.new
+      browser.start
+      browser.navigate_to("https://kaliiiiiiiiii.github.io/brotector?crash=false")
+      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.stop
+    end
+
+    task :bot do
+      browser = Chromate::Browser.new
+      browser.start
+      browser.navigate_to("https://bot.sannysoft.com")
+      sleep 2
+      browser.screenshot_to_file("results/bot.png")
+      browser.stop
+    end
+
+    task :cloudflare do
+      Chromate.configure do |config|
+        config.headless = false
+      end
+      browser = Chromate::Browser.new
+      browser.start
+      browser.navigate_to("https://2captcha.com/fr/demo/cloudflare-turnstile-challenge")
+      sleep 10
+      browser.screenshot_to_file("results/cloudflare.png")
+      browser.stop
+    end
+  end
+end

data/dockerfiles/Dockerfile

@@ -0,0 +1,85 @@
+FROM ruby:3.2-slim
+
+RUN apt-get update && apt-get install -y \
+    nano \
+    xvfb \
+    curl \
+    git \
+    bash \
+    build-essential \
+    libx11-xcb1 \
+    libxcomposite1 \
+    libxrandr2 \
+    libxdamage1 \
+    libjpeg62-turbo \
+    libwebp-dev \
+    udev \
+    fonts-freefont-ttf \
+    fonts-noto-color-emoji \ 
+    nodejs \
+    npm \
+    libxcursor1 \
+    libgtk-3-0 \
+    libpangocairo-1.0-0 \
+    libcairo-gobject2 \
+    libgdk-pixbuf2.0-0 \
+    libgstreamer1.0-0 \
+    libgstreamer-plugins-base1.0-0 \
+    gstreamer1.0-gl \
+    gstreamer1.0-libav \
+    gstreamer1.0-plugins-bad \
+    libxslt1.1 \
+    libwoff1 \
+    libvpx7 \
+    libevent-2.1-7 \
+    libopus0 \
+    libsecret-1-0 \
+    libenchant-2-2 \
+    libharfbuzz-icu0 \
+    libhyphen0 \
+    libmanette-0.2-0 \
+    libflite1 \
+    libavcodec-extra \
+    libx11-dev \
+    libxtst-dev \
+    x11-utils \
+    x11-apps \
+    imagemagick \
+    xdotool \
+    fluxbox \
+    ffmpeg \
+    psmisc \
+    --no-install-recommends && rm -rf /var/lib/apt/lists/*
+
+# Donwload and install Chrome
+
+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
+
+ENV CHROME_BIN=/usr/bin/google-chrome
+
+RUN gem install bundler -v 2.5.21
+
+WORKDIR /app
+
+COPY Gemfile Gemfile.lock chromate.gemspec ./
+COPY lib/chromate/version.rb ./lib/chromate/version.rb
+
+RUN bundle install
+
+COPY dockerfiles/docker-entrypoint.sh /usr/local/bin/
+
+RUN chmod +x /usr/local/bin/docker-entrypoint.sh
+
+COPY . .
+
+ENV DISPLAY=:99
+
+ENTRYPOINT ["/usr/local/bin/docker-entrypoint.sh"]
+
+CMD [ "bash" ]
+
+# docker build -f dockerfiles/Dockerfile -t chromate .
+# docker run -v $(pwd):/app -it chromate

data/dockerfiles/docker-entrypoint.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+if [ -f /tmp/.X99-lock ]; then 
+  rm -f /tmp/.X99-lock
+fi
+
+if ! pgrep -x "Xvfb" > /dev/null; then 
+  Xvfb :99 -screen 0 1920x1080x24 &
+  DISPLAY=:99 fluxbox &
+fi
+
+echo "Waiting for Xvfb to start..."
+sleep 1
+
+exec "$@"

data/docs/browser.md

@@ -0,0 +1,163 @@
+# Browser
+
+The `Chromate::Browser` class is the main interface for interacting with the Chrome browser using the Chromate gem. It provides methods for navigating, interacting with elements, taking screenshots, and more.
+
+## Initialization
+
+To create a new instance of the `Browser` class, you can pass in various options:
+
+```ruby
+browser = Chromate::Browser.new(
+  headless: true,
+  native_control: true,
+  user_data_dir: '/path/to/user/data',
+  record: false
+)
+```
+
+### Options
+
+- `headless`: Run Chrome in headless mode (default: true).
+- `native_control`: Use native mouse control (default: false).
+- `user_data_dir`: Directory to store user data (default: a temporary directory).
+- `record`: Record the browser session (default: false).
+- `xfvb`: Use xvfb for headless mode (default: false).
+
+## Methods
+
+### 
+
+start
+
+
+
+Starts the Chrome browser with the specified options.
+
+```ruby
+browser.start
+```
+
+### 
+
+stop
+
+
+
+Stops the Chrome browser and any associated processes.
+
+```ruby
+browser.stop
+```
+
+### `navigate_to(url)`
+
+Navigates to the specified URL and waits for the page to load.
+
+```ruby
+browser.navigate_to('http://example.com')
+```
+
+### `find_element(selector)`
+
+Finds an element on the page using the specified CSS selector.
+
+```ruby
+element = browser.find_element('#some-element')
+```
+
+### `click_element(selector)`
+
+Clicks on an element specified by the CSS selector.
+
+```ruby
+browser.click_element('#some-element')
+```
+
+### `hover_element(selector)`
+
+Hovers over an element specified by the CSS selector.
+
+```ruby
+browser.hover_element('#some-element')
+```
+
+### `type_text(selector, text)`
+
+Types text into an element specified by the CSS selector.
+
+```ruby
+browser.type_text('#input-field', 'Hello, world!')
+```
+
+### `screenshot_to_file(file_path, options = {})`
+
+Takes a screenshot of the current page and saves it to the specified file path.
+
+```ruby
+browser.screenshot_to_file('screenshot.png')
+```
+
+### 
+
+native_control?
+
+
+
+Returns whether native control is enabled.
+
+```ruby
+puts browser.native_control? # => true or false
+```
+
+## Example Usage
+
+```ruby
+require 'chromate'
+
+browser = Chromate::Browser.new(headless: true, native_control: true)
+browser.start
+
+browser.navigate_to('http://example.com')
+browser.find_element('#some-element').click
+browser.screenshot_to_file('screenshot.png')
+
+browser.stop
+```
+
+## Private Methods
+
+### 
+
+start_video_recording
+
+
+
+Starts recording the browser session using `ffmpeg`.
+
+### 
+
+build_args
+
+
+
+Builds the arguments for starting the Chrome process.
+
+### 
+
+stop_and_exit
+
+
+
+Stops the browser and exits the process.
+
+### 
+
+config
+
+
+
+Returns the Chromate configuration.
+
+## Conclusion
+
+The `Chromate::Browser` class provides a powerful interface for automating interactions with the Chrome browser. With support for headless mode, native mouse control, and more, it is a versatile tool for creating undetectable bots with human-like behavior.