Beacon Configuration Admin View, with CRUD and Regenerate and Revoke Tokens Actions (#585)

Author: dmitrytrager

app/assets/tailwind/application.css

@@ -387,3 +387,49 @@ nav.pagy a.current {
 .help-text {
   @apply mt-2 text-xs text-gray-500 m-0;
 }
+
+/* Beacon Configuration Admin View styles */
+.beacon-online {
+    display: inline-block;
+    width: 10px;
+    height: 10px;
+    background-color: #10b981;
+    border-radius: 50%;
+    animation: pulse-green 2s infinite;
+}
+
+.beacon-online-large {
+  display: inline-block;
+  width: 16px;
+  height: 16px;
+  background-color: #10b981;
+  border-radius: 50%;
+  animation: pulse-green 2s infinite;
+}
+
+.beacon-offline {
+    display: inline-block;
+    width: 10px;
+    height: 10px;
+    background-color: #ef4444;
+    border-radius: 50%;
+}
+
+.beacon-offline-large {
+  display: inline-block;
+  width: 16px;
+  height: 16px;
+  background-color: #ef4444;
+  border-radius: 50%;
+}
+
+@keyframes pulse-green {
+    0%, 100% {
+      opacity: 1;
+      box-shadow: 0 0 0 0 rgba(16, 185, 129, 0.7);
+    }
+    50% {
+      opacity: 0.8;
+      box-shadow: 0 0 0 6px rgba(16, 185, 129, 0);
+    }
+}

app/controllers/application_controller.rb

@@ -20,4 +20,8 @@ def current_provider
     end
   end
   helper_method :current_provider
+
+  def non_contributor_redirect_path
+    topics_path
+  end
 end

app/controllers/beacons_controller.rb

@@ -0,0 +1,99 @@
+class BeaconsController < ApplicationController
+  include Authentication
+
+  before_action :set_beacon, only: %i[show edit update regenerate_key revoke_key]
+  before_action :prepare_associations, only: %i[new edit]
+
+  def index
+    @beacons = Beacon.order(created_at: :desc)
+  end
+
+  def new
+    @beacon = Beacon.new
+  end
+
+  def create
+    success, @beacon, api_key = Beacons::Creator.new.call(beacon_params)
+
+    if success
+      flash[:notice] = "Beacon was successfully provisioned. API Key: #{api_key}"
+      redirect_to beacon_path(@beacon, api_key: api_key)
+    else
+      prepare_associations
+      render :new, status: :unprocessable_entity
+    end
+  end
+
+  def show; end
+
+  def edit; end
+
+  def update
+    if @beacon.update(beacon_params)
+      redirect_to @beacon, notice: "Beacon was successfully updated."
+    else
+      prepare_associations
+      render :edit, status: :unprocessable_entity
+    end
+  end
+
+  def regenerate_key
+    _, api_key = Beacons::KeyRegenerator.new.call(@beacon)
+    flash[:notice] = "API key has been successfully regenerated. API Key: #{api_key}"
+    redirect_to beacon_path(@beacon, api_key: api_key)
+
+    rescue => StandardError
+      flash[:alert] = "API key could not be regenerated."
+      redirect_to @beacon
+  end
+
+  def filter_options
+    topics = if params[:language_id].present?
+      Topic.active.where(language_id: params[:language_id]).order(:title)
+    else
+      Topic.active.order(:title)
+    end
+
+    providers = if params[:region_id].present?
+      Provider.joins(:branches).where(branches: { region_id: params[:region_id] }).distinct.order(:name)
+    else
+      Provider.order(:name)
+    end
+
+    render json: {
+      topics: topics.select(:id, :title),
+      providers: providers.select(:id, :name),
+    }
+  end
+
+  def revoke_key
+    api_key = @beacon.revoke!
+    flash[:notice] = "API key has been successfully revoked."
+    redirect_to @beacon
+
+    rescue => StandardError
+      flash[:alert] = "API key could not be revoked."
+      redirect_to @beacon
+  end
+
+  def non_contributor_redirect_path
+    root_path
+  end
+
+  private
+
+  def set_beacon
+    @beacon = Beacon.find(params[:id])
+  end
+
+  def prepare_associations
+    @languages = Language.order(:name)
+    @providers = Provider.order(:name)
+    @regions = Region.order(:name)
+    @topics = Topic.active.order(:title)
+  end
+
+  def beacon_params
+    params.require(:beacon).permit(:name, :language_id, :region_id, provider_ids: [], topic_ids: [])
+  end
+end

app/controllers/concerns/authentication.rb

@@ -13,7 +13,7 @@ def allow_unauthenticated_access(**options)
   end
 
   def redirect_contributors
-    redirect_to topics_path unless Current.user.is_admin?
+    redirect_to non_contributor_redirect_path unless Current.user.is_admin?
   end
 
   private

app/javascript/controllers/beacon_form_controller.js

@@ -0,0 +1,51 @@
+import { Controller } from "@hotwired/stimulus"
+import { get } from "@rails/request.js"
+
+export default class extends Controller {
+  static targets = ["languageSelect", "regionSelect", "topicsSelect", "providersSelect"]
+  static values = { filterUrl: String }
+
+  connect() {
+    // Defer until select-tags children have initialized their TomSelect instances
+    requestAnimationFrame(() => this.fetchOptions())
+  }
+
+  fetchOptions() {
+    const params = new URLSearchParams()
+    const languageId = this.languageSelectTarget.value
+    const regionId = this.regionSelectTarget.value
+
+    if (languageId) params.set("language_id", languageId)
+    if (regionId) params.set("region_id", regionId)
+
+    get(`${this.filterUrlValue}?${params}`, { responseKind: "json" })
+      .then(response => response.json)
+      .then(data => {
+        this.#updateSelect(this.topicsSelectTarget, data.topics, "title")
+        this.#updateSelect(this.providersSelectTarget, data.providers, "name")
+      })
+  }
+
+  #updateSelect(selectElement, items, textKey) {
+    const tomSelect = selectElement.tomselect
+    if (!tomSelect) return
+
+    const previousValues = [].concat(tomSelect.getValue())
+
+    tomSelect.clear(true)
+    tomSelect.clearOptions()
+
+    items.forEach(item => {
+      tomSelect.addOption({ value: String(item.id), text: item[textKey] })
+    })
+
+    const stillValidValues = previousValues.filter(v =>
+      items.some(item => String(item.id) === v)
+    )
+    if (stillValidValues.length > 0) {
+      tomSelect.setValue(stillValidValues, true)
+    }
+
+    tomSelect.refreshOptions(false)
+  }
+}

app/javascript/controllers/beacons_controller.js

@@ -0,0 +1,24 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = ["button", "beaconApiKey"]
+
+  copyApiKey() {
+    const apiKey = this.beaconApiKeyTarget.textContent;
+    
+    navigator.clipboard.writeText(apiKey).then(() => {
+      const button = this.buttonTarget;
+      const originalText = button.textContent;
+      button.textContent = "Copied!";
+      button.classList.add("text-green-600");
+      
+      setTimeout(() => {
+        button.textContent = originalText;
+        button.classList.remove("text-green-600");
+      }, 2000);
+    }).catch(err => {
+      console.error("Failed to copy:", err);
+      alert("Failed to copy API key to clipboard");
+    });
+  }
+}

app/models/beacon.rb

@@ -38,6 +38,9 @@ class Beacon < ApplicationRecord
   has_many :beacon_topics, dependent: :destroy
   has_many :topics, through: :beacon_topics
 
+  delegate :name, to: :region, prefix: true
+  delegate :name, to: :language, prefix: true
+
   validates :name, presence: true
   validates :api_key_digest, presence: true, uniqueness: true
   validates :api_key_prefix, presence: true
@@ -53,6 +56,20 @@ def revoked?
     revoked_at.present?
   end
 
+  def status_str
+    revoked? ? "Revoked" : "Active"
+  end
+
+  # Get count of topics that match this beacon's configuration
+  def document_count
+    topics.count
+  end
+
+  # Get count of actual document files attached to matching topics
+  def file_count
+    topics.joins(:documents_attachments).count
+  end
+
   def accessible_blobs
     ActiveStorage::Blob
       .joins(:attachments)