vim-rana-local/plugin/packages/wakatime/wakatime/__init__.py

194 lines
5.8 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
"""
wakatime
~~~~~~~~
2013-07-20 22:25:11 +00:00
Action event appender for Wakati.Me, auto time tracking for text editors.
:copyright: (c) 2013 Alan Hamlett.
:license: BSD, see LICENSE for more details.
"""
from __future__ import print_function
__title__ = 'wakatime'
2013-09-05 06:27:58 +00:00
__version__ = '0.4.3'
__author__ = 'Alan Hamlett'
__license__ = 'BSD'
__copyright__ = 'Copyright 2013 Alan Hamlett'
import base64
import json
import logging
import os
import platform
import re
import sys
import time
import traceback
2013-08-12 10:32:04 +00:00
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
from .log import setup_logging
from .project import find_project
2013-08-12 10:32:04 +00:00
from .packages import requests
try:
import argparse
except ImportError:
from .packages import argparse
log = logging.getLogger(__name__)
class FileAction(argparse.Action):
def __call__(self, parser, namespace, values, option_string=None):
values = os.path.realpath(values)
setattr(namespace, self.dest, values)
2013-07-20 22:25:11 +00:00
def parseArguments(argv):
2013-08-12 10:32:04 +00:00
try:
sys.argv
except AttributeError:
sys.argv = argv
parser = argparse.ArgumentParser(
description='Wakati.Me event api appender')
parser.add_argument('--file', dest='targetFile', metavar='file',
action=FileAction, required=True,
help='absolute path to file for current action')
parser.add_argument('--time', dest='timestamp', metavar='time',
type=float,
help='optional floating-point unix epoch timestamp; '+
'uses current time by default')
parser.add_argument('--endtime', dest='endtime',
help='optional end timestamp turning this action into '+
'a duration; if a non-duration action occurs within a '+
'duration, the duration is ignored')
parser.add_argument('--write', dest='isWrite',
action='store_true',
help='note action was triggered from writing to a file')
parser.add_argument('--plugin', dest='plugin',
help='optional text editor plugin name and version '+
'for User-Agent header')
parser.add_argument('--key', dest='key',
help='your wakati.me api key; uses api_key from '+
'~/.wakatime.conf by default')
parser.add_argument('--logfile', dest='logfile',
help='defaults to ~/.wakatime.log')
parser.add_argument('--config', dest='config',
help='defaults to ~/.wakatime.conf')
parser.add_argument('--verbose', dest='verbose', action='store_true',
help='turns on debug messages in log file')
parser.add_argument('--version', action='version', version=__version__)
2013-07-20 22:25:11 +00:00
args = parser.parse_args(args=argv[1:])
if not args.timestamp:
args.timestamp = time.time()
if not args.key:
default_key = get_api_key(args.config)
if default_key:
args.key = default_key
else:
parser.error('Missing api key')
return args
def get_api_key(configFile):
if not configFile:
2013-07-21 17:46:03 +00:00
configFile = os.path.join(os.path.expanduser('~'), '.wakatime.conf')
api_key = None
try:
2013-07-21 17:46:03 +00:00
cf = open(configFile)
for line in cf:
line = line.split('=', 1)
if line[0] == 'api_key':
api_key = line[1].strip()
cf.close()
except IOError:
print('Error: Could not read from config file.')
return api_key
def get_user_agent(plugin):
2013-07-24 03:32:19 +00:00
ver = sys.version_info
2013-07-31 00:20:44 +00:00
python_version = '%d.%d.%d.%s.%d' % (ver[0], ver[1], ver[2], ver[3], ver[4])
2013-07-24 00:53:26 +00:00
user_agent = 'wakatime/%s (%s) Python%s' % (__version__,
platform.platform(), python_version)
if plugin:
user_agent = user_agent+' '+plugin
return user_agent
2013-08-15 07:12:23 +00:00
def send_action(project=None, branch=None, key=None, targetFile=None,
timestamp=None, endtime=None, isWrite=None, plugin=None, **kwargs):
url = 'https://www.wakati.me/api/v1/actions'
log.debug('Sending action to api at %s' % url)
data = {
'time': timestamp,
'file': targetFile,
}
if endtime:
data['endtime'] = endtime
if isWrite:
data['is_write'] = isWrite
if project:
data['project'] = project
2013-08-15 07:12:23 +00:00
if branch:
data['branch'] = branch
log.debug(data)
2013-08-12 10:32:04 +00:00
# setup api request headers
auth = 'Basic %s' % bytes.decode(base64.b64encode(str.encode(key)))
2013-08-12 10:32:04 +00:00
headers = {
'User-Agent': get_user_agent(plugin),
'Content-Type': 'application/json',
'Authorization': auth,
}
2013-09-05 06:27:58 +00:00
# json request content
content = json.dumps(data).encode('utf-8')
2013-08-12 10:32:04 +00:00
# send action to api
try:
2013-09-05 06:27:58 +00:00
response = requests.post(url, data=content, headers=headers)
2013-08-12 10:32:04 +00:00
except requests.exceptions.RequestException as exc:
exception_data = {
sys.exc_info()[0].__name__: str(sys.exc_info()[1]),
}
if log.isEnabledFor(logging.DEBUG):
2013-08-12 10:32:04 +00:00
exception_data['traceback'] = traceback.format_exc()
log.error(exception_data)
else:
2013-08-12 10:32:04 +00:00
if response.status_code == requests.codes.created:
log.debug({
2013-08-12 10:32:04 +00:00
'response_code': response.status_code,
})
return True
log.error({
2013-08-12 10:32:04 +00:00
'response_code': response.status_code,
'response_content': response.text,
})
return False
2013-07-20 22:25:11 +00:00
def main(argv=None):
if not argv:
argv = sys.argv
args = parseArguments(argv)
setup_logging(args, __version__)
if os.path.isfile(args.targetFile):
2013-08-15 07:12:23 +00:00
branch = None
2013-07-21 17:46:03 +00:00
name = None
project = find_project(args.targetFile)
2013-07-21 17:46:03 +00:00
if project:
2013-08-15 07:12:23 +00:00
branch = project.branch()
2013-07-21 17:46:03 +00:00
name = project.name()
2013-08-15 07:12:23 +00:00
if send_action(project=name, branch=branch, **vars(args)):
return 0
return 102
else:
log.debug('File does not exist; ignoring this action.')
return 101