utils.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# Copyright (C) 2017 J. Manrique Lopez de la Fuente
#
# 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.
#
# Authors:
#     J. Manrique Lopez <jsmanrique@bitergia.com>
#

import os

from elasticsearch import Elasticsearch, helpers
from elasticsearch_dsl import Search

from genderize import Genderize

import csv
import yaml

from tqdm import tqdm

import logging

""" Some constansts, mainly mappings that would be used to format data
"""

MAPPING_GITHUB_GIT = {
    "mappings": {
        "item": {
            "properties": {
                "date": {
                    "type": "date",
                    "format" : "E MMM d HH:mm:ss yyyy Z",
                    "locale" : "US"
                },
                "commit_id": {"type": "keyword"},
                "contributor_name": {"type": "keyword"},
                "contributor_email_domain": {"type": "keyword"},
                "file": {"type": "keyword"},
                "lines_added": {"type": "integer"},
                "lines_removed": {"type": "integer"},
                "github_owner": {"type": "keyword"},
                "github_repository": {"type": "keyword"}
            }
        }
    }
}

MAPPING_GITHUB_ISSUES = {
    "mappings": {
        "item": {
            "properties": {
                "date": {
                    "type": "date",
                    "format": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                },
                "contributor_name": {"type": "keyword"},
                "title": {"type": "string"},
                "state": {"type": "keyword"},
                "issue_type": {"type": "keyword"},
                "url": {"type": "keyword"},
                "comments": {"type": "integer"},
                "closed_at": {
                    "type": "date",
                    "format": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                },
                "time_to_solve": {"type": "integer"},
                "assignee_name": {"type": "keyword"},
                "github_owner": {"type": "keyword"},
                "github_repository": {"type": "keyword"}
            }
        }
    }
}

MAPPING_RAW = {
    "mappings": {
        "item": {
            "properties": {
                "uuid": {"type": "keyword"},
                "updated_on": {
                    "type": "date",
                    "format": "yyyy-MM-dd HH:mm:ss"
                },
                "backend_name":{"type":"keyword"},
                "tag":{"type":"keyword"},
                "category":{"type":"keyword"},
                "timestamp":{
                    "type":"date",
                    "format": "yyyy-MM-dd HH:mm:ss.SSSSSS"
                },
                "backend_version":{"type":"keyword"},
                "data":{"type":"object"},
                "origin":{"type":"keyword"},
                "perceval_version":{"type":"keyword"}
            }
        }
    }
}


def read_config_file(filename):
    """ Function to read yaml file with settings information
    """

    with open(filename) as data_file:
    	config_data = yaml.load(data_file)

    logging.info(filename + ' settings file readed and parsed')
    return config_data

def establish_connection(es_host):
    """ Function to estabilish connection with a running Elasticsearch

        Given an elasticsearch host, it returns an Elasticsearch client
    """

    es = Elasticsearch([es_host])

    if not es.ping():
        raise ValueError('Connection refused')
    else:
        logging.info('Connection established with ' + es_host)
        return es

def genderize(genderize_api_key):
    """ Function to set up Genderize
    """

    genderize_obj = Genderize(user_agent='GenderizeCommunities/0.0', \
                            api_key=genderize_api_key)
    return genderize_obj

def load_names(names_file):
    """ Function to load cached names information
    """

    names_cache = {}

    if os.path.exists(names_file):
        with open(names_file) as csvfile:
            reader = csv.DictReader(csvfile)
            for row in tqdm(reader, ascii=True, desc='Names'):
                names_cache[row['name']] = {}
                names_cache[row['name']]['gender'] = row['gender']
                names_cache[row['name']]['gender_prob'] = row['probability']
                names_cache[row['name']]['gender_count'] = row['count']
    else:
        print('Creating ' + names_file)
        with open(names_file, 'w') as outcsv:
            writer = csv.DictWriter(outcsv, fieldnames = ['name', 'gender',\
                                    'probability', 'count'])
            writer.writeheader()

    logging.info(names_file + ' names and gender file info readed and parsed')
    return names_cache

def genderize_index(es, es_index, names_file, es_index_field, genderize):
    """ Function to add gender information for a given ES index and field
    """

    names = load_names(names_file)

    query = {"query": {"match_all" :{}}}

    docs = []

    for item in tqdm(helpers.scan(es, query, scroll='300m', index=es_index), \
                    ascii=True, desc='Gender info extracted'):

        full_name = item['_source'][es_index_field]

        first_name = full_name.split(' ')[0]

        if first_name not in names.keys():
            names[first_name] = {}
            gender_info = genderize.get([first_name])
            if gender_info[0]['gender'] == None:
                names[first_name][es_index_field + '_gender'] = 'unknown'
                names[first_name][es_index_field + '_gender_prob'] = 1
                names[first_name][es_index_field + '_gender_count'] = 0
            else:
                names[first_name][es_index_field + '_gender'] = gender_info[0]['gender']
                names[first_name][es_index_field + '_gender_prob'] = gender_info[0]['probability']
                names[first_name][es_index_field + '_gender_count'] = gender_info[0]['count']
            # Let's update names file with new names gender information
            with open(names_file, 'a') as csvfile:
                writer = csv.DictWriter(csvfile, fieldnames=['name', 'gender', \
                                        'probability', 'count'])
                writer.writerow({'name': first_name, 'gender': names[first_name][es_index_field + '_gender'],\
                                'probability': names[first_name][es_index_field + '_gender_prob'],\
                                'count': names[first_name][es_index_field + '_gender_count']})
        docs.append({'_op_type': 'update', '_index': es_index, '_type': 'item',\
                    '_id':item['_id'], 'doc':names[first_name]})
    helpers.bulk(es, docs)
    logging.info('Gender info updated')

def create_ES_index(es, index_name, index_mapping):
    """ Function to create an Elasticsearch index.
        Given an ES client (es), an index name (index_name) and its mapping
        (index_mapping), it removes any index with same name and create a
        new one.
    """
    es.indices.delete(index_name, ignore=[400, 404])
    es.indices.create(index_name, body=index_mapping)
    logging.info(index_name + ' index created')

def create_KIB_index_pattern(es, index_name, time_field_name):
    """ Function to create a Kibana index pattern to visualize data
        Given an ES client (es), an index (index_name) and its time field name
        (time_field_name), it creates a Kibana index pattern to visualize
        the data.
    """
    es.index(index='.kibana', doc_type='index-pattern', id=index_name, body={'title': index_name, 'timeFieldName': time_field_name})
    logging.info(index_name + ' Kibana index pattern created')