# RailsFailover

* Automatic failover and recovery for simple master-replica Redis setup

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'rails_failover'
```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install rails_failover

## Usage

### Redis

```
Redis.new(host: "127.0.0.1", port: 6379, replica_host: "127.0.0.1", replica_port: 6380, connector: RailsFailover::Redis::Connector))
```

Callbacks can be registered when the master connection is down and when it is up.


```
RailsFailover::Redis.register_master_up_callback do
  # Switch site to read-only mode
end

RailsFailover::Redis.register_master_down_callback do
  # Switch site out of read-only mode
end
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `make test` 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 tags, 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/[USERNAME]/rails_failover. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rails_failover/blob/master/CODE_OF_CONDUCT.md).


## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the RailsFailover project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rails_failover/blob/master/CODE_OF_CONDUCT.md).