regulator 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: debaf2d2834f1f40dfb69f5d16f20a8b0f887d7e
-  data.tar.gz: a894788600e922d6fca85ae7897a08f76d7fdbcd
+  metadata.gz: 911cd1700d6c57b00ca93599c53af6b38aeb5e29
+  data.tar.gz: 483493a6ff6ddc269e374fedb22a3df20b917f6a
 SHA512:
-  metadata.gz: 10a08ae8dc44b46b4a3bde10f5802ea32543b3f9ae55668ceae101439dc594dd0ef11f25a548706a44e07e8928527198a7a5369f6f4742c4db80dde8e00c1178
-  data.tar.gz: fe9af60ae01fd42e0ce9ad509c4feff5c696d244bf57318603844f3908a35955f7760b7449a48fb17ce552fdc21715869d8bd0d77eca22461f8bac302de405b0
+  metadata.gz: 5b2d0979c34ac379599b231e43aa79954a247a5c4bcac14379cce38a264d462258f98ee9e474f7954a84c1ea2df92630efb9c8ac55e021f2f67fb5d423e20143
+  data.tar.gz: 3ea1165fa80b0d4caf10a07f9496dd623fe31f81c9c1cd49f3108eb7e046cd1fbbe448e3a718d735505f2f0d3da1f21cd967c53342881aa53416d8650e44acff

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.DS_Store

data/.travis.yml

@@ -4,8 +4,5 @@ rvm:
   - 2.2.0
   - 2.0.0
   - 2.1.5
-  - jruby-19mode
 env:
-  - RSPEC_VERSION="<2.99"
-  - RSPEC_VERSION="~>3.0
   - CODECLIMATE_REPO_TOKEN=561cc65a0f136c90b4661c76c96e4ca0717d49a1336cb08d7a617f2cb7d4f6c6

data/CHANGELOG.md

@@ -1,11 +1,14 @@
 # Regulator
 
+## 0.1.2 (2015-07-23)
+- Add generators for install, policy, and activeadmin adapter
+
 ## 0.1.1 (2015-07-23)
 - Regulator.authorize support for controller namespacing
 - Regulator can accept a controller instance or an explicity modules name
   - Regulator.policy!(user,resource, my_controller_instance)
   - Regulator.policy!(user,resource, Api::V2)
-  
+
 ## 0.1.0 (2015-07-23)
 - initial release
 - pundit compatible

data/README.md

