rudra 1.0.16 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 425842a9405ec0a244bca0e722f6eb25cdb881b355346f3d61318a2fde111a25
-  data.tar.gz: 4ed27b935bd5a3192d421fad516fa024fc9783f1f10c2b75da85679717511a70
+  metadata.gz: d1094036482a36f5196cd490c2594b66aabf2eebb1aa6c5adfb2b49c426d03e3
+  data.tar.gz: 4fd39aae44a3cf44d263014147cba3eb50a3c0622445fb0452dfda3f438120a1
 SHA512:
-  metadata.gz: 0aa62d7dcfa60e50e74fcc61a11a264a5e1b20f77355e4776e6821d75d06a4b3ecf9ff89c1a4197d72ace5175fe25163b7b68309f05d5ff64c60aa86e33f1aaa
-  data.tar.gz: 8f4353692ce71ef0276786a0bad7a062c1d88095184947a1d2f682f5ddae0d515764bb958726fe9dfafcc704b9ac40b129659b1a0a277e673e38ffd3e8cf6edc
+  metadata.gz: 8c1fca4fe84b87a53c2681df286f0862fa88fec448af16a4a2752c34dca6c9c0e3686b4a4f4db05fd222d539a08586e6750a524801033d127fda974345f79025
+  data.tar.gz: 813860ba0fa303826bcc1ea916592b73b0b42130c2ecb92082562b576be71a26a445cc3128964cc6b2342d1837d37b0b3855867bf66259b5c772cbe8d1702099

data/lib/rudra.rb

@@ -1,10 +1,9 @@
 require 'selenium-webdriver'
-require 'webdrivers/chromedriver'
-require 'webdrivers/geckodriver'
-require 'webdrivers/iedriver'
-
-# Selenium::WebDriver::Chrome::Service.driver_path = './webdrivers/chromedriver'
-# Selenium::WebDriver::Firefox::Service.driver_path = './webdrivers/geckodriver'
+require 'webdrivers'
+require 'zip'
+require 'base64'
+require 'json'
+require 'stringio'
 
 # Selenium IDE-like WebDriver based upon Ruby binding
 # @author Aaron Chen
@@ -14,10 +13,14 @@ require 'webdrivers/iedriver'
 # @attr_reader [String] install_dir The install directory of WebDrivers
 # @attr_reader [String] locale The browser locale
 # @attr_reader [Boolean] headless Headless mode for Google Chrome
+# @attr_reader [String] window_size Chrome window size when headless
 # @attr_reader [String] screen_dir The screenshot directory of save_screenshot
-# @attr_reader [String] log_prefix Prefix for logging executed methods
+# @attr_reader [String] log_prefix Prefix for logging descriptions and methods
 # @attr_reader [Integer] timeout The driver timeout
-# @attr_reader [Boolean] verbose Verbose mode
+# @attr_reader [Boolean] verbose Turn on/off Verbose mode
+# @attr_reader [Boolean] silent Turn off Turn on/off descriptions
+# @attr_reader [String] chrome_auth_username Chrome Basic Auth Extension - username
+# @attr_reader [String] chrome_auth_password Chrome Basic Auth Extension - password
 class Rudra
   # Supported Browsers
   BROWSERS = %i[chrome firefox ie safari].freeze
@@ -31,13 +34,15 @@ class Rudra
   # Attributes
   ATTRIBUTES = %i[
     browser driver install_dir locale
-    headless screen_dir log_prefix
-    timeout verbose
+    headless window_size screen_dir
+    log_prefix timeout verbose silent
+    chrome_auth_username chrome_auth_password
   ].freeze
 
   attr_reader :browser, :driver, :install_dir, :locale,
-              :headless, :screen_dir, :log_prefix,
-              :timeout, :verbose
+              :headless, :window_size, :screen_dir,
+              :log_prefix, :timeout, :verbose, :silent,
+              :chrome_auth_username, :chrome_auth_password
 
   # Initialize an instance of Rudra
   # @param [Hash] options the options to initialize Rudra
@@ -47,18 +52,26 @@ class Rudra
   #   directory of WebDrivers
   # @option options [Symbol] :locale (:en) the browser locale
   # @option options [Boolean] :headless (false) headless mode
+  # @option options [String] :window_size ('1280,720') window size when headless
   # @option options [String] :screen_dir ('./screens/') the location of screenshots
-  # @option options [String] :log_prefix (' - ') prefix for logging executed methods
+  # @option options [String] :log_prefix (' - ') prefix for logging descriptions and methods
   # @option options [Integer] :timeout (30) implicit_wait timeout
