webaccount 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7be023b85deb2330712bc3202c2215d20c8024ff074ddcf677f08f7720b8994b
+  data.tar.gz: 543880a40c28d83efdd8839927be8c556e752cd5a4a268466af8b184a8f58a48
+SHA512:
+  metadata.gz: cc5e55208933dd0aadf508cc198047d0d174313faf8b49d87e7119bec56d2a6f8bbea7c543a53ffa5a487b2825cec7be955fe92e64b826ca1e4157be767c93fc
+  data.tar.gz: 7e8eb9a63de804731d720729b6d4cb3a5a2b87b9a59e92b02103358f042d4ae3419265a5f069f07fe6a1810ff1f44cc05d21689c86dffe0cdd3be16cbe1b03c9

data/lib/Thoran/Selenium/WebDriver/Driver/Attempt/attempt.rb

@@ -0,0 +1,53 @@
+# Thoran/Selenium/WebDriver/Attempt/attempt.rb
+# Thoran::Selenium::WebDriver::Attempt.attempt
+
+# 20200418
+# 0.0.0
+
+# Examples:
+# 1. driver.attempt do |driver|
+#   driver.get('https://example.com/users/sign_in')
+#   enter_username
+#   enter_password
+#   sign_in
+# end
+
+# Changes:
+# 1. + Thoran namespace.
+
+module Thoran
+  module Selenium
+    module WebDriver
+      module Driver
+        module Attempt
+
+          def attempt(max_attempts = 3, &block)
+            attempts = 0
+            loop do
+              begin
+                yield
+                break
+              rescue Timeout::Error, Selenium::WebDriver::Error::UnknownError, Selenium::WebDriver::Error::NoSuchElementError => e
+                attempts += 1
+                if attempts >= max_attempts
+                  @driver.quit
+                  puts "Giving up after #{max_attempts} attempts to #{__method__} because #{e}."
+                  exit
+                end
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end
+
+module Selenium
+  module WebDriver
+    class Driver
+      include Thoran::Selenium::WebDriver::Driver::Attempt
+    end
+  end
+end

data/lib/Thoran/Selenium/WebDriver/Remote/W3C/Bridge/ConvertLocators/convert_locators.rb

@@ -0,0 +1,51 @@
+# Thoran/Selenium/WebDriver/Remote/W3C/BridgeMonkeyPatch/ConvertLocators.convert_locators.rb
+# Thoran::Selenium::WebDriver::Remote::W3C::BridgeMonkeyPatch::ConvertLocators.convert_locators
+
+# 20200418
+# 0.0.0
+
+# Changes:
+# 1. + Thoran namespace.
+
+module Thoran
+  module Selenium
+    module WebDriver
+      module Remote
+        module W3C
+          module Bridge
+            module ConvertLocators
+
+              def convert_locators(how, what)
+                case how.to_s
+                when 'class name'
+                  how = 'css selector'
+                  what = ".#{escape_css(what)}"
+                when 'id'
+                  how = 'css selector'
+                  what = "##{escape_css(what)}"
+                when 'name'
+                  how = 'css selector'
+                  what = "*[name='#{escape_css(what)}']"
+                when 'tag name'
+                  how = 'css selector'
+                end
+                [how, what]
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+module Selenium
+  module WebDriver
+    module Remote
+      module W3C
+        Bridge.prepend(Thoran::Selenium::WebDriver::Remote::W3C::Bridge::ConvertLocators)
+      end
+    end
+  end
+end

data/lib/Thoran/Selenium/WebDriver/SearchContext/ElementPresentQ/element_presentQ.rb

@@ -0,0 +1,39 @@
+# Thoran/Selenium/WebDriver/SearchContext/ElementPresentQ/element_presentQ.rb
+# Thoran::Selenium::WebDriver::SearchContext::ElementPresentQ.element_present?
+
+# 20200418
+# 0.0.0
+
+# Examples:
+# 1. driver.element_present?(:xpath, '//a[@id="submit"]')
+# 2. driver.element_present?(:id, @logout_button_id)
+
+# Changes:
+# 1. + Thoran namespace.
+
+module Thoran
+  module Selenium
+    module WebDriver
+      module SearchContext
+        module ElementPresentQ
+
+          def element_present?(selector_type, selector)
+            bridge.find_element_by(selector_type, selector)
+            true
+          rescue ::Selenium::WebDriver::Error::NoSuchElementError
+            false
+          end
+
+        end
+      end
+    end
+  end
+end
+
+module Selenium
+  module WebDriver
+    class Driver
+      include Thoran::Selenium::WebDriver::SearchContext::ElementPresentQ
+    end
+  end
+end

