[NEP-17473] Add Export endpoint

Author: jbat

lib/superset/dashboard/export.rb

@@ -0,0 +1,96 @@
+# Will export the zip file to /tmp/superset_dashboards with zip filename adjusted to include the dashboard_id
+# Example zipfile: dashboard_#{dashboard_id}_export_#{datestamp}.zip
+# Usage
+# Superset::Dashboard::Export.new(dashboard_id: 15).perform
+#
+
+require 'superset/file_utilities'
+
+module Superset
+  module Dashboard
+    class Export < Request
+      include FileUtilities
+
+      TMP_SUPERSET_DASHBOARD_PATH = '/tmp/superset_dashboards'
+
+      attr_reader :dashboard_id, :destination_path
+
+      def initialize(dashboard_id: , destination_path: )
+        @dashboard_id = dashboard_id
+        @destination_path = destination_path
+        @download_path = TMP_SUPERSET_DASHBOARD_PATH
+      end
+
+      def perform
+        response
+        write_file_and_unzip
+        copy_export_files_to_destination_path if destination_path
+      end
+
+      # overriding the current happi get request as the returned packet is as string, ie not the usual hash
+      def response
+        @response ||= client.call(
+          :get,
+          client.url(route),
+          client.param_check(params)
+        )
+      end
+
+      def download_folder
+        File.dirname(extracted_files[0])
+      end
+
+      private
+
+      def route
+        "dashboard/export/"
+      end
+
+      def params
+        { "q": "!(#{dashboard_id})" }   # pulled off chrome dev tools doing a GUI export.  Swagger interface not helpfull with this endpoint.
+      end
+
+      def write_file_and_unzip
+        create_tmp_dir
+        File.open(zip_file_name, 'wb') { |fp| fp.write(@response.body) }
+
+        @extracted_files = unzip_file(zip_file_name, tmp_uniq_dashboard_path)
+      end
+
+      def copy_export_files_to_destination_path
+        path_with_dash_id = File.join(destination_path, dashboard_id.to_s)
+        FileUtils.mkdir_p(path_with_dash_id) unless File.directory?(path_with_dash_id)
+
+        Dir.glob("#{download_folder}/*").each do |item|
+          FileUtils.cp_r(item, path_with_dash_id)
+        end
+      end
+
+      def zip_file_name
+        @zip_file_name ||= "#{tmp_uniq_dashboard_path}/dashboard_#{dashboard_id}_export_#{datestamp}.zip"
+      end
+
+      def create_tmp_dir
+        FileUtils.mkdir_p(tmp_uniq_dashboard_path) unless File.directory?(tmp_uniq_dashboard_path)
+      end
+
+      # uniq random tmp folder name for each export
+      # this will allow us to do a wildcard glop on the folder to get the files 
+      def tmp_uniq_dashboard_path
+        @tmp_uniq_dashboard_path ||= File.join(TMP_SUPERSET_DASHBOARD_PATH, uuid)
+      end
+
+      def uuid
+        SecureRandom.uuid
+      end
+
+      def extracted_files
+        @extracted_files ||= []
+      end
+
+      def datestamp
+        @datestamp ||= Time.now.strftime('%Y%m%d')
+      end
+    end
+  end
+end

lib/superset/file_utilities.rb

@@ -0,0 +1,19 @@
+require 'zip'
+
+module Superset
+  module FileUtilities
+    def unzip_file(zip_file, destination)
+      entries = []
+      Zip::File.open(zip_file) do |zip|
+        zip.each do |entry|
+          entry_path = File.join(destination, entry.name)
+          entries << entry_path
+          FileUtils.mkdir_p(File.dirname(entry_path))
+          zip.extract(entry, entry_path)
+        end
+      end
+      puts entries
+      entries # return array of extracted files
+    end
+  end
+end