-  # @option options [Boolean] :verbose (true) verbose mode
+  # @option options [Boolean] :verbose (false) Turn on/off verbose mode
+  # @option options [Boolean] :silent (false) Turn on/off descriptions
+  # @option options [String] :chrome_auth_username ('') username for Chrome Basic Auth extension
+  # @option options [String] :chrome_auth_password ('') password for Chrome Basic Auth extension
   def initialize(options = {})
     self.browser = options.fetch(:browser, :chrome)
     self.install_dir = options.fetch(:install_dir, './webdrivers/')
     self.locale = options.fetch(:locale, :en)
     self.headless = options.fetch(:headless, false)
+    self.window_size = options.fetch(:window_size, '1280,720')
     self.screen_dir = options.fetch(:screen_dir, './screens/')
     self.log_prefix = options.fetch(:log_prefix, ' - ')
-    self.verbose = options.fetch(:verbose, true)
+    self.verbose = options.fetch(:verbose, false)
+    self.silent = options.fetch(:silent, false)
+    self.chrome_auth_username = options.fetch(:chrome_auth_username, '')
+    self.chrome_auth_password = options.fetch(:chrome_auth_password, '')
     self.main_label = caller_locations(2, 1).first.label
 
     initialize_driver
@@ -104,6 +117,7 @@ class Rudra
   end
 
   # Send keys to an alert
+  # @param [String] keys keystrokes to send
   def alert_send_keys(keys)
     switch_to_alert.send_keys(keys)
   end
@@ -147,6 +161,26 @@ class Rudra
     driver.manage.delete_cookie(name)
   end
 
+  # Check if an element is found
+  # @param [String, Selenium::WebDriver::Element] locator the locator to
+  #   identify the element or Selenium::WebDriver::Element
+  # @param [Integer] seconds seconds before timed out
+  def element_found?(locator, seconds = 1)
+    how, what = parse_locator(locator)
+
+    implicit_wait(seconds)
+
+    begin
+      wait_for(seconds) { driver.find_element(how, what).displayed? }
+    rescue Selenium::WebDriver::Error::TimeoutError
+      false
+    rescue Net::ReadTimeout
+      false
+    ensure
+      implicit_wait(timeout)
+    end
+  end
+
   # Execute the given JavaScript
   # @param [String] script JavaScript source to execute
   # @param [Selenium::WebDriver::Element, Integer, Float, Boolean, NilClass,
@@ -175,7 +209,7 @@ class Rudra
 
     element ||= driver.find_element(how, what)
 
-    abort("Failed to find element: #{locator}") unless element
+    raise Selenium::WebDriver::Error::NoSuchElementError, "Failed to find element: #{locator}" unless element
 
     wait_for { element.displayed? }
 
@@ -187,8 +221,11 @@ class Rudra
   # @return [Array<Selenium::WebDriver::Element>] the elements found
   def find_elements(locator)
     how, what = parse_locator(locator)
-    driver.find_elements(how, what) ||
-      abort("Failed to find elements: #{locator}")
+    elements = driver.find_elements(how, what)
+
+    raise Selenium::WebDriver::Error::NoSuchElementError, "Failed to find elements: #{locator}" if elements.empty?
+
+    elements
   end
 
   # Move forward a single entry in the browser's history
@@ -208,7 +245,7 @@ class Rudra
 
   # Maximize the current window
   def maximize
-    driver.manage.window.maximize
+    driver.manage.window.maximize unless headless
   end
 
   # Maximize the current window to the size of the screen
@@ -266,6 +303,12 @@ class Rudra
     driver.page_source
   end
 
+  # Print description in the console
+  # @param [String] description description to show
+  def puts(description)
+    $stdout.puts "#{log_prefix}#{description.chomp}" unless silent
+  end
+
   # Refresh the current pagef
   def refresh
     driver.navigate.refresh
@@ -281,13 +324,16 @@ class Rudra
   # Save a PNG screenshot to file
   # @param [String] filename the filename of PNG screenshot
   def save_screenshot(filename)
