clisaurus.py

#!/usr/bin/python

"""
The MIT License (MIT)

Copyright (c) 2016 Steffen Karlsson

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"""

__author__ = 'Steffen Karlsson'
__version__ = '0.1-dev'
__licence__ = 'MIT'

from colorama import init, Fore
from requests import get, codes
from argparse import ArgumentParser
from json import loads
from collections import defaultdict
from urllib import quote

from bs4 import BeautifulSoup
from tabulate import tabulate

PAGE = "http://www.thesaurus.com/browse/%s?s=t"
COLORS = [Fore.RED, Fore.YELLOW, Fore.GREEN]


class NoResultException(Exception):
    pass


class MisspelledQueryException(Exception):
    def __init__(self, message):
        super(MisspelledQueryException, self).__init__(message)


def is_okay(res):
    return res.status_code == codes.ok


def search(query):
    res = get(PAGE % quote(query))
    html = res.text

    if not is_okay(res):
        bs = BeautifulSoup(html, "lxml")
        misspelled = bs.find('div', class_="misspelled")

        if misspelled is not None:
            correction_header = misspelled.find('div', class_="heading-row")
            if not correction_header:
                raise NoResultException()

            correction = str(correction_header.find('a').text).strip()
            raise MisspelledQueryException(correction)

    return html


def find_synonyms(html):
    bs = BeautifulSoup(html, "lxml")

    if bs.find('div', class_="ermsg") is not None or bs.find('li', id="words-gallery-no-results") is not None:
        raise NoResultException()

    mask = bs.find('div', class_="mask")
    synonym_groups = {}
    for tab in mask.find_all('a', class_="pos-tab"):
        synonym = tab.find('strong', class_="ttl").text
        word_type = tab.find('em', class_="txt").text
        synonym_groups["%s %s" % (word_type, synonym)] = defaultdict(list)

    relevancy_lists = bs.find_all('div', class_="relevancy-list")
    if relevancy_lists is None or not relevancy_lists or len(relevancy_lists) != len(synonym_groups):
        raise NoResultException()

    for idx, relevancy in enumerate(relevancy_lists):
        for common_word in relevancy.find_all('a'):
            category = int(loads(common_word["data-category"])["name"].split("relevant-")[1])
            synonym = common_word.find('span', class_="text").text
            synonym_groups[synonym_groups.keys()[idx]][category].append(synonym)

    return synonym_groups


def get_arguments():
    parser = ArgumentParser(description="A command line tool for thesaurus.com")
    parser.add_argument('q', help="Query to search for at thesaurus")
    args = parser.parse_args()

    if args.q is None:
        exit(1)
    return args.q


def present_synonyms(synonym_groups, query):
    table = defaultdict(list)
    for sg in sorted(synonym_groups.keys()):
        synonyms = synonym_groups[sg]
        table[sg] = [COLORS[category - 1] + word
                     for category in sorted(synonyms.keys(), reverse=True)
                     for word in sorted(synonyms[category])]
        table[sg].append(Fore.WHITE + "")

    print ">> Results from searching: %s, where the first row denotes the context of where the synonyms are used.\n" % query
    print tabulate(table, tablefmt="rst", headers="keys")


if __name__ == '__main__':
    init()
    query = get_arguments()

    try:
        html = search(query)
        synonym_groups = find_synonyms(html)
        present_synonyms(synonym_groups, query)
    except NoResultException:
        print "No matching results for query: %s" % query
    except MisspelledQueryException, e:
        print "Did you mean %s instead of %s?, otherwise no matching results." % (e.message, query)