eyes_selenium 1.15.0 → 1.16.0

data/.gitignore

@@ -11,6 +11,8 @@ doc/
 lib/bundler/man
 pkg
 rdoc
+.idea/
+spec/
 spec/reports
 test/tmp
 test/version_tmp

data/README.md

@@ -16,62 +16,8 @@ Or install it yourself as:
 
     $ gem install eyes_selenium
 
-## Standalone Usage
-
-```ruby
-Applitools::Eyes.config[:apikey] = 'XXX'
-
-eyes = Applitools::Eyes.new
-eyes.test(app_name: 'my app', test_name: 'my test') do |eyes, driver|
-  driver.get 'http://www.mywebsite.com'
-  eyes.check_window('home page')
-  driver.find_element(:css, "li#pricing").click
-  eyes.check_window('pricing')
-end
-```
-
-## Integrated within your Capybara tests:
-initializer:
-```ruby
-Capybara.run_server = false
-# This is your api key, make sure you use it in all your tests.
-Applitools::Eyes.config[:apikey] = 'XXX'
-let(:eyes) do
-  webdriver = page.driver.browser
-  eyes = Applitools::Eyes.new browser: webdriver
-end
-```
-
-spec:
-```ruby
-require 'capybara/rspec'
-require 'eyes_selenium_ruby'
-
-
-describe 'Applitools', :type=>:feature, :js=>true do
-
-  describe 'Test Applitools website' do
-    it 'should navigate from the main page to the features page' do
-
-      # Start visual testing with browser viewport set to 1024x768.
-      eyes.open(app_name: 'Applitools', test_name: 'Test Web Page', viewport_size: {width: 1024, height: 768})
-
-      visit 'http://www.applitools.com'
-
-      # Visual validation point #1
-      eyes.check_window('Main Page')
-
-      page.first('.read_more').click
-
-      # Visual validation point #2
-      eyes.check_window('Features Page')
-
-      eyes.close
-    end
-  end
-end
-
-```
+## Usage
+Please check the applitools website for usage instructions: http://www.applitools.com
 
 ## Contributing
 

data/lib/eyes_selenium.rb

@@ -16,12 +16,12 @@ module Applitools
   class NewTestError < TestFailedError; end
 
   require 'eyes_selenium/utils'
-  require "eyes_selenium/version"
-  require "eyes_selenium/eyes/agent_connecter"
-  require "eyes_selenium/eyes/target_app"
+  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"
+  require 'eyes_selenium/eyes/dimension'
+  require 'eyes_selenium/eyes/driver'
   require 'eyes_selenium/eyes/element'
   require 'eyes_selenium/eyes/environment'
   require 'eyes_selenium/eyes/eyes'

data/lib/eyes_selenium/eyes/{agent_connecter.rb → agent_connector.rb}

@@ -3,6 +3,7 @@ class Applitools::AgentConnector
   include HTTParty
   headers 'Accept' => 'application/json'
   ssl_ca_file File.join(File.dirname(File.expand_path(__FILE__)), '../../../certs/cacert.pem').to_s
+  default_timeout 300
   #debug_output $stdout # comment out when not debugging
 
   attr_reader :uri, :auth

data/lib/eyes_selenium/eyes/driver.rb

@@ -5,38 +5,25 @@ class  Applitools::Driver
   include Selenium::WebDriver::DriverExtensions::HasInputDevices
 
   attr_reader :remote_server_url, :remote_session_id, :user_agent, :screenshot_taker
-  attr_accessor :user_inputs, :browser
+  attr_accessor :user_inputs, :driver
 
-  DEFAULT_DRIVER = :firefox
   DRIVER_METHODS = [
     :title, :execute_script, :execute_async_script, :quit, :close, :get,
     :post, :page_source, :window_handles, :window_handle, :switch_to, 
     :navigate, :manage, :capabilities
   ]
 
