eyes_core 4.6.1 → 4.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5da50988617f6f1d1d8fa0d841ffb56513559c51d7226c0e7507a7c6ffb97bf
-  data.tar.gz: 5a4426568492124b82ed7cc0b701cf90b63e9b0e0e5095b87c4c4b12e2d4b17d
+  metadata.gz: dc9edfb9472508be4eef5a0b90e465af508088a242e65702b778cc29fe3ae9ba
+  data.tar.gz: d886d03648fe73af72be41ae4d04f8cec2b4fdc0f956f1c753a3b7cc21144c04
 SHA512:
-  metadata.gz: 8a8de0abdfb28f62370dbb6d567c1995e45ba3ec9c836a794c03e2010072d29f7b96a54e2d800f67933843cf358233ea02755aaa60035942a7236f96192d788e
-  data.tar.gz: 0ae44b83b5085243e03dc156496f0eeef82dc91229c45d99b7fc5359f2c18a42218c4f3f3a45764a3926ce424ff60a03c1086761db603ebde1eb3bd169d3cddc
+  metadata.gz: 5bc0945cc30ee39e4a9b7648e02d7a2c84a8f5b96fbbc98855d7669c290a3995347f6c06d703efa65006851c16f116353b4940440353c45acec9c1c56a4656c2
+  data.tar.gz: ef53eba834af0a0c7e7db66437d31a26a669c68a14885f43b2f0a86c4c1099e32258c51b1bca7a1e9bbfd00361db3f12cad3b348c249c8b424a71a5f856599c1

data/lib/applitools/appium/eyes.rb

@@ -120,6 +120,41 @@ class Applitools::Appium::Eyes < Applitools::Selenium::SeleniumEyes
     check(options[:tag], target)
   end
 
+  def set_mobile_capabilities(nmg_caps, nml_api_key, eyes_server_url, proxy_settings)
+    new_caps = {}
+
+    if nml_api_key.nil? || nml_api_key.empty?
+      nml_api_key = ENV['APPLITOOLS_API_KEY']
+      if nml_api_key.nil? || nml_api_key.empty?
+        raise Applitools::EyesError.new('No API key was given, or is an empty string.')
+      end
+    end
+    new_caps[:NML_API_KEY] = nml_api_key
+
+    if eyes_server_url.nil? || eyes_server_url.empty?
+      eyes_server_url = ENV['APPLITOOLS_SERVER_URL']
+    end
+    new_caps[:NML_SERVER_URL] = eyes_server_url if eyes_server_url
+
+    if proxy_settings.nil? || proxy_settings.empty?
+      proxy_settings = ENV['APPLITOOLS_HTTP_PROXY']
+    end
+    new_caps[:NML_PROXY_URL] = proxy_settings if proxy_settings
+
+    nmg_caps[:optionalIntentArguments] = "--es APPLITOOLS '" + new_caps.to_json + "'"
+    nmg_caps[:processArguments] = {
+      args: [],
+      env: new_caps.merge(DYLD_INSERT_LIBRARIES: "@executable_path/Frameworks/UFG_lib.xcframework/ios-arm64/UFG_lib.framework/UFG_lib:@executable_path/Frameworks/UFG_lib.xcframework/ios-arm64_x86_64-simulator/UFG_lib.framework/UFG_lib")
+    }
+  end
+
+  alias set_nmg_capabilities set_mobile_capabilities
+
+  def use_system_screenshot(value = true)
+    self.screenshot_mode = !value ? 'applitools-lib' : 'default'
+    self
+  end
+
   private
 
   def viewport_screenshot

data/lib/applitools/core/eyes_base_configuration.rb

@@ -126,6 +126,7 @@ module Applitools
     boolean_field :enable_cross_origin_rendering
     boolean_field :dont_use_cookies
     boolean_field :dont_close_batches
+    string_field :screenshot_mode
 
     methods_to_delegate.delete(:batch_info)
     methods_to_delegate.delete(:batch_info=)

data/lib/applitools/core/eyes_runner.rb

@@ -4,6 +4,7 @@ module Applitools
   class EyesRunner
     attr_accessor :batches_server_connectors_map
     attr_accessor :universal_client, :universal_eyes_manager
+    attr_accessor :remove_duplicate_tests
 
     def initialize
       self.batches_server_connectors_map = {}
