(#127) Add API token to DB

lib/magpie/experiments/experiment.ex

@@ -8,6 +8,9 @@ defmodule Magpie.Experiments.Experiment do
     field :name, :string, null: false
     field :author, :string, null: false
 
+    # A randomly generated API token which the frontend should provide when interacting with the backend
+    field :api_token, :string, null: false
+
     # Note that the type :text is actually used for Postgres (specified in the migration file). It may not be valid for other databases. The description is potentially longer than varchar(255) limited by the default :string.
     field :description, :string
     field :active, :boolean, default: true, null: false

lib/magpie_web/templates/experiment/edit.html.eex

@@ -1,10 +1,11 @@
 <h1>Edit Experiment</h1>
 
 <p>
-  Please use the endpoints shown below when submitting/retrieving experiments:
+  Please refer to the following information when submitting/retrieving experiments:
 </p>
 
 <ul>
+  <li>API token: <code><%= @experiment.api_token %></code></li>
   <li>Submission: <code><%= get_endpoint_url(:submit, @experiment.id) %></code></li>
   <li>Dynamic retrieval: <code><%= get_endpoint_url(:retrieve_as_json, @experiment.id) %></code></li>
   <li>Socket endpoint for interactive experiments: <code><%= get_socket_url() %></code></li>

priv/repo/migrations/20210929031329_add_api_token_to_experiments.exs

@@ -0,0 +1,14 @@
+defmodule Magpie.Repo.Migrations.AddApiTokenToExperiments do
+  use Ecto.Migration
+
+  def change do
+    execute(
+      "CREATE EXTENSION IF NOT EXISTS \"pgcrypto\"",
+      "DROP EXTENSION IF EXISTS \"pgcrypto\""
+    )
+
+    alter table(:experiments) do
+      add :api_token, :string, null: false, default: fragment("md5(random()::text)")
+    end
+  end
+end