ditty 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b443ee45c38fca3c0f69379d0631b03f1f91263
-  data.tar.gz: 3b26f6324b6979e1e517c6338e41cb994dce80c0
+  metadata.gz: a55bb96414dd9974ba6f8ce44aadacbc340967e4
+  data.tar.gz: c529f7ac183eedfc9530d7c8703660d9a8894093
 SHA512:
-  metadata.gz: 6794d0ac24c5fa6f0e95bd98e90cf8456f42b12c3cc8b3c0f3933f76a01912e1f62a798eddbc0076068351077b08d9e80e1071305630a256a9f27a78091071c3
-  data.tar.gz: 4356aa0fca5ffd090d90a39450d2d8f5dfa90286aa9d0c66e7708ded6e1669d1cfa853ea5d4dbab9dc34476c233e0f2e72b5bed759833b82f55cd7b52de561b3
+  metadata.gz: 759f21f4031b46c3f486081f238d8846402c0c1d7c85dab75fc6f19d096757150020e217531772e5cfca88c6a32031663a8fb71692a046c2956010d63c70cd24
+  data.tar.gz: b821ad004ff984706263355b5408ae66d33f0f230fe22057fefd28dc075308a7c74928f11b68ab08fa3540220b042fb386f82caded9400fe9847222aced3366c

data/.travis.yml

@@ -1,21 +1,29 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.0
-  - 2.3.3
-  - 2.2.6
+- 2.4.0
+- 2.3.3
+- 2.2.6
 gemfile: Gemfile.ci
 env:
-  - DATABASE_URL="sqlite::memory:" RACK_ENV=test
+- DATABASE_URL="sqlite::memory:" RACK_ENV=test
 before_install:
-  - gem install bundler -v 1.12.5
+- gem install bundler -v 1.12.5
 before_script:
-  - bundle exec rake ditty:prep
+- bundle exec rake ditty:prep
 script:
-  - bundle exec rake
-  - bundle exec rubocop --fail-level W lib views
+- bundle exec rake
+- bundle exec rubocop --fail-level W lib views
 addons:
   code_climate:
     repo_token: 289860573c6284a8e277de86848caba84d840be49e35f3601bcd672ab40d1e35
 after_success:
-  - bundle exec codeclimate-test-reporter
+- bundle exec codeclimate-test-reporter
+deploy:
+  provider: rubygems
+  api_key:
+    secure: i0GPUrE9cU31oOXoEiyAJEUU2EjGB8RAJ11veipq1x29F9sX3aDPWS2s9mk+uQsoUHC7IhziN8rD2Aw9bjNss+YywRvxA0M6bfP3w+C5v2rGV5j7p9R1pnUfKVgOIXTpOjocafgcUr6LslDhpdJileG29Z9dtQWi5wuqARXE54EhBPk1vvCh86l4t07vY4AbguNj73nbF2Rz0Z/+aZ9MrhS+rUhJ85ynIhH913ckl1jCjVycOTazyWdX6GBiEUYiToZBtQK/4XCsUuE4UQAcWXgNdwscV6WD1n53M2JBu6neqZzosLxyJ2aOZ65U643AtfrZd0qVqt1V9Od2083gwRmCXl58VltCDraXUbkWbqb/tfgdy4STeZilKNh5IPEmoySjjWiYmmN2vN+32D8ekyGRr2iciOSsMsy4pQW6r0MX16HfVct283guwIp4dFacVxQLuTZcjjkaRXILVOGuml/mcKxe48u82kHtlxveBKm0K9avDXupLWhXQ2Fy8B6q1z8ekSL4eNk1bcAyonXdQCgyHqlZQMEONd584XFVq1/L4yxvplxYoe4lOfTuDnwwTboHHZz8wLh27xAMguRhGUIa8oYTj8SgRZBpkVfUqQp14z/oH/qQ67MIY/kLWbjDY9cSA9MbhrOGCA/VczlLRkhmn4WJrYZHDyDMQkZwAOU=
+  gem: ditty
+  on:
+    tags: true
+    repo: EagerELK/ditty

data/lib/ditty/controllers/application.rb

@@ -38,6 +38,7 @@ module Ditty
 
     configure :production do
       disable :show_exceptions
+      set :dump_errors, false
     end
 
     configure :development do
@@ -46,7 +47,7 @@ module Ditty
 
     configure :production, :development do
       enable :logging
-      # use Rack::CommonLogger, Ditty::Services::Logger.instance
+      use Rack::CommonLogger, Ditty::Services::Logger.instance
     end
 
     not_found do
@@ -73,7 +74,7 @@ module Ditty
       end
     end
 
