rails_api_keys-ui 0.2.0

data/app/views/rails_api_keys/ui/api_keys/_form_modal.html.erb

@@ -0,0 +1,49 @@
+<div data-modal-target="modal"
+     data-action="keydown@window->modal#closeOnEscape"
+     class="hidden fixed inset-0 z-50 overflow-y-auto">
+  <div class="flex items-center justify-center min-h-screen px-4">
+    <div data-modal-target="backdrop"
+         data-action="click->modal#closeOnBackdropClick"
+         class="fixed inset-0 bg-gray-500 bg-opacity-75 transition-opacity"></div>
+    <div data-modal-target="panel"
+         class="relative bg-white rounded-lg shadow-xl max-w-md w-full p-6 z-10">
+      <div class="flex justify-between items-center mb-4">
+        <h3 class="text-lg font-medium text-gray-900"><%= title %></h3>
+        <button type="button"
+                data-action="click->modal#close"
+                class="text-gray-400 hover:text-gray-500">
+          ×
+        </button>
+      </div>
+      <%= form_with url: create_path, scope: :api_key, class: "space-y-4" do |f| %>
+        <div>
+          <%= f.label :name, t("rails_api_keys_ui.api_keys.form.name"), class: "block text-sm font-medium text-gray-700 mb-2" %>
+          <%= f.text_field :name, required: true, class: "form-input w-full border-gray-300 rounded-md shadow-sm", placeholder: t("rails_api_keys_ui.api_keys.form.name_placeholder") %>
+        </div>
+        <div>
+          <%= f.label :permission, t("rails_api_keys_ui.api_keys.form.permission"), class: "block text-sm font-medium text-gray-700 mb-2" %>
+          <%= f.select :permission,
+                       options_for_select(
+                         [
+                           [ t("rails_api_keys_ui.api_keys.form.permission_read"), "read" ],
+                           [ t("rails_api_keys_ui.api_keys.form.permission_read_write"), "read_write" ]
+                         ],
+                         "read"
+                       ),
+                       {},
+                       required: true,
+                       class: "form-input w-full border-gray-300 rounded-md shadow-sm" %>
+        </div>
+        <div class="flex justify-end space-x-3 pt-4">
+          <button type="button"
+                  data-action="click->modal#close"
+                  class="inline-flex items-center px-4 py-2 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50">
+            <%= t("rails_api_keys_ui.api_keys.cancel") %>
+          </button>
+          <%= f.submit t("rails_api_keys_ui.api_keys.form.submit"),
+                       class: "inline-flex items-center px-4 py-2 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-primary-600 hover:bg-primary-700 cursor-pointer" %>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/rails_api_keys/ui/api_keys/_list.html.erb

@@ -0,0 +1,28 @@
+<% if api_keys.any? %>
+  <div class="space-y-3">
+    <% api_keys.each do |api_key| %>
+      <div class="flex flex-col gap-3 p-4 border border-gray-200 rounded-lg sm:flex-row sm:items-center sm:justify-between">
+        <div>
+          <p class="text-sm font-medium text-gray-900"><%= api_key.name %></p>
+          <p class="mt-1 text-sm text-gray-500 font-mono"><%= api_key.token_display_prefix %>…</p>
+          <p class="mt-1 text-xs text-gray-400">
+            <%= t("rails_api_keys_ui.api_keys.permission_#{api_key.permission}") %>
+            ·
+            <% if api_key.last_used_at.present? %>
+              <%= t("rails_api_keys_ui.api_keys.last_used", time: l(api_key.last_used_at, format: :short)) %>
+            <% else %>
+              <%= t("rails_api_keys_ui.api_keys.never_used") %>
+            <% end %>
+          </p>
+        </div>
+        <%= button_to t("rails_api_keys_ui.api_keys.revoke"),
+                      destroy_path.respond_to?(:call) ? destroy_path.call(api_key) : destroy_path,
+                      method: :delete,
+                      class: "inline-flex items-center px-3 py-2 border border-red-300 rounded-md shadow-sm text-sm font-medium text-red-700 bg-white hover:bg-red-50",
+                      data: { turbo_confirm: t("rails_api_keys_ui.api_keys.revoke_confirm") } %>
+      </div>
+    <% end %>
+  </div>
+<% else %>
+  <p class="text-sm text-gray-500"><%= t("rails_api_keys_ui.api_keys.empty") %></p>
+<% end %>

data/app/views/rails_api_keys/ui/api_keys/_panel.html.erb

@@ -0,0 +1,27 @@
+<%= rails_api_keys_ui_stylesheet %>
+<div class="rails-api-keys-ui">
+  <div class="bg-white shadow rounded-lg p-6">
+    <div class="mb-6 flex flex-col gap-3 sm:flex-row sm:items-start sm:justify-between">
+      <div>
+        <h2 class="text-lg font-medium text-gray-900"><%= t("rails_api_keys_ui.api_keys.title") %></h2>
+        <p class="mt-1 text-sm text-gray-500"><%= t("rails_api_keys_ui.api_keys.description") %></p>
+      </div>
+      <div data-controller="modal">
+        <button type="button"
+                data-action="click->modal#open"
+                class="inline-flex items-center px-3 py-2 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-primary-600 hover:bg-primary-700">
+          <%= t("rails_api_keys_ui.api_keys.new") %>
+        </button>
+        <%= render "rails_api_keys/ui/api_keys/form_modal", create_path: create_path, title: t("rails_api_keys_ui.api_keys.new") %>
+      </div>
+    </div>
+
+    <%= render "rails_api_keys/ui/api_keys/list", api_keys: api_keys, destroy_path: destroy_path %>
+  </div>
+
+  <% if raw_token.present? %>
+    <div data-controller="modal" data-modal-open-on-connect-value="true">
+      <%= render "rails_api_keys/ui/api_keys/reveal_modal", raw_token: raw_token %>
+    </div>
+  <% end %>
+</div>

data/app/views/rails_api_keys/ui/api_keys/_reveal_modal.html.erb

@@ -0,0 +1,48 @@
+<div data-modal-target="modal"
+     data-action="keydown@window->modal#closeOnEscape"
+     class="fixed inset-0 z-50 overflow-y-auto">
+  <div class="flex items-center justify-center min-h-screen px-4">
+    <div data-modal-target="backdrop"
+         data-action="click->modal#closeOnBackdropClick"
+         class="fixed inset-0 bg-gray-500 bg-opacity-75 transition-opacity"></div>
+    <div data-modal-target="panel"
+         class="relative bg-white rounded-lg shadow-xl max-w-md w-full p-6 z-10">
+      <div class="flex justify-between items-center mb-4">
+        <h3 class="text-lg font-medium text-gray-900"><%= t("rails_api_keys_ui.api_keys.reveal.title") %></h3>
+        <button type="button"
+                data-action="click->modal#close"
+                class="text-gray-400 hover:text-gray-500">
+          ×
+        </button>
+      </div>
+      <p class="text-sm text-amber-700 bg-amber-50 border border-amber-200 rounded-md p-3 mb-4">
+        <%= t("rails_api_keys_ui.api_keys.reveal.warning") %>
+      </p>
+      <div data-controller="clipboard" class="space-y-3">
+        <label class="block text-sm font-medium text-gray-700"><%= t("rails_api_keys_ui.api_keys.reveal.token") %></label>
+        <div class="flex gap-2">
+          <input type="text"
+                 readonly
+                 data-clipboard-target="source"
+                 value="<%= raw_token %>"
+                 class="form-input font-mono text-sm flex-1 border-gray-300 rounded-md shadow-sm">
+          <button type="button"
+                  data-action="click->clipboard#copy"
+                  class="inline-flex items-center px-3 py-2 border border-gray-300 rounded-md shadow-sm text-sm font-medium text-gray-700 bg-white hover:bg-gray-50">
+            <%= t("rails_api_keys_ui.api_keys.reveal.copy") %>
+          </button>
+        </div>
+        <p data-clipboard-target="feedback" class="hidden text-sm text-primary-600">
+          <%= t("rails_api_keys_ui.api_keys.reveal.copied") %>
+        </p>
+      </div>
+      <div class="flex justify-end pt-6">
+        <button type="button"
+                data-action="click->modal#close"
+                class="inline-flex items-center px-4 py-2 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-primary-600 hover:bg-primary-700">
+          <%= t("rails_api_keys_ui.api_keys.reveal.done") %>
+        </button>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/rails_api_keys/ui/api_keys/index.html.erb

@@ -0,0 +1,5 @@
+<%= rails_api_keys_ui_panel(
+      api_keys: @api_keys,
+      create_path: url_for(action: :create),
+      destroy_path: ->(api_key) { url_for(action: :destroy, id: api_key) }
+    ) %>

data/config/locales/en.yml

@@ -0,0 +1,42 @@
+en:
+  rails_api_keys_ui:
+    api_keys:
+      title: "API keys"
+      description: "Create personal API keys for integrations."
+      new: "Create API key"
+      empty: "No API keys yet."
+      revoke: "Revoke"
+      revoke_confirm: "Revoke this API key? Integrations using it will stop working."
+      never_used: "Never used"
+      last_used: "Last used %{time}"
+      permission_read: "Read"
+      permission_read_write: "Read & write"
+      cancel: "Cancel"
+      form:
+        name: "Name"
+        name_placeholder: "e.g. Zapier production"
+        permission: "Permission"
+        permission_read: "Read"
+        permission_read_write: "Read & write"
+        submit: "Create API key"
+      reveal:
+        title: "Your new API key"
+        warning: "Copy this key now. You will not be able to see it again."
+        token: "API key"
+        copy: "Copy"
+        copied: "Copied to clipboard"
+        done: "Done"
+  # Lazy lookup scopes for engine controller (`t(".created")` / `t(".revoked")`)
+  rails_api_keys:
+    ui:
+      api_keys:
+        create:
+          created: "API key created. Copy it now — it won’t be shown again."
+        destroy:
+          revoked: "API key revoked."
+  # Lazy lookup when host subclasses as ApiKeysController
+  api_keys:
+    create:
+      created: "API key created. Copy it now — it won’t be shown again."
+    destroy:
+      revoked: "API key revoked."

data/config/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+RailsApiKeys::UI::Engine.routes.draw do
+end

data/lib/generators/rails_api_keys_ui/controllers/controllers_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module RailsApiKeysUi
+  module Generators
+    class ControllersGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Copy rails_api_keys-ui controller into the host app"
+
+      def copy_controller
+        template "api_keys_controller.rb.tt", "app/controllers/api_keys_controller.rb"
+      end
+    end
+  end
+end

data/lib/generators/rails_api_keys_ui/controllers/templates/api_keys_controller.rb.tt

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class ApiKeysController < RailsApiKeys::UI::ApiKeysController
+  # Customize authorization or owner resolution here.
+  #
+  # Example (nested under employees):
+  #
+  #   before_action :set_employee
+  #   before_action :authorize_employee_api_keys!
+  #
+  #   private
+  #
+  #   def set_employee
+  #     @employee = Employee.find(params[:employee_id])
+  #   end
+  #
+  #   def authorize_employee_api_keys!
+  #     authorize @employee, :show_api_keys?
+  #   end
+end

data/lib/generators/rails_api_keys_ui/install/install_generator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module RailsApiKeysUi
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Install rails_api_keys-ui (initializer + optional Stimulus controllers)"
+
+      def copy_initializer
+        template "initializer.rb.tt", "config/initializers/rails_api_keys_ui.rb"
+      end
+
+      def copy_stimulus_controllers
+        return unless yes?("Copy example Stimulus modal/clipboard controllers into the host app?")
+
+        copy_file "javascript/modal_controller.js", "app/javascript/controllers/modal_controller.js"
+        copy_file "javascript/clipboard_controller.js", "app/javascript/controllers/clipboard_controller.js"
+      end
+
+      def show_readme
+        say <<~MSG
+
+          rails_api_keys-ui installed.
+
+          1. Draw routes, for example:
+
+               resources :employees do
+                 rails_api_keys_ui owner: :current_user, controller: "api_keys"
+               end
+
+               rails_api_keys_ui owner: :company, path: "company/api_keys"
+
+          2. Views expect Stimulus controllers registered as `modal` and `clipboard`
+             (open/close + openOnConnect; copy from source target). Skip the copy
+             step above if your app already has compatible controllers.
+
+          3. The panel inlines a scoped stylesheet by default. Override brand colors
+             with --rak-ui-primary-600 / --rak-ui-primary-700 on .rails-api-keys-ui,
+             or set config.include_stylesheet = false if you style it yourself.
+
+          4. Optional: rails generate rails_api_keys_ui:controllers
+                       rails generate rails_api_keys_ui:views
+                       rails generate rails_api_keys_ui:locales
+
+        MSG
+      end
+    end
+  end
+end

