eyes_selenium 2.11.0 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77213698a9791f81c32d4a00d7fcda49f14f013a
-  data.tar.gz: 6e463fd95f40d3f5737d3abf703786c1339c6c4c
+  metadata.gz: fc78305202b75895bf7025658234b46d93645892
+  data.tar.gz: bade0478f3a690c4ba373ad74ebd8e9460ce73ce
 SHA512:
-  metadata.gz: 5ca198c3707141869407d64c30492a080339a54d45133539196fbfd410a0f3805908748e30a08e5e1ba361e84fc7800ecda65dc364370bd81f8b851aa965eb52
-  data.tar.gz: e668edf99cad251749e6e4ab9202bd5cc3d80d6af3cf293be7e3d2350c48fc14e773eb81794845e1cf1030f6ad8b8cd3e31a9a9a74819a04ef3947b36d1b6e54
+  metadata.gz: 4e649613d6a93955dad130ae4d305bd34dbc41205ea6603534dcc22032693c83c4d04414b3a4d3d2612eb1bf15416f824c855b39b0da5f98c490c55987f98b7b
+  data.tar.gz: 0a28cebf023e6724ed65d0bc27d85c6c29359364afcc8b0f9e96ea0714ff8e6955910e768d7d974637b6eef58d62b75465c1efe1556f9af15cd3e55096033cc6

data/lib/eyes_selenium/eyes/driver.rb

@@ -4,27 +4,28 @@ require 'appium_lib'
 
 class  Applitools::Driver
 
-  # Prepares an image for being sent to the Eyes server (e.g., handling rotation, scaling etc.).
+  # Prepares an image (in place!) for being sent to the Eyes server (e.g., handling rotation, scaling etc.).
   #
   # +driver+:: +Applitools::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.
   #
-  # Returns:
-  # +Integer+ The rotation of the screenshot we get from the webdriver (degrees).
-  def self.normalize_image!(driver, image, rotation=0)
+  def self.normalize_image!(driver, image, rotation)
     EyesLogger.debug "#{__method__}()"
-    # Handling rotation
-    num_quadrants = 0
     if rotation != 0
-      if rotation % 90 != 0
-        raise Applitools::EyesError.new "Currently only quadrant rotations are supported. Current rotation: #{rotation}"
+      num_quadrants = 0
+      if !rotation.nil?
+        if rotation % 90 != 0
+          raise Applitools::EyesError.new(
+            "Currently only quadrant rotations are supported. Current rotation: #{rotation}")
+        end
+        num_quadrants = (rotation / 90).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 / 90).to_i
-    elsif 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
-    if num_quadrants != 0
       Applitools::Utils::ImageUtils.quadrant_rotate!(image, num_quadrants)
     end
   end
@@ -108,24 +109,28 @@ class  Applitools::Driver
     @is_mobile_device
   end
 
-  def screenshot_as(output_type)
-    # TODO Check if screenshot_taker is still required
-    if screenshot_taker
-      if output_type.downcase.to_sym != :base64
-        raise Applitools::EyesError.new("#{output_type} output type not supported for screenshot")
-      end
-      screenshot64 = screenshot_taker.screenshot
-    else
-      screenshot = driver.screenshot_as(output_type)
-      # We only support additional processing of the output (such as rotation) for Base64 type of screenshots.
-      if output_type.downcase.to_sym != :base64
-        return screenshot
-      end
-      screenshot64 = screenshot
+  # Return a PNG screenshot in the given format as a string
+  #
+  # +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)
+    # FIXME Check if screenshot_taker is still required
+    screenshot = screenshot_taker ? screenshot_taker.screenshot : driver.screenshot_as(:base64)  
+    screenshot = Applitools::Utils::ImageUtils.png_image_from_base64(screenshot)
+    Applitools::Driver.normalize_image!(self, screenshot, rotation)
+    case output_type
+      when :base64
+        screenshot = Applitools::Utils::ImageUtils.base64_from_png_image(screenshot)
+      when :png
+        screenshot = Applitools::Utils::ImageUtils.bytes_from_png_image(screenshot)
+      else
+        raise Applitools::EyesError.new("Unsupported screenshot output type #{output_type.to_s}")
     end
-    screenshot = Applitools::Utils::ImageUtils.png_image_from_base64(screenshot64)
-    Applitools::Driver.normalize_image!(self, screenshot)
-    Applitools::Utils::ImageUtils.base64_from_png_image(screenshot)
+    screenshot.force_encoding('BINARY')
   end
 
   def mouse

data/lib/eyes_selenium/eyes/eyes.rb

@@ -1,6 +1,6 @@
 class Applitools::Eyes
 
