Automation Engines

Driving a Live Browser Through the OttoMagic REST Client

Calling REST APIs with GPAL.RESTClient Chaining REST Calls: Results and Workflows The Fluent Interface Automation Engines Browser Automation Basics

Complete Program

This is a trimmed version of the actual test program. It launches a browser, gets browser.OttoMagicClient, opens a few tabs to set up a session, then drives the page through a series of endpoint calls.

using GenerallyPositive;

using GenerallyPositive.Browser;

using static GenerallyPositive.Enums;

GPAL.WithAutomationEngine(AutomationEngine.OttoMagic).WithPublishToConsole();

IBrowser browser = GPAL.Browser

.WithBrowserType(BrowserType.Chrome)

.WithAutomationEngine(AutomationEngine.OttoMagic)

.WithDriverLocation(@"C:drivers")

.ToGPALObject();

browser.GoTo(""); // launches with the default home page

IRESTClient client = browser.OttoMagicClient;

// Set up the session

client.GoTo("https://example.com").Execute();

client.CheckNetworkIdle().Execute();

client.NewTab("https://example.com").Execute();

client.CheckNetworkIdle().Execute();

// Drive the page

dynamic result = client.GetCurrentUrl().Execute<string>();

result = client.IsEndOfPage().Execute<bool>();

result = client.LeftClick("#login-button").Execute();

result = client.FillInOverwrite("#search-input").WithText("hello world").Execute();

result = client.ScrollWindow(0, 400).Execute();

result = client.Maximize().Execute();

browser.Close(true);

OttoMagicClient: A Pre-Wired REST Client

browser.OttoMagicClient saves you from setting WithAPIBase yourself - it is already pointed at that browser's RestApiBaseUrl, the local OttoMagic REST API server. Calling it returns the same fluent IRESTClient you'd get from GPAL.RESTClient, just pre-configured. Give it a WithName so any logged errors are easy to trace back to this client.

IRESTClient client = browser.OttoMagicClient;

NOTE

The client is fetched once. From here every endpoint call is a fluent chain off that same object, and there is no need to reach for browser.OttoMagicClient again between calls.

Setting Up the Session: Tabs and Network Idle

GoTo navigates the current tab, NewTab opens another, and CheckNetworkIdle waits until the page settles before the next action runs. This mirrors how a real workflow primes multiple tabs before doing any scraping or interaction.

client.GoTo("https://example.com").Execute();

client.CheckNetworkIdle().Execute();

client.NewTab("https://example.com").Execute();

client.CheckNetworkIdle().Execute();

Every Browser Action Is an Endpoint Call

Reading the page, clicking, typing, and scrolling all follow the same shape: call the endpoint method, optionally chain a With* parameter, then call Execute() (or Execute<T>() when you want a typed result back). GetCurrentUrl and IsEndOfPage return values; LeftClick, FillInOverwrite, ScrollWindow, and Maximize perform actions.

string currentUrl = client.GetCurrentUrl().Execute<string>();

bool atEnd = client.IsEndOfPage().Execute<bool>();

client.LeftClick("#login-button").Execute();

client.FillInOverwrite("#search-input").WithText("hello world").Execute();

client.ScrollWindow(0, 400).Execute();

client.Maximize().Execute();

NOTE

The real test program exercises every value of the ApiEndpoint enum this way - Back, Forward, Hover, RightClick, GetAttribute, WindowInnerWidth, and dozens more. They all follow the identical call-then-Execute pattern shown here.

Closing Down

Once the workflow is finished, close the browser. Passing true tells GPAL to stop the underlying automation engine entirely, not just the tab.

browser.Close(true);

WARNING

Passing true kills the running automation engine process. If other code in the same run still needs the browser, pass false instead.

Documentation Example

Documentation

Showing off some plain text in these paragraphs eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Other formats

Here you can find different accents and emphasis sit amet consectetur adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

This is a link and how it could look like bestlinkinthebeautifulworld. Obcaecati, iste distinctio veritatis eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Here's just some classic bold text adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam notBoldSecondbestlinkinthebeautifulworld illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Obcaecati, iste distinctio veritatis eligendi laboriosam adipisicing elit illo nostrum corporis at adipisicing elit libero vel voluptas? Expedita, adipisicing facere dolores voluptatem ad ab rem assumenda soluta!

Other cuple of colors in case we want to emphasize several ways adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam adipisicing elit illo nostrum corporis at voluptatem libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Adding Images to the content

Lorem ipsum dolor sit amet consectetur adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta! Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quod veniam, quam ad expedita laborum sed at voluptates culpa ipsam ut vel. Ullam temporibus a mollitia quod aliquam ratione exercitationem nesciunt.

Coding Blocks

Lorem ipsum dolor sit amet consectetur adipisicing elit. Repudiandae quas consequuntur illo numquam assumenda autem exercitationem distinctio perspiciatis in natus. Eius dicta similique ipsam ipsa minima, nemo quae enim tempore.

GPAL

.CallIfNotFound(GenericCallIfNotFound)

.WithPublishToConsole();

//System.Drawing.Rectangle windowSize = new System.Drawing.Rectangle(10, 10, 1500, 1024);

// NOTE: we have to set browser = before we execute any steps

// this is due to the 'GenericCallIfNotFound' which might throw an exception, and BankScraper will not have the browser set when it calls scraper.Close()

// until the complete fluent line gets executed (meaning every step, meaning browser is not set until everything else succeeds)

browser = GPAL.Browser

.WithBrowserType(Enums.BrowserType.Chrome)

.WithProfileDataDirectory(ChromeProfileLocation)

.WithUseAutomationEngine(AutomationEngine.Selenium)

.WithWindowSize(new System.Drawing.Rectangle(0,0,1920,1080))

.ToGPALObject();

Automation Engines

Automation Engines

Driving a Live Browser Through the OttoMagic REST Client

Complete Program

OttoMagicClient: A Pre-Wired REST Client

Setting Up the Session: Tabs and Network Idle

Every Browser Action Is an Endpoint Call

Closing Down

Documentation Example

Documentation

Category

Endpoint

Enpoint

Enpoint

Enpoint

Other formats

Adding Images to the content

Coding Blocks

On this page