ditty 0.7.2 → 0.8.0

data/lib/ditty/helpers/response.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'csv'
+
 module Ditty
   module Helpers
     module Response
@@ -22,6 +24,14 @@ module Ditty
               'total' => total
             )
           end
+          format.csv do
+            CSV.generate do |csv|
+              csv << result.first.for_csv.keys
+              result.all.each do |r|
+                csv << r.for_csv.values
+              end
+            end
+          end
         end
       end
 
@@ -38,12 +48,17 @@ module Ditty
         end
       end
 
+      def actions(entity = nil)
+        actions = {}
+        actions["#{base_path}/#{entity.id}/edit"] = "Edit #{heading}" if entity && policy(entity).update?
+        actions["#{base_path}/new"] = "New #{heading}" if policy(settings.model_class).create?
+        actions
+      end
+
       def read_response(entity)
+        actions = actions(entity)
         respond_to do |format|
           format.html do
-            actions = {}
-            actions["#{base_path}/#{entity.id}/edit"] = "Edit #{heading}" if policy(entity).update?
-            actions["#{base_path}/new"] = "New #{heading}" if policy(entity).create?
             title = heading(:read) + (entity.respond_to?(:name) ? ": #{entity.name}" : '')
             haml :"#{view_location}/display",
                  locals: { entity: entity, title: title, actions: actions },
@@ -53,6 +68,12 @@ module Ditty
             # TODO: Add links defined by actions (Edit #{heading})
             json entity.for_json
           end
+          format.csv do
+            CSV.generate do |csv|
+              csv << entity.for_csv.keys
+              csv << entity.for_csv.values
+            end
+          end
         end
       end
 

data/lib/ditty/helpers/views.rb

@@ -7,6 +7,7 @@ module Ditty
     module Views
       def layout
         return :embedded if request.params['layout'] == 'embedded'
+
         :layout
       end
 
@@ -14,6 +15,7 @@ module Ditty
         uri = URI.parse(url)
         # Don't set the layout if there's none. Don't set the layout for external URIs
         return url if params['layout'].nil? || uri.host
+
         qs = { 'layout' => params['layout'] }.merge(uri.query ? CGI.parse(uri.query) : {})
         uri.query = Rack::Utils.build_query qs
         uri.to_s
@@ -41,6 +43,7 @@ module Ditty
       def filter_control(filter, opts = {})
         meth = "#{filter[:name]}_options".to_sym
         return unless respond_to? meth
+
         haml :'partials/filter_control', locals: {
           name: filter[:name],
           label: opts[:label] || filter[:name].to_s.titlecase,
@@ -50,6 +53,7 @@ module Ditty
 
       def flash_messages(key = :flash)
         return '' if flash(key).empty?
+
         id = (key == :flash ? 'flash' : "flash_#{key}")
         messages = flash(key).collect do |message|
           "  <div class='alert alert-#{message[0]} alert-dismissable' role='alert'>#{message[1]}</div>\n"
@@ -93,6 +97,7 @@ module Ditty
 
       def pagination(list, base_path, qp = {})
         return unless list.respond_to?(:pagination_record_count) || list.respond_to?(:total_entries)
+
         list = Ditty::Services::PaginationWrapper.new(list)
         locals = {
           first_link: "#{base_path}?" + query_string(qp.merge(page: 1)),
@@ -114,6 +119,21 @@ module Ditty
           value
         end
       end
+
+      def url_for(options = nil)
+        return options if options.is_a? String
+        return request.env['HTTP_REFERER'] if options == :back && request.env['HTTP_REFERER']
+
+        raise 'Unimplemented'
+      end
+
+      def link_to(name = nil, options = nil, html_options = {})
+        html_options[:href] ||= url_for(options)
+
+        capture_haml do
+          haml_tag :a, name, html_options
+        end
+      end
     end
   end
 end

data/lib/ditty/listener.rb

@@ -19,33 +19,51 @@ module Ditty
     def method_missing(method, *args)
       return unless args[0].is_a?(Hash) && args[0][:target].is_a?(Sinatra::Base) && args[0][:target].settings.track_actions
 
-      log_action({
-        user: args[0][:target].current_user,
-        action: action_from(args[0][:target], method),
-        details: args[0][:details]
-      }.merge(args[0][:values] || {}))
+      log_action(
+        user_traits(args[0][:target]).merge(
+          action: action_from(args[0][:target], method),
+          details: args[0][:details]
+        ).merge(args[0][:values] || {})
+      )
     end
 
     def respond_to_missing?(method, _include_private = false)
       EVENTS.include? method
     end
 
+    def user_login(event)
+      log_action(
+        user_traits(event[:target]).merge(
+          action: action_from(event[:target], :user_login),
+          details: event[:details]
+        ).merge(event[:values] || {})
+      )
+
+      @mutex.synchronize do
+        UserLoginTrait.update_or_create(user_traits(event[:target]), updated_at: Time.now)
+      end
+    end
+
     def user_register(event)
       user = event[:values][:user]
-      log_action({
-        user: user,
-        action: action_from(event[:target], :user_register),
-        details: event[:details]
-      }.merge(event[:values] || {}))
+      log_action(
+        user_traits(event[:target]).merge(
+          user_id: user.id,
+          action: action_from(event[:target], :user_register),
+          details: event[:details]
+        ).merge(event[:values] || {})
+      )
 
       # Create the SA user if none is present
       sa = Role.find_or_create(name: 'super_admin')
       return if User.where(roles: sa).count.positive?
+
       user.add_role sa
     end
 
     def action_from(target, method)
       return method unless method.to_s.start_with? 'component_'
+
       target.class.to_s.demodulize.underscore + '_' + method.to_s.gsub(/^component_/, '')
     end
 
@@ -53,6 +71,16 @@ module Ditty
       values[:user] ||= values[:target].current_user if values[:target]
       @mutex.synchronize { Ditty::AuditLog.create values }
     end
+
+    def user_traits(target)
+      {
+        user_id: target.current_user&.id,
+        platform: target.browser.platform.name,
+        device: target.browser.device.name,
+        browser: target.browser.name,
+        ip_address: target.request.ip
+      }
+    end
   end
 end
 

data/lib/ditty/middleware/accept_extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ditty
   module Middleware
     # Allow requests to be responded to in JSON if the URL has .json at the end.

data/lib/ditty/middleware/error_catchall.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ditty/services/logger'
 
 module Ditty

data/lib/ditty/models/audit_log.rb

@@ -8,6 +8,7 @@ module Ditty
     many_to_one :user
 
     def validate
+      super
       validates_presence [:action]
     end
   end

data/lib/ditty/models/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sequel'
 
 module Ditty
@@ -5,5 +7,7 @@ module Ditty
     def for_json
       values
     end
+
+    alias for_csv for_json
   end
 end

data/lib/ditty/models/identity.rb

@@ -22,6 +22,7 @@ module Ditty
 
     def authenticate(unencrypted)
       return false if crypted_password.blank?
+
       self if ::BCrypt::Password.new(crypted_password) == unencrypted
     end
 
@@ -38,6 +39,7 @@ module Ditty
 
     # Validation
     def validate
+      super
       validates_presence :username
       unless username.blank?
         validates_unique :username
@@ -64,6 +66,7 @@ module Ditty
 
     # Callbacks
     def before_save
+      super
       encrypt_password unless password == '' || password.nil?
     end
 

data/lib/ditty/models/role.rb

@@ -9,6 +9,7 @@ module Ditty
     many_to_many :users
 
     def validate
+      super
       validates_presence [:name]
       validates_unique [:name]
     end

data/lib/ditty/models/user.rb

@@ -13,6 +13,7 @@ module Ditty
     one_to_many :identity
     many_to_many :roles
     one_to_many :audit_logs
+    one_to_many :user_login_traits
 
     def role?(check)
       @roles ||= Hash.new do |h, k|
@@ -39,25 +40,32 @@ module Ditty
     end
 
     def validate
+      super
       validates_presence :email
       return if email.blank?
+
       validates_unique :email
       validates_format(/\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i, :email)
     end
 
     # Add the basic roles and identity
     def after_create
+      super
       check_roles
     end
 
     def check_roles
       return if roles_dataset.first(name: 'anonymous')
       return if roles_dataset.first(name: 'user')
+
       add_role Role.find_or_create(name: 'user')
     end
 
     def username
-      identity_dataset.first.username
+      identity = identity_dataset.first
+      return identity.username if identity
+
+      email
     end
 
     class << self

data/lib/ditty/models/user_login_trait.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'ditty/models/base'
+
+# Why not store this in Elasticsearch?
+module Ditty
+  class UserLoginTrait < ::Sequel::Model
+    include ::Ditty::Base
+
+    many_to_one :user
+
+    def validate
+      super
+      validates_presence :user_id
+    end
+  end
+end

data/lib/ditty/policies/audit_log_policy.rb

@@ -5,23 +5,23 @@ require 'ditty/policies/application_policy'
 module Ditty
   class AuditLogPolicy < ApplicationPolicy
     def create?
-      user && user.super_admin?
+      false
     end
 
     def list?
-      create?
+      user&.super_admin?
     end
 
     def read?
-      create?
+      user&.super_admin?
     end
 
     def update?
-      read?
+      false
     end
 
     def delete?
-      create?
+      false
     end
 
     def permitted_attributes
@@ -30,7 +30,7 @@ module Ditty
 
     class Scope < ApplicationPolicy::Scope
       def resolve
-        if user && user.super_admin?
+        if user&.super_admin?
           scope
         else
           scope.where(id: -1)

data/lib/ditty/policies/role_policy.rb

@@ -5,7 +5,7 @@ require 'ditty/policies/application_policy'
 module Ditty
   class RolePolicy < ApplicationPolicy
     def create?
-      user && user.super_admin?
+      user&.super_admin?
     end
 
     def list?
@@ -30,7 +30,7 @@ module Ditty
 
     class Scope < ApplicationPolicy::Scope
       def resolve
-        if user && user.super_admin?
+        if user&.super_admin?
           scope
         else
           scope.where(id: -1)

data/lib/ditty/policies/user_login_trait_policy.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'ditty/policies/application_policy'
+
+module Ditty
+  class UserLoginTraitPolicy < ApplicationPolicy
+    def create?
+      user&.super_admin?
+    end
+
+    def list?
+      !!user
+    end
+
+    def read?
+      user && (record.user_id || user.super_admin?)
+    end
+
+    def update?
+      user&.super_admin?
+    end
+
+    def delete?
+      user&.super_admin?
+    end
+
+    def permitted_attributes
+      attribs = %i[ip_address os browser]
+      attribs << :user_id if user.super_admin?
+      attribs
+    end
+
+    class Scope < ApplicationPolicy::Scope
+      def resolve
+        if user&.super_admin?
+          scope
+        elsif user
+          scope.where(user_id: user.id)
+        else
+          scope.where(id: -1)
+        end
+      end
+    end
+  end
+end

data/lib/ditty/policies/user_policy.rb

@@ -10,7 +10,7 @@ module Ditty
     end
 
     def create?
-      user && user.super_admin?
+      user&.super_admin?
     end
 
     def list?
@@ -37,7 +37,7 @@ module Ditty
 
     class Scope < ApplicationPolicy::Scope
       def resolve
-        if user && user.super_admin?
+        if user&.super_admin?
           scope
         elsif user
           scope.where(id: user.id)

data/lib/ditty/rubocop.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'rubocop/cop/ditty/call_services_directly'