Merge pull request #83 from ArkhamCookie/69-top-example-api

topExample API coverage

docs/coverage.md

@@ -18,7 +18,7 @@
 | [`/{word}/pronunciations`](https://developer.wordnik.com/docs#!/word/getTextPronunciations) | Returns text pronunciations for a given word | [ ] |
 | [`/{word}/relatedWords`](https://developer.wordnik.com/docs#!/word/getRelatedWords) | Given a word as a string, returns relationships from the Word Graph | [ ] |
 | [`/{word}/scrabbleScore`](https://developer.wordnik.com/docs#!/word/getScrabbleScore) | Returns the Scrabble score for a word | [x] |
-| [`/{word}/topExample`](https://developer.wordnik.com/docs#!/word/getTopExample) | Returns a top example for a word | [ ] |
+| [`/{word}/topExample`](https://developer.wordnik.com/docs#!/word/getTopExample) | Returns a top example for a word | [x] |
 
 ### [`/words.json`](https://developer.wordnik.com/docs#/words)
 

lib/tests/topExample-test.js

@@ -0,0 +1,22 @@
+#!/usr/bin/env -S deno test --allow-read --allow-env --allow-net
+
+import { assertEquals, assertExists } from 'assert'
+
+import { topExample } from '../mod.js'
+
+Deno.test({
+	name: 'word/topExample',
+	permissions:  { read: true, env: true, net: true },
+	async fn() {
+		const testWord = 'cookie'
+
+		const response = await topExample(testWord)
+		assertExists(response)
+
+		assertEquals(response.word, testWord)
+
+		// This might have to be updated if the top example changes
+		const expectedResponse = 'I noticed there\'s a small cookie, nice? ya all for $7.90 but excluding serbice charge la. de tea/coffee comes with a kan small cookie~'
+		assertEquals(response.text, expectedResponse)
+	}
+})

lib/word/mod.js

@@ -6,3 +6,4 @@
 
 export * from './scrabbleScore.js'
 export * from './examples.js'
+export * from './topExample.js'

lib/word/topExample.js

@@ -0,0 +1,32 @@
+import { Wordnik } from '../mod.js'
+
+/**
+ * Top Example
+ * @param {string} word - word to fetch examples for
+ * @param {boolean} useCanonical - If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.
+ * @returns {JSON} response
+ */
+
+export async function topExample(word, useCanonical) {
+	if (!word) { console.error('A word is required') }
+	const wordnik = new Wordnik('word.json/' + word + '/topExample')
+	let endpoint =
+		wordnik.base + wordnik.version + wordnik.target
+
+	if (useCanonical === true) {
+		endpoint = endpoint + 'useCanonical=true'
+	}
+
+	endpoint = endpoint + '&' + wordnik.key
+
+	const response = await fetch(endpoint)
+
+	console.debug(endpoint)
+
+	if (response.status !== 200) {
+		console.error('Error! Status: ' + response.statusText)
+		return
+	}
+
+	return await response.json()
+}