eyes_core 3.14.10 → 3.15.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4624958021d0ecf5c443a0a9df7edc84158b2bf26b1caf920ccda6e19776f85
-  data.tar.gz: 3494e2526ef93192d57c1604074fc497c668a6e140c0727650d76ec4d0043de2
+  metadata.gz: 1f5d2900e70b58643ee591bbef57b92a65fc2baf0e6756a4389a3200692a9520
+  data.tar.gz: 5323d53289f538a047d270b03d5c197c1e6d4935ab4e16e2697750dc26096bee
 SHA512:
-  metadata.gz: 215fc9a1362141e7241ef3460be3e376d75d21b2fa660d43a454fe42149f1389fd8a49499b9fa8e2ca5dbc66ff397859d23c6553680673733ade5868b8a3f99a
-  data.tar.gz: abde370aea21b82fe2a5da16a2cb1e7478c6c6737b0e9ded6342052b9201fcff136a69aab73f517dbae55f00aaaf10e5ab28831b06dc692029a09e4d01ae02fb
+  metadata.gz: 93eefa109d311ce4330400a4f37d545621c27fbf4e169f9b26a60ef10d59031fa634a8a370192fafdada8e75ab4e5587c68bab86c2c4ccf7e452c01881644500
+  data.tar.gz: cc276d91d1944b62ca602ecd3d64a74b18826e3df1afc9a6d12fe35094ee382e72ab35081f9f8e3990f203336ce544e69fb7f7a62adee2a7485411a87d50d89b

data/lib/applitools/connectivity/server_connector.rb

@@ -13,9 +13,15 @@ module Applitools::Connectivity
 
     SSL_CERT = File.join(File.dirname(File.expand_path(__FILE__)), '../../../certs/cacert.pem').to_s.freeze
     DEFAULT_TIMEOUT = 300
+    API_SESSIONS = '/api/sessions'.freeze
+    API_SESSIONS_RUNNING = API_SESSIONS + '/running/'.freeze
+    API_SINGLE_TEST = API_SESSIONS + '/'.freeze
 
