ditty 0.7.1 → 0.10.1

data/lib/ditty/cli.rb

@@ -1,23 +1,43 @@
+# frozen_string_literal: true
+
 # https://nandovieira.com/creating-generators-and-executables-with-thor
-require 'dotenv/load'
+require 'dotenv/load' rescue LoadError # rubocop:disable Style/RescueModifier - Ignore dotenv/load errors
 require 'thor'
-require 'ditty'
-require 'ditty/rake_tasks'
 require 'rack'
 require 'rake'
+require 'ditty/db' if ENV['DATABASE_URL']
+require 'ditty/generators/crud_generator'
+require 'ditty/generators/project_generator'
+require 'ditty/generators/migration_generator'
+require 'ditty/components/ditty'
+
+# TODO: Component generator
+# TODO: Add requires into application.rb
+# TODO: Add requires into schema.rb
 
 module Ditty
   class CLI < Thor
     include Thor::Actions
 
+    register ::Ditty::Generators::CrudGenerator, 'crud', 'crud NAME', 'Generate a CRUD endpoint'
+
+    register ::Ditty::Generators::ProjectGenerator, 'init', 'init', 'Initialize a Ditty Project'
+
+    register ::Ditty::Generators::MigrationGenerator, 'migration', 'migration NAME', 'Create a new Sequel migration'
+
+    default_task :server
+
     desc 'server', 'Start the Ditty server'
     require './application' if File.exist?('application.rb')
+    require 'ditty/db' unless defined?(DB)
+    ::Ditty::Components.tasks
     def server
       # Ensure the token files are present
       Rake::Task['ditty:generate_tokens'].invoke
 
       # Prep Ditty
-      Rake::Task['ditty:prep'].invoke
+      Rake::Task['ditty:prep:folders'].invoke
+      Rake::Task['ditty:prep:migrations'].invoke
 
       # Check the migrations
       Rake::Task['ditty:migrate:check'].invoke
@@ -34,11 +54,24 @@ module Ditty
     desc 'migrate', 'Run the Ditty migrations'
     def migrate
       # Prep Ditty
-      Rake::Task['ditty:prep'].invoke
+      Rake::Task['ditty:prep:migrations'].invoke
 
       # Run the migrations
       Rake::Task['ditty:migrate:up'].invoke
       puts 'Ditty Migrations Executed'
+
+      Rake::Task['ditty:dump_schema'].invoke
+      puts 'Ditty DB Schema Dumped'
+    end
+
+    desc 'seed', 'Seed the predefined seeding data'
+    def seed
+      Rake::Task['ditty:seed'].invoke
+    end
+
+    desc 'console', 'Open a fully loaded console'
+    def console
+      Rake::Task['ditty:console'].invoke
     end
   end
 end

data/lib/ditty/components/ditty.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'ditty'
+require 'ditty/services/settings'
+
+module Ditty
+  class Ditty
+    def self.load
+      controllers = File.expand_path('../controllers', __dir__)
+      Dir.glob("#{controllers}/*.rb").sort.each { |f| require f }
+
+      require 'ditty/models/user'
+      require 'ditty/models/role'
+      require 'ditty/models/identity'
+      require 'ditty/models/audit_log'
+      require 'ditty/models/user_login_trait'
+    end
+
+    def self.configure(_container)
+      require 'ditty/db' unless defined? ::DB
+      require 'ditty/listener'
+    end
+
+    def self.migrations
+      File.expand_path('../../../migrate', __dir__)
+    end
+
+    def self.view_folder
+      File.expand_path('../../../views', __dir__)
+    end
+
+    def self.routes
+      load
+      {
+        '/' => ::Ditty::MainController,
+        '/auth' => ::Ditty::AuthController,
+        '/users' => ::Ditty::UsersController,
+        '/roles' => ::Ditty::RolesController,
+        '/audit-logs' => ::Ditty::AuditLogsController,
+        '/login-traits' => ::Ditty::UserLoginTraitsController
+      }
+    end
+
+    def self.navigation(_request)
+      load
+
+      [
+        {
+          group: 'User Management',
+          order: 50,
+          icon: 'lock',
+          target: ::Ditty::User,
+          items: [
+            { order: 10, link: '/users/', text: 'Users', target: ::Ditty::User, icon: 'user' },
+            { order: 20, link: '/roles/', text: 'Roles', target: ::Ditty::Role, icon: 'check-square' },
+            { order: 30, link: '/audit-logs/', text: 'Audit Logs', target: ::Ditty::AuditLog, icon: 'history' },
+            { order: 40, link: '/login-traits/', text: 'User Login Traits', target: ::Ditty::UserLoginTrait,
+              icon: 'list' }
+          ]
+        }
+      ]
+    end
+
+    def self.seeder
+      proc do
+        load
+
+        sa = ::Ditty::Role.find_or_create(name: 'super_admin')
+        admin = ::Ditty::Role.find_or_create(name: 'admin') { |e| e.parent = sa }
+        ::Ditty::Role.find_or_create(name: 'user') { |e| e.parent = admin }
+      end
+    end
+
+    def self.tasks
+      Kernel.load 'ditty/tasks/ditty.rake'
+      auth_settings = ::Ditty::Services::Settings[:authentication] || {}
+      Kernel.load 'ditty/tasks/omniauth-ldap.rake' if auth_settings.key?(:ldap)
+    end
+  end
+end
+
+Ditty::Components.register_component(:ditty, Ditty::Ditty)

