eyes_core 3.6.5 → 3.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ce8c72d9ec9b74d08d2043166edd0fef0c4b0d8
-  data.tar.gz: 2af38568fe334e350dd825bee647885c86d2a161
+  metadata.gz: d0af160a9d4c23132f0157a2f7c1f9c3e6ee5a70
+  data.tar.gz: b784261c4ab25b34cb427b86a5c5ed516c34db5b
 SHA512:
-  metadata.gz: d5d333ccc6d22588c916b6da27fb204ce7206df52fe0480207d1a54e91637a3edfcfc6bfc40e962fb1bf277ca5a0aa771de646089f8e997b67159cb5216758d7
-  data.tar.gz: b6d7879dd36ccfa121a7b7bdf4a0ae4db298063ca580e588da69657495fcb0fd36dd19e916d2e0c987b3077b9a6236dd37c430a6b4ac2ca93266049c6fdf51f9
+  metadata.gz: 3f071a1df3b3d861ab0d898f83c1d894efdb6a47e33c28b85424472f958bd6bc18b06cd226941fa93d70fa36dd7574533c8716b5f1903f1494b39ed2882f427d
+  data.tar.gz: 39f1310318b3ac8c2c8aae040c8f4ce12fd606944849580d7f1a566840e50fa71636ecb6c667dbefc1bdec37ac4fe573457ef2d004f467f3f36df08fb6ef4bc9

data/lib/applitools/connectivity/server_connector.rb

@@ -5,12 +5,9 @@ Oj.default_options = { :mode => :compat }
 require 'uri'
 
 module Applitools::Connectivity
-  module ServerConnector
-    extend self
-
+  class 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
 
@@ -26,6 +23,10 @@ module Applitools::Connectivity
     attr_reader :endpoint_url
     attr_reader :proxy
 
+    def initialize(url = nil)
+      self.server_url = url
+    end
+
     def server_url=(url)
       @server_url = url.nil? ? DEFAULT_SERVER_URL : url
       unless @server_url.is_a? String
@@ -53,7 +54,7 @@ module Applitools::Connectivity
       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...'
-      #Applitools::EyesLogger.debug json_data
+      # Applitools::EyesLogger.debug json_data
       res = post(URI.join(endpoint_url, session.id.to_s), content_type: 'application/octet-stream', body: body)
       raise Applitools::EyesError.new("Request failed: #{res.status} #{res.headers}") unless res.success?
       Applitools::MatchResult.new Oj.load(res.body)
@@ -139,7 +140,5 @@ module Applitools::Connectivity
         delay = [MAX_LONG_REQUEST_DELAY, (delay * LONG_REQUEST_DELAY_MULTIPLICATIVE_INCREASE_FACTOR).round].min
       end
     end
-
-    include Applitools::MethodTracer
   end
 end

data/lib/applitools/core/batch_info.rb

@@ -1,7 +1,8 @@
 require 'securerandom'
+
 module Applitools
   class BatchInfo
-    attr_accessor :name, :sterted_at, :id
+    attr_accessor :name, :started_at, :id
     def initialize(name = nil, started_at = Time.now)
       @name = name
       @started_at = started_at

data/lib/applitools/core/eyes_base.rb

@@ -22,7 +22,7 @@ module Applitools
     CONTEXT_RELATIVE = Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative].freeze
 
     def_delegators 'Applitools::EyesLogger', :logger, :log_handler, :log_handler=
-    def_delegators 'Applitools::Connectivity::ServerConnector', :api_key, :api_key=, :server_url, :server_url=,
+    def_delegators '@server_connector', :api_key, :api_key=, :server_url, :server_url=,
       :set_proxy, :proxy, :proxy=
 
     # @!attribute [rw] verbose_results
@@ -42,7 +42,7 @@ module Applitools
     abstract_method :get_viewport_size, true
 
     def initialize(server_url = nil)
-      Applitools::Connectivity::ServerConnector.server_url = server_url
+      self.server_connector = Applitools::Connectivity::ServerConnector.new(server_url)
       self.disabled = false
       @viewport_size = nil
       self.match_timeout = DEFAULT_MATCH_TIMEOUT
