eyes_core 3.16.16 → 3.17.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b136d9d87a89f8d7de25d38d7a6597d4dce20866def4985ba735a39e7b6e3462
-  data.tar.gz: 8d5861b1392c336a75ca393ac20224493cc7fd26e40ebee43951ff479ce8f63c
+  metadata.gz: 312e54caac6310abd60d5bc82d8e0897fc635d374a66744f560143232d324d0a
+  data.tar.gz: 06c6261334f611245938c4653bb2e6619a6309538285e3ace4d4bcfc4e2be214
 SHA512:
-  metadata.gz: c504140d557d1aac4516873f7c65149e293c10cde3c28f43bfbb31eee608b3ed5743b75e07a3674b51fe8a4ccde5a004b46ec986721957f342549575be345bc8
-  data.tar.gz: 53cff244c5b9290bf8baf58bb6f6d1e294183dc0f10097eb2c55273ca9301b31c6d0df21d97a1a404bd95835f5a5e5beb4b6b1afd095784703574154ca46c7d0
+  metadata.gz: 86a30cb5da86b0f128f3265f52c61880f429eb5310529a1fbf755b013c6e017515327c11d0507513acee261c57ca89d24b33306d69ea4cdea9dadb9455d82172
+  data.tar.gz: 9ab3f66d06e33475bcdf250b80fce6013f413ec1d77fc92457e14ac36052382a97d5de964dc06e63feeef0e455711c23c4989fd5b8d5b2156037f1711e489e0d

data/lib/applitools/connectivity/server_connector.rb

@@ -279,14 +279,11 @@ module Applitools::Connectivity
     end
 
     def start_session(session_start_info)
-      request_body = Oj.dump(
-        startInfo: Applitools::Utils.camelcase_hash_keys(session_start_info.to_hash)
-      )
+      request_body = session_start_info.json
       res = long_post(
         endpoint_url, body: request_body
       )
       raise Applitools::EyesError.new("Request failed: #{res.status} #{res.body} #{request_body}") unless res.success?
-
       response = Oj.load(res.body)
       Applitools::Session.new(response, res.status == HTTP_STATUS_CODES[:created])
     end

data/lib/applitools/core/abstract_configuration.rb

@@ -11,9 +11,11 @@ module Applitools
     def initialize
       @config_hash = {}
       self.validation_errors = {}
-      default_config = self.class.default_config
-      default_config.keys.each do |k|
-        send "#{k}=", default_config[k]
+      if self.class.respond_to? :default_config
+        default_config = self.class.default_config
+        default_config.keys.each do |k|
+          send "#{k}=", default_config[k] unless default_config[k].nil?
+        end
       end
     end
 

data/lib/applitools/core/accessibility_level.rb

@@ -3,12 +3,44 @@
 module Applitools
   module AccessibilityLevel
     extend self
-    NONE = 'None'
     AA = 'AA'
     AAA = 'AAA'
 
     def enum_values
-      [NONE, AA, AAA]
+      [AA, AAA]
+    end
+  end
+
+  module AccessibilityGuidelinesVersion
+    extend self
+    WCAG_2_1 = 'WCAG_2_1'
+    WCAG_2_0 = 'WCAG_2_0'
+    def enum_values
+      [WCAG_2_0, WCAG_2_1]
+    end
+  end
+
+  class AccessibilitySettings
+    attr_reader :config_hash
+    attr_accessor :validation_errors
+    extend Applitools::EyesConfigurationDSL
+
+    enum_field :level, Applitools::AccessibilityLevel.enum_values
+    enum_field :version, Applitools::AccessibilityGuidelinesVersion.enum_values
+
+    def initialize(accessibility_level, guidelines_version)
+      @config_hash = {}
+      self.validation_errors = []
+      self.level = accessibility_level
+      self.version = guidelines_version
+    end
+
+    def to_h
+      @config_hash
+    end
+
+    def json_data
+      to_h
     end
   end
 end