-    error Helpers::NotAuthenticated do
+    error Helpers::NotAuthenticated, ::Pundit::NotAuthorizedError do
       respond_to do |format|
         format.html do
           flash[:warning] = 'Please log in first.'
@@ -85,18 +86,6 @@ module Ditty
       end
     end
 
-    error ::Pundit::NotAuthorizedError do
-      respond_to do |format|
-        format.html do
-          flash[:warning] = 'Please log in first.'
-          redirect "#{settings.map_path}/auth/identity"
-        end
-        format.json do
-          [401, { 'Content-Type' => 'application/json' }, [{ code: 401, errors: ['Not Authorized'] }.to_json]]
-        end
-      end
-    end
-
     error ::Sequel::ForeignKeyConstraintViolation do
       respond_to do |format|
         format.html do
@@ -110,10 +99,11 @@ module Ditty
 
     before(/.*/) do
       ::Ditty::Services::Logger.instance.debug "Running with #{self.class}"
-      if request.url =~ /.json/
-        request.accept.unshift('application/json')
-        request.path_info = request.path_info.gsub(/.json/, '')
+      if request.path =~ /.*\.json\Z/
+        content_type :json
       end
+      # Ensure the accept header is set. People forget to include it in API requests
+      content_type(:json) if request.accept.count.eql?(1) && request.accept.first.to_s.eql?('*/*')
     end
   end
 end

data/lib/ditty/controllers/component.rb

@@ -2,11 +2,12 @@
 
 require 'ditty/controllers/application'
 require 'ditty/helpers/component'
+require 'ditty/helpers/response'
 require 'sinatra/json'
 
 module Ditty
   class Component < Application
-    helpers Helpers::Component
+    helpers Helpers::Component, Helpers::Response
 
     set base_path: nil
     set dehumanized: nil
@@ -18,28 +19,13 @@ module Ditty
     end
 
     # List
-    get '/', provides: %i[html json] do
+    get '/' do
       authorize settings.model_class, :list
 
-      actions = {}
-      actions["#{base_path}/new"] = "New #{heading}" if policy(settings.model_class).create?
+      result = list
 
       log_action("#{dehumanized}_list".to_sym) if settings.track_actions
-      respond_to do |format|
-        format.html do
-          haml :"#{view_location}/index",
-               locals: { list: list, title: heading(:list), actions: actions }
-        end
-        format.json do
-          # TODO: Add links defined by actions (New #{heading})
-          json(
-            'items' => list.all.map(&:for_json),
-            'page' => (params['page'] || 1).to_i,
-            'count' => list.count,
-            'total' => dataset.count
-          )
-        end
-      end
+      list_response(result)
     end
 
     # Create Form
@@ -52,29 +38,13 @@ module Ditty
 
     # Create
     post '/' do
-      authorize settings.model_class, :create
       entity = settings.model_class.new(permitted_attributes(settings.model_class, :create))
-      success = entity.valid? && entity.save
+      authorize entity, :create
 
-      log_action("#{dehumanized}_create".to_sym) if success && settings.track_actions
-      respond_to do |format|
-        format.html do
-          if success
-            flash[:success] = "#{heading} Created"
-            redirect "#{base_path}/#{entity.id}"
-          else
-            haml :"#{view_location}/new", locals: { entity: entity, title: heading(:new) }
-          end
-        end
-        format.json do
-          content_type :json
-          if success
-            redirect "#{base_path}/#{entity.id}", 201
-          else
-            [400, { errors: entity.errors }.to_json]
-          end
-        end
-      end
+      entity.save # Will trigger a Sequel::ValidationFailed exception if the model is incorrect
+
+      log_action("#{dehumanized}_create".to_sym) if settings.track_actions
+      create_response(entity)
     end
 
     # Read
@@ -83,20 +53,8 @@ module Ditty
       halt 404 unless entity
       authorize entity, :read
 
-      actions = {}
-      actions["#{base_path}/#{entity.id}/edit"] = "Edit #{heading}" if policy(entity).update?
-
       log_action("#{dehumanized}_read".to_sym) if settings.track_actions
-      respond_to do |format|
-        format.html do
-          haml :"#{view_location}/display",
-               locals: { entity: entity, title: heading, actions: actions }
-        end
-        format.json do
-          # TODO: Add links defined by actions (Edit #{heading})
-          json entity.for_json
-        end
-      end
+      read_response(entity)
     end
 
     # Update Form
@@ -115,32 +73,10 @@ module Ditty
       authorize entity, :update
 
       entity.set(permitted_attributes(settings.model_class, :update))