@@ -25,7 +26,11 @@ module Applitools
     end
 
     def close_all_eyes
-      get_universal_eyes_manager.close_all_eyes
+      get_universal_eyes_manager.close_all_eyes(remove_duplicate_tests)
+    end
+
+    def set_remove_duplicate_tests(value)
+      self.remove_duplicate_tests = !!value
     end
 
     # def close_batch(batch_id)

data/lib/applitools/core/universal_new_api.rb

@@ -44,7 +44,11 @@ module Applitools
       }
       driver_target = driver.universal_driver_config
       results = universal_eyes.locate(settings, driver_target)
-      Applitools::Utils.deep_stringify_keys(results)
+      old_style = {
+        applitools_title: results[:applitools_title].
+          map {|r| {left: r[:x], top: r[:y], width: r[:width], height: r[:height]} }
+      }
+      Applitools::Utils.deep_stringify_keys(old_style)
     end
 
   end

data/lib/applitools/universal_sdk/universal_check_settings.rb

@@ -95,6 +95,8 @@ module Applitools
                 # :locationInView,
                 # :fullViewSize
 
+    json_fields :screenshotMode
+
     def initialize(*args)
       options = Applitools::Utils.extract_options! args
       options.keys.select {|k| options[k] && respond_to?("#{k}=") }.each {|k| send("#{k}=", options[k]) }
@@ -119,6 +121,7 @@ module Applitools
 
       self.accessibility_settings = eyes.accessibility_validation
       self.disable_browser_fetching = eyes.dont_fetch_resources
+      self.screenshot_mode = eyes.screenshot_mode
 
       self.accessibility_regions = target.accessibility_regions
       self.content_regions = target.content_regions

data/lib/applitools/universal_sdk/universal_client.rb

@@ -16,7 +16,7 @@ module Applitools::Connectivity
     extend Forwardable
     def_delegators 'Applitools::EyesLogger', :logger
 
-    CORE_MAKE_EC_CLIENT = 'Core.makeECClient'
+    CORE_GET_EC_CLIENT = 'Core.getECClient'
     SESSION_INIT = 'Core.makeCore'
 
     CORE_MAKE_MANAGER = 'Core.makeManager'
@@ -57,7 +57,7 @@ module Applitools::Connectivity
       # ECClientSettings
       #
       # {
-      #   "capabilities": { // default capabilities that will be used if user do not provide `applitools:` caps
+      #   "options": { // default options that will be used if user do not provide `applitools:` caps
       #     "serverUrl": "https://eyesapi.applitools.com/",
       #     "apiKey": "DFH$HJD%77333J355",
       #   },
@@ -71,17 +71,17 @@ module Applitools::Connectivity
       ec_client_capabilities[:serverUrl] = server_url unless server_url.nil?
       ec_client_capabilities[:apiKey] = api_key unless api_key.nil?
       ec_client_settings = {}
-      ec_client_settings[:capabilities] = ec_client_capabilities unless ec_client_capabilities.empty?
+      ec_client_settings[:options] = ec_client_capabilities unless ec_client_capabilities.empty?
       ec_client_settings[:proxy] = proxy unless proxy.nil?
       make_ec_client_request_payload = {settings: ec_client_settings}
-      # interface MakeECClientRequestPayload {
+      # interface GetECClientRequestPayload {
       #   settings?: ECClientSettings
       # }
       #
-      # interface MakeECClientResponsePayload {
+      # interface GetECClientResponsePayload {
       #   url: string
       # }
-      command_with_result(CORE_MAKE_EC_CLIENT, make_ec_client_request_payload)
+      command_with_result(CORE_GET_EC_CLIENT, make_ec_client_request_payload)
     end
 
     def make_manager(eyes_manager_config)
@@ -95,9 +95,13 @@ module Applitools::Connectivity
     def core_make_manager(eyes_manager_config)
       # interface MakeManagerRequestPayload {
       #   type: 'ufg' | 'classic'
-      #   concurrency?: number
-      #   legacyConcurrency?: number
-      #   agentId?: string
+      #   settings?: EyesManagerSettings
+      # }
+      # ### EyesManagerSettings
+      # {
+      #   "concurrency": 10,
+      #   "legacyConcurrency": 50,
+      #   "agentId": "js/eyes/1.0.0"
       # }
       #
       # type MakeManagerResponsePayload = Ref<EyesManager>
