https://github.com/bih/userq
A user queuing system for Rails
https://github.com/bih/userq
Last synced: over 1 year ago
JSON representation
A user queuing system for Rails
- Host: GitHub
- URL: https://github.com/bih/userq
- Owner: bih
- License: mit
- Created: 2013-12-22T14:04:13.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2015-03-27T12:58:42.000Z (over 11 years ago)
- Last Synced: 2024-04-23T16:43:15.962Z (about 2 years ago)
- Language: Ruby
- Homepage:
- Size: 371 KB
- Stars: 11
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# UserQ: Simple User Queues for Rails
UserQ allows you to **very quickly** integrate awesome user-based queues into your Rails application. Many large ticketing websites such as [Ticketmaster](http://www.ticketmaster.com) use queues as a means of user experience.
[](https://travis-ci.org/studenthack/userq)
[](https://gemnasium.com/studenthack/userq)
### Example code
```ruby
queue = UserQ::Queue.new(capacity: 50)
## Can we enter the queue?
if queue.enter_into_queue?
entry = queue.enter
# They have a place in the queue. Sell them a ticket!
else
# No place in queue. Run this block again after n seconds.
end
# Default expiry: 180 seconds
puts entry.expires # => 180
sleep(5)
puts entry.expires # => 175
```
### How does it work?
Tell it how much you capacity you have (i.e. how many available tickets are left) and then UserQ does its beautiful magic. Some of the questions you can ask UserQ:
* How many "people" are in the queue?
* When does the current users spot in the queue expire?
* When do you think another spot in the queue will open? (i.e. average wait time)
* Can I extend/shorten the current users spot in the queue?
### Install
```
Install the gem:
$ gem install userq
Install the database model (automatically migrates):
$ rails generate userq:install
You're all setup!
```
### UserQ Documentation
See the [full documentation on the Wiki](https://github.com/studenthack/userq/wiki/Documentation#getting-started) to see what you can do with UserQ.
### Roadmap
- Lots of more awesome looking tests
- Develop the UserQ Wiki
- Assign queue places in a chronological order (first into queue = first entry) instead of randomly
### Release History
- 25/12/13: Fixed bug in using custom data (and tests added for it)
- 23/12/13: The initial version
### LICENCE
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.