eyes_appium 6.4.2 → 6.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 983229f0027129770c7ba59b0adfbab752572a8b71fdb69ed2bb5ded0b785c52
-  data.tar.gz: bcf0481f0fefef75c338cbd718c44041e64bf92d113d9399330a9bfbc218543d
+  metadata.gz: 5fcfa8562652c96b348aba30ea81631c693700dcdcb58a37374238bd5b4aae69
+  data.tar.gz: d7081f08a381fdf0f85013bac13078603b937263e3fd608e97bae977083dbcaa
 SHA512:
-  metadata.gz: c99d3bf1a83202c37d727ec6f36a0ca3e8296ff7199157872c4290b6587db44107e68fadc42ef3c4229da117fb6a51b536f5c7e621d1a516025396d96f93ca5f
-  data.tar.gz: 87a99f190a4a27e09e254aaddb349d0b700787ea7336f613cb59ea99a741ebeabe7bfb71f922a960bc647cfe58ca8788c6d54de210fb104bbcb3aa76d44da34f
+  metadata.gz: 220b47d8d64b3c1d0a0ce91121ea694619542ff66c534835553ed8847d8a4b4c064935e43a1004dd8631a46629f738a77a2a7cddab1a5c766a83068506e62a22
+  data.tar.gz: 6377c0649e4893e868f4c25fc85626fb869eb56e82d82d2fd87744941c4bec6489c81e0503fbc3f8940bf653001ec7eddcf28121b0902c832268dbd7d11210bc

data/CHANGELOG.md

@@ -1,5 +1,106 @@
 # Changelog
 
+## [6.4.4](https://github.com/Applitools-Dev/sdk/compare/ruby/eyes_appium@6.4.3...ruby/eyes_appium@6.4.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/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/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))
+
+
+
+* @applitools/ec-client bumped to 1.10.15
+
+* eyes_core bumped to 6.7.2
+
+* @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/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
+
+* eyes_universal bumped to 4.40.0
+
+* eyes_selenium bumped to 6.9.2
+  #### Bug Fixes
+
+  * remove safari-early-access browser version (bindings) | AD-10226 ([#3033](https://github.com/Applitools-Dev/sdk/issues/3033)) ([108b805](https://github.com/Applitools-Dev/sdk/commit/108b8051986609fc701a20cee8e39cefd433c19b))
+
+
+
+
+## [6.4.3](https://github.com/Applitools-Dev/sdk/compare/ruby/eyes_appium@6.4.2...ruby/eyes_appium@6.4.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
+
+* eyes_selenium bumped to 6.9.1
+
+
 ## [6.4.2](https://github.com/Applitools-Dev/sdk/compare/ruby/eyes_appium@6.4.1...ruby/eyes_appium@6.4.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,370 @@
+# Applitools Eyes Appium SDK for Ruby
+
+[![Gem Version](https://badge.fury.io/rb/eyes_appium.svg)](https://badge.fury.io/rb/eyes_appium)
+
+The Applitools Eyes Appium SDK for Ruby extends visual testing capabilities to mobile applications using Appium. This SDK enables automated visual testing for both native mobile apps and hybrid applications across iOS and Android platforms.
+
+## Table of Contents
+
+1. [Overview](#overview)
+2. [Installation](#installation)
+3. [Key Components](#key-components)
+   - [Eyes Class](#eyes-class)
+   - [Target Class](#target-class)
+   - [Driver Class](#driver-class)
+   - [Screenshot Classes](#screenshot-classes)
+   - [Region Providers](#region-providers)
+4. [Basic Usage](#basic-usage)
+   - [Initializing Eyes](#initializing-eyes)
+   - [Opening a Test](#opening-a-test)
+   - [Capturing Screenshots](#capturing-screenshots)
+   - [Configuring Match Settings](#configuring-match-settings)
+   - [Closing a Test](#closing-a-test)
+5. [Advanced Features](#advanced-features)
+   - [Handling Native and WebView Contexts](#handling-native-and-webview-contexts)
+   - [Region-based Testing](#region-based-testing)
+   - [Working with Different Mobile Platforms](#working-with-different-mobile-platforms)
+   - [Mobile Native Grid (MNG) Integration](#mobile-native-grid-integration)
+6. [Best Practices](#best-practices)
+7. [Troubleshooting](#troubleshooting)
+8. [FAQ](#faq)
+9. [Documentation](#documentation)
+10. [API Reference](#api-reference)
+
+## Overview
+
+The Applitools Eyes Appium SDK for Ruby extends the Eyes Selenium SDK to provide visual testing capabilities for mobile applications using Appium. It seamlessly integrates with your existing Appium test automation to add AI-powered visual validations.
+
+### Key Features
+
+- **Cross-Platform Support**: Works with both iOS and Android applications
+- **Native & Hybrid Apps**: Supports pure native apps and hybrid apps with WebViews
+- **Automatic Platform Detection**: Intelligently detects the platform and adjusts behavior accordingly
+- **Region-Based Testing**: Target specific UI elements for precise visual validation
+- **WebView Context Handling**: Seamlessly switch between native and WebView contexts
+- **Mobile Native Grid Integration**: Leverage cloud-based device testing for scalability
+
+The SDK handles platform-specific complexities such as status bar heights, device pixel ratios, and screenshot capture mechanisms, allowing you to focus on writing tests rather than dealing with mobile-specific implementation details.
+
+## Installation
+
+Add the gem to your Gemfile:
+
+```ruby
+gem 'eyes_appium'
+```
+
+Or install it directly:
+
+```bash
+gem install eyes_appium
+```
+
+### Dependencies
+
+The Eyes Appium SDK has the following dependencies:
+- `eyes_selenium` - Core Applitools functionality for Selenium-based testing
+- `appium_lib` (>= 10.6.0) - Appium Ruby client
+- `selenium-webdriver` (>= 3, < 4.30) - WebDriver implementation
+
+> **Dependency Update:** The SDK has been optimized to reduce mandatory dependencies. WebDriver-related dependencies are now more flexible to improve compatibility across different environments.
+
+## Key Components
+
+### Eyes Class
+
+`Applitools::Appium::Eyes` is the main class that provides the core functionality for visual testing of mobile applications. It extends `Applitools::Selenium::SeleniumEyes` and customizes the behavior for mobile applications.
+
+Key features:
+- Detects the platform (iOS or Android) automatically
+- Provides native app testing capabilities
+- Handles status bar height and device pixel ratio
+- Manages different region providers based on the platform
+
+### Target Class
+
+`Applitools::Appium::Target` extends the Selenium Target class to handle mobile-specific targeting. It provides methods to:
+- Target specific elements in mobile applications
+- Handle region-based checks
+- Support WebView contexts
+- Define areas to ignore, floating regions, and layout regions
+
+### Driver Class
+
+`Applitools::Appium::Driver` extends `Applitools::Selenium::Driver` to integrate with Appium's driver. It wraps the Appium driver to provide additional functionality for visual testing.
+
+### Screenshot Handling
+
+The SDK includes platform-specific screenshot handling for:
+- iOS devices and simulators
+- Android devices and emulators
+
+These handle platform-specific aspects of screenshots, such as status bar height and device pixel ratio.
+
+## Basic Usage
+
+### Initializing Eyes
+
+```ruby
+require 'eyes_appium'
+
+# Initialize the Eyes SDK
+eyes = Applitools::Appium::Eyes.new
+eyes.api_key = 'YOUR_API_KEY'
+
+# Optional: Configure logging
+eyes.log_handler = Logger.new(STDOUT)
+```
+
+### Opening a Test
+
+```ruby
+# Define Appium capabilities
+caps = {
+  deviceName: 'iPhone 12',
+  platformName: 'iOS',
+  platformVersion: '14.5',
+  app: '/path/to/your/app.ipa',
+  automationName: 'XCUITest'
+}
+
+# Initialize Appium driver
+appium_opts = {
+  server_url: 'http://127.0.0.1:4723/wd/hub'
+}
+driver = Appium::Driver.new({ caps: caps, appium_lib: appium_opts }, true)
+driver.start_driver
+
+# Start the test
+eyes.open(
+  app_name: 'My Mobile App',
+  test_name: 'Login Screen Test',
+  driver: driver
+)
+```
+
+### Capturing Screenshots
+
+#### Full Window Check
+
+```ruby
+# Check the entire screen
+eyes.check_window('Home Screen')
+```
+
+#### Region Check
+
+```ruby
+# Check a specific element by accessibility ID
+eyes.check('Profile Button', Applitools::Appium::Target.region(accessibility_id: 'profile_button'))
+
+# Check a specific element by XPath
+eyes.check('Login Form', Applitools::Appium::Target.region(xpath: '//android.widget.EditText'))
+```
+
+### Configuring Match Settings
+
+```ruby
+# Set the match level
+eyes.match_level = Applitools::MatchLevel::LAYOUT
+
+# Configure layout regions
+target = Applitools::Appium::Target.window.layout(id: 'dynamic_content')
+eyes.check('With Layout Region', target)
+
+# Ignore regions
+target = Applitools::Appium::Target.window.ignore(id: 'timestamp')
+eyes.check('Ignoring Timestamp', target)
+```
+
+### Closing a Test
+
+```ruby
+# Complete the test
+results = eyes.close(false)
+puts "Test results: #{results.to_s}"
+
+# Always include in a ensure block
+ensure
+  # If the test was not closed, abort it
+  eyes.abort_if_not_closed
+  
+  # Close the Appium driver
+  driver.driver_quit
+```
+
+## Advanced Features
+
+### Handling Native and WebView Contexts
+
+The SDK provides seamless handling of both native app contexts and WebView contexts:
+
+```ruby
+# Switch to WebView context
+webview_contexts = driver.available_contexts
+driver.set_context(webview_contexts.find { |c| c.include?('WEBVIEW') })
+
+# Check WebView content
+eyes.check('WebView Content', Applitools::Appium::Target.window.webview)
+
+# Switch back to native context
+driver.set_context('NATIVE_APP')
+
+# Check native content
+eyes.check_window('Native Content')
+```
+
+### Region-based Testing
+
+For more precise testing, you can target specific UI elements:
+
+```ruby
+# Check a specific element by its ID
+eyes.check('Username Field', Applitools::Appium::Target.region(id: 'username_field'))
+
+# Check an element with surrounding padding
+eyes.check(
+  'Password Field With Padding',
+  Applitools::Appium::Target.region(
+    accessibility_id: 'password_field',
+    padding: { top: 10, right: 20, bottom: 10, left: 20 }
+  )
+)
+```
+
+## Best Practices
+
+1. **Proper Test Cleanup**
+   - Always use `eyes.abort_if_not_closed` in the `ensure` block to ensure proper cleanup even if tests fail.
+   - Close the Appium driver in the `ensure` block to prevent resource leaks.
+
+2. **Efficient Region Selection**
+   - Target specific elements when possible instead of the entire window to make tests more focused and faster.
+   - Use accessibility IDs for element identification when possible (more robust than XPaths).
+
+3. **Handle Device Rotation**
+   - If your app supports both portrait and landscape modes, test in both orientations.
+   - Reset orientation between tests to ensure consistent starting conditions.
+
+4. **Manage WebView vs Native Context**
+   - Be explicit about context switching when testing hybrid apps.
+   - Use `check_window` for native contexts and `check` with `Target.window.webview()` for WebView contexts.
+
+5. **Device-Specific Testing**
+   - Test on multiple device types and OS versions to ensure compatibility.
+   - Use device-specific configurations when necessary.
+
+6. **Error Handling**
+   - Use proper exception handling to catch and log Appium and Eyes exceptions separately.
+   - Consider retry mechanisms for flaky mobile interactions.
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Screenshots Are Offset or Incorrectly Sized**
+   - Issue: Status bar height or device pixel ratio might not be correctly detected.
+   - Solution: Use `eyes.status_bar_height = custom_height` to manually set the status bar height.
+
+2. **Element Not Found During Checks**
+   - Issue: Element locators might be platform-specific or timing-related.
+   - Solution: Add implicit waits or explicit waits before performing checks.
+
+3. **Context Switching Problems**
+   - Issue: Cannot interact with elements after switching contexts.
+   - Solution: Verify the available contexts and ensure proper switching back to the native context.
+
+4. **Test Timeout Issues**
+   - Issue: Tests time out during visual comparison.
+   - Solution: Increase the match timeout using `eyes.match_timeout = 10000` (in milliseconds).
+
+5. **Differences in iOS vs Android Results**
+   - Issue: Tests pass on one platform but fail on another.
+   - Solution: Use platform-specific baselines and matching settings.
+
+### Debugging Tips
+
+1. Enable verbose logging:
+   ```ruby
+   eyes.log_handler = Logger.new(STDOUT)
+   eyes.log_handler.level = Logger::DEBUG
+   ```
+
+2. Use visual debugger by setting:
+   ```ruby
+   eyes.save_debug_screenshots = true
+   ```
+
+3. Check Appium server logs for connection or driver-related issues.
+
+4. Verify the device/emulator configuration matches your test capabilities.
+
+## FAQ
+
+**Q: Can I use Eyes Appium SDK with cloud-based Appium providers like Sauce Labs or BrowserStack?**  
+A: Yes, you can use the Eyes Appium SDK with any Appium server, including cloud-based services. Just configure the appropriate server URL and capabilities.
+
+**Q: How do I handle dynamic content in my mobile app?**  
+A: Use `ignore` regions for content that changes, or use the `layout` match level for areas with dynamic content but consistent structure.
+
+**Q: Can I test scrollable content in my mobile app?**  
+A: Yes, but you'll need to combine Appium's scrolling capabilities with Eyes' checking. Scroll to each position and perform a check, or use the `fully` option with caution.
+
+**Q: Does Eyes Appium SDK work with real devices, emulators, or both?**  
+A: The SDK works with both real devices and emulators/simulators. Real devices are recommended for more accurate visual testing.
+
+**Q: How do I handle different screen sizes and resolutions?**  
+A: Use Applitools' responsive testing features, and consider using device-specific baselines if necessary.
+
+**Q: Can I use features like Visual Grid with mobile testing?**  
+A: Yes, for hybrid apps with WebViews, you can use the Ultrafast Grid for the web portions. For native apps, use the Mobile Native Grid (MNG).
+
+## Documentation
+
+For comprehensive guides and tutorials on mobile testing with Applitools, please refer to:
+
+- **[Appium Ruby Native Apps Documentation](https://applitools.com/tutorials/sdks/appium-ruby-native/quickstart)** - Learn how to test native mobile applications using Appium and Ruby
+
+- **[Appium Ruby Mobile Web Documentation](https://applitools.com/tutorials/sdks/appium-ruby-web/quickstart)** - Learn how to test web applications on mobile browsers using Appium and Ruby
+
+For API documentation and additional resources, visit:
+- [Applitools Documentation Portal](https://applitools.com/docs)
+- [Applitools SDK API Reference](https://applitools.com/docs/api/eyes-sdk/index-gen/classindex-ruby.html)
+
+## API Reference
+
+### `Applitools::Appium::Eyes`
+
+Core methods:
+- `open(options)` - Starts a test session
+- `check(tag, target)` - Performs a checkpoint
+- `check_window(tag = nil, match_timeout = USE_DEFAULT_MATCH_TIMEOUT)` - Performs a full window checkpoint
+- `check_region(*args)` - Performs a region checkpoint
+- `close(throw_exception = true)` - Closes a test session
+- `abort_if_not_closed` - Aborts an open test
+
+Configuration methods:
+- `use_system_screenshot(value = true)` - Controls if system screenshots are used
+
+Static methods:
+- `set_mobile_capabilities(caps, api_key = nil, server_url = nil, proxy = nil)` - Sets up MNG capabilities
+- `set_nmg_capabilities` - Alias for `set_mobile_capabilities`
+
+### `Applitools::Appium::Target`
+
+- `window` - Creates a target for the entire window
+- `region(*args)` - Creates a target for a specific region
+- `ignore(*args)` - Defines regions to ignore
+- `floating(*args)` - Defines floating regions
+- `layout(*args)` - Defines layout regions
+- `strict(*args)` - Defines strict regions
+- `content(*args)` - Defines content regions
+- `accessibility(*args)` - Defines accessibility regions
+- `timeout(timeout_ms)` - Sets the match timeout
+- `webview(value = true)` - Specifies WebView context for the check
+
+## 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_appium.gemspec

@@ -13,11 +13,13 @@ Gem::Specification.new do |spec|
   spec.description   = 'Appium support for Applitools Ruby SDK'
   spec.summary       = 'Applitools Ruby Appium SDK'
   spec.homepage      = 'https://www.applitools.com'
-  spec.license       = 'Applitools'
+  spec.license       = 'Proprietary'
 
   spec.files         = `git ls-files lib/applitools/appium`.split($RS) + [
     'lib/eyes_appium.rb',
     'lib/applitools/eyes_appium/version.rb',
+    'LICENSE',
+    'README.md',
     'CHANGELOG.md',
     'eyes_appium.gemspec',
     'Rakefile',
@@ -25,7 +27,7 @@ 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_selenium', "= 6.9.0"
+  spec.add_dependency 'eyes_selenium', "= 6.9.2"
   spec.add_dependency 'appium_lib', '>= 10.6.0'
   # TODO: remove after appium_lib fix issue on their side at https://github.com/appium/ruby_lib_core/issues/602
   spec.add_dependency 'selenium-webdriver', ['>= 3', '< 4.30']

data/lib/applitools/appium/screenshot.rb

@@ -1,30 +1,14 @@
 # frozen_string_literal: true
 
+# Empty placeholder for backward compatibility
+# This class has been removed as its functionality is now handled by the Universal SDK
+
+require 'applitools/core/eyes_screenshot'
+
 module Applitools
   module Appium
+    # Empty placeholder class to maintain backward compatibility
     class Screenshot < Applitools::EyesScreenshot
-
-      attr_reader :status_bar_height, :device_pixel_ratio
-
-      def initialize(*args)
-        options = Applitools::Utils.extract_options!(args)
-        @status_bar_height = options[:status_bar_height] || 0
-        @device_pixel_ratio = options[:device_pixel_ratio] || 1
-        super
-      end
-
-      def sub_screenshot(region, _coordinate_type, _throw_if_clipped = false, _force_nil_if_clipped = false)
-        self.class.new(
-          Applitools::Screenshot.from_image(
-            image.crop(region.x, region.y, region.width, region.height)
-          )
-        )
-      end
-
-      def convert_location(location, _from, _to)
-        raise 'Applitools::Appium::Screenshot is an abstract class.' \
-          ' You should implement :convert_location method in a descendant class.'
-      end
     end
   end
-end
+end

data/lib/applitools/appium/target.rb

@@ -21,7 +21,7 @@ module Applitools
         value = { type: args[0], selector: args[1] } if value.nil?
         # value = value[:selector] if value.is_a?(Hash) && (value[:type].to_s === 'id') && !is_a?(Applitools::Appium::Target)
         self.region_to_check = value
-        self.coordinate_type = Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative]
+        self.coordinate_type = :context_relative
         options[:timeout] = nil
         reset_ignore
         reset_floating

data/lib/applitools/eyes_appium/version.rb

@@ -2,6 +2,6 @@
 
 module Applitools
   module EyesAppium
-    VERSION = '6.4.2'.freeze
+    VERSION = '6.4.4'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_appium
 version: !ruby/object:Gem::Version
-  version: 6.4.2
+  version: 6.4.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_selenium
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.9.0
+        version: 6.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.9.0
+        version: 6.9.2
 - !ruby/object:Gem::Dependency
   name: appium_lib
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- LICENSE
+- README.md
 - Rakefile
 - eyes_appium.gemspec
 - lib/applitools/appium/android_region_provider.rb
@@ -82,7 +84,7 @@ files:
 - lib/eyes_appium.rb
 homepage: https://www.applitools.com
 licenses:
-- Applitools
+- Proprietary
 metadata: {}
 post_install_message: 
 rdoc_options: []