data/lib/ditty/controllers/application_controller.rb

@@ -0,0 +1,267 @@
+# frozen_string_literal: true
+
+require 'browser/browser'
+require 'wisper'
+require 'oga'
+require 'sinatra/base'
+require 'sinatra/flash'
+require 'sinatra/param'
+require 'sinatra/respond_with'
+require 'ditty/helpers/views'
+require 'ditty/helpers/pundit'
+require 'ditty/helpers/authentication'
+require 'ditty/services/logger'
+require 'active_support'
+require 'active_support/inflector'
+require 'rack/contrib'
+require 'rack/csrf'
+
+module Ditty
+  class ApplicationController < Sinatra::Base
+    include ActiveSupport::Inflector
+
+    set :root, ENV['APP_ROOT'] || ::File.expand_path("#{::File.dirname(__FILE__)}/../../../")
+    set :map_path, nil
+    set :view_location, nil
+    set :view_folder, nil
+    set :base_path, nil
+    set :model_class, nil
+    set :raise_sinatra_param_exceptions, true
+    set track_actions: false
+
+    # The order here is important, since Wisper has a deprecated method respond_with method
+    helpers Wisper::Publisher
+    helpers Helpers::Pundit, Helpers::Views, Helpers::Authentication
+    helpers Sinatra::Param
+
+    register Sinatra::Flash, Sinatra::RespondWith
+
+    use Rack::Csrf, raise: ENV['APP_ENV'] == 'development' unless ENV['APP_ENV'] == 'test'
+    use Rack::JSONBodyParser
+    use Rack::MethodOverride
+    use Rack::NestedParams
+
+    helpers do
+      def logger
+        ::Ditty::Services::Logger
+      end
+
+      def base_path
+        settings.base_path || "#{settings.map_path}/#{dasherize(view_location)}"
+      end
+
+      def view_location
+        return settings.view_location if settings.view_location
+
+        loc = demodulize(settings.model_class || self.class)
+        pluralize(underscore(loc.gsub(/Controller\Z/, '')))
+      end
+
+      def browser
+        Browser.new(request.user_agent, accept_language: request.env['HTTP_ACCEPT_LANGUAGE'])
+      end
+
+      def config(name, default = '')
+        ::Ditty::Services::Settings[name] || default
+      end
+    end
+
+    def view_folders
+      folders = ['./views']
+      folders << settings.view_folder if settings.view_folder
+      folders << ::Ditty::Ditty.view_folder
+    end
+
+    def find_template(views, name, engine, &block)
+      # Backwards compatability
+      if settings.view_folder.nil? && self.class.name.split('::').first != 'Ditty'
+        return super(views, name, engine, &block)
+      end
+
+      view_folders.each do |folder|
+        super(folder, name, engine, &block) # Root
+      end
+      raise ::Ditty::TemplateNotFoundError, "Could not find template `#{name}`"
+    end
+
+    configure :production do
+      disable :show_exceptions
+      set :dump_errors, false
+    end
+
+    configure :development do
+      set :show_exceptions, :after_handler
+    end
+
+    configure :production, :development do
+      disable :logging
+      use Rack::CommonLogger, ::Ditty::Services::Logger
+    end
+
+    not_found do
+      respond_to do |format|
+        status 404
+        format.html do
+          haml :'404', locals: { title: '4 oh 4' }, layout: layout
+        end
+        format.json do
+          if response.body.empty?
+            json code: 404, errors: ['Not Found']
+          else
+            [404, response.body]
+          end
+        end
+      end
+    end
+
+    error Helpers::NotAuthenticated, ::Pundit::NotAuthorizedError do
+      # TODO: Check if this is logged / tracked
+      if authenticated?
+        respond_to do |format|
+          status 403
+          format.html do
+            flash.now[:danger] = 'Cannot perform that action at the moment.'
+            haml :'403', locals: { title: 'Forbidden' }, layout: layout
+          end
+          format.json do
+            json code: 403, errors: ['Forbidden']
+          end
+        end
+      else
+        respond_to do |format|
+          format.html do
+            flash[:warning] = 'Please log in first.'
+            redirect with_layout("#{settings.map_path}/auth/login")
+          end
+          format.json do
+            status 401
+            json code: 401, errors: ['Not Authenticated']
+          end
+        end
+      end
+    end
+
+    error ::Sinatra::Param::InvalidParameterError do
+      respond_to do |format|
+        status 400
+        format.html do
+          flash.now[:danger] = env['sinatra.error'].message
+          haml :'400', locals: { title: '4 oh oh' }, layout: layout
+        end
+        format.json do
+          json code: 400, errors: { env['sinatra.error'].param => env['sinatra.error'].message },
+               full_errors: [env['sinatra.error'].message]
+        end
+      end
+    end
+
+    error ::Sequel::NoMatchingRow do
+      respond_to do |format|
+        status 404
+        format.html do
+          haml :'404', locals: { title: '4 oh 4' }, layout: layout
+        end
+        format.json do
+          if response.body.empty?
+            json code: 404, errors: ['Not Found']
+          else
+            [404, response.body]
+          end
+        end
+      end
+    end
+
+    error ::Sequel::ValidationFailed do
+      respond_to do |format|
+        entity = env['sinatra.error'].model
+        errors = env['sinatra.error'].errors
+        status 400
+        format.html do
+          action = entity.id ? :edit : :new
+          haml :"#{view_location}/#{action}", locals: { entity: entity, title: heading(action) }, layout: layout
+        end
+        format.json do
+          json code: 400, errors: errors, full_errors: errors.full_messages
+        end
+      end
+    end
+
+    error ::Sequel::ForeignKeyConstraintViolation do
+      error = env['sinatra.error']
+      broadcast(:application_error, error)
+      logger.error error
+      respond_to do |format|
+        status 400
+        format.html do
+          haml :error, locals: { title: 'Something went wrong', error: error }, layout: layout
+        end
+        format.json do
+          json code: 400, errors: ['Invalid Relation Specified']
+        end
+      end
+    end
+
+    error ::Ditty::TemplateNotFoundError do
+      # TODO: Display a better error message
+      error = env['sinatra.error']
+      broadcast(:application_error, error)
+      logger.error error
+      respond_to do |format|
+        status 500
+        format.html do
+          haml :error, locals: { title: 'Template not found', error: error }, layout: layout
+        end
+      end
+    end
+
+    error do
+      error = env['sinatra.error']
+      broadcast(:application_error, error)
+      logger.error error
+      respond_to do |format|
+        status 500
+        format.html do
+          haml :error, locals: { title: 'Something went wrong', error: error }, layout: layout
+        end
+        format.json do
+          json code: 500, errors: ['Something went wrong']
+        end
+      end
+    end
+
+    before(/.*/) do
+      logger.info "Running with #{self.class} - #{request.path_info}"
+      if /.*\.json\Z/.match?(request.path)
+        content_type :json
+        request.path_info = request.path_info.gsub(/.json$/, '')
+      elsif /.*\.csv\Z/.match?(request.path)
+        content_type :csv
+        request.path_info = request.path_info.gsub(/.csv$/, '')
+      elsif request.env['ACCEPT']
+        content_type request.env['ACCEPT']
+      elsif request.accept.count.eql?(1) && request.accept.first.to_s.eql?('*/*')
+        content_type(:json)
+      end
+    end
+
+    after do
+      return if params[:layout].nil?
+      return unless response.body.respond_to?(:map)
+
+      begin
+        orig = response.body
+        response.body = response.body.map do |resp|
+          document = Oga.parse_html(resp)
+          document.css('a').each do |elm|
+            unless (href = elm.get('href')).nil?
+              elm.set 'href', with_layout(href)
+            end
+          end
+          document.to_xml
+        end
+      rescue StandardError => _e
+        orig
+      end
+    end
+  end
+end

data/lib/ditty/controllers/{audit_logs.rb → audit_logs_controller.rb}

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
-require 'ditty/controllers/component'
+require 'ditty/controllers/component_controller'
 require 'ditty/models/audit_log'
 require 'ditty/policies/audit_log_policy'
 
 module Ditty
-  class AuditLogs < Ditty::Component
+  class AuditLogsController < ::Ditty::ComponentController
     set model_class: AuditLog
 
+    SEARCHABLE = %i[details platform device browser ip_address].freeze
     FILTERS = [
       { name: :user, field: 'user.email' },
       { name: :action }
@@ -23,12 +24,9 @@ module Ditty
       end
     end
 
-    def find_template(views, name, engine, &block)
-      super(views, name, engine, &block) # Root
-      super(::Ditty::App.view_folder, name, engine, &block) # Ditty
-    end
-
     def list
+      return super if params[:sort]
+
       super.order(:created_at).reverse
     end