searxng/searx/engines/faroo.py

## Faroo (Web, News)
#
# @website     http://www.faroo.com
# @provide-api yes (http://www.faroo.com/hp/api/api.html), require API-key
#
# @using-api   yes
# @results     JSON
# @stable      yes
# @parse       url, title, content, publishedDate, img_src

from urllib import urlencode
from json import loads
import datetime
from searx.utils import searx_useragent

# engine dependent config
categories = ['general', 'news']
paging = True
language_support = True
number_of_results = 10
api_key = None

# search-url
url = 'http://www.faroo.com/'
search_url = url + 'api?{query}'\
                      '&start={offset}'\
                      '&length={number_of_results}'\
                      '&l={language}'\
                      '&src={categorie}'\
                      '&i=false'\
                      '&f=json'\
                      '&key={api_key}'  # noqa

search_category = {'general': 'web',
                   'news': 'news'}


# do search-request
def request(query, params):
    offset = (params['pageno'] - 1) * number_of_results + 1
    categorie = search_category.get(params['category'], 'web')

    if params['language'] == 'all':
        language = 'en'
    else:
        language = params['language'].split('_')[0]

    # if language is not supported, put it in english
    if language != 'en' and\
       language != 'de' and\
       language != 'zh':
        language = 'en'

    params['url'] = search_url.format(offset=offset,
                                      number_of_results=number_of_results,
                                      query=urlencode({'q': query}),
                                      language=language,
                                      categorie=categorie,
                                      api_key=api_key)

    # using searx User-Agent
    params['headers']['User-Agent'] = searx_useragent()

    return params


# get response from search-request
def response(resp):
    # HTTP-Code 401: api-key is not valide
    if resp.status_code == 401:
        raise Exception("API key is not valide")

    # HTTP-Code 429: rate limit exceeded
    if resp.status_code == 429:
        raise Exception("rate limit has been exceeded!")

    results = []

    search_res = loads(resp.text)

    # return empty array if there are no results
    if not search_res.get('results', {}):
        return []

    # parse results
    for result in search_res['results']:
        if result['news']:
            # timestamp (milliseconds since 1970)
            publishedDate = datetime.datetime.fromtimestamp(result['date']/1000.0)  # noqa

            # append news result
            results.append({'url': result['url'],
                            'title': result['title'],
                            'publishedDate': publishedDate,
                            'content': result['kwic']})

        else:
            # append general result
            # TODO, publishedDate correct?
            results.append({'url': result['url'],
                            'title': result['title'],
                            'content': result['kwic']})

        # append image result if image url is set
        # TODO, show results with an image like in faroo
        if result['iurl']:
            results.append({'template': 'images.html',
                            'url': result['url'],
                            'title': result['title'],
                            'content': result['kwic'],
                            'img_src': result['iurl']})

    # return results
    return results