kadmin 0.1.4

data/lib/kadmin.rb

@@ -0,0 +1,19 @@
+require 'kadmin/configuration'
+require 'kadmin/error'
+require 'kadmin/engine'
+require 'kadmin/auth'
+
+module Kadmin
+  class << self
+    delegate :logger, :logger=, to: :config
+
+    def config
+      return @config ||= Kadmin::Configuration.new
+    end
+
+    def configure
+      yield(config) if block_given?
+      return config
+    end
+  end
+end

data/lib/kadmin/auth.rb

@@ -0,0 +1,31 @@
+# Third party dependency
+require 'omniauth-google-oauth2'
+
+# Core files
+require 'kadmin/auth/unauthorized_error'
+require 'kadmin/auth/configuration'
+require 'kadmin/auth/user'
+require 'kadmin/auth/user_store'
+
+module Kadmin
+  module Auth
+    class << self
+      def users
+        @users ||= config.user_store_class.new
+      end
+
+      def config
+        return @config ||= Kadmin::Auth::Configuration.new
+      end
+
+      def configure
+        yield(config) if block_given?
+        return config
+      end
+
+      def omniauth_provider
+        return config.oauth_credentials.present? ? :google_oauth2 : :developer
+      end
+    end
+  end
+end

data/lib/kadmin/auth/configuration.rb

@@ -0,0 +1,66 @@
+module Kadmin
+  module Auth
+    class Configuration
+      OAuthCredentials = Struct.new(:id, :secret)
+
+      # @return [Kadmin::Auth::Configuration::OAuthCredentials] credentials for OAuth2 authentication; if absent, fallback to :developer provider
+      attr_accessor :oauth_credentials
+
+      # @return [Class<Kadmin::Auth::User>] class to use for authenticated users (mostly for resource authorization)
+      attr_accessor :user_class
+
+      # @return [Class<Kadmin::Auth::UserStore>] class for user lookup/registration
+      attr_accessor :user_store_class
+
+      def initialize
+        @oauth_credentials = nil
+        @user_class = Kadmin::Auth::User
+        @user_store_class = Kadmin::Auth::UserStore
+        @enabled = false
+      end
+
+      # @return [Boolean] true if enabled, false otherwise
+      def enabled?
+        return @enabled
+      end
+
+      # Enables authentication and adds OmniAuth middlewares
+      def enable!
+        unless @enabled
+          append_omniauth_middleware
+          @enabled = true
+        end
+      end
+
+      # Disables authentication and removes OmniAuth middlewares
+      def disable!
+        if @enabled
+          delete_omniauth_middleware
+          @enabled = false
+        end
+      end
+
+      def append_omniauth_middleware
+        OmniAuth.config.logger = Kadmin.logger
+        OmniAuth.config.path_prefix = File.join(Kadmin.config.mount_path, OmniAuth.config.path_prefix)
+
+        provider_args = case Kadmin::Auth.omniauth_provider
+        when :google_oauth2
+          [:google_oauth2, @oauth_credentials.id, @oauth_credentials.secret]
+        else
+          [:developer, fields: [:email]]
+        end
+
+        Rails.application.config.middleware.use OmniAuth::Builder do
+          provider(*provider_args)
+        end
+      end
+      private :append_omniauth_middleware
+
+      def delete_omniauth_middleware
+        Rails.application.config.middleware.delete OmniAuth::Builder
+      end
+      private :delete_omniauth_middleware
+    end
+  end
+end

data/lib/kadmin/auth/unauthorized_error.rb

@@ -0,0 +1,14 @@
+module Kadmin
+  module Auth
+    class UnauthorizedError < Kadmin::Error
+      # Attempts to translate message, if not found returns message as a string
+      def message
+        I18n.t(@message, default: @message)
+      end
+
+      def title
+        I18n.t('kadmin.auth.unauthorized')
+      end
+    end
+  end
+end

data/lib/kadmin/auth/user.rb

@@ -0,0 +1,15 @@
+module Kadmin
+  module Auth
+    class User
+      attr_accessor :email
+
+      def initialize(email)
+        @email = email
+      end
+
+      def authorized?(_request)
+        return true
+      end
+    end
+  end
+end

data/lib/kadmin/auth/user_store.rb

@@ -0,0 +1,21 @@
+module Kadmin
+  module Auth
+    class UserStore
+      def initialize
+        @store = {}
+      end
+
+      def get(email)
+        return @store[email.downcase]
+      end
+
+      def set(email, user)
+        @store[email.downcase] = user
+      end
+
+      def exists?(email)
+        @store.key?(email.downcase)
+      end
+    end
+  end
+end

data/lib/kadmin/configuration.rb

@@ -0,0 +1,18 @@
+module Kadmin
+  class Configuration
+    # @return [Logger] An instance of a Ruby compatible logger
+    attr_accessor :logger
+
+    # @return [String] the path the engine is mounted at (used for authentication routes)
+    attr_accessor :mount_path
+
+    # @return [Array<Hash<Symbol, String>] list of admin links, format: { title: '', path: '' }
+    attr_accessor :navbar_links
+
+    def initialize
+      @mount_path = '/admin'
+      @logger = Rails.logger
+      @navbar_links = []
+    end
+  end
+end

