Monsyne Dragon 7e9ce15e9c Add Mark/Limit paging for paging streams.
Add mark & limit  params for paging.
Default page size is set to 200 for reasonableness.

Change-Id: Ib7ad2d71e173cf3b961e7f10d2a9c3167f7b14ce
2015-02-12 18:06:01 +00:00

131 lines
3.9 KiB
Python

# Copyright (c) 2014 Dark Secret Software Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from quincy import jsonutil
from dateutil import parser
import common
#set this to something reasonable.
DEFAULT_LIMIT = 200
def _convert_traits(dtraits):
if dtraits is None:
return None
pairs = dtraits.split(';')
lists = [pair.split(':') for pair in pairs]
tuples = [(x[0].strip(), x[1].strip()) for x in lists]
return dict(x for x in tuples)
def _get_streams(impl, req, resp, count=False):
older_than = req.get_param('older_than')
younger_than = req.get_param('younger_than')
state = req.get_param('state')
trigger = req.get_param('trigger_name')
dtraits = req.get_param('distinguishing_traits')
traits = _convert_traits(dtraits)
mark = req.get_params('mark')
limit = req.get_params('limit')
if limit:
try:
limit = int(limit)
except (ValueError, TypeError):
limit = DEFAULT_LIMIT
else:
limit = DEFAULT_LIMIT
if older_than:
older_than = parser.parse(older_than)
if younger_than:
younger_than = parser.parse(younger_than)
return impl.get_streams(count=count,
older_than=older_than,
younger_than=younger_than,
state=state,
trigger_name=trigger,
distinguishing_traits=traits,
mark=mark, limit=limit)
def _get_stream(impl, req, resp, stream_id):
details = req.get_param('details')
return impl.get_stream(stream_id, details)
class StreamCollection(common.FalconBase):
# HTTP Operations on a stream
# GET - list stream with qualifiers
# DELETE - mark stream for deletion
# POST - move stream to READY or reset error count
# GET Qualifiers:
# older_than
# younger_than
# state
# trigger_name
# distinguishing_traits - find stream by dtrait values.
#
# Actions on a Stream:
# details - get full details on stream (including events &
# distriquishing traits)
def on_get(self, req, resp):
streams = _get_streams(self.impl, req, resp)
resp.body = jsonutil.dumps(streams)
class StreamItem(common.FalconBase):
def on_get(self, req, resp, stream_id):
# could be /streams/123 or /streams/count
stream_id = stream_id.lower()
count = stream_id == 'count'
if count:
streams = _get_streams(self.impl, req, resp, count=count)
else:
streams = _get_stream(self.impl, req, resp, stream_id)
resp.body = jsonutil.dumps(streams)
def on_delete(self, req, resp, stream_id):
self.impl.delete_stream(stream_id)
def on_put(self, req, resp, stream_id):
self.impl.reset_stream(stream_id)
class Schema(object):
def _v(self):
return "/v%d" % self.version
def __init__(self, version, api, impl):
self.api = api
self.impl = impl
self.version = version
self.stream_collection = StreamCollection(impl)
self.stream_item = StreamItem(impl)
# Can't have a /streams/{item} route *and* a
# /streams/foo route. Have to overload the StreamItem
# handler.
self.api.add_route('%s/streams/{stream_id}' % self._v(),
self.stream_item)
self.api.add_route('%s/streams' % self._v(), self.stream_collection)