Initial commit

Author: Nikita Andreyev

.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'eyes_images'

PNG_IMG1.png

@@ -0,0 +1,17 @@
+# Pre-requisites:
+
+1. Ruby is installed on your machine.
+   * [See instructions here](https://www.ruby-lang.org/en/documentation/installation/)
+
+# Steps to run this example
+
+1. Git clone this repo
+    * `git clone git@github.com:applitools/tutorial-ruby-screenshots.git`
+2. Open the folder `tutorial-ruby-screenshots`
+3. Run command `gem install bundler && bundle install`. This will install necessary ruby gems and dependencies
+4. Obtain your API_KEY:
+    * Login to Applitools > Click on the Person icon > My API Key
+5. Export the API_KEY: 
+    * For Mac, Linux: `export APPLITOOLS_API_KEY=MY_API_KEY`
+    * For Windows: `SET APPLITOOLS_API_KEY=MY_API_KEY`
+6. Run the test: `bundle exec ruby simple_test_script.rb`

README.md

@@ -0,0 +1,42 @@
+require 'eyes_images'
+
+runner = Applitools::ClassicRunner.new
+eyes = Applitools::Images::Eyes.new(runner: runner)
+batch = Applitools::BatchInfo.new('Applitools Screenshot example')
+
+eyes.batch = batch
+
+Applitools::EyesLogger.log_handler = Logger.new(STDOUT).tap do |l|
+  l.level = Logger::INFO
+end
+
+begin
+  file_path = './PNG_IMG1.png'
+  image_bytes = File.read(file_path)
+  image = Applitools::Screenshot.from_datastream(image_bytes)
+
+  # Classic API
+  eyes.open(app_name: 'Screenshot example app', test_name: 'Screenshot example classic api')
+  eyes.check_image(tag: 'By file path', image_path: file_path)
+  eyes.check_image(tag: 'By image bytes', image_bytes: image_bytes)
+  eyes.check_image(tag: 'By Applitools Screenshot', image: image)
+  eyes.check_region(tag: 'Check region example', image: image, region: Applitools::Region.new(200, 200, 100, 100))
+  eyes.close
+
+  # Fluent API
+  eyes.open(app_name: 'Screenshot example app', test_name: 'Screenshot example fluent api')
+  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.check(
+    'Check region example',
+    Applitools::Images::Target.screenshot(image).region(Applitools::Region.new(200, 200, 100, 100))
+  )
+  eyes.close
+rescue => e
+  eyes.abort
+ensure
+  puts runner.get_all_test_results
+end
+
+