AC-11246 Add Put endpoint for chart and dataset

Author: jbat

lib/superset/base_put_request.rb

@@ -0,0 +1,32 @@
+
+
+module Superset
+  class BasePutRequest < Superset::Request
+    attr_reader :object_id, :params
+
+    def initialize(object_id: ,params: )
+      @object_id = object_id
+      @params = params
+    end
+
+    def perform
+      validate
+      response
+    end
+
+    def response
+      @response ||= client.put(route, params)
+    end
+
+    private
+
+    def validate
+      raise "Error: object_id integer is required" unless object_id.present? && object_id.is_a?(Integer)
+      raise "Error: params hash is required" unless params.present? && params.is_a?(Hash)
+    end
+
+    def route
+      raise "Error: route method is required"
+    end
+  end
+end

lib/superset/chart/put.rb

@@ -2,37 +2,16 @@
 #
 # Usage:
 # params = { owners: [ 58, 3 ] }
-# Superset::Chart::Put.new(chart_id: 3998, params: params ).perform
+# Superset::Chart::Put.new(object_id: 202, params: params ).perform
 
 module Superset
   module Chart
-    class Put < Superset::Request
-
-      attr_reader :chart_id, :params
-
-      def initialize(chart_id: , params:)
-        @chart_id = chart_id
-        @params = params
-      end
-
-      def perform
-        validate_proposed_changes
-        response
-      end
-
-      def response
-        @response ||= client.put(route, params)
-      end
+    class Put < Superset::BasePutRequest
 
       private
 
-      def validate_proposed_changes
-        raise "Error: chart_id integer is required" unless chart_id.present? && chart_id.is_a?(Integer)
-        raise "Error: params hash is required" unless params.present? && params.is_a?(Hash)
-      end
-
       def route
-        "chart/#{chart_id}"
+        "chart/#{object_id}"
       end
     end
   end

lib/superset/dataset/put.rb

@@ -0,0 +1,18 @@
+# Updates a dataset in Superset with the given params
+#
+# Usage:
+# params = { owners: [ 58, 3 ] }
+# Superset::Dataset::Put.new(object_id: 101, params: params ).perform
+
+module Superset
+  module Dataset
+    class Put < Superset::BasePutRequest
+
+      private
+
+      def route
+        "dataset/#{object_id}"
+      end
+    end
+  end
+end

spec/shared/base_put_request_shared_examples.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+RSpec.shared_examples :base_put_request_shared_examples do
+  describe "#perform" do
+    subject { described_class.new(
+                object_id: object_id,
+                params: params) }
+
+    let(:object_id) { 226 }
+    let(:params) { { owners: [ 1, 2, 3 ] } }
+    let(:response) do
+      {
+        id: object_id, 
+        result: { owners: [1, 2, 3] }
+      }
+    end
+
+    before do
+      allow(subject).to receive(:response).and_return(response)
+    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 'object_id is empty' do
+          let(:object_id) { nil }
+          
+          specify do
+            expect { subject.perform }.to raise_error(RuntimeError, "Error: object_id integer is required")
+          end
+        end
+
+        context 'params is empty' do
+          let(:params) { nil }
+          
+          specify do
+            expect { subject.perform }.to raise_error(RuntimeError, "Error: params hash is required")
+          end
+        end 
+      end
+    end
+  end
+end

spec/superset/chart/put_spec.rb

@@ -1,46 +1,8 @@
 require 'spec_helper'
+require 'shared/base_put_request_shared_examples'
 
 RSpec.describe Superset::Chart::Put do
-  subject { described_class.new(
-              chart_id:  chart_id,
-              params: params) }
-
-  let(:chart_id) { 226 }
-  let(:params) { { owners: [ 1, 2, 3 ] } }
-  let(:response) do
-    {
-      id: chart_id, 
-      result: { owners: [1, 2, 3] }
-    }
-  end
-
-  before do
-    allow(subject).to receive(:response).and_return(response)
-  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 'chart_id is empty' do
-        let(:chart_id) { nil }
-        
-        specify do
-          expect { subject.perform }.to raise_error(RuntimeError, "Error: chart_id integer is required")
-        end
-      end
-
-      context 'params is empty' do
-        let(:params) { nil }
-        
-        specify do
-          expect { subject.perform }.to raise_error(RuntimeError, "Error: params hash is required")
-        end
-      end 
-    end
+  describe 'behaves like a BasePutRequest' do
+    it_behaves_like :base_put_request_shared_examples
   end
 end

spec/superset/dataset/put_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'shared/base_put_request_shared_examples'
+
+RSpec.describe Superset::Dataset::Put do
+
+  describe 'behaves like a BasePutRequest' do
+    it_behaves_like :base_put_request_shared_examples
+  end
+end