eyes_images 6.5.2 → 6.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17ff6aaef191825a021f827971a9e4ecbc49282243f65907e7daa0d4d0ab6368
-  data.tar.gz: 7d1bd99a566a18819107f027e43658f772870c33f82731a7808c9fdf3ec9d741
+  metadata.gz: a1065b462858b2cc0adada9b3605b6b39493eeea5b0ee468fb10954721366fcb
+  data.tar.gz: 49d044dab2953e71625b6de9ae0fd0097ae9a5e6dafacf2aec6a1c3ec439d21c
 SHA512:
-  metadata.gz: 4dd2a0ebf4fb1ff93942087efb1ff46636c6e8a4e6152a29c72c3f7b594270f50fc61f01de50178c71c1691b74cc4242485e5edbbe819cb0b240cbf614fe12e0
-  data.tar.gz: 512dc154345972f0e2d08227fc34bf8e191ae1935c728c2f350eee6b854233e42d7640538203ce7e66eee7483808763a35bb86a4e5f779c2caf275a7317a178a
+  metadata.gz: 7eb04ea845d8f07dadef21a37678ed6f5523ea48de359d60427cdfedced1704f06a7580f06a8d727d0ae208c0a3da321c2236b2961261a2b3721900813111824
+  data.tar.gz: a7ae9671aa1f24ac43782117caf7e5171bce3c7aecc36f24a9c589d7aae8be6f0c07c8959156324e410bca476bb2fb3fd4729aa3763e37417e69ae721a865ae6

data/CHANGELOG.md

@@ -1,5 +1,97 @@
 # Changelog
 
