From 6acb8a62a0f33e672826ebd50cc601ef5da71779 Mon Sep 17 00:00:00 2001 From: Fred Gleason Date: Mon, 6 Dec 2021 15:31:43 -0500 Subject: [PATCH] 2021-12-06 Fred Gleason * Added a 'RemoveCart()' method to the 'rivwebpyapi' API. Signed-off-by: Fred Gleason --- ChangeLog | 2 + apis/rivwebpyapi/api/rivwebpyapi.py | 39 +++++++++++++++++ apis/rivwebpyapi/tests/Makefile.am | 1 + apis/rivwebpyapi/tests/remove_cart.py | 60 +++++++++++++++++++++++++++ 4 files changed, 102 insertions(+) create mode 100755 apis/rivwebpyapi/tests/remove_cart.py diff --git a/ChangeLog b/ChangeLog index 1758fb9e..6a5bfa3b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -22666,3 +22666,5 @@ * Added a 'RemoveCut()' method to the 'rivwebpyapi' API. 2021-12-06 Fred Gleason * Added an 'AddCart()' method to the 'rivwebpyapi' API. +2021-12-06 Fred Gleason + * Added a 'RemoveCart()' method to the 'rivwebpyapi' API. diff --git a/apis/rivwebpyapi/api/rivwebpyapi.py b/apis/rivwebpyapi/api/rivwebpyapi.py index 4ec815eb..4b562a00 100755 --- a/apis/rivwebpyapi/api/rivwebpyapi.py +++ b/apis/rivwebpyapi/api/rivwebpyapi.py @@ -1162,6 +1162,45 @@ class rivwebpyapi(object): return handler.output() + def RemoveCart(self,cart_number): + """ + Remove a cart from the cart library. + + Takes the following argument: + + cart_number - The number of the desired cart, in the range + 1 - 999999 (integer) + """ + + if((cart_number<1)or(cart_number>999999)): + raise ValueError('invalid cart number') + + # + # Build the WebAPI arguments + # + postdata={ + 'COMMAND': '13', + 'LOGIN_NAME': self.__connection_username, + 'PASSWORD': self.__connection_password, + 'CART_NUMBER': str(cart_number) + } + + # + # 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={ + 'ResponseCode': 'integer', + 'ErrorString': 'string' + } + handler=RivWebPyApi_ListHandler(base_tag='RDWebResult',fields=fields) + def RemoveCut(self,cart_number,cut_number): """ Remove an existing cut from an audio cart. diff --git a/apis/rivwebpyapi/tests/Makefile.am b/apis/rivwebpyapi/tests/Makefile.am index fc0ee792..9a93f17e 100644 --- a/apis/rivwebpyapi/tests/Makefile.am +++ b/apis/rivwebpyapi/tests/Makefile.am @@ -34,6 +34,7 @@ EXTRA_DIST = add_cart.py\ list_scheduler_codes.py\ list_services.py\ list_system_settings.py\ + remove_cart.py\ remove_cut.py CLEANFILES = *~\ diff --git a/apis/rivwebpyapi/tests/remove_cart.py b/apis/rivwebpyapi/tests/remove_cart.py new file mode 100755 index 00000000..c20e770a --- /dev/null +++ b/apis/rivwebpyapi/tests/remove_cart.py @@ -0,0 +1,60 @@ +#!%PYTHON_BANGPATH% + +# remove_cart.py +# +# RivWebPyApi test script for Rivendell +# +# Test the RemoveCart Web API call +# +# (C) Copyright 2021 Fred Gleason +# +# 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 + +# +# Get login parameters +# +usage='remove_cut --url= --username= --cart-number= [--password=]' +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]=='--cart-number'): + cart_number=int(f0[1]) + +if(not password): + password=getpass.getpass() +if((not url)or(not username)): + print(usage) + sys.exit(1) + +# +# Execute +# +webapi=rivwebpyapi.rivwebpyapi(url=url,username=username,password=password) +webapi.RemoveCart(cart_number=cart_number)