eyes_selenium 2.31.0 → 2.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57e3ec595f0c7d68c32885999d4fe662de97f90b
-  data.tar.gz: b2c665c860fc5356572ab4150b955bb237b12d0a
+  metadata.gz: dc57b143e0d3877d92cf53f89e53f58ea521db39
+  data.tar.gz: 450452fc879ddc89f77e7089a0d8623b1f8bc81d
 SHA512:
-  metadata.gz: a5b40fb1f539daca644a7bda37991908b6563ab1c888a2b63b7efc279b06eaab106e603efdcac46c63faaf58e75a11f2b751de7de6bede377127560562156b1e
-  data.tar.gz: bf67f4c46ad8ad8d04612d4a99b2cfb01662085d9302ecfffd57742ff583939f0758961f66be5f4ab2addb099b08abfd7738da59db0a36f5bb44790cff801449
+  metadata.gz: d77c9ab86b00cb68b722358807c620517fbcfecb62fc102967ea6faafd9723704b19c2212c4f005e27bb965d7217059a05254d68f7cc7daef21676ac761515ab
+  data.tar.gz: 33e5a22b2d4bff707f18e19cda2b4949b4aee9c154c90148887cb2b8918ec1659e6d5b8c9da9db9832ef7dd24183a45870659151a7c6a2c100b57c1964d69389

data/lib/applitools/base/dimension.rb

@@ -1,12 +1,5 @@
 module Applitools::Base
-  class Dimension
-    attr_accessor :width, :height
-
-    def initialize(width, height)
-      @width = width
-      @height = height
-    end
-
+  Dimension = Struct.new(:width, :height) do
     def to_hash
       {
         width: width,
@@ -17,5 +10,27 @@ module Applitools::Base
     def values
       [width, height]
     end
+
+    def -(other)
+      self.width -= other.width
+      self.height -= other.height
+      self
+    end
+
+    def +(other)
+      self.width += other.width
+      self.height += other.height
+      self
+    end
+
+    def to_s
+      values.to_s
+    end
+
+    class << self
+      def for(other)
+        new(other.width, other.height)
+      end
+    end
   end
 end

data/lib/applitools/base/point.rb

@@ -17,12 +17,12 @@ module Applitools::Base
       @x == other.x && @y == other.y
     end
 
+    alias eql? ==
+
     def hash
       @x.hash & @y.hash
     end
 
-    alias_method :eql?, :==
-
     def to_hash(options = {})
       options[:region] ? { left: left, top: top } : { x: x, y: y }
     end

data/lib/applitools/base/server_connector.rb

@@ -11,9 +11,9 @@ module Applitools::Base::ServerConnector
   DEFAULT_SERVER_URL = 'https://eyessdk.applitools.com'.freeze
 
   SSL_CERT = File.join(File.dirname(File.expand_path(__FILE__)), '../../../certs/cacert.pem').to_s.freeze
-  DEFAULT_TIMEOUT = 300.freeze
+  DEFAULT_TIMEOUT = 300
 
-  API_SESSIONS_RUNNING =  '/api/sessions/running/'.freeze
+  API_SESSIONS_RUNNING = '/api/sessions/running/'.freeze
 
   HTTP_STATUS_CODES = {
     created: 201,
@@ -40,7 +40,6 @@ module Applitools::Base::ServerConnector
     # Notice that this does not include the screenshot.
     json_data = Oj.dump(Applitools::Utils.camelcase_hash_keys(data.to_hash)).force_encoding('BINARY')
     body = [json_data.length].pack('L>') + json_data + data.screenshot
-
     Applitools::EyesLogger.debug 'Sending match data...'
 
     res = post(URI.join(endpoint_url, session.id.to_s), content_type: 'application/octet-stream', body: body)
@@ -75,9 +74,9 @@ module Applitools::Base::ServerConnector
     'Content-Type' => 'application/json'
   }.freeze
 
-  LONG_REQUEST_DELAY = 2.freeze # seconds
-  MAX_LONG_REQUEST_DELAY = 10.freeze # seconds
-  LONG_REQUEST_DELAY_MULTIPLICATIVE_INCREASE_FACTOR = 1.5.freeze
+  LONG_REQUEST_DELAY = 2 # seconds
+  MAX_LONG_REQUEST_DELAY = 10 # seconds
+  LONG_REQUEST_DELAY_MULTIPLICATIVE_INCREASE_FACTOR = 1.5
 
   [:get, :post, :delete].each do |method|
     define_method method do |url, options = {}|
@@ -91,7 +90,7 @@ module Applitools::Base::ServerConnector
 
   def request(url, method, options = {})
     Faraday::Connection.new(url, ssl: { ca_file: SSL_CERT }, proxy: @proxy || nil).send(method) do |req|
-      req.options.timeout  = DEFAULT_TIMEOUT
+      req.options.timeout = DEFAULT_TIMEOUT
       req.headers = DEFAULT_HEADERS.merge(options[:headers] || {})
       req.headers['Content-Type'] = options[:content_type] if options.key?(:content_type)
       req.params = { apiKey: api_key }.merge(options[:query] || {})

data/lib/applitools/base/test_results.rb

@@ -6,8 +6,8 @@ module Applitools::Base
     def initialize(results = {})
       @steps = results.fetch('steps', 0)
       @matches = results.fetch('matches', 0)
-      @mismatches =  results.fetch('mismatches', 0)
-      @missing =  results.fetch('missing', 0)
+      @mismatches = results.fetch('mismatches', 0)
+      @missing = results.fetch('missing', 0)
       @is_new = nil
       @url = nil
     end
@@ -15,7 +15,7 @@ module Applitools::Base
     def passed?
       !is_new && !(mismatches > 0) && !(missing > 0)
     end
-    alias_method :is_passed, :passed?
+    alias is_passed passed?
 
     def to_s
       is_new_str = ''

data/lib/applitools/eyes.rb

@@ -20,9 +20,9 @@ class Applitools::Eyes
     exact: 'Exact'
   }.freeze
 
