/openform-rbac-api

Primary LanguageRubyMIT LicenseMIT

Rootstrap RBAC+

CircleCI Code Climate Test Coverage

Role-based access control for Rootstrap projects.

RBAC+ restricts access based on a person's role within an organization and has become one of the main methods for advanced access control.

The roles in RBAC refer to the levels of access that users have in a platform.

The "+" stands for positive RBAC. We give access to specified resources, but no access is denied explicitly.

Finally, it contains a plug an play Administration console (thanks to ActiveAdmin).

Domain

How to use

  1. Clone this repo
  2. Install PostgreSQL in case you don't have it
  3. Create your database.yml and application.yml file
  4. bundle install
  5. Generate a secret key with rake secret and paste this value into the application.yml.
  6. rails db:create db:migrate
  7. rspec and make sure all tests pass
  8. rails s
  9. You can now try your REST services!

How to use with docker

Api Docs

https://rsrbac.docs.apiary.io/

Code quality

With rake code_analysis you can run the code analysis tool, you can omit rules with:

  • Rubocop Edit .rubocop.yml
  • Reek Edit config.reek
  • Rails Best Practices Edit config/rails_best_practices.yml
  • Brakeman Run brakeman -I to generate config/brakeman.ignore
  • Bullet You can add exceptions to a bullet initializer or in the controller

Configuring Code Climate

  1. After adding the project to CC, go to Repo Settings
  2. On the Test Coverage tab, copy the Test Reporter ID
  3. Replace the current value of CC_TEST_REPORTER_ID on the config.yml file (.circleci/config.yml) with the one you copied from CC

Code Owners

You can use CODEOWNERS file to define individuals or teams that are responsible for code in the repository.

Code owners are automatically requested for review when someone opens a pull request that modifies code that they own.

Credits

Rails Api Base is maintained by Rootstrap with the help of our contributors.