mno-enterprise-api 3.3.3 → 3.4.0

data/lib/mno_enterprise/concerns/controllers/jpi/v1/impac/widgets_controller.rb

@@ -24,6 +24,8 @@ module MnoEnterprise::Concerns::Controllers::Jpi::V1::Impac::WidgetsController
   #  -> POST /api/mnoe/v1/dashboards/:id/widgets
   def create
     if widgets
+      authorize! :create_impac_widgets, widgets.build(widget_create_params)
+
       if @widget = widgets.create(widget_create_params)
         MnoEnterprise::EventLogger.info('widget_create', current_user.id, 'Widget Creation', widget)
         @nocontent = true # no data fetch from Connec!
@@ -39,6 +41,8 @@ module MnoEnterprise::Concerns::Controllers::Jpi::V1::Impac::WidgetsController
   # PUT /mnoe/jpi/v1/impac/widgets/:id
   #   -> PUT /api/mnoe/v1/widgets/:id
   def update
+    authorize! :update_impac_widgets, widget
+
     if widget.update(widget_update_params)
       MnoEnterprise::EventLogger.info('widget_update', current_user.id, 'Widget Update', widget, {widget_action: params[:widget]})
       @nocontent = !params['metadata']
@@ -51,6 +55,8 @@ module MnoEnterprise::Concerns::Controllers::Jpi::V1::Impac::WidgetsController
   # DELETE /mnoe/jpi/v1/impac/widgets/:id
   #   -> DELETE /api/mnoe/v1/widgets/:id
   def destroy
+    authorize! :destroy_impac_widgets, widget
+
     if widget.destroy
       MnoEnterprise::EventLogger.info('widget_delete', current_user.id, 'Widget Deletion', widget)
       head status: :ok
@@ -69,13 +75,19 @@ module MnoEnterprise::Concerns::Controllers::Jpi::V1::Impac::WidgetsController
       @widget ||= MnoEnterprise::Impac::Widget.find(params[:id])
     end
 
+    def parent_dashboard
+      @parent_dashboard ||= MnoEnterprise::Impac::Dashboard.find(params[:dashboard_id])
+    end
+
     def widgets
-      @widgets ||= MnoEnterprise::Impac::Dashboard.find(params[:dashboard_id]).widgets
+      @widgets ||= parent_dashboard.widgets
     end
 
     def widget_create_params
-      params.require(:widget).permit(:endpoint, :name, :width).tap do |whitelisted|
+      permitted_attrs = [:endpoint, :name, :width, { layouts: [] }]
+      params.require(:widget).permit(*permitted_attrs).tap do |whitelisted|
         whitelisted[:settings] = params[:widget][:metadata] || {}
+        whitelisted[:settings][:organization_ids] ||= parent_dashboard.settings[:organization_ids]
         # TODO: remove when mnohub migrated to new model
         whitelisted[:widget_category] = params[:widget][:endpoint]
       end

data/lib/mno_enterprise/concerns/controllers/jpi/v1/organizations_controller.rb

@@ -200,7 +200,7 @@ module MnoEnterprise::Concerns::Controllers::Jpi::V1::OrganizationsController
     end
 
     def organization_permitted_update_params
-      [:name, :soa_enabled, :industry, :size]
+      [:name, :soa_enabled, :industry, :size, :financial_year_end_month]
     end
 
     def organization_update_params

data/spec/controllers/mno_enterprise/jpi/v1/admin/impac/dashboard_controller_spec.rb

@@ -0,0 +1,149 @@
+require 'rails_helper'
+require 'mno_enterprise/testing_support/shared_contexts/jpi_v1_admin_controller'
+require 'mno_enterprise/testing_support/shared_contexts/jpi_v1_admin_impac_controller'
+
+module MnoEnterprise
+  describe Jpi::V1::Admin::Impac::DashboardsController, type: :controller do
+    include_context MnoEnterprise::Jpi::V1::Admin::BaseResourceController
+
+    include MnoEnterprise::TestingSupport::SharedContexts::JpiV1AdminImpacController
+    include_context 'MnoEnterprise::Jpi::V1::Admin::Impac'
+
+    describe 'GET #index' do
+      subject { get :index }
+
+      before do
+        api_stub_for(
+          get: '/dashboards',
+          params: { filter: { 'owner_type' => 'User', 'owner_id' => user.id } },
+          response: from_api([dashboard])
+        )
+      end
+
+      include_context "#{described_class}: dashboard dependencies stubs"
+
+      it_behaves_like "a jpi v1 admin action"
+
+      it 'returns a list of dashboards' do
+        subject
+        expect(JSON.parse(response.body)).to eq([hash_for_dashboard])
+      end
+    end
+
+    describe 'POST #create' do
+      subject { post :create, dashboard: dashboard_params }
+
+      let(:dashboard_params) do
+        {
+          name: dashboard.name,
+          currency: dashboard.currency,
+          organization_ids: [org.id]
+        }
+      end
+
+      before do
+        # TODO: stub params?
+        api_stub_for(
+          post: "/dashboards",
+          response: from_api(dashboard)
+        )
+      end
+
+      include_context "#{described_class}: dashboard dependencies stubs"
+
+      it_behaves_like "a jpi v1 admin action"
+
+      it 'returns a dashboard' do
+        subject
+        expect(JSON.parse(response.body)).to eq(hash_for_dashboard)
+      end
+
+    end
+
+    describe 'PUT #update' do
+      subject { put :update, id: dashboard.id, dashboard: dashboard_params }
+
+      let(:dashboard_params) do
+        {
+          name: dashboard.name,
+          currency: dashboard.currency,
+          organization_ids: [org.id]
+        }
+      end
+
+      before do
+        api_stub_for(
+          get: "/dashboards",
+          params: {
+            filter: { 'id' => dashboard.id, 'owner_id' => user.id, 'owner_type' => 'User' },
+            limit: 1
+          },
+          response: from_api([dashboard])
+        )
+        api_stub_for(
+          put: "/dashboards/#{dashboard.id}",
+          response: from_api(dashboard)
+        )
+      end
+
+      include_context "#{described_class}: dashboard dependencies stubs"
+
+      it_behaves_like "a jpi v1 admin action"
+
+      it 'returns a dashboard' do
+        subject
+        expect(JSON.parse(response.body)).to eq(hash_for_dashboard)
+      end
+    end
+
+    describe 'DELETE destroy' do
+      subject { delete :destroy, id: dashboard.id }
+
+      before do
+        api_stub_for(
+          get: "/dashboards",
+          params: {
+            filter: { 'id' => dashboard.id, 'owner_id' => user.id, 'owner_type' => 'User' },
+            limit: 1
+          },
+          response: from_api([dashboard])
+        )
+        api_stub_for(
+          delete: "/dashboards/#{dashboard.id}",
+          response: from_api(nil)
+        )
+      end
+
+      it_behaves_like "a jpi v1 admin action"
+    end
+
+    describe 'POST copy' do
+      subject { post :copy, id: template.id, dashboard: dashboard_params }
+
+      let(:template) { build(:impac_dashboard, dashboard_type: 'template') }
+      let(:dashboard_params) do
+        {
+          name: dashboard.name,
+          currency: dashboard.currency,
+          organization_ids: [org.id]
+        }
+      end
+
+      before do
+        api_stub_for(
+          get: "/dashboards/#{template.id}",
+          params: { filter: { 'dashboard_type' => 'template' } },
+          response: from_api(template)
+        )
+        api_stub_for(
+          post: "/dashboards/#{template.id}/copy",
+          response: from_api(dashboard)
+        )
+      end
+
+      include_context "#{described_class}: dashboard dependencies stubs"
+
+      it_behaves_like "a jpi v1 admin action"
+    end
+  end
+end

data/spec/controllers/mno_enterprise/jpi/v1/admin/impac/dashboard_templates_controller_spec.rb

@@ -1,75 +1,20 @@
 require 'rails_helper'
+require 'mno_enterprise/testing_support/shared_contexts/jpi_v1_admin_controller'
+require 'mno_enterprise/testing_support/shared_contexts/jpi_v1_admin_impac_controller'
 
 module MnoEnterprise
   describe Jpi::V1::Admin::Impac::DashboardTemplatesController, type: :controller do
-    # include MnoEnterprise::TestingSupport::JpiV1TestHelper
-    include MnoEnterprise::TestingSupport::SharedExamples::JpiV1Admin
-    render_views
-    routes { MnoEnterprise::Engine.routes }
-    before { request.env["HTTP_ACCEPT"] = 'application/json' }
+    include_context MnoEnterprise::Jpi::V1::Admin::BaseResourceController
 
-    RSpec.shared_context "#{described_class}: dashboard dependencies stubs" do
-      before do
-        api_stub_for(
-          get: "/users/#{user.id}/organizations",
-          response: from_api([org])
-        )
-        api_stub_for(
-          get: "/dashboards/#{template.id}/widgets",
-          response: from_api([widget])
-        )
-        api_stub_for(
-          get: "/dashboards/#{template.id}/kpis",
-          response: from_api([d_kpi])
-        )
-        api_stub_for(
-          get: "/widgets/#{widget.id}/kpis",
-          response: from_api([w_kpi])
-        )
-      end
+    include MnoEnterprise::TestingSupport::SharedContexts::JpiV1AdminImpacController
+    include_context 'MnoEnterprise::Jpi::V1::Admin::Impac' do
+      let(:dashboard) { template }
     end
 
