canner 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 7b7de0bc3ce06cfa8e719a5b4cd3da5d8847007b
-  data.tar.gz: 25cb560b1410ca7661df5ef6c1baf77c0c5dba7e
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Yjk3NGI2ZWYzMmQ1OTM1OTYzZjIwMjI5OWE3ZWIzMTM2YWY1NDdkNg==
+  data.tar.gz: !binary |-
+    YjBlYWRiNWI4YjQwYjRjYzMzOTI4ZjQxZDM5NWFlMGQ3YWRlMGRiMA==
 SHA512:
-  metadata.gz: e70bd029306bb3c7a4a6d4666d9452320dc7e43c284492173b243e1fbf0d860c0466e7ddc437a6827959a7a5d9e7f173cbf694817380f0f0ec5ff83a688c4aab
-  data.tar.gz: 4e70d8b65ab9f19a2665235dc9f7ed856e002a098648b900ddd9b60288b01f0885b058b0c14fc2175f2e52a0d42037087d34033fb990b893d1281d8ed0295392
+  metadata.gz: !binary |-
+    NzM3N2UxN2EzOWUyOGEwZDEzODIzOGM5M2VmOTUyYzNlZDgzM2U1NDNjNmE3
+    NmNhZTI1NjBiY2QwZGJhYWZiMjVmZmNmM2I4YjEzY2QzNzI3NTYyMWE5MzUy
+    ODM1YWI0ZDFlZmI1MzkwZDEyODdjYzc1YjMwY2MyODExYTJmYTA=
+  data.tar.gz: !binary |-
+    YmU5YTk0MmNhYjQ2OGIxYzE1NDA3MTE5M2IyZGJlN2ViM2VjY2IyZDMxZWQ0
+    YWQ3ODVkNzViODlkZjBlNzY0ZWI4NDdjMDNmMmU4NzUxYzIyN2JmMTkxYjk0
+    YzVjNjNiMzFjYWZlNTE3Mjk4YzAxZDhlNjM2OTIwZGZhNDg2YmY=

data/README.md

@@ -55,7 +55,7 @@ need to override the fetch_roles policy method.
 rails g canner:fetch_roles
 ```
 
-More details are available in the wiki: 
+More details are available in the wiki:
 [Overriding the Fetching of Roles](https://github.com/jacklin10/canner/wiki/Feed-Roles)
 
 ## Policies
@@ -64,7 +64,7 @@ As mentioned Canner is strongly influenced by Pundit and is also based on Policy
 Your policy objects should be named using the following pattern:   
 UserPolicy, CustomerPolicy, AppPolicy.
 
-Use the generator to save you some time: 
+Use the generator to save you some time:
 ``` rails g canner:policy <model name> ```
 
 Your policy models need to implement 2 methods:
@@ -167,7 +167,7 @@ end
 
 in your base_policy's `can?` method
 
-### instance_can? 
+### instance_can?
 
 You use the instance_can? method to determine if the current_user is able to modify a particular instance
 of an object.  
@@ -180,13 +180,13 @@ For example, if a user who belongs to company A wants to edit a particular item
 
 Normal stuff.  The user changes the item price and moves on.  
 
-But now we have another user who decides they want to see what happens when they manually change the url: 
+But now we have another user who decides they want to see what happens when they manually change the url:
 
 ```
 /items/13/edit
 ```
 
-If you don't defend against this the user would be granted access to edit item with id=13 which 
+If you don't defend against this the user would be granted access to edit item with id=13 which
 belongs to a different company.  
 
 The instance_can? method helps in these situations.  
@@ -237,10 +237,17 @@ You are able to force the use of controller authorization with canner.
 I recommend you do this so you don't forget to wrap authorization about some of your resources.
 
 To make sure your controller actions are using the can? method add this near the top of your
-application_controller.rb
+`application_controller.rb`.  Use the `except:` option for ensuring we ignore controllers
+related to authentication.
 
 ``` ruby
 after_action :ensure_auth
