eyes_selenium 2.15.0 → 2.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5d8d5bd76a819da52f7fc72a1c81a923c9f9a97
-  data.tar.gz: 1330ef8e52a1a9e0c772c6000dcb55303f8fc86c
+  metadata.gz: 47b395b9cd5931cd1cdf51770296824d4123540e
+  data.tar.gz: ed4cfaadc2824b1140d64abee6322e08a5a99e94
 SHA512:
-  metadata.gz: c587d0a9605ca5547e0b17b561a4b243a25ffa4d1ec7d72f2b8de1fece7d7c576f5262122854d15581ec793439c75188d4132fa91eaa89537e38ec8604bd236d
-  data.tar.gz: 5f9fbb8dbab7175f7cadaec99bc119a98772c5b56000015a347713a4b2dbfde93e09c786fab71bb6c06eac0cdacb5f52ed505959b3dda3d3f23e4060d6bc5094
+  metadata.gz: a7f9f968f8be5d0108c768084e00213a575b946abdad64de5b389008439f8ffcc2ab24892ddf68f43229ba4d51202bb9ec509b478e87f94640ce7d108f7a09f6
+  data.tar.gz: 5fa006f0a50e22a1e9e2e31a17b31d25c47f11f90e98f1ecb70c051473fb998561bb1ec2b0031cdb859fc651077de559c086d2e4374d12d08df540f49cc9d325

data/.gitignore

@@ -15,6 +15,4 @@ rdoc
 .idea/
 .idea-*/
 spec/reports
-test/tmp
-test/version_tmp
 tmp

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2
+  - ruby-head
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+# Use the faster container based infrastructure.
+sudo: false
+before_install:
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in applitools.gemspec
+# Specify your gem's dependencies in eyes_selenium.gemspec
 gemspec

data/README.md

