Implement model solution tokens

Author: nygrenh

app/controllers/api/v8/organizations/courses/exercises_controller.rb

@@ -81,7 +81,20 @@ def show
             course = organization.courses.find_by!(name: params[:course_name]) unless course
             ex = course.exercises.find_by!(name: params[:name])
             authorize! :read, ex
-            present({
+
+            model_solution_token_used_on_this_exercise = tokens_used = ModelSolutionTokenUsed.where(user: current_user, course: course, exercise_name: ex.name).count > 0
+
+            total_model_solution_tokens = 0
+            grant_model_solution_token_every_nth_completed_exercise = course.grant_model_solution_token_every_nth_completed_exercise
+            if grant_model_solution_token_every_nth_completed_exercise && grant_model_solution_token_every_nth_completed_exercise > 0
+              completed_exercises_count = course.submissions.where(all_tests_passed: true, user: current_user).distinct.select(:exercise_name).count
+              total_model_solution_tokens = completed_exercises_count / grant_model_solution_token_every_nth_completed_exercise
+
+              tokens_used = ModelSolutionTokenUsed.where(user: current_user, course: course).count
+              available_model_solution_tokens = total_model_solution_tokens - tokens_used
+            end
+
+            present(
               id: ex.id,
               available_points: ex.available_points,
               name: ex.name,
@@ -90,8 +103,14 @@ def show
               soft_deadline: ex.soft_deadline_for(current_user),
               expired: ex.expired_for?(current_user),
               disabled: ex.disabled?,
-              completed: ex.completed_by?(current_user)
-            })
+              completed: ex.completed_by?(current_user),
+              model_solution_token_used_on_this_exercise: model_solution_token_used_on_this_exercise,
+              course: {
+                grant_model_solution_token_every_nth_completed_exercise: grant_model_solution_token_every_nth_completed_exercise,
+                total_model_solution_tokens: total_model_solution_tokens,
+                available_model_solution_tokens: available_model_solution_tokens,
+              }
+            )
           end
 
           def download

app/controllers/application_controller.rb

@@ -128,6 +128,10 @@ def unauthorize_guest!(message = 'Authentication required')
       unauthorized!(message) if current_user.guest?
     end
 
+    def only_admins!
+      unauthorized! unless current_user.administrator?
+    end
+
     def authorization_skip!
       authorize! :read, nil
     end

app/controllers/model_solution_token_useds_controller.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class ModelSolutionTokenUsedsController < ApplicationController
+  before_action :set_model_solution_token_used, only: [:show, :edit, :update, :destroy]
+  before_action :only_admins
+
+  # GET /model_solution_token_useds
+  def index
+    @model_solution_token_useds = ModelSolutionTokenUsed.all
+  end
+
+  # GET /model_solution_token_useds/1
+  def show
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_model_solution_token_used
+      @model_solution_token_used = ModelSolutionTokenUsed.find(params[:id])
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def model_solution_token_used_params
+      params.require(:model_solution_token_used).permit(:user_id, :course_id, :exercise_name)
+    end
+end

app/models/model_solution_token_used.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class ModelSolutionTokenUsed < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :course
+
+  validates :exercise_name, presence: true
+end

app/views/model_solution_token_useds/index.html.erb

@@ -0,0 +1,31 @@
+<p id="notice"><%= notice %></p>
+
+<h1>Listing Model Solution Token Useds</h1>
+
+<table>
+  <thead>
+    <tr>
+      <th>User</th>
+      <th>Course</th>
+      <th>Exercise name</th>
+      <th colspan="3"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @model_solution_token_useds.each do |model_solution_token_used| %>
+      <tr>
+        <td><%= model_solution_token_used.user %></td>
+        <td><%= model_solution_token_used.course %></td>
+        <td><%= model_solution_token_used.exercise_name %></td>
+        <td><%= link_to 'Show', model_solution_token_used %></td>
+        <td><%= link_to 'Edit', edit_model_solution_token_used_path(model_solution_token_used) %></td>
+        <td><%= link_to 'Destroy', model_solution_token_used, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<br>
+
+<%= link_to 'New Model solution token used', new_model_solution_token_used_path %>

app/views/model_solution_token_useds/show.html.erb

@@ -0,0 +1,19 @@
+<p id="notice"><%= notice %></p>
+
+<p>
+  <strong>User:</strong>
+  <%= @model_solution_token_used.user %>
+</p>
+
+<p>
+  <strong>Course:</strong>
+  <%= @model_solution_token_used.course %>
+</p>
+
+<p>
+  <strong>Exercise name:</strong>
+  <%= @model_solution_token_used.exercise_name %>
+</p>
+
+<%= link_to 'Edit', edit_model_solution_token_used_path(@model_solution_token_used) %> |
+<%= link_to 'Back', model_solution_token_useds_path %>

config/routes.rb

@@ -289,6 +289,8 @@
 
   resources :status, only: [:index]
 
+  resources :model_solution_token_useds, only: [:index, :show]
+
   if SiteSetting.value('pghero_enabled')
     constraints CanAccessPgHero do
       mount PgHero::Engine, at: 'pghero'

db/migrate/20181213161532_add_grant_model_solution_token_every_nth_completed_exercise_to_course.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddGrantModelSolutionTokenEveryNthCompletedExerciseToCourse < ActiveRecord::Migration
+  def change
+    add_column :courses, :grant_model_solution_token_every_nth_completed_exercise, :integer, null: true
+  end
+end

db/migrate/20181213163959_create_model_solution_token_useds.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CreateModelSolutionTokenUseds < ActiveRecord::Migration
+  def change
+    create_table :model_solution_token_useds do |t|
+      t.references :user, index: true, foreign_key: true
+      t.references :course, index: true, foreign_key: true
+      t.string :exercise_name
+
+      t.timestamps null: false
+    end
+  end
+end

db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20181003140911) do
+ActiveRecord::Schema.define(version: 20181213161532) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -94,29 +94,30 @@
     t.datetime "created_at"
     t.datetime "updated_at"
     t.datetime "hide_after"
-    t.boolean  "hidden",                                   default: false, null: false
-    t.integer  "cached_version",                           default: 0,     null: false
+    t.boolean  "hidden",                                                  default: false, null: false
+    t.integer  "cached_version",                                          default: 0,     null: false
     t.string   "spreadsheet_key"
     t.datetime "hidden_if_registered_after"
     t.datetime "refreshed_at"
-    t.boolean  "locked_exercise_points_visible",           default: true,  null: false
+    t.boolean  "locked_exercise_points_visible",                          default: true,  null: false
     t.text     "description"
     t.string   "paste_visibility"
     t.string   "formal_name"
-    t.boolean  "certificate_downloadable",                 default: false, null: false
+    t.boolean  "certificate_downloadable",                                default: false, null: false
     t.string   "certificate_unlock_spec"
     t.integer  "organization_id"
-    t.integer  "disabled_status",                          default: 1
+    t.integer  "disabled_status",                                         default: 1
     t.string   "title"
     t.string   "material_url"
-    t.integer  "course_template_id",                                       null: false
-    t.boolean  "hide_submission_results",                  default: false
+    t.integer  "course_template_id",                                                      null: false
+    t.boolean  "hide_submission_results",                                 default: false
     t.string   "external_scoreboard_url"
-    t.boolean  "initial_refresh_ready",                    default: false
-    t.boolean  "hide_submissions",                         default: false, null: false
-    t.boolean  "model_solution_visible_before_completion", default: false, null: false
-    t.float    "soft_deadline_point_multiplier",           default: 0.75,  null: false
-    t.boolean  "code_review_requests_enabled",             default: true,  null: false
+    t.boolean  "initial_refresh_ready",                                   default: false
+    t.boolean  "hide_submissions",                                        default: false, null: false
+    t.boolean  "model_solution_visible_before_completion",                default: false, null: false
+    t.float    "soft_deadline_point_multiplier",                          default: 0.75,  null: false
+    t.boolean  "code_review_requests_enabled",                            default: true,  null: false
+    t.integer  "grant_model_solution_token_every_nth_completed_exercise"
   end
 
   add_index "courses", ["organization_id"], name: "index_courses_on_organization_id", using: :btree
@@ -181,7 +182,7 @@
 
   add_index "migrated_submissions", ["from_course_id", "to_course_id", "original_submission_id", "new_submission_id"], name: "unique_values", unique: true, using: :btree
 
-  create_table "model_solution_access_log", force: :cascade do |t|
+  create_table "model_solution_access_logs", force: :cascade do |t|
     t.integer  "user_id",       null: false
     t.integer  "course_id",     null: false
     t.string   "exercise_name", null: false