eyes_selenium 2.37.0 → 2.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a7377ec805fb8d992f0d4a5824df099c88399b2
-  data.tar.gz: 75b9eda1e1c09e56c0cec6c4a0edb34b6e345db4
+  metadata.gz: 3f99be729477dfe4620d7e5a34ac8bdf7c72b0d0
+  data.tar.gz: 960476bb8f22adb7348a2ff3c17b9785bb9c3bf7
 SHA512:
-  metadata.gz: 9aeb2f24c873ace1cca6f056eaf77a17baab4191cf1f73f98d3955341d67f4e2dccd691c827cfdc2681872458a8c21e27a6819b39ae07a307c84b42bd97a3c49
-  data.tar.gz: 4bf4801f534f014e3dd13d3a1293938e9ef61a8020a3431472889c26aba56345091b8550521a248decfd0ead95360ef11c860c40adc6bd096f5a2171df9e405c
+  metadata.gz: 479fedebff785cec3a5bcc440fc9bb700713ecc70c84e2e5eef786ff9e4cb3306753ffef4766534fa7f5df95ef1f4d89a56028dd8760bb16b2b958ae2b760868
+  data.tar.gz: 2001fcb0b69a988b981bd3952e85121e968ab210d8c969593439d36d2b75351a318f3ac2f46e8c22725951f68bdda113816b0ff740d458328f3d3010b339cda9

data/.travis.yml

@@ -3,8 +3,7 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.6
-  - 2.2.2
-  - ruby-head
+  - 2.3.1
   - rbx-2
 matrix:
   allow_failures:

data/{test → examples}/appium_example_script.rb

@@ -1,8 +1,8 @@
-require_relative '../lib/eyes_selenium'
-
 require 'logger'
 require 'appium_lib'
 
+require 'eyes_selenium'
+
 # Based on Appium example: https://github.com/appium/appium/blob/master/sample-code/examples/ruby/
 
 def android_caps

data/examples/capybara_example.rb

@@ -0,0 +1,82 @@
+require 'rspec'
+require 'capybara/rspec'
+require 'eyes_selenium'
+require 'applitools/capybara'
+
+##
+# This will register capybara driver :eyes by performing
+#
+#   Capybara.register_driver :eyes do |app|
+#     Capybara::Selenium::Driver.new(options)
+#   end
+#
+# (options are passed to Applitools.register_capybara_driver method) and set it as a default driver.
+# The page.driver.browser method will return Applitools::Selenium::Driver instance,
+# based on standard Selenium::Webdriver driver, when eyes have opened.
+# The page.driver.browser method will contain Selenium::Webdriver
+# instance (without applitools wrapper), after eyes have closed
+#
+Applitools.register_capybara_driver :browser => :chrome
+
+# Register another driver if needed
+Capybara.register_driver :selenium_chrome do |app|
+  Capybara::Selenium::Driver.new(app, :browser => :chrome)
+end
+
+# And even one more
+Capybara.register_driver :selenium_firefox do |app|
+  Capybara::Selenium::Driver.new(app, :browser => :firefox)
+end
+
+describe 'Capybara Example', :type => :feature, :js => true do
+  let(:eyes) do
+    Applitools::Eyes.new.tap do |eyes|
+      eyes.api_key = ENV['APPLITOOLS_API_KEY']
+      eyes.log_handler = Logger.new(STDOUT)
+    end
+  end
+
+  it 'Simple test' do
+    eyes.open(app_name: 'Ruby SDK', test_name: 'Capybara test', driver: page,
+               viewport_size: { width: 800, height: 600 })
+    visit 'http://github.com'
+    eyes.check_window('homepage')
+    fill_in('user[login]', with: 'user')
+    eyes.check_window('homepage with username')
+    eyes.close
+  end
+
+  ##
+  # This will use :eyes driver with standard browser, without Applitools wrapper
+  # In our case  - Selenium::Webdriver for :crome
+  #
+  it 'common capybara test' do
+    visit 'http://github.com'
+    fill_in('user[login]', with: 'user')
+    # and so on
+  end
+
+  it 'other chrome test' do
+    ##
+    # this uses :selenium_chrome driver (see Capybara.register_driver block) instead of :eyes driver
+    Capybara.using_driver :selenium_chrome do
+      visit 'http://github.com'
+      fill_in('user[login]', with: 'user')
+      # and so on
+    end
+  end
+
+  after :each do
+    eyes.abort_if_not_closed
+  end
+end
+
+describe 'Other Capybara tests', :type => :feature, :js => true do
+  it 'some other chrome test' do
+    Capybara.using_driver :selenium_chrome do
+      visit 'http://github.com'
+      fill_in('user[login]', with: 'user')
+      # and so on
+    end
+  end
+end

data/{test → examples}/watir_test_script.rb

@@ -1,7 +1,6 @@
-require_relative '../lib/eyes_selenium'
-
-require 'logger'
 require 'watir-webdriver'
+require 'eyes_selenium'
+require 'logger'
 
 require 'openssl'
 OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE

data/lib/applitools/appium_driver.rb

@@ -1,7 +1,7 @@
 if defined? Appium::Driver
   Appium::Driver.class_eval do
     def driver_for_eyes(eyes)
-      Applitools::Selenium::Driver.new(eyes, driver: driver, is_mobile_device: true)
+      Applitools::Selenium::Driver.new(eyes, driver: driver || start_driver, is_mobile_device: true)
     end
   end
 end

data/lib/applitools/capybara.rb

@@ -1,8 +1,8 @@
 require 'capybara'
 
-Applitools.require_dir 'capybara'
+Applitools.require_dir 'selenium/capybara'
 
 module Applitools
-  extend Applitools::Capybara::CapybaraSettings
+  extend Applitools::Selenium::Capybara::CapybaraSettings
   register_capybara_driver
 end

data/lib/applitools/eyes.rb

@@ -67,16 +67,21 @@ class Applitools::Eyes
   #   override Eyes' automatic scaling inference. Values must be >=0 or +nil+. 1 = Don't scale, +nil+ = use Eyes'
   #   automatic scaling inference.
   # +force_fullpage_screenshot+:: +boolean+ Whether or not to force fullpage screenshot taking, if the browser doesn't
-  #   support it explicitly.
+  #                               support it explicitly.
   # +hide_scrollbars+:: +boolean+ Whether or not hide scrollbars.
   # +use_css_transition+:: +boolean+ Whether or not to perform CSS transition.
   # +wait_before_screenshot+:: +Integer+ The number of milliseconds to wait before each screenshot. Use -1 to reset to
-  #   the default value.
-  attr_reader :app_name, :test_name, :is_open, :viewport_size, :driver
+  #                            the default value.
+  # +debug_screenshot+:: +boolean+ If true saves every taken screenshot in current folder. File name has following
+  #                      format: +TAG_YYYY_MM_DD_HH_MI__N.png+, where +TAG+ - the tag specified for the test,
+  #                      +YYYY_MM_DD_HH_MI+ - date && time, +N+ - screenshot number (makes sence only when
+  #                      +force_fullpage_screenshot+ is true). Default value is false
+
+  attr_reader :app_name, :test_name, :is_open, :viewport_size, :driver, :passed_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
+    :use_css_transition, :scale_ratio, :wait_before_screenshots, :debug_screenshot
 
   def_delegators 'Applitools::EyesLogger', :log_handler, :log_handler=
   def_delegators 'Applitools::Base::ServerConnector', :api_key, :api_key=, :server_url, :server_url=, :set_proxy
@@ -103,7 +108,7 @@ class Applitools::Eyes
 
   def initialize(options = {})
     @is_disabled = false
-
+    @debug_screenshot = options[:debug_screenshot].nil? ? false : true
     return if disabled?
 
     @api_key = nil
@@ -124,7 +129,7 @@ class Applitools::Eyes
   end
 
   def open(options = {})
-    @driver = get_driver(options)
+    @passed_driver = @driver = get_driver(options.merge(debug_screenshot: debug_screenshot))
     return driver if disabled?
 
     if api_key.nil?
@@ -232,6 +237,7 @@ class Applitools::Eyes
   def close(raise_ex = true)
     return if disabled?
     @is_open = false
+    passed_driver.use_native_browser if passed_driver.respond_to? :use_native_browser
 
     # If there's no running session, the test was never started (never reached check_window).
     unless @session
@@ -308,6 +314,7 @@ class Applitools::Eyes
     return if disabled?
 
     @is_open = false
+    passed_driver.use_native_browser if passed_driver.respond_to? :use_native_browser
 
     return unless @session
 

data/lib/applitools/sauce.rb

@@ -1,2 +1,2 @@
 require_relative 'capybara' if defined? Capybara
-Applitools.require_dir 'sauce'
+Applitools.require_dir 'selenium/sauce'

data/lib/applitools/{capybara → selenium/capybara}/capybara_settings.rb

@@ -1,8 +1,8 @@
-module Applitools::Capybara
+module Applitools::Selenium::Capybara
   module CapybaraSettings
     def register_capybara_driver(options = {})
       Capybara.register_driver :eyes do |app|
