snapuser 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd6de8037acd4f6c436397f7015174ef41a769bc
-  data.tar.gz: 335fddb281e315ffe3ed395047500dafdd050011
+  metadata.gz: 6071678522da82d7646d3c87d54828f63f68129d
+  data.tar.gz: a55d8d5b1f208372018ced5a9d08fa9ab5d6a3f9
 SHA512:
-  metadata.gz: 8e461327b8781332f1f16a5428abf18bf786a71908f07d36fcccf6293e42b75ce9bb82927093c479b7a374951dc3f0cbc93f4d03e83f343adac62bb5fa4a5294
-  data.tar.gz: 0dbe2a6514993a1bbde843e667271522eaa48140bf0fd38d15898efb04ba67c15b797270a319dc2d3ac64ee0a350bbf59d60b47d66ec45519d10a9597857b4ee
+  metadata.gz: 0d0c1e350c3bfd3d02f8bb6c56bfcb997b77e848727d89241284464cdc816fc5cbe86c9d052e75459d7781d6c37a1560c02a2e74a87dbb9b8390da01bc163510
+  data.tar.gz: be262fffc639a34b54e241c8525334b1f9cb0e240263f3072970331131feff104dc86a4337c034808c12c6058dbe6f793a276b6e5205e5a301fe5977f9b1f1c6

data/README.md

@@ -0,0 +1,86 @@
+# Snapuser
+
+A rails engine to add a simple authentification and permission system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'snapuser'
+```
+
+And then execute:
+
+    $ bundle
+
+In order to run the engine's migrations:
+
+    $ rake db:migrate
+
+## Usage
+
+The gem provides two methods to securize your controllers and your views.
+
+Use `authorize_level(level)` to prevent access to an action from a certain user level. In this example, only the users with a level 3 or higher can visit these pages.
+
+```ruby
+class Admin::EventsController < Admin::BaseController
+  before_action { |c| c.authorize_level(3) }
+
+  def index
+    @events = Event.all
+  end
+
+  def new
+    @event = Event.new
+  end
+
+  def create
+    ...
+  end
+
+end
+```
+
+Use `authorize_level?(level)` to know if a user is authorized compared to a given level.
+
+```html
+<%= link_to "Add an event", new_event_path if authorize_level?(3) %>
+```
+
+Finally, if you just want that a user is connected, use the first method and pass the lowest level.
+
+The plugin also provides few methods that can be useful:
+* `current_user`: return the connected user, or otherwise `nil`
+* `signed_in?`: check if a user is connected
+
+The following URL are reserved by the plugin:
+
+* `/login`, login_path
+* `/user/edit`, user_edit_path
+* `/user/update`, user_update_path
+* `/signout`, signout_path
+* `/sessions`, sessions_path
+* resources `/admin/users`, admin_users_path
+
+## Configuration
+
+Create an custom initializer to put your configuration.
+
+You can configure the different permission's levels. Set `Snapuser.levels` with an hash:
+
+```ruby
+# initializers/snapuser.rb
+
+Snapuser.levels = {"superadmin" => "1", "admin" => "2", "author" => "3", "member" => "4"}
+```
+By default, the levels are `{"superadmin" => "1", "admin" => "2"}`.
+
+Set `Snapuser.superuser_level` to configure from which level the users are allowed to edit the other users. By default, the superuser level is 1.
+
+Set `Snapuser.can_edit` to configure from which level a user is allowed to edit his information (username and password).
+
+Set `Snapuser.redirect_url` to configure where the user is redirected after a successful login. By default, "/profile".
+
+Set `Snapuser.layout` to configure which layout is used in the admin views, when you edit a user for instance. By default, "admin".

data/Rakefile

@@ -4,34 +4,4 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Snapuser'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
-
-load 'rails/tasks/statistics.rake'
-
-
-
 Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-
-task default: :test

data/app/views/sessions/new.html.erb

@@ -3,13 +3,13 @@
 		<div>
 			<p>
 				<%= f.label :name %><br>
-				<%= f.text_field :name, placeholder: :name %>
+				<%= f.text_field :name %>
 			</p>
 		</div>
 		<div>
 			<p>
 				<%= f.label :password %><br>
-				<%= f.password_field :password, placeholder: :password %>
+				<%= f.password_field :password %>
 			</p>
 		</div>
 		<div class="rem">

data/lib/snapuser/version.rb

@@ -1,3 +1,3 @@
 module Snapuser
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapuser
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - khcr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-11 00:00:00.000000000 Z
+date: 2017-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- README.md
 - Rakefile
 - app/assets/stylesheets/snapuser.css
 - app/assets/stylesheets/snapuser/snapuser.css.scss
@@ -130,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: A rails engine to add a simple authentification and permission system.