https://github.com/dwbutler/qu-mongoid

Qu Mongoid Backend
https://github.com/dwbutler/qu-mongoid

Last synced: about 1 month ago
JSON representation

Qu Mongoid Backend

• Host: GitHub
• URL: https://github.com/dwbutler/qu-mongoid
• Owner: dwbutler
• License: mit
• Created: 2012-09-18T00:21:21.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2014-06-25T16:37:44.000Z (over 10 years ago)
• Last Synced: 2024-09-17T19:47:48.215Z (3 months ago)
• Language: Ruby
• Size: 203 KB
• Stars: 1
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Qu-Mongoid

[![Build Status](https://secure.travis-ci.org/dwbutler/qu-mongoid.png)](http://travis-ci.org/dwbutler/qu-mongoid)

This gem provides a Mongoid 3 / Moped backend for the queueing library [Qu](http://github.com/bkeepers/qu). See the documentation for Qu for more information.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'qu'

gem 'qu-mongoid'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install qu-mongoid

Tested in Ruby 1.9.3, 2.0.0, JRuby (1.9 mode), and Rubinius (1.9 mode). Ruby 1.8.7 is not supported because Mongoid 3 only supports Ruby 1.9+.

## Why not just use the Mongo backend?

Starting with version 3, Mongoid uses its own mongoDB driver (Moped) instead of the official 10gen ruby driver (mongo). To avoid loading both drivers, I ported the Mongo backend to Mongoid/Moped.

Mongoid version 2 and below uses the mongo driver, so use qu-mongo if you are on Mongoid 2.

## Configuration

Qu-Mongoid will automatically connect to the default session configured in mongoid.yml. If a default session is not configured, it will attempt to read from ```ENV['MONGOHQ_URL']``` and ```ENV['MONGOLAB_URI']```, so it should work on Heroku. If you need to use a different Mongoid session, you should do the following:

```ruby

Qu.configure do |c|

  c.backend.session = :qu

end

```

You may also configure the Qu connection using the code below, but **WARNING**: if you are running your workers in threads, this configuration is **NOT** recommended. This is because Mongoid uses a separate connection on each thread, so only the original thread will use the configured connection. New threads will use the default Mongoid session as described above.

``` ruby

Qu.configure do |c|

  c.connection = Mongoid::Sessions.with_name(:qu) # New threads will not use this configured connection.

end

```

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Added some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request