data/lib/generators/rails_api_keys_ui/install/templates/initializer.rb.tt

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# RailsApiKeys::UI.configure do |config|
+#   # config.parent_controller = "ApplicationController"
+#   # config.current_owner = ->(controller) { controller.current_user }
+#   # config.policy_class = "RailsApiKeys::UI::ApiKeyPolicy"
+#   # config.raw_token_flash_key = :rails_api_keys_raw_token
+#   # config.include_stylesheet = true # false if the host already styles the panel
+#   # config.authorize = ->(controller, action, record) { ... }
+# end

data/lib/generators/rails_api_keys_ui/install/templates/javascript/clipboard_controller.js

@@ -0,0 +1,19 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = ["source", "feedback"]
+
+  async copy() {
+    const value = this.sourceTarget.value
+    try {
+      await navigator.clipboard.writeText(value)
+    } catch (_error) {
+      this.sourceTarget.select()
+      document.execCommand("copy")
+    }
+
+    if (this.hasFeedbackTarget) {
+      this.feedbackTarget.classList.remove("hidden")
+    }
+  }
+}

data/lib/generators/rails_api_keys_ui/install/templates/javascript/modal_controller.js

@@ -0,0 +1,43 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = ["modal", "backdrop", "panel"]
+  static values = { openOnConnect: Boolean }
+
+  connect() {
+    if (this.openOnConnectValue) {
+      this.open()
+      return
+    }
+
+    if (this.hasModalTarget) {
+      this.modalTarget.classList.add("hidden")
+    }
+  }
+
+  open() {
+    if (this.hasModalTarget) {
+      this.modalTarget.classList.remove("hidden")
+      document.body.classList.add("overflow-hidden")
+    }
+  }
+
+  close() {
+    if (this.hasModalTarget) {
+      this.modalTarget.classList.add("hidden")
+      document.body.classList.remove("overflow-hidden")
+    }
+  }
+
+  closeOnBackdropClick(event) {
+    if (event.target === this.backdropTarget) {
+      this.close()
+    }
+  }
+
+  closeOnEscape(event) {
+    if (event.key === "Escape") {
+      this.close()
+    }
+  }
+}

data/lib/generators/rails_api_keys_ui/locales/locales_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module RailsApiKeysUi
+  module Generators
+    class LocalesGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../../config/locales", __dir__)
+
+      desc "Copy rails_api_keys-ui locale files into the host app"
+
+      def copy_locales
+        copy_file "en.yml", "config/locales/rails_api_keys_ui.en.yml"
+      end
+    end
+  end
+end

data/lib/generators/rails_api_keys_ui/views/views_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module RailsApiKeysUi
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../../app/views/rails_api_keys/ui", __dir__)
+
+      desc "Copy rails_api_keys-ui views into the host app for editing"
+
+      def copy_views
+        directory "api_keys", "app/views/rails_api_keys/ui/api_keys"
+      end
+    end
+  end
+end

data/lib/rails_api_keys/ui/configuration.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RailsApiKeys
+  module UI
+    # Host overrides. Set via {RailsApiKeys::UI.configure}.
+    class Configuration
+      attr_accessor :parent_controller,
+                    :current_owner,
+                    :authorize,
+                    :policy_class,
+                    :raw_token_flash_key,
+                    :include_stylesheet
+
+      def initialize
+        @parent_controller = "ApplicationController"
+        @current_owner = ->(controller) { controller.current_user }
+        @authorize = nil
+        @policy_class = "RailsApiKeys::UI::ApiKeyPolicy"
+        @raw_token_flash_key = :rails_api_keys_raw_token
+        @include_stylesheet = true
+      end
+    end
+  end
+end

data/lib/rails_api_keys/ui/engine.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "rails_api_keys/ui/route_mapper"
+
+module RailsApiKeys
+  module UI
+    class Engine < ::Rails::Engine
+      isolate_namespace RailsApiKeys::UI
+
+      initializer "rails_api_keys_ui.inflections", before: :set_autoload_paths do
+        ActiveSupport::Inflector.inflections(:en) do |inflect|
+          inflect.acronym "UI"
+        end
+      end
+
+      initializer "rails_api_keys_ui.routes", before: :add_routing_paths do
+        ActionDispatch::Routing::Mapper.include(RailsApiKeys::UI::RouteMapper)
+      end
+
+      initializer "rails_api_keys_ui.helpers" do
+        ActiveSupport.on_load(:action_controller_base) do
+          helper_path = RailsApiKeys::UI::Engine.root.join("app/helpers/rails_api_keys/ui/api_keys_helper.rb")
+          require helper_path.to_s unless defined?(RailsApiKeys::UI::ApiKeysHelper)
+          helper RailsApiKeys::UI::ApiKeysHelper
+        end
+      end
+
+      initializer "rails_api_keys_ui.assets" do |app|
+        next unless app.config.respond_to?(:assets)
+
+        app.config.assets.paths << root.join("app/javascript")
+        app.config.assets.paths << root.join("app/assets/stylesheets")
+        if app.config.assets.respond_to?(:precompile)
+          app.config.assets.precompile << "rails_api_keys/ui.css"
+        end
+      end
+    end
+  end
+end

data/lib/rails_api_keys/ui/mount_registry.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RailsApiKeys
+  module UI
+    # Stores per-draw-helper options (owner resolution, authorize, etc.).
+    # Route defaults only carry the mount name; procs live here.
+    class MountRegistry
+      def initialize
+        @mounts = {}
+      end
+
+      def register(name, options)
+        @mounts[name.to_s] = options.dup
+      end
+
+      def fetch(name)
+        @mounts.fetch(name.to_s) do
+          raise KeyError, "Unknown rails_api_keys_ui mount #{name.inspect}. " \
+                          "Did routes reload without re-registering?"
+        end
+      end
+
+      def clear!
+        @mounts.clear
+      end
+    end
+  end
+end

data/lib/rails_api_keys/ui/route_mapper.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RailsApiKeys
+  module UI
+    # Adds +rails_api_keys_ui+ to the host routes DSL.
+    module RouteMapper
+      # Draws +index+/+create+/+destroy+ API key routes for one owner mount.
+      #
+      # @param options [Hash]
+      # @option options [Symbol, String, Proc] :owner key owner resolution
+      #   (:current_user, :company, or callable)
+      # @option options [Proc] :authorize optional per-mount authorize override
+      # @option options [String] :controller host or engine controller
+      # @option options [String] :path URL path segment (default "api_keys")
+      # @option options [String, Symbol] :name mount registry key
+      def rails_api_keys_ui(options = {})
+        opts = options.dup
+        mount_name = (opts.delete(:name) || default_rails_api_keys_ui_mount_name).to_s
+        owner = opts.key?(:owner) ? opts.delete(:owner) : :current_user
+        authorize = opts.delete(:authorize)
+        controller = opts.delete(:controller) || "rails_api_keys/ui/api_keys"
+        path = opts.delete(:path) || "api_keys"
+        as = opts.delete(:as)
+
+        RailsApiKeys::UI.mounts.register(
+          mount_name,
+          owner: owner,
+          authorize: authorize
+        )
+
+        resource_options = {
+          only: %i[index create destroy],
+          controller: controller,
+          path: path,
+          defaults: { rails_api_keys_ui_mount: mount_name }
+        }
+        resource_options[:as] = as if as
+
+        resources :api_keys, **resource_options, **opts
+      end
+
+      private
+
+      def default_rails_api_keys_ui_mount_name
+        scope = @scope
+        parts = []
+        parts << scope[:module] if scope[:module]
+        parts << scope[:as] if scope[:as]
+        parts << scope[:path] if scope[:path].present? && scope[:path] != "/"
+        parts << "api_keys"
+        parts.compact.join("_").gsub(%r{[/\-]}, "_").gsub(/__+/, "_")
+      end
+    end
+  end
+end

data/lib/rails_api_keys/ui/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RailsApiKeys
+  module UI
+    VERSION = "0.2.0"
+  end
+end

data/lib/rails_api_keys/ui.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "rails_api_keys"
+require "rails_api_keys/ui/version"
+require "rails_api_keys/ui/configuration"
+require "rails_api_keys/ui/mount_registry"
+
+ActiveSupport::Inflector.inflections(:en) do |inflect|
+  inflect.acronym "UI"
+end
+
+require "rails_api_keys/ui/engine"
+
+module RailsApiKeys
+  # HTML/JSON management UI for {RailsApiKeys::ApiKey}.
+  module UI
+    class << self
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield configuration
+      end
+
+      def reset_configuration!
+        @configuration = Configuration.new
+      end
+
+      def mounts
+        @mounts ||= MountRegistry.new
+      end
+
+      def reset_mounts!
+        mounts.clear!
+      end
+    end
+  end
+end

data/lib/rails_api_keys_ui.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "rails_api_keys/ui"