https://github.com/taketo1113/rack-change-password-url
A Well-Known URL for Changing Passwords for Rails and Rack apps
https://github.com/taketo1113/rack-change-password-url
rack rack-middleware rails ruby
Last synced: 5 months ago
JSON representation
A Well-Known URL for Changing Passwords for Rails and Rack apps
- Host: GitHub
- URL: https://github.com/taketo1113/rack-change-password-url
- Owner: taketo1113
- License: mit
- Created: 2022-10-11T14:56:37.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-02T12:48:24.000Z (8 months ago)
- Last Synced: 2024-12-13T00:32:00.465Z (5 months ago)
- Topics: rack, rack-middleware, rails, ruby
- Language: Ruby
- Homepage:
- Size: 34.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Rack::ChangePasswordUrl
Provides endpoint of a Well-Known URL for Changing Passwords for Rails and Rack apps.
References:
* [A Well-Known URL for Changing Passwords | W3C](https://www.w3.org/TR/change-password-url/)
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add rack-change-password-url
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install rack-change-password-url
## Usage
### For Rack App
```ruby
require "rack/change-password-url"
Rack::ChangePasswordUrl.configure do |config|
config.redirect_path = 'your-redirect-path'
end
use Rack::ChangePasswordUrl::Middleware
```
### For Rails App
```ruby
# config/initializers/change_password_url.rb
Rack::ChangePasswordUrl.configure do |config|
config.redirect_path = 'your-redirect-path'
end
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/taketo1113/rack-change-password-url.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).