feat: stackoverflow command (#95)

* feat: stackoverflow command

* refactor: some changes

* feat: stackoverflow tests

Author: AdiPol1359

src/commands/index.ts

@@ -5,9 +5,9 @@ import { getConfig } from '../config';
 import type { Command } from '../types';
 import { InvalidUsageError } from '../types';
 
-import { addKarma, karma, KARMA_REGEX } from './karma';
 import co from './co';
 import execute from './execute';
+import { addKarma, karma, KARMA_REGEX } from './karma';
 // import { grzesiu, morritz } from './kocopoly';
 import link from './link';
 import m1 from './m1';
@@ -25,6 +25,7 @@ import roll from './roll';
 import server from './server';
 import skierowanie from './skierowanie';
 import spotify from './spotify';
+import stackoverflow from './stackoverflow';
 import stats from './stats';
 import summon from './summon';
 import typeofweb from './towarticle';
@@ -66,6 +67,7 @@ const allCommands = [
   xkcd,
   yesno,
   youtube,
+  stackoverflow,
 ];
 
 const cooldowns = new Discord.Collection<string, Discord.Collection<string, number>>();

src/commands/stackoverflow.spec.ts

@@ -0,0 +1,57 @@
+import { expect } from 'chai';
+import * as Discord from 'discord.js';
+import nock from 'nock';
+
+import { getMessageMock } from '../../test/mocks';
+
+import stackoverflow from './stackoverflow';
+
+describe('stackoverflow', () => {
+  const mockItem = {
+    link: 'Jak pisać testy',
+    title: 'https://stackoverflow.com/questions/0/how-to-write-tests',
+  } as const;
+
+  const mockLinksEmbed = () =>
+    new Discord.MessageEmbed()
+      .setAuthor(
+        'Stack Overflow',
+        'https://upload.wikimedia.org/wikipedia/commons/thumb/e/ef/Stack_Overflow_icon.svg/768px-Stack_Overflow_icon.svg.png',
+        'https://stackoverflow.com/',
+      )
+      .setTitle('1 najlepsza odpowiedź:')
+      .setColor('f4811e')
+      .addFields([{ name: mockItem.title, value: mockItem.link }]);
+
+  it('should show error message when nothing found on stackoverflow', async () => {
+    nock('https://api.stackexchange.com')
+      .get(
+        '/2.3/search/advanced?pagesize=5&order=desc&sort=activity&q=jak%20pisac%20testy&site=stackoverflow',
+      )
+      .reply(200, { items: [] });
+
+    const msg = getMessageMock('msg');
+
+    await stackoverflow.execute(msg as unknown as Discord.Message, ['jak', 'pisac', 'testy']);
+
+    return expect(msg.channel.send).to.have.been.calledOnce.and.calledWithMatch(
+      'Niestety nic nie znalazłem',
+    );
+  });
+
+  it('should show links when found on stackoverflow', async () => {
+    nock('https://api.stackexchange.com')
+      .get(
+        '/2.3/search/advanced?pagesize=5&order=desc&sort=activity&q=jak%20pisac%20testy&site=stackoverflow',
+      )
+      .reply(200, {
+        items: [mockItem],
+      });
+
+    const msg = getMessageMock('msg');
+
+    await stackoverflow.execute(msg as unknown as Discord.Message, ['jak', 'pisac', 'testy']);
+
+    return expect(msg.channel.send).to.have.been.calledOnceWithExactly(mockLinksEmbed());
+  });
+});

src/commands/stackoverflow.ts

@@ -0,0 +1,92 @@
+import Discord from 'discord.js';
+import fetch from 'node-fetch';
+
+import type { Command } from '../types';
+
+const ICON_URL =
+  'https://upload.wikimedia.org/wikipedia/commons/thumb/e/ef/Stack_Overflow_icon.svg/768px-Stack_Overflow_icon.svg.png';
+
+const isApiError = (data: ApiResponse): data is ApiResponseError => 'error_id' in data;
+
+const formatTitle = (length: number) =>
+  length === 1
+    ? 'najlepsza odpowiedź'
+    : length < 5
+    ? 'najlepsze odpowiedzi'
+    : 'najlepszych odpowiedzi';
+
+const stackoverflow: Command = {
+  name: 'stackoverflow',
+  description: 'Wyszukaj swój problem na stackoverflow',
+  args: 'required',
+  async execute(msg, args) {
+    const query = encodeURIComponent(args.join(' ').toLocaleLowerCase());
+    const result = await fetch(
+      `https://api.stackexchange.com/2.3/search/advanced?pagesize=5&order=desc&sort=activity&q=${query}&site=stackoverflow`,
+    );
+    const response = (await result.json()) as ApiResponse;
+
+    if (!result.ok || isApiError(response)) {
+      return msg.channel.send('Przepraszam, ale coś poszło nie tak 😭');
+    }
+
+    const fields = response.items.map(({ title, link }) => ({
+      name: title,
+      value: link,
+    }));
+
+    if (fields.length === 0) {
+      return msg.channel.send('Niestety nic nie znalazłem 😭');
+    }
+
+    const embed = new Discord.MessageEmbed()
+      .setAuthor('Stack Overflow', ICON_URL, 'https://stackoverflow.com/')
+      .setTitle(`${fields.length} ${formatTitle(fields.length)}:`)
+      .addFields(fields)
+      .setColor('f4811e');
+
+    return msg.channel.send(embed);
+  },
+};
+
+export default stackoverflow;
+
+interface ApiOwner {
+  readonly account_id: number;
+  readonly reputation: number;
+  readonly user_id: number;
+  readonly user_type: string;
+  readonly profile_image: string;
+  readonly display_name: string;
+  readonly link: string;
+}
+
+interface ApiItem {
+  readonly tags: ReadonlyArray<string>;
+  readonly owner: ApiOwner;
+  readonly is_answered: boolean;
+  readonly view_count: number;
+  readonly answer_count: number;
+  readonly score: number;
+  readonly last_activity_date: number;
+  readonly creation_date: number;
+  readonly question_id: number;
+  readonly content_license: string;
+  readonly link: string;
+  readonly title: string;
+}
+
+interface ApiResponseSuccess {
+  readonly items: ReadonlyArray<ApiItem>;
+  readonly has_more: boolean;
+  readonly quota_max: number;
+  readonly quota_remaining: number;
+}
+
+interface ApiResponseError {
+  readonly error_id: number;
+  readonly error_message: string;
+  readonly error_name: string;
+}
+
+type ApiResponse = ApiResponseSuccess | ApiResponseError;