Application Rating & Review

api/app/assets/javascripts/mno_enterprise/config.js.coffee.erb

@@ -11,6 +11,7 @@ angular.module('mnoEnterprise.configuration', [])
   .constant('PRICING_CONFIG', <%= Hash(Settings.pricing).to_json %>)
   .constant('DOCK_CONFIG', <%= Hash(Settings.dock).to_json %>)
   .constant('DEVELOPER_SECTION_CONFIG', <%= Hash(Settings.developer).to_json %>)
+  .constant('REVIEWS_CONFIG', <%= Hash(Settings.reviews).to_json %>)
   .constant('GOOGLE_TAG_CONTAINER_ID', <%= MnoEnterprise.google_tag_container.to_json %>)
   .constant('INTERCOM_ID', <%= MnoEnterprise.intercom_app_id.to_json %>)
   .constant('APP_NAME', <%= MnoEnterprise.app_name.to_json %>)

api/app/controllers/mno_enterprise/jpi/v1/admin/app_reviews_controller.rb

@@ -0,0 +1,32 @@
+module MnoEnterprise
+  class Jpi::V1::Admin::AppReviewsController < Jpi::V1::Admin::BaseResourceController
+    # GET /mnoe/jpi/v1/admin/app_reviews
+    def index
+      @app_reviews = MnoEnterprise::AppReview
+      @app_reviews = @app_reviews.limit(params[:limit]) if params[:limit]
+      @app_reviews = @app_reviews.skip(params[:offset]) if params[:offset]
+      @app_reviews = @app_reviews.order_by(params[:order_by]) if params[:order_by]
+      @app_reviews = @app_reviews.where(params[:where]) if params[:where]
+      @app_reviews = @app_reviews.all.fetch
+      response.headers['X-Total-Count'] = @app_reviews.metadata[:pagination][:count]
+    end
+
+    # GET /mnoe/jpi/v1/admin/app_reviews/1
+    def show
+      @app_review = MnoEnterprise::AppReview.find(params[:id])
+    end
+
+
+    # PATCH /mnoe/jpi/v1/admin/app_reviews/1
+    def update
+      @app_review = MnoEnterprise::AppReview.find(params[:id])
+      @app_review.update(app_review_params)
+      render :show
+    end
+
+    def app_review_params
+      params.require(:app_review).permit(:status)
+    end
+
+  end
+end

api/app/controllers/mno_enterprise/jpi/v1/app_reviews_controller.rb

@@ -0,0 +1,34 @@
+module MnoEnterprise
+  class Jpi::V1::AppReviewsController < Jpi::V1::BaseResourceController
+    # GET /mnoe/jpi/v1/marketplace/:id/app_reviews
+    def index
+      @app_reviews = MnoEnterprise::AppReview.approved.where(reviewable_id: params[:id])
+      @app_reviews = @app_reviews.limit(params[:limit]) if params[:limit]
+      @app_reviews = @app_reviews.skip(params[:offset]) if params[:offset]
+      @app_reviews = @app_reviews.order_by(params[:order_by]) if params[:order_by]
+      @app_reviews = @app_reviews.where(params[:where]) if params[:where]
+      @app_reviews = @app_reviews.all.fetch
+      response.headers['X-Total-Count'] = @app_reviews.metadata[:pagination][:count]
+    end
+
+    # POST /mnoe/jpi/v1/marketplace/:id/app_reviews
+    def create
+      @app = MnoEnterprise::App.find(params[:id])
+      return render json: "could not find App #{params[:id]}", status: :not_found unless @app
+
+      # TODO: use the has_many associations -> @app.reviews.build
+      @app_review = MnoEnterprise::AppReview.new(review_params(@app.id))
+      if @app_review.save
+        @average_rating = @app.reload.average_rating
+        render :show
+      else
+        render json: @app_review.errors, status: :bad_request
+      end
+    end
+
+    def review_params(app_id)
+      params.require(:app_review).permit(:rating, :description, :organization_id)
+        .merge(app_id: app_id, user_id: current_user.id)
+    end
+  end
+end

