eyes_selenium 1.40.0 → 2.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZGIwYmU3YzViYzJmNWI2Mzg3NzFjZWZiYjg5OTIzMDE2NTQwODYyZQ==
-  data.tar.gz: !binary |-
-    NzdkZDQxZTEzMDFlYTc5YWI5Mzg3Yzk0NmNjZDYyMzhlNDlmOThkZA==
+SHA1:
+  metadata.gz: 044cf5e9768b727cff07d095e52743a1fb7de84f
+  data.tar.gz: c21b7f05504ef82c53736aede6362db9b517078a
 SHA512:
-  metadata.gz: !binary |-
-    YjA0ZTVmNzI2NjNlZjQ4Yzk1NmE0ZWJkYjUxMTM0OWY3NzcyYzRkZjg2YTVi
-    ODA4ZDFkNzQ2MDQ3NTMzZThmYjkyMGJmOGIwNzQxZTA5ODMxNWQyZWM1ZmRl
-    Mjk4OGI1NWI1NDYyY2U0NjM3OWEwNDJiOTViM2EyYjQ0N2E3YTE=
-  data.tar.gz: !binary |-
-    ZmY1NzY2MGViNGUwMGZmY2EwMDQ4NzM1YTZhODMyOThjM2UxY2JjOTkwMGI0
-    NjMwNGQ0N2Q2MDc2MjJkNGIyYjljYWY2YWVkMGFjNTUyZWIyNThhMDU5MjBi
-    MDVlN2U0YmI4ZTM4YWU1YmQ4Yzk0ZTQ3ZDYwNTg1YWQ2NGQwYWE=
+  metadata.gz: a21b00d31a5e8bc57c53a3a19cc0c149994057c1c5f68bc3a4df9eb5f7c3607ca47f8994d67a2c9800878185758048081f15f2c88d48aa4ac7034190ab837fd3
+  data.tar.gz: 3c06337c9fbabdc89169b7baea3e02523eeae435841f74634d190fce8e1c49d1e27c0d623827f52f562ae2bc053e5c8cf218946cc6d9902162a2095d923d7465

data/appium_eyes_example.rb

@@ -1,47 +1,47 @@
-require 'eyes_selenium'
-
-Applitools::Eyes.api_key = 'YOUR_API_KEY'
-
-## 
-# Based on Appium example: https://github.com/appium/appium/blob/master/sample-code/examples/ruby/
-
-desired_capabilities = {
-    "device" => "Android",
-    "version" => "4.2",
-    "app" => "http://appium.s3.amazonaws.com/NotesList.apk",
-    "app-package" => "com.example.android.notepad",
-    "app-activity" => ".NotesList"
-}
-
-def create_note(text)
-	@driver.find_element(:name, "New note").click
-	@driver.find_element(:tag_name, "textfield").send_keys text
-	@eyes.check_window("Note: #{text}")
-	@driver.find_element(:name, "Save").click
-end
-
-def clear_note_by_text(text)
-	@driver.find_element(:name, "#{text}").click
-	@driver.find_element(:tag_name, "textfield").clear
-	@driver.find_element(:name, "Save").click
-end
-
-@eyes = Applitools::Eyes.new
-begin
-	@driver = Selenium::WebDriver.for(:remote, :url => 'http://127.0.0.1:4723/wd/hub', :desired_capabilities => desired_capabilities)
-	@driver = @eyes.open(app_name: 'Selenium Israel', test_name: 'Appium Notepad', driver: @driver)
-	@eyes.check_window("No notes")
-
-	create_note "I didn't expect a kind of Spanish Inquisition!"
-	create_note "Nobody expects the Spanish Inquisition!"
-	@eyes.check_window("Two notes")
-
-	clear_note_by_text "I didn't expect a kind of Spanish Inquisition!"
-	@eyes.check_window("One note")
-
-	@eyes.close
-ensure
-	sleep 5
-	@eyes.abort_if_not_closed
-	@driver.quit
-end
+require 'eyes_selenium'
+
+Applitools::Eyes.api_key = 'YOUR_API_KEY'
+
+## 
+# Based on Appium example: https://github.com/appium/appium/blob/master/sample-code/examples/ruby/
+
+desired_capabilities = {
+    "device" => "Android",
+    "version" => "4.2",
+    "app" => "http://appium.s3.amazonaws.com/NotesList.apk",
+    "app-package" => "com.example.android.notepad",
+    "app-activity" => ".NotesList"
+}
+
+def create_note(text)
+	@driver.find_element(:name, "New note").click
+	@driver.find_element(:tag_name, "textfield").send_keys text
+	@eyes.check_window("Note: #{text}")
+	@driver.find_element(:name, "Save").click
+end
+
+def clear_note_by_text(text)
+	@driver.find_element(:name, "#{text}").click
+	@driver.find_element(:tag_name, "textfield").clear
+	@driver.find_element(:name, "Save").click
+end
+
+@eyes = Applitools::Eyes.new
+begin
+	@driver = Selenium::WebDriver.for(:remote, :url => 'http://127.0.0.1:4723/wd/hub', :desired_capabilities => desired_capabilities)
+	@driver = @eyes.open(app_name: 'Selenium Israel', test_name: 'Appium Notepad', driver: @driver)
+	@eyes.check_window("No notes")
+
+	create_note "I didn't expect a kind of Spanish Inquisition!"
+	create_note "Nobody expects the Spanish Inquisition!"
+	@eyes.check_window("Two notes")
+
+	clear_note_by_text "I didn't expect a kind of Spanish Inquisition!"
+	@eyes.check_window("One note")
+
+	@eyes.close
+ensure
+	sleep 5
+	@eyes.abort_if_not_closed
+	@driver.quit
+end