data/lib/Thoran/Selenium/WebDriver/SearchContext/ElementsPresentQ/elements_presentQ.rb

@@ -0,0 +1,39 @@
+# Thoran/Selenium/WebDriver/SearchContext/ElementsPresentQ/elements_presentQ.rb
+# Thoran::Selenium::WebDriver::SearchContext::ElementsPresentQ.elements_present?
+
+# 20200418
+# 0.0.0
+
+# Examples:
+# 1. driver.elements_present?(:xpath, '//li[@class="item"]')
+# 2. driver.elements_present?(:css, 'li.item')
+
+# Changes:
+# 1. + Thoran namespace.
+
+module Thoran
+  module Selenium
+    module WebDriver
+      module SearchContext
+        module ElementsPresentQ
+
+          def elements_present?(selector_type, selector)
+            bridge.find_elements_by(selector_type, selector)
+            true
+          rescue ::Selenium::WebDriver::Error::NoSuchElementError
+            false
+          end
+
+        end
+      end
+    end
+  end
+end
+
+module Selenium
+  module WebDriver
+    class Driver
+      include Thoran::Selenium::WebDriver::SearchContext::ElementsPresentQ
+    end
+  end
+end

data/lib/Thoran/Selenium/WebDriver/Setup/setup.rb

@@ -0,0 +1,68 @@
+# Thoran/Selenium/WebDriver/Setup/setup.rb
+# Thoran::Selenium::WebDriver.setup
+
+# 20200418
+# 0.0.0
+
+# Usage:
+# 1. Binary is in the path:
+#   Selenium::WebDriver.setup('chrome') # String - lowercase
+#   Selenium::WebDriver.setup('Chrome') # String - capitalised
+#   Selenium::WebDriver.setup(:chrome) # Symbol - lowercase
+#   Selenium::WebDriver.setup(:Chrome) # Symbol - capitalised
+# 2. Binary is not in the path:
+#   Selenium::WebDriver.setup('~/Applications/Firefox.app/Contents/MacOS/firefox-bin')
+
+# Changes:
+# 1. + Thoran namespace.
+
+require 'selenium-webdriver'
+require 'Thoran/String/ToConst/to_const'
+
+module Thoran
+  module Selenium
+    module WebDriver
+      module Setup
+
+        module_function
+
+        def setup(path_or_browser)
+          if File.exist?(File.expand_path(path_or_browser.to_s))
+            path = path_or_browser
+            Selenium::WebDriver.at(path)
+            Selenium::WebDriver.for(selenium_browser(path))
+          else
+            browser = path_or_browser.to_sym.downcase
+            Selenium::WebDriver.for(browser)
+          end
+        end
+
+        private
+
+        def at(path)
+          selenium_binary_constant(path).path = File.expand_path(path)
+        end
+
+        def selenium_browser(path)
+          case path
+          when /chrome/i; :chrome
+          when /firefox/i; :firefox
+          when /safari/i; :safari
+          end
+        end
+
+        # This method seem to be necessary only to Firefox, since there are no equivalent constants for Safari or Chrome.
+        def selenium_binary_constant(path)
+          "Selenium::WebDriver::#{selenium_browser(path).to_s.capitalize}::Binary".to_const
+        end
+
+      end
+    end
+  end
+end
+
+module Selenium
+  module WebDriver
+    include Thoran::Selenium::WebDriver::Setup
+  end
+end

data/lib/Thoran/Selenium.rb

@@ -0,0 +1,11 @@
+# Thoran/Selenium.rb
+# Thoran::Selenium
+
+# 20200418
+# 0.0.0
+
+require_relative './Selenium/WebDriver/Driver/Attempt/attempt'
+require_relative './Selenium/WebDriver/Remote/W3C/Bridge/ConvertLocators/convert_locators'
+require_relative './Selenium/WebDriver/SearchContext/ElementPresentQ/element_presentQ'
+require_relative './Selenium/WebDriver/SearchContext/ElementsPresentQ/elements_presentQ'
+require_relative './Selenium/WebDriver/Setup/setup'

data/lib/WebAccount/VERSION.rb

@@ -0,0 +1,5 @@
+class WebAccount
+
+  VERSION = '0.2.3'
+
+end

