authist 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c7422a9ad57d23dd5eeb3f96bdfcac245c17321
+  data.tar.gz: f11023381203387eeb30549b892f5410c6ed00b0
+SHA512:
+  metadata.gz: bca1e2f4f60485bee97b0c2c259ef42eca59c7c11e80dd2d91e34c9b6da1c60e369cf46b7d489da89896878094f679f8317701f82c108b87267bba09cb5e1a3b
+  data.tar.gz: ff5bdebd10f6ebf16227e11e84048145ce53dfb42c16d06c84ee7a82e23272ab2c31b858a7c48594647b20a31123cbd610b96f71acd688684a4e471f7cb2c7d3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Ruben 'angryzor' Tytgat
+
+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,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Authist'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+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

data/lib/authist.rb

@@ -0,0 +1,16 @@
+module Authist
+	autoload :Authism, 'authist/authism'
+	autoload :Models, 'authist/models'
+	autoload :ControllerHelpers, 'authist/controller_helpers'
+
+	@@disable_controller_extensions = false
+	mattr_accessor :disable_controller_extensions
+
+	def self.setup
+		yield self
+
+		unless disable_controller_extensions
+			ApplicationController.include ControllerHelpers
+		end
+	end
+end

data/lib/authist/authism.rb

@@ -0,0 +1,14 @@
+module Authist
+	module Authism
+		extend ActiveSupport::Concern
+
+		included do
+			has_many :role_subscriptions, as: :authorizable, class_name: '::Authist::Models::RoleSubscription'
+			has_many :roles, through: :role_subscriptions, class_name: '::Authist::Models::Role'
+		end
+
+		def has_access? access_type
+			roles.any? { |role| role.allows_access? access_type }
+		end
+	end
+end

data/lib/authist/controller_helpers.rb

@@ -0,0 +1,31 @@
+module Authist
+	module ControllerHelpers
+		extend ActiveSupport::Concern
+
+		included do
+		end
+
+		def access_required type
+			truth_required current_user.has_access?(type)
+		end
+
+		def user_or_access_required user, type
+			truth_required current_user == user || current_user.has_access?(type)
+		end
+
+		def user_required user
+			truth_required current_user == user
+		end
+
+		def truth_required clause
+			unless clause
+				unauthorized_access
+				false
+			end
+		end
+
+		def unauthorized_access
+			redirect root_path
+		end
+	end
+end

data/lib/authist/models.rb

@@ -0,0 +1,6 @@
+module Authist
+	module Models
+		autoload :Role, 'authist/models/role'
+		autoload :RoleSubscription, 'authist/models/role_subscription'
+	end
+end

data/lib/authist/models/role.rb

@@ -0,0 +1,25 @@
+module Authist
+	module Models
+		class Role < ActiveRecord::Base
+			has_and_belongs_to_many :included_roles, class_name: "Role", foreign_key: "includer_id"
+			has_many :role_subscriptions
+
+			def allows_access? access_type
+				allows_access_directly? access_type or allows_access_transitively? access_type
+			end
+
+			private
+			def allows_access_directly? access_type
+				begin
+					send access_type
+				rescue NoMethodError => e
+					raise "No such access type: #{access_type}"
+				end
+			end
+
+			def allows_access_transitively? access_type
+				included_roles.any? { |role| role.allows_access? access_type }
+			end
+		end
+	end
+end

data/lib/authist/models/role_subscription.rb

@@ -0,0 +1,8 @@
+module Authist
+	module Models
+		class RoleSubscription < ActiveRecord::Base
+			belongs_to :role
+			belongs_to :authorizable, polymorphic: true
+		end
+	end
+end

data/lib/authist/version.rb

@@ -0,0 +1,3 @@
+module Authist
+	VERSION = "0.0.1"
+end

data/lib/generators/active_record/access_type_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/active_record'
+
+module ActiveRecord
+  module Generators
+    class AccessTypeGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Add access type."
+      
+      def generate_migrations
+        migration_template "access_type_migration.rb", "db/migrate/add_access_type_#{singular_name}.rb"
+      end
+    end
+  end
+end

data/lib/generators/active_record/authist_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators/active_record'
+
+module ActiveRecord
+  module Generators
+    class AuthistGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Turns an ActiveModel model into an authist."
+
+      def include_authism_in_model
+        class_path = if namespaced?
+          class_name.to_s.split("::")
+        else
+          [class_name]
+        end
+
+        inject_into_class File.join("app", "models", "#{file_path}.rb"), class_path.last, "  include Authist::Authism\n"
+      end
+    end
+  end
+end

data/lib/generators/active_record/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators/active_record'
+
+module ActiveRecord
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates the core Authist ActiveRecord migrations."
+      
+      def generate_migrations
+        migration_template "core_migration.rb", "db/migrate/create_authistic_behaviour.rb"
+      end
+    end
+  end
+end

data/lib/generators/active_record/templates/access_type_migration.rb

@@ -0,0 +1,7 @@
+class AddAccessType<%= singular_name.camelize %> < ActiveRecord::Migration
+  def change
+    change_table :roles do |t|
+      t.boolean :<%= singular_name %>
+    end
+  end
+end

data/lib/generators/authist/access_type_generator.rb

@@ -0,0 +1,11 @@
+module Authist
+  module Generators
+    class AccessTypeGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a new access type."
+
+      hook_for :orm
+    end
+  end
+end

data/lib/generators/authist/authist_generator.rb

@@ -0,0 +1,11 @@
+module Authist
+  module Generators
+    class AuthistGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Turns a model into an Authist."
+
+      hook_for :orm
+    end
+  end
+end

data/lib/generators/authist/install_generator.rb

@@ -0,0 +1,15 @@
+module Authist
+	module Generators
+		class InstallGenerator < Rails::Generators::Base
+			source_root File.expand_path("../../templates", __FILE__)
+
+			desc "Creates an authist initializer and core migrations."
+
+			hook_for :orm
+
+			def copy_initializer
+				template "authist.rb", "config/initializers/authist.rb"
+			end
+		end
+	end
+end

data/lib/generators/templates/authist.rb

@@ -0,0 +1,4 @@
+Authist.setup do |config|
+  # Uncomment this if you don't want the controller helpers.
+  # config.disable_controller_extensions
+end

data/lib/generators/templates/core_migration.rb

@@ -0,0 +1,17 @@
+class CreateAuthisticBehaviour < ActiveRecord::Migration
+  def change
+    create_table :roles do |t|
+      t.string :name
+    end
+
+    create_table :role_subscriptions do |t|
+      t.references :role, index: true
+      t.references :authorizable, index: { name: 'index_role_subs_on_auth_id_and_auth_type_authist' }, polymorphic: true
+    end
+
+    create_table :roles_roles do |t|
+      t.references :role, index: true
+      t.references :includer, index: true
+    end
+  end
+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__)
+
+Dummy::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 vendor/assets/javascripts of plugins, if any, 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/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

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

@@ -0,0 +1,13 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

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/helpers/application_helper.rb

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

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

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+	include Authist::Authism
+end

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

@@ -0,0 +1,3 @@
+class UserGroup < ActiveRecord::Base
+  include Authist::Authism
+end

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>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "authist"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+