+      entity.save # Will trigger a Sequel::ValidationFailed exception if the model is incorrect
 
-      success = entity.valid? && entity.save
-      log_action("#{dehumanized}_update".to_sym) if success && settings.track_actions
-      if success
-        respond_to do |format|
-          format.html do
-            # TODO: Ability to customize the return path and message?
-            flash[:success] = "#{heading} Updated"
-            redirect "#{base_path}/#{entity.id}"
-          end
-          format.json do
-            headers 'Location' => "#{base_path}/#{entity.id}"
-            json body entity.for_json
-          end
-        end
-      else
-        respond_to do |format|
-          format.html do
-            haml :"#{view_location}/edit", locals: { entity: entity, title: heading(:edit) }
-          end
-          format.json do
-            content_type :json
-            [400, { errors: entity.errors }.to_json]
-          end
-        end
-      end
+      log_action("#{dehumanized}_update".to_sym) if settings.track_actions
+      update_response(entity)
     end
 
     delete '/:id' do |id|
@@ -151,15 +87,20 @@ module Ditty
       entity.destroy
 
       log_action("#{dehumanized}_delete".to_sym) if settings.track_actions
+      delete_response(entity)
+    end
+
+    error Sequel::ValidationFailed do
       respond_to do |format|
+        entity = env['sinatra.error'].model
+        errors = env['sinatra.error'].errors
+        status 400
         format.html do
-          flash[:success] = "#{heading} Deleted"
-          redirect base_path.to_s
+          action = entity.id ? :edit : :new
+          haml :"#{view_location}/#{action}", locals: { entity: entity, title: heading(action) }
         end
         format.json do
-          content_type :json
-          headers 'Location' => '/users'
-          status 204
+          json [400, { errors: errors }]
         end
       end
     end

data/lib/ditty/controllers/main.rb

@@ -18,6 +18,12 @@ module Ditty
     # OmniAuth Identity Stuff
     # Log in Page
     get '/auth/identity' do
+      # Redirect to the registration page if there's no SA user
+      sa = Role.find_or_create(name: 'super_admin')
+      if User.where(roles: sa).count == 0
+        flash[:info] = 'Please register the super admin user.'
+        redirect "#{settings.map_path}/auth/identity/register"
+      end
       haml :'identity/login', locals: { title: 'Log In' }
     end
 

data/lib/ditty/controllers/users.rb

@@ -42,47 +42,20 @@ module Ditty
       user     = locals[:user]     = User.new(user_params)
       identity = locals[:identity] = Identity.new(identity_params)
 
-      if identity.valid? && user.valid?
-        DB.transaction(isolation: :serializable) do
-          identity.save
-          user.save
-          user.add_identity identity
-          if roles
-            roles.each do |role_id|
-              user.add_role(role_id) unless user.roles.map(&:id).include? role_id.to_i
-            end
-          end
-          user.check_roles
-        end
-
-        log_action("#{dehumanized}_create".to_sym) if settings.track_actions
-        respond_to do |format|
-          format.html do
-            flash[:success] = 'User created'
-            redirect "#{base_path}/#{user.id}"
-          end
-          format.json do
-            headers 'Content-Type' => 'application/json'
-            redirect "#{base_path}/#{user.id}", 201
-          end
-        end
-      else
-        respond_to do |format|
-          format.html do
-            flash.now[:danger] = 'Could not create the user'
-            locals[:entity] = user
-            locals[:identity] = identity
-            haml :"#{view_location}/new", locals: locals
-          end
-          format.json do
-            headers \
-              'Content-Type' => 'application/json',
-              'Content-Location' => "#{view_location}/new"
-            body ''
-            status 402
+      DB.transaction(isolation: :serializable) do
+        identity.save # Will trigger a Sequel::ValidationFailed exception if the model is incorrect
+        user.save
+        user.add_identity identity
+        if roles
+          roles.each do |role_id|
+            user.add_role(role_id) unless user.roles.map(&:id).include? role_id.to_i
           end
         end
+        user.check_roles
       end
+
+      log_action("#{dehumanized}_create".to_sym) if settings.track_actions
+      create_response(user)
     end
 
     # Update
@@ -94,36 +67,16 @@ module Ditty
       values = permitted_attributes(settings.model_class, :update)
       roles  = values.delete('role_id')
       entity.set values
-      if entity.valid? && entity.save
-        if roles
-          entity.remove_all_roles
-          roles.each { |role_id| entity.add_role(role_id) }
-          entity.check_roles
-        end
+      entity.save # Will trigger a Sequel::ValidationFailed exception if the model is incorrect
 
