superset 0.1.6 → 0.2.5

data/lib/superset/services/import_dashboard_across_environment.rb

@@ -0,0 +1,144 @@
+=begin
+This service is used to duplicate a dashboard from one environment to another.
+It will not create any database connections from an imported dashboard zip, therefore the target_database_yaml_file configuration
+must already exist as a database connection in the target superset environment.
+
+Currently handles only 1 Database yaml file in the zip file. ( ie only 1 common database connection per dashboards datasets )
+
+Required Attributes: 
+ - target_database_yaml_file - location of the target database yaml config file
+ - target_database_schema - the schema name to be used in the target database
+ - dashboard_export_zip - location of the source dashboard export zip file to tranferred to a new superset Env
+
+Usage:
+Assuming you have exported a dashboard from the source environment and have the zip file, and have exported the target database yaml file
+
+Superset::Services::ImportDashboardAcrossEnvironments.new(
+ target_database_yaml_file: '/tmp/database.yaml',
+ target_database_schema: 'insert_schema_here',
+ dashboard_export_zip: '/tmp/dashboard.zip'
+).perform
+
+=end
+
+require 'superset/file_utilities'
+require 'yaml'
+
+module Superset
+  module Services
+    class ImportDashboardAcrossEnvironments
+      include FileUtilities
+
+      def initialize(target_database_yaml_file:, target_database_schema: ,dashboard_export_zip:)
+        @target_database_yaml_file   = target_database_yaml_file
+        @target_database_schema = target_database_schema
+        @dashboard_export_zip        = dashboard_export_zip
+      end
+
+      def perform
+        validate_params
+
+        remove_source_database_config
+        insert_target_database_file
+        insert_target_database_config
+        update_dataset_configs
+
+        create_new_dashboard_zip
+      end
+
+      def dashboard_config
+        @dashboard_config ||= Superset::Services::DashboardLoader.new(dashboard_export_zip: dashboard_export_zip).perform
+      end
+
+      private
+
+      attr_reader :target_database_yaml_file, :target_database_schema, :dashboard_export_zip
+
+      def remove_source_database_config
+        return if dashboard_config[:databases].blank?
+        previous_database_name = dashboard_config[:databases]&.first[:content][:database_name]
+        File.delete(dashboard_config[:databases].first[:filename])
+
+        dashboard_config[:databases].clear
+      end
+
+      def insert_target_database_file
+        FileUtils.cp(target_database_yaml_file, File.join(dashboard_export_root_path, 'databases'))
+
+        pattern = File.join(dashboard_export_root_path, 'databases', '*.yaml')
+        @new_database_yaml_file_path = Dir.glob(pattern).first
+      end
+
+      def insert_target_database_config
+        yaml_content = YAML.load_file(target_database_yaml_file).deep_symbolize_keys
+        dashboard_config[:databases] << { filename: new_database_yaml_file_path, content: yaml_content }
+      end
+
+      def update_dataset_configs
+        dashboard_config[:datasets].each do |dataset|
+          dataset[:content][:database_uuid] = dashboard_config[:databases].first[:content][:uuid]
+          dataset[:content][:schema]        = target_database_schema
+          stringified_content = deep_transform_keys_to_strings(dataset[:content])
+          File.open(dataset[:filename], 'w') { |f| f.write stringified_content.to_yaml }
+        end
+      end
+
+      def create_new_dashboard_zip
+        Zip::File.open(new_zip_file, Zip::File::CREATE) do |zipfile|
+          Dir[File.join(dashboard_export_root_path, '**', '**')].each do |file|
+            zipfile.add(file.sub(dashboard_export_root_path + '/', File.basename(dashboard_export_root_path) + '/' ), file) if File.file?(file)
+          end
+        end
+        new_zip_file
+      end
+
+      def new_zip_file
+        new_database_name = dashboard_config[:databases].first[:content][:database_name]
+        File.join(dashboard_config[:tmp_uniq_dashboard_path], "dashboard_import_for_#{new_database_name}.zip")
+      end
+
+      def new_database_yaml_file_path
+        @new_database_yaml_file_path ||= ''
+      end
+
+      def dashboard_export_root_path
+        # locate the unziped dashboard_export_* directory as named by superset app, eg dashboard_export_20240821T001536
+        @dashboard_export_root_path ||= begin 
+          pattern = File.join(dashboard_config[:tmp_uniq_dashboard_path], 'dashboard_export_*')
+          Dir.glob(pattern).first
+        end
+
+      end
+
+      def new_database_name
+        dashboard_config[:databases].first[:content][:database_name]
+      end
+
+      def previous_database_name
+        @previous_database_name ||= ''
+      end
+
+      def validate_params
+        raise "Dashboard Export Zip file does not exist" unless File.exist?(dashboard_export_zip)
+        raise "Dashboard Export Zip file is not a zip file" unless File.extname(dashboard_export_zip) == '.zip'
+        raise "Target Database YAML file does not exist" unless File.exist?(target_database_yaml_file)
+        raise "Currently this class handles boards with single Database configs only. Multiple Database configs exist in zip file." if dashboard_config[:databases].size > 1
+        raise "Target Database Schema cannot be blank" if target_database_schema.blank?
+      end
+
+      # Method to recursively transform keys to strings
+      def deep_transform_keys_to_strings(value)
+        case value
+        when Hash
+          value.each_with_object({}) do |(k, v), result|
+            result[k.to_s] = deep_transform_keys_to_strings(v)
+          end
+        when Array
+          value.map { |v| deep_transform_keys_to_strings(v) }
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/superset/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Superset
-  VERSION = "0.1.6"
+  VERSION = "0.2.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: superset
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.5
 platform: ruby
 authors:
 - jbat
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-11 00:00:00.000000000 Z
+date: 2025-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -208,17 +208,24 @@ files:
 - README.md
 - Rakefile
 - doc/duplicate_dashboards.md