-  DEFAULT_MATCH_TIMEOUT = 2.0.freeze # Seconds
+  DEFAULT_MATCH_TIMEOUT = 2.0 # Seconds
   # noinspection RubyConstantNamingConvention
-  DEFAULT_WAIT_BEFORE_SCREENSHOTS = 0.1.freeze # Seconds
+  DEFAULT_WAIT_BEFORE_SCREENSHOTS = 0.1 # Seconds
   BASE_AGENT_ID = ('eyes.selenium.ruby/' + Applitools::VERSION).freeze
 
   ANDROID = 'Android'.freeze
@@ -74,9 +74,9 @@ class Applitools::Eyes
   #   the default value.
   attr_reader :app_name, :test_name, :is_open, :viewport_size, :driver
   attr_accessor :match_timeout, :batch, :host_os, :host_app, :branch_name, :parent_branch_name, :user_inputs,
-                :save_new_tests, :save_failed_tests, :is_disabled, :server_url, :agent_id, :failure_reports,
-                :match_level, :baseline_name, :rotation, :force_fullpage_screenshot, :hide_scrollbars,
-                :use_css_transition, :scale_ratio, :wait_before_screenshots
+    :save_new_tests, :save_failed_tests, :is_disabled, :server_url, :agent_id, :failure_reports,
+    :match_level, :baseline_name, :rotation, :force_fullpage_screenshot, :hide_scrollbars,
+    :use_css_transition, :scale_ratio, :wait_before_screenshots
 
   def_delegators 'Applitools::EyesLogger', :log_handler, :log_handler=
   def_delegators 'Applitools::Base::ServerConnector', :api_key, :api_key=, :server_url, :server_url=, :set_proxy
@@ -143,6 +143,8 @@ class Applitools::Eyes
     else
       unless driver.is_a?(Applitools::Selenium::Driver)
         Applitools::EyesLogger.warn("Unrecognized driver type: (#{driver.class.name})!")
+        is_mobile_device = driver.respond_to?(:capabilities) && driver.capabilities['platformName']
+        @driver = Applitools::Selenium::Driver.new(self, driver: driver, is_mobile_device: is_mobile_device)
       end
     end
 

data/lib/applitools/selenium/browser.rb

@@ -1,14 +1,14 @@
 module Applitools::Selenium
   class Browser
-    JS_GET_USER_AGENT = (<<-JS).freeze
+    JS_GET_USER_AGENT = <<-JS.freeze
       return navigator.userAgent;
     JS
 
-    JS_GET_DEVICE_PIXEL_RATIO = (<<-JS).freeze
+    JS_GET_DEVICE_PIXEL_RATIO = <<-JS.freeze
       return window.devicePixelRatio;
     JS
 