-  DEFAULT_MATCH_TIMEOUT = 2.0
+  DEFAULT_MATCH_TIMEOUT = 2.0  # Seconds
   BASE_AGENT_ID = 'eyes.selenium.ruby/' + Applitools::VERSION
   DEFAULT_EYES_SERVER = 'https://eyessdk.applitools.com'
 
@@ -10,10 +10,47 @@ class Applitools::Eyes
                 :dont_get_title
 
   public
+  #
+  # Attributes:
+  #
+  # +app_name+:: +String+ The application name which was provided as an argument to +open+.
+  # +test_name+:: +String+ The test name which was provided as an argument to +open+.
+  # +is_open+:: +boolean+ Is there an open session.
+  # +viewport_size+:: +Hash+ The viewport size which was provided as an argument to +open+. Should include +width+
+  #                    and +height+.
+  # +driver+:: +Applitools::Driver+ The driver instance wrapping the driver which was provided as an argument to +open+.
+  # +api_key+:: +String+ The user's API key.
+  # +match_timeout+:: +Float+ The default timeout for check_XXXX operations. (Seconds)
+  # +batch+:: +BatchInfo+ The current tests grouping, if any.
+  # +host_os+:: +String+ A string identifying the OS running the AUT. Set this if you wish to override Eyes' automatic
+  #             inference.
+  # +host_app+:: +String+ A string identifying the container application running the AUT (e.g., Firefox). Set this if
+  #               you wish to override Eyes' automatic inference.
+  # +branch_name+:: +String+ If set, names the branch in which the test should run.
+  # +parent_branch_name+:: +String+ If set, names the parent branch of the branch in which the test should run.
+  # +user_inputs+:: +Applitools::MouseTrigger+/+Applitools::KeyboardTrigger+ Mouse/Keyboard events which happened after
+  #                 the last visual validation.
+  # +save_new_tests+:: +boolean+ Whether or not new tests should be automatically accepted as baseline.
+  # +save_failed_tests+:: +boolean+ Whether or not failed tests should be automatically accepted as baseline.
+  # +match_level+:: +String+ The default match level for the entire session. See +Applitools::MatchLevel+.
+  # +baseline_name+:: +String+ A string identifying the baseline which the test will be compared against. Set this if
+  #                   you wish to override Eyes' automatic baseline inference.
+  # +is_disabled+:: +boolean+ Set to +true+ if you wish to disable Eyes without deleting code (Eyes' methods act as a
+  #                 mock, and will do nothing).
+  # +server_url+:: +String+ The Eyes' server. Set this if you wish to override the default Eyes server URL.
+  # +agent_id+:: +String+ An optional string identifying the current library using the SDK.
+  # +log_handler+:: +Logger+ The logger to which Eyes will send info/debug messages.
+  # +failure_reports+:: +String+ Whether the current test will report mismatches immediately or when it is finished.
+  #                     See +Applitools::FailureReports+.
+  # +rotation+:: +Integer+|+nil+ The degrees by which to rotate the screenshots received from the driver. Set this to
+  #               override Eyes' automatic rotation inference. Positive values = clockwise rotation,
+  #               negative values = counter-clockwise, 0 = force no rotation, +nil+ = use Eyes' automatic rotation
+  #               inference.
+  #
   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, :api_key, :is_disabled, :server_url, :agent_id, :log_handler,
-                :failure_reports, :match_level, :baseline_name
+                :failure_reports, :match_level, :baseline_name, :rotation
 
   def log_handler
     EyesLogger.log_handler
@@ -85,8 +122,8 @@ class Applitools::Eyes
 
     if api_key.nil?
       #noinspection RubyQuotedStringsInspection
-      raise Applitools::EyesError.new("API key not set! Log in to https://applitools.com to obtain your" +
-                                          " API Key and use 'api_key' to set it.")
+      raise Applitools::EyesError.new(
+                "API key not set! Log in to https://applitools.com to obtain your API Key and use 'api_key' to set it.")
     end
 
     if driver.is_a?(Selenium::WebDriver::Driver)
@@ -341,7 +378,7 @@ class Applitools::Eyes
     end
 
     EyesLogger.debug 'Starting match task...'
-    as_expected = match_window_task.match_window(region, specific_timeout, tag, should_match_window_run_once_on_timeout)
+    as_expected = match_window_task.match_window(region, specific_timeout, tag, rotation, should_match_window_run_once_on_timeout)
     EyesLogger.debug 'Match window done!'
     unless as_expected
       self.should_match_window_run_once_on_timeout = true

data/lib/eyes_selenium/eyes/match_window_task.rb

@@ -22,18 +22,18 @@ class Applitools::MatchWindowTask
     @current_screenshot = nil # +ChunkyPNG::Canvas+
   end
 
-  def match_window(region, retry_timeout, tag,run_once_after_wait=false)
+  def match_window(region, retry_timeout, tag, rotation, run_once_after_wait=false)
     if retry_timeout < 0
       retry_timeout = default_retry_timeout
     end
     EyesLogger.debug "Retry timeout set to: #{retry_timeout}"
     start = Time.now
     res = if retry_timeout.zero?
-            run(region, tag)
+            run(region, tag, rotation)
           elsif run_once_after_wait
-            run(region, tag, retry_timeout)
+            run(region, tag, rotation, retry_timeout)
           else
-            run_with_intervals(region, tag, retry_timeout)
+            run_with_intervals(region, tag, rotation, retry_timeout)
           end
     elapsed_time = Time.now - start
     EyesLogger.debug "match_window(): Completed in #{format('%.2f', elapsed_time)} seconds"
@@ -43,21 +43,21 @@ class Applitools::MatchWindowTask
     driver.eyes.clear_user_inputs and return res
   end
 
-  def run(region, tag, wait_before_run=nil)
+  def run(region, tag, rotation, wait_before_run=nil)
     EyesLogger.debug 'Trying matching once...'
     if wait_before_run
       EyesLogger.debug 'waiting before run...'
       sleep(wait_before_run)
       EyesLogger.debug 'waiting done!'
     end
-    match(region, tag)
+    match(region, tag, rotation)
   end
 
-  def run_with_intervals(region, tag, retry_timeout)
+  def run_with_intervals(region, tag, rotation, retry_timeout)
     # We intentionally take the first screenshot before starting the timer, to allow the page
     # just a tad more time to stabilize.
     EyesLogger.debug 'Matching with intervals...'
-    data = prep_match_data(region, tag, true)
+    data = prep_match_data(region, tag, rotation, true)
     start = Time.now
     as_expected = agent_connector.match_window(session, data)
     EyesLogger.debug "First call result: #{as_expected}"
@@ -68,13 +68,13 @@ class Applitools::MatchWindowTask
       EyesLogger.debug 'Waiting before match...'
       sleep(MATCH_INTERVAL)
       EyesLogger.debug 'Done! Matching...'
-      return true if match(region, tag, true)
+      return true if match(region, tag, rotation, true)
       match_retry = Time.now - start
       EyesLogger.debug "Elapsed time: #{match_retry}"
     end
     ## lets try one more time if we still don't have a match
     EyesLogger.debug 'Last attempt to match...'
-    as_expected = match(region, tag)
+    as_expected = match(region, tag, rotation)
     EyesLogger.debug "Match result: #{as_expected}"
     as_expected
   end
@@ -89,15 +89,11 @@ class Applitools::MatchWindowTask
       Applitools::Region.new(left, top, width, height)
     end
 
-    def prep_match_data(region, tag, ignore_mismatch)
+    def prep_match_data(region, tag, rotation, ignore_mismatch)
       EyesLogger.debug 'Preparing match data...'
       title = eyes.title
       EyesLogger.debug 'Getting screenshot...'
-      screenshot64 = driver.screenshot_as(:base64)
-      # We need a reference to the raw bytes of the PNG, which is why we didn't
-      # use +Applitools::Utils::ImageUtils.image_from_base64+.
-      EyesLogger.debug 'Done! Decoding base64...'
-      current_screenshot_encoded = Base64.decode64(screenshot64)
+      current_screenshot_encoded = driver.screenshot_as(:png, rotation)
       EyesLogger.debug 'Done! Creating image object from PNG...'
       @current_screenshot = ChunkyPNG::Image.from_blob(current_screenshot_encoded)
       EyesLogger.debug 'Done!'
@@ -176,9 +172,9 @@ class Applitools::MatchWindowTask
       match_window_data_obj
     end
 
-    def match(region, tag, ignore_mismatch=false)
+    def match(region, tag, rotation, ignore_mismatch=false)
       EyesLogger.debug 'Match called...'
-      data = prep_match_data(region, tag, ignore_mismatch)
+      data = prep_match_data(region, tag, rotation, ignore_mismatch)
       match_result = agent_connector.match_window(session, data)
       EyesLogger.debug 'Match done!'
       match_result

data/lib/eyes_selenium/version.rb

@@ -1,3 +1,3 @@
 module Applitools
-  VERSION = '2.11.0'
+  VERSION = '2.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.12.0
 platform: ruby
 authors:
 - Applitools team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-27 00:00:00.000000000 Z
+date: 2015-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver