add bulk delete endpoints

Author: jbat

lib/superset/chart/bulk_delete.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+# TODO: the gui delete has a confirmation step, this does not.  Potentially add a confirm_delete parameter to the constructor
+# that would ensure that all charts belong to an expected dashboard before deleting.  ( not sure if this is a good idea )
+
+
+module Superset
+  module Chart
+    class BulkDelete < Superset::Request
+      attr_reader :chart_ids
+
+      def initialize(chart_ids: [])
+        @chart_ids = chart_ids
+      end
+
+      def perform
+        raise InvalidParameterError, "chart_ids array of integers expected" unless chart_ids.is_a?(Array)
+        raise InvalidParameterError, "chart_ids array must contin Integer only values" unless chart_ids.all? { |item| item.is_a?(Integer) }
+
+        logger.info("Attempting to delete charts with id: #{chart_ids.join(', ')}")
+        response
+      end
+
+      def response
+        @response ||= client.delete(route, params)
+      end
+
+      private
+
+      def params
+        { q: "!(#{chart_ids.join(',')})" }
+      end
+
+      def route
+        "chart/"
+      end
+    end
+  end
+end

lib/superset/dashboard/bulk_delete.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# TODO: the gui delete has a confirmation step, this does not.  Potentially add a confirm_delete parameter to the constructor
+# that would ensure that no charts belong to a dashboard before deleting
+
+module Superset
+  module Dashboard
+    class BulkDelete < Superset::Request
+      attr_reader :dashboard_ids
+
+      def initialize(dashboard_ids: [])
+        @dashboard_ids = dashboard_ids
+      end
+
+      def perform
+        raise InvalidParameterError, "dashboard_ids array of integers expected" unless dashboard_ids.is_a?(Array)
+        raise InvalidParameterError, "dashboard_ids array must contin Integer only values" unless dashboard_ids.all? { |item| item.is_a?(Integer) }
+
+        logger.info("Attempting to delete dashboards with id: #{dashboard_ids.join(', ')}")
+        response
+      end
+
+      def response
+        @response ||= client.delete(route, params)
+      end
+
+      private
+
+      def params
+        { q: "!(#{dashboard_ids.join(',')})" }
+      end
+
+      def route
+        "dashboard/"
+      end
+    end
+  end
+end

lib/superset/dashboard/charts/list.rb

@@ -22,7 +22,7 @@ def rows
               c[:id],
               c[:slice_name],
               c[:form_data][:datasource],
-              c[:form_data][:dashboards]
+              # c[:form_data][:dashboards]  # NOTE: form_data dashboards is not accurate .. looks to be bugs related to copying charts
             ]
           end
         end
@@ -34,7 +34,7 @@ def route
         end
 
         def list_attributes
-          ['id', 'slice_name', 'datasource', 'dashboards'].map(&:to_sym)
+          ['id', 'slice_name', 'datasource'].map(&:to_sym)
         end
 
         # when displaying a list of datasets, show dashboard id and title as well

lib/superset/dashboard/delete.rb

@@ -24,7 +24,7 @@ def response
         @response ||= client.delete(route)
       end
 
-#      private
+      private
 
       def confirm_zero_charts_on_dashboard
         raise "Error: Dashboard includes #{dashboard_charts.count} charts. Please delete all charts before deleting the dashboard or override and set confirm_zero_charts: false" if dashboard_charts.count.positive?

lib/superset/dashboard/list.rb

@@ -55,6 +55,10 @@ def rows
         end
       end
 
+      def ids
+        result.map { |d| d[:id] }
+      end
+
       private
 
       def route

lib/superset/dataset/bulk_delete.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# TODO: the gui delete has a confirmation step, this does not.  Potentially add a confirm_delete parameter to the constructor
+# that would ensure that no charts point to a dataset before deleting
+
+module Superset
+  module Dataset
+    class BulkDelete < Superset::Request
+      attr_reader :dataset_ids
+
+      def initialize(dataset_ids: [])
+        @dataset_ids = dataset_ids
+      end
+
+      def perform
+        raise InvalidParameterError, "dataset_ids array of integers expected" unless dataset_ids.is_a?(Array)
+        raise InvalidParameterError, "dataset_ids array must contin Integer only values" unless dataset_ids.all? { |item| item.is_a?(Integer) }
+
+        logger.info("Attempting to delete datasets with id: #{dataset_ids.join(', ')}")
+        response
+      end
+
+      def response
+        @response ||= client.delete(route, params)
+      end
+
+      private
+
+      def params
+        { q: "!(#{dataset_ids.join(',')})" }
+      end
+
+      def route
+        "dataset/"
+      end
+    end
+  end
+end

spec/superset/chart/bulk_delete_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+RSpec.describe Superset::Chart::BulkDelete do
+  subject { described_class.new(chart_ids: chart_ids) }
+  let(:chart_ids) { nil }
+  let(:response) { "some response" }
+
+  before do
+    allow(subject).to receive(:response).and_return(response)
+  end
+
+  describe '.perform' do
+    context 'when chart_ids is not present' do
+      it 'raises an error' do
+        expect { subject.perform }.to raise_error(Superset::Request::InvalidParameterError, "chart_ids array of integers expected")
+      end
+    end
+
+    context 'when chart_ids contains non integer values' do
+      let(:chart_ids) { [1, 'string'] }
+
+      it 'raises an error' do
+        expect { subject.perform }.to raise_error(Superset::Request::InvalidParameterError, "chart_ids array must contin Integer only values")
+      end
+    end
+
+    context 'when chart_ids is an integer' do
+      let(:chart_ids) { [1, 2] }
+
+      it 'deletes the charts' do
+        expect(subject).to receive(:response)
+        subject.perform
+      end
+    end
+  end
+end

spec/superset/dashboard/bulk_delete_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+RSpec.describe Superset::Dashboard::BulkDelete do
+  subject { described_class.new(dashboard_ids: dashboard_ids) }
+  let(:dashboard_ids) { nil }
+  let(:response) { "some response" }
+
+  before do
+    allow(subject).to receive(:response).and_return(response)
+  end
+
+  describe '.perform' do
+    context 'when dashboard_ids is not present' do
+      it 'raises an error' do
+        expect { subject.perform }.to raise_error(Superset::Request::InvalidParameterError, "dashboard_ids array of integers expected")
+      end
+    end
+
+    context 'when dashboard_ids contains non integer values' do
+      let(:dashboard_ids) { [1, 'string'] }
+
+      it 'raises an error' do
+        expect { subject.perform }.to raise_error(Superset::Request::InvalidParameterError, "dashboard_ids array must contin Integer only values")
+      end
+    end
+
+    context 'when dashboard_ids is an integer' do
+      let(:dashboard_ids) { [1, 2] }
+
+      it 'deletes the dashboards' do
+        expect(subject).to receive(:response)
+        subject.perform
+      end
+    end
+  end
+end

spec/superset/dashboard/charts/list_spec.rb

@@ -36,8 +36,8 @@
     specify do
       expect(subject.rows).to match_array(
         [
-          [248, "Chart 1", "114__table", [28]],
-          [249, "Chart 2", "114__table", [28]]
+          [248, "Chart 1", "114__table"],
+          [249, "Chart 2", "114__table"]
         ]
       )
     end

spec/superset/dataset/bulk_delete_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+RSpec.describe Superset::Dataset::BulkDelete do
+  subject { described_class.new(dataset_ids: dataset_ids) }
+  let(:dataset_ids) { nil }
+  let(:response) { "some response" }
+
+  before do
+    allow(subject).to receive(:response).and_return(response)
+  end
+
+  describe '.perform' do
+    context 'when dataset_ids is not present' do
+      it 'raises an error' do
+        expect { subject.perform }.to raise_error(Superset::Request::InvalidParameterError, "dataset_ids array of integers expected")
+      end
+    end
+
+    context 'when dataset_ids contains non integer values' do
+      let(:dataset_ids) { [1, 'string'] }
+
+      it 'raises an error' do
+        expect { subject.perform }.to raise_error(Superset::Request::InvalidParameterError, "dataset_ids array must contin Integer only values")
+      end
+    end
+
+    context 'when dataset_ids is an integer' do
+      let(:dataset_ids) { [1, 2] }
+
+      it 'deletes the datasets' do
+        expect(subject).to receive(:response)
+        subject.perform
+      end
+    end
+  end
+end