-    mkdir(@screen_dir) unless Dir.exist?(@screen_dir)
-    driver.save_screenshot(
-      File.join(
-        @screen_dir,
-        filename.end_with?('.png') ? filename : "#{filename}.png"
-      )
+    file = File.join(
+      @screen_dir,
+      sanitize(filename.end_with?('.png') ? filename : "#{filename}.png")
     )
+
+    dir = File.dirname(file)
+
+    mkdir(dir) unless Dir.exist?(dir)
+
+    driver.save_screenshot(file)
   end
 
   # Switch to the currently active modal dialog
@@ -302,6 +348,7 @@ class Rudra
   end
 
   # Switch to the frame with the given id
+  # @param [String] id the frame id
   def switch_to_frame(id)
     driver.switch_to.frame(id)
   end
@@ -337,6 +384,50 @@ class Rudra
     wait_for { find_element(locator).enabled? }
   end
 
+  # Wait until the element, identified by locator, is found in frame
+  # @param [String] frame_id the frame id
+  # @param [String] locator the locator to identify the element
+  def wait_for_element_found_in_frame(frame_id, locator)
+    switch_to_frame frame_id
+
+    how, what = parse_locator(locator)
+
+    wait_for do
+      begin
+        driver.find_element(how, what)
+      rescue Selenium::WebDriver::Error::NoSuchWindowError
+        false
+      end
+    end
+  end
+
+  # Wait (in seconds) until the element is not displayed
+  # @param [String, Selenium::WebDriver::Element] locator the locator to
+  #   identify the element or Selenium::WebDriver::Element
+  # @param [Integer] seconds seconds before timed out
+  def wait_for_not_visible(locator, seconds = 3)
+    how, what = parse_locator(locator)
+
+    implicit_wait(seconds)
+
+    begin
+      wait_for(seconds) do
+        begin
+          elements = driver.find_elements(how, what)
+          elements.empty? || elements.map(&:displayed?).none?
+        rescue Selenium::WebDriver::Error::StaleElementReferenceError
+          false
+        end
+      end
+    rescue Selenium::WebDriver::Error::TimeoutError
+      true
+    rescue Net::ReadTimeout
+      true
+    ensure
+      implicit_wait(timeout)
+    end
+  end
+
   # Wait until the title of the page including the given string
   # @param [String] string the string to compare
   def wait_for_title(string)
@@ -385,7 +476,7 @@ class Rudra
   # @param [String] attribute the name of the attribute
   # @return [String, nil] attribute value
   def attribute(locator, attribute)
-    find_element(locator).property(attribute)
+    find_element(locator).attribute(attribute)
   end
 
   # If the element, identified by locator, has the given attribute
@@ -420,7 +511,14 @@ class Rudra
   # @param [String, Selenium::WebDriver::Element] locator the locator to
   #   identify the element or Selenium::WebDriver::Element
   def click(locator)
-    find_element(locator).click
+    wait_for do
+      begin
+        element = find_element(locator)
+        element.enabled? && element.click.nil?
+      rescue Selenium::WebDriver::Error::ElementClickInterceptedError
+        false
+      end
+    end
   end
 
   # Click the given element, identified by locator, with an offset
@@ -733,6 +831,38 @@ class Rudra
     ), find_element(locator), event)
   end
 
+  # Wait until the element, identified by locator, attribute has value
+  # @param [String, Selenium::WebDriver::Element] locator the locator to identify the element
+  # @param [String] attribute the name of the attribute
+  # @param [String] value the value of the attribute
+  def wait_for_attribute_to_include(locator, attribute, value)
+    how, what = parse_locator(locator)
+
+    wait_for do
+      begin
+        driver.find_element(how, what)&.attribute(attribute)&.downcase&.include?(value.downcase)
+      rescue Selenium::WebDriver::Error::StaleElementReferenceError
+        false
+      end
+    end
+  end
+
+  # Wait until the element, identified by locator, excluding string in text
+  # @param [String, Selenium::WebDriver::Element] locator the locator to
+  #   identify the element or Selenium::WebDriver::Element
+  # @param [String] string the string to exclude
+  def wait_for_text_to_exclude(locator, string)
+    wait_for { text(locator).exclude?(string) }
+  end
+
+  # Wait until the element, identified by locator, including string in text
+  # @param [String, Selenium::WebDriver::Element] locator the locator to
+  #   identify the element or Selenium::WebDriver::Element
+  # @param [String] string the string to compare
+  def wait_for_text_to_include(locator, string)
+    wait_for { text(locator).include?(string) }
+  end
+
   #
   # Tool Functions
   #
@@ -1070,7 +1200,7 @@ class Rudra
   end
 
   (instance_methods - superclass.instance_methods).map do |method_name|