-  ## If driver is not provided, Applitools::Driver will default to Firefox driver
-  ## Driver param can be a Selenium::WebDriver or a named symbol (:chrome)
+  ## If driver is not provided, Applitools::Driver will raise an EyesError exception.
   #
-  ## Example:
-  #  eyes.open(browser: :chrome) ##=> will create chrome webdriver
-  #  eyes.open(browser: Selenium::WebDriver.for(:chrome) ##=> will create the same thing
-  #  eyes.open ##=> will create a webdriver according to Applitools::Driver::DEFAULT_DRIVER
-  def initialize(options={})
-    browser_obj = options.delete(:browser) || DEFAULT_DRIVER 
-    @browser ||= case browser_obj
-                 when Symbol
-                   at_exit { quit rescue nil }
-                   Selenium::WebDriver.for browser_obj
-                 else
-                   browser_obj
-                 end
+  def initialize(options)
+    @driver = options[:driver]
 
     @user_inputs = []
     @remote_server_url = address_of_remote_server
     @remote_session_id = remote_session_id
     @user_agent = get_user_agent
     begin
-      if browser.capabilities.takes_screenshot?
+      if driver.capabilities.takes_screenshot?
        @screenshot_taker = false
       else
         @screenshot_taker = Applitools::ScreenshotTaker.new(@remote_server_url, @remote_session_id)
@@ -48,12 +35,12 @@ class  Applitools::Driver
 
   DRIVER_METHODS.each do |method|
     define_method method do |*args, &block|
-      browser.send(method,*args, &block)
+      driver.send(method,*args, &block)
     end
   end
 
   def screenshot_as(output_type)
-    return browser.screenshot_as(output_type) if !screenshot_taker
+    return driver.screenshot_as(output_type) if !screenshot_taker
 
     if output_type.downcase.to_sym != :base64
       raise Applitools::EyesError.new("#{output_type} ouput type not supported for screenshot")
@@ -62,19 +49,19 @@ class  Applitools::Driver
   end 
 
   def mouse
-    Applitools::EyesMouse.new(self, browser.mouse)
+    Applitools::EyesMouse.new(self, driver.mouse)
   end
 
   def keyboard
-    Applitools::EyesKeyboard.new(self, browser.keyboard)
+    Applitools::EyesKeyboard.new(self, driver.keyboard)
   end
 
   def find_element(by, selector)
-    Applitools::Element.new(self, browser.find_element(by, selector))
+    Applitools::Element.new(self, driver.find_element(by, selector))
   end
 
   def find_elements(by, selector)
-    browser.find_elements(by, selector).map { |el| Applitools::Element.new(self, el) }
+    driver.find_elements(by, selector).map { |el| Applitools::Element.new(self, el) }
   end
 
   def create_application
@@ -86,17 +73,17 @@ class  Applitools::Driver
   end
 
   def ie?
-    browser.to_s == 'ie'
+    driver.to_s == 'ie'
   end
 
   def firefox?
-    browser.to_s == 'firefox'
+    driver.to_s == 'firefox'
   end
 
   private
 
     def address_of_remote_server
-      uri = URI(browser.current_url)
+      uri = URI(driver.current_url)
       raise Applitools::EyesError.new("Failed to get remote web driver url") if uri.to_s.empty?
 
       webdriver_host = uri.host
@@ -108,7 +95,7 @@ class  Applitools::Driver
     end
 
     def remote_session_id
-      browser.remote_session_id
+      driver.remote_session_id
     end
 
     def get_user_agent

data/lib/eyes_selenium/eyes/eyes.rb

@@ -37,14 +37,16 @@ class Applitools::Eyes
     @failure_reports = Applitools::FailureReports::ON_CLOSE
   end
 
-  def create_driver(params)
-    Applitools::Driver.new(browser: params.fetch(:browser, nil))
-  end
-
   def open(params={})
-    @driver = create_driver(params)
+    @driver = get_driver(params)
     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")