@@ -1,4 +1,8 @@
-# Applitools [![Gem Version](https://badge.fury.io/rb/eyes_selenium.svg)](https://rubygems.org/gems/eyes_selenium)
+# Applitools
+
+[![Gem Version](https://badge.fury.io/rb/eyes_selenium.svg)](http://badge.fury.io/rb/eyes_selenium)
+[![Build Status](https://travis-ci.org/applitools/Eyes.Selenium.Ruby.svg)](https://travis-ci.org/applitools/Eyes.Selenium.Ruby)
+[![Dependency Status](https://gemnasium.com/applitools/Eyes.Selenium.Ruby.svg)](https://gemnasium.com/applitools/Eyes.Selenium.Ruby)
 
 Applitools Ruby SDK.
 
@@ -6,15 +10,21 @@ Applitools Ruby SDK.
 
 Add this line to your application's Gemfile:
 
-    gem 'eyes_selenium'
+```ruby
+gem 'eyes_selenium'
+```
 
 And then execute:
 
-    $ bundle
+```ruby
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install eyes_selenium
+```bash
+gem install eyes_selenium
+```
 
 ## Usage
 Please check the applitools website for usage instructions: http://www.applitools.com

data/Rakefile

@@ -1 +1,8 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+Bundler::GemHelper.install_tasks
+
+task :default => :spec

data/eyes_selenium.gemspec

@@ -1,30 +1,39 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'eyes_selenium/version'
+require 'applitools/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "eyes_selenium"
+  spec.name          = 'eyes_selenium'
   spec.version       = Applitools::VERSION
-  spec.authors       = ["Applitools team"]
-  spec.email         = ["team@applitools.com"]
-  spec.description   = "Applitools Ruby SDK"
-  spec.summary       = "Applitools Ruby SDK"
-  spec.homepage      = "http://www.applitools.com"
-  spec.license       = "Apache License, Version 2.0"
+  spec.authors       = ['Applitools Team']
+  spec.email         = ['team@applitools.com']
+  spec.description   = 'Applitools Ruby SDK'
+  spec.summary       = 'Applitools Ruby SDK'
+  spec.homepage      = 'https://www.applitools.com'
+  spec.license       = 'Apache License, Version 2.0'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "selenium-webdriver", [">= 2.45.0"]
-  spec.add_dependency "httparty"
-  spec.add_dependency "oily_png", [">= 1.1.0"] 
+  spec.add_dependency 'selenium-webdriver', '>= 2.45.0'
+  spec.add_dependency 'oily_png'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'oj'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", [">= 2.2.0"]
-  spec.add_development_dependency "capybara", [">= 2.1.0"]
-  spec.add_development_dependency "sinatra"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 3'
+  spec.add_development_dependency 'watir-webdriver'
+  spec.add_development_dependency 'appium_lib'
+
+  # Exclude debugging support on Travis CI, due to its incompatibility with jruby and older rubies.
+  unless ENV['TRAVIS']
+    spec.add_development_dependency 'pry'
+    spec.add_development_dependency 'pry-byebug'
+    spec.add_development_dependency 'pry-doc'
+    spec.add_development_dependency 'pry-stack_explorer'
+  end
 end

data/lib/applitools/base/batch_info.rb

@@ -0,0 +1,19 @@
+require 'securerandom'
+
+module Applitools::Base
+  class BatchInfo
+    def initialize(name = nil, started_at = Time.now)
+      @name = name
+      @started_at = started_at
+      @id = SecureRandom.uuid
+    end
+
+    def to_hash
+      {
+        id: @id,
+        name: @name,
+        started_at: @started_at.iso8601
+      }
+    end
+  end
+end

data/lib/applitools/base/dimension.rb

@@ -0,0 +1,21 @@
+module Applitools::Base
+  class Dimension
+    attr_accessor :width, :height
+
+    def initialize(width, height)
+      @width = width
+      @height = height
+    end
+
+    def to_hash
+      {
+        width: width,
+        height: height
+      }
+    end
+
+    def values
+      [width, height]
+    end
+  end
+end

data/lib/applitools/base/environment.rb

@@ -0,0 +1,19 @@
+module Applitools::Base
+  class Environment
+    def initialize(os = nil, hosting_app = nil, display_size = nil, inferred = nil)
+      @os = os
+      @hosting_app = hosting_app
+      @display_size = display_size
+      @inferred = inferred
+    end
+
+    def to_hash
+      {
+        os: @os,
+        hosting_app: @hosting_app,
+        display_size: @display_size.to_hash,
+        inferred: @inferred
+      }
+    end
+  end
+end

data/lib/applitools/base/mouse_trigger.rb

@@ -0,0 +1,33 @@
+module Applitools::Base
+  class MouseTrigger
+    MOUSE_ACTION = {
+      click: 'Click',
+      right_click: 'RightClick',
+      double_click: 'DoubleClick',
+      move: 'Move',
+      down: 'Down',
+      up: 'Up'
+     }.freeze
+
+    attr_reader :mouse_action, :control, :location
+
+    def initialize(mouse_action, control, location)
+      @mouse_action = mouse_action
+      @control = control
+      @location = location
+    end
+
+    def to_hash
+      {
+        trigget_type: 'Mouse',
+        mouse_action: MOUSE_ACTION[mouse_action],
+        control: control.to_hash,
+        location: location.to_hash
+      }
+    end
+
+    def to_s
+      "#{mouse_action} [#{control}] #{location.x}, #{location.y}"
+    end
+  end
+end

data/lib/applitools/base/point.rb

@@ -0,0 +1,21 @@
+module Applitools::Base
+  class Point
+    attr_accessor :x, :y
+
+    def initialize(x, y)
+      @x = x
+      @y = y
+    end
+
+    def to_hash
+      {
+        x: x,
+        y: y
+      }
+    end
+
+    def values
+      [x, y]
+    end
+  end
+end

data/lib/applitools/base/region.rb

@@ -0,0 +1,77 @@
+module Applitools::Base
+  class Region
+    attr_accessor :left, :top, :width, :height
+
+    def initialize(left, top, width, height)
+      @left = left.round
+      @top = top.round
+      @width = width.round
+      @height = height.round
+    end
+
+    EMPTY = Applitools::Base::Region.new(0, 0, 0, 0)
+
+    def make_empty
+      @left = EMPTY.left
+      @top = EMPTY.top
+      @width = EMPTY.width
+      @height = EMPTY.height
+    end
+
+    def empty?
+       @left == EMPTY.left && @top == EMPTY.top && @width == EMPTY.width && @height == EMPTY.height
+    end
+
+    def right
+      left + width
+    end
+
+    def bottom
+      top + height
+    end
+
+    def intersecting?(other)
+      ((left <= other.left && other.left <= right) || (other.left <= left && left <= other.right)) \
+      && ((top <= other.top && other.top <= bottom) || (other.top <= top && top <=other.bottom))
+    end
+
+    def intersect(other)
+      if !intersecting?(other)
+        make_empty and return
+      end
+      i_left = (left >= other.left) ? left : other.left
+      i_right = (right <= other.right) ? right : other.right
+      i_top = (top >= other.top) ? top : other.top
+      i_bottom = (bottom <= other.bottom) ? bottom : other.bottom
+
+      @left = i_left
+      @top = i_top
+      @width = i_right - i_left
+      @height = i_bottom - i_top
+    end
+
+    def contains?(other_left, other_top)
+      other_left >= left && other_left <= right && \
+      other_top >= top && other_top <= bottom
+    end
+
+    def middle_offset
+      mid_x = width / 2
+      mid_y = height / 2
+      Applitools::Base::Point.new(mid_x.round, mid_y.round)
+    end
+
+    def to_hash
+      {
+        left: left,
+        top: top,
+        height: height,
+        width: width
+      }
+    end
+
+    def to_s
+      "(#{left}, #{top}), #{width} x #{height}"
+    end
+  end
+end

data/lib/applitools/base/server_connector.rb

@@ -0,0 +1,113 @@
+require 'faraday'
+
+require 'oj'
+Oj.default_options = {:mode => :compat }
+
+require 'uri'
+
+module Applitools::Base::ServerConnector
+  extend self
+
+  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.freeze
+
+  API_SESSIONS_RUNNING =  '/api/sessions/running/'.freeze
+
+  HTTP_STATUS_CODES = {
+    created: 201,
+    accepted: 202
+  }.freeze
+
+  attr_accessor :server_url, :api_key
+  attr_reader :endpoint_url
+
+  def server_url=(url)
+    @server_url = url.nil? ? DEFAULT_SERVER_URL : url
+    @endpoint_url = URI.join(@server_url, API_SESSIONS_RUNNING).to_s
+  end
+
+  def match_window(session, data)
+    # Notice that this does not include the screenshot.
+    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...'
+
+    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}") unless res.success?
+
+    Oj.load(res.body)['asExpected'].tap do |as_expected|
+      Applitools::EyesLogger.debug "Got response! #{as_expected}"
+    end
+  end
+
+  def start_session(session_start_info)
+    res = post(endpoint_url, body: Oj.dump(startInfo: Applitools::Utils.camelcase_hash_keys(session_start_info.to_hash)))
+    raise Applitools::EyesError.new("Request failed: #{res.status}") unless res.success?
+
+    response = Oj.load(res.body)
+    Applitools::Base::Session.new(response['id'], response['url'], res.status == HTTP_STATUS_CODES[:created])
+  end
+
+  def stop_session(session, aborted = nil, save = false)
+    res = long_delete(URI.join(endpoint_url, session.id.to_s), query: {aborted: aborted, updateBaseline: save})
+    raise Applitools::EyesError.new("Request failed: #{res.status}") unless res.success?
+
+    response = Oj.load(res.body)
+    response.delete('$id')
+    Applitools::Base::TestResults.new(*response.values)
+  end
+
+  private
+
+  DEFAULT_HEADERS = {
+    'Accept' => 'application/json',
+    'Content-Type' => 'application/json'
+  }.freeze
+
+  LONG_REQUEST_DELAY = 2.freeze # seconds
+  MAX_LONG_REQUEST_DELAY = 10.freeze # seconds
+  LONG_REQUEST_DELAY_MULTIPLICATIVE_INCREASE_FACTOR = 1.5.freeze
+
+  [:get, :post, :delete].each do |method|
+    define_method method do |url, options = {}|
+      request(url, method, options)
+    end
+
+    define_method "long_#{method}" do |url, options = {}|
+      long_request(url, method, options)
+    end
+  end
+
+  def request(url, method, options = {})
+    Faraday::Connection.new(url, ssl: {ca_file: SSL_CERT}).send(method) do |req|
+      req.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 = {apiKey: api_key}.merge(options[:query] || {})
+      req.body = options[:body]
+    end
+  end
+
+  def long_request(url, method, options = {})
+    delay = LONG_REQUEST_DELAY
+    (options[:headers] ||= {})['Eyes-Expect'] = '202-accepted'
+
+    while true
+      # Date should be in RFC 1123 format.
+      options[:headers]['Eyes-Date'] = Time.now.utc.strftime('%a, %d %b %Y %H:%M:%S GMT')
+
+      res = request(url, method, options)
+      return res unless res.status == HTTP_STATUS_CODES[:accepted]
+
+      Applitools::EyesLogger.debug "Still running... retrying in #{delay}s"
+      sleep delay
+
+      delay = [MAX_LONG_REQUEST_DELAY, (delay * LONG_REQUEST_DELAY_MULTIPLICATIVE_INCREASE_FACTOR).round].min
+    end
+  end
+
+  include Applitools::MethodTracer
+end