restrict 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c99bdbebb900cbb8bd4f2e16c7951a00077c9552
-  data.tar.gz: ad856af2b30b2e808db164da909ee824598707ee
+  metadata.gz: a311cd60d3877b78f14d2baa83f6155a86a1f3f2
+  data.tar.gz: 4a974335ee21c330485d91de9cc54f9d861812dc
 SHA512:
-  metadata.gz: cef3ff540a576034e4d243304e52717dd4edb910e738e707417ba8bcbcfaf024dfc963307e411dd799627697692cc0d106d0135ffdbe6a3ddfedbedfcf9cb16b
-  data.tar.gz: 2d6bf74cbe84d97398ea0c23cb99429e6be7dbb7dfd8359f3c6abbbfdd8c215beb3fd70c22b4f810bdbc3bd70c29d0e85a5286a42429723256f584e62fdbb116
+  metadata.gz: a49f1610e19cb448b598ff93e965e277788e1e7e482b2541eb5c6275a7b290afbdd1397a51f55dd518894063b34e63dc85ab835e832b0e6a8de52b667f8a3b14
+  data.tar.gz: c50d8015c07fb09a5061f606b2ca8aaeacf45c9d5dc3ed4e0d50d445fef2a849e0372ba31854ed56b0e856d673996d397aa6ff446948939eb1764cc49a403c67

data/CHANGELOG.md

@@ -1,5 +1,7 @@
-[not released] - 2014-08-22
+[0.0.3] - 2014-08-23
   * Added railtie to require controller extension instantly
+  * Added :all_actions matcher
+  * Configuration for authentication_validation_method
 
 [0.0.1] - 2014-08-21 Initial import
   * Includes plain and conditional restrictions

data/README.md

@@ -41,10 +41,22 @@ What that does:
   3. If a `current_user` exists but `goodie_manager?` returns false, then `Restrict::AccessDenied` will be raised
   4. If a `current_user` exists and `goodie_manager?` is true, the access is allowed
 
-## Todos/Ideas
+### Restrict all actions
 
-* make `current_user` configurable
-* introduce `any_action` option
+```ruby
+restrict :all_actions
+```
+
+This one will apply to all actions on this controller. It takes the `allow_if` option as well.
+
+### Configuration
+
+```ruby
+# Default is :user_signed_in?
+Restrict.config.authentication_validation_method = :current_user
+```
+
+You may set the method that is used to figure out whether a user is signed in or not to whatever you like, however it's default is `:user_signed_in?` which is the most common (devise) method in use.
 
 ## Contributing
 

data/Rakefile

@@ -1,7 +1,7 @@
 require "bundler/gem_tasks"
 
 if File.exist?('.codeclimate')
-  ENV["CODECLIMATE_REPO_TOKEN"] = File.read('.codeclimate')
+  ENV["CODECLIMATE_REPO_TOKEN"] = File.read('.codeclimate').strip
 end
 
 require 'rspec/core/rake_task'

data/lib/restrict/configuration.rb

@@ -0,0 +1,9 @@
+module Restrict
+  class Configuration
+    attr_writer :authentication_validation_method
+
+    def authentication_validation_method
+      @authentication_validation_method || :user_signed_in?
+    end
+  end
+end

data/lib/restrict/gatekeeper.rb

@@ -20,7 +20,7 @@ module Restrict
     def current_restriction(controller)
       controller.restrictions or return
       controller.restrictions.find do |restriction|
-        restriction.restricts?(controller.action_name)
+        restriction.concerning?(controller.action_name)
       end
     end
   end

data/lib/restrict/restriction.rb

@@ -1,17 +1,26 @@
 module Restrict
   class Restriction
-    attr_accessor :actions, :role, :allow_if
+    attr_accessor :actions, :allow_if
 
     def initialize(*args)
       options   = args.extract_options!
-      @role     = options[:role]
       @allow_if = options[:allow_if]
       @actions  = args
       actions.empty? and raise ArgumentError, "expected actions to restrict, but got #{actions.inspect}"
     end
 
-    def restricts?(action_name)
-      actions.include?(action_name.to_sym)
+    def concerning?(action)
+      concerns_action?(action) || concerns_all?
+    end
+
+    private
+
+    def concerns_all?
+      actions.include?(:all_actions)
+    end
+
+    def concerns_action?(name)
+      actions.include?(name.to_sym)
     end
   end
 end

data/lib/restrict/rspec/matcher.rb

@@ -4,7 +4,7 @@ RSpec::Matchers.define :have_restriction_on do |given_action_name|
     @given_controller = given_controller
 
     @restriction = given_controller.restrictions.find do |restriction|
-      restriction.restricts?(given_action_name)
+      restriction.concerning?(given_action_name)
     end
 
     if @restriction
@@ -38,6 +38,7 @@ RSpec::Matchers.define :have_restriction_on do |given_action_name|
     end
   end
 
