ditty 0.8.0 → 0.10.2

data/spec/support/api_shared_examples.rb

@@ -0,0 +1,250 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'active_support/core_ext/hash/except'
+
+shared_examples 'an API interface' do |subject, params|
+  before { create(subject) }
+
+  context 'GET /' do
+    it 'returns HTML when requested' do
+      header 'Accept', 'text/html'
+      get '/'
+
+      expect(last_response).to be_ok
+      expect(last_response.headers['Content-Type']).to include('text/html;charset=utf-8')
+    end
+
+    it 'returns JSON when requested' do
+      header 'Accept', 'application/json'
+      get '/'
+
+      expect(last_response).to be_ok
+      expect(last_response.headers).to include('Content-Type' => 'application/json')
+      expect { JSON.parse(last_response.body) }.not_to raise_error
+    end
+
+    it 'returns a list object' do
+      header 'Accept', 'application/json'
+      get '/'
+
+      response = JSON.parse last_response.body
+      expect(response).to include('page', 'count', 'total', 'items')
+      expect(response['page']).to be_an Integer
+      expect(response['count']).to be_an Integer
+      expect(response['total']).to be_an Integer
+      expect(response['items']).to be_an Array
+    end
+  end
+
+  context 'GET /id' do
+    let(:entity) { create(subject) }
+
+    it 'returns HTML when requested' do
+      header 'Accept', 'text/html'
+      get "/#{entity.id}"
+
+      expect(last_response).to be_ok
+      expect(last_response.headers).to include('Content-Type' => 'text/html;charset=utf-8')
+    end
+
+    it 'returns JSON when requested' do
+      header 'Accept', 'application/json'
+      get "/#{entity.id}"
+
+      expect(last_response).to be_ok
+      expect(last_response.headers).to include('Content-Type' => 'application/json')
+      expect { JSON.parse(last_response.body) }.not_to raise_error
+    end
+
+    it 'returns the fetched object' do
+      header 'Accept', 'application/json'
+      get "/#{entity.id}"
+
+      response = JSON.parse last_response.body
+      expect(response).to be_a Hash
+      entity_to_json = JSON.parse entity.values.to_json
+      expect(response).to include(entity_to_json)
+    end
+  end
+
+  context 'POST /' do
+    it 'returns HTML when requested' do
+      header 'Accept', 'text/html'
+      header 'Content-Type', 'application/x-www-form-urlencoded'
+      params[subject] = build(subject).to_hash
+      post '/', params
+
+      expect(last_response.headers).to include('Content-Type' => 'text/html;charset=utf-8')
+    end
+
+    it 'returns a 302 Redirect response for a HTML Request' do
+      header 'Accept', 'text/html'
+      header 'Content-Type', 'application/x-www-form-urlencoded'
+      params[subject] = build(subject).to_hash
+      post '/', params
+
+      expect(last_response.status).to eq 302
+      expect(last_response.headers).to include('Location')
+    end
+
+    it 'returns JSON when requested' do
+      header 'Accept', 'application/json'
+      header 'Content-Type', 'application/json'
+      params[subject] = build(subject).to_hash
+      post '/', params.to_json
+
+      expect(last_response.headers).to include('Content-Type' => 'application/json')
+    end
+
+    it 'returns a 201 Created response for a JSON Request' do
+      header 'Accept', 'application/json'
+      header 'Content-Type', 'application/json'
+      params[subject] = build(subject).to_hash
+      post '/', params.to_json
+
+      expect(last_response.status).to eq 201
+    end
+
+    it 'returns a Location Header for a JSON Request' do
+      header 'Accept', 'application/json'
+      header 'Content-Type', 'application/json'
+      params[subject] = build(subject).to_hash
+      post '/', params.to_json
+
+      expect(last_response.headers).to include 'Location'
+    end
+
+    it 'returns an empty body for a JSON Request' do
+      header 'Accept', 'application/json'
+      header 'Content-Type', 'application/json'
+      params[subject] = build(subject).to_hash
+      post '/', params.to_json
+
+      expect(last_response.body).to eq ''
+    end
+  end
+
+  context 'PUT /:id' do
+    let(:entity) { create(subject) }
+
+    it 'returns HTML when requested' do
+      header 'Accept', 'text/html'
+      header 'Content-Type', 'application/x-www-form-urlencoded'
+
+      values = entity.to_hash.except(:id)
+      params[subject] = values
+      put "/#{entity.id}", params
+
+      expect(last_response.headers).to include('Content-Type' => 'text/html;charset=utf-8')
+    end
+
+    it 'returns a 302 Redirect response for a HTML Request' do
+      header 'Accept', 'text/html'
+      header 'Content-Type', 'application/x-www-form-urlencoded'
+
+      values = entity.to_hash.except(:id)
+      params[subject] = values
+      put "/#{entity.id}", params
+
+      expect(last_response.status).to eq 302
+      expect(last_response.headers).to include('Location')
+    end
+
+    it 'returns JSON when requested' do
+      header 'Accept', 'application/json'
+      header 'Content-Type', 'application/json'
+
+      values = entity.to_hash.except(:id)
+      params[subject] = values
+      put "/#{entity.id}", params.to_json
+
+      expect(last_response.headers).to include('Content-Type' => 'application/json')
+    end
+
+    it 'returns a 200 OK response for a JSON Request' do
+      header 'Accept', 'application/json'
+      header 'Content-Type', 'application/json'
+
+      values = entity.to_hash.except(:id)
+      params[subject] = values
+      put "/#{entity.id}", params.to_json
+
+      expect(last_response.status).to eq 200
+    end
+
+    it 'returns a Location Header for a JSON Request' do
+      header 'Accept', 'application/json'
+      header 'Content-Type', 'application/json'
+
+      values = entity.to_hash.except(:id)
+      params[subject] = values
+      put "/#{entity.id}", params.to_json
+
+      expect(last_response.headers).to include 'Location'
+    end
+
+    it 'returns the updated entity in the body for a JSON Request' do
+      header 'Accept', 'application/json'
+      header 'Content-Type', 'application/json'
+
+      values = entity.to_hash.except(:id)
+      params[subject] = values
+      put "/#{entity.id}", params.to_json
+
+      response = JSON.parse last_response.body
+      entity_to_hash = JSON.parse entity.values.to_json
+      expect(response).to eq entity_to_hash
+    end
+  end
+
+  context 'DELETE /:id' do
+    let(:entity) { create(subject) }
+
+    it 'returns HTML when requested' do
+      header 'Accept', 'text/html'
+      header 'Content-Type', 'application/x-www-form-urlencoded'
+
+      delete "/#{entity.id}"
+
+      expect(last_response.headers).to include('Content-Type' => 'text/html;charset=utf-8')
+    end
+
+    it 'returns a 302 Redirect response for a HTML Request' do
+      header 'Accept', 'text/html'
+      header 'Content-Type', 'application/x-www-form-urlencoded'
+
+      delete "/#{entity.id}"
+
+      expect(last_response.status).to eq 302
+      expect(last_response.headers).to include('Location')
+    end
+
+    it 'returns JSON when requested' do
+      header 'Accept', 'application/json'
+      header 'Content-Type', 'application/json'
+
+      delete "/#{entity.id}"
+
+      expect(last_response.headers).to include('X-Content-Type-Options' => 'nosniff')
+    end
+
+    it 'returns a 204 No Content response for a JSON Request' do
+      header 'Accept', 'application/json'
+      header 'Content-Type', 'application/json'
+
+      delete "/#{entity.id}"
+
+      expect(last_response.status).to eq 204
+    end
+
+    it 'returns an empty body for a JSON Request' do
+      header 'Accept', 'application/json'
+      header 'Content-Type', 'application/json'
+
+      delete "/#{entity.id}"
+
+      expect(last_response.body).to eq ''
+    end
+  end
+end

data/spec/support/crud_shared_examples.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+shared_examples 'a CRUD Controller' do |route|
+  context 'GET' do
+    it '/doesnotexist' do
+      get '/doesnotexist'
+      expect(last_response).not_to be_ok
+      expect(last_response.status).to eq 404
+    end
+
+    it route.to_s do
+      model # Ensure that there's at least one item in the list
+      get '/'
+
+      if Pundit.policy(user, app.model_class).list?
+        expect(last_response).to be_ok, "Expected OK response, got #{last_response.status}"
+      else
+        expect(last_response).not_to be_ok, "Expected a NOT OK response, got #{last_response.status}"
+      end
+    end
+
+    it "#{route}?count=1&page=1" do
+      model # Ensure that there's at least one item in the list
+      get '/?count=1&page=1'
+
+      if Pundit.policy(user, app.model_class).list?
+        expect(last_response).to be_ok, "Expected OK response, got #{last_response.status}"
+      else
+        expect(last_response).not_to be_ok, "Expected a NOT OK response, got #{last_response.status}"
+      end
+    end
+
+    it "#{route}/new" do
+      get '/new'
+
+      if Pundit.policy(user, app.model_class).create?
+        expect(last_response).to be_ok, "Expected OK response, got #{last_response.status}"
+      else
+        expect(last_response).not_to be_ok, "Expected a NOT OK response, got #{last_response.status}"
+      end
+    end
+
+    it "#{route}/id" do
+      get "/#{model.id}"
+
+      if Pundit.policy(user, model).read?
+        expect(last_response).to be_ok, "Expected OK response, got #{last_response.status}"
+      else
+        expect(last_response).not_to be_ok, "Expected a NOT OK response, got #{last_response.status}"
+      end
+    end
+
+    it "#{route}/id/edit" do
+      get "/#{model.id}/edit"
+
+      if Pundit.policy(user, model).update?
+        expect(last_response).to be_ok, "Expected OK response, got #{last_response.status}"
+      else
+        expect(last_response).not_to be_ok, "Expected a NOT OK response, got #{last_response.status}"
+      end
+    end
+  end
+
+  context 'POST' do
+    it '/doesnotexist' do
+      header 'Accept', 'text/html'
+      post '/doesnotexist'
+      expect(last_response).not_to be_ok, "Expected a NOT OK response, got #{last_response.status}"
+      expect(last_response.status).to eq 404
+    end
+
+    it route.to_s do
+      header 'Accept', 'text/html'
+      post '/', create_data
+
+      if Pundit.policy(user, app.model_class).create?
+        expect(last_response.status).to eq 302
+      else
+        expect(last_response).not_to be_ok, "Expected a NOT OK response, got #{last_response.status}"
+      end
+    end
+
+    it "#{route} with invalid parameters" do
+      header 'Accept', 'text/html'
+      header 'Content-Type', 'application/x-www-form-urlencoded'
+      post '/', invalid_create_data
+
+      if Pundit.policy(user, app.model_class).create?
+        expect(last_response.status).to eq 400
+      else
+        expect(last_response).not_to be_ok, "Expected a NOT OK response, got #{last_response.status}"
+      end
+    end
+  end
+
+  context 'PUT' do
+    it '/doesnotexist' do
+      header 'Accept', 'text/html'
+      put '/doesnotexist'
+      expect(last_response).not_to be_ok, "Expected a NOT OK response, got #{last_response.status}"
+      expect(last_response.status).to eq 404
+    end
+
+    it "#{route}/:id" do
+      header 'Accept', 'text/html'
+      put "/#{model.id}", update_data
+
+      if Pundit.policy(user, model).update?
+        expect(last_response.status).to eq 302
+      else
+        expect(last_response).not_to be_ok, "Expected a NOT OK response, got #{last_response.status}"
+      end
+    end
+
+    it "#{route} with invalid parameters" do
+      header 'Accept', 'text/html'
+      put "/#{model.id}", invalid_update_data
+
+      if Pundit.policy(user, model).update?
+        expect(last_response.status).to eq 400
+      else
+        expect(last_response).not_to be_ok, "Expected a NOT OK response, got #{last_response.status}"
+      end
+    end
+  end
+
+  context 'DELETE' do
+    it '/doesnotexist' do
+      delete '/doesnotexist'
+      expect(last_response).not_to be_ok, "Expected a NOT OK response, got #{last_response.status}"
+      expect(last_response.status).to eq 404
+    end
+
+    it "#{route}/id" do
+      header 'Accept', 'text/html'
+      delete "/#{model.id}"
+
+      if Pundit.policy(user, model).delete?
+        expect(last_response.status).to eq 302
+      else
+        expect(last_response).not_to be_ok
+      end
+    end
+  end
+end

data/views/403.haml

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

data/views/404.haml

@@ -1,7 +1,5 @@
-%h2 Whoops!
-
-%p.lead
+%p.lead.text-center
   We could not find the page you were looking for...
 
 .text-center
-  %iframe{ width: 560, height: 315, src: 'https://www.youtube.com/embed/e3-5YC_oHjE', frameborder: 0, allowfullscreen: true }
+  %iframe{ width: 560, height: 315, src: 'https://www.youtube.com/embed/e3-5YC_oHjE', frameborder: 0, allowfullscreen: true }

data/views/500.haml

@@ -0,0 +1,11 @@
+%p.lead.text-center
+  A call to Elasticsearch failed unexpectedly.
+
+- if current_user.admin?
+  %p
+    The error was:
+    %bt
+    = error.message
+  - if current_user.super_admin?
+    %pre
+      %code= error.backtrace.join("\n")

data/views/audit_logs/index.haml

@@ -1,37 +1,36 @@
 .row
   .col-md-12
-    .panel.panel-default
-      .panel-body
-        = haml :'partials/search'
-      %table.table.table-striped
-        %thead
-          %tr
-            %th User email
-            %th Action
-            %th Details
-            %th IP Address
-            %th Browser
-            %th Device
-            %th Platform
-            %th Created at
-        %tbody
-          - if list.count > 0
-            - list.all.each do |entity|
-              %tr
-                %td
-                  -if entity.user
-                    %a{ href: "#{settings.map_path}/users/#{entity.user.id}" }= entity.user.email
-                  -else
-                    None
-                %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
+    = haml :'partials/search'
+    %table.table.table-striped.table-bordered.table-hover
+      %thead.thead-dark
+        %tr
+          %th= "User #{sort_ui(:user)}"
+          %th= "Action #{sort_ui(:action)}"
+          %th= "Details #{sort_ui(:details)}"
+          %th= "IP Address #{sort_ui(:ip_address)}"
+          %th= "Browser #{sort_ui(:browser)}"
+          %th= "Device #{sort_ui(:device)}"
+          %th= "Platform #{sort_ui(:platform)}"
+          %th= "Created At #{sort_ui(:created_at)}"
+      %tbody
+        - if list.count > 0
+          - list.all.each do |entity|
             %tr
-              %td.text-center{ colspan: 4 } No records
+              %td
+                -if entity.user
+                  %a{ href: "#{settings.map_path}/users/#{entity.user.id}" }= entity.user.email
+                -else
+                  None
+              %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
 
-=pagination(list, base_path)
+- if list.count > 0
+  = pagination(list, base_path)