Merge pull request #24 from rdytech/AC-10426-dataset-creation-endpoint

AC-10426 Adds endpoint for dataset creation, route info

Author: jbat

bin/console

@@ -49,4 +49,10 @@ unless ENV['SUPERSET_HOST'] && ENV['SUPERSET_API_USERNAME'] && ENV['SUPERSET_API
   exit
 end
 
+puts "\n  >>> Welcome to the Superset Ruby API Client <<< \n\n"
+puts "Your accessible Superset Database connections are: Superset::Database::List.call"
+
+Superset::Database::List.call
+
 Pry.start(__FILE__)
+

lib/superset/chart/list.rb

@@ -39,7 +39,7 @@ 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:dashboards,opr:rel_m_m,value:#{dashboard_id_eq})" if dashboard_id_eq.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?
 
         unless filter_set.empty?

lib/superset/dataset/create.rb

@@ -0,0 +1,62 @@
+# The API demands that the new_dataset_name be uniq within the schema it points to.
+# same behaviour as in the GUI
+
+module Superset
+  module Dataset
+    class Create < Superset::Request
+
+      attr_reader :target_database_id, :new_dataset_name, :new_dataset_schema, :sql
+
+      def initialize(target_database_id: , new_dataset_name: , new_dataset_schema: 'public', sql: )
+        @target_database_id = target_database_id
+        @new_dataset_name = new_dataset_name
+        @new_dataset_schema = new_dataset_schema
+        @sql = sql
+      end
+
+      def perform
+        raise "Error: target_database_id integer is required" unless target_database_id.present? && target_database_id.is_a?(Integer)
+        raise "Error: new_dataset_name string is required" unless new_dataset_name.present? && new_dataset_name.is_a?(String)
+        raise "Error: Dataset Name #{new_dataset_name} is already in use in the schema: #{new_dataset_schema}. Suggest you add (COPY) as a suffix to the name" if new_dataset_name_already_in_use?
+        raise "Error: sql string is required" unless sql.present? && sql.is_a?(String)
+
+        logger.info("Creating New Dataset #{new_dataset_name} in DB #{target_database_id} Schema #{new_dataset_schema}")
+
+        response
+        { id: response['id'], dataset_name: response['data']['datasource_name'] }
+      end
+
+      def response
+        @response ||= client.post(route, params)
+      end
+
+      def params
+        {
+          "schema": new_dataset_schema,
+          "sql": sql,
+          "table_name": new_dataset_name,
+          "database": target_database_id
+
+          # Optional Params .. pulled straight from the GUI swagger example
+
+          #"always_filter_main_dttm": false,
+          #"external_url": "string",
+          #"is_managed_externally": false,
+          #"normalize_columns": false,
+          # "owners": [ 0 ],
+        }
+      end
+
+      private
+
+      # The API demands that the new_dataset_name be uniq within the schema it points to.
+      def new_dataset_name_already_in_use?
+        Dataset::List.new(title_equals: new_dataset_name, schema_equals: new_dataset_schema, database_id_eq: target_database_id).result.any?
+      end
+
+      def route
+        "dataset/"
+      end
+    end
+  end
+end

lib/superset/dataset/list.rb

@@ -1,12 +1,13 @@
 module Superset
   module Dataset
     class List < Superset::Request
-      attr_reader :title_contains, :title_equals, :schema_equals
+      attr_reader :title_contains, :title_equals, :schema_equals, :database_id_eq
 
-      def initialize(page_num: 0, title_contains: '', title_equals: '', schema_equals: '')
+      def initialize(page_num: 0, title_contains: '', title_equals: '', schema_equals: '', database_id_eq: '')
         @title_contains = title_contains
         @title_equals = title_equals
         @schema_equals = schema_equals
+        @database_id_eq = database_id_eq
         super(page_num: page_num)
       end
 
@@ -26,6 +27,7 @@ def filters
         filters << "(col:table_name,opr:ct,value:'#{title_contains}')" if title_contains.present?
         filters << "(col:table_name,opr:eq,value:'#{title_equals}')" if title_equals.present?
         filters << "(col:schema,opr:eq,value:'#{schema_equals}')" if schema_equals.present?
+        filters << "(col:database,opr:rel_o_m,value:#{database_id_eq})" if database_id_eq.present? # rel one to many
         unless filters.empty?
           "filters:!(" + filters.join(',') + "),"
         end

lib/superset/route_info.rb

@@ -0,0 +1,34 @@
+module Superset
+  class RouteInfo < Superset::Request
+    alias result response
+
+    attr_reader :route
+    
+    def initialize(route:)
+      @route = route
+    end
+
+    def perform
+      validate_route
+      response
+    end
+
+    def response
+      validate_route
+      @response ||= client.get(route)
+    end
+
+    def filters
+      result['filters']
+    end
+
+    private
+
+    def validate_route
+      unless route.present? && route.is_a?(String)
+        puts "Example Route: 'dashboard/_info' "
+        raise "Error: route string is required" unless route.present? && route.is_a?(String)
+      end
+    end
+  end
+end

lib/superset/sqllab/execute.rb

@@ -3,12 +3,13 @@ module Sqllab
     class Execute < Superset::Request
       class InvalidParameterError < StandardError; end
 
-      attr_reader :database_id, :query, :schema
+      attr_reader :database_id, :query, :schema, :query_limit
 
-      def initialize(database_id: , query: , schema: 'public')
+      def initialize(database_id: , query: , schema: 'public', query_limit: 1000)
         @database_id = database_id
         @query = query
         @schema = schema
+        @query_limit = query_limit
       end
 
       def perform
@@ -36,7 +37,7 @@ def query_params
           database_id: database_id,
           sql:         query,
           schema:      schema,
-          queryLimit:  1000,
+          queryLimit:  query_limit,
           runAsync: false,
         }
       end
@@ -48,4 +49,4 @@ def validate_constructor_args
       end
     end
   end
-end
+end