rudra 1.1.1 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff3f69221a8e01fb0c0bf5a517c11547872f475b4cdc7aa551a26f81929c8373
-  data.tar.gz: e039db5f85576af890d9b58f8deed4f7f30cf09ea474d8b2226c6574cad9c115
+  metadata.gz: dd2c656d270051d403273294621ca5d21a9986b63ac082165d2453025e77abcf
+  data.tar.gz: 70eca0978aba2ee93fec2077e7999acf492b1083812d99ade02efc475a684ff7
 SHA512:
-  metadata.gz: a632f5ee68fa9417a78e86642246c47d2b4480292ca4816471b8f948458d7c6444150ccb7eb1a65fe8d7167f25dca32e1271f97cd725dbc86643362d763d4361
-  data.tar.gz: 9edc12b61b22302ef0d80698a682d859a124acaa7c3d121d87353f83c84fef948f9fa93971ce85074c4b7faf52b27bf9ebef4bdedcb14429a8ef7222b73854f3
+  metadata.gz: 1aa0e5fb07ad8b52d7e459bab2786f1a244a83cefa93ed41226dbbd58724e57c1e367b29aa425c85e52201595f36f02293d2c1edcfadecb96282437aada12aad
+  data.tar.gz: 47ef76f3d85928a7ba445a69d8e62a382db233f128cbc002e6c8a074b607b105a5a4b0043567156368103bf05d319041bf2789c35b3dc32c8b10775264bdedad

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
@@ -15,6 +19,8 @@ require 'webdrivers'
 # @attr_reader [Integer] timeout The driver timeout
 # @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
@@ -30,11 +36,13 @@ class Rudra
     browser driver install_dir locale
     headless window_size screen_dir
     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, :silent
+              :log_prefix, :timeout, :verbose, :silent,
+              :auth_username, :auth_password
 
   # Initialize an instance of Rudra
   # @param [Hash] options the options to initialize Rudra
@@ -50,6 +58,8 @@ class Rudra
   # @option options [Integer] :timeout (30) implicit_wait timeout
   # @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/')
@@ -60,6 +70,8 @@ class Rudra
     self.log_prefix = options.fetch(:log_prefix, ' - ')
     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
@@ -149,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,
@@ -292,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
@@ -349,10 +384,10 @@ class Rudra
     wait_for { find_element(locator).enabled? }
   end
 
-  # Wait until the element, identified by locator, is found in frame
+  # 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 wait_for_element_found_in_frame(frame_id, locator)
+  def switch_to_frame_and_wait_for_element_found(frame_id, locator)
     switch_to_frame frame_id
 
     how, what = parse_locator(locator)
@@ -370,16 +405,16 @@ class Rudra
   # @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 = 2)
+  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::NoSuchElementError
-          true
         rescue Selenium::WebDriver::Error::StaleElementReferenceError
           false
         end
@@ -388,6 +423,8 @@ class Rudra
       true
     rescue Net::ReadTimeout
       true
+    ensure
+      implicit_wait(timeout)
     end
   end
 
@@ -476,7 +513,8 @@ class Rudra
   def click(locator)
     wait_for do
       begin
-        find_element(locator).click.nil?
+        element = find_element(locator)
+        element.enabled? && element.click.nil?
       rescue Selenium::WebDriver::Error::ElementClickInterceptedError
         false
       end
@@ -1175,7 +1213,7 @@ class Rudra
   private
 
   attr_accessor :main_label
-  attr_writer :silent, :window_size
+  attr_writer :silent, :window_size, :auth_username, :auth_password
 
   def browser=(brw)
     unless BROWSERS.include?(brw)
@@ -1242,10 +1280,23 @@ class Rudra
   def chrome_options
     options = Selenium::WebDriver::Chrome::Options.new
     options.add_argument('--disable-notifications')
+    options.add_argument('--ignore-ssl-errors=yes')
+    options.add_argument('--ignore-certificate-errors')
+
     if headless
       options.add_argument('--headless')
       options.add_argument("--window-size=#{window_size}")
     end
+
+    if auth_username
+      if headless
+        $stdout.puts('Basic Access Authentication Extension cannot be installed while headless')
+      else
+        encoded = chrome_basic_auth_extension(auth_username, auth_password)
+        options.add_encoded_extension(encoded)
+      end
+    end
+
     options.add_option(
       'excludeSwitches',
       %w[enable-automation enable-logging]
@@ -1305,9 +1356,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.1.1
+  version: 1.1.6
 platform: ruby
 authors:
 - Aaron Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-12 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -44,6 +44,26 @@ dependencies:
     - - "~>"
       - !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