eyes_selenium 3.17.0 → 3.17.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78413a6f279b3794f59b083a1fa5a45d4e24abacd2ce0afc307b9ef460544c14
-  data.tar.gz: a275e1d8faeb55b6fc4d6da860dbd5fb3653f2998850e21a1cc49acd764fdca6
+  metadata.gz: 119f032b65d1a768ae420679f6cb509480505767691d86b7417f3cb210fb7e8d
+  data.tar.gz: 100b6606ffb9a405d5e042a7d424fedd96599a426235ba1056792056c26d771e
 SHA512:
-  metadata.gz: 5c0469f425a316ff162998b826d3895a36b2c4861e80bf1bf1e27e11dfe247e159bc885c6d2079c629ae612b68cd148e73910acf9ecbcf40f8f4faaf16fefe94
-  data.tar.gz: 624f99713ef32dbe5f19af005444fe74537ff84961e99a27419e011c53fbc9c0759ab3b6e4f11a094ab697c64ea7c86ddc0bacd7f1192ac9046f6ba6670e9fd8
+  metadata.gz: c48cea011af489db8c29a06b1b6b7ac3a10ab733f22fe46e9dc70ac9a0bd587bc5ed960c98692f34f39521e99f14d8dc3c7eb559de8ed3b9eb0adec2da41e5c6
+  data.tar.gz: 4388fbfb94018ef6629f019ece08eee0186bdcad74dcad6b83815aafb4a4c44b04233522d73b1f18bd829c395781b7e1610c7d419514abf3c0a772b01ae4cd61

data/lib/applitools/selenium/browser_types.rb

@@ -1,5 +1,16 @@
 # frozen_string_literal: true
 module BrowserTypes
+  extend self
+  def const_missing(name)
+    puts 'Please, prefer using BrowserType instead of BrowserTypes(plural).'
+    BrowserType.const_get(name)
+  end
+
+  def enum_values
+    BrowserType.enum_values
+  end
+end
+module BrowserType
   extend self
   CHROME = :'chrome-0'
   CHROME_ONE_VERSION_BACK = :'chrome-1'
@@ -12,6 +23,7 @@ module BrowserTypes
   SAFARI = :'safari-0'
   SAFARI_ONE_VERSION_BACK = :'safari-1'
   SAFARI_TWO_VERSIONS_BACK = :'safari-2'
+  IOS_SAFARI = :safari
 
   EDGE_CHROMIUM = :'edgechromium'
   EDGE_CHROMIUM_ONE_VERSION_BACK = :'edgechromium-1'
@@ -52,7 +64,8 @@ module BrowserTypes
       EDGE_LEGACY,
       IE_10,
       EDGE_CHROMIUM,
-      EDGE_CHROMIUM_ONE_VERSION_BACK
+      EDGE_CHROMIUM_ONE_VERSION_BACK,
+      IOS_SAFARI
     ]
   end
 end

data/lib/applitools/selenium/browsers_info.rb

@@ -4,7 +4,7 @@ module Applitools
   module Selenium
     class BrowsersInfo < Set
       def add(obj)