-    JS_GET_PAGE_METRICS = (<<-JS).freeze
+    JS_GET_PAGE_METRICS = <<-JS.freeze
       return {
         scrollWidth: document.documentElement.scrollWidth,
         bodyScrollWidth: document.body.scrollWidth,
@@ -19,7 +19,7 @@ module Applitools::Selenium
       };
     JS
 
-    JS_GET_CURRENT_SCROLL_POSITION = (<<-JS).freeze
+    JS_GET_CURRENT_SCROLL_POSITION = <<-JS.freeze
       return (function() {
         var doc = document.documentElement;
         var x = (window.scrollX || window.pageXOffset || doc.scrollLeft) - (doc.clientLeft || 0);
@@ -29,15 +29,15 @@ module Applitools::Selenium
       }());
     JS
 
-    JS_SCROLL_TO = (<<-JS).freeze
+    JS_SCROLL_TO = <<-JS.freeze
       window.scrollTo(%{left}, %{top});
     JS
 
-    JS_GET_CURRENT_TRANSFORM = (<<-JS).freeze
+    JS_GET_CURRENT_TRANSFORM = <<-JS.freeze
       return document.body.style.transform;
     JS
 
-    JS_SET_TRANSFORM = (<<-JS).freeze
+    JS_SET_TRANSFORM = <<-JS.freeze
       return (function() {
         var originalTransform = document.body.style.transform;
         document.body.style.transform = '%{transform}';
@@ -45,7 +45,7 @@ module Applitools::Selenium
       }());
     JS
 
-    JS_SET_OVERFLOW = (<<-JS).freeze
+    JS_SET_OVERFLOW = <<-JS.freeze
       return (function() {
         var origOF = document.documentElement.style.overflow;
         document.documentElement.style.overflow = '%{overflow}';
@@ -53,9 +53,9 @@ module Applitools::Selenium
       }());
     JS
 
-    EPSILON_WIDTH = 12.freeze
-    MIN_SCREENSHOT_PART_HEIGHT = 10.freeze
-    MAX_SCROLLBAR_SIZE = 50.freeze
+    EPSILON_WIDTH = 12
+    MIN_SCREENSHOT_PART_HEIGHT = 10
+    MAX_SCROLLBAR_SIZE = 50
     OVERFLOW_HIDDEN = 'hidden'.freeze
 
     def initialize(driver, eyes)

data/lib/applitools/selenium/driver.rb

@@ -8,7 +8,7 @@ module Applitools::Selenium
 
     include Selenium::WebDriver::DriverExtensions::HasInputDevices
 
-    RIGHT_ANGLE = 90.freeze
+    RIGHT_ANGLE = 90
     IOS = 'IOS'.freeze
     ANDROID = 'ANDROID'.freeze
     LANDSCAPE = 'LANDSCAPE'.freeze
@@ -40,10 +40,7 @@ module Applitools::Selenium
       @wait_before_screenshots = 0
       @eyes = eyes
       @browser = Applitools::Selenium::Browser.new(self, @eyes)
-
-      unless capabilities.takes_screenshot?
-        Applitools::EyesLogger.warn '"takes_screenshot" capability not found.'
-      end
+      Applitools::EyesLogger.warn '"takes_screenshot" capability not found.' unless driver.respond_to? :screenshot_as
     end
 
     # Returns:
@@ -81,32 +78,22 @@ module Applitools::Selenium
     end
 
     ## Set the overflow value for document element and return the original overflow value.
-    def set_overflow(overflow)
+    def overflow=(overflow)
       @browser.set_overflow(overflow)
     end
 
-    # Return a PNG screenshot in the given format as a string
+    alias set_overflow overflow=
+
+    # Return a normalized screenshot.
     #
-    # +output_type+:: +Symbol+ The format of the screenshot. Accepted values are +:base64+ and +:png+.
     # +rotation+:: +Integer+|+nil+ The degrees by which to rotate the image: positive values = clockwise rotation,
     #   negative values = counter-clockwise, 0 = force no rotation, +nil+ = rotate automatically when needed.
     #
-    # Returns: +String+ A screenshot in the requested format.
-    def screenshot_as(output_type, rotation = nil)
+    # Returns: +ChunkPng::Image+ A screenshot object, normalized by scale and rotation.
+    def get_screenshot(rotation = nil)
       image = mobile_device? || !@eyes.force_fullpage_screenshot ? visible_screenshot : @browser.fullpage_screenshot
