multiconnect

Multiconnect

Multiconnect is a way to manage your server conenction fallbacks.

Installation

Add this line to your application's Gemfile:

gem 'multiconnect'

And then execute:

$ bundle

Or install it yourself as:

$ gem install multiconnect

Usage

Let's say you have an object that wraps JsonApiClient and you want to make sure that your client server has some level of failure tolerance.

You want your client to make a request to the server, but if it fails you want to try to pull from cache. Here's a simple way to do this:

module Zappos
  module Client
    class Shoe
      self.site = "http://zappos.com/api"
    end
  end
end

class Shoe
  self.client_class = Zappos::Client::Shoe

  include Multiconnect::Connectable

  # block of connections

  # try to hit the server directly. If the server fails, disallow calls for 30 seconds
  add_connection :server, client: client_class, class: CircuitBreakerServerConnection

  # If the server call failed, try to fetch the value from cache. This assumes you cache that somewhere
  add_connection :cache_fallback
  

  # whatever your client calling code is
  def self.call_client(action, *args)
    request(action, *args)
  end
end

You can find all these connections in the examples file

Development

After checking out the repo, run bin/setup to install dependencies. Then, 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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

1. Fork it ( https://github.com/gaorlov/multiconnect/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request