-        Applitools::Capybara::Driver.new app, options
+        Applitools::Selenium::Capybara::Driver.new app, options
       end
       Capybara.default_driver = :eyes
       Capybara.javascript_driver = :eyes

data/lib/applitools/{capybara → selenium/capybara}/driver.rb

@@ -1,5 +1,5 @@
 if defined? Capybara::Selenium::Driver
-  module Applitools::Capybara
+  module Applitools::Selenium::Capybara
     class Driver < Capybara::Selenium::Driver
       def driver_for_eyes(eyes)
         browser eyes: eyes
@@ -7,7 +7,7 @@ if defined? Capybara::Selenium::Driver
 
       def browser(options = {})
         eyes = options.delete(:eyes)
-        super()
+        @native_browser ||= super()
         unless eyes.nil?
           is_mobile_device = @browser.capabilities['platformName'] ? true : false
           @browser = Applitools::Selenium::Driver.new eyes,
@@ -15,6 +15,10 @@ if defined? Capybara::Selenium::Driver
         end
         @browser
       end
+
+      def use_native_browser
+        @browser = @native_browser
+      end
     end
   end
 end
@@ -24,5 +28,9 @@ if defined? Capybara::Session
     def driver_for_eyes(eyes)
       driver.driver_for_eyes eyes
     end
+
+    def use_native_browser
+      driver.use_native_browser if driver.respond_to? :use_native_browser
+    end
   end
 end

data/lib/applitools/selenium/driver.rb

@@ -86,10 +86,13 @@ module Applitools::Selenium
     # Return a normalized screenshot.
     #
     # +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.
+    #              negative values = counter-clockwise, 0 = force no rotation, +nil+ = rotate automatically when needed.
+    # +tag+:: +String|nil+ The tag specified for the test, used onle when +debug_screenshot+ is set to true
     #
     # Returns: +ChunkPng::Image+ A screenshot object, normalized by scale and rotation.
-    def get_screenshot(rotation = nil)
+    def get_screenshot(rotation = nil, tag = nil)
+      @tag_for_screenshot_debug = tag
+      @visible_screenshot_call_count = 0
       image = mobile_device? || !@eyes.force_fullpage_screenshot ? visible_screenshot : @browser.fullpage_screenshot
       Applitools::Selenium::Driver.normalize_image(self, image, rotation)
       image
@@ -99,7 +102,9 @@ module Applitools::Selenium
       Applitools::EyesLogger.debug "Waiting before screenshot: #{wait_before_screenshots} seconds..."
       sleep(wait_before_screenshots)
       Applitools::EyesLogger.debug 'Finished waiting.'
-      Applitools::Utils::ImageUtils::Screenshot.new driver.screenshot_as(:png)
+      screenshot = driver.screenshot_as(:png)
+      save_image(screenshot) if @eyes.debug_screenshot
+      Applitools::Utils::ImageUtils::Screenshot.new screenshot
     end
 
     def mouse
@@ -137,6 +142,12 @@ module Applitools::Selenium
 
     private
 
+    def save_image(image)
+      tag = (@tag_for_screenshot_debug || 'screenshot').gsub(/\s+/, '_')
+      screenshot = ChunkyPNG::Image.from_string(image)
+      screenshot.save("#{tag}_#{Time.now.strftime('%Y_%m_%d_%H_%M')}__#{@visible_screenshot_call_count += 1}.png")
+    end
+
     def bridge
       __getobj__.send(:bridge)
     end

data/lib/applitools/selenium/match_window_task.rb

@@ -103,7 +103,7 @@ module Applitools::Selenium
       title = eyes.title
       Applitools::EyesLogger.debug 'Getting screenshot...'
       Applitools::EyesLogger.debug 'Done! Creating image object from PNG...'
-      @current_screenshot = driver.get_screenshot(rotation)
+      @current_screenshot = driver.get_screenshot(rotation, tag)
       Applitools::EyesLogger.debug 'Done!'
       # If a region was defined, we refer to the sub-image defined by the region.
       unless region.empty?

data/lib/applitools/{sauce → selenium/sauce}/driver.rb

@@ -4,6 +4,10 @@ if defined? Sauce::Selenium2
       def driver_for_eyes(eyes)
         browser.raw_driver eyes: eyes
       end
+
+      def use_native_browser
+        browser.use_native_browser
+      end
     end
   end
 
@@ -14,6 +18,7 @@ if defined? Sauce::Selenium2
 
     def raw_driver(options = {})
       eyes = options.delete(:eyes)
+      @native_driver ||= @raw_driver
       unless eyes.nil?
         is_mobile_device = @raw_driver.capabilities['platformName'] ? true : false
         @raw_driver = Applitools::Selenium::Driver.new eyes,
