eyes_core 3.10.1 → 3.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69da25c3d4e67d9f44a708e6b0c0da5382374285
-  data.tar.gz: 45358e7a6182c7185b00cfeda8034423fcce5178
+  metadata.gz: b5809ea0c1a4fce9a7233b53c2f93b811cd45e24
+  data.tar.gz: 7297d6577eb1d687fe9fd08954a9accbbd7273b1
 SHA512:
-  metadata.gz: 00ace03b98a2b76511a79bba56c9fe0c2299f80e935c46fbaeeb368a87b4059394f1881b25d38236ff905e13259305e1ddd849c83082c8c9186d65771da2e2b0
-  data.tar.gz: a328ecd8c09fb95c31ee1d3833ab9d6456f56caf3f8df484083104a65ee9e8473c68fefe148d7493cf466205896affae4ff44cb50d0e6dd64c0bb7919f5e84a5
+  metadata.gz: 224885021816ed5b60ba60c5e07a9469c3e991f1fb10a789935fce33b7119d2605202ea751b23da8bf3291f088e82b0ce71e461736610854b2a7ed03fb53f48a
+  data.tar.gz: 7257faf0af15b39d3d90a0708ee001f2f7aa55ffa9b4134745633af0b342bb56898316494b03da7547278431bcb5c4a6061ced8456475485de093d8ec0445d0a

data/lib/applitools/connectivity/server_connector.rb

@@ -100,8 +100,11 @@ module Applitools::Connectivity
     end
 
     def start_session(session_start_info)
-      res = post(endpoint_url, body: Oj.dump(startInfo:
-                                                 Applitools::Utils.camelcase_hash_keys(session_start_info.to_hash)))
+      res = post(
+        endpoint_url, body: Oj.dump(
+          startInfo:  Applitools::Utils.camelcase_hash_keys(session_start_info.to_hash)
+        )
+      )
       raise Applitools::EyesError.new("Request failed: #{res.status} #{res.body}") unless res.success?
 
       response = Oj.load(res.body)
@@ -167,29 +170,41 @@ module Applitools::Connectivity
     def long_request(url, method, request_delay, options = {})
       delay = request_delay
       options = { headers: {
-        'Eyes-Expect' => '202+location',
-        'Eyes-Date' => Time.now.utc.strftime('%a, %d %b %Y %H:%M:%S GMT')
-      } }.merge! options
+        'Eyes-Expect' => '202+location'
+      }.merge(eyes_date_header) }.merge! options
       res = request(url, method, options)
-      return res if res.status == HTTP_STATUS_CODES[:ok]
+      check_status(res, delay)
+    end
 
-      if res.status == HTTP_STATUS_CODES[:accepted]
+    def eyes_date_header
+      { 'Eyes-Date' => Time.now.utc.strftime('%a, %d %b %Y %H:%M:%S GMT') }
+    end
+
+    def check_status(res, delay)
+      case res.status
+      when HTTP_STATUS_CODES[:ok]
+        res
+      when HTTP_STATUS_CODES[:accepted]
         second_step_url = res.headers[:location]
-        delay = [MAX_LONG_REQUEST_DELAY, (delay * LONG_REQUEST_DELAY_MULTIPLICATIVE_INCREASE_FACTOR).round].min
         loop do
+          delay = [MAX_LONG_REQUEST_DELAY, (delay * LONG_REQUEST_DELAY_MULTIPLICATIVE_INCREASE_FACTOR).round].min
           Applitools::EyesLogger.debug "Still running... retrying in #{delay}s"
           sleep delay
-          second_step_options = { headers: {
-              'Eyes-Date' => Time.now.utc.strftime('%a, %d %b %Y %H:%M:%S GMT')
-          } }
+          second_step_options = {
+            headers: {}.merge(eyes_date_header)
+          }
           res = request(second_step_url, :get, second_step_options)
           break unless res.status == HTTP_STATUS_CODES[:ok]
         end
+        check_status(res, delay)
+      when HTTP_STATUS_CODES[:created]
+        last_step_url = res.headers[:location]
+        request(last_step_url, :delete, headers: eyes_date_header)
+      when HTTP_STATUS_CODES[:gone]
+        raise Applitools::EyesError.new('The server task has gone.')
+      else
+        raise Applitools::EyesError.new('Unknown error processing long request')
       end
-
-      raise Applitools::EyesError.new('The server task has gone.') if res.status == HTTP_STATUS_CODES[:gone]
-      return request(second_step_url, :delete) if res.status == HTTP_STATUS_CODES[:created]
-      raise Applitools::EyesError.new('Unknown error processing long request')
     end
   end
 end

data/lib/applitools/core/eyes_base.rb

@@ -1,5 +1,6 @@
 require 'applitools/core/helpers'
 require 'applitools/core/eyes_screenshot'
+require_relative 'match_level_setter'
 
 module Applitools
   MATCH_LEVEL = {
@@ -12,6 +13,7 @@ module Applitools
   }.freeze
 
   class EyesBase
+    include Applitools::MatchLevelSetter
     extend Forwardable
     extend Applitools::Helpers
 
@@ -33,7 +35,7 @@ module Applitools
     attr_accessor :app_name, :baseline_name, :branch_name, :parent_branch_name, :batch, :agent_id, :full_agent_id,
       :match_timeout, :save_new_tests, :save_failed_tests, :failure_reports, :default_match_settings, :cut_provider,
       :scale_ratio, :host_os, :host_app, :base_line_name, :position_provider, :viewport_size, :verbose_results,
-      :inferred_environment, :remove_session_if_matching
+      :inferred_environment, :remove_session_if_matching, :server_scale, :server_remainder, :match_level, :exact
 
     abstract_attr_accessor :base_agent_id
     abstract_method :capture_screenshot, true
@@ -68,14 +70,52 @@ module Applitools
         end
       end
 
+      self.exact = nil
+      self.match_level = Applitools::MATCH_LEVEL[:strict]
+      self.server_scale = 0
+      self.server_remainder = 0
+
       @default_match_settings = {
-        match_level: Applitools::MATCH_LEVEL[:strict],
-        exact: nil,
+        match_level: match_level,
+        exact: exact,
         scale: server_scale,
         remainder: server_remainder
       }
     end
 
+    # Sets default match_level which will be applied to any test, unless match_level is set for a test explicitly
+    # @param [Symbol] value Can be one of allowed match levels - :none, :layout, :layout2, :content, :strict or :exact
+    # @param [Hash] exact_options exact options are used only for :exact match level
+    # @option exact_options [Integer] :min_diff_intensity
+    # @option exact_options [Integer] :min_diff_width
+    # @option exact_options [Integer] :min_diff_height
+    # @option exact_options [Integer] :match_threshold
+    # @return [Target] Applitools::Selenium::Target or Applitools::Images::target
+
+    def default_match_level(value, exact_options = {})
+      @match_level, self.exact = match_level_with_exact(value, exact_options)
+    end
+
+    # rubocop:disable LineLength
+    # Sets default match settings
+    # @param [Hash] value
+    # @option value [Symbol] match_level
+    # @option value [Hash] exact exact values. Available keys are 'MinDiffIntensity', 'MinDiffWidth', 'MinDiffHeight', 'MatchThreshold'
+    # @option value [Fixnum] scale
+    # @option value [Fixnum] remainder
+    # rubocop:enable LineLength
+
+    def default_match_settings=(value)
+      Applitools::ArgumentGuard.is_a? value, 'value', Hash
+      extra_keys = value.keys - match_level_keys
+      unless extra_keys.empty?
+        raise Applitools::EyesIllegalArgument.new(
+          "Pasiing extra keys is prohibited! Passed extra keys: #{extra_keys}"
+        )
+      end
+      default_match_settings.merge! value
+    end
+
     def batch
       if @batch.nil?
         logger.info 'No batch set'
@@ -92,28 +132,6 @@ module Applitools
       end
     end
 
-    def match_level=(level)
-      @default_match_settings[:match_level] = level
-    end
-
-    def match_level
-      @default_match_settings[:match_level]
-    end
-
-    def server_scale=(ratio)
-      @server_scale = ratio
-      @default_match_settings[:scale] = ratio
-    end
-
-    attr_reader :server_scale
-
-    def server_remainder=(ratio)
-      @server_remainder = ratio
-      @default_match_settings[:remainder] = ratio
-    end
-
-    attr_reader :server_remainder
-
     def disabled=(value)
       @disabled = Applitools::Utils.boolean_value value
     end
@@ -137,7 +155,7 @@ module Applitools
     def abort_if_not_closed
       if disabled?
         logger.info "#{__method__} Ignored"
-        return
+        return false
       end
 
       self.open = false
@@ -146,7 +164,7 @@ module Applitools
 
       if running_session.nil?
         logger.info 'Closed'
-        return
+        return false
       end
 
       logger.info 'Aborting server session...'
@@ -154,7 +172,7 @@ module Applitools
       logger.info '---Test aborted'
 
     rescue Applitools::EyesError => e
-      logger.error e.messages
+      logger.error e.message
 
     ensure
       self.running_session = nil
