first commit

Author: 34fame

README.md

@@ -0,0 +1,36 @@
+This was a fun exercise, learning to create a CLI app using Node.js. This "package" could be published and installed by others as a global package. This makes it usable by anyone, on any platform, running Node.js (unlike a bash or PowerShell script).
+
+Using the `commander` and `inquirer` packages provides a simple way to create responses and collect input.
+
+If installed as a global package this is an example of what you get when running the `qotd` command. This is an automatically generated help screen.
+
+```sh
+> qotd
+
+Usage: qotd [options] [command]
+
+Options:
+  -h, --help      display help for command
+
+Commands:
+  list|ls         List qotd options
+  quick|q         Return a random quote
+  author|a        Choose an author and get a quote
+  help [command]  display help for command
+```
+
+If you use the `author` option you get a list to choose from:
+
+```sh
+> qotd a
+
+Author Quote
+----------------
+? Choose an author
+  Buddha
+  Mark Twain
+❯ Yogi Berra
+  William Shakespeare
+```
+
+The app is pulling from a free API of 1,600+ famous quotes. Like I said, a fun little exercise!

bin/index.js

@@ -0,0 +1,42 @@
+#!/usr/bin/env node
+const program = require('commander')
+
+const colors = require('colors')
+const qotd = require('../lib/qotd')
+const list = require('../lib/list')
+const author = require('../lib/author')
+
+/**
+ * List QOTD options
+ */
+program
+   .command('list')
+   .alias('ls')
+   .description('List qotd options')
+   .action(function () {
+      list()
+   })
+
+/**
+ * Return a random quote
+ */
+program
+   .command('quick')
+   .alias('q')
+   .description('Return a random quote')
+   .action(function () {
+      qotd()
+   })
+
+/**
+ * Return a quote by specific author
+ */
+program
+   .command('author')
+   .alias('a')
+   .description('Choose an author and get a quote')
+   .action(function () {
+      author()
+   })
+
+program.parse(process.argv)

lib/author.js

@@ -0,0 +1,20 @@
+const inquirer = require('inquirer')
+const colors = require('colors')
+const pad = require('pad')
+const quotes = require('./quotes')
+const values = require('./values')
+
+const questions = [{ type: 'list', name: 'author', message: 'Choose an author', choices: values.authors }]
+
+module.exports = function () {
+   console.log('Author Quote')
+   console.log('----------------')
+
+   inquirer.prompt(questions).then(function (answers) {
+      quotes.author(answers.author).then((msg) => {
+         console.log(colors.bold(msg.text))
+         console.log(colors.grey('/ ' + msg.author))
+         console.log('')
+      })
+   })
+}

lib/list.js

@@ -0,0 +1,12 @@
+const colors = require('colors')
+const { options } = require('./values')
+
+module.exports = function () {
+   console.log('QOTD OPTIONS')
+   console.log('----------------')
+
+   options.map((o) => {
+      console.log('%s %s', colors.bold(o.name), colors.grey('/ ' + o.descr))
+      console.log('')
+   })
+}

lib/qotd.js

@@ -0,0 +1,13 @@
+const colors = require('colors')
+const quotes = require('./quotes')
+
+module.exports = function () {
+   console.log('Random Quote')
+   console.log('----------------')
+
+   quotes.random().then((msg) => {
+      console.log(colors.bold(msg.text))
+      console.log(colors.grey('/ ' + msg.author ? msg.author : 'Unknown'))
+      console.log('')
+   })
+}

lib/quotes.js

@@ -0,0 +1,58 @@
+const axios = require('axios')
+
+const BASEURL = 'https://type.fit/api/quotes'
+
+async function getQuotes() {
+   return axios.get(BASEURL).then((result) => {
+      return result.data
+   })
+}
+
+async function picker(author) {
+   let quotes = await getQuotes()
+   if (author) {
+      quotes = quotes.filter((q) => q.author === author)
+   }
+   return quotes[Math.floor(Math.random() * quotes.length)]
+}
+
+const aggregate = async () => {
+   const quotes = await getQuotes()
+   let counts = {}
+   quotes.map((q) => {
+      if (!q.author) return false
+      if (counts[q.author]) {
+         counts[q.author] += 1
+      } else {
+         counts[q.author] = 1
+      }
+   })
+   let popular = {}
+   Object.keys(counts).map((key) => {
+      if (!popular.author) {
+         popular = {
+            author: key,
+            count: counts[key],
+         }
+      }
+      if (counts[key] > popular.count) {
+         popular = {
+            author: key,
+            count: counts[key],
+         }
+      }
+   })
+   return popular
+}
+
+exports.random = async function () {
+   return picker()
+}
+
+exports.popular = async function () {
+   return aggregate()
+}
+
+exports.author = async function (author) {
+   return picker(author)
+}

lib/values.js

@@ -0,0 +1,8 @@
+exports.options = [
+   { name: 'help', descr: 'Show how to use QOTD' },
+   { name: 'quick', descr: 'Return a random quote' },
+   { name: 'author', descr: 'Return a quote from specific author' },
+   { name: 'popular', descr: 'Show the most popular author' },
+]
+
+exports.authors = ['Buddha', 'Mark Twain', 'Yogi Berra', 'William Shakespeare']