data/lib/applitools/core/accessibility_region_type.rb

@@ -4,7 +4,6 @@ module Applitools
   module AccessibilityRegionType
     extend self
 
-    NONE = 'None'
     IGNORE_CONTRAST = 'IgnoreContrast'
     REGULAR_TEXT = 'RegularText'
     LARGE_TEXT = 'LargeText'
@@ -13,7 +12,6 @@ module Applitools
 
     def enum_values
       [
-        NONE,
         IGNORE_CONTRAST,
         REGULAR_TEXT,
         LARGE_TEXT,

data/lib/applitools/core/app_environment.rb

@@ -12,16 +12,20 @@ module Applitools
       self.device_info = options[:device_info]
     end
 
-    def to_hash
+    def json_data
       {
-        'os' => os,
-        'hostingApp' => hosting_app,
-        'displaySize' => display_size && display_size.to_hash,
-        'inferred' => inferred_environment,
-        'deviceInfo' => device_info.nil? || device_info.empty? ? 'Desktop' : device_info + ' (Chrome emulation)'
+          'os' => os,
+          'hostingApp' => hosting_app,
+          'displaySize' => display_size && display_size.to_hash,
+          'inferred' => inferred_environment,
+          'deviceInfo' => device_info.nil? || device_info.empty? ? 'Desktop' : device_info
       }
     end
 
+    def to_hash
+      json_data
+    end
+
     def to_s
       result = ''
       to_hash.each_pair do |k, v|

data/lib/applitools/core/batch_info.rb

@@ -19,16 +19,20 @@ module Applitools
       self.id = SecureRandom.uuid unless id
     end
 
-    def to_hash
+    def json_data
       {
-        'id' => id,
-        'name' => name,
-        'startedAt' => @started_at.iso8601,
-        'batchSequenceName' => sequence_name,
-        'notifyOnCompletion' => 'true'.casecmp(notify_on_completion || '') == 0 ? true : false
+          'id' => id,
+          'name' => name,
+          'startedAt' => @started_at.iso8601,
+          'batchSequenceName' => sequence_name,
+          'notifyOnCompletion' => 'true'.casecmp(notify_on_completion || '') == 0 ? true : false
       }
     end
 
+    def to_hash
+      json_data
+    end
+
     def to_s
       to_hash.to_s
     end

data/lib/applitools/core/eyes_base.rb

@@ -87,7 +87,6 @@ module Applitools
       self.results = []
       self.allow_empty_screenshot = true
       @inferred_environment = nil
-      @properties = []
       @server_scale = 0
       @server_remainder = 0
       get_app_output_method = ->(r, s) { get_app_output_with_screenshot r, s }
@@ -151,10 +150,6 @@ module Applitools
       running_session && running_session.new_session?
     end
 
-    def add_property(name, value)
-      @properties << { name: name, value: value }
-    end
-
     def abort_if_not_closed
       if disabled?
         logger.info "#{__method__} Ignored"
@@ -319,11 +314,14 @@ module Applitools
 
       tag = '' if tag.nil?
 
-      session_start_info = SessionStartInfo.new agent_id: base_agent_id, app_id_or_name: app_name,
-         scenario_id_or_name: test_name, batch_info: batch,
-         env_name: baseline_env_name, environment: app_environment,
-         default_match_settings: default_match_settings.json_data,
-         branch_name: branch_name, parent_branch_name: parent_branch_name, properties: properties
+      self.session_start_info = SessionStartInfo.new agent_id: base_agent_id, app_id_or_name: app_name,
+                                                     scenario_id_or_name: test_name, batch_info: batch,
+                                                     baseline_env_name: baseline_env_name, environment: app_env,
+                                                     default_match_settings: default_match_settings,
+                                                     environment_name: environment_name, session_type: session_type,
+                                                     branch_name: branch_name, parent_branch_name: parent_branch_name,
+                                                     baseline_branch_name: baseline_branch_name, save_diffs: save_diffs,
+                                                     properties: properties
 
       match_window_data.start_info = session_start_info
       match_window_data.update_baseline_if_new = save_new_tests
@@ -481,7 +479,7 @@ module Applitools
     attr_accessor :running_session, :last_screenshot, :scale_provider, :session_start_info,
       :should_match_window_run_once_on_timeout, :app_output_provider, :failed
 
-    attr_reader :user_inputs, :properties
+    attr_reader :user_inputs
 
     private :full_agent_id, :full_agent_id=
 
@@ -596,9 +594,11 @@ module Applitools
 
       self.session_start_info = SessionStartInfo.new agent_id: base_agent_id, app_id_or_name: app_name,
                                                 scenario_id_or_name: test_name, batch_info: batch,
-                                                env_name: baseline_env_name, environment: app_env,
-                                                default_match_settings: default_match_settings.json_data,
+                                                baseline_env_name: baseline_env_name, environment: app_env,
+                                                default_match_settings: default_match_settings,
+                                                environment_name: environment_name, session_type: session_type,
                                                 branch_name: branch_name, parent_branch_name: parent_branch_name,
+                                                baseline_branch_name: baseline_branch_name, save_diffs: save_diffs,
                                                 properties: properties
 
       logger.info 'Starting server session...'

data/lib/applitools/core/eyes_base_configuration.rb

@@ -12,15 +12,17 @@ require 'applitools/core/image_match_settings'
 module Applitools
   class EyesBaseConfiguration < AbstractConfiguration
     DEFAULT_CONFIG = {
-      branch_name: ENV['APPLITOOLS_BRANCH'] || '',
-      parent_branch_name: ENV['APPLITOOLS_PARENT_BRANCH'] || '',
-      baseline_branch_name: ENV['APPLITOOLS_BASELINE_BRANCH'] || '',
+      branch_name: ENV['APPLITOOLS_BRANCH'],
+      parent_branch_name: ENV['APPLITOOLS_PARENT_BRANCH'],
+      baseline_branch_name: ENV['APPLITOOLS_BASELINE_BRANCH'],
       save_diffs: false,
       server_url: ENV['APPLITOOLS_SERVER_URL'] ||
         ENV['bamboo_APPLITOOLS_SERVER_URL'] || Applitools::Connectivity::ServerConnector::DEFAULT_SERVER_URL,
       api_key: ENV['APPLITOOLS_API_KEY'] || ENV['bamboo_APPLITOOLS_API_KEY'] || '',
       save_new_tests: true,
-      default_match_settings: Applitools::ImageMatchSettings.new
+      default_match_settings: Applitools::ImageMatchSettings.new,
+      accessibility_validation: nil,
+      properties: []
     }.freeze
 
     class << self
@@ -109,6 +111,8 @@ module Applitools
     int_field :scale
     int_field :remainder
     boolean_field :ignore_caret
+    object_field :accessibility_validation, Applitools::AccessibilitySettings, true
+    object_field :properties, Array
 
     methods_to_delegate.delete(:batch_info)
     methods_to_delegate.delete(:batch_info=)
@@ -161,6 +165,16 @@ module Applitools
       default_match_settings.ignore_caret = value
     end
 
+    def custom_setter_for_accessibility_validation(value)
+      # self.default_match_settings = self.parent.class.default_config[:default_match_settings] unless default_match_settings
+      default_match_settings.accessibility_validation = value
+    end
+
+    def add_property(name, value)
+      properties << { name: name, value: value } if name && value
+    end
+
     methods_to_delegate.push(:set_proxy)
+    methods_to_delegate.push(:add_property)
   end
 end

data/lib/applitools/core/eyes_configuration_dsl.rb

@@ -62,7 +62,7 @@ module Applitools
       end
     end
 
-    def object_field(field_name, klass)
+    def object_field(field_name, klass, allow_nil = false)
       collect_method field_name
       define_method(field_name) do
         return send("custom_getter_for_#{field_name}", config_hash[field_name.to_sym]) if
@@ -71,11 +71,11 @@ module Applitools
       end
       define_method("#{field_name}=") do |*args|
         value = args.shift
-        unless value.is_a? klass
+        unless value.is_a?(klass)
           raise(
             Applitools::EyesIllegalArgument,
             "Expected #{klass} but got #{value.class}"
-          )
+          ) unless allow_nil && value.nil?
         end
         config_hash[field_name.to_sym] = value
         config_hash[field_name.to_sym] = send("custom_setter_for_#{field_name}", config_hash[field_name.to_sym]) if
