async-webdriver 0.1.2 → 0.3.0

data/lib/async/webdriver/session.rb

@@ -1,70 +1,141 @@
-module Async
-  module Webdriver
-    class Session
-      def initialize(json:, connection:)
-        @capabilities = json.fetch "capabilities"
-        @id = json.fetch "id"
-
-        @session_connection = ConnectionPath.new "session/#{@id}", connection: connection
-        @execute = Execute.new connection: @session_connection
-      end
-
-      attr_reader :id, :execute
-
-
-      def elements
-        body = {
-          using: "css selector",
-          value: "html"
-        }
-
-        session_id, value = @session_connection.call method: "post", path: "elements", body: body
-        list = []
-        for e in value do
-          list << Element.new(json: e, connection: @session_connection)
-        end
-        list
-      end
+# frozen_string_literal: true
 
-      def delete!
-        response = @session_connection.call method: "delete"
-      end
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
 
-      def navigate!(url)
-        body = {
-          url: url
-        }
+require_relative 'request_helper'
+require_relative 'element'
 
-        @session_connection.call method: "post", path: "url", body: body
-        self
-      end
+require_relative 'scope'
 
-      def back!
-        @session_connection.call method: "post", path: "back"
-        self
-      end
-
-      def forward!
-        @session_connection.call method: "post", path: "forward"
-        self
-      end
-
-      def refresh!
-        @session_connection.call method: "post", path: "refresh"
-        self
-      end
-
-      def url
-        @session_connection.call method: "get", path: "url"
-      end
-
-      def title
-        @session_connection.call method: "get", path: "title"
-      end
-
-      def source
-        @session_connection.call method: "get", path: "source"
-      end
-    end
-  end
+module Async
+	module WebDriver
+		# A session represents a single browser session, potentially with multiple windows. It is the primary interface for interacting with a browser.
+		#
+		# ``` ruby
+		# begin
+		# 	bridge = Async::WebDriver::Bridge::Pool.start(Async::WebDriver::Bridge::Chrome.new)
+		# 	session = bridge.session
+		# 	session.navigate_to("https://google.com")
+		# 	# ...
+		# ensure
+		# 	bridge&.close
+		# end
+		# ```
+		class Session
+			# Open a new session.
+			# @parameter endpoint [Async::HTTP::Endpoint] The endpoint to connect to.
+			# @yields {|session| ...} The session will be closed automatically if you provide a block.
+			# 	@parameter session [Session] The session.
+			# @returns [Session] The session if no block is given.
+			def self.open(endpoint, *arguments, **options)
+				client = self.new(
+					Async::HTTP::Client.open(endpoint, **options),
+					*arguments
+				)
+				
+				return client unless block_given?
+				
+				begin
+					yield client
+				ensure
+					client.close
+				end
+			end
+			
+			# Initialize the session.
+			# @parameter delegate [Protocol::HTTP::Middleware] The underlying HTTP client (or wrapper).
+			# @parameter id [String] The session identifier.
+			# @parameter capabilities [Hash] The capabilities of the session.
+			def initialize(delegate, id, capabilities)
+				@delegate = delegate
+				@id = id
+				@capabilities = capabilities
+			end
+			
+			def inspect
+				"\#<#{self.class} id=#{@id.inspect}>"
+			end
+			
+			# @attribute [Protocol::HTTP::Middleware] The underlying HTTP client (or wrapper).
+			attr :delegate
+			
+			# @attribute [String] The session identifier.
+			attr :id
+			
+			# @attribute [Hash] The capabilities of the session.
+			attr :capabilities
+			
+			# The path used for making requests to the web driver bridge.
+			# @parameter path [String | Nil] The path to append to the request path.
+			# @returns [String] The path used for making requests to the web driver bridge.
+			def request_path(path = nil)
+				if path
+					"/session/#{@id}/#{path}"
+				else
+					"/session/#{@id}"
+				end
+			end
+			
+			include RequestHelper
+			
+			# Close the session.
+			def close
+				if @delegate
+					self.delete
+					@delegate = nil
+				end
+			end
+			
+			# @returns [Session] The session.
+			def session
+				self
+			end
+			
+			# @returns [Session] The current scope.
+			def current_scope
+				self
+			end
+			
+			# Execute a script in the current document.
+			# @parameter script [String] The script to execute.
+			# @parameter arguments [Array] The arguments to pass to the script.
+			# @returns [Object] The result of the script.
+			def execute(script, *arguments)
+				post("execute/sync", {script: script, args: arguments})
+			end
+			
+			# Execute a script in the current document asynchronously.
+			# @parameter script [String] The script to execute.
+			# @parameter arguments [Array] The arguments to pass to the script.
+			# @returns [Object] The result of the script.
+			def execute_async(script, *arguments)
+				post("execute/async", {script: script, args: arguments})
+			end
+			
+			include Scope::Alerts
+			include Scope::Cookies
+			include Scope::Document
+			include Scope::Elements
+			include Scope::Fields
+			include Scope::Frames
+			include Scope::Navigation
+			include Scope::Printing
+			include Scope::ScreenCapture
+			include Scope::Timeouts
+			
+			# Reset the session to a clean state.
+			def reset!
+				# Go to a blank page (in theory this should also invalidate any Element instances):
+				self.navigate_to("about:blank")
+				
+				# Clear cookies and local storage:
+				self.delete_all_cookies
+				self.execute("localStorage.clear();")
+				
+				# Detach the session instance from the underlying HTTP client:
+				@delegate = nil
+			end
+		end
+	end
 end

