ditty 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e259c6108ab65c11c7e5c33bb445406f3c5e172762369ac3fd9acc4055410d72
-  data.tar.gz: 0af669878d11300cdf8e0853bfde158f70510ccf4ae390b11910c73fa1856347
+  metadata.gz: 2b391296636a3f248171d3d71ca4c11466b8cce56f8814c271f2352e241da297
+  data.tar.gz: 8b136a384187ea59d6d8caa8f46f3dcc7a4a72939ba924ddff0eb8a332828aa1
 SHA512:
-  metadata.gz: 315f96dba2cc2c6ed416bf23f0f326deccf55bfe27e72c94b51f3001c84c5b8bab0571700c47d981bb23e0b61ab7a62c971653603e1ae2b6df9e0eb926756068
-  data.tar.gz: f426c1883a87e955fb5e9dd680f482287438fd101db1ebed3c3a515bdf8cf7d93c5cfc7ccba5b23ce37f70e8a7ccedc54bcc01c592eb19599090a111802e05d6
+  metadata.gz: 8102d97c1b3516e4f922600055a22b5bff5293dd69fbcb92a5cd233ad0e9f2e52fc6f091e05aebcee9e1dd610e76b0049db29b1eccfd54ff09f794325156cf68
+  data.tar.gz: c1ad5e59438e58fc6dbc34d5d2a95b1c5da4a0ccb88481fc15b9dd5942ece2d7525adcf52d3d520f9fd2c91dff65829d24a27ad8fb60d66889ac6f9b983c2fba

data/.rubocop.yml

@@ -1,12 +1,9 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
 Metrics/LineLength:
   Max: 120
-
-Style/NumericPredicate:
-  Enabled: false
-
 Layout/LeadingCommentSpace:
   Exclude:
     - 'config.ru'
-
-AllCops:
-  TargetRubyVersion: 2.2

data/.travis.yml

@@ -1,10 +1,10 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.5.1
-  - 2.4.0
-  - 2.3.3
-  - 2.2.6
+  - 2.6.0
+  - 2.5.3
+  - 2.4.5
+  - 2.3.8
 gemfile: Gemfile.ci
 env:
   global:
@@ -21,7 +21,7 @@ before_script:
   - bundle exec rake ditty:prep
 script:
   - bundle exec rake
-  - bundle exec rubocop --fail-level W lib views
+  - bundle exec rubocop --fail-level W lib views specs
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 after_success:

data/Gemfile.ci

@@ -3,7 +3,9 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'faker'
 gem 'rubocop'
+gem 'rubocop-rspec'
 gem 'simplecov', '~> 0.13.0'
 gem 'sqlite3'
 

data/Rakefile

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 require 'rake'
-require 'bundler/gem_tasks'
-require 'ditty/rake_tasks'
-
 require 'ditty'
 require 'ditty/components/app'
 
+Ditty.component :app
+
+Ditty::Components.tasks
+require 'bundler/gem_tasks' if File.exist? 'ditty.gemspec'
 begin
   require 'rspec/core/rake_task'
   RSpec::Core::RakeTask.new(:spec)

data/Readme.md

