mirror of
https://github.com/ElvishArtisan/rivendell.git
synced 2025-10-11 09:03:40 +02:00
2021-12-06 Fred Gleason <fredg@paravelsystems.com>
* Added an 'AddCart()' method to the 'rivwebpyapi' API. Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
This commit is contained in:
@@ -22664,3 +22664,5 @@
|
||||
* Added an 'AddCut()' method to the 'rivwebpyapi' API.
|
||||
2021-12-06 Fred Gleason <fredg@paravelsystems.com>
|
||||
* Added a 'RemoveCut()' method to the 'rivwebpyapi' API.
|
||||
2021-12-06 Fred Gleason <fredg@paravelsystems.com>
|
||||
* Added an 'AddCart()' method to the 'rivwebpyapi' API.
|
||||
|
@@ -211,6 +211,89 @@ class rivwebpyapi(object):
|
||||
self.__connection_username=username
|
||||
self.__connection_password=password
|
||||
|
||||
def AddCart(self,group_name,cart_type,cart_number=0):
|
||||
"""
|
||||
Add a new cart to the cart library. Returns the metadata of
|
||||
the newly created cart (list of dictionaries).
|
||||
|
||||
Takes the following arguments:
|
||||
|
||||
group_name - The name of the group to which the created cart
|
||||
will belong (string).
|
||||
|
||||
cart_type - The type of cart to be created. Valid values are
|
||||
'audio' and 'macro' (string).
|
||||
|
||||
cart_number - The number of the desired cart, in the range
|
||||
1 - 999999. Optional. If no cart number
|
||||
is specified, the next available cart number for
|
||||
the specified group will be used (integer).
|
||||
"""
|
||||
|
||||
if((cart_number<0)or(cart_number>999999)):
|
||||
raise ValueError('invalid cart number')
|
||||
if((cart_type!='audio')and(cart_type!='macro')):
|
||||
raise ValueError('invalid cart type')
|
||||
|
||||
#
|
||||
# Build the WebAPI arguments
|
||||
#
|
||||
postdata={
|
||||
'COMMAND': '12',
|
||||
'LOGIN_NAME': self.__connection_username,
|
||||
'PASSWORD': self.__connection_password,
|
||||
'GROUP_NAME': str(group_name),
|
||||
'TYPE': str(cart_type)
|
||||
}
|
||||
if(cart_number>0):
|
||||
postdata['CART_NUMBER']=str(cart_number)
|
||||
print('ARGS: '+str(postdata))
|
||||
#
|
||||
# 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={
|
||||
'number': 'integer',
|
||||
'type': 'string',
|
||||
'groupName': 'string',
|
||||
'title': 'string',
|
||||
'artist': 'string',
|
||||
'album': 'string',
|
||||
'year': 'integer',
|
||||
'label': 'string',
|
||||
'client': 'string',
|
||||
'agency': 'string',
|
||||
'publisher': 'string',
|
||||
'composer': 'string',
|
||||
'conductor': 'string',
|
||||
'userDefined': 'string',
|
||||
'usageCode': 'integer',
|
||||
'forcedLength': 'string',
|
||||
'averageLength': 'string',
|
||||
'lengthDeviation': 'string',
|
||||
'averageSegueLength': 'string',
|
||||
'averageHookLength': 'string',
|
||||
'minimumTalkLength': 'string',
|
||||
'maximumTalkLength': 'string',
|
||||
'cutQuantity': 'integer',
|
||||
'lastCutPlayed': 'integer',
|
||||
'enforceLength': 'boolean',
|
||||
'asyncronous': 'boolean',
|
||||
'owner': 'string',
|
||||
'metadataDatetime': 'datetime',
|
||||
'songId': 'string'
|
||||
}
|
||||
handler=RivWebPyApi_ListHandler(base_tag='cart',fields=fields)
|
||||
xml.sax.parseString(r.text,handler)
|
||||
|
||||
return handler.output()
|
||||
|
||||
def AddCut(self,cart_number):
|
||||
"""
|
||||
Add a new cut to an existing audio cart. Returns the metadata of
|
||||
|
@@ -20,7 +20,8 @@
|
||||
##
|
||||
## Use automake to process this into a Makefile.in
|
||||
|
||||
EXTRA_DIST = add_cut.py\
|
||||
EXTRA_DIST = add_cart.py\
|
||||
add_cut.py\
|
||||
list_cart.py\
|
||||
list_cart_sched_codes.py\
|
||||
list_carts.py\
|
||||
|
102
apis/rivwebpyapi/tests/add_cart.py
Executable file
102
apis/rivwebpyapi/tests/add_cart.py
Executable file
@@ -0,0 +1,102 @@
|
||||
#!%PYTHON_BANGPATH%
|
||||
|
||||
# add_cart.py
|
||||
#
|
||||
# RivWebPyApi test script for Rivendell
|
||||
#
|
||||
# Test the AddCart Web API 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
|
||||
|
||||
url='';
|
||||
username=''
|
||||
password=''
|
||||
cart_number=0
|
||||
cart_type='audio'
|
||||
group_name=''
|
||||
|
||||
#
|
||||
# Get login parameters
|
||||
#
|
||||
usage='add_cart --url=<rd-url> --username=<rd-username> --group-name=<str> --cart-type=audio|macro [--cart-number=<num>] [--password=<passwd>]'
|
||||
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(f0[0]=='--cart-type'):
|
||||
cart_type=f0[1]
|
||||
if(f0[0]=='--cart-number'):
|
||||
cart_number=int(f0[1])
|
||||
|
||||
if(not password):
|
||||
password=getpass.getpass()
|
||||
if((not url)or(not username)):
|
||||
print(usage)
|
||||
sys.exit(1)
|
||||
|
||||
#
|
||||
# Get the cut list
|
||||
#
|
||||
webapi=rivwebpyapi.rivwebpyapi(url=url,username=username,password=password)
|
||||
carts=webapi.AddCart(group_name=group_name,cart_type=cart_type,cart_number=cart_number)
|
||||
|
||||
#
|
||||
# Display the cart list
|
||||
#
|
||||
for cart in carts:
|
||||
print('ADDED')
|
||||
print('number: '+str(cart['number']))
|
||||
print('type: '+str(cart['type']))
|
||||
print('groupName: '+str(cart['groupName']))
|
||||
print('title: '+str(cart['title']))
|
||||
print('artist: '+str(cart['artist']))
|
||||
print('album: '+str(cart['album']))
|
||||
print('year: '+str(cart['year']))
|
||||
print('label: '+str(cart['label']))
|
||||
print('client: '+str(cart['client']))
|
||||
print('agency: '+str(cart['agency']))
|
||||
print('publisher: '+str(cart['publisher']))
|
||||
print('composer: '+str(cart['composer']))
|
||||
print('conductor: '+str(cart['conductor']))
|
||||
print('userDefined: '+str(cart['userDefined']))
|
||||
print('usageCode: '+str(cart['usageCode']))
|
||||
print('forcedLength: '+str(cart['forcedLength']))
|
||||
print('averageLength: '+str(cart['averageLength']))
|
||||
print('lengthDeviation: '+str(cart['lengthDeviation']))
|
||||
print('averageSegueLength: '+str(cart['averageSegueLength']))
|
||||
print('averageHookLength: '+str(cart['averageHookLength']))
|
||||
print('minimumTalkLength: '+str(cart['minimumTalkLength']))
|
||||
print('maximumTalkLength: '+str(cart['maximumTalkLength']))
|
||||
print('cutQuantity: '+str(cart['cutQuantity']))
|
||||
print('lastCutPlayed: '+str(cart['lastCutPlayed']))
|
||||
print('enforceLength: '+str(cart['enforceLength']))
|
||||
print('asyncronous: '+str(cart['asyncronous']))
|
||||
print('owner: '+str(cart['owner']))
|
||||
print('metadataDatetime: '+str(cart['metadataDatetime']))
|
||||
print('songId: '+str(cart['songId']))
|
||||
print('')
|
Reference in New Issue
Block a user