data/lib/async/webdriver/version.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
 module Async
-  module Webdriver
-    VERSION = "0.1.2"
-  end
+	module WebDriver
+		VERSION = "0.3.0"
+	end
 end

data/lib/async/webdriver/xpath.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+module Async
+	module WebDriver
+		# Helpers for working with XPath.
+		module XPath
+			# Escape a value for use in XPath.
+			#
+			# XPath 1.0  does not provide any standard mechanism for escaping quotes, so we have to do it ourselves using `concat`.
+			#
+			# @parameter value [String | Numeric] The value to escape.
+			def self.escape(value)
+				case value
+				when String
+					if value.include?("'")
+						"concat('#{value.split("'").join("', \"'\", '")}')"
+					else
+						"'#{value}'"
+					end
+				else
+					value.to_s
+				end
+			end
+		end
+	end
+end

data/lib/async/webdriver.rb

@@ -1,15 +1,10 @@
-module Async
-  module Webdriver
-  end
-end
+# frozen_string_literal: true
 
-require_relative "webdriver/version"
-require_relative "webdriver/client"
-require_relative "webdriver/connection"
-require_relative "webdriver/connection_path"
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
 
-require_relative "webdriver/session"
-require_relative "webdriver/session_creator"
+require_relative 'webdriver/bridge'
+require_relative 'webdriver/bridge/pool'
 
-require_relative "webdriver/element"
-require_relative "webdriver/execute"
+require_relative 'webdriver/client'
+require_relative 'webdriver/locator'

data/{LICENSE.txt → license.md}

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+# MIT License
 
