Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/charlotte-ruby/lock

Simple plugin that allows you to lock all or part of your app with a single password. Useful for hiding new features that are being beta tested
https://github.com/charlotte-ruby/lock

Last synced: about 1 month ago
JSON representation

Simple plugin that allows you to lock all or part of your app with a single password. Useful for hiding new features that are being beta tested

Host: GitHub
URL: https://github.com/charlotte-ruby/lock
Owner: charlotte-ruby
License: mit
Created: 2011-03-07T13:13:58.000Z (almost 14 years ago)
Default Branch: master
Last Pushed: 2022-12-11T16:40:45.000Z (about 2 years ago)
Last Synced: 2024-05-01T09:49:32.337Z (8 months ago)
Language: Ruby
Homepage:
Size: 203 KB
Stars: 23
Watchers: 4
Forks: 8
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

![Lock Logo](https://github.com/charlotte-ruby/lock/blob/master/logo.png?raw=true)

# Lock

[![ruby](https://github.com/charlotte-ruby/lock/actions/workflows/ruby.yml/badge.svg)](https://github.com/charlotte-ruby/lock/actions/workflows/ruby.yml)

A simple Rails Engine that lets you lock down controllers, specific actions or an entire site with a password. This engine is useful for locking down new features
or your entire site in production while your app is being beta tested. This is not a full-blown user authentication engine, nor is it intended to be.

## Install the gem

Add to your Gemfile

```
bundle add 'lock'
```

Install with bundler

```
bundle install
```

## Generate password file

The following command will generate /config/lock_password, which contains an encrypted password. Lock uses this for authentication

```
rails g lock:create_password_file yourpasswordhere
```

## Lock your app

You lock your app in the ApplicationController (/app/controllers/application_controller.rb).

If you want to lock your entire app use this:

```ruby
ApplicationController < ActionController::Base
lock
end
```

If you want to lock specific actions inside the widgets_controller use this:

```ruby
ApplicationController < ActionController::Base
lock actions: ["widgets#new", "widgets#index"]
end
```

If you want to lock all actions in a controller, you can just leave off the # sign and action name. The following will lock all actions in the widgets_controller

```ruby
ApplicationController < ActionController::Base
lock actions: ["widgets"]
end
```

## Unlock your app

1. Use the lock login url - /lock/login
2. Type in your password (from the generator) and press unlock

## Override the views

You may want to customize the views to fit your app. The easiest way to achieve this is to create the lock views directory - /app/views/lock, and
add your own view files. The views should be named:

```
/app/views/lock/refused.html.erb #message shown to users when they access a locked page
/app/views/lock/login.html.erb #login form
/app/views/lock/unlock.html.erb #shows a confirmation message after you unlock it
```

If you choose to override the login page, you will need to create a form that posts to /lock/unlock and uses a password field
named "password".

By default, these views will render inside your default layout. To create a custom layout for these files, just add /app/views/layouts/lock.html.erb
The layout must contain a yield.

## Contributing to lock

* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests for it. Patches without tests will be ignored
* Please try not to mess with the Rakefile, version, or history.