-    API_SESSIONS_RUNNING = '/api/sessions/running/'.freeze
-    API_SINGLE_TEST = '/api/sessions/'.freeze
+    RENDER_INFO_PATH = API_SESSIONS + "/renderinfo".freeze
+    RENDER = '/render'.freeze
+
+    RESOURCES_SHA_256 = '/resources/sha256/'.freeze
+    RENDER_STATUS = '/render-status'.freeze
 
     HTTP_STATUS_CODES = {
       created: 201,
@@ -33,6 +39,83 @@ module Applitools::Connectivity
       self.server_url = url
     end
 
+    def rendering_info
+      response = get(server_url + RENDER_INFO_PATH, content_type: 'application/json')
+      raise Applitools::EyesError, 'Error getting render info' unless response.status == HTTP_STATUS_CODES[:ok]
+      Oj.load response.body
+    end
+
+    def render(service_url, access_key, requests)
+      uri = URI(service_url)
+      uri.path = RENDER
+      response = dummy_post(
+        uri,
+        body: requests.json,
+        headers: {
+          'X-Auth-Token' => access_key
+        },
+        timeout: 10
+      )
+      raise Applitools::EyesError, "Error render processing (#{response.status}, #{response.body})" unless response.status == HTTP_STATUS_CODES[:ok]
+      Oj.load response.body
+    end
+
+    def render_put_resource(service_url, access_key, resource, render)
+      uri = URI(service_url)
+      uri.path = RESOURCES_SHA_256 + resource.hash
+      Applitools::EyesLogger.debug("PUT resource: #{uri}")
+      # Applitools::EyesLogger.debug("Resource content: #{resource.content}")
+      response = dummy_put(
+        uri,
+        body: resource.content,
+        content_type: resource.content_type,
+        headers: {
+          'X-Auth-Token' => access_key
+        },
+        query: {'render-id' => render['renderId']}
+      )
+      raise Applitools::EyesError, "Error putting resource: #{response.status}, #{response.body}" unless response.status == HTTP_STATUS_CODES[:ok]
+      resource.hash
+    end
+
+    def render_status_by_id(service_url, access_key, running_renders_json)
+      uri = URI(service_url)
+      uri.path = RENDER_STATUS
+      response = dummy_post(
+        uri,
+        body: running_renders_json,
+        content_type: 'application/json',
+        headers: {
+            'X-Auth-Token' => access_key
+        },
+        timeout: 2
+      )
+      raise Applitools::EyesError, "Error getting server status, #{response.status} #{response.body}" unless response.status == HTTP_STATUS_CODES[:ok]
+      Oj.load(response.body)
+    end
+
+    def download_resource(url)
+      Applitools::EyesLogger.debug "Fetching #{url}..."
+      resp_proc = proc do |u|
+        Faraday::Connection.new(
+          u,
+          ssl: { ca_file: SSL_CERT },
+          proxy: @proxy.nil? ? nil : @proxy.to_hash
+        ).send(:get) do |req|
+          req.options.timeout = DEFAULT_TIMEOUT
+          req.headers['Accept-Encoding'] = 'identity'
+        end
+      end
+      response = resp_proc.call(url)
+      redirect_count = 10
+      while response.status == 301 && redirect_count > 0 do
+        redirect_count -= 1
+        response = resp_proc.call(response.headers['location'])
+      end
+      Applitools::EyesLogger.debug 'Done!'
+      response
+    end
+
     def server_url=(url)
       @server_url = url.nil? ? DEFAULT_SERVER_URL : url
       unless @server_url.is_a? String
@@ -63,6 +146,7 @@ module Applitools::Connectivity
       # Applitools::EyesLogger.debug json_data
       res = long_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?
+      # puts Oj.load(res.body)
       Applitools::MatchResult.new Oj.load(res.body)
     end
 
@@ -125,7 +209,7 @@ module Applitools::Connectivity
     end
 
     def post_dom_json(dom_data)
-      Applitools::EyesLogger.debug 'About to send captured DOM...'
+      # Applitools::EyesLogger.debug 'About to send captured DOM...'
       request_body = Oj.dump(dom_data)
       # Applitools::EyesLogger.debug request_body
       processed_request_body = yield(request_body) if block_given?
@@ -153,11 +237,15 @@ module Applitools::Connectivity
     MAX_LONG_REQUEST_DELAY = 10 # seconds
     LONG_REQUEST_DELAY_MULTIPLICATIVE_INCREASE_FACTOR = 1.5
 
-    [:get, :post, :delete].each do |method|
+    [:get, :post, :delete, :put].each do |method|
       define_method method do |url, options = {}|
         request(url, method, options)
       end
 
+      define_method "dummy_#{method}" do |url, options = {}|
+        dummy_request(url, method, options)
+      end
+
       define_method "long_#{method}" do |url, options = {}, request_delay = LONG_REQUEST_DELAY|
         long_request(url, method, request_delay, options)
       end
@@ -181,6 +269,7 @@ module Applitools::Connectivity
         url,
         ssl: { ca_file: SSL_CERT },
         proxy: @proxy.nil? ? nil : @proxy.to_hash
+        # proxy: Applitools::Connectivity::Proxy.new('http://localhost:8000').to_hash
       ).send(method) do |req|
         req.options.timeout = DEFAULT_TIMEOUT
         req.headers = DEFAULT_HEADERS.merge(options[:headers] || {})
@@ -190,6 +279,21 @@ module Applitools::Connectivity
       end
     end
 
