rudra 1.0.17 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6b9b8353fbb965300bb0e6c9a96ef162717fc1b7e3afaa46192d414a0828584
-  data.tar.gz: 5ca513a1614e4c9fbae46dc5caf4636d5b579fd8e1fc74c6f745cc61d7d9ddcf
+  metadata.gz: fea1605ee31709cb1dcb4c868ec5df73c650b459dcafea5c78504b3e90abe4f6
+  data.tar.gz: 0e3ea81a32db0e5f85e3b90af70abac74c54842dc8556f57256fc1f39b1e3f0e
 SHA512:
-  metadata.gz: e775d57a29612f265578c1ecfd665e093f837460b32012763ab88983d47a1b7ae674903e1e5169b30609e65cce59d621800ab20500013d506b4dd8120fa76f55
-  data.tar.gz: 98b306bd3f397ae54f53224fa88d57aacb5d6b6699a92706440626ddbe8dee4d75e3d7ff751fd71e2d64d0bd88a3e95852d1680720b7731fed6eccb22a7213bc
+  metadata.gz: 3634c208291be7f59897a94b85c1cec4b2666db41551b5aad64b3761590819524c7a43ea501dbf031285284bb5df6ab2f12d0354d5428707bd17f76e3da6d4c7
+  data.tar.gz: 1359e36111a9f186fbc53d8d7b7e183f0c6f40465a895e28d28a6ab54a0e680b2235b2a8f2dfe2b7fa358b788a85e74bb68c5259d2c7fbeca978b174dfe85d6c

data/lib/rudra.rb

@@ -1,5 +1,9 @@
 require 'selenium-webdriver'
 require 'webdrivers'
+require 'zip'
+require 'base64'
+require 'json'
+require 'stringio'
 
 # Selenium IDE-like WebDriver based upon Ruby binding
 # @author Aaron Chen
@@ -11,9 +15,12 @@ require 'webdrivers'
 # @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] auth_username username for Basic Access Authentication Extension (Chrome only)
+# @attr_reader [String] auth_password password for Basic Access Authentication Extension (Chrome only)
 class Rudra
   # Supported Browsers
   BROWSERS = %i[chrome firefox ie safari].freeze
@@ -28,12 +35,14 @@ class Rudra
   ATTRIBUTES = %i[
     browser driver install_dir locale
     headless window_size screen_dir
-    log_prefix timeout verbose
+    log_prefix timeout verbose silent
+    auth_username auth_password
   ].freeze
 
   attr_reader :browser, :driver, :install_dir, :locale,
               :headless, :window_size, :screen_dir,
-              :log_prefix, :timeout, :verbose
+              :log_prefix, :timeout, :verbose, :silent,
+              :auth_username, :auth_password
 
   # Initialize an instance of Rudra
   # @param [Hash] options the options to initialize Rudra
@@ -45,9 +54,12 @@ class Rudra
   # @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] :auth_username ('') username for Basic Access Authentication extension
+  # @option options [String] :auth_password ('') password for Basic Access Authentication extension
   def initialize(options = {})
     self.browser = options.fetch(:browser, :chrome)
     self.install_dir = options.fetch(:install_dir, './webdrivers/')
@@ -56,7 +68,10 @@ class Rudra
     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.auth_username = options.fetch(:auth_username, '')
+    self.auth_password = options.fetch(:auth_password, '')
     self.main_label = caller_locations(2, 1).first.label
 
     initialize_driver
@@ -146,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,
@@ -174,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? }
 
@@ -186,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
@@ -265,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
@@ -280,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
@@ -301,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
@@ -336,6 +384,50 @@ class Rudra
     wait_for { find_element(locator).enabled? }
   end
 
+  # Switch to a frame and wait until the element, identified by locator, is found
+  # @param [String] frame_id the frame id
+  # @param [String] locator the locator to identify the element
+  def switch_to_frame_and_wait_for_element_found(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)
@@ -384,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
@@ -419,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
@@ -732,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
   #
@@ -1069,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 +1213,7 @@ class Rudra
   private
 
   attr_accessor :main_label
-  attr_writer :window_size
+  attr_writer :silent, :window_size, :auth_username, :auth_password
 
   def browser=(brw)
     unless BROWSERS.include?(brw)
@@ -1153,6 +1284,10 @@ class Rudra
       options.add_argument('--headless')
       options.add_argument("--window-size=#{window_size}")
     end
+    if auth_username && auth_password
+      encoded = chrome_basic_auth_extension(auth_username, auth_password)
+      options.add_encoded_extension(encoded)
+    end
     options.add_option(
       'excludeSwitches',
       %w[enable-automation enable-logging]
@@ -1197,7 +1332,7 @@ 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
@@ -1212,9 +1347,61 @@ class Rudra
     )
   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 Access Authentication Extension',
+      "version": '1.0.0',
+      "permissions": ['*://*/*', 'webRequest', 'webRequestBlocking'],
+      "background": {
+        "scripts": ['background.js']
+      }
+    }
+
+    background = <<~JAVASCRIPT
+      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']
+      );
+    JAVASCRIPT
+
+    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.17
+  version: 1.1.4
 platform: ruby
 authors:
 - Aaron Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-04 00:00:00.000000000 Z
+date: 2020-06-19 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