mirror of
https://github.com/zulip/zulip.git
synced 2025-11-18 12:54:58 +00:00
Rename api.common to humbug
Fixes #482. (imported from commit 1bd6a7fd993d8d5e225e0311c288dbce0c369a40)
This commit is contained in:
Keegan McAllister
182
api/humbug.py
Normal file
182
api/humbug.py
Normal file
@@ -0,0 +1,182 @@
|
||||
#!/usr/bin/python
|
||||
# Copyright (C) 2012 Humbug, Inc.
|
||||
#
|
||||
# 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.
|
||||
|
||||
import simplejson
|
||||
import requests
|
||||
import time
|
||||
import traceback
|
||||
import urlparse
|
||||
import sys
|
||||
import os
|
||||
|
||||
# Check that we have a recent enough version
|
||||
# Older versions don't provide the 'json' attribute on responses.
|
||||
assert(requests.__version__ > '0.12')
|
||||
API_VERSTRING = "/api/v1/"
|
||||
|
||||
class HumbugAPI(object):
|
||||
def __init__(self, email, api_key=None, api_key_file=None,
|
||||
verbose=False, retry_on_errors=True,
|
||||
site="https://humbughq.com", client="API"):
|
||||
if api_key is None:
|
||||
if api_key_file is None:
|
||||
api_key_file = os.path.join(os.environ["HOME"], ".humbug-api-key")
|
||||
if not os.path.exists(api_key_file):
|
||||
raise RuntimeError("api_key not specified and %s does not exist"
|
||||
% (api_key_file,))
|
||||
with file(api_key_file, 'r') as f:
|
||||
api_key = f.read().strip()
|
||||
|
||||
self.api_key = api_key
|
||||
self.email = email
|
||||
self.verbose = verbose
|
||||
self.base_url = site
|
||||
self.retry_on_errors = retry_on_errors
|
||||
self.client_name = client
|
||||
|
||||
def do_api_query(self, orig_request, url, longpolling = False):
|
||||
request = {}
|
||||
request["email"] = self.email
|
||||
request["api-key"] = self.api_key
|
||||
request["client"] = self.client_name
|
||||
|
||||
for (key, val) in orig_request.iteritems():
|
||||
if not (isinstance(val, str) or isinstance(val, unicode)):
|
||||
request[key] = simplejson.dumps(val)
|
||||
else:
|
||||
request[key] = val
|
||||
|
||||
query_state = {
|
||||
'had_error_retry': False,
|
||||
'request': request,
|
||||
'failures': 0,
|
||||
}
|
||||
|
||||
def error_retry(error_string):
|
||||
if not self.retry_on_errors or query_state["failures"] >= 10:
|
||||
return False
|
||||
if self.verbose:
|
||||
if not query_state["had_error_retry"]:
|
||||
sys.stdout.write("humbug API(%s): connection error%s -- retrying." % \
|
||||
(url.split(API_VERSTRING, 2)[1], error_string,))
|
||||
query_state["had_error_retry"] = True
|
||||
else:
|
||||
sys.stdout.write(".")
|
||||
sys.stdout.flush()
|
||||
query_state["request"]["dont_block"] = simplejson.dumps(True)
|
||||
time.sleep(1)
|
||||
query_state["failures"] += 1
|
||||
return True
|
||||
|
||||
def end_error_retry(succeeded):
|
||||
if query_state["had_error_retry"] and self.verbose:
|
||||
if succeeded:
|
||||
print "Success!"
|
||||
else:
|
||||
print "Failed!"
|
||||
|
||||
while True:
|
||||
try:
|
||||
res = requests.post(urlparse.urljoin(self.base_url, url),
|
||||
data=query_state["request"],
|
||||
verify=True, timeout=55)
|
||||
|
||||
# On 50x errors, try again after a short sleep
|
||||
if str(res.status_code).startswith('5'):
|
||||
if error_retry(" (server %s)" % (res.status_code,)):
|
||||
continue
|
||||
# Otherwise fall through and process the python-requests error normally
|
||||
except (requests.exceptions.Timeout, requests.exceptions.SSLError) as e:
|
||||
# Timeouts are either a Timeout or an SSLError; we
|
||||
# want the later exception handlers to deal with any
|
||||
# non-timeout other SSLErrors
|
||||
if (isinstance(e, requests.exceptions.SSLError) and
|
||||
str(e) != "The read operation timed out"):
|
||||
raise
|
||||
if longpolling:
|
||||
# When longpolling, we expect the timeout to fire,
|
||||
# and the correct response is to just retry
|
||||
continue
|
||||
else:
|
||||
end_error_retry(False)
|
||||
return {'msg': "Connection error:\n%s" % traceback.format_exc(),
|
||||
"result": "connection-error"}
|
||||
except requests.exceptions.ConnectionError:
|
||||
if error_retry(""):
|
||||
continue
|
||||
end_error_retry(False)
|
||||
return {'msg': "Connection error:\n%s" % traceback.format_exc(),
|
||||
"result": "connection-error"}
|
||||
except Exception:
|
||||
# We'll split this out into more cases as we encounter new bugs.
|
||||
return {'msg': "Unexpected error:\n%s" % traceback.format_exc(),
|
||||
"result": "unexpected-error"}
|
||||
|
||||
if res.json is not None:
|
||||
end_error_retry(True)
|
||||
return res.json
|
||||
end_error_retry(False)
|
||||
return {'msg': res.text, "result": "http-error",
|
||||
"status_code": res.status_code}
|
||||
|
||||
@classmethod
|
||||
def _register(cls, name, url=None, make_request=(lambda request={}: request), **query_kwargs):
|
||||
if url is None:
|
||||
url = name
|
||||
def call(self, *args, **kwargs):
|
||||
request = make_request(*args, **kwargs)
|
||||
return self.do_api_query(request, API_VERSTRING + url, **query_kwargs)
|
||||
call.func_name = name
|
||||
setattr(cls, name, call)
|
||||
|
||||
def call_on_each_message(self, callback, options = {}):
|
||||
max_message_id = None
|
||||
while True:
|
||||
if max_message_id is not None:
|
||||
options["last"] = str(max_message_id)
|
||||
res = self.get_messages(options)
|
||||
if 'error' in res.get('result'):
|
||||
if self.verbose:
|
||||
if res["result"] == "http-error":
|
||||
print "HTTP error fetching messages -- probably a server restart"
|
||||
elif res["result"] == "connection-error":
|
||||
print "Connection error fetching messages -- probably server is temporarily down?"
|
||||
else:
|
||||
print "Server returned error:\n%s" % res["msg"]
|
||||
# TODO: Make this back off once it's more reliable
|
||||
time.sleep(1)
|
||||
continue
|
||||
for message in sorted(res['messages'], key=lambda x: int(x["id"])):
|
||||
max_message_id = max(max_message_id, int(message["id"]))
|
||||
callback(message)
|
||||
|
||||
def _mk_subs(streams):
|
||||
return {'subscriptions': streams}
|
||||
|
||||
HumbugAPI._register('send_message', make_request=(lambda request: request))
|
||||
HumbugAPI._register('get_messages', longpolling=True)
|
||||
HumbugAPI._register('get_profile')
|
||||
HumbugAPI._register('get_public_streams')
|
||||
HumbugAPI._register('list_subscriptions', url='subscriptions/list')
|
||||
HumbugAPI._register('add_subscriptions', url='subscriptions/add', make_request=_mk_subs)
|
||||
HumbugAPI._register('remove_subscriptions', url='subscriptions/remove', make_request=_mk_subs)
|
||||
Reference in New Issue
Block a user