-        return super if obj.is_a? Applitools::Selenium::RenderBrowserInfo
+        return super if obj.is_a? Applitools::Selenium::IRenderBrowserInfo
         raise(
           Applitools::EyesIllegalArgument,
           'It is expected the value to be an Applitools::Selenium::RenderBrowserInfo instance,' \
@@ -15,7 +15,7 @@ module Applitools
       def each(viewport_size = nil)
         return super() unless empty?
         return unless viewport_size
-        default = Applitools::Selenium::RenderBrowserInfo.new.tap do |bi|
+        default = Applitools::Selenium::DesktopBrowserInfo.new.tap do |bi|
           bi.viewport_size = viewport_size
           bi.browser_type = BrowserTypes::CHROME
         end

data/lib/applitools/selenium/configuration.rb

@@ -36,11 +36,17 @@ module Applitools
 
       def add_browser(*args)
         case args.size
-        when 0, 1
+        when 0
+          browser = Applitools::Selenium::DesktopBrowserInfo.new
+        when 1
           b = args[0]
-          browser = b || Applitools::Selenium::RenderBrowserInfo.new
+          raise(
+            Applitools::EyesIllegalArgument,
+            'Expected :browser to be an IRenderBrowserInfo instance!'
+          ) unless b.is_a? IRenderBrowserInfo
+          browser = b
         when 3
-          browser = Applitools::Selenium::RenderBrowserInfo.new.tap do |bi|
+          browser = Applitools::Selenium::DesktopBrowserInfo.new.tap do |bi|
             bi.viewport_size = Applitools::RectangleSize.new(args[0], args[1])
             bi.browser_type = args[2]
           end
@@ -51,11 +57,18 @@ module Applitools
         self
       end
 
+      def add_browsers(browsers)
+        browsers.each do |browser|
+          add_browser(browser)
+        end
+        self
+      end
+
       def add_device_emulation(device_name, orientation = Orientations::PORTRAIT)
         Applitools::ArgumentGuard.not_nil device_name, 'device_name'
         raise Applitools::EyesIllegalArgument, 'Wrong device name!' unless Devices.enum_values.include? device_name
         emu = Applitools::Selenium::ChromeEmulationInfo.new(device_name, orientation)
-        add_browser { |b| b.emulation_info(emu) }
+        add_browser emu
       end
 
       def viewport_size
@@ -66,6 +79,7 @@ module Applitools
         return from_browsers_info.viewport_size if from_browsers_info
         nil
       end
+
     end
   end
 end

data/lib/applitools/selenium/orientations.rb

@@ -1,5 +1,21 @@
 # frozen_string_literal: true
 module Orientations
+  extend self
+  def const_missing(name)
+    puts 'Please prefer using the Orientation instead of Orientations(plural).'
+    Orientation.const_get(name)
+  end
+  def enum_values
+    Orientation.enum_values
+  end
+end
+
+module Orientation
+  extend self
   PORTRAIT = 'portrait'
   LANDSCAPE = 'landscape'
+
+  def enum_values
+    [PORTRAIT, LANDSCAPE]
+  end
 end

data/lib/applitools/selenium/visual_grid/chrome_emulation_info.rb

@@ -1,20 +1,66 @@
 # frozen_string_literal: true
-require 'applitools/selenium/visual_grid/emulation_base_info'
+require_relative 'emulation_base_info'
+require_relative 'i_render_browser_info'
 module Applitools
   module Selenium
-    class ChromeEmulationInfo < EmulationBaseInfo
-      attr_accessor :device_name
+    class ChromeEmulationInfo < IRenderBrowserInfo
+      DEFAULT_CONFIG = proc do
+        {
+            platform: 'linux',
+            browser_type: BrowserType::CHROME,
+            # size_mode: 'full-page',
+            viewport_size: Applitools::RectangleSize.from_any_argument(width: 0, height: 0)
+        }
+      end
+      class << self
+        def default_config
+          DEFAULT_CONFIG.call
+        end
+      end
 
-      def initialize(device_name, screen_orientation)
-        super(screen_orientation)
-        self.device_name = device_name
+      object_field :emulation_info, Applitools::Selenium::EmulationBaseInfo
+
+      # def device_name
+      #   emulation_info.device_name
+      # end
+      #
+      def initialize(*args)
+        super
+        case args[0]
+        when String
+          self.emulation_info = EmulationInfo.new.tap do |ei|
+            ei.device_name = args[0]
+            ei.screen_orientation = args[1] || Orientations::PORTRAIT
+          end
+        when Hash
+          self.emulation_info = EmulationInfo.new.tap do |ei|
+            ei.device_name = args[0][:device_name]
+            ei.screen_orientation = args[0][:screen_orientation] || Orientations::PORTRAIT
+          end
+        end
       end
 
-      def json_data
-        {
-          deviceName: device_name,
-          screenOrientation: screen_orientation
-        }
+      def to_s
+        "#{emulation_info.device_name} - #{emulation_info.screen_orientation}"
+      end
+
+      def device_name
+        emulation_info.device_name + ' (chrome emulation)'
+      end
+
+
+      private
+
+      class EmulationInfo < Applitools::Selenium::EmulationBaseInfo
+        enum_field :device_name, Devices.enum_values
+        enum_field :screen_orientation, Orientations.enum_values
+
+        def json_data
+          {
+              :'deviceName' => device_name,
+              :'screenOrientation' => screen_orientation
+          }
+        end
       end
     end
   end

data/lib/applitools/selenium/visual_grid/desktop_browser_info.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require 'applitools/selenium/browser_types'
+
+module Applitools
+  module Selenium
+    class DesktopBrowserInfo < IRenderBrowserInfo
+      DEFAULT_CONFIG = proc do
+        {
+            platform: 'linux',
+            browser_type: BrowserType::CHROME,
+            # size_mode: 'full-page',
+            viewport_size: Applitools::RectangleSize.from_any_argument(width: 0, height: 0)
+        }
+      end
+
+      class << self
+        def default_config
+          DEFAULT_CONFIG.call
+        end
+      end
+
+      def initialize(options = {})
+        super
+        if options[:width] && options[:height]
+          self.viewport_size = Applitools::RectangleSize.from_any_argument(width: options[:width], height: options[:height])
+        end
+        self.browser_type = options[:browser_type] if options[:browser_type]
+      end
+
+      def platform
+        case browser_type
+        when BrowserType::EDGE_LEGACY, BrowserType::EDGE_CHROMIUM, BrowserType::EDGE_CHROMIUM_ONE_VERSION_BACK
+          'windows'
+        else
+          'linux'
+        end
+      end
+
+      def device_name
+        'desktop'
+      end
+
+    end
+  end
+end

data/lib/applitools/selenium/visual_grid/emulation_base_info.rb

@@ -1,14 +1,7 @@
 # frozen_string_literal: true
 module Applitools
   module Selenium
-    class EmulationBaseInfo
-      extend Applitools::Helpers
-      attr_accessor :screen_orientation
-      abstract_attr_accessor :device_name
-
-      def initialize(screen_orientation)
-        self.screen_orientation = screen_orientation
-      end
+    class EmulationBaseInfo < Applitools::AbstractConfiguration
     end
   end
 end

data/lib/applitools/selenium/visual_grid/eyes_connector.rb

@@ -30,7 +30,7 @@ module Applitools
       def open(driver, browser_info)
         self.driver = driver
         self.browser_info = browser_info
-        self.device_name = browser_info && browser_info.emulation_info && browser_info.emulation_info.device_name
+        self.device_name = browser_info.device_name
         logger.info "opening EyesConnector for #{config.short_description} with viewport size: #{browser_info}"
         config.viewport_size = browser_info.viewport_size
         title

data/lib/applitools/selenium/visual_grid/i_render_browser_info.rb

@@ -0,0 +1,21 @@
+module Applitools
+  module Selenium
+    class IRenderBrowserInfo < ::Applitools::AbstractConfiguration
+
+      object_field :viewport_size, Applitools::RectangleSize
+      enum_field :browser_type, BrowserType.enum_values
+      string_field :platform
+      string_field :size_mode
+      string_field :baseline_env_name
+
+      def initialize(options = {})
+        super()
+        self.baseline_env_name = options[:baseline_env_name] if options[:baseline_env_name]
+      end
+
+      def to_s
+        return "#{viewport_size} (#{browser_type})"
+      end
+    end
+  end
+end

data/lib/applitools/selenium/visual_grid/ios_device_info.rb

@@ -0,0 +1,55 @@
+require_relative 'ios_device_name'
+require_relative 'ios_screen_orientation'
+module Applitools
+  module Selenium
+    class IosDeviceInfo < IRenderBrowserInfo
+      DEFAULT_CONFIG = proc do
+        {
+            platform: 'ios',
+            browser_type: BrowserTypes::IOS_SAFARI,
+            # size_mode: 'full-page',
+            viewport_size: Applitools::RectangleSize.from_any_argument(width: 0, height: 0)
+        }
+      end
+
+      object_field :ios_device_info, Applitools::Selenium::EmulationBaseInfo
+
+      class << self
+        def default_config
+          DEFAULT_CONFIG.call
+        end
+      end
+
+      def initialize(options = {})
+        super
+        self.ios_device_info = EmulationInfo.new.tap do |ei|
+          ei.device_name = options[:device_name]
+          ei.screen_orientation = options[:screen_orientation] || options[:orientation] || IosScreenOrientation::PORTRAIT
+        end
+      end
+
+      def to_s
+        "#{ios_device_info.device_name} - #{ios_device_info.screen_orientation}"
+      end
+
+      def device_name
+        ios_device_info.device_name
+      end
+
+      private
+
+      class EmulationInfo < EmulationBaseInfo
+        enum_field :device_name, IosDeviceName.enum_values
+        enum_field :screen_orientation, IosScreenOrientation.enum_values
+
+        def json_data
+          {
+              name: device_name,
+              screenOrientation: screen_orientation,
+              version: 'latest'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/applitools/selenium/visual_grid/ios_device_name.rb

@@ -0,0 +1,30 @@
+module IosDeviceName
+  extend self
+  IPhone_11_Pro = 'iPhone 11 Pro'
+  IPhone_11_Pro_Max = 'iPhone 11 Pro Max'
+  IPhone_11 = 'iPhone 11'
+  IPhone_XR = 'iPhone XR'
+  IPhone_XS =  'iPhone Xs'
+  IPhone_X = 'iPhone X'
+  IPhone_8 = 'iPhone 8'
+  IPhone_7 = 'iPhone 7'
+  IPad_Pro_3 = 'iPad Pro (12.9-inch) (3rd generation)'
+  IPad_7 = 'iPad (7th generation)'
+  IPad_Air_2 = 'iPad Air (2nd generation)'
+
+  def enum_values
+    [
+      IPhone_11_Pro,
+      IPhone_11_Pro_Max,
+      IPhone_11,
+      IPhone_XR,
+      IPhone_XS,
+      IPhone_X,
+      IPhone_8,
+      IPhone_7,
+      IPad_Pro_3,
+      IPad_7,
+      IPad_Air_2
+    ]
+  end
+end

data/lib/applitools/selenium/visual_grid/ios_screen_orientation.rb

@@ -0,0 +1,14 @@
+module IosScreenOrientation
+  extend self
+  PORTRAIT ='portrait'
+  LANDSCAPE_LEFT = 'landscapeLeft'
+  LANDSCAPE_RIGHT = 'landscapeRight'
+
+  def enum_values
+    [
+      PORTRAIT,
+      LANDSCAPE_LEFT,
+      LANDSCAPE_RIGHT
+    ]
+  end
+end

data/lib/applitools/selenium/visual_grid/render_browser_info.rb

@@ -1,33 +1,39 @@
 # frozen_string_literal: true
 require 'applitools/selenium/browser_types'
-
+# We should not break the API
 module Applitools
   module Selenium
-    class RenderBrowserInfo < ::Applitools::AbstractConfiguration
+    class RenderBrowserInfo < IRenderBrowserInfo
       DEFAULT_CONFIG = proc do
         {
-          platform: 'linux',
-          browser_type: BrowserTypes::CHROME,
-          # size_mode: 'full-page',
-          viewport_size: Applitools::RectangleSize.from_any_argument(width: 0, height: 0)
+            platform: 'linux',
+            browser_type: BrowserTypes::CHROME,
+            # size_mode: 'full-page',
+            viewport_size: Applitools::RectangleSize.from_any_argument(width: 0, height: 0)
         }
       end
+
+      object_field :ios_device_info, Applitools::Selenium::EmulationBaseInfo
+      object_field :emulation_info, Applitools::Selenium::EmulationBaseInfo
+
       class << self
         def default_config
           DEFAULT_CONFIG.call
         end
       end
 
-      object_field :viewport_size, Applitools::RectangleSize
-      enum_field :browser_type, BrowserTypes.enum_values
-      string_field :platform
-      string_field :size_mode
-      string_field :baseline_env_name
-      object_field :emulation_info, Applitools::Selenium::EmulationBaseInfo
+      def initialize(options = {})
+        super
+        if options[:width] && options[:height]
+          self.viewport_size = Applitools::RectangleSize.from_any_argument(width: options[:width], height: options[:height])
+        end
+        self.browser_type = options[:browser_type] if options[:browser_type]
+      end
 
       def platform
+        return 'ios' if ios_device_info
         case browser_type
-        when BrowserTypes::EDGE_LEGACY, BrowserTypes::EDGE_CHROMIUM, BrowserTypes::EDGE_CHROMIUM_ONE_VERSION_BACK
+        when BrowserType::EDGE_LEGACY, BrowserType::EDGE_CHROMIUM, BrowserType::EDGE_CHROMIUM_ONE_VERSION_BACK
           'windows'
         else
           'linux'
@@ -35,8 +41,21 @@ module Applitools
       end
 
       def to_s
-        return "#{viewport_size} (#{browser_type})" unless emulation_info
-        "#{emulation_info.device_name} - #{emulation_info.screen_orientation}"
+        if emulation_info
+          "#{emulation_info.device_name} - #{emulation_info.screen_orientation}"
+        elsif ios_device_info
+          "#{ios_device_info.device_name} - #{ios_device_info.screen_orientation}"
+        end
+        "#{viewport_size} (#{browser_type})"
+      end
+
+      def device_name
+        if ios_device_info
+          return ios_device_info.device_name
+        elsif emulation_info
+          return emulation_info.device_name + ' (chrome emulation)'
+        end
+        'desktop'
       end
     end
   end

data/lib/applitools/selenium/visual_grid/render_info.rb

@@ -3,7 +3,7 @@ module Applitools
   module Selenium
     class RenderInfo
       include Applitools::Jsonable
-      json_fields :width, :height, :sizeMode, :emulationInfo, :region, :selector
+      json_fields :width, :height, :sizeMode, :emulationInfo, :region, :selector, :IosDeviceInfo
       # , :region, :emulationInfo
 
       def json_data
@@ -13,6 +13,7 @@ module Applitools
           sizeMode: size_mode
         }
         result['emulationInfo'] = json_value(emulation_info) if emulation_info
+        result['iosDeviceInfo'] = json_value(ios_device_info) if ios_device_info
         result['region'] = json_value(region) if size_mode == 'region'
         result['selector'] = json_value(region) if size_mode == 'selector'
         result

data/lib/applitools/selenium/visual_grid/render_request.rb

@@ -8,7 +8,7 @@ module Applitools
       json_fields :renderId, :webhook, :url, :dom, :resources, :scriptHooks,
         :selectorsToFindRegionsFor, :sendDom, :agentId
 
-      json_fields :renderInfo, :browser
+      json_fields :renderInfo, :browser, :platform
 
       def initialize(*args)
         options = Applitools::Utils.extract_options! args

data/lib/applitools/selenium/visual_grid/render_task.rb

@@ -248,7 +248,11 @@ module Applitools
             r.height = running_test.browser_info.viewport_size.height
             r.size_mode = size_mode
             r.region = region_to_check
-            r.emulation_info = running_test.browser_info.emulation_info if running_test.browser_info.emulation_info
+            if running_test.browser_info.respond_to?(:emulation_info) && running_test.browser_info.emulation_info
+              r.emulation_info = running_test.browser_info.emulation_info
+            elsif running_test.browser_info.respond_to?(:ios_device_info) && running_test.browser_info.ios_device_info
+              r.ios_device_info = running_test.browser_info.ios_device_info
+            end
           end
 
           requests << Applitools::Selenium::RenderRequest.new(
@@ -257,7 +261,8 @@ module Applitools
             dom: dom,
             resources: request_resources,
             render_info: r_info,
-            browser: { name: running_test.browser_info.browser_type, platform: running_test.browser_info.platform },
+            browser: { name: running_test.browser_info.browser_type },
+            platform: { name: running_test.browser_info.platform },
             script_hooks: script_hooks,
             selectors_to_find_regions_for: region_selectors,
             send_dom: if running_test.eyes.configuration.send_dom.nil?

data/lib/applitools/version.rb

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

data/lib/eyes_selenium.rb

@@ -20,8 +20,8 @@ end
 
 Applitools::Selenium.require_dir 'selenium/concerns'
 Applitools::Selenium.require_dir 'selenium/scripts'
-Applitools::Selenium.require_dir 'selenium/visual_grid'
 Applitools::Selenium.require_dir 'selenium'
+Applitools::Selenium.require_dir 'selenium/visual_grid'
 Applitools::Selenium.require_dir 'selenium/dom_capture'
 Applitools::Selenium.require_dir 'selenium/css_parser'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 3.17.0
+  version: 3.17.5
 platform: ruby
 authors:
 - Applitools Team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-18 00:00:00.000000000 Z
+date: 2020-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eyes_core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.17.0
+        version: 3.17.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.17.0
+        version: 3.17.5
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -150,8 +150,13 @@ files:
 - lib/applitools/selenium/viewport_screenshot.rb
 - lib/applitools/selenium/viewport_size.rb
 - lib/applitools/selenium/visual_grid/chrome_emulation_info.rb
+- lib/applitools/selenium/visual_grid/desktop_browser_info.rb
 - lib/applitools/selenium/visual_grid/emulation_base_info.rb
 - lib/applitools/selenium/visual_grid/eyes_connector.rb
+- lib/applitools/selenium/visual_grid/i_render_browser_info.rb
+- lib/applitools/selenium/visual_grid/ios_device_info.rb
+- lib/applitools/selenium/visual_grid/ios_device_name.rb
+- lib/applitools/selenium/visual_grid/ios_screen_orientation.rb
 - lib/applitools/selenium/visual_grid/render_browser_info.rb
 - lib/applitools/selenium/visual_grid/render_info.rb
 - lib/applitools/selenium/visual_grid/render_request.rb
@@ -173,7 +178,7 @@ homepage: https://www.applitools.com
 licenses:
 - Applitools
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -189,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.8
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Applitools Ruby Selenium SDK
 test_files: []