Test for Smokeball
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Loopcruitment 50c4f306fb add hint to define TResult type 3 years ago
src add hint to define TResult type 3 years ago
.gitignore convert to typescript 3 years ago
LICENSE Initial commit 5 years ago
README.md add hint to define TResult type 3 years ago
jest.config.ts shift jest config to typescript 3 years ago
package-lock.json shift jest config to typescript 3 years ago
package.json shift jest config to typescript 3 years ago
tsconfig.json convert to typescript 3 years ago

README.md

Smokeball TypeScript Coding Challenge

System Requirements

The coding challenge requires the following to be installed on your development machine;

Installation

  1. Fork the ts-test repository to your personal github account.
  2. Clone the ts-test repository from your personal github account onto your development machine.
  3. Open a terminal and cd into the root directory of the ts-test repository.
  4. Execute npm install in the terminal.

Challenge Instructions

Your challenge is to implement the getArnieQuotes() function, which is exported from ./src/get-arnie-quotes.ts.

The getArnieQuotes() function accepts an array of strings, with each string containing a URL.

The unit tests in ./src/get-arnie-quotes.spec.ts will provide pre-defined URLs to the function and test your function's implementation. To run the unit tests, execute npm test in the terminal.

The goal is to write an implementation of getArnieQuotes() that meets all requirements and passes all unit tests.

Requirements

getArnieQuotes() must perform the following on every passed in URL

  1. Execute a HTTP GET
  2. If the HTTP status code of the response is 200, push an object to the results array with a single key "Arnie Quote" and the HTTP response body's message property as the key's associated value.
  3. If the HTTP status code of the response is not 200, push an object to the results array with a single key "FAILURE" and the HTTP response body's message property as the key's associated value.

Finally, the getArnieQuotes() function's return value must be a promise that resolves to the overall results array.

Note that for this challenge, the HTTP calls are mocked. You must use the provided httpGet function to perform your HTTP requests.

Tips

  • Only modify the get-arnie-quotes.ts file.
  • Properly define the TResult type.
  • You may introduce additional internal functions in get-arnie-quotes.ts
  • Exploring all of the code files may provide you with useful hints.
  • Not all of the requirements are covered by the unit tests.
  • We are most impressed with readable code that works.
  • Keep your solution as simple as possible, input validation for get-arnie-quotes() is not required.
  • Other solutions to this puzzle are available on github and can be used to give you ideas, however, not all forked solutions are correct.
  • Direct plagiarism results in an immediate failure.

Submission

Once all unit tests pass, push your code upstream then send us the link to your github repo with your solution. Please do not create a pull request against the source repository.

Docs

getArnieQuotes(urls)

Executes a HTTP GET request on each of the URLs, transforms each of the HTTP responses according to the challenge instructions and returns the results.

@param {string[]} urls The urls to be requested
@return {Promise} A promise which resolves to a results array. 

An example results array:

[
  { 'Arnie Quote': 'Some cool quote' },
  { 'FAILURE': 'Your request has been terminated' },
]

httpGet(url)

Executes a faked HTTP GET request on the passed URL.

@param {string} url The url upon which to perform a HTTP GET
@return {Promise} A promise which resolves to a HTTP response. 

An example HTTP response:

{
  status: 200,
  body: "{ 'message': 'Some cool arnie quote' }" // JSON string
}