From 3a92e039c504abfab5d43b9bc1b8956f4cf508e7 Mon Sep 17 00:00:00 2001 From: Vesa Laakso Date: Thu, 4 Aug 2016 13:52:52 +0300 Subject: [PATCH 1/2] Expand README on caveats --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fb16aebf..4042d5f4 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,19 @@ branch. This may contain information that is not relevant to the release you are `JSONAPI::Authorization` adds authorization to the [jsonapi-resources][jr] (JR) gem using [Pundit][pundit]. -***PLEASE NOTE:*** This gem is still considered to be ***alpha quality***. Make sure to test for authorization in your application, too. We should have coverage of all operations, though. If that isn't the case, please [open an issue][issues]. - [jr]: https://github.com/cerebris/jsonapi-resources "A resource-focused Rails library for developing JSON API compliant servers." [pundit]: https://github.com/elabs/pundit "Minimal authorization through OO design and pure Ruby classes" + +## Caveats + +Make sure to test for authorization in your application, too. We should have coverage of all operations, though. If that isn't the case, please [open an issue][issues]. + +This gem should work out-of-the box for simple cases. The default authorizer might be overly restrictive for [more complex cases][complex-case]. + +The API is subject to change between minor version bumps until we reach v1.0.0. + [issues]: https://github.com/venuu/jsonapi-authorization/issues + [complex-case]: https://github.com/venuu/jsonapi-authorization/issues/15 ## Installation From 0cdcc749db959bd3bfc2d91fae7891433ee297dc Mon Sep 17 00:00:00 2001 From: Vesa Laakso Date: Thu, 4 Aug 2016 13:53:05 +0300 Subject: [PATCH 2/2] Note about JR compatibility in README --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4042d5f4..14449230 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,6 @@ This gem should work out-of-the box for simple cases. The default authorizer mig The API is subject to change between minor version bumps until we reach v1.0.0. - [issues]: https://github.com/venuu/jsonapi-authorization/issues [complex-case]: https://github.com/venuu/jsonapi-authorization/issues/15 ## Installation @@ -41,6 +40,13 @@ Or install it yourself as: $ gem install jsonapi-authorization +## Compatibility + +* `v0.6.x` supports JR `v0.7.x` +* `v0.8.x` supports JR `v0.8.x` + +We aim to support the same Ruby and Ruby on Rails versions as `jsonapi-resources` does. If that's not the case, please [open an issue][issues]. + ## Usage First make sure you have a Pundit policy specified for every backing model that your JR resources use. @@ -118,3 +124,5 @@ Originally based on discussion and code samples by [@barelyknown](https://github ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/venuu/jsonapi-authorization. + + [issues]: https://github.com/venuu/jsonapi-authorization/issues