+- doc/migrating_dashboards_across_environments.md
+- doc/publishing.md
 - doc/setting_up_personal_api_credentials.md
+- doc/usage.md
 - docker-compose.override.yml
 - docker-compose.yml
 - env.sample
 - lib/loggers/duplicate_dashboard_logger.rb
 - lib/superset.rb
 - lib/superset/authenticator.rb
+- lib/superset/base_put_request.rb
 - lib/superset/chart/bulk_delete.rb
+- lib/superset/chart/create.rb
 - lib/superset/chart/delete.rb
+- lib/superset/chart/duplicate.rb
 - lib/superset/chart/get.rb
 - lib/superset/chart/list.rb
+- lib/superset/chart/put.rb
 - lib/superset/chart/update_dataset.rb
 - lib/superset/client.rb
 - lib/superset/credential/api_user.rb
@@ -234,10 +241,12 @@ files:
 - lib/superset/dashboard/embedded/put.rb
 - lib/superset/dashboard/export.rb
 - lib/superset/dashboard/get.rb
+- lib/superset/dashboard/import.rb
 - lib/superset/dashboard/info.rb
 - lib/superset/dashboard/list.rb
 - lib/superset/dashboard/put.rb
 - lib/superset/dashboard/warm_up_cache.rb
+- lib/superset/database/export.rb
 - lib/superset/database/get.rb
 - lib/superset/database/get_schemas.rb
 - lib/superset/database/list.rb
@@ -247,6 +256,8 @@ files:
 - lib/superset/dataset/duplicate.rb
 - lib/superset/dataset/get.rb
 - lib/superset/dataset/list.rb
+- lib/superset/dataset/put.rb
+- lib/superset/dataset/refresh.rb
 - lib/superset/dataset/update_query.rb
 - lib/superset/dataset/update_schema.rb
 - lib/superset/dataset/warm_up_cache.rb
@@ -266,7 +277,9 @@ files:
 - lib/superset/security/user/create.rb
 - lib/superset/security/user/get.rb
 - lib/superset/security/user/list.rb
+- lib/superset/services/dashboard_loader.rb
 - lib/superset/services/duplicate_dashboard.rb
+- lib/superset/services/import_dashboard_across_environment.rb
 - lib/superset/sqllab/execute.rb
 - lib/superset/tag/add_to_object.rb
 - lib/superset/tag/get.rb
@@ -293,7 +306,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: A Ruby Client for Apache Superset API