@@ -123,7 +123,7 @@ module Applitools
         unless available_values_array.include? value
           raise(
             Applitools::EyesIllegalArgument,
-            "Unknown #{field_name} #{value}. Allowed session types: " \
+            "Unknown #{field_name} #{value}. Allowed #{field_name} values: " \
            "#{available_values_array.join(', ')}"
           )
         end

data/lib/applitools/core/image_match_settings.rb

@@ -6,12 +6,12 @@ module Applitools
   class ImageMatchSettings
     include Applitools::Jsonable
     include Applitools::MatchLevelSetter
-    json_fields :accessibilityLevel, :MatchLevel, :IgnoreCaret, :IgnoreDisplacements, :Accessibility,
+    json_fields :accessibilitySettings, :MatchLevel, :IgnoreCaret, :IgnoreDisplacements, :Accessibility,
       :Ignore, :Floating, :Layout, :Strict, :Content, :Exact, :EnablePatterns, :UseDom,
       :SplitTopHeight, :SplitBottomHeight, :scale, :remainder
 
     def initialize
-      self.accessibility_level = 'None'
+      self.accessibility_settings = nil
       self.match_level = Applitools::MatchLevel::STRICT
       self.split_top_height = 0
       self.split_bottom_height = 0
@@ -49,6 +49,15 @@ module Applitools
       cloned_value
     end
 
