mirror of
https://github.com/ElvishArtisan/rivendell.git
synced 2025-05-22 15:41:41 +02:00
2021-11-08 Fred Gleason <fredg@paravelsystems.com>
* Added a 'ListGroup()' method to the 'rivwebpyapi' API. * Added a 'ListGroups()' method to the 'rivwebpyapi' API. Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
This commit is contained in:
Fred Gleason
parent
5226c7c926
commit
cd7ed74202
@ -22593,3 +22593,6 @@
|
||||
2021-11-08 Fred Gleason <fredg@paravelsystems.com>
|
||||
* Fixed a bug in the rdxport.cgi service that caused XML output
|
||||
to be encoded with the incorrect character set.
|
||||
2021-11-08 Fred Gleason <fredg@paravelsystems.com>
|
||||
* Added a 'ListGroup()' method to the 'rivwebpyapi' API.
|
||||
* Added a 'ListGroups()' method to the 'rivwebpyapi' API.
|
||||
|
||||
@ -121,6 +121,96 @@ class rivwebpyapi(object):
|
||||
self.__connection_username=username
|
||||
self.__connection_password=password
|
||||
|
||||
def ListGroup(self,group_name):
|
||||
"""
|
||||
Returns a list of Rivendell groups (dictionary).
|
||||
|
||||
Takes the following argument:
|
||||
|
||||
group_name - Return the attributes of the specified group name.
|
||||
(string)
|
||||
"""
|
||||
|
||||
#
|
||||
# Build the WebAPI arguments
|
||||
#
|
||||
postdata={
|
||||
'COMMAND': '5',
|
||||
'LOGIN_NAME': self.__connection_username,
|
||||
'PASSWORD': self.__connection_password,
|
||||
'GROUP_NAME': group_name
|
||||
}
|
||||
|
||||
#
|
||||
# Fetch the XML
|
||||
#
|
||||
r=requests.post(self.__connection_url,data=postdata)
|
||||
if(r.status_code!=requests.codes.ok):
|
||||
r.raise_for_status()
|
||||
|
||||
#
|
||||
# Generate the output dictionary
|
||||
#
|
||||
fields={
|
||||
'name': 'string',
|
||||
'description': 'string',
|
||||
'defaultCartType': 'string',
|
||||
'defaultLowCart': 'integer',
|
||||
'defaultHighCart': 'integer',
|
||||
'cutShelfLife': 'integer',
|
||||
'defaultTitle': 'string',
|
||||
'enforceCartRange': 'boolean',
|
||||
'reportTfc': 'boolean',
|
||||
'reportMus': 'boolean',
|
||||
'color': 'string'
|
||||
}
|
||||
handler=RivWebPyApi_ListHandler(base_tag='group',fields=fields)
|
||||
xml.sax.parseString(r.text,handler)
|
||||
|
||||
return handler.output()
|
||||
|
||||
def ListGroups(self):
|
||||
"""
|
||||
Returns a list of Rivendell groups (dictionary).
|
||||
"""
|
||||
|
||||
#
|
||||
# Build the WebAPI arguments
|
||||
#
|
||||
postdata={
|
||||
'COMMAND': '4',
|
||||
'LOGIN_NAME': self.__connection_username,
|
||||
'PASSWORD': self.__connection_password
|
||||
}
|
||||
|
||||
#
|
||||
# Fetch the XML
|
||||
#
|
||||
r=requests.post(self.__connection_url,data=postdata)
|
||||
if(r.status_code!=requests.codes.ok):
|
||||
r.raise_for_status()
|
||||
|
||||
#
|
||||
# Generate the output dictionary
|
||||
#
|
||||
fields={
|
||||
'name': 'string',
|
||||
'description': 'string',
|
||||
'defaultCartType': 'string',
|
||||
'defaultLowCart': 'integer',
|
||||
'defaultHighCart': 'integer',
|
||||
'cutShelfLife': 'integer',
|
||||
'defaultTitle': 'string',
|
||||
'enforceCartRange': 'boolean',
|
||||
'reportTfc': 'boolean',
|
||||
'reportMus': 'boolean',
|
||||
'color': 'string'
|
||||
}
|
||||
handler=RivWebPyApi_ListHandler(base_tag='group',fields=fields)
|
||||
xml.sax.parseString(r.text,handler)
|
||||
|
||||
return handler.output()
|
||||
|
||||
def ListLogs(self,service_name='',log_name='',trackable=False,
|
||||
filter_string='',recent=False):
|
||||
"""
|
||||
|
||||
@ -20,7 +20,9 @@
|
||||
##
|
||||
## Use automake to process this into a Makefile.in
|
||||
|
||||
EXTRA_DIST = list_logs.py\
|
||||
EXTRA_DIST = list_group.py\
|
||||
list_groups.py\
|
||||
list_logs.py\
|
||||
list_services.py
|
||||
|
||||
CLEANFILES = *~\
|
||||
|
||||
78
apis/rivwebpyapi/tests/list_group.py
Executable file
78
apis/rivwebpyapi/tests/list_group.py
Executable file
@ -0,0 +1,78 @@
|
||||
#!%PYTHON_BANGPATH%
|
||||
|
||||
# list_group.py
|
||||
#
|
||||
# rivwebpyapi test script for Rivendell
|
||||
#
|
||||
# Access the 'ListGroup' call.
|
||||
#
|
||||
# (C) Copyright 2021 Fred Gleason <fredg@paravelsystems.com>
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License version 2 as
|
||||
# published by the Free Software Foundation.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public
|
||||
# License along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
||||
#
|
||||
|
||||
import getpass
|
||||
import rivwebpyapi
|
||||
import sys
|
||||
|
||||
#
|
||||
# Get login parameters
|
||||
#
|
||||
usage='list_group --url=<rd-url> --username=<rd-username> --group-name=<name> [--password=<passwd>]'
|
||||
url='';
|
||||
username=''
|
||||
password=''
|
||||
group_name=''
|
||||
for arg in sys.argv:
|
||||
f0=arg.split('=')
|
||||
if(len(f0)==2):
|
||||
if(f0[0]=='--url'):
|
||||
url=f0[1]
|
||||
if(f0[0]=='--username'):
|
||||
username=f0[1]
|
||||
if(f0[0]=='--password'):
|
||||
password=f0[1]
|
||||
if(f0[0]=='--group-name'):
|
||||
group_name=f0[1]
|
||||
if(not group_name):
|
||||
print(usage)
|
||||
sys.exit(1)
|
||||
if(not password):
|
||||
password=getpass.getpass()
|
||||
if((not url)or(not username)):
|
||||
print(usage)
|
||||
sys.exit(1)
|
||||
|
||||
#
|
||||
# Get the group list
|
||||
#
|
||||
webapi=rivwebpyapi.rivwebpyapi(url=url,username=username,password=password)
|
||||
groups=webapi.ListGroup(group_name=group_name)
|
||||
|
||||
#
|
||||
# Display the group list
|
||||
#
|
||||
print('')
|
||||
for grp in groups:
|
||||
print('name: '+grp['name'])
|
||||
print('description: '+grp['description'])
|
||||
print('defaultCartType: '+grp['defaultCartType'])
|
||||
print('defaultLowCart: '+str(grp['defaultLowCart']))
|
||||
print('defaultHighCart: '+str(grp['defaultHighCart']))
|
||||
print('cutShelfLife: '+str(grp['cutShelfLife']))
|
||||
print('defaultTitle: '+grp['defaultTitle'])
|
||||
print('enforceCartRange: '+str(grp['enforceCartRange']))
|
||||
print('reportTfc: '+str(grp['reportTfc']))
|
||||
print('reportMus: '+str(grp['reportMus']))
|
||||
print('')
|
||||
72
apis/rivwebpyapi/tests/list_groups.py
Executable file
72
apis/rivwebpyapi/tests/list_groups.py
Executable file
@ -0,0 +1,72 @@
|
||||
#!%PYTHON_BANGPATH%
|
||||
|
||||
# list_groups.py
|
||||
#
|
||||
# rivwebpyapi test script for Rivendell
|
||||
#
|
||||
# Access the 'ListGroups' call.
|
||||
#
|
||||
# (C) Copyright 2021 Fred Gleason <fredg@paravelsystems.com>
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License version 2 as
|
||||
# published by the Free Software Foundation.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public
|
||||
# License along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
||||
#
|
||||
|
||||
import getpass
|
||||
import rivwebpyapi
|
||||
import sys
|
||||
|
||||
#
|
||||
# Get login parameters
|
||||
#
|
||||
usage='list_groups --url=<rd-url> --username=<rd-username> [--password=<passwd>]'
|
||||
url='';
|
||||
username=''
|
||||
password=''
|
||||
trackable=False
|
||||
for arg in sys.argv:
|
||||
f0=arg.split('=')
|
||||
if(len(f0)==2):
|
||||
if(f0[0]=='--url'):
|
||||
url=f0[1]
|
||||
if(f0[0]=='--username'):
|
||||
username=f0[1]
|
||||
if(f0[0]=='--password'):
|
||||
password=f0[1]
|
||||
if(not password):
|
||||
password=getpass.getpass()
|
||||
if((not url)or(not username)):
|
||||
print(usage)
|
||||
sys.exit(1)
|
||||
|
||||
#
|
||||
# Get the group list
|
||||
#
|
||||
webapi=rivwebpyapi.rivwebpyapi(url=url,username=username,password=password)
|
||||
groups=webapi.ListGroups()
|
||||
|
||||
#
|
||||
# Display the group list
|
||||
#
|
||||
for grp in groups:
|
||||
print('name: '+grp['name'])
|
||||
print('description: '+grp['description'])
|
||||
print('defaultCartType: '+grp['defaultCartType'])
|
||||
print('defaultLowCart: '+str(grp['defaultLowCart']))
|
||||
print('defaultHighCart: '+str(grp['defaultHighCart']))
|
||||
print('cutShelfLife: '+str(grp['cutShelfLife']))
|
||||
print('defaultTitle: '+grp['defaultTitle'])
|
||||
print('enforceCartRange: '+str(grp['enforceCartRange']))
|
||||
print('reportTfc: '+str(grp['reportTfc']))
|
||||
print('reportMus: '+str(grp['reportMus']))
|
||||
print('')
|
||||
Loading…
x
Reference in New Issue
Block a user