-
       Applitools::Selenium::Driver.normalize_image(self, image, rotation)
-
-      case output_type
-      when :base64
-        image = Applitools::Utils::ImageUtils.base64_from_png_image(image)
-      when :png
-        image = Applitools::Utils::ImageUtils.bytes_from_png_image(image)
-      else
-        raise Applitools::EyesError.new("Unsupported screenshot output type: #{output_type}")
-      end
-
-      image.force_encoding('BINARY')
+      image
     end
 
     def visible_screenshot
@@ -173,41 +160,43 @@ module Applitools::Selenium
       end
     end
 
-    def self.normalize_image(driver, image, rotation)
-      normalize_rotation(driver, image, rotation)
-      normalize_width(driver, image)
-    end
-
-    # Rotates the image as necessary. The rotation is either manually forced by passing a value in
-    # the +rotation+ parameter, or automatically inferred if the +rotation+ parameter is +nil+.
-    #
-    # +driver+:: +Applitools::Selenium::Driver+ The driver which produced the screenshot.
-    # +image+:: +ChunkyPNG::Canvas+ The image to normalize.
-    # +rotation+:: +Integer+|+nil+ The degrees by which to rotate the image: positive values = clockwise rotation,
-    #   negative values = counter-clockwise, 0 = force no rotation, +nil+ = rotate automatically when needed.
-    def self.normalize_rotation(driver, image, rotation)
-      return if rotation == 0
+    class << self
+      def normalize_image(driver, image, rotation)
+        normalize_rotation(driver, image, rotation)
+        normalize_width(driver, image)
+      end
 
-      num_quadrants = 0
-      if !rotation.nil?
-        if rotation % RIGHT_ANGLE != 0
-          raise Applitools::EyesError.new('Currently only quadrant rotations are supported. Current rotation: '\
+      # Rotates the image as necessary. The rotation is either manually forced by passing a value in
+      # the +rotation+ parameter, or automatically inferred if the +rotation+ parameter is +nil+.
+      #
+      # +driver+:: +Applitools::Selenium::Driver+ The driver which produced the screenshot.
+      # +image+:: +ChunkyPNG::Canvas+ The image to normalize.
+      # +rotation+:: +Integer+|+nil+ The degrees by which to rotate the image: positive values = clockwise rotation,
+      #   negative values = counter-clockwise, 0 = force no rotation, +nil+ = rotate automatically when needed.
+      def normalize_rotation(driver, image, rotation)
+        return if rotation == 0
+
+        num_quadrants = 0
+        if !rotation.nil?
+          if rotation % RIGHT_ANGLE != 0
+            raise Applitools::EyesError.new('Currently only quadrant rotations are supported. Current rotation: '\
             "#{rotation}")
+          end
+          num_quadrants = (rotation / RIGHT_ANGLE).to_i
+        elsif rotation.nil? && driver.mobile_device? && driver.landscape_orientation? && image.height > image.width
+          # For Android, we need to rotate images to the right, and for iOS to the left.
+          num_quadrants = driver.android? ? 1 : -1
         end
-        num_quadrants = (rotation / RIGHT_ANGLE).to_i
-      elsif rotation.nil? && driver.mobile_device? && driver.landscape_orientation? && image.height > image.width
-        # For Android, we need to rotate images to the right, and for iOS to the left.
-        num_quadrants = driver.android? ? 1 : -1
-      end
 
-      Applitools::Utils::ImageUtils.quadrant_rotate!(image, num_quadrants)
-    end
+        Applitools::Utils::ImageUtils.quadrant_rotate!(image, num_quadrants)
+      end
 
-    def self.normalize_width(driver, image)
-      return if driver.mobile_device?
+      def normalize_width(driver, image)
+        return if driver.mobile_device?
 
-      normalization_factor = driver.browser.image_normalization_factor(image)
-      Applitools::Utils::ImageUtils.scale!(image, normalization_factor) unless normalization_factor == 1
+        normalization_factor = driver.browser.image_normalization_factor(image)
+        Applitools::Utils::ImageUtils.scale!(image, normalization_factor) unless normalization_factor == 1
+      end
     end
   end
 end

data/lib/applitools/selenium/element.rb

@@ -27,7 +27,7 @@ module Applitools::Selenium
     def ==(other)
       other.is_a?(web_element.class) && web_element == other
     end
-    alias_method :eql?, :==
+    alias eql? ==
 
     def send_keys(*args)
       current_control = region
@@ -37,7 +37,7 @@ module Applitools::Selenium
 
       web_element.send_keys(*args)
     end
-    alias_method :send_key, :send_keys
+    alias send_key send_keys
 
     def region
       point = location

data/lib/applitools/selenium/match_window_data.rb

@@ -2,7 +2,7 @@ module Applitools::Selenium
   class MatchWindowData
     attr_reader :user_inputs, :app_output, :tag, :ignore_mismatch, :screenshot
 
-    def initialize(app_output, user_inputs = [], tag, ignore_mismatch, screenshot)
+    def initialize(app_output, tag, ignore_mismatch, screenshot, user_inputs = [])
       @user_inputs = user_inputs
       @app_output = app_output
       @tag = tag
@@ -20,5 +20,9 @@ module Applitools::Selenium
         ignore_mismatch: @ignore_mismatch
       }
     end