+    def accessibility_validation
+      accessibility_settings
+    end
+
+    def accessibility_validation=(value)
+      raise Applitools::EyesIllegalArgument, "Expected value to be an Applitools::AccessibilitySettings instance but got #{value.class}" unless value.nil? || value.is_a?(Applitools::AccessibilitySettings)
+      self.accessibility_settings = value
+    end
+
     class Exact
       include Applitools::Jsonable
       json_fields :MinDiffIntensity, :MinDiffWidth, :MinDiffHeight, :MatchThreshold

data/lib/applitools/core/jsonable.rb

@@ -7,9 +7,10 @@ module Applitools
       base.extend ClassMethods
       base.class_eval do
         class << self
-          attr_accessor :json_methods
+          attr_accessor :json_methods, :wrap_data_block
         end
         @json_methods = {}
+        @wrap_data_block = nil
       end
     end
 
@@ -34,10 +35,20 @@ module Applitools
       def json_fields(*args)
         args.each { |m| json_field m }
       end
+
+      def wrap_data(&block)
+        @wrap_data_block = block
+      end
     end
 
     def json_data
-      self.class.json_methods.sort.map { |k, v| [k, json_value(send(v))] }.to_h
+      result = self.class.json_methods.sort.map do |k,v|
+        val = json_value(send(v))
+        next if val.nil?
+        [k, val]
+      end.compact.to_h
+      result = self.class.wrap_data_block.call(result) if self.class.wrap_data_block.is_a? Proc
+      result
     end
 
     def json

data/lib/applitools/core/session_start_info.rb

@@ -2,38 +2,36 @@
 
 module Applitools
   class SessionStartInfo
