action_control 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c589bc119365c05165bad55d5318de1e8765805
+  data.tar.gz: 3fd73176a397cafee1a883db779506877d652564
+SHA512:
+  metadata.gz: 02621619e60135eaeaeff8f2dbd05c126c4bce890a73658c4e99ac463a12fde75e42b6390c39f59bb64e9cdea6f513ad6744acae11439d6bbffc1d86dabb773c
+  data.tar.gz: b9c5c2719ba6dffa33b4ca6700d98618c59898246fa7c8210b6deb0b3ffc5ac340dc0aff92659f63f20dd29f81109e4b2ab9232a7f465a311991fbcdc6f6bbdb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Tobias Feistmantl
+
+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,34 @@
+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    = 'ActionControl'
+	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/action_control.rb

@@ -0,0 +1,12 @@
+require 'action_control/controller_methods'
+require 'action_control/errors'
+require 'action_control/action_controller/base'
+
+module ActionControl
+	# Authorizes the user.
+	def authorize!
+		raise ActionControl::AuthorizationNotPerformedError unless defined?(authorized?)
+		
+		raise ActionControl::NotAuthorizedError unless send(:authorized?) == true
+	end
+end

data/lib/action_control/action_controller/base.rb

@@ -0,0 +1,8 @@
+# @author Tobias Feistmantl
+#
+# Add Action Control to
+# ActionController::Base
+# automatically.
+ActionController::Base.class_eval do
+	include ActionControl
+end

data/lib/action_control/controller_methods.rb

@@ -0,0 +1,69 @@
+# @author Tobias Feistmantl
+#
+# Helper methods for your controller
+# to identify RESTful actions.
+module ActionControl
+	# @return [Boolean]
+	#    True if the called action
+	#    is a only-read action.
+	def read_action?
+		action_name == "index" ||
+		action_name == "show"
+	end
+
+	# @return [Boolean]
+	#    True if the called action
+	#    is a write action.
+	def write_action?
+		action_name == "new" ||
+		action_name == "create" ||
+		action_name == "edit" ||
+		action_name == "update" ||
+		action_name == "destroy"
+	end
+
+	# @return [Boolean]
+	#    True if the called action
+	#    is a change action.
+	def change_action?
+		action_name == "edit" ||
+		action_name == "update" ||
+		action_name == "destroy"
+	end
+
+	# @note
+	#    Also true for the pseudo
+	#    update action `new`.
+	#
+	# @note
+	#    Only true for create methods
+	#    such as new and create.
+	#
+	# @return [Boolean]
+	#    True if the called action
+	#    is a create action.
+	def create_action?
+		action_name == "new" ||
+		action_name == "create"
+	end
+
+	# @note
+	#    Also true for the pseudo
+	#    update action `edit`.
+	#
+	# @return [Boolean]
+	#    True if the called action
+	#    is a update action.
+	def update_action?
+		action_name == "edit" ||
+		action_name == "update"
+	end
+
+	# @return [Boolean]
+	#    True if it's a destroy action.
+	def destroy_action?
+		action_name == "destroy"
+	end
+
+	alias delete_action? destroy_action?
+end

data/lib/action_control/errors.rb

@@ -0,0 +1,29 @@
+# @author Tobias Feistmantl
+module ActionControl
+	# Generic authorization error.
+	# Other, more specific, errors inherit from this one.
+	#
+	# @raise [AuthorizationError]
+	#    if something generic is happening.
+	class AuthorizationError < StandardError
+	end
+
+	# Error for controllers in which authorization isn't handled.
+	#
+	# @raise [AuthorizationNotPerformedError]
+	#    if the #authorized? method isn't defined
+	#    in the controller class.
+	class AuthorizationNotPerformedError < AuthorizationError
+	end
+
+	# Error if user unauthorized.
+	#
+	# @raise [NotAuthorizedError]
+	#    if authorized? isn't returning true.
+	#
+	# @note
+	#    Should always be called at the end
+	#    of the #authorize! method.
+	class NotAuthorizedError < AuthorizationError
+	end
+end

data/lib/action_control/version.rb

@@ -0,0 +1,3 @@
+module ActionControl
+	VERSION = "0.0.2"
+end

data/lib/tasks/action_control_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :action_control do
+#   # Task goes here
+# end

data/test/action_control_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+class ActionControlTest < ActiveSupport::TestCase
+	def reinstatiate
+		@authorizable = Class.new do
+			include ActionControl
+		end
+	end
+
+	setup do
+		reinstatiate
+	end
+
+	test 'should raise `AuthorizationNotPerformedError` if #authorized? is not defined' do
+		assert_raise ActionControl::AuthorizationNotPerformedError do
+			@authorizable.new.authorize!
+		end
+	end
+
+	test 'should raise `NotAuthorizedError` if #authorized? not returns true' do
+		@authorizable.class_eval do
+			define_method :authorized? do
+				false
+			end
+		end
+
+		assert_raise ActionControl::NotAuthorizedError do
+			@authorizable.new.authorize!
+		end
+	end
+
+	test 'should raise no exception if #authorized? returns true' do
+		@authorizable.class_eval do
+			define_method :authorized? do
+				true
+			end
+		end
+
+		assert_nothing_raised do
+			@authorizable.new.authorize!
+		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__)
+
+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/javascripts/welcome.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

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/assets/stylesheets/welcome.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

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

@@ -0,0 +1,7 @@
+class ApplicationController < ActionController::Base
+	protect_from_forgery with: :exception
+
+	before_action :authorize!
+
+	rescue_from ActionControl::NotAuthorizedError, with: -> { render html: 'You are not authorized!' }
+end

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

@@ -0,0 +1,12 @@
+class WelcomeController < ApplicationController
+	def index
+	end
+
+	def other
+	end
+
+	def authorized?
+		return true if action_name == 'index'
+		return false if action_name == 'other'
+	end
+end

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

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

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

@@ -0,0 +1,2 @@
+module WelcomeHelper
+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/app/views/welcome/index.html.erb

@@ -0,0 +1,2 @@
+<h1>Welcome#index</h1>
+<p>Find me in app/views/welcome/index.html.erb</p>

data/test/dummy/app/views/welcome/other.html.erb

@@ -0,0 +1 @@
+If you see this, something isn't working correctly

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/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

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,29 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+# require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "action_control"
+
+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
+