+
+    def screenshot
+      @screenshot.to_blob.force_encoding('BINARY')
+    end
   end
 end

data/lib/applitools/selenium/match_window_task.rb

@@ -2,7 +2,7 @@ require 'base64'
 
 module Applitools::Selenium
   class MatchWindowTask
-    MATCH_INTERVAL = 0.5.freeze
+    MATCH_INTERVAL = 0.5
     AppOuptut = Struct.new(:title, :screenshot64)
 
     attr_reader :eyes, :session, :driver, :default_retry_timeout, :last_checked_window,
@@ -45,7 +45,7 @@ module Applitools::Selenium
           region
         end
       driver.clear_user_inputs
-
+      GC.start
       res
     end
 
@@ -65,9 +65,8 @@ module Applitools::Selenium
       # We intentionally take the first screenshot before starting the timer, to allow the page just a tad more time to
       # stabilize.
       Applitools::EyesLogger.debug 'Matching with intervals...'
-      data = prep_match_data(region, tag, rotation, true)
       start = Time.now
-      as_expected = Applitools::Base::ServerConnector.match_window(session, data)
+      as_expected = match(region, tag, rotation, true)
       Applitools::EyesLogger.debug "First call result: #{as_expected}"
       return true if as_expected
       Applitools::EyesLogger.debug "Not as expected, performing retry (total timeout #{retry_timeout})"
@@ -103,9 +102,8 @@ module Applitools::Selenium
       Applitools::EyesLogger.debug 'Preparing match data...'
       title = eyes.title
       Applitools::EyesLogger.debug 'Getting screenshot...'
-      current_screenshot_encoded = driver.screenshot_as(:png, rotation)
       Applitools::EyesLogger.debug 'Done! Creating image object from PNG...'
-      @current_screenshot = ChunkyPNG::Image.from_blob(current_screenshot_encoded)
+      @current_screenshot = Applitools::Utils::ImageUtils::Screenshot.new(driver.get_screenshot(rotation))
       Applitools::EyesLogger.debug 'Done!'
       # If a region was defined, we refer to the sub-image defined by the region.
       unless region.empty?
@@ -116,18 +114,14 @@ module Applitools::Selenium
         Applitools::EyesLogger.debug 'Done! Cropping region...'
         @current_screenshot.crop!(clipped_region.left, clipped_region.top, clipped_region.width, clipped_region.height)
         Applitools::EyesLogger.debug 'Done! Creating cropped image object...'
-        current_screenshot_encoded = @current_screenshot.to_blob.force_encoding('BINARY')
         Applitools::EyesLogger.debug 'Done!'
       end
 
-      # FIXME re-Enable screenshot compression after handling memory leaks.
+      # FIXME: re-Enable screenshot compression after handling memory leaks.
       # Applitools::EyesLogger.debug 'Compressing screenshot...'
       # compressed_screenshot = Applitools::Utils::ImageDeltaCompressor.compress_by_raw_blocks(@current_screenshot,
       #   current_screenshot_encoded, last_checked_window)
 
-      # FIXME Remove the following line after compression is re-enabled.
-      compressed_screenshot = current_screenshot_encoded
-
       Applitools::EyesLogger.debug 'Done! Creating AppOuptut...'
       app_output = AppOuptut.new(title, nil)
       user_inputs = []