@@ -21,5 +26,9 @@ if defined? Sauce::Selenium2
       end
       @raw_driver
     end
+
+    def use_native_browser
+      @raw_driver = @native_driver
+    end
   end
 end

data/lib/applitools/utils/image_utils.rb

@@ -23,8 +23,8 @@ module Applitools::Utils
     #
     # Returns:
     # +ChunkyPNG::Canvas+ An image object.
-    def png_image_from_base64(png_bytes64)
-      png_image_from_bytes(Base64.decode64(png_bytes64))
+    def png_image_from_base64(png_bytes)
+      png_image_from_bytes(Base64.decode64(png_bytes))
     end
 
     # Get the raw PNG bytes of an image.

data/lib/applitools/version.rb

@@ -1,3 +1,3 @@
 module Applitools
-  VERSION = '2.37.0'.freeze
+  VERSION = '2.38.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 2.37.0
+  version: 2.38.0
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-01 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -278,6 +292,12 @@ files:
 - README.md
 - Rakefile
 - certs/cacert.pem
+- examples/appium_example_script.rb
+- examples/capybara_example.rb
+- examples/sauce_capybara_example.rb
+- examples/sauce_example.rb
+- examples/simple_test_script.rb
+- examples/watir_test_script.rb
 - eyes_selenium.gemspec
 - lib/applitools/appium_driver.rb
 - lib/applitools/base/batch_info.rb
@@ -293,21 +313,21 @@ files:
 - lib/applitools/base/test_results.rb
 - lib/applitools/base/text_trigger.rb
 - lib/applitools/capybara.rb
-- lib/applitools/capybara/capybara_settings.rb
-- lib/applitools/capybara/driver.rb
 - lib/applitools/extensions.rb
 - lib/applitools/eyes.rb
 - lib/applitools/eyes_logger.rb
 - lib/applitools/method_tracer.rb
 - lib/applitools/sauce.rb
-- lib/applitools/sauce/driver.rb
 - lib/applitools/selenium/browser.rb
+- lib/applitools/selenium/capybara/capybara_settings.rb
+- lib/applitools/selenium/capybara/driver.rb
 - lib/applitools/selenium/driver.rb
 - lib/applitools/selenium/element.rb
 - lib/applitools/selenium/keyboard.rb
 - lib/applitools/selenium/match_window_data.rb
 - lib/applitools/selenium/match_window_task.rb
 - lib/applitools/selenium/mouse.rb
+- lib/applitools/selenium/sauce/driver.rb
 - lib/applitools/selenium/viewport_size.rb
 - lib/applitools/selenium_webdriver.rb
 - lib/applitools/utils/image_delta_compressor.rb
@@ -319,12 +339,6 @@ files:
 - spec/driver_passthrough_spec.rb
 - spec/fixtures/static_test_file.html
 - spec/spec_helper.rb
-- test/appium_example_script.rb
-- test/capybara_example.rb
-- test/sauce_capybara_example.rb
-- test/sauce_example.rb
-- test/test_script.rb
-- test/watir_test_script.rb
 homepage: https://www.applitools.com
 licenses:
 - Apache License, Version 2.0
@@ -345,7 +359,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Applitools Ruby SDK
@@ -353,9 +367,3 @@ test_files:
 - spec/driver_passthrough_spec.rb
 - spec/fixtures/static_test_file.html
 - spec/spec_helper.rb
-- test/appium_example_script.rb
-- test/capybara_example.rb
-- test/sauce_capybara_example.rb
-- test/sauce_example.rb
-- test/test_script.rb
-- test/watir_test_script.rb

data/test/capybara_example.rb

@@ -1,28 +0,0 @@
-require 'rspec'
-require 'capybara/rspec'
-require 'eyes_selenium'
-
-Applitools.register_capybara_driver :browser => :chrome
-
-describe 'Capybara Example', :type => :feature, :js => true do
-  let(:eyes) do
-    Applitools::Eyes.new.tap do |eyes|
-      eyes.api_key = ENV['APPLITOOLS_API_KEY']
-      eyes.log_handler = Logger.new(STDOUT)
-    end
-  end
-
-  it 'Simple test' do
-    eyes.open(app_name: 'Ruby SDK', test_name: 'Capybara test', driver: page,
-               viewport_size: { width: 800, height: 600 })
-    visit 'http://github.com'
-    eyes.check_window('homepage')
-    fill_in('user[login]', with: 'user')
-    eyes.check_window('homepage with username')
-    eyes.close
-  end
-
-  after :each do
-    eyes.abort_if_not_closed
-  end
-end