+    end
+
+    @driver = Applitools::Driver.new(driver: @driver)
+ 
     if open?
       abort_if_not_closed
       msg = 'a test is alread running'
@@ -126,8 +128,7 @@ class Applitools::Eyes
       open(params)
       yield(driver)
       close
-    rescue Applitools::EyesError
-    ensure 
+    ensure
       abort_if_not_closed
     end
   end
@@ -153,6 +154,15 @@ class Applitools::Eyes
       disabled
     end
 
+    def get_driver(params)
+      # TODO remove the "browser" related block when possible. It's for backward compatibility.
+      if params.has_key?(:browser)
+        EyesLogger.info('"browser" key is deprecated, please use "driver" instead.')
+        return params[:browser]
+      end
+      params.fetch(:driver, nil)
+    end
+
     def start_session
       assign_viewport_size
       test_batch ||= Applitools::BatchInfo.new

data/lib/eyes_selenium/eyes/eyes_mouse.rb

@@ -29,8 +29,8 @@ class Applitools::EyesMouse
   def move_to(element, right_by = nil, down_by = nil)
     element = element.web_element if element.is_a?(Applitools::Element)
     location = element.location
-    location.x = [0,location.x].max
-    location.y = [0,location.y].max
+    location.x = [0,location.x].max.round
+    location.y = [0,location.y].max.round
     current_control = Applitools::Region.new(0,0, *location.values)
     driver.user_inputs << Applitools::MouseTrigger.new(:move, current_control, location)
     element = element.web_element if element.is_a?(Applitools::Element)
@@ -38,9 +38,9 @@ class Applitools::EyesMouse
   end
 
   def move_by(right_by, down_by)
-    right = [0,right_by].max
-    down = [0,down_by].max
-    location = Selenium::WebDriver::Location.new(right,down)
+    right = [0,right_by].max.round
+    down = [0,down_by].max.round
+    location = Selenium::WebDriver::Point.new(right,down)
     current_control = Applitools::Region.new(0,0, right, down)
     driver.user_inputs << Applitools::MouseTrigger.new(:move, current_control, location)
     mouse.move_by(right_by,down_by)
@@ -50,8 +50,8 @@ class Applitools::EyesMouse
 
     def extract_trigger_and_perform(method, element=nil, *args)
       location = element.location
-      location.x = [0,location.x].max
-      location.y = [0,location.y].max
+      location.x = [0,location.x].max.round
+      location.y = [0,location.y].max.round
       current_control = Applitools::Region.new(0,0, *location.values)
       driver.user_inputs << Applitools::MouseTrigger.new(method, current_control, location)
       element = element.web_element if element.is_a?(Applitools::Element)

data/lib/eyes_selenium/version.rb

@@ -1,3 +1,3 @@
 module Applitools
-  VERSION = "1.15.0"
+  VERSION = "1.16.0"
 end

data/test_script.rb

@@ -7,15 +7,22 @@ require 'eyes_selenium'
 Applitools::Eyes.config[:apikey] = 'YOUR_API_KEY'
 
 eyes = Applitools::Eyes.new
