2021-12-03 Fred Gleason <fredg@paravelsystems.com>

* Added a 'ListCart()' method to the 'rivwebpyapi' API.

Signed-off-by: Fred Gleason <fredg@paravelsystems.com>

ChangeLog

@@ -22634,3 +22634,5 @@
 2021-12-03 Fred Gleason <fredg@paravelsystems.com>
 	* Modified the 'rivwebpyapi' so as to require only scheme and host
 	parts of the URL provided to the 'url' parameter.
+2021-12-03 Fred Gleason <fredg@paravelsystems.com>
+	* Added a 'ListCart()' method to the 'rivwebpyapi' API.

apis/rivwebpyapi/api/rivwebpyapi.py

@@ -206,6 +206,81 @@ class rivwebpyapi(object):
         self.__connection_username=username
         self.__connection_password=password
 
+    def ListCart(self,cart_number,include_cuts=False):
+        """
+          Returns a Rivendell cart (dictionary)
+
+          Takes the following arguments:
+
+          cart_number - The number of the desired cart, in the range
+                        0 - 999999 (integer)
+
+          include_cuts - Include cut information in the return. Default is
+                         False. (boolean)
+        """
+
+        if((cart_number<1)or(cart_number>999999)):
+            raise ValueError('invalid cart number')
+
+        #
+        # Build the WebAPI arguments
+        #
+        postdata={
+            'COMMAND': '7',
+            'LOGIN_NAME': self.__connection_username,
+            'PASSWORD': self.__connection_password,
+            'CART_NUMBER': str(cart_number),
+            'INCLUDE_CUTS': '0'
+        }
+        if(include_cuts):
+            postdata['INCLUDE_CUTS']='1'
+
+        #
+        # 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 ListCarts(self,group_name='',filter_string='',cart_type='all',
                   include_cuts=False):
         """

apis/rivwebpyapi/tests/Makefile.am

@@ -20,7 +20,8 @@
 ##
 ## Use automake to process this into a Makefile.in
 
-EXTRA_DIST = list_carts.py\
+EXTRA_DIST = list_cart.py\
+             list_carts.py\
              list_group.py\
              list_groups.py\
              list_log.py\

apis/rivwebpyapi/tests/list_cart.py

@@ -0,0 +1,96 @@
+#!%PYTHON_BANGPATH%
+
+# list_cart.py
+#
+# RivWebPyApi test script for Rivendell
+#
+#  Test the ListLogs 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
+include_cuts=False
+
+#
+# Get login parameters
+#
+usage='list_cart --url=<rd-url> --username=<rd-username> --cart-number=<num> [--password=<passwd>] [--include-cuts]'
+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)
+
+#
+# Get the cart list
+#
+webapi=rivwebpyapi.rivwebpyapi(url=url,username=username,password=password)
+carts=webapi.ListCart(cart_number=cart_number,include_cuts=include_cuts)
+
+#
+# Display the cart list
+#
+for cart in carts:
+    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('')