data/lib/WebAccount.rb

@@ -0,0 +1,118 @@
+# WebAccount.rb
+# WebAccount
+
+require 'selenium-webdriver'
+require 'Thoran/Selenium'
+
+class WebAccount
+
+  attr_accessor :username
+  attr_accessor :password
+  attr_writer :user_agent_alias
+
+  def initialize(
+    username: nil, password: nil,
+    login_page_url: nil,
+    login_page_username_field_id: nil, login_page_password_field_id: nil,
+    login_page_submit_button_id: nil,
+    logout_button_id: nil,
+    logged_out_xpath: nil
+  )
+    @username, @password = username, password
+    @login_page_url = login_page_url
+    @login_page_username_field_id, @login_page_password_field_id = login_page_username_field_id, login_page_password_field_id
+    @login_page_submit_button_id = login_page_submit_button_id
+    @logout_button_id = logout_button_id
+    @logged_out_xpath = logged_out_xpath
+  end
+
+  def login(username: nil, password: nil)
+    @logged_in = false
+    username ||= self.username
+    password ||= self.password
+    attempts = 0
+    driver.attempt do
+      get_login_page
+      enter_username(username)
+      enter_password(password)
+      login_page_submit_button.click
+    end
+    @logged_in = driver_wait.until do
+      driver.element_present?(:id, @logout_button_id)
+    end
+  end
+  alias_method :logon, :login
+
+  def logout
+    driver.find_element(:id, @logout_button_id).click
+    if logged_out?
+      @logged_in = false
+    end
+  end
+  alias_method :logoff, :logout
+
+  def shutdown
+    logout if logged_in?
+    driver.quit
+  end
+
+  # predicate methods
+
+  def logged_in?
+    @logged_in
+  end
+
+  def logged_out?
+    driver_wait.until do
+      driver.element_present?(:xpath, @logged_out_xpath)
+    end
+  end
+
+  private
+
+  def user_agent_alias
+    @user_agent_alias ||= @user_agent_alias || :chrome
+  end
+
+  def driver
+    @driver ||= (
+      driver = Selenium::WebDriver.setup(user_agent_alias)
+      driver.manage.timeouts.implicit_wait = 5
+      driver
+    )
+  end
+
+  def driver_wait
+    @driver_wait ||= Selenium::WebDriver::Wait.new(timeout: 180)
+  end
+
+  # logging in
+
+  def login_page
+    driver.get(@login_page_url)
+  end
+  alias_method :get_login_page, :login_page
+
+  def enter_username(username = nil)
+    username ||= self.username
+    username_field.send_keys(username)
+  end
+
+  def username_field
+    driver.find_element(:id, @login_page_username_field_id)
+  end
+
+  def enter_password(password = nil)
+    password ||= self.password
+    password_field.send_keys(password)
+  end
+
+  def password_field
+    driver.find_element(:id, @login_page_password_field_id)
+  end
+
+  def login_page_submit_button
+    driver.find_element(:id, @login_page_submit_button_id)
+  end
+
+end

data/lib/web_account.rb

@@ -0,0 +1,6 @@
+# web_account.rb
+
+# Notes:
+# 1. This is to enable an alternate means of loading: require 'web_account'.
+
+require_relative 'WebAccount'

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: webaccount
+version: !ruby/object:Gem::Version
+  version: 0.2.3
+platform: ruby
+authors:
+- thoran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  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: Easily log into web accounts but just supplying a username and password,
+  the URL of the login page, and a few page ids to a subclass of WebAccount.
+email: code@thoran.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/Thoran/Selenium.rb
+- lib/Thoran/Selenium/WebDriver/Driver/Attempt/attempt.rb
+- lib/Thoran/Selenium/WebDriver/Remote/W3C/Bridge/ConvertLocators/convert_locators.rb
+- lib/Thoran/Selenium/WebDriver/SearchContext/ElementPresentQ/element_presentQ.rb
+- lib/Thoran/Selenium/WebDriver/SearchContext/ElementsPresentQ/elements_presentQ.rb
+- lib/Thoran/Selenium/WebDriver/Setup/setup.rb
+- lib/WebAccount.rb
+- lib/WebAccount/VERSION.rb
+- lib/web_account.rb
+homepage: http://github.com/thoran/WebAccount
+licenses:
+- Ruby
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: "# Description: An abstract superclass for navigating a web-based user account
+  via Selenium WebDriver."
+test_files: []