@@ -186,8 +180,8 @@ module Applitools::Selenium
         Applitools::EyesLogger.info 'Triggers ignored: no previous window checked'
       end
       Applitools::EyesLogger.debug 'Creating MatchWindowData object..'
-      match_window_data_obj = Applitools::Selenium::MatchWindowData.new(app_output, user_inputs, tag, ignore_mismatch,
-        compressed_screenshot)
+      match_window_data_obj = Applitools::Selenium::MatchWindowData.new(app_output, tag, ignore_mismatch,
+        @current_screenshot, user_inputs)
       Applitools::EyesLogger.debug 'Done creating MatchWindowData object!'
       match_window_data_obj
     end

data/lib/applitools/selenium/viewport_size.rb

@@ -1,78 +1,57 @@
 module Applitools::Selenium
   class ViewportSize
-    JS_GET_VIEWPORT_HEIGHT = (<<-JS).freeze
-      return (function() {
-        var height = undefined;
-        if (window.innerHeight) {
-          height = window.innerHeight;
-        }
-        else if (document.documentElement && document.documentElement.clientHeight) {
-          height = document.documentElement.clientHeight;
-        } else {
-          var b = document.getElementsByTagName("body")[0];
-          if (b.clientHeight) {
-            height = b.clientHeight;
-          }
-        }
-
-        return height;
-      }());
+    JS_GET_VIEWPORT_SIZE = <<-JS.freeze
+       return (function() {
+         var height = undefined;
+         var width = undefined;
+         if (window.innerHeight) {height = window.innerHeight;}
+         else if (document.documentElement && document.documentElement.clientHeight)
+         {height = document.documentElement.clientHeight;}
+         else { var b = document.getElementsByTagName('body')[0];
+            if (b.clientHeight) {height = b.clientHeight;}
+         };
+
+         if (window.innerWidth) {width = window.innerWidth;}
+         else if (document.documentElement && document.documentElement.clientWidth)
+         {width = document.documentElement.clientWidth;}
+         else { var b = document.getElementsByTagName('body')[0];
+            if (b.clientWidth) {width = b.clientWidth;}
+         };
+         return [width, height];
+         }());
     JS
 
-    JS_GET_VIEWPORT_WIDTH = (<<-JS).freeze
-      return (function() {
-        var width = undefined;
-        if (window.innerWidth) {
-          width = window.innerWidth
-        } else if (document.documentElement && document.documentElement.clientWidth) {
-          width = document.documentElement.clientWidth;
-        } else {
-          var b = document.getElementsByTagName("body")[0];
-          if (b.clientWidth) {
-            width = b.clientWidth;
-          }
-        }
-
-        return width;
-      }());
-    JS
-
-    VERIFY_SLEEP_PERIOD = 1.freeze
-    VERIFY_RETRIES = 3.freeze
+    VERIFY_SLEEP_PERIOD = 1
+    VERIFY_RETRIES = 3
+    BROWSER_SIZE_CALCULATION_RETRIES = 2
 
     def initialize(driver, dimension = nil)
       @driver = driver
-      @dimension = dimension
+      @dimension = setup_dimension(dimension)
     end
 
-    def extract_viewport_width
-      @driver.execute_script(JS_GET_VIEWPORT_WIDTH)
+    def size
+      @dimension
     end
 
-    def extract_viewport_height
-      @driver.execute_script(JS_GET_VIEWPORT_HEIGHT)
-    end
-
-    def extract_viewport_from_browser!
+    def extract_viewport_size!
       @dimension = extract_viewport_from_browser
     end
 
-    def extract_viewport_from_browser
+    alias extract_viewport_from_browser! extract_viewport_size!
+
+    def extract_viewport_size
       width = nil
       height = nil
       begin
-        width  = extract_viewport_width
-        height = extract_viewport_height
+        width, height = @driver.execute_script(JS_GET_VIEWPORT_SIZE)
       rescue => e
         Applitools::EyesLogger.error "Failed extracting viewport size using JavaScript: (#{e.message})"
       end
-
       if width.nil? || height.nil?
         Applitools::EyesLogger.info 'Using window size as viewport size.'
 
-        width, height = *browser_size.values
-        width = width.ceil
-        height = height.ceil
+        width, height = *browser_size.values.map(&:ceil)
 
         if @driver.landscape_orientation? && height > width
           width, height = height, width
@@ -82,56 +61,99 @@ module Applitools::Selenium
       Applitools::Base::Dimension.new(width, height)
     end
 
-    alias_method :viewport_size, :extract_viewport_from_browser
+    alias viewport_size extract_viewport_size
+    alias extract_viewport_from_browser extract_viewport_size
 
     def set
-      if @dimension.is_a?(Hash) && @dimension.key?(:width) && @dimension.key?(:height)
-        # If @dimension is hash of width/height, we convert it to a struct with width/height properties.
-        @dimension = Applitools::Base::Dimension.new(@dimension[:width], @dimension[:height])
-      elsif !@dimension.respond_to?(:width) || !@dimension.respond_to?(:height)
-        raise ArgumentError, "expected #{@dimension.inspect}:#{@dimension.class} to respond to #width and #height, or "\
-          'be  a hash with these keys.'
+      Applitools::EyesLogger.debug "Set viewport size #{@dimension}"
+      # Before resizing the window, set its position to the upper left corner (otherwise, there might not be enough
+      # "space" below/next to it and the operation won't be successful).
+      browser_to_upper_left_corner
+
+      browser_size_calculation_count = 0
+      while browser_size_calculation_count < BROWSER_SIZE_CALCULATION_RETRIES
+        raise Applitools::TestFailedError.new 'Failed to set browser size!' \
+        " (current size: #{browser_size})" unless resize_attempt
+        browser_size_calculation_count += 1
+        if viewport_size == size
+          Applitools::EyesLogger.debug "Actual viewport size #{viewport_size}"
+          return
+        end
       end
+      raise Applitools::TestFailedError.new 'Failed to set viewport size'
+    end
 
-      resize_browser(@dimension)
-      verify_size(:browser_size)
-
-      current_viewport_size = extract_viewport_from_browser
+    def browser_size
+      Applitools::Base::Dimension.for @driver.manage.window.size
+    end
 
-      resize_browser(Applitools::Base::Dimension.new((2 * browser_size.width) - current_viewport_size.width,
-        (2 * browser_size.height) - current_viewport_size.height))
-      verify_size(:viewport_size)
+    def resize_browser(other)
+      @driver.manage.window.size = other
     end
 
-    def verify_size(to_verify)
-      current_size = nil
+    def browser_to_upper_left_corner
+      @driver.manage.window.position = Selenium::WebDriver::Point.new(0, 0)
+    rescue Selenium::WebDriver::Error::UnsupportedOperationError => e
+      Applitools::EyesLogger.warn "Unsupported operation error: (#{e.message})"
+    end
 
-      VERIFY_RETRIES.times do
-        sleep(VERIFY_SLEEP_PERIOD)
-        current_size = send(to_verify)
+    def to_hash
+      @dimension.to_hash
+    end
 
-        return if current_size.values == @dimension.values
-      end
+    private
 
-      err_msg = "Failed setting #{to_verify} to #{@dimension.values} (current size: #{current_size.values})"
+    def setup_dimension(dimension)
+      return dimension if dimension.is_a? ::Selenium::WebDriver::Dimension
+      return Applitools::Base::Dimension.for(dimension) if dimension.respond_to?(:width) &
+          dimension.respond_to?(:height)
+      return Applitools::Base::Dimension.new(
+        dimension[:width],
+        dimension[:height]
+      ) if dimension.is_a?(Hash) && (dimension.keys & [:width, :height]).size == 2
 
-      Applitools::EyesLogger.error(err_msg)
-      raise Applitools::TestFailedError.new(err_msg)
+      raise ArgumentError,
+        "expected #{@dimension.inspect}:#{@dimension.class} to respond to #width and #height," \
+        ' or be  a hash with these keys.'
     end
 
-    def browser_size
-      @driver.manage.window.size
+    # Calculates a necessary browser size to get a requested viewport size,
+    # tries to resize browser, yields a block (which should check if an attempt was successful) before each iteration.
+    # If the block returns true, stop trying and returns true (resize was successful)
+    # Otherwise, returns false after VERIFY_RETRIES iterations
+
+    def resize_attempt
+      actual_viewport_size = extract_viewport_size
+      Applitools::EyesLogger.debug "Actual viewport size #{actual_viewport_size}"
+      required_browser_size = ViewportSize.required_browser_size actual_browser_size: browser_size,
+        actual_viewport_size: actual_viewport_size, required_viewport_size: size
+
+      retries_left = VERIFY_RETRIES
+
+      until retries_left == 0
+        return true if browser_size == required_browser_size
+        Applitools::EyesLogger.debug "Trying to set browser size to #{required_browser_size}"
+        resize_browser required_browser_size
+        sleep VERIFY_SLEEP_PERIOD
+        Applitools::EyesLogger.debug "Required browser size #{required_browser_size}, " \
+          "Current browser size #{browser_size}"
+        retries_left -= 1
+      end
+      false
     end
 
