XPing365.Core 1.0.0-rc1

About The Project

XPing365 SDK is designed to make eXternal Ping(s) to web applications to verify its availability and monitor its content by scraping data from the web pages. It allows users to parametrize URLs and generate hundrets of different queries.

Getting Started

XPing365 SDK can be installed via the NuGet package manager or .NET CLI. If you need help, please open an issue.

Installation using .NET CLI

dotnet add package XPing365.Core

Usage

In this section you will find 5 steps to start working with XPing 365 SDK. It is a small subset of what's possible with XPing 365 SDK.

• Setup program initialization with the Dependency injection in .NET.

var host = Host.CreateDefaultBuilder(args)
               .ConfigureServices(services =>
               {
                   services.AddHttpClient<IWebDataRetriever, WebDataRetriever>("httpClient", client => 
                   {
                       client.BaseAddress = new Uri("http://example.com/");
                   });
                   services.AddTransient<IDataParserFactory, DataParserFactory>();
                   services.AddTransient<IWebDataRetriever, WebDataRetriever>();
               })
               .Build();

• Declare your page you're going to test

class BasicPage : HtmlSource
{
    [XPath("//head/title")]
    public string? Title { get; set; }

    [XPath("//body/h1")]
    public string? Header { get; set; }

    [XPath("//body/p")]
    public string? Paragraph { get; set; }
}

• Get the WebDataRetriever object

var webDataRetriever = host.Services.GetRequiredService<IWebDataRetriever>();

• Fetch the web page content

BasicPage? basicPage = await webDataRetriever.GetFromHtmlAsync<BasicPage>("/basic_page.html");

• Assert your web page

Assert.AreEqaul(HttpStatusCode.OK, basicPage.ResponseCode); // or alternatively check property IsSuccessResponseCode
Assert.IsTrue(basicPage.ResponseSizeInBytes < 150000);
Assert.IsTrue(basicPage.RequestEndTime - basicPage.RequestStartTime <= TimeSpan.FromSeconds(5));
Assert.AreEqual("ExampleTile", basicPage.Title);
Assert.AreEqual("ExampleHeader", basicPage.Header);
Assert.AreEqual("ExampleParagraph", basicPage.Paragraph);