ditty 0.7.2 → 0.8.0

data/lib/ditty/seed.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 ::Ditty::Components.seeders.each(&:call)

data/lib/ditty/services/authentication.rb

@@ -1,13 +1,16 @@
-require 'ditty/models/identity'
-require 'ditty/controllers/auth'
+# frozen_string_literal: true
+
+require 'ditty/controllers/application'
 require 'ditty/services/settings'
 require 'ditty/services/logger'
+require 'backports/2.4.0/hash/compact'
 
 require 'omniauth'
 OmniAuth.config.logger = Ditty::Services::Logger.instance
 OmniAuth.config.path_prefix = "#{Ditty::Application.map_path}/auth"
 OmniAuth.config.on_failure = proc { |env|
   next [400, {}, []] if env['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest'
+
   OmniAuth::FailureEndpoint.new(env).redirect_to_failure
 }
 
@@ -42,6 +45,8 @@ module Ditty
         end
 
         def default
+          require 'ditty/models/identity'
+          require 'ditty/controllers/auth'
           {
             identity: {
               arguments: [

data/lib/ditty/services/email.rb

@@ -11,6 +11,8 @@ module Ditty
       class << self
         include ActiveSupport::Inflector
 
+        attr_writer :config
+
         def config!
           cfg = config
           Mail.defaults do
@@ -21,6 +23,7 @@ module Ditty
         def deliver(email, to = nil, options = {})
           config!
           options[:to] ||= to unless to.nil?
+          options[:from] ||= config[:from] unless config[:from].nil?
           email = from_symbol(email, options) if email.is_a? Symbol
           email.deliver!
         end
@@ -28,11 +31,14 @@ module Ditty
         private
 
         def config
-          default.merge Ditty::Services::Settings.values(:email) || {}
+          @config ||= default.merge Ditty::Services::Settings.values(:email) || {}
         end
 
         def default
-          { delivery_method: :logger, logger: Ditty::Services::Logger.instance }
+          {
+            delivery_method: :logger,
+            logger: Ditty::Services::Logger.instance
+          }
         end
 
         def from_symbol(email, options)

data/lib/ditty/services/logger.rb

@@ -20,6 +20,7 @@ module Ditty
       def initialize
         @loggers = []
         return if config[:loggers].blank?
+
         config[:loggers].each do |values|
           klass = values[:class].constantize
           opts = tr(values[:options]) || nil
@@ -53,6 +54,16 @@ module Ditty
       def default
         { loggers: [{ name: 'default', class: 'Logger' }] }
       end
+
+      class << self
+        def method_missing(method, *args, &block)
+          instance.send(method, *args, &block)
+        end
+
+        def respond_to_missing?(method, _include_private)
+          instance.respond_to? method
+        end
+      end
     end
   end
 end

data/lib/ditty/services/pagination_wrapper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ditty
   module Services
     class PaginationWrapper

data/lib/ditty/services/settings.rb

@@ -16,12 +16,19 @@ module Ditty
     # in separate files will be used in preference of those in the `settings.yml`
     # file.
     module Settings
-      CONFIG_FOLDER = './config'.freeze
-      CONFIG_FILE = "#{CONFIG_FOLDER}/settings.yml".freeze
+      CONFIG_FOLDER = './config'
+      CONFIG_FILE = "#{CONFIG_FOLDER}/settings.yml"
 
       class << self
         def [](key)
-          values(key.to_sym)
+          keys = key.to_s.split('.').map(&:to_sym)
+          from = values
+          if keys.count > 1 && scope?(keys.first)
+            from = values(keys.first)
+            keys = keys[1..-1]
+            key = keys.join('.')
+          end
+          from[key.to_sym] || from.dig(*keys)
         end
 
         def values(scope = :settings)
@@ -40,6 +47,10 @@ module Ditty
           @values[scope]
         end
 
+        def scope?(name)
+          @values.key?(name.to_sym) || File.file?("#{CONFIG_FOLDER}/#{name}.yml")
+        end
+
         attr_writer :values
 
         def read(filename)

data/lib/ditty/tasks/ditty.rake

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+namespace :ditty do
+  desc 'Prepare Ditty'
+  task prep: ['generate_tokens', 'prep:folders', 'prep:public', 'prep:migrations']
+
+  desc 'Generate the needed tokens'
+  task :generate_tokens do
+    puts 'Generating the Ditty tokens'
+    require 'securerandom'
+    File.write('.session_secret', SecureRandom.random_bytes(40)) unless File.file?('.session_secret')
+    File.write('.token_secret', SecureRandom.random_bytes(40)) unless File.file?('.token_secret')
+  end
+
+  desc 'Seed the Ditty database'
+  task :seed do
+    puts 'Seeding the Ditty database'
+    require 'ditty/seed'
+  end
+
+  desc 'Dump the Ditty DB Schema'
+  task :dump_schema do
+    Ditty::Components.components.each do |_name, comp|
+      comp.load if comp.respond_to?(:load)
+    end.compact
+    DB.dump_schema_cache('./config/schema.dump')
+  end
+
+  namespace :prep do
+    desc 'Check that the required Ditty folders are present'
+    task :folders do
+      puts 'Prepare the Ditty folders'
+      Dir.mkdir 'pids' unless File.exist?('pids')
+    end
+
+    desc 'Check that the public folder is present and populated'
+    task :public do
+      puts 'Preparing the Ditty public folder'
+      Dir.mkdir 'public' unless File.exist?('public')
+      ::Ditty::Components.public_folder.each do |path|
+        puts "Checking #{path}"
+        path = "#{path}/."
+        FileUtils.cp_r path, 'public' unless File.expand_path(path).eql? File.expand_path('public')
+      end
+    end
+
+    desc 'Check that the migrations folder is present and populated'
+    task :migrations do
+      puts 'Preparing the Ditty migrations folder'
+      Dir.mkdir 'migrations' unless File.exist?('migrations')
+      ::Ditty::Components.migrations.each do |path|
+        path = "#{path}/."
+        FileUtils.cp_r path, 'migrations' unless File.expand_path(path).eql? File.expand_path('migrations')
+      end
+      puts 'Migrations added:'
+      Dir.foreach('migrations').sort.each { |x| puts x if File.file?("migrations/#{x}") && x[-3..-1] == '.rb' }
+    end
+  end
+
+  desc 'Migrate Ditty database to latest version'
+  task migrate: ['prep:migrations'] do
+    puts 'Running the Ditty migrations'
+    Rake::Task['ditty:migrate:up'].invoke
+  end
+
+  namespace :migrate do
+    require 'logger'
+
+    folder = 'migrations'
+
+    desc 'Check if the migration is current'
+    task :check do
+      ::DB.loggers << Logger.new($stdout) if ::DB.loggers.count.zero?
+      puts '** [ditty] Running Ditty Sequel Migrations check'
+      ::Sequel.extension :migration
+      begin
+        ::Sequel::Migrator.check_current(::DB, folder)
+        puts '** [ditty] Sequel Migrations up to date'
+      rescue Sequel::Migrator::Error => _e
+        raise 'Sequel Migrations NOT up to date'
+      end
+    end
+
+    desc 'Migrate Ditty database to latest version'
+    task :up do
+      ::DB.loggers << Logger.new($stdout) if ::DB.loggers.count.zero?
+      puts '** [ditty] Running Ditty Migrations up'
+      ::Sequel.extension :migration
+      ::Sequel::Migrator.apply(::DB, folder)
+    end
+
+    desc 'Remove the whole Ditty database. You WILL lose data'
+    task :down do
+      ::DB.loggers << Logger.new($stdout) if ::DB.loggers.count.zero?
+      puts '** [ditty] Running Ditty Migrations down'
+      ::Sequel.extension :migration
+      ::Sequel::Migrator.apply(::DB, folder, 0)
+    end
+
+    desc 'Reset the Ditty database. You WILL lose data'
+    task :bounce do
+      ::DB.loggers << Logger.new($stdout) if ::DB.loggers.count.zero?
+      puts '** [ditty] Running Ditty Migrations bounce'
+      ::Sequel.extension :migration
+      ::Sequel::Migrator.apply(::DB, folder, 0)
+      ::Sequel::Migrator.apply(::DB, folder)
+    end
+  end
+end

data/lib/ditty/tasks/omniauth-ldap.rake

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+namespace :ditty do
+  namespace :ldap do
+    desc 'Check the LDAP settings'
+    task :check do
+      settings = Ditty::Services::Settings[:authentication][:ldap][:arguments].first
+      ldap = Net::LDAP.new host: settings[:host], port: settings[:port]
+      ldap.authenticate settings[:bind_dn], settings[:password] if settings[:bind_dn]
+      raise 'Could not bind to LDAP server' unless ldap.bind
+
+      puts 'LDAP Binding Successful'
+    end
+
+    desc 'Add the AD / LDAP Groups to Ditty as Roles'
+    task :populate_groups, [:filter] do |_task, args|
+      puts 'Adding AD / LDAP Groups to Ditty as Roles'
+      require 'ditty/services/settings'
+      require 'ditty/models/role'
+
+      settings = Ditty::Services::Settings[:authentication][:ldap][:arguments].first
+      ldap = Net::LDAP.new host: settings[:host], port: settings[:port]
+      ldap.authenticate settings[:bind_dn], settings[:password] if settings[:bind_dn]
+      if ldap.bind
+        group_filter = Net::LDAP::Filter.construct(settings[:group_filter]) unless settings[:group_filter].blank?
+        group_filter ||= Net::LDAP::Filter.eq('ObjectClass', 'Group')
+        if args[:filter]
+          search_filter = Net::LDAP::Filter.eq(*args[:filter].split(':', 2))
+          filter = Net::LDAP::Filter.join(group_filter, search_filter)
+        else
+          filter = group_filter
+        end
+        ldap.search(base: settings[:base], filter: filter).each do |group|
+          Ditty::Role.find_or_create(name: group.name) do |role|
+            puts "Adding #{role.name}"
+          end
+        end
+      else
+        puts 'Could not connect to LDAP Server'
+      end
+    end
+  end
+end

data/lib/ditty/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ditty
-  VERSION = '0.7.2'.freeze
+  VERSION = '0.8.0'
 end

data/lib/rubocop/cop/ditty/call_services_directly.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require 'rubocop/ast/node'
+require 'rubocop/cop/cop'
+
+module RuboCop
+  module Cop
+    module Ditty
+      # This cop enforces the use of `Service.method` instead of
+      # `Service.instance.method`. Calling the singleton instance has been
+      # deprecated for services.
+      #
+      # @example
+      #   # bad
+      #   Ditty::Services::Logger.instance.info 'This is a log message'
+      #
+      #   # good
+      #   Ditty::Services::Logger.info 'This is a log message'
+      class CallServicesDirectly < RuboCop::Cop::Cop
+        MSG = 'Do not use `.instance` on services. Call the method directly instead'
+
+        def_node_matcher :service_instance_call?, <<-PATTERN
+          (send (const (const (const ... :Ditty) :Services) _) :instance)
+        PATTERN
+
+        def on_send(node)
+          return unless service_instance_call?(node)
+
+          add_offense(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            internal = node.children.first.source
+            corrector.replace(node.loc.expression, internal)
+          end
+        end
+      end
+    end
+  end
+end

data/migrate/20181209_add_user_login_traits.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+Sequel.migration do
+  change do
+    create_table :user_login_traits do
+      primary_key :id
+      foreign_key :user_id, :users
+      String :ip_address, nullable: true
+      String :platform, nullable: true
+      String :device, nullable: true
+      String :browser, nullable: true
+      DateTime :created_at
+      DateTime :updated_at
+    end
+  end
+end

data/migrate/20181209_extend_audit_log.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+Sequel.migration do
+  change do
+    alter_table :audit_logs do
+      add_column :ip_address, String
+      add_column :platform, String
+      add_column :device, String
+      add_column :browser, String
+    end
+  end
+end

data/views/403.haml

@@ -0,0 +1,2 @@
+%p.lead
+  Your user is not allowed access to the requested URL.

data/views/audit_logs/index.haml

@@ -9,6 +9,10 @@
             %th User email
             %th Action
             %th Details
+            %th IP Address
+            %th Browser
+            %th Device
+            %th Platform
             %th Created at
         %tbody
           - if list.count > 0
@@ -19,12 +23,13 @@
                     %a{ href: "#{settings.map_path}/users/#{entity.user.id}" }= entity.user.email
                   -else
                     None
-                %td
-                  = entity.action
-                %td
-                  = entity.details
-                %td
-                  = entity.created_at.strftime('%Y-%m-%d %H:%M:%S')
+                %td= entity.action
+                %td= entity.details
+                %td= entity.ip_address || 'Unknown'
+                %td= entity.browser || 'Unknown'
+                %td= entity.device || 'Unknown'
+                %td= entity.platform || 'Unknown'
+                %td= entity.created_at&.strftime('%Y-%m-%d %H:%M:%S') || 'Unknown'
           - else
             %tr
               %td.text-center{ colspan: 4 } No records

data/views/auth/ldap.haml

@@ -0,0 +1,17 @@
+.row
+  .col-sm-2
+  .col-sm-8
+    .panel.panel-default
+      .panel-body
+        = form_tag("#{settings.map_path}/auth/ldap/callback", attributes: { class: '' }) do
+          .form-group
+            %label.control-label Username
+            %input.form-control.border-input{ name: 'username', tabindex: '1' }
+          .form-group
+            %label.control-label{ style: 'display: block' }
+              Password
+            %input.form-control.border-input{ name: 'password', type: 'password', tabindex: '2' }
+          %button.btn.btn-primary{ type: 'submit', tabindex: '3' }
+            %i.fa.fa-building
+            Log In
+  .col-sm-2

data/views/emails/forgot_password.haml

@@ -8,7 +8,7 @@
 		This reset is only valid for 24 hours
 
 %p.text-center
-	%a{ href: reset_url }
+	%a{ href: reset_url } Reset Password
 
 %p
 	For security purposes, if you did not request this password reset,

data/views/emails/layouts/action.haml

@@ -3,7 +3,8 @@
   %head
     %meta{:content => "width=device-width", :name => "viewport"}/
     %meta{:content => "text/html; charset=UTF-8", "http-equiv" => "Content-Type"}/
-    %title Actionable emails e.g. reset password
+    %title
+      = subject
     :css
       img {
       max-width: 100%;
@@ -59,10 +60,13 @@
         %td.container{:style => "font-family: 'Helvetica Neue',Helvetica,Arial,sans-serif; box-sizing: border-box; font-size: 14px; vertical-align: top; display: block !important; max-width: 600px !important; clear: both !important; margin: 0 auto;", :valign => "top", :width => "600"}
           .content{:style => "font-family: 'Helvetica Neue',Helvetica,Arial,sans-serif; box-sizing: border-box; font-size: 14px; max-width: 600px; display: block; margin: 0 auto; padding: 20px;"}
             = content
-            - if defined? footer
-              .footer{:style => "font-family: 'Helvetica Neue',Helvetica,Arial,sans-serif; box-sizing: border-box; font-size: 14px; width: 100%; clear: both; color: #999; margin: 0; padding: 20px;"}
-                %table{:style => "font-family: 'Helvetica Neue',Helvetica,Arial,sans-serif; box-sizing: border-box; font-size: 14px; margin: 0;", :width => "100%"}
-                  %tr{:style => "font-family: 'Helvetica Neue',Helvetica,Arial,sans-serif; box-sizing: border-box; font-size: 14px; margin: 0;"}
-                    %td.aligncenter.content-block{:align => "center", :style => "font-family: 'Helvetica Neue',Helvetica,Arial,sans-serif; box-sizing: border-box; font-size: 12px; vertical-align: top; color: #999; text-align: center; margin: 0; padding: 0 0 20px;", :valign => "top"}
+            .footer{:style => "font-family: 'Helvetica Neue',Helvetica,Arial,sans-serif; box-sizing: border-box; font-size: 14px; width: 100%; clear: both; color: #999; margin: 0; padding: 20px;"}
+              %table{:style => "font-family: 'Helvetica Neue',Helvetica,Arial,sans-serif; box-sizing: border-box; font-size: 14px; margin: 0;", :width => "100%"}
+                %tr{:style => "font-family: 'Helvetica Neue',Helvetica,Arial,sans-serif; box-sizing: border-box; font-size: 14px; margin: 0;"}
+                  %td.aligncenter.content-block{:align => "center", :style => "font-family: 'Helvetica Neue',Helvetica,Arial,sans-serif; box-sizing: border-box; font-size: 12px; vertical-align: top; color: #999; text-align: center; margin: 0; padding: 0 0 20px;", :valign => "top"}
+                    - if defined? footer
                       = footer
+                    - else
+                      This email was sent to
+                      = to
         %td{:style => "font-family: 'Helvetica Neue',Helvetica,Arial,sans-serif; box-sizing: border-box; font-size: 14px; vertical-align: top; margin: 0;", :valign => "top"}