superset 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f3edd28b29118fb3c7ebc2eb7a199a92939429683bbe0c19aecc87b09202d9e
-  data.tar.gz: f4eba7dd0dccd0093f8016e565df81861f0157560ab2f0320e7c4f29caec31c7
+  metadata.gz: ddf012f64fba5d3e1fe7584f41fc5ddcbdf9b20dea686efca47ae99e9e228c58
+  data.tar.gz: 9295923ac58ea7f24d92e978f94d8bbcbb6c06dd4cc821de4d67c3b57ebd08d0
 SHA512:
-  metadata.gz: c89e37964c7a4e3ae49c484cd4594f7471734184500874c04c217a58ea785eede26390fcee81b178da92d7f4f0a0f263f61d959f33ee235a7d633a609b3cdb77
-  data.tar.gz: 96a68b6e37885caa88dd6fc1b8b219f5fbe45f25347f9e3c66a52f1a8f167b5fa48d03dac849f4fa8b04426d450ba050af0cabe268b5961e77c306fdba98b969
+  metadata.gz: 563f5e16113862396196f5b0bbfe8fc96b2edce69d14089e464592f3770a9da156d50ebacc2098e6b4fc1a7766c568571d25a33507db86c2641d92ac5f518ea7
+  data.tar.gz: 8a02610f9d42328bff42753363ddb651924af87da82abfcd9311a16dd8ab9293e1f035d4f6e60e097e7f82c1b28165d5a009dfae4de0b1c0b1d8b16a2f00f704

data/.ruby-version

@@ -0,0 +1 @@
+2.7.8

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Change Log
 
+## 0.2.6 - 2025-08-05
+* Bump terminal-table from 1.8.0 to 4.0.0
+
+## 0.2.5 - 2025-05-22
+* add refresh dataset call in `Superset::Dataset::Refresh.call(id)`
+
 ## 0.2.4 - 2025-01-29
 * modifies the `Superset::Dashboard::Datasets::List.new(id).schemas` to optionally include filter datasets as well.
 * modifies the `Superset::Dashboard::Embedded::Get.new` to accept dashboard_id as named parameter
@@ -76,6 +82,3 @@
 - add security/user endpoints
 - add security/role endpoints
 - add security/role/permission endpoints
-
-
-

data/doc/migrating_dashboards_across_environments.md

@@ -20,12 +20,12 @@ Assuming your API env for ruby is setup for your target superset environment.
 
 new_import_zip = Superset::Services::ImportDashboardAcrossEnvironments.new(
   dashboard_export_zip:      'path_to/dashboard_101_export_20241010.zip',
-  target_database_yaml_file: 'path_to/env2_db_config.yaml', 
-  target_database_schema:    'acme', 
+  target_database_yaml_file: 'path_to/env2_db_config.yaml',
+  target_database_schema:    'acme',
   ).perform
 
 # now import the adjusted zip to the target superset env
