guachiman 0.1.2 → 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24c4933a403cafbadec8a89d9d4c97fcc60363a1
+  data.tar.gz: f7105a30e32169f70009ba9e7035859ae35440c9
+SHA512:
+  metadata.gz: 700a5be51edeec2700bc4c584856e65e9a9ac5696c6ae1dcdc6f4ed3b0f8467eb55d83402a74d903685c9a70ea0b950c515d3b49df03de45dc3304e6606cafa0
+  data.tar.gz: c91922b1e2b61f69a3b10a4789f74371d02023b0d58597417c95f4f5c3df019f1560101352bb266f2ed9a6aec319b52d0ce8e5417823567458ac7c67dde336de

data/README.md

@@ -22,4 +22,69 @@ Or install it yourself as:
 Usage
 -----
 
-TODO: Write usage instructions here
+Include it in your `Gemfile`
+
+```ruby
+gem 'guachiman'
+```
+
+Run `bundle install`
+
+Run `rails g guachiman:install`
+
+This will generate a `Permission.rb` file in `app/models`.
+
+Include `Guachiman::Permissible` in `ApplicationController` and implemente a `current_user` method there.
+
+```ruby
+include Guachiman::Permissible
+
+def current_user
+  @current_user ||= User.find_by_auth_token(cookies[:auth_token]) if cookies[:auth_token]
+end
+```
+
+That's it, now you can describe your permissions in this way:
+
+```ruby
+class Permission
+  include Guachiman::Permissions
+  include Guachiman::Params
+
+  attr_reader :user
+
+  def initialize current_user
+    @user = current_user
+
+    if user.nil?
+      guest
+    elsif user.admin?
+      admin
+    else
+      member
+    end
+  end
+
+  private
+
+  def guest
+    allow :sessions,   [:new, :create, :destroy]
+    allow :identities, [:new, :create]
+    allow :passwords,  [:new, :create]
+
+    allow_param :user, [:name, :email, :password]
+  end
+
+  def member
+    guest
+    allow :identities, [:show, :edit, :update]
+    allow :passwords,  [:edit, :update]
+  end
+
+  def admin
+    allow_all!
+  end
+end
+```
+
+The method `allow` takes a controller params key and an array of actions. The method `allow_param` takes a model params key and an array of attributes. The method `allow_all!` is a convinience method to allow all controlles, actions and parameteres.

data/guachiman.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'railties', '>= 3.2'
-  spec.add_dependency 'activerecord', '>= 3.2'
+  spec.add_dependency 'railties', '>= 3.0'
+  spec.add_dependency 'activerecord', '>= 3.0'
   spec.add_dependency 'strong_parameters', '>= 0.2.1'
   spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'minitest-focus'

data/lib/guachiman/version.rb

@@ -1,3 +1,3 @@
 module Guachiman
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guachiman
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: 0.1.3
 platform: ruby
 authors:
 - Francesco Rodriguez
@@ -10,92 +9,81 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-06 00:00:00.000000000 Z
+date: 2013-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: strong_parameters
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: minitest
   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: minitest-focus
   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: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -103,7 +91,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -111,21 +98,19 @@ dependencies:
 - !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'
-description: ! 'Basic authorization library based on Ryan Bates'' Railscasts #385
-  and #386'
+description: 'Basic authorization library based on Ryan Bates'' Railscasts #385 and
+  #386'
 email:
 - lrodriguezsanc@gmail.com
 - gustavo@epiclabs.pe
@@ -152,27 +137,26 @@ files:
 homepage: https://github.com/epiclabs/guachiman
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Basic authorization library
 test_files:
 - test/generators/install_generator_test.rb