diff --git a/package.json b/package.json index 1dad193..8224184 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "random-bunny", - "version": "2.1.6", + "version": "2.1.5", "description": "Get a random subreddit image url", "license": "MIT", "author": "Vylpes", @@ -21,7 +21,6 @@ "commander": "^12.0.0", "glob-parent": "^6.0.0", "got-cjs": "^12.5.4", - "htmlparser2": "^9.1.0", "linqts": "^1.14.4" }, "scripts": { diff --git a/src/imageHelper.ts b/src/imageHelper.ts deleted file mode 100644 index 3da0fc9..0000000 --- a/src/imageHelper.ts +++ /dev/null @@ -1,19 +0,0 @@ -import fetch from "got-cjs"; -import * as htmlparser from "htmlparser2"; - -export default class ImageHelper { - public static async FetchImageFromRedditGallery(url: string): Promise { - const fetched = await fetch(url); - - if (!fetched || fetched.errored || fetched.statusCode != 200) { - return undefined; - } - - const dom = htmlparser.parseDocument(fetched.body); - const img = htmlparser.DomUtils.findOne((x => x.tagName == "img" && x.attributes.find(y => y.value.includes("https://preview.redd.it")) != null), dom.children, true); - - const imgSrc = img?.attributes.find(x => x.name == "src")?.value; - - return imgSrc; - } -} \ No newline at end of file diff --git a/src/index.ts b/src/index.ts index 75ad628..3d7277b 100644 --- a/src/index.ts +++ b/src/index.ts @@ -5,7 +5,6 @@ import { List } from 'linqts'; import IFetchResult from "./contracts/IFetchResult"; import { ErrorCode } from "./constants/ErrorCode"; import ErrorMessages from "./constants/ErrorMessages"; -import ImageHelper from "./imageHelper"; const sortable = [ 'new', @@ -57,7 +56,7 @@ export default async function randomBunny(subreddit: string, sortBy: string = 'h const data: IFetchResult[] = json.data.children; const dataWithImages = new List(data) - .Where(x => x!.data.url.includes('.jpg') || x!.data.url.includes('.png') || x!.data.url.includes("/gallery/")) + .Where(x => x!.data.url.includes('.jpg') || x!.data.url.includes('.png')) .ToArray(); let random = 0; @@ -82,30 +81,6 @@ export default async function randomBunny(subreddit: string, sortBy: string = 'h const randomData = randomSelect.data; - let url: string; - - if (randomData.url.includes("/gallery")) { - const galleryImage = await ImageHelper.FetchImageFromRedditGallery(randomData.url); - - if (!galleryImage) { - return { - IsSuccess: false, - Query: { - subreddit: subreddit, - sortBy: sortBy, - }, - Error: { - Code: ErrorCode.NoImageResultsFound, - Message: ErrorMessages.NoImageResultsFound, - }, - } - } - - url = galleryImage; - } else { - url = randomData.url; - } - const redditResult: IRedditResult = { Archived: randomData['archived'], Downs: randomData['downs'], @@ -115,7 +90,7 @@ export default async function randomBunny(subreddit: string, sortBy: string = 'h SubredditSubscribers: randomData['subreddit_subscribers'], Title: randomData['title'], Ups: randomData['ups'], - Url: url, + Url: randomData['url'] }; return { diff --git a/tests/cli.test.ts b/tests/cli.test.ts index 66fecbe..9671235 100644 --- a/tests/cli.test.ts +++ b/tests/cli.test.ts @@ -147,7 +147,7 @@ describe('query-metadata', () => { expect(query).toBeUndefined(); }, 5000); - test('GIVEN --query-metadata is supplied, EXPECT query metadata returned', async () => { + test('GIVEN --query-metadata is not supplied, EXPECT no query metadata returned', async () => { const result = await cli(['--query-metadata'], '.'); const query = result.stdout.split('\n') @@ -156,7 +156,7 @@ describe('query-metadata', () => { expect(query).toBeDefined(); }, 5000); - test('GIVEN -q is supplied, EXPECT query metadata returned', async () => { + test('GIVEN -q is not supplied, EXPECT no query metadata returned', async () => { const result = await cli(['-q'], '.'); const query = result.stdout.split('\n') diff --git a/tests/imageHelper.test.ts b/tests/imageHelper.test.ts deleted file mode 100644 index 77227b1..0000000 --- a/tests/imageHelper.test.ts +++ /dev/null @@ -1,90 +0,0 @@ -import ImageHelper from "../src/imageHelper"; -import fetch from "got-cjs"; - -jest.mock('got-cjs'); -const fetchMock = jest.mocked(fetch); - -describe("FetchImageFromRedditGallery", () => { - test("EXPECT image url to be returned", async () => { - fetchMock.mockResolvedValue({ - body: "", - errored: undefined, - statusCode: 200, - }); - - const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image"); - - expect(fetchMock).toHaveBeenCalledTimes(1); - expect(fetchMock).toHaveBeenCalledWith("https://redd.it/gallery/image"); - - expect(result).toBe("https://preview.redd.it/image.png"); - }); - - test("GIVEN fetch is unable to return data, EXPECT undefined returned", async () => { - fetchMock.mockResolvedValue(null); - - const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image"); - - expect(result).toBeUndefined(); - }); - - test("GIVEN fetch is an error, EXPECT undefined returned", async () => { - fetchMock.mockResolvedValue({ - body: "", - errored: "Error", - statusCode: 200, - }); - - const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image"); - - expect(result).toBeUndefined(); - }); - - test("GIVEN fetch is not status code of 200, EXPECT undefined returned", async () => { - fetchMock.mockResolvedValue({ - body: "", - errored: undefined, - statusCode: 500, - }); - - const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image"); - - expect(result).toBeUndefined(); - }); - - test("GIVEN image tag is not found, EXPECT undefined returned", async () => { - fetchMock.mockResolvedValue({ - body: "", - errored: undefined, - statusCode: 200, - }); - - const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image"); - - expect(result).toBeUndefined(); - }); - - test("GIVEN image source attribute is not found, EXPECT undefined returned", async () => { - fetchMock.mockResolvedValue({ - body: "", - errored: undefined, - statusCode: 200, - }); - - const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image"); - - expect(result).toBeUndefined(); - }); - - test("GIVEN image source attribute is not found that is a preview.redd.it url, EXPECT undefined returned", async () => { - fetchMock.mockResolvedValue({ - body: "", - errored: undefined, - statusCode: 200, - }); - - const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image"); - - expect(result).toBeUndefined(); - }); -}); \ No newline at end of file diff --git a/tests/index.test.ts b/tests/index.test.ts index 053f347..37ab315 100644 --- a/tests/index.test.ts +++ b/tests/index.test.ts @@ -1,6 +1,5 @@ import { ErrorCode } from "../src/constants/ErrorCode"; import ErrorMessages from "../src/constants/ErrorMessages"; -import ImageHelper from "../src/imageHelper"; import randomBunny from "../src/index"; import fetch from "got-cjs"; @@ -190,77 +189,5 @@ describe('randomBunny', () => { expect(result.Error!.Message).toBe(ErrorMessages.NoImageResultsFound); expect(fetchMock).toBeCalledWith('https://reddit.com/r/rabbits/new.json?limit=100'); - expect(fetchMock).toBeCalledWith('https://reddit.com/r/rabbits/new.json?limit=100'); - }); - - test("GIVEN data fetched is a gallery AND an image is returned from the helper, EXPECT this to be used", async () => { - fetchMock.mockResolvedValue({ - body: JSON.stringify({ - data: { - children: [ - { - data: { - archived: false, - downs: 0, - hidden: false, - permalink: '/r/Rabbits/comments/12pa5te/someone_told_pickles_its_monday_internal_fury/', - subreddit: 'Rabbits', - subreddit_subscribers: 298713, - title: 'Someone told pickles it’s Monday… *internal fury*', - ups: 1208, - url: 'https://i.redd.it/gallery/cr8xudsnkgua1', - }, - }, - ], - } - }), - }); - - ImageHelper.FetchImageFromRedditGallery = jest.fn().mockResolvedValue("https://i.redd.it/cr8xudsnkgua1.jpg") - - const result = await randomBunny('rabbits', 'new'); - - expect(result.IsSuccess).toBeTruthy(); - expect(result.Result).toBeDefined(); - - expect(fetchMock).toBeCalledWith('https://reddit.com/r/rabbits/new.json?limit=100'); - - expect(ImageHelper.FetchImageFromRedditGallery).toHaveBeenCalledTimes(1); - expect(ImageHelper.FetchImageFromRedditGallery).toHaveBeenCalledWith("https://i.redd.it/gallery/cr8xudsnkgua1"); - }); - - test("GIVEN data fetched is a gallery AND an image is not returned from the helper, EXPECT error", async () => { - fetchMock.mockResolvedValue({ - body: JSON.stringify({ - data: { - children: [ - { - data: { - archived: false, - downs: 0, - hidden: false, - permalink: '/r/Rabbits/comments/12pa5te/someone_told_pickles_its_monday_internal_fury/', - subreddit: 'Rabbits', - subreddit_subscribers: 298713, - title: 'Someone told pickles it’s Monday… *internal fury*', - ups: 1208, - url: 'https://i.redd.it/gallery/cr8xudsnkgua1', - }, - }, - ], - } - }), - }); - - ImageHelper.FetchImageFromRedditGallery = jest.fn().mockResolvedValue(undefined) - - const result = await randomBunny('rabbits', 'new'); - - expect(ImageHelper.FetchImageFromRedditGallery).toHaveBeenCalledTimes(1); - - expect(result.IsSuccess).toBe(false); - expect(result.Error).toBeDefined(); - expect(result.Error?.Code).toBe(ErrorCode.NoImageResultsFound); - expect(result.Error?.Message).toBe(ErrorMessages.NoImageResultsFound); }); }); \ No newline at end of file diff --git a/yarn.lock b/yarn.lock index 33bb80e..ce1063d 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1883,36 +1883,6 @@ doctrine@^3.0.0: dependencies: esutils "^2.0.2" -dom-serializer@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/dom-serializer/-/dom-serializer-2.0.0.tgz#e41b802e1eedf9f6cae183ce5e622d789d7d8e53" - integrity sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg== - dependencies: - domelementtype "^2.3.0" - domhandler "^5.0.2" - entities "^4.2.0" - -domelementtype@^2.3.0: - version "2.3.0" - resolved "https://registry.yarnpkg.com/domelementtype/-/domelementtype-2.3.0.tgz#5c45e8e869952626331d7aab326d01daf65d589d" - integrity sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw== - -domhandler@^5.0.2, domhandler@^5.0.3: - version "5.0.3" - resolved "https://registry.yarnpkg.com/domhandler/-/domhandler-5.0.3.tgz#cc385f7f751f1d1fc650c21374804254538c7d31" - integrity sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w== - dependencies: - domelementtype "^2.3.0" - -domutils@^3.1.0: - version "3.1.0" - resolved "https://registry.yarnpkg.com/domutils/-/domutils-3.1.0.tgz#c47f551278d3dc4b0b1ab8cbb42d751a6f0d824e" - integrity sha512-H78uMmQtI2AhgDJjWeQmHwJJ2bLPD3GMmO7Zja/ZZh84wkm+4ut+IUnUdRa8uCGX88DiVx1j6FRe1XfxEgjEZA== - dependencies: - dom-serializer "^2.0.0" - domelementtype "^2.3.0" - domhandler "^5.0.3" - dot-prop@^6.0.1: version "6.0.1" resolved "https://registry.yarnpkg.com/dot-prop/-/dot-prop-6.0.1.tgz#fc26b3cf142b9e59b74dbd39ed66ce620c681083" @@ -1964,11 +1934,6 @@ end-of-stream@^1.1.0, end-of-stream@^1.4.1: dependencies: once "^1.4.0" -entities@^4.2.0, entities@^4.5.0: - version "4.5.0" - resolved "https://registry.yarnpkg.com/entities/-/entities-4.5.0.tgz#5d268ea5e7113ec74c4d033b79ea5a35a488fb48" - integrity sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw== - error-ex@^1.3.1: version "1.3.2" resolved "https://registry.yarnpkg.com/error-ex/-/error-ex-1.3.2.tgz#b4ac40648107fdcdcfae242f428bea8a14d4f1bf" @@ -2613,16 +2578,6 @@ html-escaper@^2.0.0: resolved "https://registry.yarnpkg.com/html-escaper/-/html-escaper-2.0.2.tgz#dfd60027da36a36dfcbe236262c00a5822681453" integrity sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg== -htmlparser2@^9.1.0: - version "9.1.0" - resolved "https://registry.yarnpkg.com/htmlparser2/-/htmlparser2-9.1.0.tgz#cdb498d8a75a51f739b61d3f718136c369bc8c23" - integrity sha512-5zfg6mHUoaer/97TxnGpxmbR7zJtPwIYFMZ/H5ucTlPZhKvtum05yiPK3Mgai3a0DyVxv7qYqoweaEd2nrYQzQ== - dependencies: - domelementtype "^2.3.0" - domhandler "^5.0.3" - domutils "^3.1.0" - entities "^4.5.0" - http-cache-semantics@^4.0.0, http-cache-semantics@^4.1.1: version "4.1.1" resolved "https://registry.yarnpkg.com/http-cache-semantics/-/http-cache-semantics-4.1.1.tgz#abe02fcb2985460bf0323be664436ec3476a6d5a" @@ -5185,9 +5140,9 @@ types-pkg-json@^1.1.0: types-json "^1.2.2" typescript@^5.0.0: - version "5.4.5" - resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.4.5.tgz#42ccef2c571fdbd0f6718b1d1f5e6e5ef006f611" - integrity sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ== + version "5.4.4" + resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.4.4.tgz#eb2471e7b0a5f1377523700a21669dce30c2d952" + integrity sha512-dGE2Vv8cpVvw28v8HCPqyb08EzbBURxDpuhJvTrusShUfGnhHBafDsLdS1EhhxyL6BJQE+2cT3dDPAv+MQ6oLw== undici-types@~5.26.4: version "5.26.5"