add default order, update specs

Author: jbat

lib/superset/dashboard/list.rb

@@ -7,7 +7,7 @@ module Dashboard
     class List < Superset::Request
       attr_reader :title_contains, :title_equals, :tags_equal, :ids_not_in
 
-      def initialize(page_num: 0, title_contains: '', title_equals: '', tags_equal: [], ids_not_in: [])
+      def initialize(page_num: 0, title_contains: '', title_equals: '', tags_equal: [], ids_not_in: [], **extra_args)
         @title_contains = title_contains
         @title_equals = title_equals
         @tags_equal = tags_equal

lib/superset/dashboard/list_all.rb

@@ -0,0 +1,62 @@
+# Superset has a 100 result limit for requests
+# This is a wrapper for Superset::Dashboard::List to recursively list all dashboards 
+
+# TODO - would be very handy to create a parent class for this
+#        to then be able to use the same pattern for other ::List classes
+
+module Superset
+  module Dashboard
+    class ListAll
+      include Display
+
+      def initialize(**kwargs)
+        kwargs.each do |key, value|
+          instance_variable_set("@#{key}", value)
+          self.class.attr_reader key
+        end
+      end
+
+      def constructor_args
+        instance_variables.each_with_object({}) do |var, hash|
+          hash[var.to_s.delete('@').to_sym] = instance_variable_get(var)
+        end
+      end
+      
+      def perform
+        page_num = 0
+        boards = []
+        boards << next_group = Dashboard::List.new(page_num: page_num, **constructor_args).result
+        while !next_group.empty?
+          boards << next_group = Dashboard::List.new(page_num: page_num += 1, **constructor_args).result
+        end
+        @result = boards.flatten
+      end
+
+      def result
+        @result ||= []
+      end
+
+      def rows
+        result.map do |d|
+          list_attributes.map do |la|
+            la == :url ? "#{superset_host}#{d[la]}" : d[la]
+          end
+        end
+      end
+
+      def ids
+        result.map { |d| d[:id] }
+      end
+
+      private
+
+      def list_attributes
+        [:id, :dashboard_title, :status, :url]
+      end
+
+      def superset_host
+        ENV['SUPERSET_HOST']
+      end
+    end
+  end
+end

lib/superset/request.rb

@@ -33,7 +33,12 @@ def superset_host
     end
 
     def query_params
-      [filters, pagination].join
+      [filters, pagination, order_by].join
+    end
+
+    def order_by
+      # by default, we will order by changed_on as per the GUI
+      ",order_column:changed_on,order_direction:desc"
     end
 
     private

lib/superset/tag/add_to_object.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+# Add tags to an object
+# for object type options see ObjectType.to_a
+#
+# Usage:
+# Superset::Tag::AddToObject.new(object_type_id: ObjectType::DASHBOARD, object_id: new_dashboard.id, tags: tags).perform
+
 module Superset
   module Tag
     class AddToObject < Superset::Request

lib/superset/tag/delete_from_object.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Delete tags from an object
+# for object type options see ObjectType.to_a
+#
+# Usage:
+# Superset::Tag::DeleteFromObject.new(object_type_id: ObjectType::DASHBOARD, object_id: 101, tag: 'test-tag').perform
+
+module Superset
+  module Tag
+    class DeleteFromObject < Superset::Request
+
+      attr_reader :object_type_id, :object_id, :tag
+
+      def initialize(object_type_id:, object_id:, tag:)
+        @object_type_id = object_type_id
+        @object_id = object_id
+        @tag = tag
+      end
+
+      def perform
+        validate_constructor_args
+
+        response
+      end
+
+      def response
+        @response ||= client.delete(route)
+      end
+
+      def validate_constructor_args
+        raise InvalidParameterError, "object_type_id integer is required" unless object_type_id.present? && object_type_id.is_a?(Integer)
+        raise InvalidParameterError, "object_type_id is not a known value" unless ObjectType.list.include?(object_type_id)
+        raise InvalidParameterError, "object_id integer is required" unless object_id.present? && object_id.is_a?(Integer)
+        raise InvalidParameterError, "tag string is required" unless tag.present? && tag.is_a?(String)
+      end
+
+      private
+
+      def route
+        "tag/#{object_type_id}/#{object_id}/#{tag}/"
+      end
+    end
+  end
+end

spec/superset/chart/list_spec.rb

@@ -74,6 +74,7 @@
       "viz_type"=>"dist_bar"
     }]
   end
+  let(:default_query_params) { "page:0,page_size:100,order_column:changed_on,order_direction:desc" }
 
   before do
     allow(subject).to receive(:result).and_return(result)
@@ -106,14 +107,14 @@
 
   describe '#query_params' do
     specify 'with defaults' do
-      expect(subject.query_params).to eq("page:0,page_size:100")
+      expect(subject.query_params).to eq(default_query_params)
     end
 
     context 'with name_contains filters' do
       subject { described_class.new(name_contains: 'birth') }
 
       specify do
-        expect(subject.query_params).to eq("filters:!((col:slice_name,opr:ct,value:'birth')),page:0,page_size:100")
+        expect(subject.query_params).to eq("filters:!((col:slice_name,opr:ct,value:'birth')),#{default_query_params}")
       end
     end
 
@@ -125,7 +126,7 @@
           "filters:!(" \
           "(col:slice_name,opr:ct,value:'birth')," \
           "(col:dashboards,opr:rel_m_m,value:3)" \
-          "),page:0,page_size:100")
+          "),#{default_query_params}")
       end
     end
   end

spec/superset/dashboard/list_spec.rb

@@ -19,6 +19,7 @@
       }
     ]
   end
+  let(:default_query_params) { "page:0,page_size:100,order_column:changed_on,order_direction:desc" }
 
   before do
     allow(subject).to receive(:result).and_return(result)
@@ -62,15 +63,15 @@
     context 'for pagination' do
       context 'with defaults' do
         specify do
-          expect(subject.query_params).to eq("page:0,page_size:100")
+          expect(subject.query_params).to eq(default_query_params)
         end
       end
 
       context 'with specifiec page' do
         subject { described_class.new(page_num: 5) }
 
         specify do
-          expect(subject.query_params).to eq("page:5,page_size:100")
+          expect(subject.query_params).to eq(default_query_params.gsub('page:0', 'page:5'))
         end
       end
     end
@@ -79,7 +80,7 @@
       subject { described_class.new(title_contains: 'acme') }
 
       specify do
-        expect(subject.query_params).to eq("filters:!((col:dashboard_title,opr:ct,value:'acme')),page:0,page_size:100")
+        expect(subject.query_params).to eq("filters:!((col:dashboard_title,opr:ct,value:'acme')),#{default_query_params}")
       end
     end
 
@@ -91,7 +92,7 @@
           "filters:!(" \
           "(col:dashboard_title,opr:ct,value:'birth')," \
           "(col:tags,opr:dashboard_tags,value:'template')" \
-          "),page:0,page_size:100")
+          "),#{default_query_params}")
       end
     end
 
@@ -106,7 +107,7 @@
           "(col:tags,opr:dashboard_tags,value:'template')," \
           "(col:tags,opr:dashboard_tags,value:'client:acme')," \
           "(col:tags,opr:dashboard_tags,value:'product:turbo-charged-feet')" \
-          "),page:3,page_size:100")
+          "),#{default_query_params.gsub('page:0', 'page:3')}")
       end
     end
   end

spec/superset/database/list_spec.rb

@@ -20,6 +20,7 @@
       ]
     }
   end
+  let(:default_query_params) { "page:0,page_size:100,order_column:changed_on,order_direction:desc" }
 
   describe '#rows' do
     before do
@@ -40,15 +41,15 @@
     context 'for pagination' do
       context 'with defaults' do
         specify do
-          expect(subject.query_params).to eq("page:0,page_size:100")
+          expect(subject.query_params).to eq(default_query_params)
         end
       end
 
       context 'with specifiec page' do
         subject { described_class.new(page_num: 5) }
 
         specify do
-          expect(subject.query_params).to eq("page:5,page_size:100")
+          expect(subject.query_params).to eq(default_query_params.gsub('page:0', 'page:5'))
         end
       end
     end
@@ -57,15 +58,15 @@
       subject { described_class.new(title_contains: 'acme') }
 
       specify do
-        expect(subject.query_params).to eq("filters:!((col:database_name,opr:ct,value:'acme')),page:0,page_size:100")
+        expect(subject.query_params).to eq("filters:!((col:database_name,opr:ct,value:'acme')),#{default_query_params}")
       end
     end
 
     context 'with uuid_equals filters' do
       subject { described_class.new(uuid_equals: '123') }
 
       specify do
-        expect(subject.query_params).to eq("filters:!((col:uuid,opr:eq,value:'123')),page:0,page_size:100")
+        expect(subject.query_params).to eq("filters:!((col:uuid,opr:eq,value:'123')),#{default_query_params}")
       end
     end
   end

spec/superset/dataset/list_spec.rb

@@ -43,15 +43,15 @@
   ]
   end
 
+  let(:default_query_params) { "page:0,page_size:100,order_column:changed_on,order_direction:desc" }
+
   before do
     allow(subject).to receive(:result).and_return(result)
     allow(subject).to receive(:superset_host).and_return(superset_host)
     allow(subject).to receive(:response).and_return( { 'count': 1 } )
   end
 
   describe '#rows' do
-    #before { stub_const("Superset::Request::PAGE_SIZE", "3") }
-
     specify do
       expect(subject.rows).to eq(
         [
@@ -64,22 +64,22 @@
 
   describe '#query_params' do
     specify 'with defaults' do
-      expect(subject.query_params).to eq("page:0,page_size:100")
+      expect(subject.query_params).to eq("#{default_query_params}")
     end
 
     context 'with title_contains filters' do
       subject { described_class.new(title_contains: 'birth') }
 
       specify do
-        expect(subject.query_params).to eq("filters:!((col:table_name,opr:ct,value:'birth')),page:0,page_size:100")
+        expect(subject.query_params).to eq("filters:!((col:table_name,opr:ct,value:'birth')),#{default_query_params}")
       end
     end
 
     context 'with title_contains filters' do
       subject { described_class.new(title_equals: 'birth_days') }
 
       specify do
-        expect(subject.query_params).to eq("filters:!((col:table_name,opr:eq,value:'birth_days')),page:0,page_size:100")
+        expect(subject.query_params).to eq("filters:!((col:table_name,opr:eq,value:'birth_days')),#{default_query_params}")
       end
     end
 
@@ -88,7 +88,7 @@
       subject { described_class.new(title_equals: 'birth_days', schema_equals: 'schema_one') }
 
       specify do
-        expect(subject.query_params).to eq("filters:!((col:table_name,opr:eq,value:'birth_days'),(col:schema,opr:eq,value:'schema_one')),page:0,page_size:100")
+        expect(subject.query_params).to eq("filters:!((col:table_name,opr:eq,value:'birth_days'),(col:schema,opr:eq,value:'schema_one')),#{default_query_params}")
       end
     end
 

spec/superset/request_spec.rb

@@ -38,4 +38,10 @@
       expect(subject.superset_host).to eq(host)
     end
   end
+
+  describe '#query_params' do
+    it 'returns the default query params' do
+      expect(subject.send(:query_params)).to eq("page:0,page_size:100,order_column:changed_on,order_direction:desc")
+    end
+  end
 end