-    attr_accessor :app_id_or_name, :scenario_id_or_name
+    include Applitools::Jsonable
+    json_fields :batchInfo, :agentId, :appIdOrName, :verId, :environment, :environmentName, :branchName, :defaultMatchSettings,
+      :scenarioIdOrName, :properties, :parentBranchName, :compareWithParentBranch, :baselineEnvName, :saveDiffs, :sessionType,
+      :baselineBranchName
+
+    wrap_data do |value|
+      { startInfo: value }
+    end
 
     def initialize(options = {})
-      @agent_id = options[:agent_id]
-      @app_id_or_name = options[:app_id_or_name]
-      @ver_id = options[:ver_id]
-      @scenario_id_or_name = options[:scenario_id_or_name]
-      @batch_info = options[:batch_info]
-      @env_name = options[:env_name]
-      @environment = options[:environment]
-      @default_match_settings = options[:default_match_settings]
-      @branch_name = options[:branch_name]
-      @parent_branch_name = options[:parent_branch_name]
-      @properties = options[:properties]
-      @compare_with_parent_branch = options[:compare_with_parent_branch]
+      self.agent_id = options[:agent_id]
+      self.app_id_or_name = options[:app_id_or_name]
+      self.ver_id = options[:ver_id]
+      self.scenario_id_or_name = options[:scenario_id_or_name]
+      self.batch_info = options[:batch_info]
+      self.environment_name = options[:environment_name]
+      self.baseline_env_name = options[:baseline_env_name]
+      self.environment = options[:environment]
+      self.default_match_settings = options[:default_match_settings]
+      self.branch_name = options[:branch_name]
+      self.parent_branch_name = options[:parent_branch_name]
+      self.properties = options[:properties]
+      self.compare_with_parent_branch = options[:compare_with_parent_branch]
+      self.save_diffs = options[:save_diffs]
+      self.session_type = options[:session_type]
+      self.baseline_branch_name = options[:baseline_branch_name]
     end
 
     def to_hash
-      {
-        agent_id: @agent_id,
-        app_id_or_name: @app_id_or_name,
-        ver_id: @ver_id,
-        scenario_id_or_name: @scenario_id_or_name,
-        batch_info: @batch_info && @batch_info.to_hash,
-        env_name: @env_name,
-        environment: @environment.to_hash,
-        default_match_settings: @default_match_settings,
-        branch_name: @branch_name,
-        parent_branch_name: @parent_branch_name,
-        compare_with_parent_branch: @compare_with_parent_branch,
-        properties: @properties
-      }
+      json_data
     end
   end
 end

data/lib/applitools/core/test_results.rb

@@ -4,6 +4,18 @@ require 'yaml'
 
 module Applitools
   class TestResults
+    class AccessibilityStatus
+      attr_accessor :status, :level, :version
+      def initialize(hash = {})
+        self.status = hash['status']
+        self.level = hash['level']
+        self.version = hash['version']
+      end
+
+      def failed?
+        status.downcase == 'Failed'.downcase
+      end
+    end
     attr_accessor :is_new, :url, :screenshot
     attr_reader :status, :steps, :matches, :mismatches, :missing, :original_results
 
@@ -50,6 +62,14 @@ module Applitools
       original_results['secretToken']
     end
 
+    def name
+      original_results['name']
+    end
+
+    def session_accessibility_status
+      @accessibility_status ||= original_results['accessibilityStatus'] && AccessibilityStatus.new(original_results['accessibilityStatus'] || {})
+    end
+
     def ==(other)
       if other.is_a? self.class
         result = true

data/lib/applitools/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: false
 
 module Applitools
-  VERSION = '3.16.16'.freeze
+  VERSION = '3.17.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_core
 version: !ruby/object:Gem::Version
-  version: 3.16.16
+  version: 3.17.4
 platform: ruby
 authors:
 - Applitools Team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oily_png
@@ -370,7 +370,7 @@ licenses:
 - Applitools
 metadata:
   yard.run: yri
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -387,7 +387,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.8
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Core of the Applitools Ruby SDK
 test_files: []