-Superset::Dashboard::Import.new(source_zip_file: new_import_file).perform
+Superset::Dashboard::Import.new(source: new_import_file).perform
 
 ```
 
@@ -170,4 +170,4 @@ It will attempt to update the same dashboard as the UUID for the dashboard has n
 
 Some helpful references relating to cross-environment workflows:
 - [Managing Content Across Workspaces](https://docs.preset.io/docs/managing-content-across-workspaces)
-- [Superset Slack AI Explanation](https://apache-superset.slack.com/archives/C072KSLBTC1/p1722382347022689)
+- [Superset Slack AI Explanation](https://apache-superset.slack.com/archives/C072KSLBTC1/p1722382347022689)

data/lib/superset/dashboard/import.rb

@@ -1,29 +1,32 @@
-# Import the provided Dashboard zip file
+# frozen_string_literal: true
+
+# Import the provided Dashboard zip file or directory (aka source)
 # In the context of this API import process, assumption is that the database.yaml file details will match
 # an existing database in the Target Superset Environment.
 
 # Scenario 1: Export from Env1 -- Import to Env1 into the SAME Environment
-#             Will result in updating/over writing the dashboard with the contents of the zip file 
+#             Will result in updating/over writing the dashboard with the contents of the source
 
 # Scenario 2: Export from Env1 -- Import to Env2 into a DIFFERENT Environment
-#             Assumption is that the database.yaml will match a database configuration in the target env. 
-#             Initial import will result in creating a new dashboard with the contents of the zip file. 
-#             Subsequent imports will result in updating/over writing the previous imported dashboard with the contents of the zip file.
+#             Assumption is that the database.yaml will match a database configuration in the target env.
+#             Initial import will result in creating a new dashboard with the contents of the source.
+#             Subsequent imports will result in updating/over writing the previous imported dashboard with the contents of the source.
 
 # the overwrite flag will determine if the dashboard will be updated or created new
 # overwrite: false .. will result in an error if a dashboard with the same UUID already exists
 
 # Usage
-# Superset::Dashboard::Import.new(source_zip_file: '/tmp/dashboard.zip').perform
+# Superset::Dashboard::Import.new(source: '/tmp/dashboard.zip').perform
+# Superset::Dashboard::Import.new(source: '/tmp/dashboard').perform
 #
 
 module Superset
   module Dashboard
     class Import < Request
-      attr_reader :source_zip_file, :overwrite
+      attr_reader :source, :overwrite
 
-      def initialize(source_zip_file: , overwrite: true)
-        @source_zip_file = source_zip_file
+      def initialize(source:, overwrite: true)
+        @source = source
         @overwrite = overwrite
       end
 
@@ -42,16 +45,20 @@ module Superset
       private
 
       def validate_params
-        raise ArgumentError, 'source_zip_file is required' if source_zip_file.nil?
-        raise ArgumentError, 'source_zip_file does not exist' unless File.exist?(source_zip_file)
-        raise ArgumentError, 'source_zip_file is not a zip file' unless File.extname(source_zip_file) == '.zip'
-        raise ArgumentError, 'overwrite must be a boolean' unless [true, false].include?(overwrite)
-        raise ArgumentError, "zip target database does not exist: #{zip_database_config_not_found_in_superset}" if zip_database_config_not_found_in_superset.present?
+        raise ArgumentError, "source is required" if source.nil?
+        raise ArgumentError, "source does not exist" unless File.exist?(source)
+        raise ArgumentError, "source is not a zip file or directory" unless zip? || directory?
+        raise ArgumentError, "overwrite must be a boolean" unless [true, false].include?(overwrite)
+
+        return unless database_config_not_found_in_superset.present?
+
+        raise ArgumentError,
+              "target database does not exist: #{database_config_not_found_in_superset}"
       end
 
       def payload
         {
-          formData: Faraday::UploadIO.new(source_zip_file, 'application/zip'),
+          formData: Faraday::UploadIO.new(source_zip_file, "application/zip"),
           overwrite: overwrite.to_s
         }
       end
@@ -60,24 +67,66 @@ module Superset
         "dashboard/import/"
       end
 
-      def zip_database_config_not_found_in_superset
-        zip_databases_details.select {|s| !superset_database_uuids_found.include?(s[:uuid]) }
+      def zip?
+        File.extname(source) == ".zip"
       end
 
-      def superset_database_uuids_found
-        @superset_database_uuids_found ||= begin
-          zip_databases_details.map {|i| i[:uuid]}.map do |uuid|
-            uuid if Superset::Database::List.new(uuid_equals: uuid).result.present?
-          end.compact
+      def directory?
+        File.directory?(source)
+      end
+
+      def source_zip_file
+        return source if zip?
+
+        Zip::File.open(new_zip_file, Zip::File::CREATE) do |zipfile|
+          Dir[File.join(source, "**", "**")].each do |file|
+            next unless File.file?(file)
+
+            # add a base folder to the relative path: "dashboard_import_#{timestamp}"
+            zipfile.add(File.join("dashboard_import_#{timestamp}", relative_path(file)), file)
+          end
         end
+        new_zip_file
+      end
+
+      def relative_path(file)
+        Pathname.new(file).relative_path_from(Pathname.new(source)).to_s
+      end
+
+      def new_zip_file
+        File.join(source, "dashboard_import_#{timestamp}.zip")
       end
 
-      def zip_databases_details
-        zip_dashboard_config[:databases].map{|d| {uuid: d[:content][:uuid], name: d[:content][:database_name]} }
+      def timestamp
+        @timestamp ||= Time.now.strftime("%Y%m%d%H%M%S")
+      end
+
+      def database_config_not_found_in_superset
+        databases_details.reject { |s| superset_database_uuids_found.include?(s[:uuid]) }
+      end
+
+      def superset_database_uuids_found
+        @superset_database_uuids_found ||= databases_details.map { |i| i[:uuid] }.map do |uuid|
+          uuid if Superset::Database::List.new(uuid_equals: uuid).result.present?
+        end.compact
+      end
+
+      def databases_details
+        dashboard_config[:databases].map { |d| { uuid: d[:content][:uuid], name: d[:content][:database_name] } }
+      end
+
+      def dashboard_config
+        @dashboard_config ||= zip? ? zip_dashboard_config : directory_dashboard_config
       end
 
       def zip_dashboard_config
-        @zip_dashboard_config ||= Superset::Services::DashboardLoader.new(dashboard_export_zip: source_zip_file).perform
+        Superset::Services::DashboardLoader.new(dashboard_export_zip: source).perform
+      end
+
+      def directory_dashboard_config
+        Superset::Services::DashboardLoader::DashboardConfig.new(
+          dashboard_export_zip: "", tmp_uniq_dashboard_path: source
+        ).config
       end
     end
   end

data/lib/superset/dataset/refresh.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Description: This endpoint has the same functionality as 'Sync Columns from Source' button in the Superset UI on a dataset.
+# Executes the dataset against the source to confirm the query runs and then sync and cache dataset columns.
+# NOTICE: only owners of the dataset can refresh it
+#
+# Usage: Superset::Dataset::Refresh.call(id)
+
+module Superset
+  module Dataset
+    class Refresh < Superset::Request
+
+      attr_reader :id
+
+      def initialize(id)
+        @id = id
+      end
+
+      def self.call(id)
+        self.new(id).perform
+      end
+
+      def perform
+        response
+      end
+
+      def response
+        @response ||= client.put(route)
+      end
+
+      private
+
+      def route
+        "dataset/#{id}/refresh"
+      end
+    end
+  end
+end

data/lib/superset/version.rb

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

data/superset.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary = "A Ruby Client for Apache Superset API"
   spec.homepage = "https://github.com/rdytech/superset-client"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 2.7.8"
 
   #spec.metadata["allowed_push_host"] = ""
 
@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "dotenv", "~> 2.7"
   spec.add_dependency "json", "~> 2.6"
-  spec.add_dependency "terminal-table", "~> 1.8"
+  spec.add_dependency "terminal-table", "~> 4.0"
   spec.add_dependency "rake", "~> 13.0"
   spec.add_dependency "rollbar", "~> 3.4"
   spec.add_dependency "require_all", "~> 3.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: superset
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - jbat
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-29 00:00:00.000000000 Z
+date: 2025-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +202,7 @@ files:
 - ".buildkite/pipeline.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Dockerfile
 - LICENSE
@@ -257,6 +258,7 @@ files:
 - 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
@@ -298,14 +300,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: A Ruby Client for Apache Superset API