Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anjlab/graphql_authorize
Authorization helpers for ruby-graphql fields
https://github.com/anjlab/graphql_authorize
authorization cancancan gem graphql permissions pundit rails ruby
Last synced: 2 months ago
JSON representation
Authorization helpers for ruby-graphql fields
- Host: GitHub
- URL: https://github.com/anjlab/graphql_authorize
- Owner: anjlab
- License: mit
- Created: 2018-08-13T16:32:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-20T11:53:40.000Z (9 months ago)
- Last Synced: 2024-11-15T04:49:33.825Z (3 months ago)
- Topics: authorization, cancancan, gem, graphql, permissions, pundit, rails, ruby
- Language: Ruby
- Homepage:
- Size: 37.1 KB
- Stars: 24
- Watchers: 8
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://travis-ci.org/anjlab/graphql_authorize)
[](https://rubygems.org/gems/graphql_authorize)
[](https://codeclimate.com/github/anjlab/graphql_authorize/maintainability)
# GraphqlAuthorize
This gem allows you to authorize an access to you graphql-fields (defined by [graphql-ruby](https://github.com/rmosolgo/graphql-ruby)).
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'graphql_authorize'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install graphql_authorize
## Usage
You can define a proc and pass it to `authorize` inside the field block:
```ruby
field :posts, types[PostType] do
authorize lambda { |_obj, _args, context|
current_user = context[:current_user]
current_user && current_user.admin
}
resolve ->(_obj, _args, _context) { ... }
end
```
It also works for a new class-based syntax:
```ruby
field :posts, PostType, null: false do
authorize lambda { |_obj, _args, context|
current_user = context[:current_user]
current_user && current_user.admin
}
end
```
Don't forget to pass `current_user` to the context when you execute the query, e.g.:
```ruby
Schema.execute(query, context: { current_user: current_user })
```
### CanCanCan
If you are using CanCanCan, you can just pass an array with two values - permission to check and a model class:
```ruby
field :posts, types[PostType] do
authorize [:read, Post]
resolve ->(_obj, _args, _context) { ... }
end
```
In order to let GraphqlAuthorize know that it should use CanCanCan, please configure it somewhere in your app:
```ruby
GraphqlAuthorize.config.auth_adapter = GraphqlAuthorize::AuthAdapters::CanCanCan
```
By default it will try to call `can?` on the module called `Ability` (you have it if you follow the [guide](https://github.com/CanCanCommunity/cancancan/wiki/Defining-Abilities)). However, when you've done it in a different way, you must also configure `auth_adapter_source` - a proc, which will get a current context and will need to return something, which can respond to `can?`:
```ruby
GraphqlAuthorize.configure do |config|
config.auth_adapter = GraphqlAuthorize::AuthAdapters::CanCanCan
config.auth_adapter_source = ->(context) { context[:current_user] }
end
```
### Pundit
Pundit integration is very similar with CanCanCan - you should pass an array with two values in a following way:
```ruby
field :posts, types[PostType] do
authorize [:read, Post]
resolve ->(_obj, _args, _context) { ... }
end
```
Don't forget to configure GraphqlAuthorize to use the proper adapter:
```ruby
GraphqlAuthorize.config.auth_adapter = GraphqlAuthorize::AuthAdapters::Pundit
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/anjlab/graphql_authorize.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).