@@ -168,7 +172,7 @@ module Applitools::Connectivity
       command_with_result(EYES_MANAGER_MAKE_EYES, {manager: manager, target: driver_config, settings: commands_config[:open], config: commands_config})
     end
 
-    def eyes_manager_close_all_eyes(manager)
+    def eyes_manager_close_all_eyes(manager, remove_duplicate_tests)
       # interface GetManagerResultsRequestPayload {
       #   manager: Ref<EyesManager>
       #   settings?: {throwErr?: boolean}
@@ -189,7 +193,7 @@ module Applitools::Connectivity
       #   missing: number
       #   matches: number
       # }
-      settings = {throwErr: false}
+      settings = {throwErr: false, removeDuplicateTests: remove_duplicate_tests}
       command_with_result(EYES_MANAGER_CLOSE_ALL_EYES, {manager: manager, settings: settings})
     end
 

data/lib/applitools/universal_sdk/universal_eyes_manager.rb

@@ -37,9 +37,9 @@ module Applitools
       universal_eyes
     end
 
-    def close_all_eyes
+    def close_all_eyes(remove_duplicate_tests)
       @opened_eyes.each {|universal_eye| universal_eye.close }
-      @universal_client.eyes_manager_close_all_eyes(@manager)
+      @universal_client.eyes_manager_close_all_eyes(@manager, remove_duplicate_tests)
     end
 
   end

data/lib/applitools/universal_sdk/universal_eyes_manager_config.rb

@@ -4,11 +4,11 @@ module Applitools
   class UniversalEyesManagerConfig
 
     def self.classic
-      new(type: CLASSIC)
+      new(type: CLASSIC, runner_agent_id: "eyes.classic.ruby/#{Applitools::VERSION}")
     end
 
     def self.vg(concurrent_open_sessions=1)
-      new(type: VG, concurrency: concurrent_open_sessions, legacy: false)
+      new(type: VG, concurrency: concurrent_open_sessions, legacy: false, runner_agent_id: "eyes.visualgrid.ruby/#{Applitools::VERSION}")
     end
 
     # export type EyesManagerConfig<TType extends 'vg' | 'classic' = 'vg' | 'classic'> = {
@@ -16,7 +16,7 @@ module Applitools
     #   concurrency?: TType extends 'vg' ? number : never
     #   legacy?: TType extends 'vg' ? boolean : never
     # }
-    attr_reader :type, :concurrency, :legacy
+    attr_reader :type, :concurrency, :legacy, :runner_agent_id
 
     VG = 'ufg'.freeze
     CLASSIC = 'classic'.freeze
@@ -29,6 +29,7 @@ module Applitools
       self.type = options[:type].to_s
       self.concurrency = options[:concurrency]
       self.legacy = options[:legacy]
+      @runner_agent_id = options[:runner_agent_id]
     end
 
     # enum_field :type, Applitools::UniversalEyesManagerConfig.type_enum_values
@@ -52,8 +53,10 @@ module Applitools
     def to_hash
       result = {}
       result[:type] = type
-      result[:concurrency] = concurrency if concurrency
-      result[:legacy] = legacy if legacy
+      result[:settings] = {}
+      result[:settings][:concurrency] = concurrency if concurrency
+      result[:settings][:legacyConcurrency] = legacy if legacy
+      result[:settings][:agentId] = runner_agent_id
       result.compact
     end
 

data/lib/applitools/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: false
 
 module Applitools
-  VERSION = '4.6.1'.freeze
-  IMAGES_VERSION = '4.2.1'.freeze
-  UNIVERSAL_VERSION = '3.3.1'.freeze
-  UNIVERSAL_CORE_VERSION = '2.4.8'.freeze
+  VERSION = '4.6.3'.freeze
+  IMAGES_VERSION = '4.2.3'.freeze
+  UNIVERSAL_VERSION = '3.3.3'.freeze
+  UNIVERSAL_CORE_VERSION = '3.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_core
 version: !ruby/object:Gem::Version
-  version: 4.6.1
+  version: 4.6.3
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.1
+        version: 3.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.1
+        version: 3.3.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement