Comparing Screenshots in Ruby with Applitools | Applitools Documentation

Prerequisites

A free Applitools account and Applitools API KEY
Tip: Unsure how to find your API key?
Read Retrieving your API key to find your API key.
Ruby
Git

Note: Installing git is optional
Installing git is used to clone the demo project from the Github repository. Instead of installing git, you can simply download the Zip file from the repository. Further, if you are Mac, you already have git.

Running the Example Project

Clone or download the repository and navigate to that folder
```
git clone https://github.com/applitools/tutorial-ruby-screenshots.git
cd tutorial-ruby-screenshots
```
Note: you can alternatively download the project as a Zip file and extract it
Install the dependencies
```
gem install bundler && bundle install
```

Run the example test

APPLITOOLS_API_KEY="[Your API Key]" bundle exec ruby simple_test_script.rb

Adding Applitools Eyes to an Existing Project

Install Applitools Eyes dependencies:

gem install eyes_images

Sample test

require 'eyes_images'

runner = Applitools::ClassicRunner.new
eyes = Applitools::Images::Eyes.new(runner: runner)
batch = Applitools::BatchInfo.new('Demo Batch - Images - Ruby')

eyes.batch = batch

Applitools::EyesLogger.log_handler = Logger.new(STDOUT).tap do |l|
  l.level = Logger::INFO
end

begin
  file_path = './applitools.png'
  image_bytes = File.read(file_path)
  image = Applitools::Screenshot.from_datastream(image_bytes)

eyes.open(app_name: 'Demo App - Images Ruby', test_name: 'Smoke Test - Images Ruby')

eyes.check('By file path', Applitools::Images::Target.path(file_path))
  eyes.check('By image bytes', Applitools::Images::Target.blob(image_bytes))
  eyes.check('By Applitools Screenshot', Applitools::Images::Target.screenshot(image))

eyes.close
rescue => e
  puts e.message
  eyes.abort
ensure
  puts runner.get_all_test_results
end

Having Trouble?

Don't suffer in silence!
Let us help you.
Please reach out to us to get your project working.

Taking the next steps with Applitools Eyes

Congratulations on completing this quickstart!
There's still so much to learn about visual testing with Applitools, but you're off to a great start.