Skip to content

dispatchitinc/devise_revocable_session

 
 

Repository files navigation

DeviseRevocableSession

A module for devise to revoke sessions.

This is borrowed heavily from: https://github.com/mkhairi/devise_revocable and https://www.jonathanleighton.com/articles/2013/revocable-sessions-with-devise/.

Installation

Add this line to your application's Gemfile:

gem 'devise_revocable_session'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install devise_revocable_session

Usage

Install using the generator

$ rails g devise_revocable_sessions

Add :revocable_session to your model's devise declaration.

Development

Making Changes

  1. Clone or fork the repository
  2. Create a feature branch for your changes
  3. Run bundle install
  4. Make your changes
  5. Test the gem locally
    • Run gem build *.gemspec to build the gem locally
    • Run gem install --local devise_revocable_session-X.X.X.gem to install the gem locally
  6. Make a pull request back to this repository

Releasing

  1. Make sure the lib/devise_revocable_session/version.rb file is updated with a new version
  2. Run git tag vX.X.X && git push --tag
  3. Run gem build *.gemspec
  4. Run gem push *.gem to push the new version to RubyGems
  5. Run rm *.gem to clean up your local repository

To set up your local machine to push to RubyGems via the API, see the RubyGems documentation.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/dispatchitinc/devise_revocable_session. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Code of Conduct

Everyone interacting in the DeviseRevocableSession project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the Contributor Covenant code of conduct.

Copyright

Copyright (c) 2022 Dispatch. See MIT License for further details.

About

A devise gem that adds revocable session functionality

Resources

License

Stars

Watchers

Forks

Languages

  • Ruby 98.4%
  • Shell 1.6%