[ViewVC] Diff of: cvs/AnyEvent-WebDriver/README

Comparing AnyEvent-WebDriver/README (file contents):
Revision 1.4 by root, Wed Aug 29 02:17:51 2018 UTC vs.
Revision 1.5 by root, Wed Aug 29 05:55:23 2018 UTC

        $wd->element_click ($wd->find_element ("css selector" => 'input[type="submit"]'));
        sleep 10;
 DESCRIPTION
+    WARNING: THE API IS NOT GUARANTEED TO BE STABLE UNTIL VERSION 1.0.
     This module aims to implement the W3C WebDriver specification which is
     the standardised equivalent to the Selenium WebDriver API., which in
     turn aims at remotely controlling web browsers such as Firefox or
     Chromium.
     $al = $wd->actions
         Creates an action list associated with this WebDriver. See ACTION
         LISTS, below, for full details.
+    $sessionstring = $wd->save_session
+        Save the current session in a string so it can be restored load with
+        "load_session". Note that only the session data itself is stored
+        (currently the session id and capabilities), not the endpoint
+        information itself.
+        The main use of this function is in conjunction with disabled
+        "autodelete", to save a session to e.g., and restore it later. It
+        could presumably used for other applications, suhc as using the same
+        sssion from multiple processes and so on.
+    $wd->load_session ($sessionstring)
+    $wd->set_session ($sessionid, $capabilities)
+        Starts using the given session, as identified by $sessionid.
+        $capabilities should be the original session capabilities, although
+        the current version of this module does not make any use of it.
+        The $sessionid is stored in "$wd->{sid}" (and could be fetched form
+        there for later use), while the capabilities are stored in
+        "$wd->{capabilities}".
   SIMPLIFIED API
     This section documents the simplified API, which is really just a very
     thin wrapper around the WebDriver protocol commands. They all block
     (using AnyEvent condvars) the caller until the result is available, so
     must not be called from an event loop callback - see "EVENT BASED API"
         WebDriver object.
         On success, "$wd->{sid}" is set to the session ID, and
         "$wd->{capabilities}" is set to the returned capabilities.
+        Simple example of creatring a WebDriver object and a new session:
            my $wd = new AnyEvent::Selenium endpoint => "http://localhost:4545";
+           $wd->new_session ({});
+        Real-world example with capability negotiation:
            $wd->new_session ({
               capabilities => {
+                 alwaysMatch => {
-                 pageLoadStrategy => "normal",
+                    pageLoadStrategy        => "eager",
+                    unhandledPromptBehavior => "dismiss",
+                    # proxy => { proxyType => "manual", httpProxy => "1.2.3.4:56", sslProxy => "1.2.3.4:56" },
+                 },
+                 firstMatch => [
+                    {
+                       browserName => "firefox",
+                       "moz:firefoxOptions" => {
+                          binary => "firefox/firefox",
+                          args => ["-devtools"],
+                          prefs => {
+                             "dom.webnotifications.enabled" => \0,
+                             "dom.disable_beforeunload" => \1,
+                             "browser.link.open_newwindow" => 3,
+                             "browser.link.open_newwindow.restrictions" => 0,
+                             "dom.popup_allowed_events" => "",
+                             "dom.disable_open_during_load" => \1,
+                          },
+                       },
+                    },
+                    {
+                       # generic fallback
+                    },
+                 ],
-              }.
+              },
            });
+        Firefox-specific capability documentation can be found on MDN
+        <https://developer.mozilla.org/en-US/docs/Web/WebDriver/Capabilities
+        >, Chrome-specific capability documentation might be found here
+        <http://chromedriver.chromium.org/capabilities>, but the latest
+        release at the time of this writing has effectively no WebDriver
+        support at all, and canary releases are not freely downloadable.
+        If you have URLs for Safari/IE/Edge etc. capabilities, feel free to
+        tell me about them.
     $wd->delete_session
         Deletes the session - the WebDriver object must not be used after
         this call.
         Changes the window size by either maximising, minimising or making
         it fullscreen. In my experience, this will timeout if no window
         manager is running.
    ELEMENT RETRIEVAL
