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

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

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

ChangeLog

@@ -22719,3 +22719,5 @@
 	* Added a 'TrimAudio()' method to the 'rivwebpyapi' API.
 2021-12-09 Fred Gleason <fredg@paravelsystems.com>
 	* Added a 'SavePodcast()' method to the 'rivwebpyapi' API.
+2021-12-09 Fred Gleason <fredg@paravelsystems.com>
+	* Added a 'GetPodcast()' method to the 'rivwebpyapi' API.

apis/rivwebpyapi/api/rivwebpyapi.py

@@ -766,6 +766,40 @@ class rivwebpyapi(object):
             ret=ret+block
         return ret
 
+    def GetPodcast(self,cast_id,filename):
+        """
+          Get posted podcast audio from the Rivendell audio store.
+
+          Takes the following arguments:
+
+          cast_id - ID of the owning podcast item (integer).
+
+          filename - Destination filename (string).
+        """
+
+        if(cast_id<0):
+            raise ValueError('invalid podcast ID')
+
+        #
+        # Build the WebAPI arguments
+        #
+        postdata={
+            'COMMAND': '37',
+            'LOGIN_NAME': self.__connection_username,
+            'PASSWORD': self.__connection_password,
+            'ID': str(cast_id)
+        }
+
+        #
+        # Fetch the audio data
+        #
+        r=requests.post(self.__connection_url,data=postdata,stream=True)
+        if(r.status_code!=requests.codes.ok):
+            self.__throwError(response=r)
+        with open(filename,'wb') as handle:
+            for block in r.iter_content(1024):
+                handle.write(block)
+
     def Import(self,filename,use_metadata,cart_number=0,cut_number=0,
                channels=2,normalization_level=0,autotrim_level=0,
                group_name='',title=''):

apis/rivwebpyapi/tests/Makefile.am

@@ -30,6 +30,7 @@ EXTRA_DIST = add_cart.py\
              delete_log.py\
              export.py\
              export_peaks.py\
+             get_podcast.py\
              import.py\
              list_cart.py\
              list_cart_sched_codes.py\

apis/rivwebpyapi/tests/get_podcast.py

@@ -0,0 +1,79 @@
+#!%PYTHON_BANGPATH%
+
+# get_podcast.py
+#
+# RivWebPyApi test script for Rivendell
+#
+#  Test the GetPodcast 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
+def eprint(*args,**kwargs):
+    print(*args,file=sys.stderr,**kwargs)
+
+url='';
+username=''
+password=''
+filename=''
+cast_id=-1
+
+#
+# Get login parameters
+#
+usage='get_podcast --url=<rd-url> --username=<rd-username> --filename=<str> --cast-id=<id>'
+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]=='--filename'):
+            filename=f0[1]
+        if(f0[0]=='--cast-id'):
+            cast_id=int(f0[1])
+
+if(not password):
+    password=getpass.getpass()
+if((not url)or(not username)):
+    print(usage)
+    sys.exit(1)
+if(cast_id<0):
+    eprint('you must supply "--cast-id"')
+    sys.exit(1)
+if(not filename):
+    eprint('you must supply "--filename"')
+    sys.exit(1)
+
+#
+# Execute
+#
+webapi=rivwebpyapi.rivwebpyapi(url=url,username=username,password=password)
+try:
+    webapi.GetPodcast(cast_id=cast_id,filename=filename)
+except rivwebpyapi.RivWebPyError as err:
+    eprint('*** ERROR ***')
+    eprint('Response Code: '+str(err.responseCode))
+    eprint('ErrorString: '+str(err.errorString))
+    eprint('*************')
+    eprint('')
+    sys.exit(1)

docs/apis/web_api.xml

@@ -1782,7 +1782,7 @@
 
 <sect1>
   <title>GetPodcast</title>
-  <subtitle>Get posted podcast audio</subtitle>
+  <subtitle>Get posted podcast audio from the Rivendell audio store</subtitle>
   <para>
     Command Code: <code>RDXPORT_COMMAND_GET_PODCAST</code>, Feed Permissions
     or <code>Administer System</code>