-eyes.test(app_name: 'Ruby SDK', test_name: 'Applitools website test', viewport_size: {width: 1024, height: 768}) do |driver|
-  driver.get "http://www.applitools.com"
-  eyes.check_window("initial")
-  driver.find_element(:css, "li.pricing a").click
-  eyes.check_window("pricing page")
-  el = driver.find_elements(:css, ".footer-row a").first
-  driver.action.double_click(el).perform
-  eyes.check_window("in forms")
-  other_el = driver.find_elements(:css, ".s2member-pro-paypal-registration-email").first
-  driver.action.move_to(other_el).click(other_el).send_keys("applitools").perform
-  eyes.check_window("end")
+
+my_webdriver = Selenium::WebDriver.for :firefox
+
+begin
+  eyes.test(app_name: 'Ruby SDK', test_name: 'Applitools website test', viewport_size: {width: 1024, height: 768}, driver: my_webdriver) do |driver|
+    driver.get "http://www.applitools.com"
+    eyes.check_window("initial")
+    driver.find_element(:css, "li.pricing a").click
+    eyes.check_window("pricing page")
+    el = driver.find_elements(:css, ".footer-row a").first
+    driver.action.double_click(el).perform
+    eyes.check_window("in forms")
+    other_el = driver.find_elements(:css, ".s2member-pro-paypal-registration-email").first
+    driver.action.move_to(other_el).click(other_el).send_keys("applitools").perform
+    eyes.check_window("end")
+  end
+ensure
+  my_webdriver.quit
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.16.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-21 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -156,7 +156,7 @@ files:
 - eyes_selenium.gemspec
 - lib/eyes_selenium.rb
 - lib/eyes_selenium/capybara.rb
-- lib/eyes_selenium/eyes/agent_connecter.rb
+- lib/eyes_selenium/eyes/agent_connector.rb
 - lib/eyes_selenium/eyes/batch_info.rb
 - lib/eyes_selenium/eyes/dimension.rb
 - lib/eyes_selenium/eyes/driver.rb
@@ -182,11 +182,6 @@ files:
 - lib/eyes_selenium/utils.rb
 - lib/eyes_selenium/utils/image_delta_compressor.rb
 - lib/eyes_selenium/version.rb
-- spec/capybara_spec.rb
-- spec/driver_spec.rb
-- spec/eyes_spec.rb
-- spec/spec_helper.rb
-- spec/test_app.rb
 - test_script.rb
 homepage: http://www.applitools.com
 licenses:
@@ -201,27 +196,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2476420457327612730
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2476420457327612730
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Applitools Ruby SDK
-test_files:
-- spec/capybara_spec.rb
-- spec/driver_spec.rb
-- spec/eyes_spec.rb
-- spec/spec_helper.rb
-- spec/test_app.rb
+test_files: []

data/spec/capybara_spec.rb

@@ -1,34 +0,0 @@
-require 'spec_helper'
-require 'capybara/rspec'
-require 'eyes_selenium/capybara'
-require 'test_app'
-
-Capybara.app = TestApp
-
-describe Applitools::Eyes do
-  init_eyes
-  describe 'capybara' do
-    before do
-      eyes.agent_connector.stub(:stop_session).and_return(double("TestResults", mismatches: 0, missing: 0))
-      eyes.agent_connector.stub(:match_window).and_return(true)
-      @navigation = double("navigation")
-      @navigation.stub(:to)
-    end
-    it 'should invoke eyes driver when calling capybara visit inside of eyes.open' do
-      Capybara.current_driver.should == :rack_test
-
-      eyes.driver.should_receive(:navigate).and_return(@navigation)
-      eyes.test(app_name: 'test', test_name: 'test') do |eyes|
-        Capybara.current_driver.should == :selenium
-        eyes.driver.should == Capybara.current_session.driver.instance_variable_get(:@browser)
-        Capybara.current_session.visit '/'
-        eyes.check_window('test')
-      end
-      Capybara.current_driver.should == :rack_test
-    end
-    it 'should not invoke eyes driver when calling capybara visit outside of eyes.open' do
-      eyes.driver.should_not_receive(:navigate)
-      Capybara.current_session.visit '/'
-    end
-  end
-end

data/spec/driver_spec.rb

@@ -1,10 +0,0 @@
-require 'spec_helper'
-
-describe Applitools::Driver do
-  describe "#driver" do
-    let(:driver) { Applitools::Driver.new }
-
-    it "has a selenium driver" do
-    end
-  end
-end

data/spec/eyes_spec.rb

@@ -1,157 +0,0 @@
-require 'spec_helper'
-
-describe Applitools::Eyes do
-  init_eyes
-
-  before do
-    eyes.open(app_name: 'test_app', test_name: 'test_app_test')
-    fake_session = Applitools::Session.new(1,"http://fake_url.com", false)
-    eyes.session = fake_session
-    eyes.agent_connector.stub(:stop_session).and_return(double("TestResults", mismatches: 0, missing: 0))
-    eyes.agent_connector.stub(:match_window).and_return(true)
-  end
-
-  describe "#new" do
-    context "doesn't have an apikey" do
-      before do
-        Applitools::Eyes.config[:apikey] = nil
-      end
-      it {expect {Applitools::Eyes.new }.to raise_error }
-      after do
-        Applitools::Eyes.config[:apikey] = 'YOUR_API_KEY_HERE'
-      end
-    end
-    context "has an apikey url" do
-      it {expect {Applitools::Eyes.new }.to_not raise_error }
-    end
-  end
-
-  describe ".open" do
-    context "already open" do
-      it "aborts session" do
-        eyes.should_receive(:abort_if_not_closed)
-        expect {eyes.open}.to raise_error
-      end
-    end
-
-  end
-
-  describe ".abort_if_not_closed" do
-    it "closes eyes" do
-      expect(eyes).to be_open
-      eyes.send(:abort_if_not_closed)
-      expect(eyes).to_not be_open
-    end
-
-    it "clears session" do
-      eyes.send(:abort_if_not_closed)
-      expect(eyes.session).to be_nil
-    end
-
-    it "stops session" do
-      expect(eyes.agent_connector).to receive(:stop_session)
-      eyes.send(:abort_if_not_closed)
-    end
-  end
-
-  describe ".close" do
-    it "stops the session" do
-      eyes.agent_connector.stub(:stop_session).and_return(double("TestResults", mismatches: 0, missing: 0))
-      expect(eyes.agent_connector).to receive(:stop_session)
-      expect(eyes.close)
-    end
-
-    context "new_session" do
-      before { eyes.session.stub(:new_session?).and_return(true) }
-      it "raises NewTestError" do
-        eyes.session_start_info = double().as_null_object
-        expect { eyes.close }.to raise_error(Applitools::NewTestError)
-      end
-    end
-
-    context "not new_session" do
-      before do
-        eyes.stub(:session_start_info).and_return double().as_null_object 
-        eyes.session.new_session = false
-      end
-
-      it "raises TestFailedError if results have mismatches" do
-        eyes.agent_connector.stub(:stop_session).and_return(double("TestResults", mismatches: 2))
-        expect { eyes.close }.to raise_error(Applitools::TestFailedError)
-      end
-
-      it "raises TestFailedError if results have missing" do
-        eyes.agent_connector.stub(:stop_session).and_return(double("TestResults", mismatches: 0, missing: 2))
-        expect { eyes.close }.to raise_error(Applitools::TestFailedError)
-      end
-
-      it "doesn't raise if old session without mismatches" do
-        eyes.stub_chain(:agent_connector, :stop_session).and_return(double("TestResults", mismatches: 0, missing: 0))
-        expect(eyes.close).to_not raise_error
-      end
-    end
-  end
-
-  describe ".check_window" do
-    it "raises EyesError if eyes aren't open"
-    context "no session" do 
-      it "creates new session if no session exists"
-      it "creates new MatchWindowTask"
-    end
-
-    context "results are as expected" do
-      it "doesn't raise"
-    end
-    context "results are not as expected" do
-      context "new session" do
-        specify "next check_window will run once on time out"
-      end
-      context "not new session" do
-        context "immediate failreports" do
-          it "raises TestFailedError"
-        end
-
-        context "not immediate failreports" do
-          it "doesn't raise"
-        end
-      end
-    end
-  end
-
-  describe ".test" do
-    it "opens and closes the eyes around the block execution" do
-      eyes.should_receive(:open).ordered
-      eyes.should_receive(:close).ordered
-      eyes.test { "foo" }
-    end
-
-    it "always closes eyes even if there were exceptions" do
-      eyes.stub(:open)
-      eyes.should_receive(:abort_if_not_closed)
-      eyes.test { raise Applitools::EyesError }
-    end
-
-    context "testing .test" do
-      let!(:eyes) do
-        Applitools::Eyes.new
-      end
-      it "catches triggers" do
-        eyes.send(:abort_if_not_closed)
-        eyes.test(app_name: 'my app1', test_name: 'my test') do |eyes, driver|
-          driver.get "http://www.applitools.com"
-          eyes.check_window("initial")
-          driver.find_element(:css, "li.pricing a").click
-          # return false unless user_inputs.map(&:to_hash) == [{"$type"=>"Applitools.Models.MouseTrigger, Core", :mouseAction=>1, :control=>{"$type"=>"Applitools.Utils.Geometry.MutableRegion, Core", :left=>555, :top=>0, :height=>69, :width=>50}, :location=>{:latitude=>25, :longitude=>34, :altitude=>nil}}]
-          eyes.check_window("pricing page")
-          el = driver.find_elements(:css, ".footer-row a").first
-          driver.action.double_click(el).perform
-          # return false unless user_inputs.map(&:to_hash) == [{"$type"=>"Applitools.Models.MouseTrigger, Core", :mouseAction=>3, :control=>{"$type"=>"Applitools.Utils.Geometry.MutableRegion, Core", :left=>0, :top=>0, :height=>115, :width=>376}, :location=>{:x=>115, :y=>376}}]
-          eyes.check_window("in forms")
-          other_el = driver.find_elements(:css, ".s2member-pro-paypal-registration-email").first
-          driver.action.move_to(other_el).click(other_el).send_keys("text1",:space,"text2").perform
-          # return false unless user_inputs.map(&:to_hash) == [{"$type"=>"Applitools.Models.MouseTrigger, Core", :mouseAction=>4, :control=>{"$type"=>"Applitools.Utils.Geometry.MutableRegion, Core", :left=>0, :top=>0, :height=>230, :width=>331}, :location=>{:x=>230, :y=>331}}, {"$type"=>"Applitools.Models.MouseTrigger, Core", :mouseAction=>1, :control=>{"$type"=>"Applitools.Utils.Geometry.MutableRegion, Core", :left=>0, :top=>0, :height=>230, :width=>331}, :location=>{:x=>230, :y=>331}}, {"$type"=>"Applitools.Models.TextTrigger, Core", :text=>"text1", :control=>{"$type"=>"Applitools.Utils.Geometry.MutableRegion, Core", :left=>230, :top=>331, :height=>367, :width=>35}}, {"$type"=>"Applitools.Models.TextTrigger, Core", :text=>"", :control=>{"$type"=>"Applitools.Utils.Geometry.MutableRegion, Core", :left=>230, :top=>331, :height=>367, :width=>35}}, {"$type"=>"Applitools.Models.TextTrigger, Core", :text=>"text2", :control=>{"$type"=>"Applitools.Utils.Geometry.MutableRegion, Core", :left=>230, :top=>331, :height=>367, :width=>35}}]
-        end
-      end
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,29 +0,0 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-require 'eyes_selenium'
-RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = 'random'
-end
-
-
-def init_eyes
-  before(:all) do
-    Applitools::Eyes.config[:apikey] = 'YOUR_API_KEY'
-    Applitools::Eyes.config[:server_url] = 'http://eyes.applitools.com'
-  end
-  let!(:eyes) do
-    Applitools::Eyes.new
-  end
-end

data/spec/test_app.rb

@@ -1,11 +0,0 @@
-require 'sinatra/base'
-require 'rack'
-
-class TestApp < Sinatra::Base
-  set :root, File.dirname(__FILE__)
-  set :static, true
-
-  get '/' do
-    'Hello world!'
-  end
-end