rutaka-n/connfuse

# Connfuse

[![Build Status](https://travis-ci.org/rutaka-n/connfuse.svg?branch=master)](https://travis-ci.org/rutaka-n/connfuse)
[![Code Climate](https://codeclimate.com/github/rutaka-n/connfuse/badges/gpa.svg)](https://codeclimate.com/github/rutaka-n/connfuse)
[![Test Coverage](https://codeclimate.com/github/rutaka-n/connfuse/badges/coverage.svg)](https://codeclimate.com/github/rutaka-n/connfuse/coverage)
[![Issue Count](https://codeclimate.com/github/rutaka-n/connfuse/badges/issue_count.svg)](https://codeclimate.com/github/rutaka-n/connfuse)

Connfuse is a Ruby circuit breaker gem. It lets your application fail fast from failures of its service dependencies. It wraps calls to external services and monitors for failures.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'connfuse'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install connfuse

## Usage

You can use Circuit class directly:
```ruby
  circuit = Connfuse::Circuit.new
  circuit.pass_thru do
    some_transport.data.get(params)
  end
```
Or you can include Connfuse module in your class and specify methods:
```ruby
class Foo
  include Connfuse

  def bar
    # do something
  end

  fuse_for :bar
end
```
Circuit will be initialized for your class automatically
or you can specify parameters:
```ruby
class Foo
  include Connfuse
  circuit(limit: 5, timeout: 15, expected_errors: [SomeErrorClass])

  # ...
end
```
 - limit - number of attempts to execute method before circuit will be broken.
 - timeout - specify time until the next attempt to execute methods when circuit is broken.
 - expected_errors - array of error classes which do not count as errors of circuit.

## 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 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/rutaka-n/connfuse. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.


## License

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