+    To reduce typing and memory strain, the element finding functions accept
+    some shorter and hopefully easier to remember aliases for the standard
+    locator strategy values, as follows:
+       Alias   Locator Strategy
+       css     css selector
+       link    link text
+       substr  partial link text
+       tag     tag name
-    $element = $wd->find_element ($location_strategy, $selector)
+    $element = $wd->find_element ($locator_strategy, $selector)
         Finds the first element specified by the given selector and returns
         its element object. Raises an error when no element was found.
            $element = $wd->find_element ("css selector" => "body a");
            $element = $wd->find_element ("link text" => "Click Here For Porn");
            $element = $wd->find_element ("partial link text" => "orn");
            $element = $wd->find_element ("tag name" => "input");
            $element = $wd->find_element ("xpath" => '//input[@type="text"]');
            => e.g. { "element-6066-11e4-a52e-4f735466cecf" => "decddca8-5986-4e1d-8c93-efe952505a5f" }
-    $elements = $wd->find_elements ($location_strategy, $selector)
+    $elements = $wd->find_elements ($locator_strategy, $selector)
         As above, but returns an arrayref of all found element objects.
-    $element = $wd->find_element_from_element ($element, $location_strategy,
+    $element = $wd->find_element_from_element ($element, $locator_strategy,
     $selector)
         Like "find_element", but looks only inside the specified $element.
     $elements = $wd->find_elements_from_element ($element,
-    $location_strategy, $selector)
+    $locator_strategy, $selector)
         Like "find_elements", but looks only inside the specified $element.
            my $head = $wd->find_element ("tag name" => "head");
            my $links = $wd->find_elements_from_element ($head, "tag name", "link");
     entering some text and pressing enter, you can use this:
        $wd->actions
           ->click (1, 100)
           ->type ("some text")
-          ->key ("Enter")
+          ->key ("{Enter}")
           ->perform;
     By default, keyboard and mouse input sources are provided. You can
     create your own sources and use them when adding events. The above
     example could be more verbosely written like this:
        $wd->actions
           ->click (1, 100, "mouse")
           ->type ("some text")
-          ->key ("Enter")
+          ->key ("{Enter}")
           ->perform;
-    #TODO verboser example
     When you specify the event source expliticly it will switch the current
     "focus" for this class of device (all keyboards are in one class, all
     pointer-like devices such as mice/fingers/pens are in one class), so you
     don't have to specify the source for subsequent actions.
     without defining them, then a suitable default source will be created
     for them.
     $al = new AnyEvent::WebDriver::Actions
         Create a new empty action list object. More often you would use the
-        "$sel->action_list" method to create one that is already associated
+        "$wd->action_list" method to create one that is already associated
         with a given web driver.
     $al = $al->source ($id, $type, key => value...)
         The first time you call this with a givne ID, this defines the event
         source using the extra parameters. Subsequent calls merely switch
         "viewport", "pointer" or an element object.
     $al = $al->keyDown ($key, $source)
     $al = $al->keyUp ($key, $source)
         Press or release the given key.
+    $al = $al->key ($key, $source)
+        Peess and release the given key, without unnecessary delay.
+        A special syntax, "{keyname}" can be used for special keys - all the
+        special key names from section 17.4.2
+        <https://www.w3.org/TR/webdriver1/#keyboard-actions> of the
+        WebDriver recommendation can be used.
+        Example: press and release "a".
+           $al->key ("a");
+        Example: press and release the "Enter" key:
+           $al->key ("\x{e007}");
+        Example: press and release the "enter" key using the special key
+        name syntax:
+           $al->key ("{Enter}");
+    $al = $al->type ($string, $source)
+        Convenience method to simulate a series of key press and release
+        events for the keys in $string. There is no syntax for special keys,
+        everything will be typed "as-is" if possible.
     $al->perform ($wd)
         Finaluses and compiles the list, if not done yet, and calls
         "$wd->perform" with it.

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing AnyEvent-WebDriver/README (file contents): Revision 1.4 by root, Wed Aug 29 02:17:51 2018 UTC vs. Revision 1.5 by root, Wed Aug 29 05:55:23 2018 UTC

Diff Legend

Comparing AnyEvent-WebDriver/README (file contents):
Revision 1.4 by root, Wed Aug 29 02:17:51 2018 UTC vs.
Revision 1.5 by root, Wed Aug 29 05:55:23 2018 UTC