active_model_serializers-cancan 0.0.1 → 0.0.2

data/README.md

@@ -18,6 +18,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Associations
+
 `hasOne` and `hasMany` serializer macros now support an additional property, `authorize`. Associations with this property set to true will be authorized and filtered via CanCan. For example:
 
 ```ruby
@@ -27,11 +29,45 @@ class PostSerializer < ActiveModel::Serializer
   has_one :author, authorize: true
   has_many :comments, authorize: true
 end
-
 ```
 
+### Helpers
+
 Serializers now also have access to the same helpers as controllers, namely `current_ability`, `can?`, and `cannot?`.
 
+### Ability Serialization
+
+Use the `abilities` helper method to add an `abilities` key to the serialized data. For example:
+
+```ruby
+class PostSerializer < ActiveModel::Serializer
+  attributes :id
+  abilities :show, :update
+end
+
+@post.as_json # { id: 1, abilities: { show: true, update: false } }
+```
+
+#### RESTful Alias
+
+If `:restful` is passed as an ability it will expand to the 7 default
+RESTful actions: `:index, :show, :new, :create, :edit, :update, :destroy`
+
+#### Overriding an Ability
+
+Abilities are checked by calling the `can_#{action}?` method.  By overriding this method the result for the ability can be customized. For example:
+
+```ruby
+class PostSerializer < ActiveModel::Serializer
+  attributes :id
+  abilities :show
+
+  def can_show?
+    session[:wizard_started] && can?(:show, object)
+  end
+end
+```
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,7 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/active_model_serializers-cancan.gemspec

@@ -16,6 +16,10 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "active_model_serializers", "~> 0.7.0"
-  gem.add_dependency "cancan", "~> 1.6.9"
+  gem.add_dependency 'active_model_serializers'
+  gem.add_dependency 'cancan', '~> 1.6'
+
+  gem.add_development_dependency 'bundler', '~> 1.3'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
 end

data/lib/active_model_serializers-cancan.rb

@@ -1 +1 @@
-require "active_model_serializers/cancan"
+require "active_model_serializers/cancan"

data/lib/active_model_serializers/cancan.rb

@@ -1,2 +1,6 @@
-require "active_model_serializers/cancan/version"
-require "active_model_serializers/cancan/associations"
+require 'cancan'
+require 'active_model_serializers'
+require 'active_model_serializers/cancan/version'
+require 'active_model_serializers/cancan/helpers'
+require 'active_model_serializers/cancan/associations'
+require 'active_model_serializers/cancan/abilities'

data/lib/active_model_serializers/cancan/abilities.rb

@@ -0,0 +1,46 @@
+module ActiveModel
+  class Serializer
+    module CanCan
+      module Abilities
+        extend ActiveSupport::Concern
+
+        included do
+          class_attribute :cancan_actions
+        end
+
+        module ClassMethods
+          def abilities(*actions)
+            self.cancan_actions = expand_cancan_actions(actions)
+            cancan_actions.each do |action|
+              method = "can_#{action}?".to_sym
+              unless method_defined?(method)
+                define_method method do
+                  can? action, object
+                end
+              end
+            end
+            attributes :abilities
+          end
+
+          private
+          def expand_cancan_actions(actions)
+            if actions.include? :restful
+              actions.delete :restful
+              actions |= [:index, :show, :new, :create, :edit, :update, :destroy]
+            end
+            actions
+          end
+        end
+
+        def abilities
+          cancan_actions.inject({}) do |hash, action|
+            hash[action] = send("can_#{action}?")
+            hash
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveModel::Serializer.send :include, ActiveModel::Serializer::CanCan::Abilities

data/lib/active_model_serializers/cancan/associations.rb

@@ -1,6 +1,3 @@
-require 'cancan'
-require 'active_model_serializers'
-
 module ActiveModel
   class Serializer
     module Associations #:nodoc:
@@ -10,25 +7,13 @@ module ActiveModel
           !!option(:authorize)
         end
 
-        def current_ability
-          Ability.new(source_serializer.options[:scope])
-        end
-
-        def can?(*args)
-          current_ability.can? *args
-        end
-
-        def cannot?
-          current_ability.cannot? *args
-        end
-
       end
 
       class HasMany #:nodoc:
 
         def serialize_with_cancan
           return serialize_without_cancan unless authorize?
