Add Update dataset query endpoint

Author: jbat

lib/superset/dataset/duplicate.rb

@@ -7,7 +7,7 @@ class Duplicate < Superset::Request
 
       attr_reader :source_dataset_id, :new_dataset_name
 
-      def initialize(source_dataset_id: :source_dataset_id, new_dataset_name: :new_dataset_name)
+      def initialize(source_dataset_id: , new_dataset_name: )
         @source_dataset_id = source_dataset_id
         @new_dataset_name = new_dataset_name
       end

lib/superset/dataset/update_query.rb

@@ -0,0 +1,56 @@
+module Superset
+  module Dataset
+    class UpdateQuery < Superset::Request
+
+      attr_reader :new_query, :dataset_id
+
+      def initialize(dataset_id: ,new_query: )
+        @new_query = new_query
+        @dataset_id = dataset_id
+      end
+
+      def perform
+        validate_proposed_changes
+
+        response
+      end
+
+      def response
+        @response ||= client.put(route, params)
+      end
+
+      def params
+        { "sql": new_query }
+      end
+
+      # check if the sql query embedds the schema name, if so it can not be duplicated cleanly
+      def sql_query_includes_hard_coded_schema?
+        new_query.include?("#{source_dataset['schema']}.")
+      end
+
+      def source_dataset
+        # will raise an error if the dataset does not exist
+        @source_dataset ||= begin
+          dataset = Get.new(dataset_id)
+          dataset.result
+        end
+      end
+
+      private
+
+      def validate_proposed_changes
+        logger.info "    Validating Dataset ID: #{dataset_id} query update to '#{new_query}'"
+        raise "Error: dataset_id integer is required"  unless dataset_id.present? && dataset_id.is_a?(Integer)
+        raise "Error: new_query string is required"       unless new_query.present? && new_query.is_a?(String)
+
+        # does the sql query hard code the current schema name?
+        raise "Error: >>WARNING<< The Dataset ID #{dataset_id} SQL query is hard coded with the schema value and can not be duplicated cleanly. " +
+              "Remove all direct embedded schema calls from the Dataset SQL query before continuing." if sql_query_includes_hard_coded_schema?
+      end
+
+      def route
+        "dataset/#{dataset_id}"
+      end
+    end
+  end
+end

lib/superset/dataset/update_schema.rb

@@ -4,7 +4,7 @@ class UpdateSchema < Superset::Request
 
       attr_reader :source_dataset_id, :target_database_id, :target_schema, :remove_copy_suffix
 
-      def initialize(source_dataset_id: :source_dataset_id, target_database_id: :target_database_id, target_schema: :target_schema, remove_copy_suffix: false)
+      def initialize(source_dataset_id: , target_database_id: , target_schema: , remove_copy_suffix: false)
         @source_dataset_id = source_dataset_id
         @target_database_id = target_database_id
         @target_schema = target_schema

spec/superset/dataset/update_query_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+RSpec.describe Superset::Dataset::UpdateQuery do
+  subject { described_class.new(
+              dataset_id: dataset_id,
+              new_query:  new_query) }
+
+  let(:dataset_id) { 226 }
+  let(:new_query) { 'select blah from some_table' }
+
+  let(:response) { { "id"=>dataset_id , "result" => { "sql" => new_query } } }
+
+  before do
+    allow(subject).to receive(:response).and_return(response)
+    allow(subject).to receive(:source_dataset).and_return( { schema: 'client2', sql: 'select fu from dif_table' }.with_indifferent_access)
+  end
+
+  describe '#perform' do
+    context 'with valid params' do
+      specify do
+        expect(subject.perform).to eq response
+      end
+    end
+
+    context 'with invalid params' do
+      context 'dataset_id is empty' do
+        let(:dataset_id) { nil }
+
+        specify do
+          expect { subject.perform }.to raise_error(RuntimeError, "Error: dataset_id integer is required")
+        end
+      end
+
+      context 'new_query is empty' do
+        let(:new_query) { nil }
+
+        specify do
+          expect { subject.perform }.to raise_error(RuntimeError, "Error: new_query string is required")
+        end
+      end
+
+      context 'new_query hard codes schema name' do
+        let(:new_query) { 'select fu from client2.dif_table' }
+
+        specify do
+          expect { subject.perform }.to raise_error(RuntimeError, 
+            "Error: >>WARNING<< The Dataset ID 226 SQL query is hard coded with the schema value and can not be duplicated cleanly. " \
+            "Remove all direct embedded schema calls from the Dataset SQL query before continuing.")
+        end
+      end
+    end
+  end
+end