superset 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddf012f64fba5d3e1fe7584f41fc5ddcbdf9b20dea686efca47ae99e9e228c58
-  data.tar.gz: 9295923ac58ea7f24d92e978f94d8bbcbb6c06dd4cc821de4d67c3b57ebd08d0
+  metadata.gz: c6b2b4cb255df5113b61de937f565c6f004c5df347bb047f0c47e6f1c06eadd2
+  data.tar.gz: a34377f58a2dbbfc0bcbcf7a897bee918760707c01b33c41d1119af0d940840d
 SHA512:
-  metadata.gz: 563f5e16113862396196f5b0bbfe8fc96b2edce69d14089e464592f3770a9da156d50ebacc2098e6b4fc1a7766c568571d25a33507db86c2641d92ac5f518ea7
-  data.tar.gz: 8a02610f9d42328bff42753363ddb651924af87da82abfcd9311a16dd8ab9293e1f035d4f6e60e097e7f82c1b28165d5a009dfae4de0b1c0b1d8b16a2f00f704
+  metadata.gz: c734a5177395f6981fa7733ee0a6c44c1839ca080eb18ad9c4c6e8d12f7adb2948f7710c5d5d2c13015c855cce03169b0ddf5b93254e17929173e3a81503501b
+  data.tar.gz: 3db00f88ca7dd063ace17729b41cc5c5c7e30b3b77ef37a15ccee83873cbe02caf1460bd30b397a4d28a7d3971179f57d9b0194a186ebf05b194e90a050ed650

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## Change Log
 
+## 0.2.7 - 2025-10-16
+* add to_h method to list classes for Hash output
+* add ids method to list classes for array of ids output
+* add ability to over ride default page_size
+* add ruby console auto timeout set to 30 mins by default
+* add GetCatalogs endpoint caller
+* fix catalog bug related to dashboard export and import across env
+* add tag_equals param to dashboard list class
+
 ## 0.2.6 - 2025-08-05
 * Bump terminal-table from 1.8.0 to 4.0.0
 

data/lib/superset/chart/list.rb

@@ -2,13 +2,13 @@ module Superset
   module Chart
     class List < Superset::Request
 
-      attr_reader :name_contains, :dashboard_id_eq, :dataset_id_eq
+      attr_reader :title_contains, :dashboard_id_eq, :dataset_id_eq
 
-      def initialize(page_num: 0, name_contains: '', dashboard_id_eq: '', dataset_id_eq: '')
-        @name_contains = name_contains
+      def initialize(title_contains: '', dashboard_id_eq: '', dataset_id_eq: '', **kwargs)
+        @title_contains = title_contains
         @dashboard_id_eq = dashboard_id_eq
         @dataset_id_eq = dataset_id_eq
-        super(page_num: page_num)
+        super(**kwargs)
       end
 
       def self.call
@@ -38,7 +38,7 @@ module Superset
       def filters
         # TODO filtering across all classes needs a refactor to support multiple options in a more flexible way
         filter_set = []
-        filter_set << "(col:slice_name,opr:ct,value:'#{name_contains}')" if name_contains.present?
+        filter_set << "(col:slice_name,opr:ct,value:'#{title_contains}')" if title_contains.present?
         filter_set << "(col:dashboards,opr:rel_m_m,value:#{dashboard_id_eq})" if dashboard_id_eq.present? # rel many to many
         filter_set << "(col:datasource_id,opr:eq,value:#{dataset_id_eq})" if dataset_id_eq.present?
 

data/lib/superset/dashboard/list.rb

@@ -5,15 +5,18 @@
 module Superset
   module Dashboard
     class List < Superset::Request
-      attr_reader :title_contains, :title_equals, :tags_equal, :ids_not_in, :include_filter_dataset_schemas
+      attr_reader :title_contains, :title_equals,
+                  :tags_contain, :tags_equal,
+                  :ids_not_in, :include_filter_dataset_schemas
 
-      def initialize(page_num: 0, title_contains: '', title_equals: '', tags_equal: [], ids_not_in: [], include_filter_dataset_schemas: false)
+      def initialize(title_contains: '', title_equals: '', tags_contain: [], tags_equal: [], ids_not_in: [], include_filter_dataset_schemas: false, **kwargs)
         @title_contains = title_contains
         @title_equals = title_equals
+        @tags_contain = tags_contain
         @tags_equal = tags_equal
         @ids_not_in = ids_not_in
         @include_filter_dataset_schemas = include_filter_dataset_schemas
