ditty 0.8.0 → 0.10.2

data/lib/ditty/controllers/{application.rb → application_controller.rb}

@@ -17,13 +17,14 @@ require 'rack/contrib'
 require 'rack/csrf'
 
 module Ditty
-  class Application < Sinatra::Base
+  class ApplicationController < Sinatra::Base
     include ActiveSupport::Inflector
 
-    set :root, ENV['APP_ROOT'] || ::File.expand_path(::File.dirname(__FILE__) + '/../../../')
+    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
@@ -35,14 +36,13 @@ module Ditty
 
     register Sinatra::Flash, Sinatra::RespondWith
 
-    use Rack::Csrf, raise: ENV['APP_ENV'] == 'development' unless ENV['APP_ENV'] == 'test'
-    use Rack::PostBodyContentTypeParser
+    use Rack::JSONBodyParser
     use Rack::MethodOverride
     use Rack::NestedParams
 
     helpers do
       def logger
-        Ditty::Services::Logger.instance
+        ::Ditty::Services::Logger
       end
 
       def base_path
@@ -51,9 +51,9 @@ module Ditty
 
       def view_location
         return settings.view_location if settings.view_location
-        return underscore(pluralize(demodulize(settings.model_class))) if settings.model_class
 
-        underscore(demodulize(self.class))
+        loc = demodulize(settings.model_class || self.class)
+        pluralize(underscore(loc.gsub(/Controller\Z/, '')))
       end
 
       def browser
@@ -61,24 +61,26 @@ module Ditty
       end
 
       def config(name, default = '')
-        Ditty::Services::Settings[name] || default
+        ::Ditty::Services::Settings[name] || default
       end
     end
 
     def view_folders
       folders = ['./views']
       folders << settings.view_folder if settings.view_folder
-      folders << Ditty::App.view_folder
+      folders << ::Ditty::Ditty.view_folder
     end
 
     def find_template(views, name, engine, &block)
       # Backwards compatability
-      return super(views, name, engine, &block) if settings.view_folder.nil? && self.class.name.split('::').first != 'Ditty'
+      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}`"
+      raise ::Ditty::TemplateNotFoundError, "Could not find template `#{name}`"
     end
 
     configure :production do
@@ -92,7 +94,7 @@ module Ditty
 
     configure :production, :development do
       disable :logging
-      use Rack::CommonLogger, Ditty::Services::Logger.instance
+      use Rack::CommonLogger, ::Ditty::Services::Logger
     end
 
     not_found do
@@ -102,7 +104,11 @@ module Ditty
           haml :'404', locals: { title: '4 oh 4' }, layout: layout
         end
         format.json do
-          json code: 404, errors: ['Not Found']
+          if response.body.empty?
+            json code: 404, errors: ['Not Found']
+          else
+            [404, response.body]
+          end
         end
       end
     end
@@ -134,30 +140,47 @@ module Ditty
       end
     end
 
-    error Sequel::ValidationFailed do
+    error ::Sinatra::Param::InvalidParameterError 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
+          flash.now[:danger] = env['sinatra.error'].message
+          haml :'400', locals: { title: '4 oh oh' }, layout: layout
         end
         format.json do
-          json code: 400, errors: errors, full_errors: errors.full_messages
+          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 Sinatra::Param::InvalidParameterError do
+    error ::Sequel::ValidationFailed do
       respond_to do |format|
+        entity = env['sinatra.error'].model
+        errors = env['sinatra.error'].errors
         status 400
         format.html do
-          flash.now[:danger] = env['sinatra.error'].message
-          haml :'400', locals: { title: '4 oh oh' }, layout: layout
+          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: { env['sinatra.error'].param => env['sinatra.error'].message }, full_errors: [env['sinatra.error'].message]
+          json code: 400, errors: errors, full_errors: errors.full_messages
         end
       end
     end
@@ -177,7 +200,7 @@ module Ditty
       end
     end
 
-    error Ditty::TemplateNotFoundError do
+    error ::Ditty::TemplateNotFoundError do
       # TODO: Display a better error message
       error = env['sinatra.error']
       broadcast(:application_error, error)
@@ -207,30 +230,36 @@ module Ditty
 
     before(/.*/) do
       logger.info "Running with #{self.class} - #{request.path_info}"
-      if request.path =~ /.*\.json\Z/
+      if /.*\.json\Z/.match?(request.path)
         content_type :json
         request.path_info = request.path_info.gsub(/.json$/, '')
-      elsif request.path =~ /.*\.csv\Z/
+      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']
-      else
-        content_type(:json) if request.accept.count.eql?(1) && request.accept.first.to_s.eql?('*/*')
+      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)
 
-      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)
+      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
-        document.to_xml
+      rescue StandardError => _e
+        orig
       end
     end
   end

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

@@ -1,11 +1,11 @@
 # 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
@@ -25,6 +25,8 @@ module Ditty
     end
 
     def list