@@ -124,7 +124,7 @@ module Applitools
       end
 
       logger.info 'Aborting server session...'
-      Applitools::Connectivity::ServerConnector.stop_session(running_session, true, false)
+      server_connector.stop_session(running_session, true, false)
       logger.info '---Test aborted'
 
     rescue Applitools::EyesError => e
@@ -184,7 +184,10 @@ module Applitools
       raise Applitools::EyesError.new 'Eyes not open' unless open?
       Applitools::ArgumentGuard.not_nil region_provider, 'region_provider'
 
-      logger.info "check_window_base(#{region_provider}, #{match_window_data.tag}, #{match_window_data.ignore_mismatch}, #{retry_timeout})"
+      logger.info(
+        "check_window_base(#{region_provider}, #{match_window_data.tag}, #{match_window_data.ignore_mismatch}," \
+        " #{retry_timeout})"
+      )
 
       tag = '' if tag.nil?
 
@@ -196,16 +199,18 @@ module Applitools
           logger,
           running_session,
           match_timeout,
-          app_output_provider
+          app_output_provider,
+          server_connector
         )
       end
 
       logger.info 'Calling match_window...'
-      result = @match_window_task.match_window(match_window_data,
+      result = @match_window_task.match_window(
+        match_window_data,
         last_screenshot: last_screenshot,
         region_provider: region_provider,
         should_match_window_run_once_on_timeout: should_match_window_run_once_on_timeout,
-        retry_timeout: retry_timeout,
+        retry_timeout: retry_timeout
       )
       logger.info 'match_window done!'
 
@@ -232,7 +237,6 @@ module Applitools
       result
     end
 
-
     def check_single_base(region_provider, retry_timeout, match_window_data)
       if disabled?
         logger.info "#{__method__} Ignored"
@@ -244,7 +248,10 @@ module Applitools
       raise Applitools::EyesError.new 'Eyes not open' unless open?
       Applitools::ArgumentGuard.not_nil region_provider, 'region_provider'
 
-      logger.info "check_single_base(#{region_provider}, #{match_window_data.tag}, #{match_window_data.ignore_mismatch}, #{retry_timeout})"
+      logger.info(
+        "check_single_base(#{region_provider}, #{match_window_data.tag}, #{match_window_data.ignore_mismatch}," \
+        " #{retry_timeout})"
+      )
 
       tag = '' if tag.nil?
 
@@ -258,17 +265,19 @@ module Applitools
       match_window_data.update_baseline_if_new = save_new_tests
       match_window_data.update_baseline_if_different = save_failed_tests
       match_window_task = Applitools::MatchSingleTask.new(
-          logger,
-          match_timeout,
-          app_output_provider
+        logger,
+        match_timeout,
+        app_output_provider,
+        server_connector
       )
 
       logger.info 'Calling match_window...'
-      result = match_window_task.match_window(match_window_data,
-                                               last_screenshot: last_screenshot,
-                                               region_provider: region_provider,
-                                               should_match_window_run_once_on_timeout: should_match_window_run_once_on_timeout,
-                                               retry_timeout: retry_timeout,
+      result = match_window_task.match_window(
+        match_window_data,
+        last_screenshot: last_screenshot,
+        region_provider: region_provider,
+        should_match_window_run_once_on_timeout: should_match_window_run_once_on_timeout,
+        retry_timeout: retry_timeout
       ) do |match_results|
         results = match_results.original_results
         not_aborted = !results['isAborted']
@@ -336,7 +345,7 @@ module Applitools
 
       logger.info "Automatically save test? #{save}"
 
-      results = Applitools::Connectivity::ServerConnector.stop_session running_session, false, save
+      results = server_connector.stop_session running_session, false, save
 
       results.is_new = is_new_session
       results.url = session_results_url
@@ -370,7 +379,8 @@ module Applitools
     private
 
     attr_accessor :running_session, :last_screenshot, :current_app_name, :test_name, :session_type,
-      :scale_provider, :session_start_info, :should_match_window_run_once_on_timeout, :app_output_provider, :failed
+      :scale_provider, :session_start_info, :should_match_window_run_once_on_timeout, :app_output_provider,
+      :failed, :server_connector
 
     attr_reader :user_inputs
 
@@ -489,7 +499,7 @@ module Applitools
                                                 branch_name: branch_name, parent_branch_name: parent_branch_name
 
       logger.info 'Starting server session...'
-      self.running_session = Applitools::Connectivity::ServerConnector.start_session session_start_info
+      self.running_session = server_connector.start_session session_start_info
 
       logger.info "Server session ID is #{running_session.id}"
       test_info = "'#{test_name}' of '#{app_name}' #{app_env}"

data/lib/applitools/core/eyes_screenshot.rb

@@ -21,6 +21,13 @@ module Applitools
     abstract_method :location_in_screenshot, false
     abstract_method :intersected_region, false
 
+    def sub_screenshots(regions, coordinate_type)
+      Applitools::ArgumentGuard.is_a? regions, 'regions', Enumerable
+      regions.map do |region|
+        sub_screenshot(region, coordinate_type, false, true)
+      end
+    end
+
     def convert_region_location(region, from, to)
       Applitools::ArgumentGuard.not_nil region, 'region'
       Applitools::ArgumentGuard.is_a? region, 'region', Applitools::Region

data/lib/applitools/core/match_single_check_data.rb

@@ -4,59 +4,59 @@ module Applitools
     class << self
       def default_data
         {
-            'startInfo' => {
-              'agentId' => nil,
-              'appIdOrName' => nil,
-              'verId' => nil,
-              'scenarioIdOrName' => nil,
-              'batchInfo' => {},
-              'envName' => nil,
-              'environment' => {},
-              'defaultMatchSettings' => nil,
-              'branchName' => nil,
-              'parentBranchName' => nil
-            },
-            'IgnoreMismatch' => false,
-            'MismatchWait' => 0,
-            'Options' => {
-                'Name' => nil,
-                'UserInputs' => [],
-                'ImageMatchSettings' => {
-                    'MatchLevel' => 'None',
-                    'SplitTopHeight' => 0,
-                    'SplitBottomHeight' => 0,
-                    'IgnoreCaret' => false,
-                    'Ignore' => [],
-                    'Exact' => {
-                        'MinDiffIntensity' => 0,
-                        'MinDiffWidth' => 0,
-                        'MinDiffHeight' => 0,
-                        'MatchThreshold' => 0
-                    }
-                },
-                'IgnoreExpectedOutputSettings' => false,
-                'ForceMatch' => false,
-                'ForceMismatch' => false,
-                'IgnoreMatch' => false,
-                'IgnoreMismatch' => false,
-                'Trim' => {
-                    'Enabled' => false,
-                    'ForegroundIntensity' => 0,
-                    'MinEdgeLength' => 0
-                }
-            },
-            'Id' => nil,
+          'startInfo' => {
+            'agentId' => nil,
+            'appIdOrName' => nil,
+            'verId' => nil,
+            'scenarioIdOrName' => nil,
+            'batchInfo' => {},
+            'envName' => nil,
+            'environment' => {},
+            'defaultMatchSettings' => nil,
+            'branchName' => nil,
+            'parentBranchName' => nil
+          },
+          'IgnoreMismatch' => false,
+          'MismatchWait' => 0,
+          'Options' => {
+            'Name' => nil,
             'UserInputs' => [],
-            'AppOutput' => {
-                'Screenshot64' => nil,
-                'ScreenshotUrl' => nil,
-                'Title' => nil,
-                'IsPrimary' => false,
-                'Elapsed' => 0
+            'ImageMatchSettings' => {
+              'MatchLevel' => 'None',
+              'SplitTopHeight' => 0,
+              'SplitBottomHeight' => 0,
+              'IgnoreCaret' => false,
+              'Ignore' => [],
+              'Exact' => {
+                'MinDiffIntensity' => 0,
+                'MinDiffWidth' => 0,
+                'MinDiffHeight' => 0,
+                'MatchThreshold' => 0
+              }
             },
-            'Tag' => nil,
-            'updateBaselineIfDifferent' => false,
-            'updateBaselineIfNew' => false
+            'IgnoreExpectedOutputSettings' => false,
+            'ForceMatch' => false,
+            'ForceMismatch' => false,
+            'IgnoreMatch' => false,
+            'IgnoreMismatch' => false,
+            'Trim' => {
+              'Enabled' => false,
+              'ForegroundIntensity' => 0,
+              'MinEdgeLength' => 0
+            }
+          },
+          'Id' => nil,
+          'UserInputs' => [],
+          'AppOutput' => {
+            'Screenshot64' => nil,
+            'ScreenshotUrl' => nil,
+            'Title' => nil,
+            'IsPrimary' => false,
+            'Elapsed' => 0
+          },
+          'Tag' => nil,
+          'updateBaselineIfDifferent' => false,
+          'updateBaselineIfNew' => false
         }
       end
     end

data/lib/applitools/core/match_single_task.rb

@@ -2,15 +2,15 @@ require 'base64'
 require_relative 'match_window_task'
 module Applitools
   class MatchSingleTask < MatchWindowTask
-    def initialize(logger, retry_timeout, app_output_provider)
-      super(logger, 'nil', retry_timeout, app_output_provider)
+    def initialize(logger, retry_timeout, app_output_provider, server_connector)
+      super(logger, 'nil', retry_timeout, app_output_provider, server_connector)
     end
 
     private
 
     def perform_match(match_window_data)
       Applitools::ArgumentGuard.is_a? match_window_data, 'match_window_data', Applitools::MatchSingleCheckData
-      Applitools::Connectivity::ServerConnector.match_single_window match_window_data
+      server_connector.match_single_window match_window_data
     end
   end
 end

data/lib/applitools/core/match_window_data.rb

@@ -35,7 +35,7 @@ module Applitools
             'IgnoreMatch' => false,
             'IgnoreMismatch' => false,
             'Trim' => {
-              'Enabled' => false,
+              'Enabled' => false
             }
           },
           'Id' => nil,
@@ -51,11 +51,11 @@ module Applitools
         }
       end
 
-      def valid_region(r)
+      def valid_region(_r)
         true
       end
 
-      def valid_input(i)
+      def valid_input(_i)
         true
       end
     end
@@ -111,36 +111,32 @@ module Applitools
     end
 
     def read_target(target, driver)
-      #options
+      # options
       %w(trim).each do |field|
         send("#{field}=", target.options[field.to_sym])
       end
-      #ignored regions
+      # ignored regions
       target.ignored_regions.each do |r|
         case r
-          when Proc
-            region = r.call(driver)
-            @ignored_regions << Applitools::Region.from_location_size(region.location, region.size)
-            @need_convert_ignored_regions_coordinates = true
-          when Applitools::Region
-            @ignored_regions << r
-            @need_convert_ignored_regions_coordinates = true
+        when Proc
+          region = r.call(driver)
+          @ignored_regions << Applitools::Region.from_location_size(region.location, region.size)
+          @need_convert_ignored_regions_coordinates = true
+        when Applitools::Region
+          @ignored_regions << r
+          @need_convert_ignored_regions_coordinates = true
         end
       end
     end
 
     def ignore_mismatch
-     current_data['IgnoreMismatch']
+      current_data['IgnoreMismatch']
     end
 
     def tag
       current_data['Tag']
     end
 
-    def screenshot
-      app_output.screenshot.image.to_blob
-    end
-
     def trim=(value)
       current_data['Options']['Trim']['Enabled'] = value ? true : false
     end
@@ -154,7 +150,9 @@ module Applitools
     end
 
     def to_hash
-      raise Applitools::EyesError.new 'You should convert coordinates for ignored_regions!' if @need_convert_ignored_regions_coordinates
+      raise Applitools::EyesError.new(
+        'You should convert coordinates for ignored_regions!'
+      ) if @need_convert_ignored_regions_coordinates
       current_data.dup
     end
 

data/lib/applitools/core/match_window_task.rb

@@ -6,12 +6,14 @@ module Applitools
 
     attr_reader :logger, :running_session, :default_retry_timeout, :app_output_provider
 
-    def initialize(logger, running_session, retry_timeout, app_output_provider)
+    def initialize(logger, running_session, retry_timeout, app_output_provider, server_connector)
+      Applitools::ArgumentGuard.is_a? server_connector, 'server_connector', Applitools::Connectivity::ServerConnector
       @logger = logger
       @running_session = running_session
       # @driver = driver
       @default_retry_timeout = retry_timeout
       @app_output_provider = app_output_provider
+      self.server_connector = server_connector
 
       ArgumentGuard.not_nil logger, 'logger'
       ArgumentGuard.not_nil running_session, 'running_session'
@@ -50,11 +52,11 @@ module Applitools
         match_result = perform_match(match_window_data)
         retry_time = Time.now - start
 
-        if block_given?
-          block_retry = yield(match_result)
-        else
-          block_retry = false
-        end
+        block_retry = if block_given?
+                        yield(match_result)
+                      else
+                        false
+                      end
 
         while retry_time < retry_timeout && !(block_retry || match_result.as_expected?)
           sleep MATCH_INTERVAL
@@ -83,9 +85,11 @@ module Applitools
 
     private
 
+    attr_accessor :server_connector
+
     def perform_match(match_window_data)
       Applitools::ArgumentGuard.is_a? match_window_data, 'match_window_data', Applitools::MatchWindowData
-      Applitools::Connectivity::ServerConnector.match_window running_session, match_window_data
+      server_connector.match_window running_session, match_window_data
     end
   end
 end

data/lib/applitools/eyes_logger.rb

@@ -14,7 +14,7 @@ module Applitools::EyesLogger
   def self.add_thread_id_to_log_handler!(log_handler)
     original_formatter = Logger::Formatter.new
     log_handler.formatter = proc do |severity, datetime, progname, msg|
-      updated_progname = "#{progname.to_s} (#{Thread.current.object_id.to_s})"
+      updated_progname = "#{progname} (#{Thread.current.object_id})"
       original_formatter.call(severity, datetime, updated_progname, msg.dump)
     end
   end

data/lib/applitools/images/eyes.rb

@@ -97,9 +97,9 @@ module Applitools::Images
       self.screenshot = EyesImagesScreenshot.new image
 
       mr = check_single_base(
-          region_provider,
-          target.options[:timeout] || Applitools::EyesBase::USE_DEFAULT_TIMEOUT,
-          match_window_data
+        region_provider,
+        target.options[:timeout] || Applitools::EyesBase::USE_DEFAULT_TIMEOUT,
+        match_window_data
       )
       mr
     end

data/lib/applitools/images/eyes_images_screenshot.rb

@@ -73,13 +73,14 @@ module Applitools::Images
       convert_location location, CONTEXT_RELATIVE, SCREENSHOT_AS_IS
     end
 
-    def sub_screenshot(region, coordinates_type, throw_if_clipped)
+    def sub_screenshot(region, coordinates_type, throw_if_clipped = false, force_nil_if_clipped = false)
       Applitools::ArgumentGuard.not_nil region, 'region'
       Applitools::ArgumentGuard.not_nil coordinates_type, 'coordinates_type'
 
       sub_screen_region = intersected_region region, coordinates_type, SCREENSHOT_AS_IS
 
       if sub_screen_region.empty? || (throw_if_clipped && !region.size_equals?(sub_screen_region))
+        return nil if force_nil_if_clipped
         Applitools::OutOfBoundsException.new "Region #{sub_screen_region} (#{coordinates_type}) is out of " \
           " screenshot bounds #{bounds}"
       end

data/lib/applitools/version.rb

@@ -1,3 +1,3 @@
 module Applitools
-  VERSION = '3.6.5'.freeze
+  VERSION = '3.6.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_core
 version: !ruby/object:Gem::Version
-  version: 3.6.5
+  version: 3.6.6
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-09 00:00:00.000000000 Z
+date: 2017-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oily_png
@@ -270,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Applitools Ruby SDK