api/app/views/mno_enterprise/jpi/v1/admin/app_reviews/_app_review.json.jbuilder

@@ -0,0 +1,12 @@
+json.id app_review.id
+json.rating app_review.rating
+json.description app_review.description
+json.status app_review.status
+json.app_id app_review.app_id
+json.app_name app_review.app_name
+json.user_id app_review.user_id
+json.user_name app_review.user_name
+json.organization_id app_review.organization_id
+json.organization_name app_review.organization_name
+json.created_at app_review.created_at
+json.updated_at app_review.updated_at

api/app/views/mno_enterprise/jpi/v1/admin/app_reviews/index.json.jbuilder

@@ -0,0 +1 @@
+json.app_reviews @app_reviews, partial: 'app_review', as: :app_review

api/app/views/mno_enterprise/jpi/v1/admin/app_reviews/show.json.jbuilder

@@ -0,0 +1,3 @@
+json.app_review do
+  json.partial! 'app_review', app_review: @app_review
+end

api/app/views/mno_enterprise/jpi/v1/app_reviews/_resource.json.jbuilder

@@ -0,0 +1,12 @@
+json.id app_review[:id]
+json.rating app_review[:rating]
+json.description app_review[:description]
+json.status app_review[:status]
+json.user_id app_review[:user_id]
+json.user_name app_review[:user_name]
+json.organization_id app_review[:organization_id]
+json.organization_name app_review[:organization_name]
+json.app_id app_review[:app_id]
+json.app_name app_review[:app_name]
+json.created_at app_review[:created_at]
+json.updated_at app_review[:updated_at]

api/app/views/mno_enterprise/jpi/v1/app_reviews/index.json.jbuilder

@@ -0,0 +1,6 @@
+json.app_reviews do
+  json.array! @app_reviews do |app_review|
+    json.partial! 'resource', app_review: app_review
+  end
+end
+

api/app/views/mno_enterprise/jpi/v1/app_reviews/show.json.jbuilder

@@ -0,0 +1,4 @@
+json.app_review do
+  json.partial! 'resource', app_review: @app_review
+end
+json.average_rating @average_rating

api/app/views/mno_enterprise/jpi/v1/marketplace/_app.json.jbuilder

@@ -10,6 +10,7 @@ json.is_coming_soon app.coming_soon?
 json.single_billing app.single_billing?
 json.multi_instantiable app.multi_instantiable
 json.subcategories app.subcategories
+json.average_rating app.average_rating
 
 if app.logo
   json.logo app.logo.to_s

api/app/views/mno_enterprise/jpi/v1/marketplace/index.json.jbuilder

@@ -1,4 +1,2 @@
-json.cache! ['v1', 'marketplace'], expires_in: 20.minutes do
-  json.categories @categories
-  json.apps @apps, partial: 'app', as: :app
-end
+json.categories @categories
+json.apps @apps, partial: 'app', as: :app

api/app/views/mno_enterprise/jpi/v1/marketplace/show.json.jbuilder

@@ -1,3 +1,3 @@
 json.app do
   json.partial! 'app', app: @app
-end
+end

api/config/routes.rb

@@ -91,7 +91,11 @@
   #============================================================
   namespace :jpi do
     namespace :v1 do
-      resources :marketplace, only: [:index, :show]
+      resources :marketplace, only: [:index, :show] do
+        member do
+          resources :app_reviews, only: [:index, :create]
+        end
+      end
       resource :current_user, only: [:show, :update] do
         put :update_password
         put :register_developer
@@ -150,6 +154,7 @@
       namespace :admin, defaults: {format: 'json'} do
         resources :audit_events, only: [:index]
         resources :app_instances, only: [:destroy], shallow: true
+        resources :app_reviews, only: [:index, :show,  :update]
         resources :users, only: [:index, :show, :destroy, :update, :create] do
           collection do
             get :count

api/spec/controllers/mno_enterprise/jpi/v1/admin/app_reviews_controller_spec.rb

@@ -0,0 +1,102 @@
+require 'rails_helper'
+
+module MnoEnterprise
+  include MnoEnterprise::TestingSupport::SharedExamples::JpiV1Admin
+
+  describe Jpi::V1::Admin::AppReviewsController, type: :controller do
+    render_views
+    routes { MnoEnterprise::Engine.routes }
+    before { request.env['HTTP_ACCEPT'] = 'application/json' }
+    let(:user) { build(:user, :admin, :with_organizations) }
+    let(:app_review) { build(:app_review, user: user) }
+    before do
+      api_stub_for(get: '/app_reviews', response: from_api([app_review]))
+      api_stub_for(get: "/app_reviews/#{app_review.id}", response: from_api(app_review))
+      api_stub_for(get: "/users/#{user.id}", response: from_api(user))
+      sign_in user
+    end
+
+    def partial_hash_for_app_review(app_review)
+      {
+        'id' => app_review.id,
+        'rating' => app_review.rating,
+        'description' => app_review.description,
+        'status' => app_review.status,
+        'app_id' => app_review.app_id,
+        'app_name' => app_review.app_name,
+        'user_id' => app_review.user_id,
+        'user_name' => app_review.user_name,
+        'organization_id' => app_review.organization_id,
+        'organization_name' => app_review.organization_name,
+        'created_at' => app_review.created_at,
+        'updated_at' => app_review.updated_at,
+      }
+    end
+
+    def hash_for_app_review(app_review)
+      {
+        'app_review' => partial_hash_for_app_review(app_review)
+      }
+    end
+
+    def hash_for_app_reviews(app_reviews)
+      {
+        'app_reviews' => app_reviews.map { |o| partial_hash_for_app_review(o) }
+      }
+    end
+
+
+    describe '#index' do
+      subject { get :index }
+
+      it_behaves_like "a jpi v1 admin action"
+
+      context 'success' do
+        before { subject }
+
+        it 'returns a list of app_review' do
+          expect(response).to be_success
+          expect(JSON.parse(response.body)).to eq(JSON.parse(hash_for_app_reviews([app_review]).to_json))
+        end
+      end
+    end
+
+    describe 'GET #show' do
+      subject { get :show, id: app_review.id }
+
+      it_behaves_like "a jpi v1 admin action"
+
+      context 'success' do
+        before { subject }
+
+        it 'returns a complete description of the app_review' do
+          expect(response).to be_success
+          expect(JSON.parse(response.body)).to eq(JSON.parse(hash_for_app_review(app_review).to_json))
+        end
+      end
+    end
+
+
+    describe 'PUT #update' do
+      subject { put :update, id: app_review.id, app_review: {status: 'rejected'} }
+
+      before do
+        sign_in user
+        api_stub_for(put: "/app_reviews/#{app_review.id}", response: -> { app_review.status = 'rejected'; from_api(app_review) })
+      end
+
+      it_behaves_like "a jpi v1 admin action"
+
+      context 'success' do
+        before { subject }
+
+        it { expect(response).to be_success }
+
+        # Test that the app_review is updated by testing the api endpoint was called
+        it { expect(app_review.status).to eq('rejected') }
+      end
+    end
+
+
+  end
+end

api/spec/controllers/mno_enterprise/jpi/v1/app_reviews_controller_spec.rb

@@ -0,0 +1,75 @@
+require 'rails_helper'
+
+module MnoEnterprise
+  describe Jpi::V1::AppReviewsController, type: :controller do
+    include MnoEnterprise::TestingSupport::JpiV1TestHelper
+    render_views
+    routes { MnoEnterprise::Engine.routes }
+    before { request.env["HTTP_ACCEPT"] = 'application/json' }
+
+
+    #===============================================
+    # Assignments
+    #===============================================
+    let(:user) { build(:user) }
+    before { api_stub_for(get: "/users/#{user.id}", response: from_api(user)) }
+    before { sign_in user }
+
+    let(:app) { build(:app) }
+    let(:app_review) { build(:app_review) }
+    let(:expected_hash_for_review) do
+      attrs = %w(id rating description status user_id user_name organization_id organization_name app_id app_name)
+      app_review.attributes.slice(*attrs).merge({'created_at' => app_review.created_at.as_json, 'updated_at' => app_review.updated_at.as_json})
+    end
+    let(:expected_hash_for_reviews) do
+      {
+        'app_reviews' => [expected_hash_for_review],
+        # 'metadata' => {'pagination' => {'count' => 1}}
+      }
+    end
+
+    before do
+      api_stub_for(get: "/apps/#{app.id}", response: from_api(app))
+    end
+
+    describe 'GET #index' do
+
+      before do
+        api_stub_for(get: "/app_reviews?filter[reviewable_id]=#{app.id}", response: from_api([app_review]))
+      end
+
+      subject { get :index, id: app.id }
+
+      it_behaves_like "jpi v1 protected action"
+
+      it_behaves_like "a paginated action"
+
+      it 'renders the list of reviews' do
+        subject
+        expect(JSON.parse(response.body)).to eq(expected_hash_for_reviews)
+      end
+    end
+
+    describe 'POST #create', focus: true do
+      let(:params) { {organization_id: 1, description: 'A Review', rating: 5, foo: 'bar'} }
+      let(:app_review) { build(:app_review) }
+
+      before do
+        api_stub_for(post: "/app_reviews", response: from_api(app_review))
+        api_stub_for(get: "/app_reviews/#{app_review.id}", response: from_api(app_review))
+      end
+
+      subject { post :create, id: app.id, app_review: params }
+
+      it_behaves_like "jpi v1 protected action"
+
+      it 'renders the new review' do
+        expect(JSON.parse(subject.body)).to include('app_review' => expected_hash_for_review)
+      end
+
+      it 'renders the new average rating' do
+        expect(JSON.parse(subject.body)).to include('average_rating' => app.average_rating)
+      end
+    end
+  end
+end

api/spec/controllers/mno_enterprise/jpi/v1/marketplace_controller_spec.rb

@@ -37,7 +37,7 @@ def partial_hash_for_app(app)
         'rank' => app.rank,
         'multi_instantiable' => app.multi_instantiable,
         'subcategories' => app.subcategories,
-
+        'average_rating' => app.average_rating,
       }
     end
 
@@ -73,10 +73,7 @@ def hash_for_apps(apps)
           )
         end
 
-        it 'is successful' do
-          subject
-          expect(response).to be_success
-        end
+        it { is_expected.to be_success }
 
         it 'returns the right response' do
           subject
@@ -90,10 +87,7 @@ def hash_for_apps(apps)
           api_stub_for(get: '/apps', response: from_api([app]))
         end
 
-        it 'is successful' do
-          subject
-          expect(response).to be_success
-        end
+        it { is_expected.to be_success }
 
         it 'returns the right response' do
           subject
@@ -106,10 +100,7 @@ def hash_for_apps(apps)
       before { api_stub_for(get: "/apps/#{app.id}", response: from_api(app)) }
       subject { get :show, id: app.id }
 
-      it 'is successful' do
-        subject
-        expect(response).to be_success
-      end
+      it { is_expected.to be_success }
 
       it 'returns the right response' do
         subject
@@ -129,10 +120,7 @@ def hash_for_apps(apps)
           api_stub_for(get: '/apps', response: from_api([app1,app2]))
         end
 
-        it 'is successful' do
-          subject
-          expect(response).to be_success
-        end
+        it { is_expected.to be_success }
 
         it 'returns the right response' do
           subject