[Feature Request] Add tag(s) to quotes

[lukepeavey]

[Feature Request] Add tag(s) to quotes

[lukePeavey]

🚀Just deployed the latest changes, this should be live now :)

[marekdano]

Hi, @lukePeavey. I agree with your suggestions to have a new API of /tags for a list of tags and to modify existing /quotes to filter by tag name(s). I think we can have a param of tags that can have tag names separated by a comma, something like /quotes?tags=love,art or just have /quotes?tag=love for a single tag name. What do you think?

I'm open to help with APIs when tags are defined in each quote.

[lukePeavey]

I think we can have a param of tags that can have tag names separated by a comma.

I agree, the tags parameter should accept a list of one or more tags. I was thinking that it could support two types of lists: comma separated (for AND) or pipe | separated (for OR).

So a pipe separated list would match quotes that have any of the specified tags, whereas a comma separated list would match quotes with all the specified tags.

Examples

This would match quotes with tags "love" OR "friendship"

/quotes?tags=love|friendship

This would match quotes with the tags "famous-quotes" AND "technology"

/quotes?tags=famous-quotes,technology

[marekdano]

@lukePeavey, thank you for adding tags to quotes! I'll work on API now.

[marekdano]

@lukePeavey, I agree with your suggestions! I'm fully on it 😄.

[lukePeavey]

I think this would be a great feature! I will work on adding the additional metadata to the quotes, assigning one or more tags to each quote. Here is list of possible tags:

• famous-quotes
• life
• friendship
• science
• technology
• inspirational
• motivational
• literature
• art
• business
• love
• success
• religion
• social-justice

In terms of the API, i think there should be a method to get a complete list of tags (ie /tags). And then we could add a parameter to the /quotes method to filter by tag name. Let me know what you think.

[lukePeavey]

@marekdano

Sorry about the long delay. I've been really busy at work lately, so I haven't had much time to work on this.

I am still working on adding tags to all the existing quotes in the database. This is a pretty slow process, since it requires reading through the quotes and coming up with tags for each one (If anyone wants to help with this, let me know).

Anyway, I've added enough tags that we can move ahead with this feature.

[marekdano]

I like your suggestion, @lukePeavey! I can start working on it over my holidays.

[lukePeavey]

Sounds good!

[marekdano]

Is someone working on adding tags to quotes?

[lukePeavey]

@marekdano Sounds good!

Here is what we have left to do to complete this feature

• Add a tags field to the Quote schema

• Update listQuotes, getQuoteById, and randomQuote to include the tags field on quotes returned by these endpoints

• Update the relevant tests

• Add the tags parameter to randomQuote and listQuote

One possible way to implement the tags filter would be something this...

if (tags) {
  // If a `tags` parameter was provided
  if (tags.includes('|')) {
    // If `tags` is a pipe separated list (ie "art|music")...
    // match quotes that have either of the given tags
    filter.tags = { $in: tags.split('|') }
  } else {
    // If `tags` is a comma separated list or a single tag...
    // match quotes that have all of the given tags
    filter.tags = { $all: tags.split(',') }
  }
}

Let me know what you think

[nonotest]

Hi guys,

is any extra help needed for this feature?

happy to contribute.

[lukePeavey]

@nonotest

is any extra help needed for this feature?

The feature is pretty much done. There are a few documentation changes that still need to be made (see issue #25), but thats pretty much it.

[lukePeavey]

@marekdano Great contribution!