+  # :nocov:
   def description
     "Checks if a restriction for a given action is defined on the controller"
   end

data/lib/restrict/rspec/matcher_rspec2.rb

@@ -4,7 +4,7 @@ RSpec::Matchers.define :have_restriction_on do |given_action_name|
     @given_controller = given_controller
 
     @restriction = given_controller.restrictions.find do |restriction|
-      restriction.restricts?(given_action_name)
+      restriction.concerning?(given_action_name)
     end
 
     if @restriction

data/lib/restrict/version.rb

@@ -1,3 +1,3 @@
 module Restrict
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/restrict.rb

@@ -1,6 +1,7 @@
 require 'active_support'
 
 require 'restrict/version'
+require 'restrict/configuration'
 require 'restrict/error'
 require 'restrict/login_required'
 require 'restrict/access_denied'
@@ -10,5 +11,10 @@ require 'restrict/rails/controller'
 require 'restrict/rails/railtie' if defined?(Rails)
 
 module Restrict
-  # Your code goes here...
+
+  def self.config(&block)
+    @configuration ||= Restrict::Configuration.new
+    block_given? ? yield(@configuration) : @configuration
+  end
+
 end

data/spec/lib/restrict/configuration_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Restrict::Configuration do
+  let(:configuration) { Restrict::Configuration.new }
+
+  describe '#authentication_method' do
+    it 'has a sensible default' do
+      expect(configuration.authentication_validation_method).to eq :user_signed_in?
+    end
+
+    it 'can be overridden' do
+      configuration.authentication_validation_method = :foobar?
+      expect(configuration.authentication_validation_method).to eq :foobar?
+    end
+  end
+
+end

data/spec/lib/restrict/restriction_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Restrict::Restriction do
-  let(:restriction) { Restrict::Restriction.new(:show, :edit, role: :manager) }
+  let(:restriction) { Restrict::Restriction.new(:show, :edit) }
 
   describe '#initialize' do
     it 'knows about its actions' do
@@ -13,24 +13,23 @@ describe Restrict::Restriction do
     end
   end
 
-  describe '#restricts?' do
+  describe '#concerning?' do
     it 'returns true if the given action is contained' do
-      expect(restriction).to be_restricts(:show)
+      expect(restriction).to be_concerning(:show)
     end
 
-    it 'returns false if the given action name is not contained' do
-      expect(restriction).not_to be_restricts(:index)
+    it 'returns true if the given name is a string' do
+      expect(restriction).to be_concerning('show')
     end
-  end
 
-  describe '#role' do
-    it 'returns the role name if given' do
-      expect(restriction.role).to eq :manager
+    it 'returns false if the given action name is not contained' do
+      expect(restriction).not_to be_concerning(:index)
     end
 
-    it 'returns nil if non was given' do
-      expect(Restrict::Restriction.new(:foo).role).to be_nil
+    it 'returns true if it concerns :all_actions' do
+      restriction = Restrict::Restriction.new(:all_actions)
+      expect(restriction).to be_concerning(:foo)
+      expect(restriction).to be_concerning(:bar)
     end
   end
-
 end

data/spec/lib/restrict_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Restrict do
+
+  describe '#config' do
+    it 'returns a configuration' do
+      expect(Restrict.config).to be_a Restrict::Configuration
+    end
+
+    it 'yiels a configuration if block given' do
+      Restrict.config do |config|
+        expect(config).to be_a Restrict::Configuration
+      end
+    end
+
+    it 'keeps the same configuration' do
+      expect(Restrict.config).to eq Restrict.config
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restrict
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Johannes Opper
@@ -125,6 +125,7 @@ files:
 - Rakefile
 - lib/restrict.rb
 - lib/restrict/access_denied.rb
+- lib/restrict/configuration.rb
 - lib/restrict/error.rb
 - lib/restrict/gatekeeper.rb
 - lib/restrict/login_required.rb
@@ -135,10 +136,12 @@ files:
 - lib/restrict/rspec/matcher_rspec2.rb
 - lib/restrict/version.rb
 - restrict.gemspec
+- spec/lib/restrict/configuration_spec.rb
 - spec/lib/restrict/gatekeeper_spec.rb
 - spec/lib/restrict/rails/controller_spec.rb
 - spec/lib/restrict/restriction_spec.rb
 - spec/lib/restrict/rspec/matcher_spec.rb
+- spec/lib/restrict_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/xijo/restrict
 licenses:
@@ -165,8 +168,10 @@ signing_key:
 specification_version: 4
 summary: Simple access control dsl for controllers.
 test_files:
+- spec/lib/restrict/configuration_spec.rb
 - spec/lib/restrict/gatekeeper_spec.rb
 - spec/lib/restrict/rails/controller_spec.rb
 - spec/lib/restrict/restriction_spec.rb
 - spec/lib/restrict/rspec/matcher_spec.rb
+- spec/lib/restrict_spec.rb
 - spec/spec_helper.rb