-        log_action("#{dehumanized}_update".to_sym) if settings.track_actions
-        respond_to do |format|
-          format.html do
-            flash[:success] = "#{heading} Updated"
-            redirect back
-          end
-          format.json do
-            content_type 'application/json'
-            headers 'Location' => "/users/#{entity.id}"
-            body entity.to_hash.to_json
-            status 200
-          end
-        end
-      else
-        respond_to do |format|
-          format.html do
-            haml :"#{view_location}/edit", locals: { entity: entity, title: heading(:edit) }
-          end
-          format.json do
-            400
-          end
-        end
+      if roles
+        entity.remove_all_roles
+        roles.each { |role_id| entity.add_role(role_id) }
+        entity.check_roles
       end
+
+      log_action("#{dehumanized}_update".to_sym) if settings.track_actions
+      update_response(entity)
     end
 
     put '/:id/identity' do |id|
@@ -169,17 +122,7 @@ module Ditty
       entity.destroy
 
       log_action("#{dehumanized}_delete".to_sym) if settings.track_actions
-      respond_to do |format|
-        format.html do
-          flash[:success] = "#{heading} Deleted"
-          redirect base_path
-        end
-        format.json do
-          content_type 'application/json'
-          headers 'Location' => '/users'
-          status 204
-        end
-      end
+      delete_response(entity)
     end
 
     # Profile

data/lib/ditty/db.rb

@@ -2,8 +2,12 @@
 
 require 'sequel'
 require 'ditty/services/logger'
+require 'active_support'
+require 'active_support/core_ext/object/blank'
 
-if ENV['DATABASE_URL']
+if defined? DB
+  Ditty::Services::Logger.instance.warn 'Database connection already set up'
+elsif ENV['DATABASE_URL'].blank? == false
   # Delete DATABASE_URL from the environment, so it isn't accidently
   # passed to subprocesses.  DATABASE_URL may contain passwords.
   DB = Sequel.connect(ENV['RACK_ENV'] == 'production' ? ENV.delete('DATABASE_URL') : ENV['DATABASE_URL'])

data/lib/ditty/helpers/component.rb

@@ -16,7 +16,8 @@ module Ditty
         count = params['count'] || 10
         page = params['page'] || 1
 
-        dataset.select.paginate(page.to_i, count.to_i)
+        ds = dataset.select
+        count == 'all' ? ds : ds.paginate(page.to_i, count.to_i)
       end
 
       def heading(action = nil)
@@ -83,11 +84,13 @@ module Ditty
         assoc
       end
 
+      def search_filters
+        searchable_fields.map { |f| Sequel.ilike(f.to_sym, "%#{params[:q]}%") }
+      end
+
       def search(dataset)
         return dataset if ['', nil].include?(params['q']) || searchable_fields == []
-
-        filters = searchable_fields.map { |f| Sequel.ilike(f.to_sym, "%#{params[:q]}%") }
-        dataset.where Sequel.|(*filters)
+        dataset.where Sequel.|(*search_filters)
       end
     end
   end

data/lib/ditty/helpers/response.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Ditty
+  module Helpers
+    module Response
+      def list_response(result)
+        respond_to do |format|
+          format.html do
+            actions = {}
+            actions["#{base_path}/new"] = "New #{heading}" if policy(settings.model_class).create?
+            haml :"#{view_location}/index",
+                 locals: { list: result, title: heading(:list), actions: actions }
+          end
+          format.json do
+            # TODO: Add links defined by actions (New #{heading})
+            json(
+              'items' => result.all.map(&:for_json),
+              'page' => (params['page'] || 1).to_i,
+              'count' => result.count,
+              'total' => result.pagination_record_count
+            )
+          end
+        end
+      end
+
+      def create_response(entity)
+        respond_to do |format|
+          format.html do
+            flash[:success] = "#{heading} Created"
+            redirect "#{base_path}/#{entity.id}"
+          end
+          format.json do
+            content_type :json
+            redirect "#{base_path}/#{entity.id}", 201
+          end
+        end
+      end
+
+      def read_response(entity)
+        respond_to do |format|
+          format.html do
+            actions = {}
+            actions["#{base_path}/#{entity.id}/edit"] = "Edit #{heading}" if policy(entity).update?
+            title = heading(:read) + (entity.respond_to?(:name) ? ": #{entity.name}" : '')
+            haml :"#{view_location}/display", locals: { entity: entity, title: title, actions: actions }
+          end
+          format.json do
+            # TODO: Add links defined by actions (Edit #{heading})
+            json entity.for_json
+          end
+        end
+      end
+
+      def update_response(entity)
+        respond_to do |format|
+          format.html do
+            # TODO: Ability to customize the return path and message?
+            flash[:success] = "#{heading} Updated"
+            redirect "#{base_path}/#{entity.id}"
+          end
+          format.json do
+            headers 'Location' => "#{base_path}/#{entity.id}"
+            json body entity.for_json
+          end
+        end
+      end
+
+      def delete_response(_entity)
+        respond_to do |format|
+          format.html do
+            flash[:success] = "#{heading} Deleted"
+            redirect base_path.to_s
+          end
+          format.json do
+            content_type :json
+            headers 'Location' => "#{base_path}"
+            status 204
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ditty/helpers/views.rb

@@ -47,6 +47,7 @@ module Ditty
       end
 
       def pagination(list, base_path, qp = {})
+        return unless list.respond_to? :pagination_record_count
         qs = params.clone.merge(qp)
         qs.delete('captures')
         locals = {

data/lib/ditty/rake_tasks.rb

@@ -2,7 +2,7 @@
 
 require 'rake'
 require 'rake/tasklib'
-require 'ditty/db'
+require 'ditty/db' unless defined? DB
 
 module Ditty
   class Tasks < ::Rake::TaskLib

data/lib/ditty/version.rb

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

data/views/partials/notifications.haml

@@ -1,24 +1,28 @@
 - if flash[:danger]
   .alert.alert-danger.alert-dismissible{ role: "alert" }
     %button.close{ 'type' => 'button', 'aria-hidden' => 'true', 'area-label' => 'true', 'data-dismiss' => 'alert' } ×
-    - (flash[:danger].is_a?(Array) ? flash[:danger] : [flash[:danger]]).each do |msg|
-      %span= msg
+    %ul
+      - [*flash[:danger]].each do |msg|
+        %li= msg
 
 - if flash[:warning]
   .alert.alert-warning.alert-dismissible{ role: "alert" }
     %button.close{ 'type' => 'button', 'aria-hidden' => 'true', 'area-label' => 'true', 'data-dismiss' => 'alert' } ×
-    - (flash[:warning].is_a?(Array) ? flash[:warning] : [flash[:warning]]).each do |msg|
-      %span= msg
+    %ul
+      - [*flash[:warning]].each do |msg|
+        %li= msg
 
 - if flash[:success]
   .alert.alert-success.alert-dismissible{ role: "alert" }
     %button.close{ 'type' => 'button', 'aria-hidden' => 'true', 'area-label' => 'true', 'data-dismiss' => 'alert' } ×
-    - (flash[:success].is_a?(Array) ? flash[:success] : [flash[:success]]).each do |msg|
-      %span= msg
+    %ul
+      - [*flash[:success]].each do |msg|
+        %li= msg
 
 
 - if flash[:info]
   .alert.alert-info.alert-dismissible{ role: "alert" }
     %button.close{ 'type' => 'button', 'aria-hidden' => 'true', 'area-label' => 'true', 'data-dismiss' => 'alert' } ×
-    - (flash[:info].is_a?(Array) ? flash[:info] : [flash[:info]]).each do |msg|
-      %span= msg
+    %ul
+      - [*flash[:info]].each do |msg|
+        %li= msg

data/views/users/index.haml

@@ -8,6 +8,7 @@
             %th Name
             %th Surname
             %th Roles
+            %th Signed Up
         %tbody
           - list.all.each do |entity|
             %tr
@@ -16,6 +17,7 @@
               %td= entity.name
               %td= entity.surname
               %td= entity.roles_dataset.map(:name).map(&:titlecase).join(', ')
+              %td= entity.created_at.strftime('%Y-%m-%d')
       - if policy(::Ditty::User).create?
         .panel-body.text-right
           %a.btn.btn-primary{ href: "#{base_path}/new" } New User

data/views/users/new.haml

@@ -4,7 +4,7 @@
     .panel.panel-default
       .panel-body
         %form.form-horizontal{ method: 'post', action: base_path }
-          = haml :'users/identity', locals: { identity: identity }
+          = haml :'users/identity', locals: { identity: Ditty::Identity.new }
           = haml :'users/user', locals: { user: entity }
           %button.btn.btn-primary{ type: 'submit' }
             Create User

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ditty
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Jurgens du Toit
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
+date: 2018-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -349,6 +349,7 @@ files:
 - lib/ditty/helpers/authentication.rb
 - lib/ditty/helpers/component.rb
 - lib/ditty/helpers/pundit.rb
+- lib/ditty/helpers/response.rb
 - lib/ditty/helpers/views.rb
 - lib/ditty/helpers/wisper.rb
 - lib/ditty/listener.rb