RabbitLabs/random-bunny
5
0
Fork 0
Code Issues 11 Pull requests 11 Projects 1 Releases 18 Wiki Activity Actions

Add "Gallery" field to return multiple images in 1 post #242

Merged
Vylpes merged 5 commits from feature/161-image-array into develop 2024-10-26 22:00:55 +01:00
Conversation 0 Commits 5 Files changed 9 +22 -17
5 changed files with 22 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 81437ede41 - Show all commits

4
src/helpers/imageHelper.ts
View file

@ -2,11 +2,11 @@ import fetch from "got-cjs";
import * as htmlparser from "htmlparser2"; import * as htmlparser from "htmlparser2";
export default class ImageHelper { export default class ImageHelper {
public static async FetchImageFromRedditGallery(url: string): Promise<string[] | undefined> { public static async FetchImageFromRedditGallery(url: string): Promise<string[]> {
const fetched = await fetch(url); const fetched = await fetch(url);
if (!fetched || fetched.errored || fetched.statusCode != 200) { if (!fetched || fetched.errored || fetched.statusCode != 200) {
return undefined; return [];
} }
const dom = htmlparser.parseDocument(fetched.body); const dom = htmlparser.parseDocument(fetched.body);

3
src/index.ts
View file

@ -93,7 +93,7 @@ export default async function randomBunny(subreddit: string, sortBy: "new" | "ho
const randomData = randomSelect.data; const randomData = randomSelect.data;
let url: string; let url: string;
let gallery: string[] = []; let gallery: string[];
if (randomData.url.includes("/gallery")) { if (randomData.url.includes("/gallery")) {
const galleryImage = await ImageHelper.FetchImageFromRedditGallery(randomData.url); const galleryImage = await ImageHelper.FetchImageFromRedditGallery(randomData.url);
@ -117,6 +117,7 @@ export default async function randomBunny(subreddit: string, sortBy: "new" | "ho
gallery = galleryImage; gallery = galleryImage;
} else { } else {
url = randomData.url; url = randomData.url;
gallery = [randomData.url];
} }
const redditResult: IRedditResult = { const redditResult: IRedditResult = {

2
tests/helpers/__snapshots__/outputHelper.test.ts.snap
View file

@ -13,7 +13,7 @@ Upvotes = 17
Url = https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d" Url = https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d"
`; `;
exports[`GenerateOutput GIVEN options.json is true, EXPECT output to be returned as JSON 1`] = `"{"Archived":false,"Author":"author","Downs":0,"Hidden":false,"Permalink":"/r/Rabbits/comments/1dj8pbt/this_is_my_ms_bear/","Subreddit":"Rabbits","SubredditSubscribers":654751,"Title":"This is my Ms Bear!","Ups":17,"Url":"https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d"}"`; exports[`GenerateOutput GIVEN options.json is true, EXPECT output to be returned as JSON 1`] = `"{"Archived":false,"Author":"author","Downs":0,"Hidden":false,"Permalink":"/r/Rabbits/comments/1dj8pbt/this_is_my_ms_bear/","Subreddit":"Rabbits","SubredditSubscribers":654751,"Title":"This is my Ms Bear!","Ups":17,"Url":"https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d","Gallery":["https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d"]}"`;
exports[`GenerateOutput GIVEN options.queryMetadata is supplied, EXPECT query metadata to be added 1`] = ` exports[`GenerateOutput GIVEN options.queryMetadata is supplied, EXPECT query metadata to be added 1`] = `
"Archived = false "Archived = false

27
tests/helpers/imageHelper.test.ts
View file

@ -17,18 +17,19 @@ describe("FetchImageFromRedditGallery", () => {
expect(fetchMock).toHaveBeenCalledTimes(1); expect(fetchMock).toHaveBeenCalledTimes(1);
expect(fetchMock).toHaveBeenCalledWith("https://redd.it/gallery/image"); expect(fetchMock).toHaveBeenCalledWith("https://redd.it/gallery/image");
expect(result).toBe("https://preview.redd.it/image.png"); expect(result.length).toBe(1);
expect(result[0]).toBe("https://preview.redd.it/image.png");
}); });
test("GIVEN fetch is unable to return data, EXPECT undefined returned", async () => { test("GIVEN fetch is unable to return data, EXPECT empty array returned", async () => {
fetchMock.mockResolvedValue(null); fetchMock.mockResolvedValue(null);
const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image"); const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image");
expect(result).toBeUndefined(); expect(result.length).toBe(0);
}); });
test("GIVEN fetch is an error, EXPECT undefined returned", async () => { test("GIVEN fetch is an error, EXPECT empty array returned", async () => {
fetchMock.mockResolvedValue({ fetchMock.mockResolvedValue({
body: "<html><body><img src='https://preview.redd.it/image.png' /></body></html>", body: "<html><body><img src='https://preview.redd.it/image.png' /></body></html>",
errored: "Error", errored: "Error",
@ -37,10 +38,10 @@ describe("FetchImageFromRedditGallery", () => {
const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image"); const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image");
expect(result).toBeUndefined(); expect(result.length).toBe(0);
}); });
test("GIVEN fetch is not status code of 200, EXPECT undefined returned", async () => { test("GIVEN fetch is not status code of 200, EXPECT empty array returned", async () => {
fetchMock.mockResolvedValue({ fetchMock.mockResolvedValue({
body: "<html><body><img src='https://preview.redd.it/image.png' /></body></html>", body: "<html><body><img src='https://preview.redd.it/image.png' /></body></html>",
errored: undefined, errored: undefined,
@ -49,10 +50,10 @@ describe("FetchImageFromRedditGallery", () => {
const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image"); const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image");
expect(result).toBeUndefined(); expect(result.length).toBe(0);
}); });
test("GIVEN image tag is not found, EXPECT undefined returned", async () => { test("GIVEN image tag is not found, EXPECT empty array returned", async () => {
fetchMock.mockResolvedValue({ fetchMock.mockResolvedValue({
body: "<html><body></body></html>", body: "<html><body></body></html>",
errored: undefined, errored: undefined,
@ -61,10 +62,10 @@ describe("FetchImageFromRedditGallery", () => {
const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image"); const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image");
expect(result).toBeUndefined(); expect(result.length).toBe(0);
}); });
test("GIVEN image source attribute is not found, EXPECT undefined returned", async () => { test("GIVEN image source attribute is not found, EXPECT empty array returned", async () => {
fetchMock.mockResolvedValue({ fetchMock.mockResolvedValue({
body: "<html><body><img /></body></html>", body: "<html><body><img /></body></html>",
errored: undefined, errored: undefined,
@ -73,10 +74,10 @@ describe("FetchImageFromRedditGallery", () => {
const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image"); const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image");
expect(result).toBeUndefined(); expect(result.length).toBe(0);
}); });
test("GIVEN image source attribute is not found that is a preview.redd.it url, EXPECT undefined returned", async () => { test("GIVEN image source attribute is not found that is a preview.redd.it url, EXPECT empty array returned", async () => {
fetchMock.mockResolvedValue({ fetchMock.mockResolvedValue({
body: "<html><body><img src='main.png' /></body></html>", body: "<html><body><img src='main.png' /></body></html>",
errored: undefined, errored: undefined,
@ -85,6 +86,6 @@ describe("FetchImageFromRedditGallery", () => {
const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image"); const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image");
expect(result).toBeUndefined(); expect(result.length).toBe(0);
}); });
}); });

3
tests/helpers/outputHelper.test.ts
View file

@ -23,6 +23,7 @@ describe("GenerateOutput", () => {
Title: "This is my Ms Bear!", Title: "This is my Ms Bear!",
Ups: 17, Ups: 17,
Url: "https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d", Url: "https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d",
Gallery: ["https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d"],
}, },
} as IReturnResult; } as IReturnResult;
@ -55,6 +56,7 @@ describe("GenerateOutput", () => {
Title: "This is my Ms Bear!", Title: "This is my Ms Bear!",
Ups: 17, Ups: 17,
Url: "https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d", Url: "https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d",
Gallery: ["https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d"],
}, },
} as IReturnResult; } as IReturnResult;
@ -89,6 +91,7 @@ describe("GenerateOutput", () => {
Title: "This is my Ms Bear!", Title: "This is my Ms Bear!",
Ups: 17, Ups: 17,
Url: "https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d", Url: "https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d",
Gallery: ["https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d"],
}, },
} as IReturnResult; } as IReturnResult;