katalyst-koi 4.15.0 → 4.16.0

data/app/controllers/admin/admin_users_controller.rb

@@ -77,7 +77,7 @@ module Admin
     end
 
     def admin_user_params
-      params.require(:admin).permit(:name, :email, :password, :archived)
+      params.expect(admin: %i[name email password archived])
     end
 
     class Collection < Admin::Collection

data/app/controllers/admin/credentials_controller.rb

@@ -64,7 +64,7 @@ module Admin
     private
 
     def credential_params
-      params.require(:admin_credential).permit(:nickname, :response)
+      params.expect(admin_credential: %i[nickname response])
     end
 
     def set_admin_user

data/app/controllers/admin/otps_controller.rb

@@ -36,7 +36,7 @@ module Admin
     private
 
     def otp_params
-      params.require(:admin).permit(:otp_secret, :token)
+      params.expect(admin: %i[otp_secret token])
     end
 
     def set_admin_user

data/app/controllers/admin/sessions_controller.rb

@@ -102,7 +102,7 @@ module Admin
     end
 
     def session_params
-      params.require(:admin).permit(:email, :password, :token, :response)
+      params.expect(admin: %i[email password token response])
     end
 
     def update_last_sign_in(admin_user)

data/app/controllers/admin/url_rewrites_controller.rb

@@ -52,7 +52,7 @@ module Admin
     private
 
     def url_rewrite_params
-      params.require(:url_rewrite).permit(:from, :to, :status_code, :active)
+      params.expect(url_rewrite: %i[from to status_code active])
     end
 
     def set_url_rewrite

data/app/controllers/admin/well_knowns_controller.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Admin
+  class WellKnownsController < ApplicationController
+    before_action :set_well_known, only: %i[show edit update destroy]
+
+    def index
+      collection = Collection.new.with_params(params).apply(::WellKnown.strict_loading.all)
+
+      render locals: { collection: }
+    end
+
+    def show
+      render locals: { well_known: @well_known }
+    end
+
+    def new
+      render locals: { well_known: ::WellKnown.new }
+    end
+
+    def edit
+      render locals: { well_known: @well_known }
+    end
+
+    def create
+      @well_known = ::WellKnown.new(well_known_params)
+
+      if @well_known.save
+        redirect_to [:admin, @well_known], status: :see_other
+      else
+        render :new, locals: { well_known: @well_known }, status: :unprocessable_content
+      end
+    end
+
+    def update
+      if @well_known.update(well_known_params)
+        redirect_to action: :show, status: :see_other
+      else
+        render :edit, locals: { well_known: @well_known }, status: :unprocessable_content
+      end
+    end
+
+    def destroy
+      @well_known.destroy!
+
+      redirect_to action: :index, status: :see_other
+    end
+
+    private
+
+    # Only allow a list of trusted parameters through.
+    def well_known_params
+      params.expect(well_known: %i[name purpose content_type content])
+    end
+
+    # Use callbacks to share common setup or constraints between actions.
+    def set_well_known
+      @well_known = ::WellKnown.find(params[:id])
+    end
+
+    class Collection < Admin::Collection
+      config.sorting  = :name
+      config.paginate = true
+
+      attribute :name, :string
+      attribute :purpose, :string
+      attribute :content_type, :string
+      attribute :content, :string
+    end
+  end
+end

data/app/controllers/well_knowns_controller.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class WellKnownsController < ApplicationController
+  before_action :set_well_known
+
+  def show
+    render renderable: @well_known
+  end
+
+  private
+
+  def set_well_known
+    @well_known = WellKnown.find_by!(name: params[:name])
+  end
+end

data/app/models/well_known.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class WellKnown < ApplicationRecord
+  CONTENT_TYPES = {
+    text: "text/plain",
+    json: "application/json",
+  }.freeze
+
+  enum :content_type, CONTENT_TYPES
+
+  validates :name, :purpose, :content_type, presence: true
+  validates :name, uniqueness: { case_sensitive: true }
+
+  scope :admin_search, ->(query) do
+    where(arel_table[:name].matches("%#{query}%"))
+  end
+
+  def render_in(view_context)
+    view_context.render(plain: content)
+  end
+
+  def format
+    content_type.to_sym
+  end
+end

data/app/views/admin/otps/_form.html.erb

@@ -15,7 +15,8 @@
     <ol class="flow">
       <li>Install an MFA app. Most password managers support MFA.</li>
       <li>Scan this code using your mobile device or password manager:<br>
-        <%== RQRCode::QRCode.new(admin.otp.provisioning_uri(admin.email)).as_svg(
+        <% otp_app_name = t("koi.auth.otp_app_name", host: URI.parse(root_url).host, email: admin.email) %>
+        <%== RQRCode::QRCode.new(admin.otp.provisioning_uri(otp_app_name)).as_svg(
                color:           "000",
                shape_rendering: "crispEdges",
                module_size:     3,

data/app/views/admin/well_knowns/_fields.html.erb

@@ -0,0 +1,6 @@
+<%= form.govuk_text_field :name %>
+<%= form.govuk_text_field :purpose %>
+<%= form.govuk_collection_radio_buttons(
+      :content_type, WellKnown::CONTENT_TYPES, :first, :second, small: true
+    ) %>
+<%= form.govuk_text_area :content %>

data/app/views/admin/well_knowns/edit.html.erb

@@ -0,0 +1,12 @@
+<% content_for :header do %>
+  <%= render(Koi::Header::EditComponent.new(resource: well_known)) %>
+<% end %>
+
+<%= form_with(model: well_known, url: admin_well_known_path(well_known)) do |form| %>
+  <%= render "fields", form: %>
+
+  <div class="actions">
+    <%= form.admin_save %>
+    <%= form.admin_delete %>
+  </div>
+<% end %>

data/app/views/admin/well_knowns/index.html.erb

@@ -0,0 +1,15 @@
+<% content_for :header do %>
+  <%= render(Koi::Header::IndexComponent.new(model: WellKnown)) do |component| %>
+    <% component.with_action "New", new_admin_well_known_path %>
+  <% end %>
+<% end %>
+
+<%= table_query_with(collection:) %>
+
+<%= table_with(collection:) do |row| %>
+  <% row.select %>
+  <% row.link :name %>
+  <% row.text :purpose %>
+<% end %>
+
+<%= table_pagination_with(collection:) %>

data/app/views/admin/well_knowns/new.html.erb

@@ -0,0 +1,11 @@
+<% content_for :header do %>
+  <%= render(Koi::Header::NewComponent.new(model: WellKnown)) %>
+<% end %>
+
+<%= form_with(model: well_known, url: admin_well_knowns_path) do |form| %>
+  <%= render "fields", form: %>
+
+  <div class="actions">
+    <%= form.admin_save %>
+  </div>
+<% end %>

data/app/views/admin/well_knowns/show.html.erb

@@ -0,0 +1,19 @@
+<% content_for :header do %>
+  <%= render(Koi::Header::ShowComponent.new(resource: well_known)) %>
+<% end %>
+
+<h2>Summary</h2>
+
+<%= summary_table_with(model: well_known) do |row| %>
+  <% row.link :name %>
+  <% row.text :purpose %>
+  <% row.text :content_type %>
+  <% row.text :content %>
+<% end %>
+
+<div class="actions">
+  <%= button_to "Delete", admin_well_known_path(well_known),
+                class:  "button button--secondary",
+                method: :delete,
+                form:   { data: { turbo_confirm: "Are you sure?" } } %>
+</div>

data/config/locales/koi.en.yml

@@ -9,6 +9,7 @@ en:
       admin: "%e %B %Y"
   koi:
     auth:
+      otp_app_name: "%{host}/admin"
       token_invalid: "Token invalid or consumed already"
       token_consumed: "Please create a password or passkey"
     labels:

data/config/routes.rb

@@ -7,7 +7,6 @@ Rails.application.routes.draw do
       resources :tokens, param: :token, only: %i[show update], token: /[^\/]+/
     end
 
-    resources :url_rewrites
     resources :admin_users do
       resources :credentials, only: %i[new create destroy]
       resource :otp, only: %i[new create destroy]
@@ -19,6 +18,8 @@ Rails.application.routes.draw do
 
     resource :cache, only: %i[destroy]
     resource :dashboard, only: %i[show]
+    resources :well_knowns
+    resources :url_rewrites
 
     root to: redirect("admin/dashboard")
   end
@@ -28,4 +29,6 @@ Rails.application.routes.draw do
     mount Katalyst::Navigation::Engine, at: "navigation"
     mount Flipper::UI.app(Flipper) => "flipper" if Object.const_defined?("Flipper::UI")
   end
+
+  resources :well_knowns, path: ".well-known", param: :name, only: %i[show], name: /[^\/]+/
 end

data/db/migrate/20250204060748_create_well_knowns.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class CreateWellKnowns < ActiveRecord::Migration[8.0]
+  def change
+    create_table :well_knowns do |t|
+      t.string :name, index: { unique: true }
+      t.string :purpose
+      t.string :content_type
+      t.string :content
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/koi/admin_controller/templates/controller.rb.tt

@@ -50,9 +50,9 @@ class <%= controller_class_name %>Controller < ApplicationController
   # Only allow a list of trusted parameters through.
   def <%= "#{singular_table_name}_params" %>
     <%- if attributes_names.empty? -%>
-    params.fetch(:<%= singular_table_name %>, {})
+    params.expect(<%= singular_table_name %>: [])
     <%- else -%>
-    params.require(:<%= singular_table_name %>).permit(<%= permitted_params %>)
+    params.expect(<%= singular_table_name %>: [<%= permitted_params %>])
     <%- end -%>
   end
 

data/lib/generators/koi/admin_route/templates/initializer.rb.tt

@@ -9,4 +9,5 @@ Koi::Menu.modules = {
 Koi::Menu.advanced = {
   "Admin Users"  => "/admin/admin_users",
   "URL Rewriter" => "/admin/url_rewrites",
+  "Well Knowns"  => "/admin/well_knowns",
 }

data/spec/factories/well_knowns.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :well_known do
+    name { Faker::Internet.base64 }
+    purpose { Faker::Lorem.sentence }
+    content_type { :text }
+    content { Faker::Internet.base64 }
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-koi
 version: !ruby/object:Gem::Version
-  version: 4.15.0
+  version: 4.16.0
 platform: ruby
 authors:
 - Katalyst Interactive
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-16 00:00:00.000000000 Z
+date: 2025-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -234,7 +233,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.5'
-description: 
 email:
 - developers@katalyst.com.au
 executables: []
@@ -375,11 +373,13 @@ files:
 - app/controllers/admin/sessions_controller.rb
 - app/controllers/admin/tokens_controller.rb
 - app/controllers/admin/url_rewrites_controller.rb
+- app/controllers/admin/well_knowns_controller.rb
 - app/controllers/concerns/koi/controller/has_admin_users.rb
 - app/controllers/concerns/koi/controller/has_attachments.rb
 - app/controllers/concerns/koi/controller/has_webauthn.rb
 - app/controllers/concerns/koi/controller/is_admin_controller.rb
 - app/controllers/concerns/koi/controller/json_web_token.rb
+- app/controllers/well_knowns_controller.rb
 - app/helpers/koi/application_helper.rb
 - app/helpers/koi/date_helper.rb
 - app/helpers/koi/definition_list_helper.rb
@@ -394,6 +394,7 @@ files:
 - app/models/concerns/koi/model/archivable.rb
 - app/models/concerns/koi/model/otp.rb
 - app/models/url_rewrite.rb
+- app/models/well_known.rb
 - app/views/admin/admin_users/_fields.html+self.erb
 - app/views/admin/admin_users/_fields.html.erb
 - app/views/admin/admin_users/archived.html.erb
@@ -425,6 +426,11 @@ files:
 - app/views/admin/url_rewrites/index.html.erb
 - app/views/admin/url_rewrites/new.html.erb
 - app/views/admin/url_rewrites/show.html.erb
+- app/views/admin/well_knowns/_fields.html.erb
+- app/views/admin/well_knowns/edit.html.erb
+- app/views/admin/well_knowns/index.html.erb
+- app/views/admin/well_knowns/new.html.erb
+- app/views/admin/well_knowns/show.html.erb
 - app/views/katalyst/content/asides/_aside.html+form.erb
 - app/views/katalyst/content/columns/_column.html+form.erb
 - app/views/katalyst/content/contents/_content.html+form.erb
@@ -465,6 +471,7 @@ files:
 - db/migrate/20230602033610_add_archived_to_admin_users.rb
 - db/migrate/20231211005214_add_status_code_to_url_rewrites.rb
 - db/migrate/20241214060913_add_otp_secret_to_admin_users.rb
+- db/migrate/20250204060748_create_well_knowns.rb
 - db/seeds.rb
 - lib/generators/koi/active_record/active_record_generator.rb
 - lib/generators/koi/admin/USAGE
@@ -504,12 +511,12 @@ files:
 - lib/koi/release.rb
 - spec/factories/admins.rb
 - spec/factories/url_rewrites.rb
+- spec/factories/well_knowns.rb
 homepage: https://github.com/katalyst/koi
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -524,8 +531,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Koi CMS admin framework
 test_files: []