ditty 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f88c10fb42b6cc8dd793998baaaf909a4dc6c0a
+  data.tar.gz: 5a72a520051492ee1a769cdeef56d943bbda6c55
+SHA512:
+  metadata.gz: 2ba59d3510c55c01ca48b49cc1f601b2dcd2f4872670fedade8a2d0d8a8f36cc42382f05361f1cda1cd7646f2d3af71f9f105f4230bc5c9a56051e15b7a38817
+  data.tar.gz: ae4ea9466221bd370ce5de8b1e19993804c77c16f9070ca323ece9e6f8ebe4ba578ad207ec51741115303672fcb4006d346bea9b1e5c2a3a0ec5c49dd8e24838

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*_secret
+/node_modules
+.vagrant
+*.db
+/Gemfile.dev.lock

data/.pryrc

@@ -0,0 +1,6 @@
+if defined?(PryByebug)
+  Pry.commands.alias_command 'c', 'continue'
+  Pry.commands.alias_command 's', 'step'
+  Pry.commands.alias_command 'n', 'next'
+  Pry.commands.alias_command 'f', 'finish'
+end

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,15 @@
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/LeadingCommentSpace:
+  Exclude:
+    - 'config.ru'
+
+AllCops:
+  TargetRubyVersion: 2.2

data/.travis.yml

@@ -0,0 +1,15 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.3.3
+  - 2.2.6
+gemfile: Gemfile.ci
+env:
+  - DATABASE_URL="sqlite::memory:" RACK_ENV=test
+before_install: gem install bundler -v 1.12.5
+addons:
+  code_climate:
+    repo_token: 289860573c6284a8e277de86848caba84d840be49e35f3601bcd672ab40d1e35
+after_success:
+  - bundle exec codeclimate-test-reporter

data/Gemfile.ci

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rubocop'
+gem 'simplecov', '~> 0.13.0'
+gem 'sqlite3'
+
+if RUBY_VERSION < '2.1'
+  gem 'sidekiq', '3.0.0'
+  gem 'activesupport', '<4.0.0'
+  gem 'omniauth', '~>1.4.2'
+elsif RUBY_VERSION < '2.2.0'
+  gem 'sidekiq', '4.0.0'
+  gem 'activesupport', '<5.0.0'
+else
+  gem 'activesupport'
+end

data/License.txt

@@ -0,0 +1,7 @@
+Copyright 2017 Jade IT cc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'ditty/rake_tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/Readme.md

@@ -0,0 +1,67 @@
+[![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)
+
+# Ditty
+
+Ditty provides an extra layer of functionality on top of [Sinatra](http://sinatrarb.com/) to give structure and basic tools to an already great framework. You can get a new application, with user authentication and basic CRUD / REST interfaces, up and running in minutes.
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+gem 'ditty'
+gem 'sqlite3'
+```
+
+You can replace `sqlite3` with a DB adapter of your choice.
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install ditty
+```
+
+## Usage
+
+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. Add the Ditty rake tasks to your Rakefile: `require 'ditty/rake_tasks'`
+3. Set the DB connection as the `DATABASE_URL` ENV variable: `DATABASE_URL=sqlite://development.db`
+4. Create and populate the DB and secret tokens:
+
+```bash
+bundle exec rake proxes:prep
+bundle exec rake proxes:generate_tokens
+bundle exec rake proxes:migrate
+bundle exec rake proxes:seed
+```
+
+4. Start up the web app: `bundle exec rackup`
+
+## Components
+
+The application can now be further extended by creating components.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/EagerELK/ditty.
+
+## License
+
+The Ditty gem is an Open Source project licensed under the terms of
+the MIT license.  Please see [MIT license](License.txt)
+for license text.

data/config.ru

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'rack/protection'
+use Rack::Session::Cookie,
+    key: '_Ditty_session',
+    # :secure=>!TEST_MODE, # Uncomment if only allowing https:// access
+    secret: File.read('.session_secret')
+use Rack::Protection::RemoteToken
+use Rack::Protection::SessionHijacking
+
+require 'ditty/components/app'
+Ditty.component :app
+
+require 'omniauth'
+require 'omniauth/identity'
+OmniAuth.config.logger = Ditty::Services::Logger.instance
+OmniAuth.config.on_failure = proc { |env|
+  OmniAuth::FailureEndpoint.new(env).redirect_to_failure
+}
+require 'ditty/controllers/main'
+require 'ditty/models/identity'
+use OmniAuth::Builder do
+  # The identity provider is used by the App.
+  provider :identity,
+           fields: [:username],
+           callback_path: '/auth/identity/callback',
+           model: Ditty::Identity,
+           on_login: Ditty::Main,
+           on_registration: Ditty::Main,
+           locate_conditions: ->(req) { { username: req['username'] } }
+end
+
+run Rack::URLMap.new Ditty::Components.routes

data/ditty.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ditty/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ditty'
+  spec.version       = Ditty::VERSION
+  spec.authors       = ['Jurgens du Toit']
+  spec.email         = ['jrgns@jadeit.co.za']
+
+  spec.summary       = 'Sinatra Based Application Framework'
+  spec.description   = 'Sinatra Based Application Framework'
+  spec.homepage      = 'https://github.com/eagerelk/ditty'
+  spec.license       = 'LGPLv3'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'factory_girl'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'racksh'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'timecop'
+
+  spec.add_dependency 'activesupport', '>= 3'
+  spec.add_dependency 'bcrypt', '~> 3.0'
+  spec.add_dependency 'haml', '~> 5.0'
+  spec.add_dependency 'logger', '~> 1.0'
+  spec.add_dependency 'omniauth', '~> 1.0'
+  spec.add_dependency 'omniauth-identity', '~> 1.0'
+  spec.add_dependency 'pundit', '~> 1.0'
+  spec.add_dependency 'rack-contrib', '~> 1.0'
+  spec.add_dependency 'rake', '~> 12.0'
+  spec.add_dependency 'sequel', '~> 4.0'
+  spec.add_dependency 'sinatra', '~> 2.0'
+  spec.add_dependency 'sinatra-contrib', '~> 2.0'
+  spec.add_dependency 'sinatra-flash', '~> 0.3'
+  spec.add_dependency 'tilt', '>= 2'
+  spec.add_dependency 'wisper', '~> 2.0'
+end

data/lib/ditty/components/app.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'ditty'
+
+module Ditty
+  class App
+    def self.load_models
+      require 'ditty/models/user'
+      require 'ditty/models/role'
+      require 'ditty/models/identity'
+      require 'ditty/models/audit_log'
+    end
+
+    def self.configure(_container)
+      require 'ditty/db' unless defined? ::DB
+      Sequel::Model.plugin :auto_validations
+      Sequel::Model.plugin :update_or_create
+      Sequel::Model.plugin :timestamps, update_on_create: true
+
+      DB.extension(:pagination)
+      require 'ditty/listener'
+    end
+
+    def self.migrations
+      File.expand_path('../../../../migrate', __FILE__)
+    end
+
+    def self.view_folder
+      File.expand_path('../../../../views', __FILE__)
+    end
+
+    def self.routes
+      controllers = File.expand_path('../../controllers', __FILE__)
+      Dir.glob("#{controllers}/*.rb").each { |f| require f }
+      {
+        '/' => ::Ditty::Main,
+        '/users' => ::Ditty::Users,
+        '/roles' => ::Ditty::Roles,
+        '/audit-logs' => ::Ditty::AuditLogs
+      }
+    end
+
+    def self.navigation
+      load_models
+
+      [
+        {
+          group: 'User Management',
+          order: 10,
+          icon: 'lock',
+          items: [
+            { order: 10, link: '/users/', text: 'Users', target: ::Ditty::User, icon: 'user' },
+            { order: 20, link: '/roles/', text: 'Roles', target: ::Ditty::Role, icon: 'check-square' },
+            { order: 30, link: '/audit-logs/', text: 'Audit Logs', target: ::Ditty::AuditLog, icon: 'history' }
+          ]
+        }
+      ]
+    end
+
+    def self.seeder
+      proc do
+        load_models
+
+        ::Ditty::Role.find_or_create(name: 'super_admin')
+        ::Ditty::Role.find_or_create(name: 'admin')
+        user_role = ::Ditty::Role.find_or_create(name: 'user')
+
+        # Anonymous User
+        anon = ::Ditty::User.find_or_create(email: 'anonymous@ditty.io')
+        anon.remove_role user_role
+        anon_role = ::Ditty::Role.find_or_create(name: 'anonymous')
+        anon.add_role anon_role unless anon.role?('anonymous')
+      end
+    end
+  end
+end
+
+Ditty::Components.register_component(:app, Ditty::App)

data/lib/ditty/controllers/application.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'wisper'
+require 'sinatra/base'
+require 'sinatra/flash'
+require 'sinatra/respond_with'
+require 'ditty/helpers/views'
+require 'ditty/helpers/pundit'
+require 'ditty/helpers/wisper'
+require 'ditty/helpers/authentication'
+require 'ditty/services/logger'
+require 'active_support'
+require 'active_support/inflector'
+require 'rack/contrib'
+
+module Ditty
+  class Application < Sinatra::Base
+    include ActiveSupport::Inflector
+
+    set :root, ENV['APP_ROOT'] || ::File.expand_path(::File.dirname(__FILE__) + '/../../../')
+    set :map_path, nil
+    set :view_location, nil
+    set :model_class, nil
+    # The order here is important, since Wisper has a deprecated method respond_with method
+    helpers Wisper::Publisher, Helpers::Wisper
+    helpers Helpers::Pundit, Helpers::Views, Helpers::Authentication
+
+    register Sinatra::Flash, Sinatra::RespondWith
+
+    use Rack::PostBodyContentTypeParser
+    use Rack::MethodOverride
+
+    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
+
+    configure :production do
+      disable :show_exceptions
+    end
+
+    configure :development do
+      set :show_exceptions, :after_handler
+    end
+
+    configure :production, :development do
+      enable :logging
+      # use Rack::CommonLogger, Ditty::Services::Logger.instance
+    end
+
+    not_found do
+      haml :'404', locals: { title: '4 oh 4' }
+    end
+
+    error do
+      error = env['sinatra.error']
+      haml :error, locals: { title: 'Something went wrong', error: error }
+    end
+
+    error Helpers::NotAuthenticated do
+      flash[:warning] = 'Please log in first.'
+      redirect "#{settings.map_path}/auth/identity"
+    end
+
+    error ::Pundit::NotAuthorizedError do
+      flash[:warning] = 'Please log in first.'
+      redirect "#{settings.map_path}/auth/identity"
+    end
+
+    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/, '')
+      end
+    end
+  end
+end

data/lib/ditty/controllers/audit_logs.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'ditty/controllers/component'
+require 'ditty/models/audit_log'
+require 'ditty/policies/audit_log_policy'
+
+module Ditty
+  class AuditLogs < Ditty::Component
+    set model_class: AuditLog
+
+    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
+
+    get '/new' do
+      halt 404
+    end
+
+    post '/' do
+      halt 404
+    end
+
+    get '/:id' do
+      halt 404
+    end
+
+    get '/:id/edit' do
+      halt 404
+    end
+
+    put '/:id' do
+      halt 404
+    end
+
+    delete '/:id' do
+      halt 404
+    end
+  end
+end

data/lib/ditty/controllers/component.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require 'ditty/controllers/application'
+require 'ditty/helpers/component'
+require 'sinatra/json'
+
+module Ditty
+  class Component < Application
+    helpers Helpers::Component
+
+    set base_path: nil
+    set dehumanized: nil
+    set view_location: nil
+    set track_actions: false
+
+    # List
+    get '/', provides: %i[html json] do
+      authorize settings.model_class, :list
+
+      actions = {}
+      actions["#{base_path}/new"] = "New #{heading}" if policy(settings.model_class).create?
+
+      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.map(&:for_json),
+            'page' => params[:page],
+            'count' => list.count,
+            'total' => dataset.count
+          )
+        end
+      end
+    end
+
+    # Create Form
+    get '/new' do
+      authorize settings.model_class, :create
+
+      entity = settings.model_class.new(permitted_attributes(settings.model_class, :create))
+      haml :"#{view_location}/new", locals: { entity: entity, title: heading(:new) }
+    end
+
+    # Create
+    post '/' do
+      authorize settings.model_class, :create
+      entity = settings.model_class.new(permitted_attributes(settings.model_class, :create))
+      success = entity.valid? && entity.save
+
+      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
+          headers 'Content-Type' => 'application/json'
+          if success
+            redirect "#{base_path}/#{entity.id}", 201
+          else
+            400
+          end
+        end
+      end
+    end
+
+    # Read
+    get '/:id' do |id|
+      entity = dataset.first(settings.model_class.primary_key => id)
+      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
+    end
+
+    # Update Form
+    get '/:id/edit' do |id|
+      entity = dataset.first(settings.model_class.primary_key => id)
+      halt 404 unless entity
+      authorize entity, :update
+
+      haml :"#{view_location}/edit", locals: { entity: entity, title: heading(:edit) }
+    end
+
+    # Update
+    put '/:id' do |id|
+      entity = dataset.first(settings.model_class.primary_key => id)
+      halt 404 unless entity
+      authorize entity, :update
+
+      entity.set(permitted_attributes(settings.model_class, :update))
+
+      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
+            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
+            400
+          end
+        end
+      end
+    end
+
+    delete '/:id' do |id|
+      entity = dataset.first(settings.model_class.primary_key => id)
+      halt 404 unless entity
+      authorize entity, :delete
+
+      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.to_s
+        end
+        format.json do
+          content_type 'application/json'
+          headers 'Location' => '/users'
+          status 204
+        end
+      end
+    end
+  end
+end