eyes_selenium 1.19.0 → 1.20.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzUwYzEwOGI0MDJiOTdhOWI1MDA5ZDUwNzk3OTFlOGIzM2MwYmY1Ng==
+    MDEyOTk3MGRjYmJkZGIxZDk4ZjZhODY2MjMxYjJkZDMzZTQ5NjRiOQ==
   data.tar.gz: !binary |-
-    NDQ2MjczNDBjNTA2NDk0M2Q5ZDNiOTFiNzY5Yjg1ZDA3ZjMwNGRmNg==
+    ZjllN2EwMDYwZTVlZGEzMWQyMmMxMzE1Yjg0ZTY1ZGQ1MjliNGM4MQ==
 SHA512:
   metadata.gz: !binary |-
-    YjEzMzg5NmYwY2FhZDcwMjMxNTE1YTU5YmE1ZDUyNDdmN2E1ZWM5MDkxOTUx
-    NTIwMDk1MTMwZDY5YTc1MjMyNTkwZDU4YzgxMTY5YzFjNjRhOTU2MTY0NzEw
-    NDU3NTZmNGMyNzU4OWY0YTVjYjU0MzM1ZDBlZTkyZDMzNWZhNTM=
+    ZTg0NWExYmI0ZGI3N2NjYzRiZGZjOGZkMTQ5ZjExOThhN2E0YjdjZGQ5Mzc5
+    YTM2Y2Y4ZDI3ZWI2Y2RlOThmOWRmNTM3M2YxNGU0ZDQzZGI4MGY0NzNhMTE0
+    MzdhMWFhMGJmY2YyZDEzN2Q5NGRkN2M5NzZlMjk0NzU2NGQ5MzM=
   data.tar.gz: !binary |-
-    NzQwYmE0ZjViOTk1OTAzYzJiZmIwZmVmYmFjODk0NDYyYjhmMjYwY2FhNjIz
-    M2I3M2MzODY3MTJjZDUxYTEyZGQ0YjhiYWJhYzQxMGMxYjBlNzI1YzU5ZWQx
-    MWE5YjZiNzBmMTJjYjBkYzMyNjc2OWJhYzM3ODllMjVlMDBiYzM=
+    MWRhYTk3NGUyMjc0NWIyN2JkZWE0NTUwMjgxM2UxY2M4MzQ0NTVjZTQ4M2Uw
+    Y2EwMDk3NTUyOGNiYTkzMzdmMTk1YzRkNTEyMzBkMTQ3NGI5NTVhMzhlZDM0
+    MjY2MWQ1NGNlMWE0NmJjMzI0YTZiZGI4NzgyNTY1YTg4ODZiMGE=

data/lib/eyes_selenium.rb

@@ -18,7 +18,6 @@ module Applitools
   require 'eyes_selenium/utils'
   require 'eyes_selenium/version'
   require 'eyes_selenium/eyes/agent_connector'
-  require 'eyes_selenium/eyes/target_app'
   require 'eyes_selenium/eyes/batch_info'
   require 'eyes_selenium/eyes/dimension'
   require 'eyes_selenium/eyes/driver'

data/lib/eyes_selenium/eyes/driver.rb

@@ -4,7 +4,7 @@ class  Applitools::Driver
 
   include Selenium::WebDriver::DriverExtensions::HasInputDevices
 
-  attr_reader :remote_server_url, :remote_session_id, :user_agent, :screenshot_taker, :eyes
+  attr_reader :remote_server_url, :remote_session_id, :screenshot_taker, :eyes
   attr_accessor :driver
 
   DRIVER_METHODS = [
@@ -20,7 +20,6 @@ class  Applitools::Driver
     @eyes = eyes
     @remote_server_url = address_of_remote_server
     @remote_session_id = remote_session_id
-    @user_agent = get_user_agent
     begin
       if driver.capabilities.takes_screenshot?
        @screenshot_taker = false
@@ -63,10 +62,6 @@ class  Applitools::Driver
     driver.find_elements(by, selector).map { |el| Applitools::Element.new(self, el) }
   end
 
-  def create_application
-    Applitools::TargetApp.new(remote_server_url, remote_session_id, user_agent)
-  end
-
   def ie?
     driver.to_s == 'ie'
   end
@@ -75,6 +70,12 @@ class  Applitools::Driver
     driver.to_s == 'firefox'
   end
 
+  def user_agent
+    execute_script "return navigator.userAgent"
+  rescue => e
+    puts "getUserAgent(): Failed to obtain user-agent string (#{e.message})"
+  end
+
   private
 
     def address_of_remote_server
@@ -93,12 +94,6 @@ class  Applitools::Driver
       driver.remote_session_id
     end
 
-    def get_user_agent
-      execute_script "return navigator.userAgent"
-    rescue => e
-      puts "getUserAgent(): Failed to obtain user-agent string (#{e.message})"
-    end
-    
     def get_local_ip
       begin
         Socket.ip_address_list.detect do |intf| 

data/lib/eyes_selenium/eyes/eyes.rb

@@ -1,39 +1,51 @@
 class Applitools::Eyes
+
   DEFAULT_MATCH_TIMEOUT = 2.0
   AGENT_ID = 'eyes.selenium.ruby/' + Applitools::VERSION
+  DEFAULT_EYES_SERVER = 'https://eyes.applitools.com'
 
   class << self
-    attr_accessor :config
+    attr_accessor :config, :api_key
 
     def log_handler=(handler)
       EyesLogger.log_handler = handler
     end
   end
 
-  @config = {
-    server_url: 'https://eyes.applitools.com',
-    user: AGENT_ID
-    # apikey: 'please supply an apikey in your initializer'
-  }
+  # Class instance variables (static variables)
+  @config = {}
+  @api_key = nil
+
+  private
+  attr_reader :agent_connector
+  attr_accessor :session, :session_start_info, :match_window_task, :should_match_window_run_once_on_timeout
 
-  attr_reader :agent_connector, :disabled
-  attr_accessor :app_name, :test_name, :session, :is_open, :aborted, :viewport_size, :match_timeout, 
-                :failure_reports, :test_batch, :match_level, :driver, :host_os, :host_app, :branch_name, :parent_branch_name, 
-                :should_match_window_run_once_on_timeout, :session_start_info, :match_window_task, :user_inputs
+  public
+  attr_reader :disabled, :app_name, :test_name, :is_open, :viewport_size, :failure_reports, :match_level, :driver
+  attr_accessor :match_timeout, :batch, :host_os, :host_app, :branch_name, :parent_branch_name, :user_inputs
 
   def config
     self.class.config
   end
 
+  def api_key
+    self.class.api_key
+  end
+
   def initialize(params={})
-    raise "Please supply an apikey: Eyes.config[:apikey] = ..." unless config[:apikey]
 
     @disabled = params[:disabled]
 
     return if disabled?
 
+    # TODO Remove this when possible. Allows setting API key using "config" for backwards compatibility.
+    self.class.api_key ||= config[:apikey]
+
+    raise 'Please supply an apikey: Eyes.config[:apikey] = ...' unless api_key
+
     @user_inputs = []
-    @agent_connector = Applitools::AgentConnector.new(config[:server_url], config[:user], config[:apikey])
+    server_url = params.fetch(:server_url, DEFAULT_EYES_SERVER)
+    @agent_connector = Applitools::AgentConnector.new(server_url, AGENT_ID, api_key)
     @match_timeout = DEFAULT_MATCH_TIMEOUT
     @failure_reports = Applitools::FailureReports::ON_CLOSE
   end
@@ -43,29 +55,29 @@ class Applitools::Eyes
     return driver if disabled?
 
     if driver.nil? || !driver.is_a?(Selenium::WebDriver::Driver)
-      raise Applitools::EyesError.new("driver/browser must be a valid Selenium webdriver")
+      raise Applitools::EyesError.new('driver/browser must be a valid Selenium webdriver')
     end
 
-    @driver = Applitools::Driver.new(self, {driver: @driver})
+    @driver = Applitools::Driver.new(self, {driver: driver})
  
     if open?
       abort_if_not_closed
-      msg = 'a test is alread running'
+      msg = 'a test is already running'
       EyesLogger.info(msg) and raise Applitools::EyesError.new(msg)
     end
 
-    self.app_name = params.fetch(:app_name)
-    self.failure_reports = params.fetch(:failure_reports, self.failure_reports)
-    self.match_level = params.fetch(:match_level,MatchLevel::EXACT)
-    self.test_name = params.fetch(:test_name)
-    self.viewport_size = params.fetch(:viewport_size, nil)
+    @app_name = params.fetch(:app_name)
+    @test_name = params.fetch(:test_name)
+    @failure_reports = params.fetch(:failure_reports, self.failure_reports)
+    @match_level = params.fetch(:match_level,MatchLevel::EXACT)
+    @viewport_size = params.fetch(:viewport_size, nil)
 
-    self.is_open = true
+    @is_open = true
     driver
   end
 
   def open?
-    self.is_open
+    is_open
   end
 
   def clear_user_inputs
@@ -74,20 +86,20 @@ class Applitools::Eyes
 
   def check_window(tag)
     return if disabled?
-    raise Applitools::EyesError.new("Eyes not open") if !open?
-    if !session
+    raise Applitools::EyesError.new('Eyes not open') if !open?
+    unless session
       start_session
       self.match_window_task = Applitools::MatchWindowTask.new(agent_connector, session, driver, match_timeout)
     end
 
     as_expected = match_window_task.match_window(tag, should_match_window_run_once_on_timeout)
-    if !as_expected
+    unless as_expected
       self.should_match_window_run_once_on_timeout = true
-      if !session.new_session?
-        EyesLogger.info %( "mismatch #{ tag ? "" : "(#{tag})" } )
+      unless session.new_session?
+        EyesLogger.info %( "mismatch #{ tag ? '' : "(#{tag})" } )
         if failure_reports.to_i == Applitools::FailureReports::IMMEDIATE
-          raise Applitools::TestFailedError.new("Mismatch found in '#{start_info.scenario_id_or_name}'"\
-                                                " of '#{start_info.app_id_or_name}'")
+          raise Applitools::TestFailedError.new("Mismatch found in '#{session_start_info.scenario_id_or_name}'"\
+                                                " of '#{session_start_info.app_id_or_name}'")
         end
       end
     end
@@ -95,7 +107,9 @@ class Applitools::Eyes
 
   def close
     return if disabled?
-    self.is_open = false
+    @is_open = false
+
+    # if there's no running session, the test was never started (never reached checkWindow)
     return Applitools::TestResults.new if !session
 
     session_results_url = session.url
@@ -128,7 +142,7 @@ class Applitools::Eyes
   #      get "http://www.google.com"
   #      check_window("initial")
   #    end
-  def test(params={}, &block)
+  def test(params={})
     begin
       open(params)
       yield(driver)
@@ -139,19 +153,19 @@ class Applitools::Eyes
   end
 
 
-    def abort_if_not_closed
-      return if disabled?
-      self.is_open = false
-      if session
-        begin
-          agent_connector.stop_session(session,true)
-        rescue Applitools::EyesError => e
-          EyesLogger.info "Failed to abort server session -> #{e.message} "
-        ensure
-          self.session = nil
-        end
+  def abort_if_not_closed
+    return if disabled?
+    @is_open = false
+    if session
+      begin
+        agent_connector.stop_session(session,true)
+      rescue Applitools::EyesError => e
+        EyesLogger.info "Failed to abort server session -> #{e.message} "
+      ensure
+        self.session = nil
       end
     end
+  end
 
   private
 
@@ -168,34 +182,34 @@ class Applitools::Eyes
       params.fetch(:driver, nil)
     end
 
+    def inferred_environment
+      user_agent = driver.user_agent
+      if user_agent
+        'useragent:' + user_agent
+      end
+    end
+
     def start_session
       assign_viewport_size
-      test_batch ||= Applitools::BatchInfo.new
-      application = driver.create_application
-      inferred = "useragent:" + application.user_agent
-      app_env = Applitools::Environment.new(host_os, host_app, viewport_size, inferred)
-      self.session_start_info = Applitools::StartInfo.new(AGENT_ID,
-        app_name, test_name, test_batch, app_env, application, 
-        match_level,nil, branch_name, parent_branch_name
+      self.batch ||= Applitools::BatchInfo.new
+      app_env = Applitools::Environment.new(host_os, host_app, viewport_size, inferred_environment)
+      self.session_start_info = Applitools::StartInfo.new(
+          AGENT_ID, app_name, test_name, batch, app_env, match_level, nil, branch_name, parent_branch_name
       )
       self.session = agent_connector.start_session(session_start_info)
       self.should_match_window_run_once_on_timeout = session.new_session?
     end
 
     def viewport_size?
-      self.viewport_size
+      viewport_size
     end
 
     def assign_viewport_size
       if viewport_size?
-        self.viewport_size = Applitools::ViewportSize.new(driver, viewport_size)
-	self.viewport_size.set
+        @viewport_size = Applitools::ViewportSize.new(driver, viewport_size)
+	      viewport_size.set
       else
-        self.viewport_size =  Applitools::ViewportSize.new(driver).extract_viewport_from_browser!
+        @viewport_size =  Applitools::ViewportSize.new(driver).extract_viewport_from_browser!
       end
     end
-
-    def to_hash
-      Hash[dimension.each_pair.to_a]
-    end
 end

data/lib/eyes_selenium/eyes/mouse_trigger.rb

@@ -1,11 +1,11 @@
 class Applitools::MouseTrigger
 
-  MouseAction = { click: 1, right_click: 2,  double_click: 3,  move: 4,  down: 5,  up: 6 }
+  MOUSE_ACTION = { click: 'Click', right_click: 'RightClick',  double_click: 'DoubleClick',  move: 'Move',  down: 'Down',  up: 'Up' }
 
   attr_reader :mouse_action, :control, :location
 
   def initialize(mouse_action, control, location)
-    @mouse_action = MouseAction[mouse_action]
+    @mouse_action = MOUSE_ACTION[mouse_action]
     @control = control
     @location = location
   end

data/lib/eyes_selenium/eyes/start_info.rb

@@ -8,16 +8,14 @@ class Applitools::StartInfo
   end
 
   ## add a config file with this stuff, and use hash arg
-  def initialize(agent_id, app_id_or_name, scenario_id_or_name, batch_info, environment,
-                 application, match_level, ver_id=nil, branch_name=nil, 
-                 parent_branch_name=nil)
+  def initialize(agent_id, app_id_or_name, scenario_id_or_name, batch_info, environment, match_level, ver_id=nil,
+                  branch_name=nil, parent_branch_name=nil)
     @agent_id = agent_id
     @app_id_or_name = app_id_or_name
     @ver_id = ver_id
     @scenario_id_or_name = scenario_id_or_name
     @batch_info = batch_info
     @environment = environment
-    @application = application
     @match_level = match_level
     @branch_name = branch_name
     @parent_branch_name = parent_branch_name
@@ -26,8 +24,7 @@ class Applitools::StartInfo
   def to_hash
     {  
       AgentId: agent_id, AppIdOrName: app_id_or_name, VerId: ver_id, ScenarioIdOrName: scenario_id_or_name,
-      BatchInfo: batch_info.to_hash, Environment: environment.to_hash, 
-      Application: application.to_hash, matchLevel: match_level, branchName: branch_name,
+      BatchInfo: batch_info.to_hash, Environment: environment.to_hash, matchLevel: match_level, branchName: branch_name,
       parentBranchName: parent_branch_name
     }
   end

data/lib/eyes_selenium/version.rb

@@ -1,3 +1,3 @@
 module Applitools
-  VERSION = "1.19.0"
+  VERSION = '1.20.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.20.0
 platform: ruby
 authors:
 - Applitools team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-28 00:00:00.000000000 Z
+date: 2013-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -157,7 +157,6 @@ files:
 - lib/eyes_selenium/eyes/screenshot_taker.rb
 - lib/eyes_selenium/eyes/session.rb
 - lib/eyes_selenium/eyes/start_info.rb
-- lib/eyes_selenium/eyes/target_app.rb
 - lib/eyes_selenium/eyes/test_results.rb
 - lib/eyes_selenium/eyes/text_trigger.rb
 - lib/eyes_selenium/eyes/viewport_size.rb

data/lib/eyes_selenium/eyes/target_app.rb

@@ -1,17 +0,0 @@
-class Applitools::TargetApp
-
-  attr_reader :url, :session_id, :user_agent
-
-  def initialize(url, session_id, user_agent)
-    @url = url
-    @session_id = session_id
-    @user_agent = user_agent
-  end
-
-  def to_hash
-    {
-      "$type" => "Applitools.Framework.TargetWebDriverApplication, Core", 
-      url: URI.encode(url.to_s), sessionId: session_id, userAgent: user_agent
-    }
-  end
-end