@@ -14,8 +14,6 @@ I built this because I believe authorization should be controller-based, not mod
 Why not contribute to pundit? [It's](https://github.com/elabs/pundit/issues/12) [been](https://github.com/elabs/pundit/issues/178) an [on going](https://github.com/elabs/pundit/search?q=namespace&type=Issues&utf8=%E2%9C%93) 'issue' in pundit and it doesn't look [like it'll be reality.](https://github.com/elabs/pundit/pull/190#issuecomment-53052356)
 
 ## TODOs
-  * [ ] generators
-    * [ ] activeadmin-regulator-adapter gem or generator
   * [ ] documentation
     * [ ] Usage section below, mock pundit's
     * [ ] yard doc
@@ -45,7 +43,46 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+No docs yet, check out the [specs](https://github.com/coryodaniel/regulator/blob/master/spec/regulator_spec.rb)
+
+### Generators
+
+Install regulator
+```bash
+  rails g regulator:install
+```
+
+Create a new policy and policy test/spec
+```bash
+  rails g regulator:policy User
+```
+
+Regulator comes with a generator for creating an ActiveAdmin adapter
+```bash
+  rails g regulator:activeadmin
+```
+
+This will create an adapter in your ```lib``` folder.
+
+Be sure to set the following in your ActiveAdmin initializer:
+```ruby
+config.authorization_adapter = "ActiveAdmin::RegulatorAdapter"
+
+# Optional
+# Sets a scope for all ActiveAdmin polices to exist in
+#
+# Example
+# app/policies/admin_policies/user_policy.rb #=> AdminPolicies::UserPolicy
+#
+# config.regulator_policy_namespace = "AdminPolicies"
+config.regulator_policy_namespace = nil
+
+# Optional
+# Sets the default policy to use if no policy is found
+#
+# config.regulator_default_policy = BlackListPolicy
+config.regulator_default_policy = nil
+```
 
 ## Development
 

data/lib/generators/regulator/adapter/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates an ActiveAdmin Regulator adapter
+
+Example:
+    rails generate regulator:active_admin
+
+    This will create:
+        lib/regulator_active_admin_adapter.rb

data/lib/generators/regulator/adapter/adapter_generator.rb

@@ -0,0 +1,41 @@
+module Regulator
+  module Generators
+    class AdapterGenerator < ::Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def inject_into_file_require
+        inject_into_file 'config/initializers/active_admin.rb', after: "ActiveAdmin.setup do |config|\n" do <<-'RUBY'
+  require 'regulator_active_admin_adapter'
+RUBY
+end
+      end
+
+      def copy_regulator_active_admin_adapter
+        # inject_into_file_require
+        # inject_info_file_config_options
+        template 'regulator_active_admin_adapter.rb', 'lib/regulator_active_admin_adapter.rb'
+      end
+
+      def inject_info_file_config_options
+        inject_into_file 'config/initializers/active_admin.rb', after: "# == User Authentication\n" do <<-'RUBY'
+  config.authorization_adapter = "ActiveAdmin::RegulatorAdapter"
+  # Optional
+  # Sets a scope for all ActiveAdmin polices to exist in
+  #
+  # Example
+  # app/policies/admin_policies/user_policy.rb #=> AdminPolicies::UserPolicy
+  #
+  # config.regulator_policy_namespace = "AdminPolicies"
+  config.regulator_policy_namespace = nil
+  # Optional
+  # Sets the default policy to use if no policy is found
+  #
+  # config.regulator_default_policy = BlackListPolicy
+  config.regulator_default_policy = nil
+RUBY
+
+        end
+      end
+    end
+  end
+end

data/lib/generators/regulator/adapter/templates/regulator_active_admin_adapter.rb

@@ -0,0 +1,74 @@
+ActiveAdmin::Dependency.regulator!
+
+require 'regulator'
+
+# Add a setting to the application to configure the regulator default policy
+ActiveAdmin::Application.inheritable_setting :regulator_default_policy, nil
+
+# policy_namespace will default to ActiveAdmin, override it here
+ActiveAdmin::Application.inheritable_setting :regulator_policy_namespace, nil
+
+module ActiveAdmin
+  class RegulatorAdapter < AuthorizationAdapter
+
+    def authorized?(action, subject = nil)
+      policy = retrieve_policy(subject)
+      action = format_action(action, subject)
+
+      policy.respond_to?(action) && policy.public_send(action)
+    end
+
+    def scope_collection(collection, action = Auth::READ)
+      # scoping is appliable only to read/index action
+      # which means there is no way how to scope other actions
+      Regulator.policy_scope!(user, collection, regulator_policy_namespace)
+    rescue Regulator::NotDefinedError => e
+      if default_policy_class && default_policy_class.const_defined?(:Scope)
+        default_policy_class::Scope.new(user, collection).resolve
+      else
+        raise e
+      end
+    end
+
+    def retrieve_policy(subject)
+      case subject
+      when nil   then Regulator.policy!(user, resource, regulator_policy_namespace)
+      when Class then Regulator.policy!(user, subject.new, regulator_policy_namespace)
+      else Regulator.policy!(user, subject, regulator_policy_namespace)
+      end
+    rescue Regulator::NotDefinedError => e
+      if default_policy_class
+        default_policy(user, subject)
+      else
+        raise e
+      end
+    end
+
+    def format_action(action, subject)
+      # https://github.com/elabs/regulator/blob/master/lib/generators/regulator/install/templates/application_policy.rb
+      case action
+      when Auth::CREATE  then :create?
+      when Auth::UPDATE  then :update?
+      when Auth::READ    then subject.is_a?(Class) ? :index? : :show?
+      when Auth::DESTROY then subject.is_a?(Class) ? :destroy_all? : :destroy?
+      else "#{action}?"
+      end
+    end
+
+    private
+
+    def regulator_policy_namespace
+      ActiveAdmin.application.regulator_policy_namespace && ActiveAdmin.application.regulator_policy_namespace.constantize
+    end
+
+    def default_policy_class
+      ActiveAdmin.application.regulator_default_policy && ActiveAdmin.application.regulator_default_policy.constantize
+    end
+
+    def default_policy(user, subject)
+      default_policy_class.new(user, subject)
+    end
+
+  end
+
+end

data/lib/generators/regulator/install/USAGE

@@ -0,0 +1,2 @@
+Description:
+    Generates an application policy as a starting point for your application.

data/lib/generators/regulator/install/install_generator.rb

@@ -0,0 +1,11 @@
+module Regulator
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def copy_application_policy
+        template 'application_policy.rb', 'app/policies/application_policy.rb'
+      end
+    end
+  end
+end

data/lib/generators/regulator/install/templates/application_policy.rb

@@ -0,0 +1,53 @@
+class ApplicationPolicy
+  attr_reader :user, :record
+
+  def initialize(user, record)
+    @user = user
+    @record = record
+  end
+
+  def index?
+    false
+  end
+
+  def show?
+    scope.where(:id => record.id).exists?
+  end
+
+  def create?
+    false
+  end
+
+  def new?
+    create?
+  end
+
+  def update?
+    false
+  end
+
+  def edit?
+    update?
+  end
+
+  def destroy?
+    false
+  end
+
+  def scope
+    Regulator.policy_scope!(user, record.class)
+  end
+
+  class Scope
+    attr_reader :user, :scope
+
+    def initialize(user, scope)
+      @user = user
+      @scope = scope
+    end
+
+    def resolve
+      scope
+    end
+  end
+end

data/lib/generators/regulator/policy/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a policy for a model with the given name.
+
+Example:
+    rails generate regulator:policy user
+
+    This will create:
+        app/policies/user_policy.rb

data/lib/generators/regulator/policy/policy_generator.rb

@@ -0,0 +1,13 @@
+module Regulator
+  module Generators
+    class PolicyGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def create_policy
+        template 'policy.rb', File.join('app/policies', class_path, "#{file_name}_policy.rb")
+      end
+
+      hook_for :test_framework
+    end
+  end
+end

data/lib/generators/regulator/policy/templates/policy.rb

@@ -0,0 +1,9 @@
+<% module_namespacing do -%>
+class <%= class_name %>Policy < ApplicationPolicy
+  class Scope < Scope
+    def resolve
+      scope
+    end
+  end
+end
+<% end -%>

data/lib/generators/rspec/policy_generator.rb

@@ -0,0 +1,11 @@
+module Rspec
+  module Generators
+    class PolicyGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def create_policy_spec
+        template 'policy_spec.rb', File.join('spec/policies', class_path, "#{file_name}_policy_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/templates/policy_spec.rb

@@ -0,0 +1,28 @@
+require '<%= File.exists?('spec/rails_helper.rb') ? 'rails_helper' : 'spec_helper' %>'
+
+describe <%= class_name %>Policy do
+
+  let(:user) { User.new }
+
+  subject { described_class }
+
+  permissions ".scope" do
+    pending "add some examples to (or delete) #{__FILE__}"
+  end
+
+  permissions :show? do
+    pending "add some examples to (or delete) #{__FILE__}"
+  end
+
+  permissions :create? do
+    pending "add some examples to (or delete) #{__FILE__}"
+  end
+
+  permissions :update? do
+    pending "add some examples to (or delete) #{__FILE__}"
+  end
+
+  permissions :destroy? do
+    pending "add some examples to (or delete) #{__FILE__}"
+  end
+end

data/lib/generators/test_unit/policy_generator.rb

@@ -0,0 +1,11 @@
+module TestUnit
+  module Generators
+    class PolicyGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def create_policy_test
+        template 'policy_test.rb', File.join('test/policies', class_path, "#{file_name}_policy_test.rb")
+      end
+    end
+  end
+end

data/lib/generators/test_unit/templates/policy_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class <%= class_name %>PolicyTest < ActiveSupport::TestCase
+
+  def test_scope
+  end
+
+  def test_show
+  end
+
+  def test_create
+  end
+
+  def test_update
+  end
+
+  def test_destroy
+  end
+end

data/lib/regulator/version.rb

@@ -1,3 +1,3 @@
 module Regulator
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: regulator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Cory O'Daniel
@@ -142,6 +142,22 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/generators/.DS_Store
+- lib/generators/regulator/.DS_Store
+- lib/generators/regulator/adapter/.DS_Store
+- lib/generators/regulator/adapter/USAGE
+- lib/generators/regulator/adapter/adapter_generator.rb
+- lib/generators/regulator/adapter/templates/regulator_active_admin_adapter.rb
+- lib/generators/regulator/install/USAGE
+- lib/generators/regulator/install/install_generator.rb
+- lib/generators/regulator/install/templates/application_policy.rb
+- lib/generators/regulator/policy/USAGE
+- lib/generators/regulator/policy/policy_generator.rb
+- lib/generators/regulator/policy/templates/policy.rb
+- lib/generators/rspec/policy_generator.rb
+- lib/generators/rspec/templates/policy_spec.rb
+- lib/generators/test_unit/policy_generator.rb
+- lib/generators/test_unit/templates/policy_test.rb
 - lib/regulator.rb
 - lib/regulator/policy_finder.rb
 - lib/regulator/rspec.rb