data/lib/eyes_selenium/eyes/agent_connector.rb

@@ -4,13 +4,21 @@ class Applitools::AgentConnector
   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
-  def initialize(base_uri, username, password)
-    # Remove trailing slashes in base uri and add the running sessions endpoint uri.
-    @uri = base_uri.gsub(/\/$/,"") + "/api/sessions/running"
-    @auth = { username: username, password: password }
+  # comment out when not debugging
+  #http_proxy 'localhost', 8888
+  #debug_output $stdout
+
+  attr_accessor :server_url, :api_key
+
+  def server_url=(server_url)
+    @server_url = server_url
+    # Remove trailing slashes in server url and add the running sessions endpoint uri.
+    @endpoint_uri = server_url.gsub(/\/$/,'') + '/api/sessions/running'
+  end
+
+  def initialize(server_url)
+    self.server_url = server_url
   end
 
   def match_window(session, data)
@@ -18,26 +26,26 @@ class Applitools::AgentConnector
     json_data = data.to_hash.to_json.force_encoding('BINARY') # Notice that this does not include the screenshot
     body = [json_data.length].pack('L>') + json_data + data.screenshot
 
-    res = self.class.post(uri + "/#{session.id}",basic_auth: auth, body: body)
-    raise Applitools::EyesError.new("could not connect to server") if res.code != 200
-    res.parsed_response["asExpected"]
+    res = self.class.post(@endpoint_uri + "/#{session.id}", query: {apiKey: api_key}, body: body)
+    raise Applitools::EyesError.new('could not connect to server') if res.code != 200
+    res.parsed_response['asExpected']
   end
 
   def start_session(session_start_info)
    self.class.headers 'Content-Type' => 'application/json'
-   res = self.class.post(uri, basic_auth: auth, body: { startInfo: session_start_info.to_hash }.to_json)
+   res = self.class.post(@endpoint_uri, query: {apiKey: api_key}, body: { startInfo: session_start_info.to_hash }.to_json)
    status_code = res.response.message
    parsed_res = res.parsed_response
-   Applitools::Session.new(parsed_res["id"], parsed_res["url"], status_code == "Created" )
+   Applitools::Session.new(parsed_res['id'], parsed_res['url'], status_code == 'Created' )
   end
 
   def stop_session(session, aborted=nil, save=false)
     self.class.headers 'Content-Type' => 'application/json'
     res = self.class.send_long_request('stop_session') do
-        self.class.delete(uri + "/#{session.id}", basic_auth: auth, query: { aborted: aborted.to_s, updateBaseline: save.to_s })
+        self.class.delete(@endpoint_uri + "/#{session.id}", query: { aborted: aborted.to_s, updateBaseline: save.to_s, apiKey: api_key })
     end
     parsed_res = res.parsed_response
-    parsed_res.delete("$id")
+    parsed_res.delete('$id')
     Applitools::TestResults.new(*parsed_res.values)
   end
 
@@ -47,6 +55,7 @@ class Applitools::AgentConnector
   # Args:
   #   name: (String) name of the method being executed
   #   request_block: (block) The actual block to be executed. Will be called using "yield"
+  # noinspection RubyUnusedLocalVariable
   def self.send_long_request(name, &request_block)
     delay = 2  # seconds
 

data/lib/eyes_selenium/eyes/eyes.rb

@@ -1,32 +1,52 @@
 class Applitools::Eyes
 
   DEFAULT_MATCH_TIMEOUT = 2.0
-  AGENT_ID = 'eyes.selenium.ruby/' + Applitools::VERSION
+  BASE_AGENT_ID = 'eyes.selenium.ruby/' + Applitools::VERSION
   DEFAULT_EYES_SERVER = 'https://eyessdk.applitools.com'
 
-  class << self
-    attr_accessor :api_key
-
-    def log_handler=(handler)
-      EyesLogger.log_handler = handler
-    end
-  end
-
-  # Class instance variables (static variables)
-  @api_key = nil
-
   private
