api: Add bindings for new get_presence endpoint.

This commit is contained in:
Tim Abbott 2017-02-10 23:46:38 -08:00
parent 9a8dc2661a
commit a87ae4b1c4
3 changed files with 58 additions and 0 deletions

44
examples/get-presence Executable file
View file

@ -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=<email address> [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))

View file

@ -46,6 +46,7 @@ package_info = dict(
["examples/zuliprc", ["examples/zuliprc",
"examples/create-user", "examples/create-user",
"examples/edit-message", "examples/edit-message",
"examples/get-presence",
"examples/get-public-streams", "examples/get-public-streams",
"examples/list-members", "examples/list-members",
"examples/list-subscriptions", "examples/list-subscriptions",

View file

@ -599,6 +599,19 @@ class Client(object):
request=request, 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): def get_streams(self, **request):
# type: (**Any) -> Dict[str, Any] # type: (**Any) -> Dict[str, Any]
''' '''