-        super(page_num: page_num)
+        super(**kwargs)
       end
 
       def self.call
@@ -57,8 +60,16 @@ module Superset
         end
       end
 
+      def to_h
+        result.map do |d|
+          list_attributes.to_h do |la|
+            la == :url ? [la, "#{superset_host}#{d[la]}"] : [la, d[la]]
+          end
+        end
+      end
+
       def ids
-        result.map { |d| d[:id] }
+        result.is_a?(Hash) ? [result[:id]] : result.map { |d| d[:id] }
       end
 
       private
@@ -72,15 +83,30 @@ module Superset
         filter_set = []
         filter_set << "(col:dashboard_title,opr:ct,value:'#{title_contains}')" if title_contains.present?
         filter_set << "(col:dashboard_title,opr:eq,value:'#{title_equals}')" if title_equals.present?
-        filter_set << tag_filters if tags_equal.present?
+        filter_set << tags_contain_filters if tags_contain.present?
+        filter_set << tags_equal_filters if tags_equal.present?
         filter_set << ids_not_in_filters if ids_not_in.present?
+
         unless filter_set.empty?
           "filters:!(" + filter_set.join(',') + "),"
         end
       end
 
-      def tag_filters
-        tags_equal.map {|tag| "(col:tags,opr:dashboard_tags,value:'#{tag}')"}.join(',')
+      def tags_equal_filters
+        tags_equal_ids.map { |id| "(col:tags,opr:dashboard_tag_id,value:#{id})" }.join(',')
+      end
+
+      def tags_equal_ids
+        tags_equal.map do |tag_name|
+          ids = Superset::Tag::List.new(name_equals: tag_name).rows.map(&:first)
+          raise "No ID found for tag: #{tag_name}" if ids.empty?
+          raise "Multiple IDs found for tag: #{tag_name}" if ids.size > 1
+          ids.first
+        end
+      end
+
+      def tags_contain_filters
+        tags_contain.map {|tag| "(col:tags,opr:dashboard_tags,value:'#{tag}')"}.join(',')
       end
 
       def ids_not_in_filters
@@ -94,8 +120,8 @@ module Superset
       def validate_constructor_args
         raise InvalidParameterError, "title_contains must be a String type" unless title_contains.is_a?(String)
         raise InvalidParameterError, "title_equals must be a String type" unless title_equals.is_a?(String)
-        raise InvalidParameterError, "tags_equal must be an Array type" unless tags_equal.is_a?(Array)
-        raise InvalidParameterError, "tags_equal array must contain string only values" unless tags_equal.all? { |item| item.is_a?(String) }
+        raise InvalidParameterError, "tags_contain must be an Array type of String values" unless tags_contain.is_a?(Array) && tags_contain.all? { |item| item.is_a?(String) }
+        raise InvalidParameterError, "tags_equal must be an Array type of String values" unless tags_equal.is_a?(Array) && tags_equal.all? { |item| item.is_a?(String) }
         raise InvalidParameterError, "ids_not_in must be an Array type" unless ids_not_in.is_a?(Array)
       end
     end

data/lib/superset/database/get_catalogs.rb

@@ -0,0 +1,38 @@
+module Superset
+  module Database
+    class GetCatalogs < Superset::Request
+
+      attr_reader :id, :include_system_catalogs
+
+      def initialize(id, include_system_catalogs: false)
+        @id = id
+        @include_system_catalogs = include_system_catalogs
+      end
+
+      def self.call(id)
+        self.new(id).catalogs
+      end
+ 
+      def catalogs
+        return result if include_system_catalogs
+
+        remove_system_catalogs
+      end
+
+      private
+
+      def route
+        "database/#{id}/catalogs/"
+      end
+
+      # exclude system catalog values for certain databases that support them
+      def remove_system_catalogs
+        result - postgres_system_catalogs
+      end
+
+      def postgres_system_catalogs
+        %w(postgres rdsadmin template1 template0)
+      end
+    end
+  end
+end

data/lib/superset/database/list.rb

@@ -6,10 +6,10 @@ module Superset
     class List < Superset::Request
       attr_reader :title_contains, :uuid_equals
 
-      def initialize(page_num: 0, title_contains: '', uuid_equals: '')
+      def initialize(title_contains: '', uuid_equals: '', **kwargs)
         @title_contains = title_contains
         @uuid_equals = uuid_equals
-        super(page_num: page_num)
+        super(**kwargs)
       end
 
       def self.call

data/lib/superset/dataset/get.rb

@@ -18,7 +18,11 @@ module Superset
       end
 
       def rows
-        [ [title, schema, database_name, database_id] ]
+        [to_h.values]
+      end
+
+      def to_h
+        list_attributes.to_h { |a| [a, send(a)] }
       end
 
       def schema
@@ -26,7 +30,7 @@ module Superset
       end
 
       def title
-        result['name']
+        result['table_name']
       end
 
       def database_name
@@ -47,8 +51,8 @@ module Superset
         "dataset/#{id}"
       end
 
-      def display_headers
-        %w[title schema database_name, database_id]
+      def list_attributes
+        [:title, :schema, :database_name, :database_id]
       end
     end
   end

data/lib/superset/dataset/list.rb

@@ -3,12 +3,12 @@ module Superset
     class List < Superset::Request
       attr_reader :title_contains, :title_equals, :schema_equals, :database_id_eq
 
-      def initialize(page_num: 0, title_contains: '', title_equals: '', schema_equals: '', database_id_eq: '')
+      def initialize(title_contains: '', title_equals: '', schema_equals: '', database_id_eq: '', **kwargs)
         @title_contains = title_contains
         @title_equals = title_equals
         @schema_equals = schema_equals
         @database_id_eq = database_id_eq
-        super(page_num: page_num)
+        super(**kwargs)
       end
 
       def self.call

data/lib/superset/dataset/update_schema.rb

@@ -2,12 +2,13 @@ module Superset
   module Dataset
     class UpdateSchema < Superset::Request
 
-      attr_reader :source_dataset_id, :target_database_id, :target_schema, :remove_copy_suffix
+      attr_reader :source_dataset_id, :target_database_id, :target_schema, :target_catalog, :remove_copy_suffix
 
-      def initialize(source_dataset_id: , target_database_id: , target_schema: , remove_copy_suffix: false)
+      def initialize(source_dataset_id: , target_database_id: , target_schema: , target_catalog: nil,  remove_copy_suffix: false)
         @source_dataset_id = source_dataset_id
         @target_database_id = target_database_id
         @target_schema = target_schema
+        @target_catalog = target_catalog
         @remove_copy_suffix = remove_copy_suffix
       end
 
@@ -37,6 +38,7 @@ module Superset
           
           # primary database and schema changes
           new_params.merge!("database_id": target_database_id)  # add the target database id
+          new_params['catalog'] = target_catalog
           new_params['schema'] = target_schema
           new_params['owners'] = new_params['owners'].map {|o| o['id'] } # expects an array of user ids
           new_params['table_name'] = new_params['table_name'].gsub(/ \(COPY\)/, '') if remove_copy_suffix

data/lib/superset/display.rb

@@ -7,28 +7,37 @@ module Superset
     def table
       Terminal::Table.new(
         title: title,
-        headings: headings,
+        headings: list_attributes.map(&:to_s).map(&:humanize),
         rows: rows
       )
     end
 
     def rows
-      result.map do |d|
-        list_attributes.map { |la| d[la].to_s }
+      if result.is_a?(Hash)
+        list_attributes.map { |la| result[la].to_s }
+      else
+        result.map do |d|
+          list_attributes.map { |la| d[la].to_s }
+        end
       end
     end
 
-    def title
-      self.class.to_s
+    def to_h
+      if result.is_a?(Hash)
+        list_attributes.to_h { |la| [la, result[la]] }
+      else
+        result.map do |d|
+          list_attributes.to_h { |la| [la, d[la]] }
+        end
+      end
     end
 
-    def headings
-      headings = display_headers ? display_headers : list_attributes
-      headings.map(&:to_s).map(&:humanize)
+    def ids
+      result.map { |d| d[:id] }
     end
 
-    def display_headers
-      # optionally override this method to display custom headers
+    def title
+      self.class.to_s
     end
 
     def list_attributes

data/lib/superset/request.rb

@@ -5,12 +5,13 @@ module Superset
     class InvalidParameterError < StandardError; end
     class ValidationError < StandardError; end
 
-    PAGE_SIZE = 100
+    DEFAULT_PAGE_SIZE = 100
 
-    attr_accessor :page_num
+    attr_accessor :page_num, :page_size
 
-    def initialize(page_num: 0)
+    def initialize(page_num: 0, page_size: nil)
       @page_num = page_num
+      @page_size = page_size || DEFAULT_PAGE_SIZE
     end
 
     def self.call
@@ -51,7 +52,8 @@ module Superset
     end
 
     def pagination
-      "page:#{page_num},page_size:#{PAGE_SIZE}"
+      raise InvalidParameterError, "page_size max is 1000 records" if page_size.to_i > 1000
+      "page:#{page_num},page_size:#{page_size}"
     end
 
     def filters

data/lib/superset/security/permissions_resources/list.rb

@@ -3,8 +3,8 @@ module Superset
     module PermissionsResources
       class List < Superset::Request
 
-        def initialize(page_num: 0)         
-          super(page_num: page_num)
+        def initialize(**kwargs)
+          super(**kwargs)
         end
 
         private

data/lib/superset/security/user/list.rb

@@ -4,10 +4,10 @@ module Superset
       class List < Superset::Request
         attr_reader :email_contains, :username_equals
 
-        def initialize(page_num: 0, email_contains: '', username_equals: '')
+        def initialize(email_contains: '', username_equals: '', **kwargs)
           @email_contains = email_contains
           @username_equals = username_equals
-          super(page_num: page_num)
+          super(**kwargs)
         end
 
         private

data/lib/superset/services/duplicate_dashboard.rb

@@ -100,8 +100,12 @@ module Superset
             new_dataset_id = existing_datasets[0]["id"] # assuming that we do not name multiple datasets with same name in a single schema
           else
             new_dataset_id = Superset::Dataset::Duplicate.new(source_dataset_id: dataset[:id], new_dataset_name: new_dataset_name).perform
-            # update the new dataset with the target schema and target database
-            Superset::Dataset::UpdateSchema.new(source_dataset_id: new_dataset_id, target_database_id: target_database_id, target_schema: target_schema).perform
+            # update the new dataset with the target schema, database, catalog
+            Superset::Dataset::UpdateSchema.new(
+              source_dataset_id:  new_dataset_id,
+              target_database_id: target_database_id,
+              target_schema:      target_schema,
+              target_catalog:     target_database_catalog).perform
           end
           # keep track of the previous dataset and the matching new dataset_id
           dataset_duplication_tracker <<  { source_dataset_id: dataset[:id], new_dataset_id: new_dataset_id }
@@ -263,6 +267,13 @@ module Superset
         @filter_dataset_ids ||= source_dashboard.filter_configuration.map { |c| c['targets'] }.flatten.compact.map { |c| c['datasetId'] }.flatten.compact.uniq
       end
 
+      # currently does not support multiple catalogs, assumption is that 1 catalog is used per database
+      def target_database_catalog
+        catalogs = Superset::Database::GetCatalogs.new(target_database_id).catalogs
+        raise ValidationError, "Target Database #{target_database_id} has multiple catalogs" if catalogs.size > 1
+        catalogs.first
+      end
+
       # Primary Assumption is that all charts datasets on the source dashboard are pointing to the same database schema
       # An unpermitted filter will have a dataset that is pulling data from a datasource that is
       # different to the dashboard charts database schema

data/lib/superset/services/import_dashboard_across_environment.rb

@@ -56,6 +56,7 @@ module Superset
 
       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])
 
@@ -78,6 +79,8 @@ module Superset
         dashboard_config[:datasets].each do |dataset|
           dataset[:content][:database_uuid] = dashboard_config[:databases].first[:content][:uuid]
           dataset[:content][:schema]        = target_database_schema
+          dataset[:content][:catalog]       = nil # reset target to use default catalog if applicable
+
           stringified_content = deep_transform_keys_to_strings(dataset[:content])
           File.open(dataset[:filename], 'w') { |f| f.write stringified_content.to_yaml }
         end

data/lib/superset/tag/list.rb

@@ -23,7 +23,7 @@ module Superset
         # TODO filtering across all list classes can be refactored to support multiple options in a more flexible way
         filter_set = []
         filter_set << "(col:name,opr:ct,value:'#{name_contains}')" if name_contains.present?
-        filter_set << "(col:name,opr:eq,value:#{name_equals})" if name_equals.present?  
+        filter_set << "(col:name,opr:eq,value:'#{name_equals}')" if name_equals.present?
         unless filter_set.empty?
           "filters:!(" + filter_set.join(',') + "),"
         end

data/lib/superset/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: superset
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - jbat
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-05 00:00:00.000000000 Z
+date: 2025-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -249,6 +249,7 @@ files:
 - lib/superset/dashboard/warm_up_cache.rb
 - lib/superset/database/export.rb
 - lib/superset/database/get.rb
+- lib/superset/database/get_catalogs.rb
 - lib/superset/database/get_schemas.rb
 - lib/superset/database/list.rb
 - lib/superset/dataset/bulk_delete.rb