-  attr_reader :agent_connector
+  attr_reader :agent_connector, :full_agent_id
   attr_accessor :session, :session_start_info, :match_window_task, :should_match_window_run_once_on_timeout,
                 :dont_get_title
 
   public
-  attr_reader :disabled, :app_name, :test_name, :is_open, :viewport_size, :failure_reports, :match_level, :driver
+  attr_reader :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,
-                :save_new_tests, :save_failed_tests
+                :save_new_tests, :save_failed_tests, :api_key, :is_disabled, :server_url, :agent_id, :log_handler
+
+  def log_handler
+    EyesLogger.log_handler
+  end
+
+  def log_handler=(handler)
+    EyesLogger.log_handler = handler
+  end
 
   def api_key
-    self.class.api_key
+    @agent_connector.api_key
+  end
+
+  def api_key=(api_key)
+    @agent_connector.api_key = api_key
+  end
+
+  def server_url
+    @agent_connector.server_url
+  end
+
+  def server_url=(server_url)
+    if server_url.nil?
+      @agent_connector.server_url = DEFAULT_EYES_SERVER
+    else
+      @agent_connector.server_url = server_url
+    end
+  end
+
+  def full_agent_id
+    if agent_id.nil?
+      return BASE_AGENT_ID
+    end
+    "#{agent_id} [#{BASE_AGENT_ID}]"
   end
 
   def title
@@ -42,13 +62,14 @@ class Applitools::Eyes
 
   def initialize(params={})
 
-    @disabled = params[:disabled]
+    @is_disabled = false
 
     return if disabled?
 
+    @api_key = nil
     @user_inputs = []
     server_url = params.fetch(:server_url, DEFAULT_EYES_SERVER)
-    @agent_connector = Applitools::AgentConnector.new(server_url, AGENT_ID, api_key)
+    @agent_connector = Applitools::AgentConnector.new(server_url)
     @match_timeout = DEFAULT_MATCH_TIMEOUT
     @failure_reports = Applitools::FailureReports::ON_CLOSE
     @save_new_tests = true
@@ -146,8 +167,8 @@ class Applitools::Eyes
       instructions = "Please approve the new baseline at #{session_results_url}"
       EyesLogger.info "--- New test ended.  #{instructions}"
       if raise_ex
-        message = "' #{session_start_info.scenario_id_or_name} of"\
-                " #{session_start_info.app_id_or_name}. #{instructions}"
+        message = "'#{session_start_info.scenario_id_or_name}' of"\
+                " '#{session_start_info.app_id_or_name}'. #{instructions}"
         raise Applitools::NewTestError.new(message, results)
       end
       return results
@@ -158,7 +179,7 @@ class Applitools::Eyes
       EyesLogger.info "--- Failed test ended. See details at #{session_results_url}"
       if raise_ex
         message = "'#{session_start_info.scenario_id_or_name}' of"\
-                "#{session_start_info.app_id_or_name}''. see details at #{session_results_url}"
+                " '#{session_start_info.app_id_or_name}'. see details at #{session_results_url}"
         raise Applitools::TestFailedError.new(message, results)
       end
       return results
@@ -207,7 +228,7 @@ class Applitools::Eyes
   private
 
     def disabled? 
-      disabled
+      is_disabled
     end
 
     def get_driver(params)
@@ -246,7 +267,7 @@ class Applitools::Eyes
       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
+          full_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?

data/lib/eyes_selenium/version.rb

@@ -1,3 +1,3 @@
 module Applitools
-  VERSION = '1.40.0'
+  VERSION = '2.1.0'
 end

data/test_script.rb

@@ -1,16 +1,14 @@
-## Before running this, please install ruby(installtion changes depending on machine)
-## Then install rake via `gem install rake` (all ruby developers use this gem)
-## run `./rake install` in applitools root directory (here), this should install the gem (after we release the gem, users will run `gem install eyes` instead
-
 require 'eyes_selenium'
 require 'logger'
 
-Applitools::Eyes.api_key = 'YOUR_API_KEY'
-Applitools::Eyes.log_handler = Logger.new(STDOUT)
+# require 'openssl'
+# OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
 
 eyes = Applitools::Eyes.new
 
 my_webdriver = Selenium::WebDriver.for :firefox
+eyes.api_key = 'YOUR_API_KEY'
+eyes.log_handler = Logger.new(STDOUT)
 
 begin
   eyes.test(app_name: 'Ruby SDK', test_name: 'Applitools website test', viewport_size: {width: 1024, height: 768}, driver: my_webdriver) do |driver|

metadata

@@ -1,125 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 1.40.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Applitools team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-18 00:00:00.000000000 Z
+date: 2014-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.37'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.37'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: oily_png
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: sinatra
   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: Applitools Ruby SDK
@@ -129,8 +129,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -176,17 +176,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Applitools Ruby SDK