-Copyright (c) 2019 Matti Paksula
+Copyright, 2023, by Samuel Williams.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,37 @@
+# Async::WebDriver
+
+Provides a client implementation of the W3C WebDriver specification with support for Chrome and Firefox.
+
+[![Development Status](https://github.com/socketry/async-webdriver/workflows/Test/badge.svg)](https://github.com/socketry/async-webdriver/actions?workflow=Test)
+
+## Motivation
+
+In the past, I've used [selenium-webdriver](https://github.com/SeleniumHQ/selenium) for testing web applications. However, I found it to be slow. I wanted to improve the performance of my tests, so I decided to write a new implementation from scratch. The W3C WebDriver specification is quite simple, so it wasn't too difficult to implement, and I was able to get a significant performance improvement, between 2x-10x depending on the usage. Specifically, most test suites can take advantage of pre-warmed sessions, which can minimise the overhead of each test running in a new session. Additionally, I'd like to explore reusing sessions between tests, which could provide even more performance improvements.
+
+In addition, building on top of [async](https://github.com/socketry/async) allows us to take advantage of [async-http](https://github.com/socketry/async-http) and run the web server in the same reactor as the test itself, which can provide a performance improvement over [capybara](https://github.com/teamcapybara/capybara) which usually needs to start a separate server process. This also makes it possible to share a single database transaction between the client and server, which can significantly reduce the overhead of "cleaning" the database after each test, and improve the opportunity for parallelisation.
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/async-webdriver/) for more details.
+
+  - [Getting Started](https://socketry.github.io/async-webdriver/guides/getting-started/index) - This guide explains how to use `async-webdriver` for controlling a browser.
+
+  - [GitHub Actions Integrations](https://socketry.github.io/async-webdriver/guides/github-actions-integration/index) - This guide explains how to use `async-webdriver` with GitHub Actions.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -1,177 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: async-webdriver
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
-- Matti Paksula
-autorequire: 
-bindir: exe
-cert_chain: []
-date: 2019-01-21 00:00:00.000000000 Z
+- Samuel Williams
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2023-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
-  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: selenium-webdriver
-  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: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+        version: '0.42'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: guard
-  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: guard-rspec
-  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: async-rspec
-  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: pry-byebug
-  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: 
+        version: '0.42'
+description:
 email:
-- matti.paksula@iki.fi
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".ruby-gemset"
-- ".ruby-version"
-- ".travis.yml"
-- Gemfile
-- Gemfile.lock
-- Guardfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- async-webdriver.gemspec
-- bin/console
-- bin/setup
-- examples/multiple_sessions.rb
 - lib/async/webdriver.rb
+- lib/async/webdriver/bridge.rb
+- lib/async/webdriver/bridge/chrome.rb
+- lib/async/webdriver/bridge/firefox.rb
+- lib/async/webdriver/bridge/generic.rb
+- lib/async/webdriver/bridge/pool.rb
+- lib/async/webdriver/bridge/process_group.rb
 - lib/async/webdriver/client.rb
-- lib/async/webdriver/connection.rb
-- lib/async/webdriver/connection_path.rb
 - lib/async/webdriver/element.rb
-- lib/async/webdriver/execute.rb
+- lib/async/webdriver/error.rb
+- lib/async/webdriver/locator.rb
+- lib/async/webdriver/request_helper.rb
+- lib/async/webdriver/scope.rb
+- lib/async/webdriver/scope/alerts.rb
+- lib/async/webdriver/scope/cookies.rb
+- lib/async/webdriver/scope/document.rb
+- lib/async/webdriver/scope/elements.rb
+- lib/async/webdriver/scope/fields.rb
+- lib/async/webdriver/scope/frames.rb
+- lib/async/webdriver/scope/navigation.rb
+- lib/async/webdriver/scope/printing.rb
+- lib/async/webdriver/scope/screen_capture.rb
+- lib/async/webdriver/scope/timeouts.rb
 - lib/async/webdriver/session.rb
-- lib/async/webdriver/session_creator.rb
 - lib/async/webdriver/version.rb
-homepage: https://github.com/matti/async-webdriver
+- lib/async/webdriver/xpath.rb
+- license.md
+- readme.md
+homepage: https://github.com/socketry/async-webdriver/
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  documentation_uri: https://socketry.github.io/async-webdriver/
+  funding_uri: https://github.com/sponsors/ioquatix
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -179,15 +101,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.4.22
+signing_key:
 specification_version: 4
-summary: async-webdriver
+summary: A native library implementing the W3C WebDriver client specification.
 test_files: []

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.ruby-gemset

@@ -1 +0,0 @@
-async-webdriver

data/.ruby-version

@@ -1 +0,0 @@
-2.6.0

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.3
-before_install: gem install bundler -v 1.16.6

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in async-webdriver.gemspec
-gemspec