data/lib/kadmin/engine.rb

@@ -0,0 +1,15 @@
+# Rails dependencies
+require 'bootstrap-sass'
+require 'sass-rails'
+require 'jquery-rails'
+require 'select2-rails'
+
+module Kadmin
+  class Engine < ::Rails::Engine
+    isolate_namespace Kadmin
+
+    initializer 'kadmin.install', after: :finisher_hook do
+      Kadmin.logger = Rails.logger
+    end
+  end
+end

data/lib/kadmin/error.rb

@@ -0,0 +1,7 @@
+module Kadmin
+  # Base class for all gem errors
+  class Error < StandardError
+  end
+end
+
+require 'kadmin/errors/authorization'

data/lib/kadmin/errors/authorization.rb

@@ -0,0 +1,15 @@
+module Kadmin
+  module Errors
+    class Authorization < Kadmin::Error
+      attr_reader :resource, :user, :reason
+
+      def initialize(resource, user, reason)
+        @resource = resource
+        @user = user
+        @reason = reason
+
+        super("#{@user} is unauthorized to access #{@resource} => #{@reason}")
+      end
+    end
+  end
+end

data/lib/kadmin/form.rb

@@ -0,0 +1,64 @@
+module Kadmin
+  # Parsing is done by using attribute setters. If you have an attribute called
+  # name, then add a reader/writer for it, name and name=, and perform the
+  # parsing in name=. If there is no parsing to be done, you can simply delegate
+  # the method to the underlying model.
+  #
+  # If the attribute is a nested form, in the writer, simply instantiate that
+  # form, and pass the attributes on to it, then update the model's association
+  # (if any) to reflect the changes.
+  #
+  # Validation is performed like on a normal model or ActiveRecord object.
+  # If you have no extra validation to perform than that of the model, simply
+  # delegate the validate and valid? methods to the model.
+  #
+  # To use nested forms, you need to add a reader and a writer. For example,
+  # for a form called Person, with potentially X nested Person forms as children,
+  # you would have:
+  # class Person
+  #   def children
+  #     [@child1, @child2]
+  #   end
+  #
+  #   def children_attributes=(attributes)
+  #     ...instantiate subforms and pass attributes...
+  #   end
+  # end
+  class Form
+    # Provides common validators and methods to add custom ones
+    include ActiveModel::Validations
+
+    # Provides translation scope and helpers (useful for error messages)
+    # Also includes ActiveModel::Naming at the same time
+    extend ActiveModel::Translation
+
+    # @return [ActiveModel::Model] underlying model to populate
+    attr_reader :model
+
+    delegate :id, :persisted?, to: :model
+
+    def initialize(model)
+      @errors = ActiveModel::Errors.new(self)
+      @model = model
+      @form_input = {}
+    end
+
+    # @!group Parsing/Deserialization
+
+    # Populates the model based on the form input. The input is typically obtained
+    # from the controller's params method, but can be any hash which conforms to
+    # whatever the form object is expecting.
+    # If some input was previously parsed, there is no "rollback" on the state
+    # of the model; it should be done prior to reparsing if it is necessary.
+    # @param [Hash<String, Object>] form_input a hash representing the raw form input
+    def assign_attributes(form_input)
+      @errors.clear
+      form_input.each do |attr, value|
+        setter = "#{attr}="
+        send(setter, value) if respond_to?(setter)
+      end
+    end
+
+    # @!endgroup
+  end
+end

data/lib/kadmin/version.rb

@@ -0,0 +1,3 @@
+module Kadmin
+  VERSION = '0.1.4'.freeze
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/admin_controller.rb

@@ -0,0 +1,4 @@
+class AdminController < Kadmin::ApplicationController
+  def index
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/authorized_controller.rb

@@ -0,0 +1,8 @@
+class AuthorizedController < ApplicationController
+  include Kadmin::Concerns::AuthorizedUser
+
+  before_action :authorize
+
+  def index
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/person.rb

@@ -0,0 +1,6 @@
+class Person < ActiveRecord::Base
+  has_many :relationships, autosave: true, dependent: :destroy, foreign_key: 'person_from'
+
+  has_many :children, { autosave: true, dependent: :destroy, foreign_key: 'person_to' }, -> { where(name: 'child') }
+  has_one :father, { autosave: true, dependent: :destroy, foreign_key: 'person_to' }, -> { where(name: 'father') }
+end

data/test/dummy/app/models/relationship.rb

@@ -0,0 +1,4 @@
+class Relationship < ActiveRecord::Base
+  belongs_to :from, autosave: true, class_name: Person.name, foreign_key: 'person_from'
+  belongs_to :to, autosave: true, class_name: Person.name, foreign_key: 'person_to'
+end

data/test/dummy/app/views/admin/index.html.erb

@@ -0,0 +1 @@
+<h1>You are authorized my dude!</h1>

data/test/dummy/app/views/authorized/index.html.erb

@@ -0,0 +1 @@
+<h1>You are authorized, but not within an admin controller!</h1>

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>