eyes_core 3.16.12 → 3.16.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca8dd4445f7e42198b683ac73f191455cda657c8794bc3d7e9af34774fb09e61
-  data.tar.gz: 0e9d44d92002264ff5e2ab17d524f5cd80e0fcb88b1203128efc86d23ac37d0b
+  metadata.gz: 3fec9e08863b0523e81a22dc9ca814594c1807af15103cd33d3ae5fdd920f6ff
+  data.tar.gz: cd99b6053547f98d71919530ad7863ef2defaac8fd7ea829f64fecf5e4732ad7
 SHA512:
-  metadata.gz: 4c32bf9532df4a85c68501803b95a7d9c904f05558f3f86c5c40019c79be547af677c9f6425d317d635faddf027a560c676cc4fb3eb09c2aaeaee9486a1cae17
-  data.tar.gz: d29441081d639c9c59ffab7a2d98a20e59814b0f750b4851415c0d8c4de68626275b19c6c54344ab0ec3042c3ae623baacdbeefdcf032521cde8448d4d745484
+  metadata.gz: 917324723274f093a3806993011e5baf127b57c54500265d0317f7419fa3247a2a8bb1cf50a9ef1fc52269ea08f42d9bdced2ba8a714e90879ce890148fa97ac
+  data.tar.gz: 99e9601adee40be269992a387c727dc91b12c0a3e6bd23d9b619a8c35cd5b5db7c34ccc019d2936576bba21e9524c3af2b0b3952cd68f059a612ca97b566c077

data/lib/applitools/connectivity/server_connector.rb

@@ -43,12 +43,23 @@ module Applitools::Connectivity
     attr_accessor :server_url
     attr_reader :endpoint_url
     attr_reader :proxy
+    attr_reader :agent_id_proc
     environment_attribute :api_key, 'APPLITOOLS_API_KEY'
 
     def initialize(url = nil)
       self.server_url = url
     end
 
+    def obtain_agent_id(&block)
+      @agent_id_proc = block if block_given?
+    end
+
+    def agent_id
+      return agent_id_proc.call if agent_id_proc
+      Applitools::EyesLogger.error('The agent id is not set!')
+      "eyes.sdk.ruby/#{Applitools::VERSION}"
+    end
+
     def rendering_info
       response = long_get(URI.join(server_url, RENDER_INFO_PATH), content_type: 'application/json')
       unless response.status == HTTP_STATUS_CODES[:ok]
@@ -159,7 +170,7 @@ module Applitools::Connectivity
     def download_resource(url, ua_string = nil)
       Applitools::EyesLogger.debug "Fetching #{url}..."
       resp_proc = proc do |u|
-        faraday_connection(u).send(:get) do |req|
+        faraday_connection(u, false).send(:get) do |req|
           req.options.timeout = self.class.connection_timeout || DEFAULT_TIMEOUT
           req.headers[:accept_encoding] = 'identity'
           req.headers[:accept_language] = '*'
@@ -185,7 +196,10 @@ module Applitools::Connectivity
     end
 
     def server_url=(url)
-      unless url.nil?; uri = URI.parse(url); url = "#{uri.scheme}://#{uri.hostname}".freeze; end
+      if url
+        uri = URI.parse(url)
+        url = "#{uri.scheme}://#{uri.hostname}".freeze
+      end
       @server_url = url.nil? ? DEFAULT_SERVER_URL : url
       unless @server_url.is_a? String
         raise Applitools::EyesIllegalArgument.new 'You should pass server url as a String!' \
@@ -297,12 +311,19 @@ module Applitools::Connectivity
 
     private
 
-    def faraday_connection(url)
+    def faraday_connection(url, pass_user_agent_header = true)
       Faraday.new(
         url: url,
         ssl: { ca_file: SSL_CERT },
         proxy: @proxy.nil? ? nil : @proxy.to_hash
       ) do |faraday|
+        if pass_user_agent_header
+          faraday.use(
+            Applitools::Connectivity::UserAgentMiddleware,
+            get_user_agent: @agent_id_proc,
+            get_server_url: proc { server_url }
+          )
+        end
         faraday.use FaradayMiddleware::FollowRedirects
         faraday.use :cookie_jar
         faraday.adapter self.class.faraday_adapter

data/lib/applitools/connectivity/user_agent_middleware.rb

@@ -0,0 +1,24 @@
+module Applitools::Connectivity
+  class UserAgentMiddleware
+    attr_accessor :app, :get_user_id_proc, :server_url_proc
+    def initialize(app, params)
+      self.app = app
+      self.get_user_id_proc = params[:get_user_agent]
+      self.server_url_proc = params[:get_server_url]
+    end
+
+    def call(env)
+      # server_url = URI.parse(server_url_proc.call)
+      env.request_headers['x-applitools-eyes-client'] = obtain_user_id
+      @app.call(env)
+    end
+
+    private
+
+    def obtain_user_id
+      return get_user_id_proc.call if get_user_id_proc.is_a?(Proc)
+      Applitools::EyesLogger.error('The user ID was not set!')
+      "eyes.sdk.ruby/#{Applitools::VERSION}"
+    end
+  end
+end

data/lib/applitools/core/eyes_base.rb

@@ -66,6 +66,9 @@ module Applitools
       self.runner = options[:runner]
       server_url = args.first
       @server_connector = Applitools::Connectivity::ServerConnector.new(server_url)
+      @server_connector.obtain_agent_id do
+        full_agent_id
+      end
       ensure_config
       self.server_url = server_url if server_url
       self.disabled = false

data/lib/applitools/core/eyes_base_configuration.rb

@@ -108,6 +108,7 @@ module Applitools
     object_field :default_match_settings, Applitools::ImageMatchSettings
     int_field :scale
     int_field :remainder
+    boolean_field :ignore_caret
 
     methods_to_delegate.delete(:batch_info)
     methods_to_delegate.delete(:batch_info=)
@@ -152,6 +153,14 @@ module Applitools
       default_match_settings.match_level
     end
 
+    def custom_getter_for_ignore_caret(_value)
+      default_match_settings.ignore_caret
+    end
+
+    def custom_setter_for_ignore_caret(value)
+      default_match_settings.ignore_caret = value
+    end
+
     methods_to_delegate.push(:set_proxy)
   end
 end

data/lib/applitools/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_core
 version: !ruby/object:Gem::Version
-  version: 3.16.12
+  version: 3.16.13
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-30 00:00:00.000000000 Z
+date: 2020-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oily_png
@@ -285,6 +285,7 @@ files:
 - lib/applitools/chunky_png_patch.rb
 - lib/applitools/connectivity/proxy.rb
 - lib/applitools/connectivity/server_connector.rb
+- lib/applitools/connectivity/user_agent_middleware.rb
 - lib/applitools/core/abstract_configuration.rb
 - lib/applitools/core/abstract_region.rb
 - lib/applitools/core/accessibility_level.rb