@@ -163,7 +181,7 @@ module Applitools
     def open_base(options)
       if disabled?
         logger.info "#{__method__} Ignored"
-        return
+        return false
       end
 
       Applitools::ArgumentGuard.hash options, 'open_base parameter', [:test_name]
@@ -230,6 +248,8 @@ module Applitools
         )
       end
 
+      match_window_data.user_inputs = user_inputs
+
       logger.info 'Calling match_window...'
       result = @match_window_task.match_window(
         match_window_data,
@@ -349,7 +369,7 @@ module Applitools
     def close(throw_exception = true)
       if disabled?
         logger.info "#{__method__} Ignored"
-        return
+        return false
       end
 
       logger.info "close(#{throw_exception})"
@@ -416,6 +436,16 @@ module Applitools
 
     private :full_agent_id, :full_agent_id=
 
+    def match_level_keys
+      %w(match_level exact scale remainder).map(&:to_sym)
+    end
+
+    def update_default_settings(match_data)
+      match_level_keys.each do |k|
+        match_data.send("#{k}=", default_match_settings[k])
+      end
+    end
+
     def app_environment
       Applitools::AppEnvironment.new os: host_os, hosting_app: host_app,
           display_size: @viewport_size, inferred: inferred_environment

data/lib/applitools/core/fixed_cut_provider.rb

@@ -11,6 +11,8 @@ module Applitools
     #   Applitools::FixedCutProvider.new Applitools::Region.new(20,20, 300, 300)
     # @example Creates cut provider by a set of fields
     #   Applitools::FixedCutProvider.new 20, 20, 300, 300
+    # @!parse def initialize(crop_region, header, left, right, footer); end
+
     def initialize(*args)
       self.region = nil
       self.left = 0

data/lib/applitools/core/floating_region.rb

@@ -2,11 +2,20 @@ require_relative 'region'
 module Applitools
   class FloatingRegion < Region
     class << self
+      def any(element, max_left_offset, max_top_offset, max_right_offset, max_bottom_offset)
+        case element
+        when Applitools::Selenium::Element, ::Selenium::WebDriver::Element, Applitools::Region
+          for_element(element, max_left_offset, max_top_offset, max_right_offset, max_bottom_offset)
+        else
+          raise Applitools::EyesIllegalArgument.new "Unsupported element - #{element.class}"
+        end
+      end
+
       def for_element(element, max_left_offset, max_top_offset, max_right_offset, max_bottom_offset)
-        Applitools::ArgumentGuard.is_a? element, 'element', Applitools::Selenium::Element
         new element.location.x, element.location.y, element.size.width, element.size.height, max_left_offset,
           max_top_offset, max_right_offset, max_bottom_offset
       end
+      private :for_element
     end
 
     attr_accessor :max_top_offset, :max_right_offset, :max_bottom_offset, :max_left_offset

data/lib/applitools/core/fluent_interface.rb

@@ -1,4 +1,6 @@
+require_relative 'match_level_setter'
 module Applitools::FluentInterface
+  include Applitools::MatchLevelSetter
   def ignore_caret(value = false)
     options[:ignore_caret] = value ? true : false
     self
@@ -19,9 +21,17 @@ module Applitools::FluentInterface
     self
   end
 
-  def match_level(value)
-    raise Applitools::EyesError unless Applitools::MATCH_LEVEL.keys.include? value
-    options[:match_level] = Applitools::MATCH_LEVEL[value]
+  # Sets match_level for current test
+  # @param [Symbol] value Can be one of allowed match levels - :none, :layout, :layout2, :content, :strict or :exact
+  # @param [Hash] exact_options exact options are used only for :exact match level
+  # @option exact_options [Integer] :min_diff_intensity
+  # @option exact_options [Integer] :min_diff_width
+  # @option exact_options [Integer] :min_diff_height
+  # @option exact_options [Integer] :match_threshold
+  # @return [Target] Applitools::Selenium::Target or Applitools::Images::target
+
+  def match_level(value, exact_options = {})
+    options[:match_level], options[:exact] = match_level_with_exact(value, exact_options)
     self
   end
 end

data/lib/applitools/core/match_level_setter.rb

@@ -0,0 +1,45 @@
+module Applitools::MatchLevelSetter
+  def match_level_with_exact(value, exact_options = {})
+    raise Applitools::EyesError unless Applitools::MATCH_LEVEL.keys.include? value
+    if value != :exact && (exact_options && !exact_options.empty?)
+      raise Applitools::EyesError.new(
+        'Exact options are accepted only for EXACT match level'
+      )
+    end
+    [Applitools::MATCH_LEVEL[value], value == :exact ? convert_exact_options(exact_options) : nil]
+  end
+
+  private
+
+  EXACT_KEYS = {
+    :min_diff_intensity => 'MinDiffIntensity',
+    :min_diff_width => 'MinDiffWidth',
+    :min_diff_height => 'MinDiffHeight',
+    :match_threshold => 'MatchThreshold',
+    'MinDiffIntensity' => 'MinDiffIntensity',
+    'MinDiffWidth' => 'MinDiffWidth',
+    'MinDiffHeight' => 'MinDiffHeight',
+    'MatchThreshold' => 'MatchThreshold'
+  }.freeze
+
+  def convert_exact_options(options)
+    allowed_keys = EXACT_KEYS.keys
+    extra_keys = options.keys - allowed_keys
+    result = {
+      'MinDiffIntensity' => 0,
+      'MinDiffWidth' => 0,
+      'MinDiffHeight' => 0,
+      'MatchThreshold' => 0
+    }
+    unless extra_keys.empty?
+      raise Applitools::EyesIllegalArgument.new(
+        "Extra exact keys passed - [#{extra_keys.join(', ')}]"
+      )
+    end
+
+    allowed_keys.each do |k|
+      result[EXACT_KEYS[k]] = options[k] unless options[k].nil?
+    end
+    result
+  end
+end

data/lib/applitools/core/match_window_data.rb

@@ -89,9 +89,8 @@ module Applitools
 
     def user_inputs=(value)
       Applitools::ArgumentGuard.is_a? value, 'value', Array
-      value.each do |i|
-        current_data['UserInputs'] << i if self.class.valid_input(i)
-      end
+      current_data['UserInputs'] += value.select { |i| i.respond_to? :to_hash }
+                                         .select { |i| self.class.valid_input(i) }.map(&:to_hash)
       current_data['Options']['UserInputs'] = current_data['UserInputs']
     end
 
@@ -142,6 +141,20 @@ module Applitools
       current_data['Options']['ImageMatchSettings']['remainder']
     end
 
+    def exact
+      current_data['Options']['ImageMatchSettings']['Exact']
+    end
+
+    def exact=(value)
+      raise Applitools::EyesError.new('You should pass a hash as a value!') unless value.nil? || value.is_a?(Hash)
+      return current_data['Options']['ImageMatchSettings']['Exact'] = nil if value.nil?
+      current_value = exact || {}
+      %w(MinDiffIntensity MinDiffWidth MinDiffHeight MatchThreshold).each do |k|
+        current_value[k] = value[k]
+      end
+      current_data['Options']['ImageMatchSettings']['Exact'] = current_value
+    end
+
     def read_target(target, driver)
       # options
       target_options_to_read.each do |field|
@@ -181,7 +194,7 @@ module Applitools
     end
 
     def target_options_to_read
-      %w(trim ignore_caret match_level ignore_mismatch)
+      %w(trim ignore_caret match_level ignore_mismatch exact)
     end
 
     private :target_options_to_read

data/lib/applitools/core/region_provider.rb

@@ -6,5 +6,9 @@ module Applitools
       @region = region
       @coordinate_type = coordinate_type
     end
+
+    def to_s
+      "Applitools::RegionProvider(#{region}, #{coordinate_type})"
+    end
   end
 end

data/lib/applitools/utils/utils.rb

@@ -16,6 +16,11 @@ module Applitools::Utils
     uncapitalize(tokens.shift) + tokens.map(&:capitalize).join
   end
 
+  def to_method_name(str)
+    str = str.to_s if !str.is_a?(String) && str.respond_to?(:to_s)
+    underscore(str).gsub(%r{\/}, '__')
+  end
+
   def wrap(object)
     if object.nil?
       []

data/lib/applitools/version.rb

@@ -1,3 +1,3 @@
 module Applitools
-  VERSION = '3.10.1'.freeze
+  VERSION = '3.10.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_core
 version: !ruby/object:Gem::Version
-  version: 3.10.1
+  version: 3.10.2
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-02 00:00:00.000000000 Z
+date: 2017-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oily_png
@@ -222,6 +222,7 @@ files:
 - lib/applitools/core/hash_extension.rb
 - lib/applitools/core/helpers.rb
 - lib/applitools/core/location.rb
+- lib/applitools/core/match_level_setter.rb
 - lib/applitools/core/match_result.rb
 - lib/applitools/core/match_results.rb
 - lib/applitools/core/match_single_check_data.rb
@@ -271,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Applitools Ruby SDK