Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ilanusse/praetorian
A minimalist Crystal authorization system inspired by https://github.com/varvet/pundit.
https://github.com/ilanusse/praetorian
authorisation authorization crystal crystal-lang crystal-language praetorian shard
Last synced: 6 days ago
JSON representation
A minimalist Crystal authorization system inspired by https://github.com/varvet/pundit.
- Host: GitHub
- URL: https://github.com/ilanusse/praetorian
- Owner: ilanusse
- License: mit
- Created: 2018-11-29T18:57:05.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-01-18T14:44:20.000Z (almost 3 years ago)
- Last Synced: 2024-10-25T01:24:26.657Z (15 days ago)
- Topics: authorisation, authorization, crystal, crystal-lang, crystal-language, praetorian, shard
- Language: Crystal
- Size: 43 KB
- Stars: 59
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-crystal - praetorian - Minimalist authorization library inspired by Pundit (Framework Components)
- awesome-crystal - praetorian - Minimalist authorization library inspired by Pundit (Framework Components)
README
# Praetorian
[](https://travis-ci.org/ilanusse/praetorian)
[](https://github.com/ilanusse/praetorian/releases/latest)
[](https://github.com/ilanusse/praetorian/blob/master/LICENSE)
Praetorian is a minimalist Crystal authorization system inspired by [Pundit](https://github.com/varvet/pundit). It aims to be both lightweight and dependency-less.
## Installation
```crystal
dependencies:
praetorian:
github: ilanusse/praetorian
```
## How to use
Praetorian, inspired by Pundit, works with policy classes. This shard is not designed to be extra compatible with any framework but rather with flexibility in mind.
This is a simple example that allows updating
a post if the user is an admin, or if the post is unpublished:
```crystal
class Post
def policy_class
PostPolicy
end
end
class PostPolicy
include Praetorian::Policy
property user, post
def initialize(user, post)
@user = user
@post = post
end
def update?
user.admin? || !post.published?
end
end
# Somewhere in your code
def update
@post = Post.find(params[:id])
Praetorian.authorize(current_user, @post, :update?) # You can also use .authorise if you're a Brit
# Rest of code flow
end
```
There are two things to notice here:
- The Post is a class that should obey a certain Policy. We can either write a `policy_class` method to return the policy class name, or Praetorian will assume the policy classname to be `#{variable_name}Policy`.
- The Policy class includes `Praetorian::Policy`. This adds default query methods to our policy as defaults that should be overwritten as necessary.
The default query methods defined in `Praetorian::Policy` are: `index?`, `show?`, `create?`, `new?`, `update?`, `edit?`, `destroy?`.
A `Praetorian::NotAuthorizedException` will be raised if the user is not authorized to perform said query on the record.
Ok. So far, pretty simple.
You can set up a simple base class to inherit from:
```crystal
class ApplicationPolicy
include Praetorian::Policy
property user, object
def initialize(user, object)
@user = user
@object = object
end
end
```
### Including the shard as a module
You can include the shard as a module in your controller base class to avoid the prefix:
```crystal
class ApplicationController
include Praetorian
end
class PostController < ApplicationController
@post = Post.find(params[:id])
authorize(current_user, @post, :update?) # yay no prefix
end
```
### Using a specific policy class
You can pass an argument to override the policy class if necessary. For example:
```crystal
def create
@publication = find_publication # assume this method returns any model that behaves like a publication
# @publication.class => Post
Praetorian.authorize(current_user, @publication, :create?, PublicationPolicy)
# Rest of code flow
end
```
# License
Licensed under the MIT license, see the separate LICENSE.txt file.