-    next if private_method_defined?(method_name) || ATTRIBUTES.include?(method_name)
+    next if private_method_defined?(method_name) || ATTRIBUTES.include?(method_name) || method_name == :puts
 
     original_method = instance_method(method_name)
 
@@ -1082,7 +1212,8 @@ class Rudra
 
   private
 
-  attr_writer :main_label
+  attr_accessor :main_label
+  attr_writer :silent, :window_size, :chrome_auth_username, :chrome_auth_password
 
   def browser=(brw)
     unless BROWSERS.include?(brw)
@@ -1135,6 +1266,8 @@ class Rudra
   def initialize_driver
     @driver = if browser == :chrome
                 Selenium::WebDriver.for(:chrome, options: chrome_options)
+              # elsif browser == :edge
+              #   Selenium::WebDriver.for(:edge, options: edge_options)
               elsif browser == :firefox
                 Selenium::WebDriver.for(:firefox, options: firefox_options)
               elsif browser == :ie
@@ -1147,7 +1280,14 @@ class Rudra
   def chrome_options
     options = Selenium::WebDriver::Chrome::Options.new
     options.add_argument('--disable-notifications')
-    options.add_argument('--headless') if headless
+    if headless
+      options.add_argument('--headless')
+      options.add_argument("--window-size=#{window_size}")
+    end
+    if chrome_auth_username && chrome_auth_password
+      encoded = chrome_basic_auth_extension(chrome_auth_username, chrome_auth_password)
+      options.add_encoded_extension(encoded)
+    end
     options.add_option(
       'excludeSwitches',
       %w[enable-automation enable-logging]
@@ -1156,6 +1296,10 @@ class Rudra
     options
   end
 
+  # def edge_options
+  #   Selenium::WebDriver::Edge::Options.new
+  # end
+
   def firefox_options
     options = Selenium::WebDriver::Firefox::Options.new
     options.add_preference('intl.accept_languages', locale)
@@ -1188,24 +1332,76 @@ class Rudra
             how.to_sym
           end
 
-    abort("Cannot parse locator: #{locator}") unless HOWS.include?(how)
+    raise Selenium::WebDriver::Error::InvalidSelectorError, "Cannot parse locator: #{locator}" unless HOWS.include?(how)
 
     [how, what]
   end
 
   def log(method_name, *args)
-    return unless @verbose && caller_locations(2, 1).first.label == @main_label
+    return unless verbose && caller_locations(2, 1).first.label == main_label
 
     arguments = args.map(&:to_s).join(', ')
 
-    puts @log_prefix + (
+    puts log_prefix + (
       arguments.empty? ? method_name.to_s : "#{method_name}(#{arguments})"
     )
   end
 
+  def sanitize(filename)
+    invalid_characters = ['/', '\\', '?', '%', '*', ':', '|', '"', '<', '>']
+    invalid_characters.each do |character|
+      filename.gsub!(character, '')
+    end
+    filename
+  end
+
   def random_id(length = 8)
     charset = [(0..9), ('a'..'z')].flat_map(&:to_a)
     id = Array.new(length) { charset.sample }.join
     "rudra_#{id}"
   end
+
+  def chrome_basic_auth_extension(username, password)
+    manifest = {
+      "manifest_version": 2,
+      "name": 'Rudra Basic Auth Extension',
+      "version": '1.0.0',
+      "permissions": ['*://*/*', 'webRequest', 'webRequestBlocking'],
+      "background": {
+        "scripts": ['background.js']
+      }
+    }
+
+    background = <<~JSCRIPT
+      var username = '#{username}';
+      var password = '#{password}';
+
+      chrome.webRequest.onAuthRequired.addListener(
+        function handler(details) {
+          if (username == null) {
+            return { cancel: true };
+          }
+
+          var authCredentials = { username: username, password: username };
+          username = password = null;
+
+          return { authCredentials: authCredentials };
+        },
+        { urls: ['<all_urls>'] },
+        ['blocking']
+      );
+    JSCRIPT
+
+    stringio = Zip::OutputStream.write_buffer do |zos|
+      zos.put_next_entry('manifest.json')
+      zos.write manifest.to_json
+      zos.put_next_entry('background.js')
+      zos.write background
+    end
+    # File.open('basic_auth.crx', 'wb') do |f|
+    #   f << stringio.string
+    # end
+
+    Base64.strict_encode64(stringio.string)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rudra
 version: !ruby/object:Gem::Version
-  version: 1.0.16
+  version: 1.1.3
 platform: ruby
 authors:
 - Aaron Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2020-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -24,6 +24,46 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.25
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement