kadmin 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef82febec75e4f5da3d104ec4b9e1e87316154d2
+  data.tar.gz: e99e55d0d3d5b7b4b8c355eaeaa5a2fcab22e2a1
+SHA512:
+  metadata.gz: 152316ddf56a8c6422137f1a492bf334e0d99a40d0debde4c9a66fd3cbde3a96976c2a09f5aef2802c46a62e740fa6da2a2184e11a036c0e5ebeafff3c813fff
+  data.tar.gz: a1b630f7e7a0f4d8ccb8cf163a5a4220015e628f8ab4a7775b472144c088af0fde55663147cdc8c66fad2032262b7159038f4d46183d68a701143b9f1440a0e0

data/README.md

@@ -0,0 +1,35 @@
+# Kadmin
+
+[![GitHub release](https://img.shields.io/badge/release-0.1.4-blue.png)](https://github.com/barcoo/kadmin/releases/tag/0.1.4)
+
+Collection of utility, configuration, etc., for admin areas in different projects.
+
+## Installation
+
+Add to your gemfile:
+
+```ruby
+gem 'kadmin', git: 'git@github.com:barcoo/kadmin.git'
+```
+
+## Web
+
+If you wish to use the web front-end, make sure to ```require 'kadmin'```
+
+See the test application ```test/dummy``` for more info.
+
+## Development
+
+Clone, bundle install
+
+Make sure test coverage stays > 90%, and make sure ```master``` stays green.
+
+## Release
+
+___Note___: eventually use one of the popular git release scripts to tag, create tag notes, etc., based on git changelog.
+
+When you want to create a new release, use the rake task ```cim:release``` (in the main Rakefile)
+
+```shell
+bundle exec rake cim:release
+```

data/Rakefile

@@ -0,0 +1,146 @@
+require 'english'
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', 'app/**/*.rb', 'config/**/*.rb']
+  t.options = ['--output-dir=./docs']
+end
+
+require 'kadmin/version'
+
+namespace :cim do
+  desc 'Tags, updates README, and CHANGELOG and pushes to Github. Requires ruby-git'
+  task :release do
+    tasks = ['cim:assert_clean_repo', 'cim:git_fetch', 'cim:set_new_version', 'cim:update_readme', 'cim:update_changelog', 'cim:commit_changes', 'cim:tag']
+    begin
+      tasks.each { |task| Rake::Task[task].invoke }
+      `git push && git push origin '#{Kadmin::VERSION}'`
+    rescue => error
+      puts ">>> ERROR: #{error}; might want to reset your repository"
+    end
+  end
+
+  desc 'Fails if the current repository is not clean'
+  task :assert_clean_repo do
+    status = `git status -s`.chomp.strip
+    if status.strip.empty?
+      status = `git log origin/master..HEAD`.chomp.strip # check if we have unpushed commits
+      if status.strip.empty?
+        puts '>>> Repository is clean!'
+      else
+        puts '>>> Please push your committed changes before releasing!'
+        exit(-1)
+      end
+    else
+      puts '>>> Please stash or commit your changes before releasing!'
+      exit(-1)
+    end
+  end
+
+  desc 'Fetches latest tags/commits'
+  task :git_fetch do
+    puts '>>> Fetching latest git refs'
+    `git fetch --tags`
+  end
+
+  desc 'Requests the new version number'
+  task :set_new_version do
+    STDOUT.print(">>> New version number (current: #{Kadmin::VERSION}; leave blank if already updated): ")
+    input = STDIN.gets.strip.tr("'", "\'")
+
+    current = if input.empty?
+      Kadmin::VERSION
+    else
+      unless input =~ /[0-9]+\.[0-9]+\.[0-9]+/
+        puts '>>> Please use semantic versioning!'
+        exit(-1)
+      end
+
+      input
+    end
+
+    latest = `git describe --abbrev=0`.chomp.strip
+    unless Gem::Version.new(current) > Gem::Version.new(latest)
+      puts ">>> Latest tagged version is #{latest}; make sure gem version (#{current}) is greater!"
+      exit(-1)
+    end
+
+    if !input.empty?
+      `sed -i -u "s@VERSION = '#{Kadmin::VERSION}'@VERSION = '#{input}'@" #{File.expand_path('../lib/kadmin/version.rb', __FILE__)}`
+      $VERBOSE = nil
+      Kadmin.const_set('VERSION', input)
+      $VERBOSE = false
+
+      `bundle check` # force updating version
+    end
+  end
+
+  desc 'Updates README with latest version'
+  task :update_readme do
+    puts '>>> Updating README.md'
+    replace = %([![GitHub release](https://img.shields.io/badge/release-#{Kadmin::VERSION}-blue.png)](https://github.com/barcoo/kadmin/releases/tag/#{Kadmin::VERSION}))
+
+    `sed -i -u 's@^\\[\\!\\[GitHub release\\].*$@#{replace}@' README.md`
+  end
+
+  desc 'Updates CHANGELOG with commit log from last tag to this one'
+  task :update_changelog do
+    puts '>>> Updating CHANGELOG.md'
+    latest = `git describe --abbrev=0`.chomp.strip
+    range = $CHILD_STATUS.success? && !latest.empty? ? "'#{latest}'..HEAD" : ''
+
+    log = `git log --pretty=format:'- [%h](https://github.com/barcoo/kadmin/commit/%h) *%ad* __%s__ (%an)' --date=short #{range}`.chomp
+
+    changelog = File.open('.CHANGELOG.md', 'w')
+    changelog.write("# Changelog\n\n###{Kadmin::VERSION}\n\n#{log}\n\n")
+    File.open('CHANGELOG.md', 'r') do |file|
+      file.readline # skip first two lines
+      file.readline
+
+      while buffer = file.read(2048) # rubocop: disable Lint/AssignmentInCondition
+        changelog.write(buffer)
+      end
+    end
+
+    changelog.close
+    `mv '.CHANGELOG.md' 'CHANGELOG.md'`
+  end
+
+  desc 'Commits the README/CHANGELOG changes'
+  task :commit_changes do
+    puts '>>> Committing updates to README/CHANGELOG'
+    `git commit -am'Updated README.md and CHANGELOG.md on new release'`
+  end
+
+  desc 'Creates and pushes the tag to git'
+  task :tag do
+    puts '>>> Tagging'
+    STDOUT.print('>>> Please enter a tag message: ')
+    input = STDIN.gets.strip.tr("'", "\'")
+    `git tag -a '#{Kadmin::VERSION}' -m '#{input}'`
+  end
+end

data/app/assets/javascripts/rails_admin/application.js

@@ -0,0 +1,3 @@
+//= require jquery2
+//= require jquery_ujs
+//= require bootstrap

data/app/assets/stylesheets/rails_admin/application.scss

@@ -0,0 +1,50 @@
+// Custom bootstrap variables must be set or import before bootstrap itself.
+@import "bootstrap-sprockets";
+@import "bootstrap";
+
+a.thumbnail {
+  max-width: 100%;
+  overflow: hidden;
+  padding-bottom: 2px;
+}
+
+a.thumbnail > img {
+  max-width: 100%;
+  padding-bottom: 2px;
+}
+
+table.table-borderless {
+
+}
+
+table.table-borderless {
+  tr, td, th {
+    border-width: 0;
+    border-style: none !important;
+  }
+}
+
+.content {
+  height: 100%;
+  left: 0;
+  min-height: 100%;
+  padding-bottom: 1em;
+  width: 100%;
+
+  .row {
+    height: 100%;
+  }
+
+  .main {
+    .page-header {
+      margin-top: 0;
+    }
+  }
+
+  .sidebar {
+  }
+
+  .alerts {
+    margin: 1em auto;
+  }
+}

data/app/assets/stylesheets/rails_admin/finder.scss

@@ -0,0 +1,2 @@
+@import "select2";
+@import "select2-bootstrap";

data/app/controllers/kadmin/application_controller.rb

@@ -0,0 +1,58 @@
+module Kadmin
+  class ApplicationController < ActionController::Base
+    layout 'kadmin/application'
+
+    helper Kadmin::ApplicationHelper
+    helper Kadmin::BootstrapHelper
+    helper Kadmin::NavigationHelper
+    helper Kadmin::PaginationHelper
+
+    include Kadmin::Concerns::AuthorizedUser
+
+    before_action :authorize
+    before_action :set_navbar_links
+    before_action :set_default_format
+
+    # @!group Error Handling
+
+    unless defined?(BetterErrors)
+      rescue_from StandardError, with: :handle_error
+      rescue_from ActiveRecord::RecordNotFound, with: :not_found
+      rescue_from ActionController::ParameterMissing, with: :params_missing
+    end
+
+    def params_missing(error)
+      handle_error(error, title: I18n.t('kadmin.errors.params_missing'), status: :bad_request)
+    end
+
+    def not_found(error)
+      handle_error(error, title: I18n.t('kadmin.errors.not_found'), status: :not_found)
+    end
+
+    def handle_error(error, options = {})
+      options = {
+        title: error.try(:title) || error.class.name,
+        message: error.message,
+        status: :internal_server_error
+      }.merge(options)
+      render 'kadmin/error', status: options[:status], locals: options
+    end
+
+    # @!endgroup
+
+    # @!group Helpers
+
+    # Overload in the sub-controllers to set up the links in the layout
+    def set_navbar_links
+      @layout_navbar_links = []
+    end
+    protected :set_navbar_links
+
+    def set_default_format
+      params[:format] = 'html' if params[:format].blank?
+    end
+    protected :set_default_format
+
+    # @!endgroup
+  end
+end

data/app/controllers/kadmin/auth_controller.rb

@@ -0,0 +1,98 @@
+module Kadmin
+  class AuthController < Kadmin::ApplicationController
+    SESSION_KEY = 'kadmin.user'.freeze
+
+    # Don't try to authenticate user on the authentication controller...
+    skip_before_action :authorize
+
+    # @!group Endpoints
+    # GET /auth/login
+    def login
+      render 'kadmin/auth/login'
+    end
+
+    # GET /auth/logout
+    # DELETE /auth/logout
+    def logout
+      session.delete(SESSION_KEY)
+      redirect_to action: :login
+    end
+
+    # GET /auth/:provider/callback
+    # POST /auth/:provider/callback
+    def save
+      auth_hash = request.env['omniauth.auth']
+
+      if auth_hash.blank?
+        Kadmin.logger.error('No authorization hash provided')
+        flash.alert = I18n.t('kadmin.auth.error')
+        redirect_to action: :login
+        return
+      end
+
+      email = auth_hash.dig('info', 'email')
+      if Kadmin::Auth.users.exists?(email)
+        session[SESSION_KEY] = email
+        redirect_url = request.env['omniauth.origin']
+        redirect_url = Kadmin.config.mount_path unless valid_redirect_url?(redirect_url)
+      else
+        flash.alert = I18n.t('kadmin.auth.unauthorized_message')
+        redirect_url = url_for(action: :login)
+      end
+
+      redirect_to redirect_url
+    end
+
+    # GET /auth/failure
+    def failure
+      flash.alert = params[:message]
+      redirect_to action: :login
+    end
+
+    def unauthorized
+      render 'kadmin/error', format: ['html'], locals: {
+        title: I18n.t('kadmin.auth.unauthorized'),
+        message: I18n.t('kadmin.auth.unauthorized_message')
+      }
+    end
+
+    # @!endgroup
+
+    # @!group Helpers
+
+    def valid_redirect_url?(url)
+      valid = false
+
+      unless url.blank?
+        paths = [url_for(action: :login), url_for(action: :logout)]
+        valid = paths.none? { |invalid| url == invalid }
+      end
+
+      return valid
+    end
+    protected :valid_redirect_url?
+
+    def omniauth_provider_link
+      auth_prefix = "#{Kadmin.config.mount_path}/auth"
+      provider_link = "#{auth_prefix}/#{Kadmin::Auth.omniauth_provider}"
+      origin = params[:origin]
+
+      # if the referer is a auth route, then we risk ending in an endless loop
+      if origin.blank?
+        referer = request.referer
+        if referer.blank?
+          origin = Kadmin.config.mount_path
+        else
+          uri = URI(referer)
+          origin = referer unless uri&.path&.start_with?(auth_prefix)
+        end
+      end
+
+      provider_link = "#{provider_link}?origin=#{CGI.escape(origin)}" unless origin.blank?
+      return provider_link
+    end
+    helper_method :omniauth_provider_link
+
+    # @!endgroup
+  end
+end

data/app/controllers/kadmin/concerns/authorized_user.rb

@@ -0,0 +1,67 @@
+module Kadmin
+  module Concerns
+    module AuthorizedUser
+      extend ActiveSupport::Concern
+
+      included do
+        if respond_to?(:helper_method)
+          helper_method :current_user
+          helper_method :authorized_user
+          helper_method :logged_in?
+          helper_method :authorized?
+        end
+      end
+
+      # @!group before_action
+
+      # Add as a before_action whenever you wish to authorize a user for a particular
+      # resource. The app provided user model will perform authorization of the resource.
+      # @see Kadmin::Auth::User
+      # @example
+      #   before_action :authorize, except: [:index] # exclude index from authorization
+      def authorize
+        if Kadmin::Auth.config.enabled?
+          if logged_in?
+            unless authorized?
+              redirect_to Kadmin::Engine.routes.url_helpers.auth_unauthorized_path
+            end
+          else
+            redirect_to Kadmin::Engine.routes.url_helpers.auth_login_path(origin: request.path)
+          end
+        end
+      end
+
+      # @!endgroup
+
+      # @!group View Helpers
+
+      # @return [String] the current user identifier. Historically called current_user
+      def current_user
+        session[Kadmin::AuthController::SESSION_KEY]
+      end
+
+      # @see Kadmin::Concerns::AuthorizedUser#current_user
+      # @return [Kadmin::Auth::User] instance of the user identified by current_user
+      def authorized_user
+        return Kadmin::Auth.users.get(current_user)
+      end
+
+      # @!endgroup
+
+      # @!group Helpers
+
+      # @return [Boolean] true if the user is logged in, false otherwise
+      def logged_in?
+        return current_user.present?
+      end
+
+      # @see Kadmin::Auth::User
+      # @return [Boolean] true if the user is authorized in, false otherwise
+      def authorized?
+        return authorized_user&.authorized?(request)
+      end
+
+      # @!endgroup
+    end
+  end
+end