+    def dummy_request(url, method, options = {})
+      Faraday::Connection.new(
+          url,
+          ssl: { ca_file: SSL_CERT },
+          proxy: @proxy.nil? ? nil : @proxy.to_hash
+          # proxy: Applitools::Connectivity::Proxy.new('http://localhost:8000').to_hash
+      ).send(method) do |req|
+        req.options.timeout = 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 = options[:query] || {}
+        req.body = options[:body]
+      end
+    end
+
     def long_request(url, method, request_delay, options = {})
       delay = request_delay
       options = { headers: {
@@ -231,3 +335,103 @@ module Applitools::Connectivity
     end
   end
 end
+
+#
+# /**
+#      *
+#      * @return The server timeout. (Seconds).
+#      */
+# int getTimeout();
+#
+#
+# /**
+#      * Deletes the given test result
+#      *
+#      * @param testResults The session to delete by test results.
+#      * @throws EyesException the exception is being thrown when deleteSession failed
+#      */
+# void deleteSession(TestResults testResults);
+#
+#
+# /**
+#      * Downloads string from a given Url
+#      *
+#      * @param uri The URI from which the IServerConnector will download the string
+#      * @param isSecondRetry Indicates if a retry is mandatory onFailed - 2 retries per request
+#      * @param listener the listener will be called when the request will be resolved.
+#      */
+# void downloadString(URL uri, boolean isSecondRetry, IDownloadListener<String> listener);
+#
+# /**
+#      * Downloads string from a given Url.
+#      *
+#      * @param uri The URI from which the IServerConnector will download the string
+#      * @param isSecondRetry Indicates if a retry is mandatory onFailed - 2 retries per request
+#      * @param listener the listener will be called when the request will be resolved.
+#      * @return A future which will be resolved when the resources is downloaded.
+#      */
+# IResourceFuture downloadResource(URL uri, boolean isSecondRetry, IDownloadListener<Byte[]> listener);
+#
+#
+# /**
+#      * Posting the DOM snapshot to the server and returns
+#      * @param domJson JSON as String.
+#      * @return URL to the JSON that is stored by the server.
+#      */
+# String postDomSnapshot(String domJson);
+#
+#
+# /**
+#      * @return the render info from the server to be used later on.
+#      */
+# RenderingInfo getRenderInfo();
+#
+# /**
+#      * Initiate a rendering using RenderingGrid API
+#      *
+#      * @param renderRequests renderRequest The current agent's running session.
+#      * @return {@code List<RunningRender>} The results of the render request
+#      */
+# List<RunningRender> render(RenderRequest... renderRequests);
+#
+# /**
+#      * Check if resource exists on the server
+#      *
+#      * @param runningRender The running render (for second request only)
+#      * @param resource The resource to use
+#      * @return Whether resource exists on the server or not
+#      */
+# boolean renderCheckResource(RunningRender runningRender, RGridResource resource);
+#
+# /**
+#      * Upload resource to the server
+#      *
+#      * @param runningRender The running render (for second request only)
+#      * @param resource The resource to upload
+#      * @param listener The callback wrapper for the upload result.
+#      * @return true if resource was uploaded
+#      */
+# PutFuture renderPutResource(RunningRender runningRender, RGridResource resource, IResourceUploadListener listener);
+#
+# /**
+#      * Get the rendering status for current render
+#      *
+#      * @param runningRender The running render
+#      * @return RenderStatusResults The render's status
+#      */
+# RenderStatusResults renderStatus(RunningRender runningRender);
+#
+# /**
+#      * Get the rendering status for current render
+#      *
+#      * @param renderIds The running renderId
+#      * @return The render's status
+#      */
+# List<RenderStatusResults> renderStatusById(String... renderIds);
+#
+# IResourceFuture createResourceFuture(RGridResource gridResource);
+#
+# void setRenderingInfo(RenderingInfo renderInfo);
+
+
+

data/lib/applitools/core/abstract_configuration.rb

@@ -0,0 +1,16 @@
+module Applitools
+  class AbstractConfiguration
+    attr_reader :config_hash
+    attr_accessor :validation_errors
+    extend Applitools::Concerns::EyesConfigurationDSL
+
+    def initialize
+      @config_hash = {}
+      self.validation_errors = {}
+      default_config = self.class.default_config
+      default_config.keys.each do |k|
+        send "#{k}=", default_config[k]
+      end
+    end
+  end
+end

data/lib/applitools/core/app_output.rb

@@ -3,7 +3,8 @@
 module Applitools
   class AppOutput
     attr_reader :title, :screenshot64, :location
-    attr_accessor :dom_url
+
+    attr_accessor :dom_url, :screenshot_url
 
     def initialize(title, screenshot64)
       @title = title
@@ -20,7 +21,8 @@ module Applitools
       result = {
         Title: title,
         Screenshot64: nil,
-        Location: location.to_hash
+        Location: location.to_hash,
+        ScreenshotUrl: screenshot_url
       }
       result[:DomUrl] = dom_url if dom_url
       result

data/lib/applitools/core/app_output_with_screenshot.rb

@@ -4,11 +4,11 @@ module Applitools
   class AppOutputWithScreenshot
     attr_reader :app_output, :screenshot
 
-    def initialize(app_output, screenshot)
+    def initialize(app_output, screenshot, allow_empty_screenshot = false)
       raise Applitools::EyesIllegalArgument.new 'app_output is not kind of Applitools::AppOutput' unless
           app_output.is_a? Applitools::AppOutput
       raise Applitools::EyesIllegalArgument.new 'screenshot is not kind of Applitools::EyesScreenshot' unless
-          screenshot.is_a? Applitools::EyesScreenshot
+          allow_empty_screenshot || screenshot.is_a?(Applitools::EyesScreenshot)
       @app_output = app_output
       @screenshot = screenshot
     end

data/lib/applitools/core/concerns/eyes_configuration_dsl.rb

@@ -0,0 +1,189 @@
+module Applitools
+  module Concerns
+    module EyesConfigurationDSL
+      def methods_to_delegate
+        @methods_to_delegate ||= []
+      end
+
+      def accessor_methods
+        @accessor_methods ||= []
+      end
+
+      def collect_method(field_name)
+        accessor_methods.push field_name.to_sym
+        methods_to_delegate.push field_name.to_sym
+        methods_to_delegate.push "#{field_name}=".to_sym
+      end
+
+      def boolean_field(field_name)
+        collect_method field_name
+        define_method(field_name) do
+          return true if config_hash[field_name]
+          false
+        end
+
+        define_method("#{field_name}=") do |*args|
+          value = args.shift
+          if value
+            config_hash[field_name] = true
+          else
+            config_hash[field_name] = false
+          end
+        end
+
+        define_method("defined_#{field_name}?") do
+          true
+        end
+      end
+
+      def string_field(field_name)
+        collect_method field_name
+        define_method(field_name) do
+          return '' unless config_hash[field_name.to_sym].is_a? String
+          config_hash[field_name.to_sym]
+        end
+
+        define_method("#{field_name}=") do |*args|
+          value = args.shift
+          raise Applitools::EyesIllegalArgument, "Expected #{field_name} to be a String but got #{value.class} instead" unless value.is_a? String
+          config_hash[field_name.to_sym] = value.freeze
+        end
+
+        define_method("defined_#{field_name}?") do
+          !send(field_name).empty?
+        end
+      end
+
+      # def rectangle_size_field(field_name)
+      #   collect_method field_name
+      #   define_method(field_name) do
+      #     return Applitools::RectangleSize.from_hash(width: 0, height: 0) unless config_hash[field_name.to_sym].is_a? Applitools::RectangleSize
+      #     config_hash[field_name.to_sym]
+      #   end
+      #
+      #   define_method("#{field_name}=") do |*args|
+      #     value = args.shift
+      #     raise Applitools::EyesIllegalArgument, "Expected #{field_name} to be an Applitools::RectangleClass but got #{value.class} instead" unless value.is_a? Applitools::RectangleSize
+      #     config_hash[field_name.to_sym] = value
+      #   end
+      #
+      #   define_method("defined_#{field_name}?") do
+      #     send(field_name).square > 0
+      #   end
+      # end
+
+      # def batch_info_field(field_name)
+      #   collect_method field_name
+      #   define_method(field_name) do
+      #     config_hash[field_name.to_sym]
+      #   end
+      #
+      #   define_method("#{field_name}=") do |*args|
+      #     value = args.shift
+      #     raise(
+      #       Applitools::EyesIllegalArgument,
+      #       "Expected Applitools::BatchInfo but got #{value.class}"
+      #     ) unless value.is_a? Applitools::BatchInfo
+      #     config_hash[field_name.to_sym] = value
+      #   end
+      #
+      #   define_method("defined_#{field_name}?") do
+      #     value = send(field_name)
+      #     value.is_a? Applitools::BatchInfo
+      #   end
+      # end
+
+      def object_field(field_name, klass)
+        collect_method field_name
+        define_method(field_name) do
+          config_hash[field_name.to_sym]
+        end
+        define_method("#{field_name}=") do |*args|
+          value = args.shift
+          raise(
+              Applitools::EyesIllegalArgument,
+              "Expected #{klass} but got #{value.class}"
+          ) unless value.is_a? klass
+          config_hash[field_name.to_sym] = value
+        end
+        define_method("defined_#{field_name}?") do
+          value = send(field_name)
+          value.is_a? klass
+        end
+      end
+
+      def int_field(field_name)
+        collect_method(field_name)
+        define_method(field_name) do
+          config_hash[field_name.to_sym]
+          # value =
+          # return value if value.is_a? Integer
+          # 0
+        end
+
+        define_method("#{field_name}=") do |*args|
+          value = args.shift
+          return config_hash[field_name.to_sym] = value if value.is_a? Integer
+          return config_hash[field_name.to_sym] = value.to_i if value.respond_to? :to_i
+          raise Applitools::EyesIllegalArgument, "Expected #{field_name} to be an Integer"
+        end
+
+        define_method("defined_#{field_name}?") do
+          value = send(field_name)
+          value.is_a? Integer
+        end
+      end
+
+      def enum_field(field_name, available_values_array)
+        collect_method(field_name)
+
+        define_method(field_name) do
+          config_hash[field_name.to_sym]
+        end
+
+        define_method("#{field_name}=") do |*args|
+          value = args.shift
+          raise(
+              Applitools::EyesIllegalArgument,
+              "Unknown #{field_name} #{value}. Allowed session types: " \
+              "#{available_values_array.join(', ')}"
+          ) unless available_values_array.include? value
+          config_hash[field_name.to_sym] = value
+        end
+
+        define_method("defined_#{field_name}?") do
+          available_values_array.include? send(field_name)
+        end
+      end
+
+      # def stitch_mode_field(field_name)
+      #   collect_method field_name
+      #   define_method(field_name) do
+      #     config_hash[field_name.to_sym]
+      #   end
+      #
+      #   define_method("#{field_name}=") do |*args|
+      #     value = args.shift
+      #     raise(
+      #         Applitools::EyesIllegalArgument,
+      #         "Unknown stitch mode #{value}. Allowed session types: " \
+      #         "#{Applitools::Selenium::Concerns::StitchModes::CSS}, " \
+      #         "#{Applitools::Selenium::Concerns::StitchModes::SCROLL}"
+      #     ) unless
+      #         [
+      #             Applitools::Selenium::Concerns::StitchModes::CSS,
+      #             Applitools::Selenium::Concerns::StitchModes::SCROLL
+      #         ].include? value
+      #     config_hash[field_name.to_sym] = value
+      #   end
+      #
+      #   define_method("defined_#{field_name}?") do
+      #     [
+      #         Applitools::Concerns::SessionTypes::SEQUENTIAL,
+      #         Applitools::Concerns::SessionTypes::PROGRESSION
+      #     ].include? config_hash[field_name.to_sym]
+      #   end
+      # end
+    end
+  end
+end

data/lib/applitools/core/concerns/jsonable.rb

@@ -0,0 +1,60 @@
+require 'oj'
+module Applitools
+  module Jsonable
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do
+        class << self
+          attr_accessor :json_methods
+        end
+        @json_methods = {}
+      end
+    end
+
+    module ClassMethods
+      def json_field(*args)
+        options = Applitools::Utils.extract_options!(args)
+        field = args.first.to_sym
+        options = { method: field }.merge! options
+        json_methods[field] = options[:method]
+        if options[:method].to_sym == field
+          attr_accessor field
+          ruby_style_field = Applitools::Utils.underscore(field.to_s)
+          unless field.to_s == ruby_style_field
+            define_method(ruby_style_field) do
+              send(field)
+            end
+            define_method("#{ruby_style_field}=") do |v|
+              send("#{field}=", v)
+            end
+          end
+        end
+      end
+
+      def json_fields(*args)
+        args.each { |m| json_field m }
+      end
+    end
+
+    def json_data
+      self.class.json_methods.sort.map {|k,v| [k, json_value(send(v))]}.to_h
+    end
+
+    def json
+      Oj.dump json_data
+    end
+
+    private
+
+    def json_value(value)
+      case value
+      when Hash
+        value.map { |k,v| [k, json_value(v)] }.sort {|a,b| a.first.to_s <=> b.first.to_s}.to_h
+      when Array
+        value.map { |el| json_value(el) }
+      else
+        value.respond_to?(:json_data) ? value.json_data : value
+      end
+    end
+  end
+end

data/lib/applitools/core/concerns/session_types.rb

@@ -0,0 +1,13 @@
+module Applitools
+  module Concerns
+    module SessionTypes
+      extend self
+      SEQUENTIAL = 'SEQUENTIAL'
+      PROGRESSION = 'PROGRESSION'
+
+      def enum_values
+        [SEQUENTIAL, PROGRESSION]
+      end
+    end
+  end
+end

data/lib/applitools/core/eyes_base.rb

@@ -2,6 +2,7 @@
 
 require 'applitools/core/helpers'
 require 'applitools/core/eyes_screenshot'
+require 'applitools/core/eyes_base_configuration'
 require 'zlib'
 
 require_relative 'match_level_setter'
@@ -27,6 +28,8 @@ module Applitools
     SCREENSHOT_AS_IS = Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is].freeze
     CONTEXT_RELATIVE = Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative].freeze
 
+    attr_accessor :config
+
     def_delegators 'Applitools::EyesLogger', :logger, :log_handler, :log_handler=
     def_delegators 'server_connector', :api_key, :api_key=, :server_url, :server_url=,
       :set_proxy, :proxy, :proxy=
@@ -36,11 +39,15 @@ module Applitools
     #   Default value is false.
     #   @return [boolean] verbose_results flag
 
-    attr_accessor :app_name, :batch, :agent_id, :full_agent_id,
+
+    # attr_accessor :agent_id, :session_type, :app_name, :test_name,
+
+
+    attr_accessor :batch, :full_agent_id,
       :match_timeout, :save_new_tests, :save_failed_tests, :failure_reports, :default_match_settings, :cut_provider,
       :scale_ratio, :host_os, :host_app, :position_provider, :viewport_size, :verbose_results,
       :inferred_environment, :remove_session_if_matching, :server_scale, :server_remainder, :match_level, :exact,
-      :compare_with_parent_branch
+      :compare_with_parent_branch, :results
 
     abstract_attr_accessor :base_agent_id
     abstract_method :capture_screenshot, true
@@ -48,12 +55,15 @@ module Applitools
     abstract_method :set_viewport_size, true
     abstract_method :get_viewport_size, true
 
-    environment_attribute :branch_name, 'APPLITOOLS_BRANCH'
-    environment_attribute :parent_branch_name, 'APPLITOOLS_PARENT_BRANCH'
-    environment_attribute :baseline_env_name, 'APPLITOOLS_BASELINE_BRANCH'
+    # environment_attribute :branch_name, 'APPLITOOLS_BRANCH'
+    # environment_attribute :parent_branch_name, 'APPLITOOLS_PARENT_BRANCH'
+    # environment_attribute :baseline_env_name, 'APPLITOOLS_BASELINE_BRANCH'
+
+    def_delegators 'config', *Applitools::EyesBaseConfiguration.methods_to_delegate
 
     def initialize(server_url = nil)
       self.server_connector = Applitools::Connectivity::ServerConnector.new(server_url)
+      ensure_config
       self.disabled = false
       @viewport_size = nil
       self.match_timeout = DEFAULT_MATCH_TIMEOUT
@@ -61,12 +71,13 @@ module Applitools
       self.save_new_tests = true
       self.save_failed_tests = false
       self.remove_session_if_matching = false
-      self.agent_id = nil
+      # self.agent_id = nil
       self.last_screenshot = nil
       @user_inputs = UserInputArray.new
       self.app_output_provider = Object.new
       self.verbose_results = false
       self.failed = false
+      self.results = []
       @inferred_environment = nil
       @properties = []
       @server_scale = 0
@@ -86,6 +97,10 @@ module Applitools
       self.compare_with_parent_branch = false
     end
 
+    def ensure_config
+      self.config = Applitools::EyesBaseConfiguration.new
+    end
+
     def match_level=(value)
       return @match_level = value if Applitools::MATCH_LEVEL.values.include?(value)
       return @match_level = Applitools::MATCH_LEVEL[value.to_sym] if Applitools::MATCH_LEVEL.keys.include?(value.to_sym)
@@ -173,10 +188,6 @@ module Applitools
       running_session && running_session.new_session?
     end
 
-    def app_name
-      !current_app_name.nil? && !current_app_name.empty? ? current_app_name : @app_name
-    end
-
     def add_property(name, value)
       @properties << { name: name, value: value }
     end
@@ -207,7 +218,8 @@ module Applitools
       self.running_session = nil
     end
 
-    def open_base(options)
+    def open_base(options = {})
+      self.results = []
       if disabled?
         logger.info "#{__method__} Ignored"
         return false
@@ -218,29 +230,17 @@ module Applitools
         raise Applitools::EyesError.new 'A test is already running'
       end
 
-      Applitools::ArgumentGuard.hash options, 'open_base parameter', [:test_name]
-      default_options = { session_type: 'SEQUENTIAL' }
-      options = default_options.merge options
+      update_config_from_options(options)
 
-      if app_name.nil?
-        Applitools::ArgumentGuard.not_nil options[:app_name], 'options[:app_name]'
-        self.current_app_name = options[:app_name]
-      else
-        self.current_app_name = app_name
-      end
+      raise Applitools::EyesIllegalArgument, config.validation_errors.values.join('/n') unless config.valid?
 
-      Applitools::ArgumentGuard.not_nil options[:test_name], 'options[:test_name]'
-      self.test_name = options[:test_name]
       logger.info "Agent = #{full_agent_id}"
-      logger.info "openBase(app_name: #{options[:app_name]}, test_name: #{options[:test_name]}," \
-          " viewport_size: #{options[:viewport_size]})"
+      logger.info "openBase(app_name: #{app_name}, test_name: #{test_name}," \
+          " viewport_size: #{viewport_size.to_s})"
 
       raise Applitools::EyesError.new 'API key is missing! Please set it using api_key=' if
         api_key.nil? || (api_key && api_key.empty?)
 
-      self.viewport_size = options[:viewport_size]
-      self.session_type = options[:session_type]
-
       yield if block_given?
 
       self.open = true
@@ -249,6 +249,26 @@ module Applitools
       raise e
     end
 
+    def update_config_from_options(options)
+      # Applitools::ArgumentGuard.hash options, 'open_base parameter', [:test_name]
+      default_options = { session_type: 'SEQUENTIAL' }
+      options = default_options.merge options
+
+      if app_name && app_name.empty?
+        # Applitools::ArgumentGuard.not_nil options[:app_name], 'options[:app_name]'
+        self.app_name = options[:app_name] if options[:app_name]
+      end
+
+      # Applitools::ArgumentGuard.not_nil options[:test_name], 'options[:test_name]'
+      self.test_name = options[:test_name] if options[:test_name]
+      self.viewport_size = options[:viewport_size] if options[:viewport_size]
+      self.session_type = options[:session_type] if options[:session_type]
+    end
+
+    def merge_config(other_config)
+      config.merge(other_config)
+    end
+
     def ensure_running_session
       return if running_session
 
@@ -464,20 +484,24 @@ module Applitools
       end
 
       logger.info '--- Test passed'
+      self.results.push results
       return results
     ensure
       self.running_session = nil
-      self.current_app_name = nil
+      self.app_name = ''
     end
 
     def compare_with_parent_branch=(value)
       @compare_with_parent_branch = value ? true : false
     end
 
+    # def rendering_info
+    #   server_connector.rendering_info
+    # end
+    #
     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,
+    attr_accessor :running_session, :last_screenshot, :scale_provider, :session_start_info, :should_match_window_run_once_on_timeout, :app_output_provider,
       :failed, :server_connector
 
     attr_reader :user_inputs, :properties
@@ -500,7 +524,7 @@ module Applitools
 
     def app_environment
       Applitools::AppEnvironment.new os: host_os, hosting_app: host_app,
-          display_size: @viewport_size, inferred: inferred_environment
+          display_size: viewport_size, inferred: inferred_environment
     end
 
     def open=(value)
@@ -666,6 +690,7 @@ module Applitools
         Applitools::AppOutput.new(a_title, compress_result).tap do |o|
           o.location = region.location unless region.empty?
           o.dom_url = dom_url unless dom_url && dom_url.empty?
+          o.screenshot_url = screenshot_url if respond_to?(:screenshot_url) && !screenshot_url.nil?
         end,
         screenshot
       )

data/lib/applitools/core/eyes_base_configuration.rb

@@ -0,0 +1,75 @@
+require 'applitools/core/rectangle_size'
+require 'applitools/core/concerns/session_types'
+require 'applitools/core/batch_info'
+
+module Applitools
+  class EyesBaseConfiguration < AbstractConfiguration
+    DEFAULT_CONFIG = {
+      branch_name: ENV['APPLITOOLS_BRANCH'] || '',
+      parent_branch_name: ENV['APPLITOOLS_PARENT_BRANCH'] || '',
+      baseline_branch_name: ENV['APPLITOOLS_BASELINE_BRANCH'] || '',
+      save_diffs: false
+    }.freeze
+
+    class << self
+      def default_config
+        DEFAULT_CONFIG
+      end
+    end
+
+    def initialize
+      super
+      self.batch_info = Applitools::BatchInfo.new
+    end
+
+    def merge(other_config)
+      return if self.object_id == other_config.object_id
+      (config_keys + other_config. config_keys).uniq do |k|
+        merge_key(other_config, k)
+      end
+    end
+
+    def merge_key(other_config, key)
+      return unless other_config.send("defined_#{key}?")
+      return unless self.respond_to? "#{key}="
+      self.send("#{key}=", other_config.send(key))
+    end
+
+    def config_keys
+      config_hash.keys
+    end
+
+    def to_s
+      config_keys.map do |k|
+        "#{k} = #{send(k)}"
+      end.join("\n")
+    end
+
+    def valid?
+      validation_errors.clear
+      validation_errors[:app_name] = ':app_name is required' if app_name.empty?
+      validation_errors[:test_name] = ':test_name is required' if test_name.empty?
+      validation_errors[:viewport_size] = ':viewport_size is required' if viewport_size.square.zero?
+      return true if validation_errors.keys.size.zero?
+      false
+    end
+
+    string_field :branch_name
+    string_field :parent_branch_name
+    string_field :baseline_branch_name
+    string_field :agent_id
+    string_field :environment_name
+    boolean_field :save_diffs
+    enum_field :session_type, Applitools::Concerns::SessionTypes.enum_values
+    object_field :batch_info, Applitools::BatchInfo
+    string_field :baseline_env_name
+    string_field :app_name
+    string_field :test_name
+    object_field :viewport_size, Applitools::RectangleSize
+
+    def short_description
+      "#{test_name} of #{app_name}"
+    end
+
+  end
+end

data/lib/applitools/core/future.rb

@@ -0,0 +1,25 @@
+module Applitools
+  class Future
+    attr_accessor :result, :semaphore, :block, :thread
+
+    def initialize(semaphore, &block)
+      raise Applitools::EyesIllegalArgument, 'Applitools::Future must be initialized with a block' unless block_given?
+      self.block = block
+      self.semaphore = semaphore
+      self.thread = Thread.new do
+        begin
+          self.result = block.call(semaphore)
+        rescue StandardError => e
+          Applitools::EyesLogger.logger.error "Failed to execute future"
+          Applitools::EyesLogger.logger.error e.message
+          Applitools::EyesLogger.logger.error e.backtrace.join( ' ')
+        end
+      end
+    end
+
+    def get
+      thread.join(15)
+      result
+    end
+  end
+end

data/lib/applitools/core/match_window_data.rb

@@ -82,6 +82,7 @@ module Applitools
     end
 
     def screenshot
+      return '' unless app_output.screenshot.respond_to?(:image)
       app_output.screenshot.image.to_blob
     end
 
@@ -248,7 +249,7 @@ module Applitools
       return unless @need_convert_ignored_regions_coordinates
       self.ignored_regions = @ignored_regions.map do |r|
         self.class.convert_coordinates(r, app_output.screenshot)
-      end
+      end unless app_output.screenshot.nil?
       @need_convert_ignored_regions_coordinates = false
     end
 
@@ -271,7 +272,7 @@ module Applitools
           r.max_right_offset,
           r.max_bottom_offset
         ).padding(r.current_padding)
-      end
+      end  unless app_output.screenshot.nil?
       @need_convert_floating_regions_coordinates = false
     end
 

data/lib/applitools/utils/utils.rb

@@ -72,6 +72,18 @@ module Applitools::Utils
     {}
   end
 
+  def stringify_for_hash(value)
+    return value.stringify if value.respond_to? :stringify
+    case value
+    when Array
+      value.map { |el| stringify_for_hash(el) }.join('')
+    when Hash
+      value.keys.sort { |a, b| b.to_s <=> a.to_s }.map { |k| "#{k}#{stringify_for_hash(value[k])}"}.join('')
+    else
+      value.to_s
+    end
+  end
+
   private
 
   def convert_hash_keys(value, method)

data/lib/applitools/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: false
 
 module Applitools
-  VERSION = '3.14.10'.freeze
+  VERSION = '3.15.0.beta'.freeze
 end

data/lib/eyes_core.rb

@@ -64,6 +64,7 @@ require_relative 'applitools/extensions'
 require_relative 'applitools/version'
 require_relative 'applitools/chunky_png_patch'
 
+Applitools.require_dir 'core/concerns'
 Applitools.require_dir 'core'
 Applitools.require_dir 'connectivity'
 Applitools.require_dir 'utils'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_core
 version: !ruby/object:Gem::Version
-  version: 3.14.10
+  version: 3.15.0.beta
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-13 00:00:00.000000000 Z
+date: 2019-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oily_png
@@ -122,6 +122,90 @@ dependencies:
     - - "<="
       - !ruby/object:Gem::Version
         version: 0.46.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Don't use it directly, take a look at eyes_selenium, eyes_images or eyes_calabash
   gems instead.
 email:
@@ -173,6 +257,7 @@ files:
 - lib/applitools/chunky_png_patch.rb
 - lib/applitools/connectivity/proxy.rb
 - lib/applitools/connectivity/server_connector.rb
+- lib/applitools/core/abstract_configuration.rb
 - lib/applitools/core/abstract_region.rb
 - lib/applitools/core/app_environment.rb
 - lib/applitools/core/app_output.rb
@@ -180,13 +265,18 @@ files:
 - lib/applitools/core/argument_guard.rb
 - lib/applitools/core/batch_info.rb
 - lib/applitools/core/class_name.rb
+- lib/applitools/core/concerns/eyes_configuration_dsl.rb
+- lib/applitools/core/concerns/jsonable.rb
+- lib/applitools/core/concerns/session_types.rb
 - lib/applitools/core/debug_screenshot_provider.rb
 - lib/applitools/core/eyes_base.rb
+- lib/applitools/core/eyes_base_configuration.rb
 - lib/applitools/core/eyes_screenshot.rb
 - lib/applitools/core/fixed_cut_provider.rb
 - lib/applitools/core/fixed_scale_provider.rb
 - lib/applitools/core/floating_region.rb
 - lib/applitools/core/fluent_interface.rb
+- lib/applitools/core/future.rb
 - lib/applitools/core/hash_extension.rb
 - lib/applitools/core/helpers.rb
 - lib/applitools/core/location.rb
@@ -238,11 +328,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Core of the Applitools Ruby SDK