+## [6.5.4](https://github.com/Applitools-Dev/sdk/compare/ruby/eyes_images@6.5.3...ruby/eyes_images@6.5.4) (2025-06-15)
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.11.22
+  #### Bug Fixes
+
+  * css media query group conditions | FLD-3151 ([#3023](https://github.com/Applitools-Dev/sdk/issues/3023)) ([56ec107](https://github.com/Applitools-Dev/sdk/commit/56ec107bcda6a5a330d19c278267d73de5d86d8b))
+
+
+
+* @applitools/req bumped to 1.7.13
+
+* @applitools/dom-capture bumped to 11.5.6
+
+* @applitools/spec-driver-webdriver bumped to 1.2.6
+
+* @applitools/screenshoter bumped to 3.11.5
+
+* @applitools/nml-client bumped to 1.9.5
+  #### Bug Fixes
+
+  * nml-client depends on core-base ([#2995](https://github.com/Applitools-Dev/sdk/issues/2995)) ([1f7cf69](https://github.com/Applitools-Dev/sdk/commit/1f7cf6930709a40a498dd1f525132648aa593af0))
+
+
+
+* @applitools/tunnel-client bumped to 1.8.0
+  #### Features
+
+  * update build script to include individual zip creation ([#3008](https://github.com/Applitools-Dev/sdk/issues/3008)) ([46a0cfc](https://github.com/Applitools-Dev/sdk/commit/46a0cfcc472ab69384560095d90a7fa58b4b9186))
+
+
+
+* @applitools/ufg-client bumped to 1.16.12
+  #### Bug Fixes
+
+  * remove safari-early-access browser version for js sdks | AD-10226 ([#3034](https://github.com/Applitools-Dev/sdk/issues/3034)) ([7ca09f5](https://github.com/Applitools-Dev/sdk/commit/7ca09f5c0c271570142058ea766533b86434dc2e))
+
+
+
+* @applitools/core-base bumped to 1.25.4
+  #### Bug Fixes
+
+  * Differentiate Between Invalid and Missing API Key Errors ([6ac17d4](https://github.com/Applitools-Dev/sdk/commit/6ac17d40d7aff45b3de5c949dc7d4673b9739bfd))
+  * export issues for ts js with legacy solution ([#3016](https://github.com/Applitools-Dev/sdk/issues/3016)) ([a3a9daf](https://github.com/Applitools-Dev/sdk/commit/a3a9daf9c3361bb1f253499c1335a1434ec520d1))
+
+
+
+* @applitools/test-server bumped to 1.2.3
+  #### Bug Fixes
+
+  * basic auth protected resources | FLD-2761 | FMRI-120 ([#2444](https://github.com/Applitools-Dev/sdk/issues/2444)) ([b48cf49](https://github.com/Applitools-Dev/sdk/commit/b48cf49dec50bbf1ed2ba111608a48cf09962565))
+  * export issues for ts js with legacy solution ([#3016](https://github.com/Applitools-Dev/sdk/issues/3016)) ([a3a9daf](https://github.com/Applitools-Dev/sdk/commit/a3a9daf9c3361bb1f253499c1335a1434ec520d1))
+  * storybook navigation timeouts ([#2701](https://github.com/Applitools-Dev/sdk/issues/2701)) ([64e3a40](https://github.com/Applitools-Dev/sdk/commit/64e3a40a524ae76ec457ae9c2d1170fbaea5e982))
+
+
+
+* @applitools/ec-client bumped to 1.10.15
+
+* @applitools/core bumped to 4.40.0
+  #### Features
+
+  * update build script to include individual zip creation ([#3008](https://github.com/Applitools-Dev/sdk/issues/3008)) ([46a0cfc](https://github.com/Applitools-Dev/sdk/commit/46a0cfcc472ab69384560095d90a7fa58b4b9186))
+
+
+  #### Bug Fixes
+
+  * css media query group conditions | FLD-3151 ([#3023](https://github.com/Applitools-Dev/sdk/issues/3023)) ([56ec107](https://github.com/Applitools-Dev/sdk/commit/56ec107bcda6a5a330d19c278267d73de5d86d8b))
+  * export issues for ts js with legacy solution ([#3016](https://github.com/Applitools-Dev/sdk/issues/3016)) ([a3a9daf](https://github.com/Applitools-Dev/sdk/commit/a3a9daf9c3361bb1f253499c1335a1434ec520d1))
+  * extractLatestCommitInfo | FLD-3217 ([#3039](https://github.com/Applitools-Dev/sdk/issues/3039)) ([3f72a23](https://github.com/Applitools-Dev/sdk/commit/3f72a230fa0166046ea85ae004cfb544de86e628))
+  * handle error when sending started message in tunnel manager server ([#3019](https://github.com/Applitools-Dev/sdk/issues/3019)) ([2cdaad8](https://github.com/Applitools-Dev/sdk/commit/2cdaad896fd679187449b69abe529b006f6255ee))
+
+
+
+* eyes_universal bumped to 4.40.0
+
+* eyes_core bumped to 6.7.2
+
+
+## [6.5.3](https://github.com/Applitools-Dev/sdk/compare/ruby/eyes_images@6.5.2...ruby/eyes_images@6.5.3) (2025-05-22)
+
+
+### Dependencies
+
+* eyes_universal bumped to 4.38.0
+  #### Features
+
+  * adding the mac-arm64 binary ([#2975](https://github.com/Applitools-Dev/sdk/issues/2975)) ([95d647f](https://github.com/Applitools-Dev/sdk/commit/95d647ff4a451309d985a786f7cec544d926f0e5))
+* eyes_core bumped to 6.7.1
+
+
 ## [6.5.2](https://github.com/Applitools-Dev/sdk/compare/ruby/eyes_images@6.5.1...ruby/eyes_images@6.5.2) (2025-04-17)
 
 

data/LICENSE

@@ -0,0 +1,26 @@
+-  -
+SDK LICENSE AGREEMENT
+IMPORTANT - PLEASE READ CAREFULLY THE TERMS OF THIS LICENSE AGREEMENT ("AGREEMENT"). BY INSTALLING, ACCESSING AND/OR USING THE SOFTWARE (AS DEFINED BELOW), YOU EXPRESSLY ACKNOWLEDGE AND AGREE THAT YOU, OR THE COMPANY YOU REPRESENT, ("YOU" OR "LICENSEE") ARE ENTERING INTO A LEGAL AGREEMENT WITH APPLITOOLS LTD. AND ITS AFFILIATES ("APPLITOOLS"), AND HAVE UNDERSTOOD AND AGREE TO COMPLY WITH, AND BE LEGALLY BOUND BY, THE TERMS AND CONDITIONS OF THIS AGREEMENT. YOU HEREBY WAIVE ANY RIGHTS OR REQUIREMENTS UNDER ANY LAWS OR REGULATIONS IN ANY JURISDICTION WHICH REQUIRE AN ORIGINAL (NON-ELECTRONIC) SIGNATURE OR DELIVERY OR RETENTION OF NON-ELECTRONIC RECORDS, TO THE EXTENT PERMITTED UNDER APPLICABLE LAW.
+THE SOFTWARE MAY BE USED SOLELY FOR YOUR PERSONAL, NON-COMMERCIAL PURPOSES. FOR COMMERCIAL PURPOSES PLEASE CONTACT THE REGIONAL APPLITOOLS BUSINESS REPRESENTATIVE.
+1. Definitions. For purposes of this Agreement, the following capitalized terms shall have the following meaning:
+   1. "Documentation" means the user's guides and technical manuals delivered by Applitools to Licensee.
+   2.  "Feedback" means suggestions, comments or feedback (whether orally or in writing) with respect to the Software.
+   3. "Intellectual Property Rights" means all intangible legal rights, titles and interests evidenced by or embodied in all: (i) inventions (regardless of patentability and whether or not reduced to practice), improvements thereto, patents, patent applications, patent disclosures, together with all reissuances, continuations, continuations in part, revisions, extensions and reexaminations thereof; (ii) trademarks, service marks, trade dress, logos, trade names, corporate names, together with translations, adaptations, derivations and combinations thereof, including goodwill associated therewith, and applications, registrations, and renewals in connection therewith; (iii) any work of authorship, regardless of copyrightable, copyrightable works, copyrights (including moral rights), and applications, registrations and renewals in connection therewith; (iv) mask works and applications, registrations and renewals in connection therewith; (v) trade secrets and Confidential Information; and (vi) other proprietary rights and any other similar rights, in each case on a worldwide basis, and copies and tangible embodiments thereof, in whatever form or medium.
+   4. "License" means the right to use the Software pursuant to Section ‎2.1 to this Agreement.
+   5.  "Software" means Applitools' software development kit software in object or source code version, Documentation and any updates and upgrade thereto (to the extent delivered).
+1. License
+   1. Grant of License. Subject to the terms and conditions of this Agreement, Applitools grants You, during the Term, a personal, non-exclusive, non-sublicensable, non-transferable, revocable license to: (i) use the Software solely for Your own personal (non-commercial) use and (ii) use and display Applitools' Marks solely for the purpose of publicizing or advertising that You are using the Software.
+   2. Documentation. Applitools may make available Documentation to Licensee for Licensee to use solely in connection with Licensee's use of the Software during the term of this Agreement. Licensee may print or copy the Documentation as needed for its own purposes provided that all copyright notices are included therein. The Documentation shall be considered the Confidential Information of Applitools.
+   1. Reservation of Rights; Use Restrictions. Other than the rights explicitly granted in this Agreement, Licensee shall have no other rights, express or implied, in the Software. Without limiting the generality of the foregoing, Licensee agrees and undertakes not to: (i) allow any third party to use the Software in any manner, including but not limited to, sell, lease, sublicense or distribute the Software, or any part thereof; (ii) modify, revise, or alter the Software or reverse engineer, decompile, disassemble or otherwise reduce to human-perceivable form the Software's source code; (iii) copy or allow copies of the Software to be made; (iv) remove, alter or obscure any proprietary notice or identification, including copyright, trademark, patent or other notices, contained in or displayed on or via the Software; (v) use the Software to violate any applicable laws, rules or regulations, or for any unlawful, harmful, irresponsible, or inappropriate purpose, or in any manner that breaches this Agreement, and/or (vi) represent that it possesses any proprietary interest in the Software.
+   1. Third Party Software. Licensee acknowledges and agrees that any third party software ("Third Party Software") that provided with the Software is provided under the terms of the license attached/linked thereto or, if no such license is attached, such Third Party Software is provided for free and on "AS IS" basis. Applitools is not liable for any losses or damages which may occur resulting from the use of any Third Party Software. Applitools does not possess any proprietary interest in such Third Party Software.
+   1. Open Source Licenses. The Software includes certain open source code software and materials (as shall be listed in the documentation of the Software) ("Open Source Software") that are subject to their respective open source licenses ("Open Source Licenses"). Such Open Source Licenses contain a list of conditions with respect to warranty, copyright policy and other provisions. By executing this Agreement, Licensee undertakes to strictly comply with the terms and condition of the Open Source Licenses, as may be amended from time to time. In order to comply with the Open Source Licenses, Licensee shall read the respective licenses or notices, such list of Open Source Licenses may be amended from time to time by Applitools, at its sole discretion. In the event of any inconsistencies or conflicting provisions between the provisions of the Open Source Licenses and the provisions of this Agreement, the provisions of the Open Source Licenses shall prevail. Without derogating from the generality of the foregoing, it is clarified that any Open Source Software is provided on an "AS IS" basis, without indemnity or warranty of any kind, whether express or implied. For clarity, the representations and warranties set forth in Section ‎4 hereunder shall not apply to any Open Source Software.
+1. Title & Ownership. APPLITOOLS DOES NOT SELL OR TRANSFER TITLE IN THE SOFTWARE, OR ANY PART THEREOF, TO LICENSEE. The Documentation, Software (excluding any Open Source Software and Third Party Software therein which are owned by their respective licensors) and/or any copies thereof, including without limitation any derivative works made (regardless of whether such derivative works were made and/or developed pursuant to the request and/or specifications of Licensee, and irrespective of any support and/or assistance Applitools may, will or had received from Licensee, or any third party on its behalf, with respect thereto), as well as any updates or upgrades thereto, if provided to Applitools pursuant to this Agreement, shall remain Applitools' sole and exclusive property. All Intellectual Property Rights evidenced by or embodied in and/or attached/connected/related to the Software, or part thereof, are and shall be owned solely and exclusively by Applitools. Nothing in this Agreement shall constitute a waiver of Applitools' Intellectual Property Rights under any law, or be in any way construed or interpreted as such. It is further agreed that to the extent Licensee provides Applitools with Feedback, Licensee acknowledges that any and all rights, including Intellectual Property Rights in such Feedback shall belong exclusively to Applitools and Licensee hereby irrevocably and unconditionally transfers and assigns to Applitools all intellectual property rights in such Feedback and waives any and all moral rights that Licensee may have in respect thereto. It is further understood that use of Feedback, if any, may be made by Applitools at its sole discretion, and that Applitools in no way shall be obliged to make use of any kind of the Feedback or part thereof.
+1. Warranty. Applitools warrants that to its knowledge it has the right to grant the license under this Agreement. Applitools' sole liability for any breach of this warranty or any other warranty under this Agreement shall be, at Applitools' sole discretion: (i) to replace or repair the Software or the applicable portion thereof; or (ii) to terminate this Agreement.
+2. Warranty Exclusions. The warranties set forth in Section ‎4 are contingent upon Licensee's proper use of the Software, and shall not apply to damage caused by abuse, misuse, alteration, neglect or unauthorized repair or installation, or by the use or attempted use of Software other than that supplied and supported by Applitools. Applitools will use reasonable commercial efforts to repair or replace the Software or the applicable portion thereof, pursuant to the foregoing warranty within thirty (30) days of being so notified.
+1. Warranty Disclaimers. AS BETWEEN LICENSEE AND APPLITOOLS, EXCEPT AS SET IN SECTION ‎4, THE SOFTWARE IS PROVIDED ON AN "AS IS" AND "AS AVAILABLE" BASIS WITHOUT WARRANTIES OF ANY KIND INCLUDING, WITHOUT LIMITATION, REPRESENTATIONS, WARRANTIES AND CONDITIONS OF MERCHANTABILITY, FITNESS FOR INTENDED OR PARTICULAR PURPOSE, TITLE, NON-INFRINGEMENT, THAT THE SOFTWARE WILL MEET LICENSEE'S REQUIREMENTS OR EXPECTATIONS OR WILL ACHIEVE ANY SPECIFIC RESULTS AND THOSE ARISING BY STATUTE OR FROM A COURSE OF DEALING OR USAGE OF TRADE. Applicable law may not allow the exclusion of certain warranties, so to that extent such exclusions may not apply.
+1. High Risk Activities. You acknowledge that the Software is not fault tolerant and is not designed, manufactured, or intended for use or resale as on-line control equipment in hazardous or high risk environments and activities requiring fail-safe performance (such as in the operation of nuclear facilities, aircraft navigation or communication systems, air traffic control, direct life support machines and/or devices, or weapons systems) in which the failure of the Software could lead directly to death, personal injury, or severe physical or environmental damage, and You agree not to use or allow the use of the Software or any portion thereof for, or in connection with, any such environment or activity.
+1. Indemnify. You agree that Applitools shall have no liability whatsoever for any use made of the Software by You or any third party. You hereby agree to defend, indemnify and hold harmless Applitools and its affiliates and their respective officers, directors, agents and employees from any and all claims, damages, liabilities, costs, and expenses (including attorney's fees) arising from claims related to Your use of the Software as well as from Your failure to comply with this Agreement.
+1. Limitation of Liability. UNDER NO CIRCUMSTANCES SHALL APPLITOOLS AND/OR ITS AFFILIATES BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL DAMAGES, OR FOR ANY LOSS OF DATA, REVENUE, BUSINESS OR REPUTATION, THAT ARISES UNDER OR IN CONNECTION WITH THIS AGREEMENT, OR THAT RESULTS FROM THE USE OF, OR THE INABILITY TO USE, THE SOFTWARE. APPLITOOLS'S TOTAL AGGREGATE LIABILITY FOR ANY AND ALL DIRECT DAMAGES AND LOSSES THAT ARISE UNDER OR IN CONNECTION WITH THIS AGREEMENT SHALL NOT IN ANY CIRCUMSTANCE EXCEED THE AMOUNT OF 100.00 (ONE HUNDRED) UNITED STATES DOLLARS. THE FOREGOING LIMITATIONS AND EXCLUSIONS IN THIS SECTION ‎7 SHALL APPLY: (I) EVEN IF APPLITOOLS HAS BEEN ADVISED OF THE POSSIBILITY OF ANY DAMAGES OR LOSSES; (II) EVEN IF ANY REMEDY SET FORTH HEREIN FAILS OF ITS ESSENTIAL PURPOSE; AND (III) REGARDLESS OF THE BASIS OR THEORY OF LIABILITY.
+1. Export Laws. Licensee agrees to comply fully with all U.S., EU, Israeli, and all applicable export laws and regulations to ensure that neither the Software nor any technical data related thereto are exported or re-exported directly or indirectly in violation of, or used for any purposes prohibited by, such laws and regulations. For clarity, and without derogating from Section ‎11 below, in case of any change of any applicable law, policy or regulation, which might affect Applitools' business, Applitools will have the right to terminate this Agreement and the license granted hereunder and the Licensee shall have no claims regarding such termination.
+1. Term and Termination. This Agreement shall continue until terminated as set forth in this section (the "Term"). You may terminate this Agreement at any time by removing the Software from Your system and destroying all copies of the Software and Documentation relating to the Software. Unauthorized copying of the Software or otherwise failing to comply with this Agreement will result in automatic immediate termination of this Agreement and will make available to Applitools legal remedies. Applitools reserves the right to terminate this Agreement and the License at any time and without notice. Upon termination of this Agreement, the License will terminate and You: (i) will cease any and all rights to use the Software, and (ii) will remove the Software from all hard drives, networks and other storage media and destroy all copies of the Software in your possession or under your control. The provisions of Sections ‎2.3, ‎2.4, ‎2.5, ‎6, ‎7, ‎8, ‎9, 10, ‎11 and ‎12 shall survive the termination, expiration or other ending of this Agreement.
+1. Miscellaneous. This Agreement represents the complete agreement concerning the Software between You and Applitools and supersedes all prior agreements and representations between You and Applitools. If any provision of this Agreement is held to be unenforceable for any reason, such provision shall be reformed only to the extent necessary to make it enforceable. Any waiver of any provision of this Agreement will be effective only if in writing and signed by Applitools. This Agreement is personal to You and may not be assigned or transferred for any reason whatsoever without the consent of Applitools and any action or conduct in violation of the foregoing shall be void and without effect. Applitools expressly reserves the right to assign this Agreement and to delegate any of its obligations hereunder. This Agreement are governed by and construed under the laws of the State of Israel, excluding its conflicts of law rules. You expressly agree that the exclusive jurisdiction for any claim or action arising out of or relating to this Agreement shall be the courts located in Tel Aviv, Israel, and You further agree and submit to the exercise of personal jurisdiction of such courts for the purpose of litigating any such claim or action. In any action or proceeding to enforce rights under this Agreement, the prevailing party shall be entitled to recover costs and attorneys' fees.

data/README.md

@@ -0,0 +1,440 @@
+# Applitools Eyes Images SDK for Ruby
+
+[![Gem Version](https://badge.fury.io/rb/eyes_images.svg)](https://badge.fury.io/rb/eyes_images)
+
+The Applitools Eyes Images SDK for Ruby enables visual testing of images from any source. Test screenshots, rendered images, or any visual content without requiring browser automation.
+
+## Table of Contents
+
+1. [Overview](#overview)
+2. [Installation](#installation)
+3. [Key Components](#key-components)
+4. [Basic Usage](#basic-usage)
+5. [Advanced Features](#advanced-features)
+   - [Region-based Testing](#region-based-testing)
+   - [Target API](#target-api)
+   - [Batch Testing](#batch-testing)
+   - [Match Levels](#match-levels)
+   - [Ignoring Regions](#ignoring-regions)
+   - [Floating Regions](#floating-regions)
+6. [Configuration](#configuration)
+7. [Best Practices](#best-practices)
+8. [Troubleshooting](#troubleshooting)
+9. [FAQ](#faq)
+10. [API Reference](#api-reference)
+
+## Overview
+
+The Applitools Eyes Images SDK enables you to perform visual testing on image files directly. Unlike other Applitools SDKs that work with web browsers or mobile devices, the Images SDK works with raw image data from any source.
+
+### Key Features
+
+- **Direct Image Testing**: Test images without browser or device automation
+- **Multiple Image Sources**: Support for files, byte arrays, base64, and image objects
+- **Region-Based Testing**: Focus on specific areas within images
+- **Flexible Matching**: Apply different match levels and comparison strategies
+- **Dynamic Content Handling**: Ignore or float regions with changing content
+- **Test Organization**: Group related tests with batch management
+- **Framework Integration**: Works with RSpec, Minitest, and other Ruby test frameworks
+
+### Common Use Cases
+
+- Testing generated PDFs, charts, or reports
+- Validating screenshots from desktop applications
+- Cross-platform UI consistency checks
+- Design mockup validation
+- Image processing pipeline testing
+
+## Installation
+
+Add the SDK to your Gemfile:
+
+```ruby
+gem 'eyes_images'
+```
+
+Or install it directly:
+
+```
+gem install eyes_images
+```
+
+### Dependencies
+
+The Eyes Images SDK has the following dependencies:
+- `eyes_core` - Core Applitools functionality
+- Ruby image handling libraries
+
+## Key Components
+
+### Eyes Class
+
+`Applitools::Images::Eyes` is the main class for interacting with the Applitools Eyes service. It provides methods for initializing, configuring, and performing visual checks on images.
+
+### Target Class
+
+`Applitools::Images::Target` defines what to capture during a check operation. It provides a fluent interface for specifying:
+- Image source (path, bytes, or image object)
+- Regions to check
+- Regions to ignore
+- Floating regions
+- Match levels
+
+### Image Class
+
+The SDK works with several types of image representations:
+- File paths
+- Image bytes
+- Ruby image objects
+- Base64 encoded image strings
+
+## Basic Usage
+
+### Initializing Eyes
+
+```ruby
+require 'eyes_images'
+
+# Initialize the Eyes SDK
+eyes = Applitools::Images::Eyes.new
+eyes.api_key = 'YOUR_APPLITOOLS_API_KEY'
+
+# Optional: Configure logging
+eyes.log_handler = Logger.new(STDOUT)
+```
+
+### Opening a Test
+
+```ruby
+# Start the test
+eyes.open(
+  app_name: 'My Image App',
+  test_name: 'Product Images Test'
+)
+```
+
+### Visual Validations
+
+```ruby
+# Check an image from a file path
+eyes.check_image(
+  image_path: '/path/to/image.png',
+  tag: 'Product Image'
+)
+
+# Check an image from bytes
+image_bytes = File.read('/path/to/image.png', mode: 'rb')
+eyes.check_image(
+  image_bytes: image_bytes,
+  tag: 'Product Image from Bytes'
+)
+
+# Check a specific region in an image
+region = Applitools::Region.new(10, 20, 300, 150) # x, y, width, height
+eyes.check_region(
+  image_path: '/path/to/image.png',
+  region: region,
+  tag: 'Product Logo'
+)
+```
+
+### Closing a Test
+
+```ruby
+# Close the test and get results
+results = eyes.close(false)
+puts "Test results: #{results}"
+
+# Always include in an ensure block
+ensure
+  # If the test was not closed properly, abort it
+  eyes.abort_if_not_closed
+```
+
+## Advanced Features
+
+### Region-based Testing
+
+Test specific regions within an image:
+
+```ruby
+# Define a region
+region = Applitools::Region.new(10, 20, 300, 200)  # x, y, width, height
+
+# Check only that region
+eyes.check_region(
+  image_path: '/path/to/image.png',
+  region: region,
+  tag: 'Header region'
+)
+```
+
+### Target API
+
+The Target API provides a fluent interface for more complex validations:
+
+```ruby
+# Create a target from a file path
+target = Applitools::Images::Target.path('/path/to/image.png')
+
+# Create a target from image bytes
+bytes = File.read('/path/to/image.png', mode: 'rb')
+target = Applitools::Images::Target.bytes(bytes)
+
+# Run the check
+eyes.check('My image check', target)
+```
+
+### Batch Testing
+
+Group multiple tests into a batch for easier management and reporting:
+
+```ruby
+# Create a batch
+batch = Applitools::BatchInfo.new('Product Images Batch')
+batch.id = 'unique-batch-id'  # Optional: Set a custom batch ID
+
+# Assign batch to the Eyes instance
+eyes.batch = batch
+
+# Run multiple tests with this batch
+eyes.open(app_name: 'My App', test_name: 'First Test')
+eyes.check_image(image_path: '/path/to/image1.png', tag: 'Image 1')
+eyes.close
+
+# Another test in the same batch
+eyes.open(app_name: 'My App', test_name: 'Second Test')
+eyes.check_image(image_path: '/path/to/image2.png', tag: 'Image 2')
+eyes.close
+```
+
+### Match Levels
+
+Set different strictness levels for visual comparisons:
+
+```ruby
+# Set match level for the entire test
+eyes.match_level = Applitools::MatchLevel::LAYOUT
+
+# Set match level for a specific check using Target API
+target = Applitools::Images::Target.path('/path/to/image.png')
+  .match_level(Applitools::MatchLevel::CONTENT)
+eyes.check('Content Match Level', target)
+
+# Available match levels:
+# - Applitools::MatchLevel::EXACT   # Pixel-perfect matching
+# - Applitools::MatchLevel::STRICT  # Default, allows small differences
+# - Applitools::MatchLevel::CONTENT # Ignores colors, checks content
+# - Applitools::MatchLevel::LAYOUT  # Checks only layout structure
+# - Applitools::MatchLevel::NONE    # No comparison, just captures image
+```
+
+### Ignoring Regions
+
+Specify regions to ignore during comparison:
+
+```ruby
+# Using Target API with region object
+ignore_region = Applitools::Region.new(50, 100, 200, 50)
+target = Applitools::Images::Target.path('/path/to/image.png')
+  .ignore(ignore_region)
+eyes.check('Image with ignored region', target)
+
+# Multiple ignore regions
+target = Applitools::Images::Target.path('/path/to/image.png')
+  .ignore(Applitools::Region.new(50, 100, 200, 50))
+  .ignore(Applitools::Region.new(300, 200, 100, 100))
+eyes.check('Image with multiple ignored regions', target)
+```
+
+### Floating Regions
+
+Floating regions allow elements to "float" or shift position within defined bounds:
+
+```ruby
+# Define a floating region with offsets (max_left, max_up, max_right, max_down)
+floating_region = Applitools::Region.new(10, 20, 300, 150)
+target = Applitools::Images::Target.path('/path/to/image.png')
+  .floating(floating_region, 10, 10, 10, 10)
+eyes.check('Image with floating region', target)
+```
+
+## Configuration
+
+### Test Configuration
+
+```ruby
+# Set the viewport size (affects baseline selection)
+eyes.viewport_size = Applitools::RectangleSize.new(1024, 768)
+
+# Configure match settings
+eyes.match_timeout = 5000  # milliseconds
+eyes.match_level = Applitools::MatchLevel::STRICT
+
+# Set server URL (for on-premise deployments)
+eyes.server_url = 'https://eyes.mycompany.com'
+
+# Set a proxy
+eyes.proxy = Applitools::Connectivity::Proxy.new('http://proxy.company.com', 8080)
+```
+
+### Batch Configuration
+
+```ruby
+# Create a batch with name
+batch = Applitools::BatchInfo.new('My Batch Name')
+
+# Set batch sequence name for grouping batches
+batch.sequence_name = 'Weekly Regression'
+
+# Additional batch properties
+batch.id = 'unique-id-for-batch'  # Custom ID for the batch
+batch.add_property('Environment', 'Production')
+batch.add_property('Branch', 'main')
+
+# Assign to Eyes instance
+eyes.batch = batch
+```
+
+## Best Practices
+
+1. **Consistent Image Sources**
+   - Ensure images are captured consistently (same resolution, format, etc.)
+   - Use the same image processing library throughout your tests
+
+2. **Efficient Region Selection**
+   - Test specific regions when possible instead of full images
+   - Group related elements into logical regions
+
+3. **Proper Error Handling**
+   - Always use try/finally blocks and call `abort_if_not_closed()`
+   - Handle and log exceptions appropriately
+
+4. **Batch Organization**
+   - Group related tests into meaningful batches
+   - Use batch properties to add important metadata
+
+5. **Match Level Selection**
+   - Use appropriate match levels based on content type
+   - Consider using LAYOUT for dynamic text content
+   - Consider using STRICT for logos and important branding elements
+
+6. **Baseline Management**
+   - Establish good baseline images under controlled conditions
+   - Review and update baselines when intended changes occur
+
+7. **API Key Security**
+   - Store API keys in environment variables or secure configuration
+   - Never hard-code API keys in source code
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Authentication Errors**
+   - Check that your API key is set correctly
+   - Verify connectivity to the Applitools server
+
+2. **Image Format Issues**
+   - Ensure the image is in a supported format (PNG, JPEG, etc.)
+   - Check for corrupt or incomplete image files
+
+3. **Region Validation Failures**
+   - Verify region coordinates are within the image bounds
+   - Check that regions are properly defined (non-zero width/height)
+
+4. **Baseline Mismatches**
+   - Review test results in the Applitools dashboard
+   - Check for unexpected changes in image content/format
+   - Verify environment settings affecting the images
+
+5. **Performance Issues**
+   - Large images may take longer to process
+   - Consider resizing very large images before testing
+   - Check network connectivity to Applitools servers
+
+### Debugging Tips
+
+1. Enable verbose logging:
+   ```ruby
+   eyes.log_handler = Logger.new(STDOUT)
+   eyes.log_handler.level = Logger::DEBUG
+   ```
+
+2. Check the image path and accessibility:
+   ```ruby
+   puts "File exists: #{File.exist?('/path/to/image.png')}"
+   puts "File size: #{File.size('/path/to/image.png')}"
+   ```
+
+3. Verify region coordinates:
+   ```ruby
+   region = Applitools::Region.new(x, y, width, height)
+   puts "Region: #{region.to_s}"
+   ```
+
+## FAQ
+
+**Q: Can I use Eyes Images SDK to test screenshots from web applications?**  
+A: Yes, you can capture screenshots using any method and then use the Eyes Images SDK to validate them.
+
+**Q: How do I handle dynamic content in images?**  
+A: Use ignore regions for content that changes between tests, or use a more lenient match level like LAYOUT.
+
+**Q: Can I test images with different resolutions?**  
+A: Yes, but be aware that differing resolutions may cause baseline mismatches. Consider resizing images to a standard resolution before testing.
+
+**Q: Is it possible to compare two images directly without using the Applitools service?**  
+A: The SDK is designed to work with the Applitools service. For direct image comparison without Applitools, you would need to use separate image processing libraries.
+
+**Q: How can I test multiple images in sequence?**  
+A: You can make multiple `check_image` calls within a single test session (between `open` and `close`), or you can group related images into a batch.
+
+**Q: Can I integrate this SDK with my existing test framework?**  
+A: Yes, the SDK can be integrated with any Ruby test framework including RSpec, Cucumber, Minitest, etc.
+
+**Q: How do I handle images with varying content but same structure?**  
+A: Use the LAYOUT match level which focuses on the structure of elements rather than their exact content.
+
+## API Reference
+
+### `Applitools::Images::Eyes`
+
+Core methods:
+- `initialize` - Creates a new Eyes instance
+- `open(options)` - Starts a test session
+- `check_image(options)` - Checks a full image
+- `check_region(options)` - Checks a specific region in an image
+- `check(tag, target)` - Checks using the Target API
+- `close(throw_exception = true)` - Closes a test session
+- `abort_if_not_closed` - Aborts an open test
+
+Configuration methods:
+- `api_key=` - Sets the Applitools API key
+- `server_url=` - Sets the Applitools server URL
+- `proxy=` - Sets the proxy configuration
+- `match_level=` - Sets the default match level
+- `match_timeout=` - Sets the match timeout
+- `batch=` - Sets the batch information
+- `branch_name=` - Sets the branch name
+- `parent_branch_name=` - Sets the parent branch name
+- `viewport_size=` - Sets the viewport size
+
+### `Applitools::Images::Target`
+
+Factory methods:
+- `Target.path(path)` - Creates a target from an image file path
+- `Target.bytes(image_bytes)` - Creates a target from image bytes
+- `Target.image(image)` - Creates a target from an image object
+
+Instance methods:
+- `ignore(region)` - Defines a region to ignore
+- `floating(region, max_left, max_up, max_right, max_down)` - Defines a floating region
+- `match_level(match_level)` - Sets the match level for this target
+- `timeout(timeout_ms)` - Sets the match timeout for this target
+
+## License
+
+This SDK is distributed under the Applitools SDK License Agreement. See the [LICENSE](LICENSE) file for more details.
+
+**Important:** This SDK may be used solely for your personal, non-commercial purposes. For commercial use, please contact your Applitools representative or visit [applitools.com](https://applitools.com) to obtain a commercial license.

data/eyes_images.gemspec

@@ -13,13 +13,15 @@ Gem::Specification.new do |spec|
   spec.description   = 'Provides Images SDK for Applitools tests.'
   spec.summary       = 'Applitools Ruby Images SDK'
   spec.homepage      = 'https://www.applitools.com'
-  spec.license       = 'Applitools'
+  spec.license       = 'Proprietary'
 
   spec.metadata['yard.run'] = 'yri' # use "yard" to build full HTML docs.
 
   spec.files         = `git ls-files lib/applitools/images`.split($RS) + [
     'lib/eyes_images.rb',
     'lib/applitools/eyes_images/version.rb',
+    'LICENSE',
+    'README.md',
     'CHANGELOG.md',
     'eyes_images.gemspec',
     'Rakefile',
@@ -27,5 +29,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = %w(lib)
-  spec.add_dependency 'eyes_core', "= 6.7.0"
+  spec.add_dependency 'eyes_core', "= 6.7.2"
 end

data/lib/applitools/eyes_images/version.rb

@@ -2,6 +2,6 @@
 
 module Applitools
   module EyesImages
-    VERSION = '6.5.2'.freeze
+    VERSION = '6.5.4'.freeze
   end
 end

data/lib/applitools/images/eyes.rb

@@ -117,7 +117,7 @@ module Applitools::Images
 
       image = target.image
       self.viewport_size = Applitools::RectangleSize.new image.width, image.height if viewport_size.nil?
-      self.screenshot = EyesImagesScreenshot.new image
+      self.screenshot = image
 
       if match_window_data.is_a? Applitools::MatchSingleCheckData
         return check_single_base(
@@ -155,7 +155,7 @@ module Applitools::Images
             end
 
             define_singleton_method :coordinate_type do
-              Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative]
+              :context_relative
             end
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_images
 version: !ruby/object:Gem::Version
-  version: 6.5.2
+  version: 6.5.4
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-04-17 00:00:00.000000000 Z
+date: 2025-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eyes_core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.7.0
+        version: 6.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.7.0
+        version: 6.7.2
 description: Provides Images SDK for Applitools tests.
 email:
 - team@applitools.com
@@ -32,6 +32,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- LICENSE
+- README.md
 - Rakefile
 - eyes_images.gemspec
 - lib/applitools/eyes_images/version.rb
@@ -40,7 +42,7 @@ files:
 - lib/eyes_images.rb
 homepage: https://www.applitools.com
 licenses:
-- Applitools
+- Proprietary
 metadata:
   yard.run: yri
 post_install_message: