From a87ae4b1c4401cea45e0d2729f6208271a98f708 Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Fri, 10 Feb 2017 23:46:38 -0800 Subject: [PATCH] api: Add bindings for new get_presence endpoint. --- examples/get-presence | 44 +++++++++++++++++++++++++++++++++++++++++++ setup.py | 1 + zulip/__init__.py | 13 +++++++++++++ 3 files changed, 58 insertions(+) create mode 100755 examples/get-presence diff --git a/examples/get-presence b/examples/get-presence new file mode 100755 index 0000000..d5008ff --- /dev/null +++ b/examples/get-presence @@ -0,0 +1,44 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +# Copyright © 2012-2014 Zulip, 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. + +from __future__ import print_function +import sys +from os import path +import optparse + +usage = """get-presence --email= [options] + +Get presence data for another user. +""" + +sys.path.append(path.join(path.dirname(__file__), '..')) +import zulip + +parser = optparse.OptionParser(usage=usage) +parser.add_option_group(zulip.generate_option_group(parser)) +parser.add_option('--email') +(options, args) = parser.parse_args() + +client = zulip.init_from_options(options) + +print(client.get_presence(options.email)) diff --git a/setup.py b/setup.py index 3b7a4e1..ef0a026 100755 --- a/setup.py +++ b/setup.py @@ -46,6 +46,7 @@ package_info = dict( ["examples/zuliprc", "examples/create-user", "examples/edit-message", + "examples/get-presence", "examples/get-public-streams", "examples/list-members", "examples/list-subscriptions", diff --git a/zulip/__init__.py b/zulip/__init__.py index 27d6969..8fc1684 100644 --- a/zulip/__init__.py +++ b/zulip/__init__.py @@ -599,6 +599,19 @@ class Client(object): request=request, ) + def get_presence(self, email): + # type: (Dict[str, Any]) -> Dict[str, Any] + ''' + Example usage: + + >>> client.get_presence() + {'presence': {'website': {'timestamp': 1486799122, 'status': 'active'}}, 'result': 'success', 'msg': ''} + ''' + return self.call_endpoint( + url='users/%s/presence' % (email,), + method='GET', + ) + def get_streams(self, **request): # type: (**Any) -> Dict[str, Any] '''