Misc doc changes

Besides other documentation changes, this commit ensures the generated
HTML doc for HexDocs.pm will become the source of truth for this Elixir
library and leverage on latest features of ExDoc.

Author: kianmeng

CHANGELOG.md

@@ -1,10 +1,16 @@
 # Changelog
 
-## 0.2 - 2021-09-13
+All notable changes to this project will be documented in this file.
 
-* Increases minimum elixir version to 1.8.
-* Relaxes tesla version requirement to ~> 1.3.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## 0.1 - 2020-04-15
 
-Initial release.
+## v0.2 - 2021-09-13
+
+* Increases minimum Elixir version to 1.8.
+* Relaxes Tesla version requirement to ~> 1.3.
+
+## v0.1 - 2020-04-15
+
+* Initial release.

LICENSE LICENSE.mdLICENSE renamed to LICENSE.md

@@ -1,4 +1,4 @@
-MIT License
+# MIT License
 
 Copyright (c) 2020 Aaron Renner
 

README.md

@@ -1,5 +1,11 @@
 # WebDriverClient
+
 [![codecov](https://codecov.io/gh/aaronrenner/web_driver_client/branch/master/graph/badge.svg)](https://codecov.io/gh/aaronrenner/web_driver_client)
+[![Module Version](https://img.shields.io/hexpm/v/web_driver_client.svg)](https://hex.pm/packages/web_driver_client)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/web_driver_client/)
+[![Total Download](https://img.shields.io/hexpm/dt/web_driver_client.svg)](https://hex.pm/packages/web_driver_client)
+[![License](https://img.shields.io/hexpm/l/web_driver_client.svg)](https://github.com/elixir-wallably/web_driver_client/blob/master/LICENSE.md)
+[![Last Updated](https://img.shields.io/github/last-commit/elixir-wallably/web_driver_client.svg)](https://github.com/elixir-wallably/web_driver_client/commits/master)
 
 A low-level [WebDriver] client for Elixir. This library is still a work in progress.
 
@@ -15,7 +21,6 @@ library is designed to be the API client for higher-level libraries, like [Walla
   |> WebDriverClient.Config.build(protocol: :w3c)
   |> WebDriverClient.start_session(%{"capabilities" => %{}})
 
-
 :ok = WebDriverClient.navigate_to(session, "http://dockyard.com")
 
 {:ok, element} = WebDriverClient.find_element(session, :css_selector, ".site-nav__logo__link")
@@ -26,26 +31,27 @@ WebDriverClient.fetch_element_text(session, element) # => {:ok, "DockYard Home"}
 ```
 
 ### Design considerations
-* Should be a thin, well-documented API client that calls the WebDriver REST APIs.
-* Should provide a main API that abstracts away the differences between the JWP and W3C
-  protocols.
-* (Future) Should provide protocol-specific APIs as an escape-hatch to access functionality
-  that is not common to both protocols.
-* Sometimes the user will request one protocol and the server returns the other protocol. This
-  happens if the user sends the incorrect payload on session start, or requests an
-  endpoint that is not tied to an individual session (like listing sessions).
 
-  This library should gracefully handle these situations, while still notifying the user
-  that the wrong protocol was returned.
+* Should be a thin, well-documented API client that calls the WebDriver REST APIs.
+* Should provide a main API that abstracts away the differences between the JWP
+  and W3C protocols.
+* (Future) Should provide protocol-specific APIs as an escape-hatch to access
+  functionality that is not common to both protocols.
+* Sometimes the user will request one protocol and the server returns the other
+  protocol. This happens if the user sends the incorrect payload on session
+  start, or requests an endpoint that is not tied to an individual session
+  (like listing sessions).
+
+  This library should gracefully handle these situations, while still notifying
+  the user that the wrong protocol was returned.
 
 ### What this library is not
+
 * This is not a high-level library to be used for day to day
   testing. Features like retries, pipeline commands, etc
   are outside the scope of this project. These features are better
   delegated to a high-level library like [Wallaby] or [Hound].
 
-
-
 ## Testing
 
 In order to ensure the reliability of this library, test coverage is very
@@ -74,91 +80,93 @@ Note: This project does not start any WebDriver program. Those need to be starte
 
 To install ChromeDriver on OS X:
 
-```
+```sh
 $ brew cask install chromedriver
 ```
 
 Before running test suite, start up chromedriver
 
-```
+```sh
 $ chromedriver
 ```
 
 Then to run the integration tests, run:
 
-```
+```sh
 $ mix test --only integration_test_driver:chromedriver
 ```
 
 #### PhantomJS
 
 To install PhantomJS on OS X:
 
-```
+```sh
 $ brew cask install phantomjs
 ```
 
 Before running test suite, start up phantomjs
 
-```
+```sh
 $ phantomjs --wd
 ```
 
 Then to run the integration tests, run:
 
-```
+```sh
 $ mix test --only integration_test_driver:phantomjs
 ```
 
 #### Selenium
 
 To install ChromeDriver on OS x:
 
-```
+```sh
 $ brew install selenium-server-standalone
 ```
 
 You also need to install the webdriver servers
 
-For firefox:
-```
+For Firefox:
+
+```sh
 $ brew install geckodriver
 ```
 
-For chrome:
-```
+For Chrome:
+
+```sh
 $ brew install chromedriver
 ```
 
 Before running test suite, start up selenium
 
-```
+```sh
 $ selenium-server
 ```
 
 Then to run the integration tests, run:
 
-```
+```sh
 $ mix test --only integration_test_driver:selenium_3
 ```
 
 If you'd like to run only the selenium tests for chrome, run:
 
-```
+```sh
 $ mix test --only integration_test_driver_browser:selenium_3-chrome
 ```
 
-And to only run selenium tests for firefox, run:
+And to only run selenium tests for Firefox, run:
 
-```
+```sh
 $ mix test --only integration_test_driver_browser:selenium_3-firefox
 ```
 
 ##### Selenium 2
-If you'd like to run integration tests for `selenium_2`, just replace `selenium_3` with
-`selenium_2`.
 
-```
+If you'd like to run integration tests for `selenium_2`, just replace `selenium_3` with `selenium_2`.
+
+```sh
 $ mix test --only integration_test_driver:selenium_2
 ```
 
@@ -169,33 +177,32 @@ Here's an example that runs the tests against a docker container.
 
 1. Start the docker container for the webdriver server
 
-    ```
-    $ docker run -p 4446:4444 --shm-size=2g selenium/standalone-chrome:3
-    ```
+   ```sh
+   $ docker run -p 4446:4444 --shm-size=2g selenium/standalone-chrome:3
+   ```
 
 2. Run the tests
 
-    ```
-    $ SELENIUM_3_BASE_URL="http://localhost:4446/wd/hub" TEST_SERVER_HOSTAME="host.docker.internal" mix test --only integration_test_driver_browser:selenium_3-chrome
-    ```
-
-    The environment variables work like this:
-
-    * `<DRIVER_NAME>_BASE_URL` - The base url for the webdriver server to run
-       against. Can also use `WEBDRIVER_BASE_URL` to set this across all scenarios.
-    * ` TEST_SERVER_HOSTNAME` - The hostname the webdriver server should use to access
-      the machine that's running the test suite.
-
-        The test suite starts up a test HTTP server, but when using a remote webdriver
-        server, the webdriver server needs to where the test pages live. When running in
-        docker for Mac, the hostname of the host computer is `host.docker.internal`.
+   ```sh
+   $ SELENIUM_3_BASE_URL="http://localhost:4446/wd/hub" TEST_SERVER_HOSTAME="host.docker.internal" mix test --only integration_test_driver_browser:selenium_3-chrome
+   ```
 
+   The environment variables work like this:
 
+   * `<DRIVER_NAME>_BASE_URL` - The base url for the webdriver server to run
+     against. Can also use `WEBDRIVER_BASE_URL` to set this across all
+     scenarios.
+   * `TEST_SERVER_HOSTNAME` - The hostname the webdriver server should use to
+     access the machine that's running the test suite. The test suite starts up
+     a test HTTP server, but when using a remote webdriver server, the
+     webdriver server needs to where the test pages live. When running in
+     docker for Mac, the hostname of the host computer is
+     `host.docker.internal`.
 
 ## Installation
 
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `web_driver_client` to your list of dependencies in `mix.exs`:
+The package can be installed by adding `:web_driver_client` to your list of
+dependencies in `mix.exs`:
 
 ```elixir
 def deps do
@@ -227,6 +234,13 @@ $ MIX_ENV=docs_prerelease mix docs
 It's important to note the pre-release APIs aren't public and
 may change at any time.
 
+## Copyright and License
+
+Copyright (c) 2020 Aaron Renner
+
+This work is free. You can redistribute it and/or modify it under the
+terms of the MIT License. See the [LICENSE.md](./LICENSE.md) file for more details.
+
 [WebDriver]: https://w3c.github.io/webdriver/
 [JWP]: https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol
 [W3C]: https://w3c.github.io/webdriver/

lib/web_driver_client/json_wire_protocol_client.ex

@@ -309,7 +309,7 @@ defmodule WebDriverClient.JSONWireProtocolClient do
   end
 
   @doc """
-  Fetchs the attribute value of an element
+  Fetches the attribute value of an element
 
   Specification: https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidelementidattributename
   """

mix.exs

@@ -1,6 +1,7 @@
 defmodule WebDriverClient.MixProject do
   use Mix.Project
 
+  @source_url "https://github.com/aaronrenner/web_driver_client"
   @version "0.2.0"
 
   def project do
@@ -22,10 +23,7 @@ defmodule WebDriverClient.MixProject do
       docs: docs(),
       deps: deps(),
       dialyzer: dialyzer(),
-      package: package(),
-      description: """
-      Low-level WebDriver client for Elixir.
-      """
+      package: package()
     ]
   end
 
@@ -47,7 +45,7 @@ defmodule WebDriverClient.MixProject do
       {:excoveralls, "~> 0.10", only: :test},
       {:credo, "~> 1.4.0", only: [:dev, :test], runtime: false},
       {:dialyxir, "~> 1.0.0-rc.7", only: [:dev], runtime: false},
-      {:ex_doc, "~> 0.20", only: [:docs, :docs_prerelease]}
+      {:ex_doc, ">= 0.0.0", only: [:docs, :docs_prerelease]}
     ]
   end
 
@@ -63,7 +61,15 @@ defmodule WebDriverClient.MixProject do
 
   defp docs do
     [
-      main: "WebDriverClient",
+      extras: [
+        "CHANGELOG.md": [],
+        "LICENSE.md": [title: "License"],
+        "README.md": [title: "Overview"]
+      ],
+      main: "readme",
+      source_ref: "v#{@version}",
+      source_url: @source_url,
+      formatters: ["html"],
       groups_for_modules: [
         "Main API": [
           WebDriverClient,
@@ -99,17 +105,19 @@ defmodule WebDriverClient.MixProject do
         Elements: &(&1[:subject] == :elements),
         Alerts: &(&1[:subject] == :alerts),
         Logging: &(&1[:subject] == :logging)
-      ],
-      source_ref: "v#{@version}",
-      source_url: "https://github.com/aaronrenner/web_driver_client"
+      ]
     ]
   end
 
   defp package do
     [
+      description: "Low-level WebDriver client for Elixir.",
       maintainers: ["Aaron Renner", "Michał Łępicki"],
       licenses: ["MIT"],
-      links: %{github: "https://github.com/aaronrenner/web_driver_client"}
+      links: %{
+        Changelog: "https://hexdocs.pm/web_driver_client/changelog.html",
+        GitHub: @source_url
+      }
     ]
   end
 end

mix.lock

@@ -7,18 +7,20 @@
   "credo": {:hex, :credo, "1.4.0", "92339d4cbadd1e88b5ee43d427b639b68a11071b6f73854e33638e30a0ea11f5", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "1fd3b70dce216574ce3c18bdf510b57e7c4c85c2ec9cad4bff854abaf7e58658"},
   "dialyxir": {:hex, :dialyxir, "1.0.0", "6a1fa629f7881a9f5aaf3a78f094b2a51a0357c843871b8bc98824e7342d00a5", [:mix], [{:erlex, ">= 0.2.6", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "aeb06588145fac14ca08d8061a142d52753dbc2cf7f0d00fc1013f53f8654654"},
   "earmark": {:hex, :earmark, "1.4.3", "364ca2e9710f6bff494117dbbd53880d84bebb692dafc3a78eb50aa3183f2bfd", [:mix], [], "hexpm", "8cf8a291ebf1c7b9539e3cddb19e9cef066c2441b1640f13c34c1d3cfc825fec"},
+  "earmark_parser": {:hex, :earmark_parser, "1.4.16", "607709303e1d4e3e02f1444df0c821529af1c03b8578dfc81bb9cf64553d02b9", [:mix], [], "hexpm", "69fcf696168f5a274dd012e3e305027010658b2d1630cef68421d6baaeaccead"},
   "erlex": {:hex, :erlex, "0.2.6", "c7987d15e899c7a2f34f5420d2a2ea0d659682c06ac607572df55a43753aa12e", [:mix], [], "hexpm", "2ed2e25711feb44d52b17d2780eabf998452f6efda104877a3881c2f8c0c0c75"},
-  "ex_doc": {:hex, :ex_doc, "0.21.3", "857ec876b35a587c5d9148a2512e952e24c24345552259464b98bfbb883c7b42", [:mix], [{:earmark, "~> 1.4", [hex: :earmark, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}], "hexpm", "0db1ee8d1547ab4877c5b5dffc6604ef9454e189928d5ba8967d4a58a801f161"},
+  "ex_doc": {:hex, :ex_doc, "0.25.3", "3edf6a0d70a39d2eafde030b8895501b1c93692effcbd21347296c18e47618ce", [:mix], [{:earmark_parser, "~> 1.4.0", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "9ebebc2169ec732a38e9e779fd0418c9189b3ca93f4a676c961be6c1527913f5"},
   "excoveralls": {:hex, :excoveralls, "0.12.2", "a513defac45c59e310ac42fcf2b8ae96f1f85746410f30b1ff2b710a4b6cd44b", [:mix], [{:hackney, "~> 1.0", [hex: :hackney, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "151c476331d49b45601ffc45f43cb3a8beb396b02a34e3777fea0ad34ae57d89"},
   "hackney": {:hex, :hackney, "1.15.2", "07e33c794f8f8964ee86cebec1a8ed88db5070e52e904b8f12209773c1036085", [:rebar3], [{:certifi, "2.5.1", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "6.0.0", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "1.0.1", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "~>1.1", [hex: :mimerl, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "1.1.5", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}], "hexpm", "e0100f8ef7d1124222c11ad362c857d3df7cb5f4204054f9f0f4a728666591fc"},
   "idna": {:hex, :idna, "6.0.0", "689c46cbcdf3524c44d5f3dde8001f364cd7608a99556d8fbd8239a5798d4c10", [:rebar3], [{:unicode_util_compat, "0.4.1", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "4bdd305eb64e18b0273864920695cb18d7a2021f31a11b9c5fbcd9a253f936e2"},
   "jason": {:hex, :jason, "1.2.0", "10043418c42d2493d0ee212d3fddd25d7ffe484380afad769a0a38795938e448", [:mix], [{:decimal, "~> 1.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "116747dbe057794c3a3e4e143b7c8390b29f634e16c78a7f59ba75bfa6852e7f"},
-  "makeup": {:hex, :makeup, "1.0.0", "671df94cf5a594b739ce03b0d0316aa64312cee2574b6a44becb83cd90fb05dc", [:mix], [{:nimble_parsec, "~> 0.5.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "a10c6eb62cca416019663129699769f0c2ccf39428b3bb3c0cb38c718a0c186d"},
-  "makeup_elixir": {:hex, :makeup_elixir, "0.14.0", "cf8b7c66ad1cff4c14679698d532f0b5d45a3968ffbcbfd590339cb57742f1ae", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "d4b316c7222a85bbaa2fd7c6e90e37e953257ad196dc229505137c5e505e9eff"},
+  "makeup": {:hex, :makeup, "1.0.5", "d5a830bc42c9800ce07dd97fa94669dfb93d3bf5fcf6ea7a0c67b2e0e4a7f26c", [:mix], [{:nimble_parsec, "~> 0.5 or ~> 1.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "cfa158c02d3f5c0c665d0af11512fed3fba0144cf1aadee0f2ce17747fba2ca9"},
+  "makeup_elixir": {:hex, :makeup_elixir, "0.15.2", "dc72dfe17eb240552857465cc00cce390960d9a0c055c4ccd38b70629227e97c", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.1", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "fd23ae48d09b32eff49d4ced2b43c9f086d402ee4fd4fcb2d7fad97fa8823e75"},
+  "makeup_erlang": {:hex, :makeup_erlang, "0.1.1", "3fcb7f09eb9d98dc4d208f49cc955a34218fc41ff6b84df7c75b3e6e533cc65f", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "174d0809e98a4ef0b3309256cbf97101c6ec01c4ab0b23e926a9e17df2077cbb"},
   "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm", "69b09adddc4f74a40716ae54d140f93beb0fb8978d8636eaded0c31b6f099f16"},
   "mime": {:hex, :mime, "1.3.1", "30ce04ab3175b6ad0bdce0035cba77bba68b813d523d1aac73d9781b4d193cf8", [:mix], [], "hexpm", "6cbe761d6a0ca5a31a0931bf4c63204bceb64538e664a8ecf784a9a6f3b875f1"},
   "mimerl": {:hex, :mimerl, "1.2.0", "67e2d3f571088d5cfd3e550c383094b47159f3eee8ffa08e64106cdf5e981be3", [:rebar3], [], "hexpm", "f278585650aa581986264638ebf698f8bb19df297f66ad91b18910dfc6e19323"},
-  "nimble_parsec": {:hex, :nimble_parsec, "0.5.3", "def21c10a9ed70ce22754fdeea0810dafd53c2db3219a0cd54cf5526377af1c6", [:mix], [], "hexpm", "589b5af56f4afca65217a1f3eb3fee7e79b09c40c742fddc1c312b3ac0b3399f"},
+  "nimble_parsec": {:hex, :nimble_parsec, "1.1.0", "3a6fca1550363552e54c216debb6a9e95bd8d32348938e13de5eda962c0d7f89", [:mix], [], "hexpm", "08eb32d66b706e913ff748f11694b17981c0b04a33ef470e33e11b3d3ac8f54b"},
   "parse_trans": {:hex, :parse_trans, "3.3.0", "09765507a3c7590a784615cfd421d101aec25098d50b89d7aa1d66646bc571c1", [:rebar3], [], "hexpm", "17ef63abde837ad30680ea7f857dd9e7ced9476cdd7b0394432af4bfc241b960"},
   "plug": {:hex, :plug, "1.8.3", "12d5f9796dc72e8ac9614e94bda5e51c4c028d0d428e9297650d09e15a684478", [:mix], [{:mime, "~> 1.0", [hex: :mime, repo: "hexpm", optional: false]}, {:plug_crypto, "~> 1.0", [hex: :plug_crypto, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4", [hex: :telemetry, repo: "hexpm", optional: true]}], "hexpm", "164baaeb382d19beee0ec484492aa82a9c8685770aee33b24ec727a0971b34d0"},
   "plug_cowboy": {:hex, :plug_cowboy, "2.1.0", "b75768153c3a8a9e8039d4b25bb9b14efbc58e9c4a6e6a270abff1cd30cbe320", [:mix], [{:cowboy, "~> 2.5", [hex: :cowboy, repo: "hexpm", optional: false]}, {:plug, "~> 1.7", [hex: :plug, repo: "hexpm", optional: false]}], "hexpm", "6cd8ddd1bd1fbfa54d3fc61d4719c2057dae67615395d58d40437a919a46f132"},

test/web_driver_client/w3c_wire_protocol_client_test.exs

@@ -2064,7 +2064,7 @@ defmodule WebDriverClient.W3CWireProtocolClientTest do
   end
 
   defp build_start_session_payload do
-    %{"capablities" => %{"browserName" => "firefox"}}
+    %{"capabilities" => %{"browserName" => "firefox"}}
   end
 
   defp string_to_type do

test/web_driver_client_test.exs

@@ -1699,7 +1699,7 @@ defmodule WebDriverClientTest do
   end
 
   defp build_start_session_payload do
-    %{"capablities" => %{"browserName" => "firefox"}}
+    %{"capabilities" => %{"browserName" => "firefox"}}
   end
 
   defp stub_bypass_response(bypass, response) do