diff --git a/ChangeLog b/ChangeLog index e3c50d2b..ff07d371 100644 --- a/ChangeLog +++ b/ChangeLog @@ -22670,3 +22670,5 @@ * Added a 'RemoveCart()' method to the 'rivwebpyapi' API. 2021-12-06 Fred Gleason * Added an 'AddLog()' method to the 'rivwebpyapi' API. +2021-12-06 Fred Gleason + * Added an 'DeleteLog()' method to the 'rivwebpyapi' API. diff --git a/apis/rivwebpyapi/api/rivwebpyapi.py b/apis/rivwebpyapi/api/rivwebpyapi.py index 2dad196a..b8509d09 100755 --- a/apis/rivwebpyapi/api/rivwebpyapi.py +++ b/apis/rivwebpyapi/api/rivwebpyapi.py @@ -416,6 +416,35 @@ class rivwebpyapi(object): if(r.status_code!=requests.codes.ok): r.raise_for_status() + def DeleteLog(self,log_name): + """ + Delete an existing log. + + Takes the following argument: + + log_name - The name of the log to be deleted (string). + """ + + if(not log_name): + raise ValueError('invalid log name') + + # + # Build the WebAPI arguments + # + postdata={ + 'COMMAND': '30', + 'LOGIN_NAME': self.__connection_username, + 'PASSWORD': self.__connection_password, + 'LOG_NAME': log_name + } + + # + # Fetch the XML + # + r=requests.post(self.__connection_url,data=postdata) + if(r.status_code!=requests.codes.ok): + r.raise_for_status() + def ListCart(self,cart_number,include_cuts=False): """ Returns the metadata associated with a Rivendell cart diff --git a/apis/rivwebpyapi/tests/Makefile.am b/apis/rivwebpyapi/tests/Makefile.am index 756629a5..1a510887 100644 --- a/apis/rivwebpyapi/tests/Makefile.am +++ b/apis/rivwebpyapi/tests/Makefile.am @@ -23,6 +23,7 @@ EXTRA_DIST = add_cart.py\ add_cut.py\ add_log.py\ + delete_log.py\ list_cart.py\ list_cart_sched_codes.py\ list_carts.py\ diff --git a/apis/rivwebpyapi/tests/delete_log.py b/apis/rivwebpyapi/tests/delete_log.py new file mode 100755 index 00000000..f12405c4 --- /dev/null +++ b/apis/rivwebpyapi/tests/delete_log.py @@ -0,0 +1,60 @@ +#!%PYTHON_BANGPATH% + +# delete_log.py +# +# RivWebPyApi test script for Rivendell +# +# Test the DeleteLog 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='' +lot_name='' + +# +# Get login parameters +# +usage='delete_log --url= --username= --log-name= [--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]=='--log-name'): + log_name=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.DeleteLog(log_name=log_name)