-          associated_object.select{|o| current_ability.can?(:read, o)}.map do |item|
+          associated_object.select{|o| source_serializer.can?(:read, o)}.map do |item|
             find_serializable(item).serializable_hash
           end
         end
@@ -39,7 +24,7 @@ module ActiveModel
       class HasOne #:nodoc:
 
         def serialize_with_cancan
-          return nil unless !authorize? || current_ability.can?(:read, associated_object)
+          return nil unless !authorize? || source_serializer.can?(:read, associated_object)
           serialize_without_cancan
         end
         alias_method_chain :serialize, :cancan
@@ -47,4 +32,4 @@ module ActiveModel
       end
     end
   end
-end
+end

data/lib/active_model_serializers/cancan/helpers.rb

@@ -0,0 +1,21 @@
+module ActiveModel
+  class Serializer
+    module CanCan
+      module Helpers
+        def current_ability
+          Ability.new(options[:scope])
+        end
+
+        def can?(*args)
+          current_ability.can? *args
+        end
+
+        def cannot?
+          current_ability.cannot? *args
+        end
+      end
+    end
+  end
+end
+
+ActiveModel::Serializer.send :include, ActiveModel::Serializer::CanCan::Helpers

data/lib/active_model_serializers/cancan/version.rb

@@ -1,7 +1,7 @@
 module ActiveModel
   module Serializers
     module Cancan
-      VERSION = "0.0.1"
+      VERSION = "0.0.2"
     end
   end
 end

data/spec/active_model_serializers/cancan/abilities_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe ActiveModel::Serializer::CanCan::Abilities do
+  let(:user) { User.first }
+  let(:category) { Category.first }
+
+  class MockAbility
+    include CanCan::Ability
+    def initialize(user)
+      can :manage, Category
+      cannot :read, Category
+    end
+  end
+
+  describe '.abilities' do
+    let(:serializer) do
+      Class.new(ActiveModel::Serializer) do
+        attributes :id
+        abilities :restful, :foo
+        def current_ability
+          MockAbility.new(nil)
+        end
+
+        def can_foo?
+          true
+        end
+      end
+    end
+
+    let(:category_serializer) { serializer.new(category, scope: user) }
+
+    context 'serializable_hash' do
+      subject { category_serializer.serializable_hash }
+      its(:keys) { should eq [:id, :abilities] }
+    end
+
+    context 'abilities key' do
+      subject { category_serializer.serializable_hash[:abilities] }
+      its([:restful]) { should be_nil }
+      its([:update]) { should be_true }
+      its([:show]) { should be_false }
+      its([:foo]) { should be_true }
+    end
+  end
+end

data/spec/active_model_serializers/cancan/associations_spec.rb

@@ -75,4 +75,4 @@ describe ActiveModel::Serializer::Associations do
 
   end
 
-end
+end

data/spec/spec_helper.rb

@@ -43,4 +43,4 @@ RSpec.configure do |config|
     Project.delete_all
     Category.delete_all
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_model_serializers-cancan
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-20 00:00:00.000000000 Z
+date: 2013-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cancan
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.9
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,55 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.9
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - ghempton@gmail.com
@@ -60,8 +108,11 @@ files:
 - init.rb
 - lib/active_model_serializers-cancan.rb
 - lib/active_model_serializers/cancan.rb
+- lib/active_model_serializers/cancan/abilities.rb
 - lib/active_model_serializers/cancan/associations.rb
+- lib/active_model_serializers/cancan/helpers.rb
 - lib/active_model_serializers/cancan/version.rb
+- spec/active_model_serializers/cancan/abilities_spec.rb
 - spec/active_model_serializers/cancan/associations_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -89,6 +140,7 @@ signing_key:
 specification_version: 3
 summary: CanCan integration with Active Model Serializers
 test_files:
+- spec/active_model_serializers/cancan/abilities_spec.rb
 - spec/active_model_serializers/cancan/associations_spec.rb
 - spec/spec_helper.rb
 has_rdoc: