adjust params naming

Author: jbat

lib/superset/dashboard/embedded/put.rb

@@ -2,19 +2,22 @@ module Superset
   module Dashboard
     module Embedded
       class Put < Superset::Request
-        attr_reader :dashboard_id, :embedded_domain
+        attr_reader :dashboard_id, :allowed_domains
 
-        def initialize(dashboard_id: , embedded_domain: )
+        def initialize(dashboard_id: , allowed_domains: )
           @dashboard_id = dashboard_id
-          @embedded_domain = embedded_domain
+          @allowed_domains = allowed_domains
         end
 
         def response
+          raise  InvalidParameterError, 'dashboard_id integer is required' if dashboard_id.nil? || dashboard_id.class != Integer
+          raise  InvalidParameterError, 'allowed_domains array is required' if allowed_domains.nil? || allowed_domains.class != Array
+
           @response ||= client.put(route, params)
         end
 
         def params
-          { "allowed_domains": [embedded_domain] }
+          { "allowed_domains": allowed_domains }
         end
 
         def uuid

lib/superset/services/duplicate_dashboard.rb

@@ -9,13 +9,13 @@ class DuplicateDashboard < Superset::Request
 
       DUPLICATED_DATASET_SUFFIX = ' (COPY)'
 
-      attr_reader :source_dashboard_id, :target_schema, :target_database_id, :embedded_domain
+      attr_reader :source_dashboard_id, :target_schema, :target_database_id, :allowed_domains
 
-      def initialize(source_dashboard_id:, target_schema:, target_database_id: , embedded_domain: '')
+      def initialize(source_dashboard_id:, target_schema:, target_database_id: , allowed_domains: nil)
         @source_dashboard_id = source_dashboard_id
         @target_schema = target_schema
         @target_database_id = target_database_id
-        @embedded_domain = embedded_domain
+        @allowed_domains = allowed_domains
       end
 
       def perform
@@ -49,9 +49,9 @@ def perform
       private
 
       def created_embedded_config
-        return unless embedded_domain.present?
+        return unless allowed_domains.present?
 
-        result = Dashboard::Embedded::Put.new(dashboard_id: new_dashboard.id, embedded_domain: embedded_domain).result
+        result = Dashboard::Embedded::Put.new(dashboard_id: new_dashboard.id, allowed_domains: allowed_domains).result
         logger.info "  Embedded Domain Added to New Dashboard #{new_dashboard.id}:"
         logger.info "  Embedded Domain allowed_domains: #{result['allowed_domains']}"
         logger.info "  Embedded Domain uuid: #{result['uuid']}"

spec/superset/dashboard/embedded/put_spec.rb

@@ -1,17 +1,17 @@
 require 'spec_helper'
 
 RSpec.describe Superset::Dashboard::Embedded::Put, type: :service do
-  subject { described_class.new(dashboard_id: dashboard_id, embedded_domain: allowed_domain) }
+  subject { described_class.new(dashboard_id: dashboard_id, allowed_domains: allowed_domains) }
   let(:dashboard_id) { 1 }
 
   describe 'with a dashboard that has embedded settings, ie has a result' do
-    let(:allowed_domain) { ['http://test-domain.io/'] }
+    let(:allowed_domains) { ['http://test-domain.io/'] }
     let(:uuid) { '631bxxxx-xxxx-xxxx-xxxx-xxxxxxxxx247' }
     let(:response) do
       {
         'result' =>
           {
-            "allowed_domains" => allowed_domain,
+            "allowed_domains" => allowed_domains,
             "changed_by"=>{"first_name"=>"Jay", "id"=>9, "last_name"=>"Bee", "username"=>"4bf....3f5"},
             "changed_on"      => "2023-10-30T03:06:51.437527",
             "dashboard_id"    => "1",
@@ -20,13 +20,53 @@
       }.with_indifferent_access
     end
 
-    before do
-      allow(subject).to receive(:response).and_return(response)
+    context 'with params' do
+      before { allow(subject).to receive(:response).and_return(response) }
+
+      context 'that are valid' do
+        it 'returns uuid' do
+          expect(subject.uuid).to eq(uuid)
+        end
+      end
+    end
+
+    context 'where allowed_domains is not an array' do
+      let(:allowed_domains) { 'http://test-domain.io/' }
+
+      before { allow(subject).to receive(:response).and_call_original }
+
+      it 'raises error' do
+        expect { subject.response }.to raise_error(Superset::Request::InvalidParameterError, "allowed_domains array is required")
+      end
     end
 
-    describe '#uuid' do
-      it 'returns uuid' do
-        expect(subject.uuid).to eq(uuid)
+    context 'where allowed_domains is nil' do
+      let(:allowed_domains) { nil }
+
+      before { allow(subject).to receive(:response).and_call_original }
+
+      it 'raises error' do
+        expect { subject.response }.to raise_error(Superset::Request::InvalidParameterError, "allowed_domains array is required")
+      end
+    end
+
+    context 'where dashboard_id is nil' do
+      let(:dashboard_id) { nil }
+
+      before { allow(subject).to receive(:response).and_call_original }
+
+      it 'raises error' do
+        expect { subject.response }.to raise_error(Superset::Request::InvalidParameterError, "dashboard_id integer is required")
+      end
+    end
+
+    context 'where dashboard_id is not an int' do
+      let(:dashboard_id) { 'asdf' }
+
+      before { allow(subject).to receive(:response).and_call_original }
+
+      it 'raises error' do
+        expect { subject.response }.to raise_error(Superset::Request::InvalidParameterError, "dashboard_id integer is required")
       end
     end
   end