-    let(:user) { build(:user, :admin, :with_organizations) }
-    let(:org) { build(:organization, users: [user]) }
-    let(:metadata) { { hist_parameters: { from: '2015-01-01', to: '2015-03-31', period: 'MONTHLY' } } }
     let(:template) { build(:impac_dashboard, dashboard_type: 'template', organization_ids: [org.uid], currency: 'EUR', settings: metadata, owner_type: nil, owner_id: nil, published: true) }
-    let(:widget) { build(:impac_widget, dashboard: template) }
-    let(:d_kpi) { build(:impac_kpi, dashboard: template) }
-    let(:w_kpi) { build(:impac_kpi, widget: widget) }
-
-    def hash_for_kpi(kpi)
-      {
-        "id" => kpi.id,
-        "element_watched" => kpi.element_watched,
-        "endpoint" => kpi.endpoint
-      }
-    end
-    let(:hash_for_widget) do
-      {
-        "id" => widget.id,
-        "name" => widget.name,
-        "endpoint" => widget.widget_category,
-        "width" => widget.width,
-        "kpis" => [hash_for_kpi(w_kpi)]
-      }
-    end
-    let(:hash_for_template) do
-      {
-        "id" => template.id,
-        "name" => template.name,
-        "full_name" => template.full_name,
-        "currency" => 'EUR',
-        "metadata" => metadata.deep_stringify_keys,
-        "data_sources" => [{ "id" => org.id, "uid" => org.uid, "label" => org.name}],
-        "kpis" => [hash_for_kpi(d_kpi)],
-        "widgets" => [hash_for_widget],
-        "published" => true
-      }
-    end
 
-    before do
-      api_stub_for(get: "/users/#{user.id}", response: from_api(user))
-      sign_in user
+    let(:hash_for_template) do
+      hash_for_dashboard.merge("published" => true)
     end
       
     describe '#index' do
@@ -94,26 +39,39 @@ module MnoEnterprise
 
     describe '#show' do
       subject { get :show, id: template.id }
-      
-      before do
-        api_stub_for(
-          get: "/dashboards/#{template.id}",
-          params: { filter: { 'dashboard_type' => 'template' } },
-          response: from_api(template)
-        )
-      end
-      include_context "#{described_class}: dashboard dependencies stubs"
 
-      it_behaves_like "a jpi v1 admin action"
-
-      it 'returns a dashboard template' do
-        subject
-        expect(JSON.parse(response.body)).to eq(hash_for_template)
-      end
-
-      # api_stub should be modified to allow this case to be stubbed
-      context 'when the template cannot be found' do
-        xit 'spec to be described'
+      context 'when the template exists' do
+        before do
+          api_stub_for(
+            get: "/dashboards/#{template.id}",
+            params: { filter: { 'dashboard_type' => 'template' } },
+            response: from_api(template)
+          )
+        end
+        include_context "#{described_class}: dashboard dependencies stubs"
+
+        it_behaves_like "a jpi v1 admin action"
+
+        it 'returns a dashboard template' do
+          subject
+          expect(JSON.parse(response.body)).to eq(hash_for_template)
+        end
+      end
+
+      context 'when the template does not exist' do
+        before do
+          api_stub_for(
+            get: "/dashboards/#{template.id}",
+            params: { filter: { 'dashboard_type' => 'template' } },
+            code: 404
+          )
+        end
+
+        it 'returns an error message' do
+          subject
+          expect(response).to have_http_status(:not_found)
+          expect(JSON.parse(response.body)).to eq({ 'errors' => { 'message' => 'Dashboard template not found' } })
+        end
       end
     end
 
@@ -130,25 +88,38 @@ module MnoEnterprise
       end
 
       subject { post :create, dashboard: template_params }
-      
-      before do
-        api_stub_for(
-          post: "/dashboards",
-          response: from_api(template)
-        )
-      end
-      include_context "#{described_class}: dashboard dependencies stubs"
 
-      it_behaves_like "a jpi v1 admin action"
+      context 'when the dashboard creation is successful' do
+        before do
+          api_stub_for(
+            post: "/dashboards",
+            response: from_api(template)
+          )
+        end
+        include_context "#{described_class}: dashboard dependencies stubs"
 
-      it 'returns a dashboard template' do
-        subject
-        expect(JSON.parse(response.body)).to eq(hash_for_template)
+        it_behaves_like "a jpi v1 admin action"
+
+        it 'returns a dashboard template' do
+          subject
+          expect(JSON.parse(response.body)).to eq(hash_for_template)
+        end
       end
 
-      # api_stub should be modified to allow this case to be stubbed
       context 'when the dashboard creation is unsuccessful' do
-        xit 'spec to be described'
+        before do
+          api_stub_for(
+            post: "/dashboards",
+            code: 400,
+            response: { errors: [{ attribute: "name", value: "can't be blank" }] }
+          )
+        end
+
+        it 'returns an error message' do
+          subject
+          expect(response).to have_http_status(:bad_request)
+          expect(JSON.parse(response.body)).to eq({ 'errors' => { 'name' => ["can't be blank"] } })
+        end
       end
     end
 
@@ -166,59 +137,100 @@ module MnoEnterprise
       end
 
       subject { put :update, id: template.id, dashboard: template_params }
-      
-      before do
-        api_stub_for(
-          get: "/dashboards/#{template.id}",
-          params: { filter: { 'dashboard_type' => 'template' } },
-          response: from_api(template)
-        )
-        api_stub_for(
-          put: "/dashboards/#{template.id}",
-          response: from_api(template)
-        )
-      end
-      include_context "#{described_class}: dashboard dependencies stubs"
-      
-      it_behaves_like "a jpi v1 admin action"
 
-      it 'returns a dashboard template' do
-        subject
-        expect(JSON.parse(response.body)).to eq(hash_for_template)
+      context 'when the template exists' do
+        before do
+          api_stub_for(
+            get: "/dashboards/#{template.id}",
+            params: { filter: { 'dashboard_type' => 'template' } },
+            response: from_api(template)
+          )
+          api_stub_for(
+            put: "/dashboards/#{template.id}",
+            response: from_api(template)
+          )
+        end
+        include_context "#{described_class}: dashboard dependencies stubs"
+
+        it_behaves_like "a jpi v1 admin action"
+
+        it 'returns a dashboard template' do
+          subject
+          expect(JSON.parse(response.body)).to eq(hash_for_template)
+        end
+      end
+
+      context 'when the template does not exist' do
+        before do
+          api_stub_for(
+            get: "/dashboards/#{template.id}",
+            params: { filter: { 'dashboard_type' => 'template' } },
+            code: 404
+          )
+        end
+
+        it 'returns an error message' do
+          subject
+          expect(response).to have_http_status(:not_found)
+          expect(JSON.parse(response.body)).to eq({ 'errors' => { 'message' => 'Dashboard template not found' } })
+        end
       end
 
-      # api_stub should be modified to allow these cases to be stubbed
-      context 'when the template cannot be found' do
-        xit 'spec to be described'
-      end
       context 'when the dashboard update is unsuccessful' do
-        xit 'spec to be described'
+        before do
+          api_stub_for(
+            get: "/dashboards/#{template.id}",
+            params: { filter: { 'dashboard_type' => 'template' } },
+            response: from_api(template)
+          )
+          api_stub_for(
+            put: "/dashboards/#{template.id}",
+            code: 400,
+            response: { errors: [{ attribute: "name", value: "can't be blank" }] }
+          )
+        end
+
+        it 'returns an error message' do
+          subject
+          expect(response).to have_http_status(:bad_request)
+          expect(JSON.parse(response.body)).to eq({ 'errors' => { 'name' => ["can't be blank"] } })
+        end
       end
     end
 
     describe '#destroy' do
       subject { delete :destroy, id: template.id }
 
-      before do
-        api_stub_for(
-          get: "/dashboards/#{template.id}",
-          params: { filter: { 'dashboard_type' => 'template' } },
-          response: from_api(template)
-        )
-        api_stub_for(
-          delete: "/dashboards/#{template.id}",
-          response: from_api(nil)
-        )
-      end
-      
-      it_behaves_like "a jpi v1 admin action"
-
-      # api_stub should be modified to allow these cases to be stubbed
-      context 'when the template cannot be found' do
-        xit 'spec to be described'
-      end
-      context 'when the dashboard destruction is unsuccessful' do
-        xit 'spec to be described'
+      context 'when the template exists' do
+        before do
+          api_stub_for(
+            get: "/dashboards/#{template.id}",
+            params: { filter: { 'dashboard_type' => 'template' } },
+            response: from_api(template)
+          )
+          api_stub_for(
+            delete: "/dashboards/#{template.id}",
+            response: from_api(nil)
+          )
+        end
+
+        it_behaves_like "a jpi v1 admin action"
+      end
+
+      context 'when the template does not exist' do
+        before do
+          api_stub_for(
+            get: "/dashboards/#{template.id}",
+            params: { filter: { 'dashboard_type' => 'template' } },
+            code: 404
+          )
+        end
+
+        it 'returns an error message' do
+          subject
+          expect(response).to have_http_status(:not_found)
+          expect(JSON.parse(response.body)).to eq({ 'errors' => { 'message' => 'Dashboard template not found' } })
+        end
       end
     end
   end