Skip to content

Commit

Permalink
feat(repo): Use class input UrlboxOptions to improve typing
Browse files Browse the repository at this point in the history
  • Loading branch information
@AJCJ1 @cjroebuck
AJCJ1 authored and cjroebuck committed Jan 21, 2025
1 parent 3eda4ec commit 308dd47
Show file tree
Hide file tree
Showing 3 changed files with 402 additions and 87 deletions.
263 changes: 208 additions & 55 deletions Urlbox.MsTest/UrlboxTest.cs
View file
Original file line number Diff line number Diff line change
@@ -1,116 +1,236 @@
using System.Diagnostics;
using System.Diagnostics;
using System.Dynamic;
using System;
using System.Threading.Tasks;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Screenshots;


[TestClass]
public class UrlTests
{
UrlboxOptions urlboxAllOptions = new UrlboxOptions(url: "https://urlbox.com")
{
Html = "test",
Width = 123,
Height = 123,
FullPage = true,
Selector = "test",
Clip = "test",
Gpu = true,
ResponseType = "test",
BlockAds = true,
HideCookieBanners = true,
ClickAccept = true,
BlockUrls = true,
BlockImages = true,
BlockFonts = true,
BlockMedias = true,
BlockStyles = true,
BlockScripts = true,
BlockFrames = true,
BlockFetch = true,
BlockXhr = true,
BlockSockets = true,
HideSelector = "test",
Js = "test",
Css = "test",
DarkMode = true,
ReducedMotion = true,
Retina = true,
ThumbWidth = 123,
ThumbHeight = 123,
ImgFit = "test",
ImgPosition = "test",
ImgBg = "test",
ImgPad = 123,
Quality = 123,
Transparent = true,
MaxHeight = 123,
Download = "test",
PdfPageSize = "test",
PdfPageRange = "test",
PdfPageWidth = 123,
PdfPageHeight = 123,
PdfMargin = "test",
PdfMarginTop = 123,
PdfMarginRight = 123,
PdfMarginBottom = 123,
PdfMarginLeft = 123,
PdfAutoCrop = true,
PdfScale = 0.12,
PdfOrientation = "test",
PdfBackground = true,
DisableLigatures = true,
Media = "test",
PdfShowHeader = true,
PdfHeader = "test",
PdfShowFooter = true,
PdfFooter = "test",
Readable = true,
Force = true,
Unique = "test",
Ttl = 123,
Proxy = "test",
Header = "test",
Cookie = "test",
UserAgent = "test",
Platform = "test",
AcceptLang = "test",
Authorization = "test",
Tz = "test",
EngineVersion = "test",
Delay = 123,
Timeout = 123,
WaitUntil = "test",
WaitFor = "test",
WaitToLeave = "test",
WaitTimeout = 123,
FailIfSelectorMissing = true,
FailIfSelectorPresent = true,
FailOn4xx = true,
FailOn5xx = true,
ScrollTo = "test",
Click = "test",
ClickAll = "test",
Hover = "test",
BgColor = "test",
DisableJs = true,
FullPageMode = "test",
FullWidth = true,
AllowInfinite = true,
SkipScroll = true,
DetectFullHeight = true,
MaxSectionHeight = 123,
ScrollIncrement = "test",
ScrollDelay = 123,
Highlight = "test",
HighlightFg = "test",
HighlightBg = "test",
Latitude = 0.12,
Longitude = 0.12,
Accuracy = 123,
UseS3 = true,
S3Path = "test",
S3Bucket = "test",
S3Endpoint = "test",
S3Region = "test",
CdnHost = "test",
S3StorageClass = "test",
};

private Urlbox urlbox;
private UrlGenerator urlGenerator;


[TestInitialize]
public void TestInitialize()
{
urlbox = new Urlbox("MY_API_KEY", "secret");
urlGenerator = new UrlGenerator("MY_API_KEY", "secret");
urlbox = new Urlbox("MY_API_KEY", "secret");
}

//[TestMethod]
//public void WithOptions()
//{
// dynamic options = new ExpandoObject();
// options.url = "bbc.co.uk";
// options.Width = 1280;
// options.Thumb_Width = 500;
// options.Full_Page = true;
[TestMethod]
public void GenerateUrlboxUrl_WithAllOptions()
{
var output = urlbox.GenerateUrlboxUrl(urlboxAllOptions);
Console.WriteLine(output);

// var output = urlbox.GenerateUrlboxUrl(options);
// Assert.AreEqual("https://api.urlbox.com/v1/MY_API_KEY/d6b5068716c19ba4556648ad9df047d5847cda0c/png?url=bbc.co.uk&width=1280&thumb_width=500&full_page=true",
// output, "Not OK");
//}
Assert.AreEqual(
"https://api.urlbox.com/v1/MY_API_KEY/1f11feec77221ee8e21911c342d6b3ba8d2b5153/png?url=https%3A%2F%2Furlbox.com&html=test&width=123&height=123&full_page=true&selector=test&clip=test&gpu=true&response_type=test&block_ads=true&hide_cookie_banners=true&click_accept=true&block_urls=true&block_images=true&block_fonts=true&block_medias=true&block_styles=true&block_scripts=true&block_frames=true&block_fetch=true&block_xhr=true&block_sockets=true&hide_selector=test&js=test&css=test&dark_mode=true&reduced_motion=true&retina=true&thumb_width=123&thumb_height=123&img_fit=test&img_position=test&img_bg=test&img_pad=123&quality=123&transparent=true&max_height=123&download=test&pdf_page_size=test&pdf_page_range=test&pdf_page_width=123&pdf_page_height=123&pdf_margin=test&pdf_margin_top=123&pdf_margin_right=123&pdf_margin_bottom=123&pdf_margin_left=123&pdf_auto_crop=true&pdf_scale=0.12&pdf_orientation=test&pdf_background=true&disable_ligatures=true&media=test&pdf_show_header=true&pdf_header=test&pdf_show_footer=true&pdf_footer=test&readable=true&force=true&unique=test&ttl=123&proxy=test&header=test&cookie=test&user_agent=test&platform=test&accept_lang=test&authorization=test&tz=test&engine_version=test&delay=123&timeout=123&wait_until=test&wait_for=test&wait_to_leave=test&wait_timeout=123&fail_if_selector_missing=true&fail_if_selector_present=true&fail_on4xx=true&fail_on5xx=true&scroll_to=test&click=test&click_all=test&hover=test&bg_color=test&disable_js=true&full_page_mode=test&full_width=true&allow_infinite=true&skip_scroll=true&detect_full_height=true&max_section_height=123&scroll_increment=test&scroll_delay=123&highlight=test&highlight_fg=test&highlight_bg=test&latitude=0.12&longitude=0.12&accuracy=123&use_s3=true&s3_path=test&s3_bucket=test&s3_endpoint=test&s3_region=test&cdn_host=test&s3_storage_class=test",
output
);
}

[TestMethod]
public void WithUrlEncodedOptions()
public void GenerateUrlboxUrl_WithUrlEncodedOptions()
{
dynamic options = new ExpandoObject();
options.url = "bbc.co.uk";
var options = new UrlboxOptions(url: "urlbox.com");
options.Width = 1280;
options.Thumb_Width = 500;
options.ThumbWidth = 500;
options.FullPage = true;
options.UserAgent = "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36";

var output = urlbox.GenerateUrlboxUrl(options);
Assert.AreEqual("https://api.urlbox.com/v1/MY_API_KEY/9c675714240421b50a9f76892d702cb0a5376ccf/png?url=bbc.co.uk&width=1280&thumb_width=500&full_page=true&user_agent=Mozilla%2F5.0%20%28Windows%20NT%206.1%29%20AppleWebKit%2F537.36%20%28KHTML%2C%20like%20Gecko%29%20Chrome%2F41.0.2228.0%20Safari%2F537.36",
output, "Not OK");
Assert.AreEqual("https://api.urlbox.com/v1/MY_API_KEY/5727321d7976d07d9f24649e6db556b2a6a71d9d/png?url=urlbox.com&width=1280&full_page=true&thumb_width=500&user_agent=Mozilla%2F5.0%20%28Windows%20NT%206.1%29%20AppleWebKit%2F537.36%20%28KHTML%2C%20like%20Gecko%29%20Chrome%2F41.0.2228.0%20Safari%2F537.36",
output);
}

[TestMethod]
public void UrlNeedsEncoding()
public void GenerateUrlboxUrl_UrlNeedsEncoding()
{
dynamic options = new ExpandoObject();
options.url = "https://www.hatchtank.io/markup/index.html?url2png=true&board=demo_1645_1430";
var options = new UrlboxOptions(url: "https://www.hatchtank.io/markup/index.html?url2png=true&board=demo_1645_1430");
var output = urlbox.GenerateUrlboxUrl(options);
Assert.AreEqual("https://api.urlbox.com/v1/MY_API_KEY/4b8ac501f3aaccbea2081a7105302593174ebc23/png?url=https%3A%2F%2Fwww.hatchtank.io%2Fmarkup%2Findex.html%3Furl2png%3Dtrue%26board%3Ddemo_1645_1430",
output, "Not OK");
output, "Not OK");
}

[TestMethod]
public void WithUserAgent()
public void GenerateUrlboxUrl_WithUserAgent()
{
dynamic options = new ExpandoObject();
options.Url = "https://bbc.co.uk";
options.User_Agent = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36";
var options = new UrlboxOptions(url: "https://bbc.co.uk");
options.UserAgent = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36";

var output = urlbox.GenerateUrlboxUrl(options);
Assert.AreEqual("https://api.urlbox.com/v1/MY_API_KEY/c2708392a4d881b4816e61b3ed4d89ae4f2c4a57/png?url=https%3A%2F%2Fbbc.co.uk&user_agent=Mozilla%2F5.0%20%28Macintosh%3B%20Intel%20Mac%20OS%20X%2010_12_6%29%20AppleWebKit%2F537.36%20%28KHTML%2C%20like%20Gecko%29%20Chrome%2F62.0.3202.94%20Safari%2F537.36", output);
}

[TestMethod]
public void IgnoreEmptyValuesAndFormat()
public void GenerateUrlboxUrl_IgnoreEmptyValuesAndFormat()
{
dynamic options = new ExpandoObject();
options.Url = "https://bbc.com";
options.Full_Page = false;
options.ThumbWidth = "";
options.Delay = null;
var options = new UrlboxOptions(url: "https://bbc.co.uk");
options.FullPage = false;
options.ThumbWidth = 0;
options.Delay = 0;
options.Format = "pdf";
options.Selector = "";
options.WaitFor = "";

var output = urlbox.GenerateUrlboxUrl(options);
Assert.AreEqual("https://api.urlbox.com/v1/MY_API_KEY/ffb3bf33fe1cc481c33f78de7762134662b63dad/png?url=https%3A%2F%2Fbbc.com&full_page=false",
output, "Not OK");
Assert.AreEqual("https://api.urlbox.com/v1/MY_API_KEY/8e00ad9a8d7c4abcd462a9b8ec041c3661f13995/png?url=https%3A%2F%2Fbbc.co.uk",
output);
}

[TestMethod]
public void FormatWorks()
public void GenerateUrlboxUrl_FormatWorks()
{
dynamic options = new ExpandoObject();
options.url = "bbc.co.uk";
var options = new UrlboxOptions(url: "https://bbc.co.uk");
var output = urlbox.GenerateUrlboxUrl(options, "jpeg");
Assert.AreEqual("https://api.urlbox.com/v1/MY_API_KEY/75c9016e7f98f90f5eabfd348f3091f7bf625153/jpeg?url=bbc.co.uk", output, "Not OK!");
Assert.AreEqual("https://api.urlbox.com/v1/MY_API_KEY/8e00ad9a8d7c4abcd462a9b8ec041c3661f13995/jpeg?url=https%3A%2F%2Fbbc.co.uk", output, "Not OK!");
}

[TestMethod]
public void WithoutUrl()
public void GenerateUrlboxUrl_WithHtml()
{
dynamic options = new ExpandoObject();
//options.Width = 500;
options.full_page = true;
var options = new UrlboxOptions(html: "<h1>test</h1>");
options.FullPage = true;
var output = urlbox.GenerateUrlboxUrl(options);
Assert.IsTrue(true);

Assert.AreEqual("https://api.urlbox.com/v1/MY_API_KEY/6e911f299782a8de56b56f47d8670bd0f085f41b/png?html=%3Ch1%3Etest%3C%2Fh1%3E&full_page=true", output);
}

[TestMethod]
public void SimpleURL()
public void GenerateUrlboxUrl_WithSimpleURL()
{
dynamic options = new ExpandoObject();
options.url = "bbc.co.uk";
var options = new UrlboxOptions(url: "bbc.co.uk");
var output = urlbox.GenerateUrlboxUrl(options);

Assert.AreEqual("https://api.urlbox.com/v1/MY_API_KEY/75c9016e7f98f90f5eabfd348f3091f7bf625153/png?url=bbc.co.uk",
output, "Not OK");
}

[TestMethod]
public void ToQueryString_ShouldRemoveFormatFromQueryString()
{
var options = new UrlboxOptions(url: "https://urlbox.com")
{
Format = "png",
FullPage = true
};
var output = urlGenerator.GenerateUrlboxUrl(options);

Assert.AreEqual("https://api.urlbox.com/v1/MY_API_KEY/bba10010e9ece486d34a82344170ae5b4dd5f347/png?url=https%3A%2F%2Furlbox.com&full_page=true", output);
}
}

[TestClass]
Expand All @@ -128,29 +248,62 @@ public void TestInitialize()
[TestMethod]
public async Task TestDownloadToFile()
{
//Urlbox s = new Urlbox("MY_API_KEY", "secret");
var urlboxUrl = "https://api.urlbox.com/v1/ca482d7e-9417-4569-90fe-80f7c5e1c781/5ee277f206869517d00cf1951f30d48ef9c64bfe/png?url=google.com";
var result = await urlbox.DownloadToFile(urlboxUrl, "result.png");
//Debug.WriteLine(result, "RESULT - Download");
Assert.IsTrue(true);
Assert.IsNotNull(result);
Assert.IsInstanceOfType(result, typeof(String));
Assert.IsTrue(result.Length >= 0);
}

[TestMethod]
public async Task TestDownloadBase64()
{
var urlboxUrl = "https://api.urlbox.com/v1/ca482d7e-9417-4569-90fe-80f7c5e1c781/59148a4e454a2c7051488defdb8b246bdea61ace/jpeg?url=bbc.co.uk";
var base64result = await urlbox.DownloadAsBase64(urlboxUrl);
//Debug.WriteLine(base64result, "RESULT - BASE64");
Assert.IsTrue(true);
}

[TestMethod]
public async Task TestDownloadFail()
{
//Urlbox s = new Urlbox("MY_API_KEY", "secret");
var urlboxUrl = "https://api.urlbox.com/v1/ca482d7e-9417-4569-90fe-80f7c5e1c781/59148a4e454a2c7051488defdb8b246bdea61ac/jpeg?url=bbc.co.uk";
var base64result = await urlbox.DownloadAsBase64(urlboxUrl);
Debug.WriteLine(base64result, "RESULT - BASE64");
Assert.IsTrue(true);
}
}
}
}


[TestClass]
public class UrlboxOptionsTest
{
[TestMethod]
public void UrlboxOptions_MissingHTMLandURL()
{
Assert.ThrowsException<ArgumentException>(() => new UrlboxOptions());
}

[TestMethod]
public void UrlboxOptions_CreatesSuccess_URL()
{
string url = "https://urlbox.com";
var urlboxOptions = new UrlboxOptions(url: url);

Assert.IsNotNull(urlboxOptions);
Assert.IsInstanceOfType(urlboxOptions, typeof(UrlboxOptions));
Assert.AreEqual(url, urlboxOptions.Url);
Assert.IsNull(urlboxOptions.Html);
}

[TestMethod]
public void UrlboxOptions_CreatesSuccess_HTML()
{
string html = "<h1>test</h1>";
var urlboxOptions = new UrlboxOptions(html: html);

Assert.IsNotNull(urlboxOptions);
Assert.IsInstanceOfType(urlboxOptions, typeof(UrlboxOptions));
Assert.AreEqual(html, urlboxOptions.Html);
Assert.IsNull(urlboxOptions.Url);
}
}
Loading

0 comments on commit 308dd47

Please sign in to comment.