@@ -1,6 +1,7 @@
 [![Build Status](https://travis-ci.org/EagerELK/ditty.svg?branch=master)](https://travis-ci.org/EagerELK/ditty)
 [![Code Climate](https://codeclimate.com/github/EagerELK/ditty/badges/gpa.svg)](https://codeclimate.com/github/EagerELK/ditty)
 [![Test Coverage](https://codeclimate.com/github/EagerELK/ditty/badges/coverage.svg)](https://codeclimate.com/github/EagerELK/ditty/coverage)
+[![Inline docs](http://inch-ci.org/github/EagerELK/ditty.svg?branch=master)](http://inch-ci.org/github/EagerELK/ditty)
 
 # Ditty
 
@@ -33,12 +34,33 @@ gem install ditty
 
 1. Add the components to your rack config file. See the included [`config.ru`](https://github.com/EagerELK/ditty/blob/master/config.ru) file for an example setup
 2. Set the DB connection as the `DATABASE_URL` ENV variable: `DATABASE_URL=sqlite://development.db`
+3. Prepare the Ditty folder: `bundle exec ditty prep`
 3. Run the Ditty migrations: `bundle exec ditty migrate`
 4. Run the Ditty server: `bundle exec ditty server`
 
-## Components
+### Components
 
-The application can now be further extended by creating components.
+The application can now be further extended by creating [components](https://github.com/EagerELK/ditty/wiki/Creating-a-Component).
+
+### Rubocop Cops
+
+Ditty provides a number of [Rubocop](https://github.com/rubocop-hq/rubocop) cops
+to ensure that the Ditty framework is used correctly. Enable this by adding the
+following to your `.rubocop.yml` file:
+
+```yaml
+require: ditty/rubocop
+```
+
+You can run Ditty specific cops as follows:
+
+```bash
+bundle exec rubocop --only Ditty
+```
+
+Adding the `-a` flag to the invocation will automatically fix some of the issues
+for you, but, as always, ensure you have a working copy of your code before
+running this.
 
 ## Development
 

data/ditty.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = ['ditty']
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'bundler', '>= 1'
   spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'factory_bot'
   spec.add_development_dependency 'rack-test'
@@ -30,10 +30,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport', '>= 3'
   spec.add_dependency 'bcrypt', '~> 3.1'
+  spec.add_dependency 'browser', '~> 2.5'
   spec.add_dependency 'haml', '~> 5.0'
   spec.add_dependency 'logger', '~> 1.0'
-  spec.add_dependency 'oga', '>= 2.14'
   spec.add_dependency 'mail', '>= 1.7'
+  spec.add_dependency 'oga', '>= 2.14'
   spec.add_dependency 'omniauth', '~> 1.0'
   spec.add_dependency 'omniauth-identity', '~> 1.0'
   spec.add_dependency 'pundit', '~> 1.0'
@@ -45,8 +46,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'sinatra-contrib', '~> 2.0'
   spec.add_dependency 'sinatra-flash', '~> 0.3'
   spec.add_dependency 'sinatra-param', '~> 1.5'
-  spec.add_dependency 'tilt', '>= 2'
   spec.add_dependency 'thor', '>= 0.20'
+  spec.add_dependency 'tilt', '>= 2'
   spec.add_dependency 'will_paginate', '>= 3.1'
   spec.add_dependency 'wisper', '~> 2.0'
 end

data/lib/ditty.rb

@@ -6,6 +6,8 @@ require 'ditty/services/logger'
 module Ditty
   class ComponentError < StandardError; end
 
+  class TemplateNotFoundError < StandardError; end
+
   # A thread safe cache class, offering only #[] and #[]= methods,
   # each protected by a mutex.
   # Ripped off from Roda - https://github.com/jeremyevans/roda
@@ -30,6 +32,10 @@ module Ditty
       @mutex.synchronize { @hash.map(&block) }
     end
 
+    def each(&block)
+      @mutex.synchronize { @hash.each(&block) }
+    end
+
     def inject(memo, &block)
       @mutex.synchronize { @hash.inject(memo, &block) }
     end
@@ -37,6 +43,10 @@ module Ditty
     def each_with_object(memo, &block)
       @mutex.synchronize { @hash.each_with_object(memo, &block) }
     end
+
+    def key?(key)
+      @hash.key? key
+    end
   end
 
   # Ripped off from Roda - https://github.com/jeremyevans/roda
@@ -57,6 +67,10 @@ module Ditty
       component
     end
 
+    def self.component?(name)
+      @components.key? name
+    end
+
     # Register the given component with Component, so that it can be loaded using #component
     # with a symbol. Should be used by component files. Example:
     #
@@ -111,6 +125,15 @@ module Ditty
       end
     end
 
+    def self.tasks
+      require 'rake'
+      require 'rake/tasklib'
+      require 'ditty/db' unless defined? DB
+      components.each do |_name, comp|
+        comp.tasks if comp.respond_to?(:tasks)
+      end
+    end
+
     module Base
       module ClassMethods
         # Load a new component into the current class.  A component can be a module
@@ -121,6 +144,7 @@ module Ditty
         #   Component.component :csrf
         def component(component, *args, &block)
           raise ComponentError, 'Cannot add a component to a frozen Component class' if frozen?
+
           component = Components.load_component(component) if component.is_a?(Symbol)
           include(component::InstanceMethods) if defined?(component::InstanceMethods)
           extend(component::ClassMethods) if defined?(component::ClassMethods)

data/lib/ditty/cli.rb

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
+
 # https://nandovieira.com/creating-generators-and-executables-with-thor
 require 'dotenv/load'
 require 'thor'
-require 'ditty'
-require 'ditty/rake_tasks'
 require 'rack'
 require 'rake'
 
@@ -12,6 +12,7 @@ module Ditty
 
     desc 'server', 'Start the Ditty server'
     require './application' if File.exist?('application.rb')
+    Ditty::Components.tasks
     def server
       # Ensure the token files are present
       Rake::Task['ditty:generate_tokens'].invoke
@@ -39,6 +40,9 @@ module Ditty
       # 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
   end
 end

data/lib/ditty/components/app.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'ditty'
+require 'ditty/services/settings'
 
 module Ditty
   class App
@@ -12,6 +13,7 @@ module Ditty
       require 'ditty/models/role'
       require 'ditty/models/identity'
       require 'ditty/models/audit_log'
+      require 'ditty/models/user_login_trait'
     end
 
     def self.configure(_container)
@@ -34,7 +36,8 @@ module Ditty
         '/auth' => ::Ditty::Auth,
         '/users' => ::Ditty::Users,
         '/roles' => ::Ditty::Roles,
-        '/audit-logs' => ::Ditty::AuditLogs
+        '/audit-logs' => ::Ditty::AuditLogs,
+        '/login-traits' => ::Ditty::UserLoginTraits
       }
     end
 
@@ -65,6 +68,12 @@ module Ditty
         ::Ditty::Role.find_or_create(name: 'user')
       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
 

data/lib/ditty/controllers/application.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'browser/browser'
 require 'wisper'
 require 'oga'
 require 'sinatra/base'
@@ -22,6 +23,7 @@ module Ditty
     set :root, ENV['APP_ROOT'] || ::File.expand_path(::File.dirname(__FILE__) + '/../../../')
     set :map_path, nil
     set :view_location, nil
+    set :view_folder, nil
     set :model_class, nil
     set :raise_sinatra_param_exceptions, true
     set track_actions: false
@@ -39,6 +41,10 @@ module Ditty
     use Rack::NestedParams
 
     helpers do
+      def logger
+        Ditty::Services::Logger.instance
+      end
+
       def base_path
         settings.base_path || "#{settings.map_path}/#{dasherize(view_location)}"
       end
@@ -46,8 +52,33 @@ 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))
       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::App.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'
+
+      view_folders.each do |folder|
+        super(folder, name, engine, &block) # Root
+      end
+      raise Ditty::TemplateNotFoundError, "Could not find template `#{name}`"
     end
 
     configure :production do
@@ -77,14 +108,28 @@ module Ditty
     end
 
     error Helpers::NotAuthenticated, ::Pundit::NotAuthorizedError do
-      respond_to do |format|
-        status 401
-        format.html do
-          flash[:warning] = 'Please log in first.'
-          redirect with_layout("#{settings.map_path}/auth/login")
+      # 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
-        format.json do
-          json code: 401, errors: ['Not Authenticated']
+      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
@@ -120,7 +165,7 @@ module Ditty
     error ::Sequel::ForeignKeyConstraintViolation do
       error = env['sinatra.error']
       broadcast(:application_error, error)
-      ::Ditty::Services::Logger.instance.error error
+      logger.error error
       respond_to do |format|
         status 400
         format.html do
@@ -132,10 +177,23 @@ module Ditty
       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)
-      ::Ditty::Services::Logger.instance.error error
+      logger.error error
       respond_to do |format|
         status 500
         format.html do
@@ -148,10 +206,13 @@ module Ditty
     end
 
     before(/.*/) do
-      ::Ditty::Services::Logger.instance.debug "Running with #{self.class} - #{request.path_info}"
+      logger.info "Running with #{self.class} - #{request.path_info}"
       if request.path =~ /.*\.json\Z/
         content_type :json
         request.path_info = request.path_info.gsub(/.json$/, '')
+      elsif request.path =~ /.*\.csv\Z/
+        content_type :csv
+        request.path_info = request.path_info.gsub(/.csv$/, '')
       elsif request.env['ACCEPT']
         content_type request.env['ACCEPT']
       else
@@ -161,6 +222,7 @@ module Ditty
 
     after do
       return if params[:layout].nil?
+
       response.body = response.body.map do |resp|
         document = Oga.parse_html(resp)
         document.css('a').each do |elm|

data/lib/ditty/controllers/audit_logs.rb

@@ -8,6 +8,7 @@ module Ditty
   class AuditLogs < Ditty::Component
     set model_class: AuditLog
 
+    SEARCHABLE = %i[details platform device browser ip_address].freeze
     FILTERS = [
       { name: :user, field: 'user.email' },
       { name: :action }
@@ -23,11 +24,6 @@ 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
       super.order(:created_at).reverse
     end