-    def resize_browser(other)
-      # Before resizing the window, set its position to the upper left corner (otherwise, there might not be enough
-      # "space" below/next to it and the operation won't be successful).
-      @driver.manage.window.position = Selenium::WebDriver::Point.new(0, 0)
-      @driver.manage.window.size = other
-    end
+    class << self
+      def required_browser_size(options)
+        unless options[:actual_browser_size].is_a?(Applitools::Base::Dimension) &&
+            options[:actual_viewport_size].is_a?(Applitools::Base::Dimension) &&
+            options[:required_viewport_size].is_a?(Applitools::Base::Dimension)
 
-    def to_hash
-      @dimension.to_hash
+          raise ArgumentError,
+            "expected #{options.inspect}:#{options.class} to be a hash with keys" \
+            ' :actual_browser_size, :actual_viewport_size, :required_viewport_size'
+        end
+        options[:actual_browser_size] - options[:actual_viewport_size] + options[:required_viewport_size]
+      end
     end
   end
 end

data/lib/applitools/utils/image_delta_compressor.rb

@@ -4,7 +4,7 @@ module Applitools::Utils
   module ImageDeltaCompressor
     extend self
 
-    BLOCK_SIZE = 10.freeze
+    BLOCK_SIZE = 10
 
     # Compresses the target image based on the source image.
     #
@@ -84,7 +84,7 @@ module Applitools::Utils
     private
 
     PREAMBLE = 'applitools'.freeze
-    FORMAT_RAW_BLOCKS = 3.freeze
+    FORMAT_RAW_BLOCKS = 3
 
     Dimension = Struct.new(:width, :height)
     CompareAndCopyBlockChannelDataResult = Struct.new(:identical, :channel_bytes)
@@ -115,7 +115,7 @@ module Applitools::Utils
     # Returns +CompareAndCopyBlockChannelDataResult+ object containing a flag saying whether the blocks are identical
     # and a copy of the target block's bytes.
     def compare_and_copy_block_channel_data(source_pixels, target_pixels, image_size, pixel_length, block_size,
-        block_column, block_row, channel)
+      block_column, block_row, channel)
       identical = true
 
       actual_block_size = get_actual_block_size(image_size, block_size, block_column, block_row)

data/lib/applitools/utils/image_utils.rb

@@ -1,8 +1,9 @@
 require 'oily_png'
 require 'base64'
+require 'tempfile'
 
 module Applitools::Utils
-  QUADRANTS_COUNT = 4.freeze
+  QUADRANTS_COUNT = 4
 
   module ImageUtils
     extend self
@@ -91,6 +92,39 @@ module Applitools::Utils
       end
     end
 
+    class Screenshot < Delegator
+      attr_accessor :width, :height, :file
+
+      def initialize(image)
+        @file = Tempfile.new('applitools')
+        image.save file
+        @width = image.width
+        @height = image.height
+      end
+
+      def __getobj__
+        restore
+      end
+
+      def __setobj__(obj)
+        obj.save file
+      end
+
+      def method_missing(method, *args, &block)
+        if method =~ /^.+!$/
+          __setobj__ super
+        else
+          super
+        end
+      end
+
+      private
+
+      def restore
+        ChunkyPNG::Image.from_file(file)
+      end
+    end
+
     include Applitools::MethodTracer
   end
 end

data/lib/applitools/version.rb

@@ -1,3 +1,3 @@
 module Applitools
-  VERSION = '2.31.0'.freeze
+  VERSION = '2.32.0'.freeze
 end

data/test/watir_test_script.rb

@@ -3,6 +3,9 @@ require_relative '../lib/eyes_selenium'
 require 'logger'
 require 'watir-webdriver'
 
+require 'openssl'
+OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
+
 eyes = Applitools::Eyes.new
 eyes.api_key = ENV['APPLITOOLS_API_KEY']
 eyes.log_handler = Logger.new(STDOUT)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 2.31.0
+  version: 2.32.0
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-19 00:00:00.000000000 Z
+date: 2016-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver