tiny_admin 0.9.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de3ed265839998db96c8e220f1b66576a8a37325e0726f3597e0b1ef315087a4
-  data.tar.gz: 828309ff8139a11c3e73fcbeb82ffea7f752191e5c4e99e9dc19fbaa29a2180e
+  metadata.gz: 78ceeba34bc5a1b4fffa887569b3ac5100a0465c5acad499a0c6ffd2c400694b
+  data.tar.gz: dc60d171c117f7f480895838e4b70b89439d7ab650c15ed27425c08468f92f79
 SHA512:
-  metadata.gz: 3648b175fd028a82bc7c3ae35fc51d3380a4d22fc6dd38dfd5da5ed375d94b4b45358b36c17c955482574756700bd2889ba57348e4ed3453491e2112c9d1471f
-  data.tar.gz: 4ea2a1301b70a3b88e07829e5755976482d22b2f18c1752ab7b7626e93b19b20527a7944c9da634fdf92a4bed53cf20d56c1e7e6738bc8c3b519de4147cd810b
+  metadata.gz: 2d1c6fd794ae0e1662cfc6dbe8a5d2c6881213681755fabccc52a88b74ac8109c74d72db5bb172e22f530523f2ec151c998f628c2c53d59163c429fde83af9ee
+  data.tar.gz: 0f3fb8db4c1dda2cac93f3bda4fa2cbbac3fa0b8ee4b7b31cd09b2ce0ccbe8ed25f8d2e55315673973a9d6e8fc25571ad30eba70bfbdc13aff51f41ed12d981e

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/tiny_admin.svg)](https://badge.fury.io/rb/tiny_admin)
 [![Gem Downloads](https://badgen.net/rubygems/dt/tiny_admin)](https://rubygems.org/gems/tiny_admin)
 [![Linters](https://github.com/blocknotes/tiny_admin/actions/workflows/linters.yml/badge.svg)](https://github.com/blocknotes/tiny_admin/actions/workflows/linters.yml)
-[![Specs](https://github.com/blocknotes/tiny_admin/actions/workflows/specs.yml/badge.svg)](https://github.com/blocknotes/tiny_admin/actions/workflows/specs.yml)
+[![Specs](https://github.com/blocknotes/tiny_admin/actions/workflows/tests.yml/badge.svg)](https://github.com/blocknotes/tiny_admin/actions/workflows/tests.yml)
 
 A compact and composable dashboard component for Ruby.
 
@@ -19,7 +19,7 @@ Please ⭐ if you like it.
 
 ## Install
 
-- Add to your Gemfile: `gem 'tiny_admin', '~> 0.9'`
+- Add to your Gemfile: `gem 'tiny_admin', '~> 0.10'`
 - Mount the app in a route (check some examples with: Hanami, Rails, Roda and standalone in [extra](extra))
   + in Rails, update _config/routes.rb_: `mount TinyAdmin::Router => '/admin'`
 - Configure the dashboard using `TinyAdmin.configure` and/or `TinyAdmin.configure_from_file` with a YAML config file (see [configuration](#configuration) below):
@@ -43,6 +43,12 @@ Plugins available:
 
 - **NoAuth**: no authentication.
 
+### Authorization
+
+Plugins available:
+
+- **Authorization**: base class to provide an authorization per action, the host application should inherit from it and override the class method `allowed?`.
+
 ### Repository
 
 Plugin available:
@@ -134,6 +140,10 @@ authentication:
   password: 'f1891cea80fc05e433c943254c6bdabc159577a02a7395dfebbfbc4f7661d4af56f2d372131a45936de40160007368a56ef216a30cb202c66d3145fd24380906'
 ```
 
+`authorization_class` (String): a plugin class to use;
+
+> 📚 [Wiki Authentication page](https://github.com/blocknotes/tiny_admin/wiki/Authorization) available
+
 `sections` (Array of hashes): define the admin sections, properties:
 
 - `slug` (String): section reference identifier;

data/lib/tiny_admin/actions/index.rb

@@ -58,12 +58,12 @@ module TinyAdmin
         end
       end
 
-      def setup_pagination(page, pagination_component_class, total_count:)
+      def setup_pagination(page, pagination_component, total_count:)
         @pages = (total_count / pagination.to_f).ceil
-        return if pages <= 1 || !pagination_component_class
+        return if pages <= 1 || !pagination_component
 
         attributes = { current: current_page, pages: pages, query_string: query_string, total_count: total_count }
-        page.pagination_component = pagination_component_class.new
+        page.pagination_component = pagination_component.new
         page.pagination_component.update_attributes(attributes)
       end
     end

data/lib/tiny_admin/plugins/authorization.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module TinyAdmin
+  module Plugins
+    class Authorization
+      class << self
+        def allowed?(_user, _action, _param = nil)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/tiny_admin/router.rb

@@ -53,37 +53,45 @@ module TinyAdmin
       render(inline: page.call)
     end
 
-    def root_route(router)
-      if TinyAdmin.settings.root[:redirect]
-        router.redirect route_for(TinyAdmin.settings.root[:redirect])
+    def root_route(req)
+      if authorization.allowed?(current_user, :root)
+        if TinyAdmin.settings.root[:redirect]
+          req.redirect route_for(TinyAdmin.settings.root[:redirect])
+        else
+          page_class = to_class(TinyAdmin.settings.root[:page])
+          attributes = TinyAdmin.settings.root.slice(:content, :title, :widgets)
+          render_page prepare_page(page_class, attributes: attributes, params: request.params)
+        end
       else
-        page_class = to_class(TinyAdmin.settings.root[:page])
-        attributes = TinyAdmin.settings.root.slice(:content, :title, :widgets)
-        render_page prepare_page(page_class, attributes: attributes, params: request.params)
+        render_page prepare_page(TinyAdmin.settings.page_not_allowed)
       end
     end
 
-    def setup_page_route(router, slug, page_data)
-      router.get slug do
-        attributes = page_data.slice(:content, :title, :widgets)
-        render_page prepare_page(page_data[:class], slug: slug, attributes: attributes, params: request.params)
+    def setup_page_route(req, slug, page_data)
+      req.get slug do
+        if authorization.allowed?(current_user, :page, slug)
+          attributes = page_data.slice(:content, :title, :widgets)
+          render_page prepare_page(page_data[:class], slug: slug, attributes: attributes, params: request.params)
+        else
+          render_page prepare_page(TinyAdmin.settings.page_not_allowed)
+        end
       end
     end
 
-    def setup_resource_routes(router, slug, options:)
-      router.on slug do
-        setup_collection_routes(router, slug, options: options)
-        setup_member_routes(router, slug, options: options)
+    def setup_resource_routes(req, slug, options:)
+      req.on slug do
+        setup_collection_routes(req, slug, options: options)
+        setup_member_routes(req, slug, options: options)
       end
     end
 
-    def setup_collection_routes(router, slug, options:)
+    def setup_collection_routes(req, slug, options:)
       repository = options[:repository].new(options[:model])
       action_options = options[:index] || {}
 
       # Custom actions
       custom_actions = setup_custom_actions(
-        router,
+        req,
         options[:collection_actions],
         options: action_options,
         repository: repository,
@@ -92,28 +100,32 @@ module TinyAdmin
 
       # Index
       if options[:only].include?(:index) || options[:only].include?('index')
-        router.is do
-          context = Context.new(
-            actions: custom_actions,
-            repository: repository,
-            request: request,
-            router: router,
-            slug: slug
-          )
-          index_action = TinyAdmin::Actions::Index.new
-          render_page index_action.call(app: self, context: context, options: action_options)
+        req.is do
+          if authorization.allowed?(current_user, :resource_index, slug)
+            context = Context.new(
+              actions: custom_actions,
+              repository: repository,
+              request: request,
+              router: req,
+              slug: slug
+            )
+            index_action = TinyAdmin::Actions::Index.new
+            render_page index_action.call(app: self, context: context, options: action_options)
+          else
+            render_page prepare_page(TinyAdmin.settings.page_not_allowed)
+          end
         end
       end
     end
 
-    def setup_member_routes(router, slug, options:)
+    def setup_member_routes(req, slug, options:)
       repository = options[:repository].new(options[:model])
       action_options = (options[:show] || {}).merge(record_not_found_page: TinyAdmin.settings.record_not_found)
 
-      router.on String do |reference|
+      req.on String do |reference|
         # Custom actions
         custom_actions = setup_custom_actions(
-          router,
+          req,
           options[:member_actions],
           options: action_options,
           repository: repository,
@@ -123,42 +135,54 @@ module TinyAdmin
 
         # Show
         if options[:only].include?(:show) || options[:only].include?('show')
-          router.is do
-            context = Context.new(
-              actions: custom_actions,
-              reference: reference,
-              repository: repository,
-              request: request,
-              router: router,
-              slug: slug
-            )
-            show_action = TinyAdmin::Actions::Show.new
-            render_page show_action.call(app: self, context: context, options: action_options)
+          req.is do
+            if authorization.allowed?(current_user, :resource_show, slug)
+              context = Context.new(
+                actions: custom_actions,
+                reference: reference,
+                repository: repository,
+                request: request,
+                router: req,
+                slug: slug
+              )
+              show_action = TinyAdmin::Actions::Show.new
+              render_page show_action.call(app: self, context: context, options: action_options)
+            else
+              render_page prepare_page(TinyAdmin.settings.page_not_allowed)
+            end
           end
         end
       end
     end
 
-    def setup_custom_actions(router, custom_actions, options:, repository:, slug:, reference: nil)
+    def setup_custom_actions(req, custom_actions = nil, options:, repository:, slug:, reference: nil)
       (custom_actions || []).each_with_object({}) do |custom_action, result|
         action_slug, action = custom_action.first
         action_class = to_class(action)
 
-        router.get action_slug.to_s do
-          context = Context.new(
-            actions: {},
-            reference: reference,
-            repository: repository,
-            request: request,
-            router: router,
-            slug: slug
-          )
-          custom_action = action_class.new
-          render_page custom_action.call(app: self, context: context, options: options)
+        req.get action_slug.to_s do
+          if authorization.allowed?(current_user, :custom_action, action_slug.to_s)
+            context = Context.new(
+              actions: {},
+              reference: reference,
+              repository: repository,
+              request: request,
+              router: req,
+              slug: slug
+            )
+            custom_action = action_class.new
+            render_page custom_action.call(app: self, context: context, options: options)
+          else
+            render_page prepare_page(TinyAdmin.settings.page_not_allowed)
+          end
         end
 
         result[action_slug.to_s] = action_class
       end
     end
+
+    def authorization
+      TinyAdmin.settings.authorization_class
+    end
   end
 end

data/lib/tiny_admin/settings.rb

@@ -7,6 +7,7 @@ module TinyAdmin
     DEFAULTS = {
       %i[authentication plugin] => Plugins::NoAuth,
       %i[authentication login] => Views::Pages::SimpleAuthLogin,
+      %i[authorization_class] => Plugins::Authorization,
       %i[components field_value] => Views::Components::FieldValue,
       %i[components flash] => Views::Components::Flash,
       %i[components head] => Views::Components::Head,
@@ -14,6 +15,7 @@ module TinyAdmin
       %i[components pagination] => Views::Components::Pagination,
       %i[content_page] => Views::Pages::Content,
       %i[helper_class] => Support,
+      %i[page_not_allowed] => Views::Pages::PageNotAllowed,
       %i[page_not_found] => Views::Pages::PageNotFound,
       %i[record_not_found] => Views::Pages::RecordNotFound,
       %i[repository] => Plugins::ActiveRecordRepository,
@@ -25,10 +27,12 @@ module TinyAdmin
 
     OPTIONS = %i[
       authentication
+      authorization_class
       components
       content_page
       extra_styles
       helper_class
+      page_not_allowed
       page_not_found
       record_not_found
       repository

data/lib/tiny_admin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TinyAdmin
-  VERSION = '0.9.0'
+  VERSION = '0.10.1'
 end

data/lib/tiny_admin/views/actions/index.rb

@@ -4,9 +4,16 @@ module TinyAdmin
   module Views
     module Actions
       class Index < DefaultLayout
-        attr_accessor :actions, :fields, :filters, :links, :pagination_component, :prepare_record, :records, :slug
+        attr_accessor :actions,
+                      :fields,
+                      :filters,
+                      :links,
+                      :pagination_component,
+                      :prepare_record,
+                      :records,
+                      :slug
 
-        def template
+        def view_template
           super do
             div(class: 'index') {
               div(class: 'row') {

data/lib/tiny_admin/views/actions/show.rb

@@ -4,9 +4,14 @@ module TinyAdmin
   module Views
     module Actions
       class Show < DefaultLayout
-        attr_accessor :actions, :fields, :prepare_record, :record, :reference, :slug
+        attr_accessor :actions,
+                      :fields,
+                      :prepare_record,
+                      :record,
+                      :reference,
+                      :slug
 
-        def template
+        def view_template
           super do
             div(class: 'show') {
               div(class: 'row') {

data/lib/tiny_admin/views/components/field_value.rb

@@ -12,7 +12,7 @@ module TinyAdmin
           @record = record
         end
 
-        def template
+        def view_template
           translated_value = field.translate_value(value)
           value_class = field.options[:options]&.include?('value_class') ? "value-#{value}" : nil
           if field.options[:link_to]

data/lib/tiny_admin/views/components/filters_form.rb

@@ -6,7 +6,7 @@ module TinyAdmin
       class FiltersForm < BasicComponent
         attr_accessor :filters, :section_path
 
-        def template
+        def view_template
           form(class: 'form_filters', method: 'get') {
             filters.each do |field, filter|
               name = field.name

data/lib/tiny_admin/views/components/flash.rb

@@ -6,7 +6,7 @@ module TinyAdmin
       class Flash < BasicComponent
         attr_accessor :messages
 
-        def template
+        def view_template
           @messages ||= {}
           notices = messages[:notices]
           warnings = messages[:warnings]

data/lib/tiny_admin/views/components/head.rb

@@ -6,7 +6,7 @@ module TinyAdmin
       class Head < BasicComponent
         attr_accessor :extra_styles, :page_title, :style_links
 
-        def template
+        def view_template
           head {
             meta charset: 'utf-8'
             meta name: 'viewport', content: 'width=device-width, initial-scale=1'

data/lib/tiny_admin/views/components/navbar.rb

@@ -6,7 +6,7 @@ module TinyAdmin
       class Navbar < BasicComponent
         attr_accessor :current_slug, :items, :root_path, :root_title
 
-        def template
+        def view_template
           nav(class: 'navbar navbar-expand-lg') {
             div(class: 'container') {
               a(class: 'navbar-brand', href: root_path) { root_title }

data/lib/tiny_admin/views/components/pagination.rb

@@ -6,7 +6,7 @@ module TinyAdmin
       class Pagination < BasicComponent
         attr_accessor :current, :pages, :query_string, :total_count
 
-        def template
+        def view_template
           div(class: 'container') {
             div(class: 'row') {
               div(class: 'col total-count') {

data/lib/tiny_admin/views/components/widgets.rb

@@ -8,7 +8,7 @@ module TinyAdmin
           @widgets = widgets
         end
 
-        def template
+        def view_template
           return if @widgets.nil? || @widgets.empty?
 
           div(class: 'container widgets') {

data/lib/tiny_admin/views/default_layout.rb

@@ -5,7 +5,7 @@ module TinyAdmin
     class DefaultLayout < BasicLayout
       attr_accessor :flash_component, :head_component, :messages, :navbar_component, :options, :title
 
-      def template(&block)
+      def view_template(&block)
         extra_styles = TinyAdmin.settings.extra_styles
         flash_component&.messages = messages
         head_component&.update_attributes(page_title: title, style_links: style_links, extra_styles: extra_styles)

data/lib/tiny_admin/views/pages/content.rb

@@ -4,7 +4,7 @@ module TinyAdmin
   module Views
     module Pages
       class Content < DefaultLayout
-        def template
+        def view_template
           super do
             div(class: 'content') {
               div(class: 'content-data') {

data/lib/tiny_admin/views/pages/page_not_allowed.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module TinyAdmin
+  module Views
+    module Pages
+      class PageNotAllowed < DefaultLayout
+        def view_template
+          super do
+            div(class: 'page_not_allowed') {
+              h1(class: 'title') { title }
+            }
+          end
+        end
+
+        def title
+          'Page not allowed'
+        end
+      end
+    end
+  end
+end

data/lib/tiny_admin/views/pages/page_not_found.rb

@@ -4,7 +4,7 @@ module TinyAdmin
   module Views
     module Pages
       class PageNotFound < DefaultLayout
-        def template
+        def view_template
           super do
             div(class: 'page_not_found') {
               h1(class: 'title') { title }

data/lib/tiny_admin/views/pages/record_not_found.rb

@@ -4,7 +4,7 @@ module TinyAdmin
   module Views
     module Pages
       class RecordNotFound < DefaultLayout
-        def template
+        def view_template
           super do
             div(class: 'record_not_found') {
               h1(class: 'title') { title }

data/lib/tiny_admin/views/pages/root.rb

@@ -4,7 +4,7 @@ module TinyAdmin
   module Views
     module Pages
       class Root < DefaultLayout
-        def template
+        def view_template
           super do
             div(class: 'root') {
               render TinyAdmin::Views::Components::Widgets.new(widgets)

data/lib/tiny_admin/views/pages/simple_auth_login.rb

@@ -4,7 +4,7 @@ module TinyAdmin
   module Views
     module Pages
       class SimpleAuthLogin < DefaultLayout
-        def template
+        def view_template
           super do
             div(class: 'simple_auth_login') {
               h1(class: 'title') { title }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny_admin
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-16 00:00:00.000000000 Z
+date: 2024-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
   name: roda
   requirement: !ruby/object:Gem::Requirement
@@ -83,6 +89,7 @@ files:
 - lib/tiny_admin/context.rb
 - lib/tiny_admin/field.rb
 - lib/tiny_admin/plugins/active_record_repository.rb
+- lib/tiny_admin/plugins/authorization.rb
 - lib/tiny_admin/plugins/base_repository.rb
 - lib/tiny_admin/plugins/no_auth.rb
 - lib/tiny_admin/plugins/simple_auth.rb
@@ -107,6 +114,7 @@ files:
 - lib/tiny_admin/views/components/widgets.rb
 - lib/tiny_admin/views/default_layout.rb
 - lib/tiny_admin/views/pages/content.rb
+- lib/tiny_admin/views/pages/page_not_allowed.rb
 - lib/tiny_admin/views/pages/page_not_found.rb
 - lib/tiny_admin/views/pages/record_not_found.rb
 - lib/tiny_admin/views/pages/root.rb
@@ -134,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Tiny Admin