+      return super if params[:sort]
+
       super.order(:created_at).reverse
     end
 

data/lib/ditty/controllers/{auth.rb → auth_controller.rb}

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-require 'ditty/controllers/application'
+require 'ditty/controllers/application_controller'
 require 'ditty/services/email'
 require 'securerandom'
 
 module Ditty
-  class Auth < Application
+  class AuthController < ApplicationController
     set track_actions: true
 
     def redirect_path
       return "#{settings.map_path}/" if omniauth_redirect_path.nil?
-      return "#{settings.map_path}/" if omniauth_redirect_path =~ %r{/#{settings.map_path}/auth/?}
+      return "#{settings.map_path}/" if omniauth_redirect_path.match? %r{/#{settings.map_path}/auth/?}
 
       omniauth_redirect_path
     end
@@ -24,7 +24,7 @@ module Ditty
 
       broadcast("before_#{provider}_login".to_sym, env['omniauth.auth'])
       user = User.first(email: env['omniauth.auth']['info']['email'])
-      user = register_user if user.nil? && authorize(current_user, :register?)
+      user = register_user if user.nil? && authorize(::Ditty::User, :register?)
       return failed_login if user.nil?
 
       broadcast("#{provider}_login".to_sym, user)
@@ -67,7 +67,7 @@ module Ditty
       authorize ::Ditty::Identity, :login
       redirect settings.map_path if authenticated?
 
-      haml :'auth/login', locals: { title: 'Log In' }
+      haml :'auth/login', locals: { title: 'Log In' }, layout: :blank
     end
 
     # Custom login form for LDAP to allow CSRF checks. Set the `request_path` for
@@ -76,13 +76,13 @@ module Ditty
       authorize ::Ditty::Identity, :login
       redirect settings.map_path if authenticated?
 
-      haml :'auth/ldap', locals: { title: 'Company Log In' }
+      haml :'auth/ldap', locals: { title: 'Company Log In' }, layout: :blank
     end
 
     get '/forgot-password' do
       authorize ::Ditty::Identity, :forgot_password
 
-      haml :'auth/forgot_password', locals: { title: 'Forgot your password?' }
+      haml :'auth/forgot_password', locals: { title: 'Forgot your password?' }, layout: :blank
     end
 
     post '/forgot-password' do
@@ -96,15 +96,18 @@ module Ditty
         token = SecureRandom.hex(16)
         identity.update(reset_token: token, reset_requested: Time.now)
         # Send Email
-        reset_url = "#{request.base_url}#{settings.map_path}/reset-password?token=#{token}"
-        Ditty::Services::Email.deliver(
+        reset_url = "#{request.base_url}#{settings.map_path}/auth/reset-password?token=#{token}"
+        ::Ditty::Services::Email.deliver(
           :forgot_password,
           email,
           locals: { identity: identity, reset_url: reset_url, request: request }
         )
       end
       flash[:info] = 'An email was sent to the email provided with instructions on how to reset your password'
-      redirect '/login'
+      redirect "#{settings.map_path}/auth/login"
+    rescue Sinatra::Param::InvalidParameterError
+      flash[:warning] = 'Email address not provided'
+      redirect back
     end
 
     get '/reset-password' do
@@ -114,7 +117,7 @@ module Ditty
       identity = Identity[reset_token: params[:token]]
       halt 404 unless identity&.reset_requested && identity.reset_requested > (Time.now - (24 * 60 * 60))
 
-      haml :'auth/reset_password', locals: { title: 'Reset your password', identity: identity }
+      haml :'auth/reset_password', locals: { title: 'Reset your password', identity: identity }, layout: :blank
     end
 
     put '/reset-password' do
@@ -124,15 +127,15 @@ module Ditty
       halt 404 unless identity
       authorize identity, :reset_password
 
-      identity_params = permitted_attributes(Identity, :update)
+      identity_params = permitted_parameters(Identity, :update)
       identity.set identity_params.merge(reset_token: nil, reset_requested: nil)
-      if identity.valid? && identity.save
+      if identity.valid? && identity.save_changes
         broadcast(:identity_update_password, target: self)
         flash[:success] = 'Password Updated'
         redirect "#{settings.map_path}/auth/login"
       else
         broadcast(:identity_update_password_failed, target: self)
-        haml :'auth/reset_password', locals: { title: 'Reset your password', identity: identity }
+        haml :'auth/reset_password', locals: { title: 'Reset your password', identity: identity }, layout: :blank
       end
     end
 
@@ -141,7 +144,7 @@ module Ditty
       authorize ::Ditty::User.new, :register
 
       identity = Identity.new
-      haml :'auth/register', locals: { title: 'Register', identity: identity }
+      haml :'auth/register', locals: { title: 'Register', identity: identity }, layout: :blank
     end
 
     # Register Action
@@ -152,8 +155,9 @@ module Ditty
       authorize user, :register
 
       begin
+        identity.valid?
         DB.transaction do
-          user.save
+          user.save_changes
           user.add_identity identity
           broadcast(:user_register, target: self, values: { user: user })
           flash[:info] = 'Successfully Registered. Please log in'
@@ -161,7 +165,7 @@ module Ditty
         end
       rescue Sequel::ValidationFailed
         flash.now[:warning] = 'Could not complete the registration. Please try again.'
-        haml :'auth/register', locals: { identity: identity }
+        haml :'auth/register', locals: { identity: identity }, layout: :blank
       end
     end
 
@@ -172,7 +176,7 @@ module Ditty
 
       halt 200 if request.xhr?
       flash[:info] = 'Logged Out'
-      redirect(Ditty::Services::Settings[:logout_redirect_path] || "#{settings.map_path}/")
+      redirect(::Ditty::Services::Settings[:logout_redirect_path] || "#{settings.map_path}/")
     end
 
     # Unauthenticated

data/lib/ditty/controllers/{component.rb → component_controller.rb}

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-require 'ditty/controllers/application'
+require 'ditty/controllers/application_controller'
 require 'ditty/helpers/component'
 require 'ditty/helpers/response'
 require 'sinatra/json'
 
 module Ditty
-  class Component < Application
+  class ComponentController < ApplicationController
+    use Rack::Csrf, raise: ENV['APP_ENV'] == 'development' unless ENV['APP_ENV'] == 'test'
+
     helpers Helpers::Component, Helpers::Response
 
     set base_path: nil
@@ -16,7 +18,12 @@ module Ditty
     set heading: nil
 
     def read(id)
-      dataset.first(settings.model_class.primary_key => id)
+      dataset.with_pk(id)
+    end
+
+    def read!(id)
+      halt 404 unless (entity = read(id))
+      entity
     end
 
     def skip_verify!
@@ -25,15 +32,15 @@ module Ditty
 
     def trigger(event, attribs = {})
       attribs[:target] ||= self
-      send(event, attribs) if self.respond_to? event
+      send(event, attribs) if respond_to? event
       broadcast(event, attribs)
     end
 
     after do
       return if settings.environment == 'production'
 
-      if (response.successful? || response.redirection?) && @skip_verify == false
-        verify_authorized if settings.environment != 'production'
+      if (response.successful? || response.redirection?) && @skip_verify == false && (settings.environment != 'production')
+        verify_authorized
       end
     end
 
@@ -58,8 +65,7 @@ module Ditty
     get '/new/?' do
       authorize settings.model_class, :create
 
-      entity = settings.model_class.new(permitted_attributes(settings.model_class, :create))
-      session[:redirect_to] = request.fullpath
+      entity = settings.model_class.new(permitted_parameters(settings.model_class, :create))
       haml :"#{view_location}/new",
            locals: { entity: entity, title: heading(:new) },
            layout: layout
@@ -67,11 +73,11 @@ module Ditty
 
     # Create
     post '/' do
-      entity = settings.model_class.new(permitted_attributes(settings.model_class, :create))
+      entity = settings.model_class.new(permitted_parameters(settings.model_class, :create))
       authorize entity, :create
 
       entity.db.transaction do
-        entity.save # Will trigger a Sequel::ValidationFailed exception if the model is incorrect
+        entity.save_changes # Will trigger a Sequel::ValidationFailed exception if the model is incorrect
         trigger :component_create, entity: entity
       end
 
@@ -80,8 +86,7 @@ module Ditty
 
     # Read
     get '/:id/?' do |id|
-      entity = read(id)
-      halt 404 unless entity
+      entity = read!(id)
       authorize entity, :read
 
       trigger :component_read, entity: entity
@@ -90,10 +95,10 @@ module Ditty
 
     # Update Form
     get '/:id/edit/?' do |id|
-      entity = read(id)
-      halt 404 unless entity
+      entity = read!(id)
       authorize entity, :update
 
+      flash[:redirect_to] = "#{base_path}/#{entity.display_id}" unless flash.keep(:redirect_to)
       haml :"#{view_location}/edit",
            locals: { entity: entity, title: heading(:edit) },
            layout: layout
@@ -101,13 +106,12 @@ module Ditty
 
     # Update
     put '/:id/?' do |id|
-      entity = read(id)
-      halt 404 unless entity
+      entity = read!(id)
       authorize entity, :update
 
       entity.db.transaction do
-        entity.set(permitted_attributes(settings.model_class, :update))
-        entity.save # Will trigger a Sequel::ValidationFailed exception if the model is incorrect
+        entity.set(permitted_parameters(settings.model_class, :update))
+        entity.save_changes # Will trigger a Sequel::ValidationFailed exception if the model is incorrect
         trigger :component_update, entity: entity
       end
 
@@ -115,8 +119,7 @@ module Ditty
     end
 
     delete '/:id/?' do |id|
-      entity = read(id)
-      halt 404 unless entity
+      entity = read!(id)
       authorize entity, :delete
 
       entity.db.transaction do