+
+# using devise?
+after_action :ensure_auth, except: :devise_controller?
+
+# using CASino?
+after_action :ensure_auth, unless: -> { self.is_a? CASino::SessionsController }
 ```
 
 And to make sure you are using the canner_scope do the following:
@@ -251,7 +258,7 @@ after_action :ensure_scope, only: :index
 Note the use of only here.  You usually won't need the canner_scope on anything except
 for the index to be strictly enforced.
 
-And finally, if you want to enforce that you are using instance_can? use something like: 
+And finally, if you want to enforce that you are using instance_can? use something like:
 ``` ruby
 after_action :ensure_instance_checking, only: [:edit, :destroy, :update]
 ```

data/lib/canner.rb

@@ -74,19 +74,16 @@ module Canner
   protected
 
   def ensure_scope
-    return if devise_controller? rescue false
     raise ScopeNotUsedError.new("Must use a canner_scope or exclude this action from the after_action") unless scope_used
     true
   end
 
   def ensure_auth
-    return if devise_controller? rescue false
     raise AuthNotUsedError.new("Must use can? method or exclude this action from the after_action") unless auth_used
     true
   end
 
   def ensure_instance_checking
-    return if devise_controller? rescue false
     raise AuthNotUsedError.new("Must use instance_can? method or exclude this action from the after_action") unless instance_checked
     true
   end

data/lib/canner/policy.rb

@@ -28,7 +28,7 @@ module Canner
       # end
     end
 
-    # implment in your policy class.
+    # implement in your policy class.
     # return true when the user can access the action or resource and false when they can't
     def can?
       raise ArgumentError.new("NOT IMPLEMENTED")
@@ -49,9 +49,12 @@ module Canner
 
     def has_role?(roles)
       begin
-        @roles.any?{|r| Util.prepare(roles).include?(r.name.to_sym) }
+        @roles.any? do |r|
+          name = r.respond_to?(:name) ? r.name : r.to_s
+          Util.prepare(roles).include?(name.to_sym)
+        end
       rescue Exception => e
-        raise ArgumentError.new "Canner: Problem fetching user roles. If current_user.roles isn't how you do it see wiki for overriding fetch_roles."
+        raise ArgumentError.new "Canner: Problem fetching user roles. If current_user.roles isn't how you do it see wiki for overriding fetch_roles. #{e}"
       end
     end
 

data/lib/canner/util.rb

@@ -3,19 +3,7 @@ class Util
   # ensures whatever is passed in comes out an array of symbols
   class << self
     def prepare(str)
-      symbolize(arrayify(str))
+      Array(str).flatten.map(&:to_sym)
     end
-
-    # ensures the array elements are symbols
-    def symbolize(strings)
-      strings.map{|s| s.to_sym}
-    end
-
-    # ensure given roles are in the form of an array
-    def arrayify(roles)
-      Array.wrap(roles).flatten
-    end
-
   end
-
 end

data/lib/canner/version.rb

@@ -1,3 +1,3 @@
 module Canner
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/canner_spec.rb

@@ -4,7 +4,7 @@ require "canner"
 class Sample
 end
 
-class SamplePolicy
+class SamplePolicy < Canner::Policy
 
   def initialize(current_user, method, current_branch)
     @current_user = current_user
@@ -14,13 +14,21 @@ class SamplePolicy
   end
 
   def fetch_roles
-    # ['admin']
+    ['admin']
   end
 
   def canner_scope
-    # [Sample.new]
+    [Sample.new]
   end
 
+  def can?
+   case @method
+   when :index, :show
+     has_role?(:admin)
+   else
+     false
+   end
+  end
 end
 
 class AppController
@@ -55,7 +63,7 @@ describe Canner do
       expect(app_controller).to receive(:canner_policy).and_return(sample_policy)
       expect(sample_policy).to receive(:instance_can?).and_return true
 
-      app_controller.instance_can?('test', 'sample', Sample.new).should be_truthy
+      expect(app_controller.instance_can?('test', 'sample', Sample.new)).to be true
     end
 
   end

data/spec/spec_helper.rb

@@ -5,7 +5,6 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: canner
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Joe Acklin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-04 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -70,42 +70,42 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: No magic authorization for Rails
@@ -148,20 +148,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Rails Auth
 test_files:
 - spec/canner_spec.rb
 - spec/spec_helper.rb
+has_rdoc: