Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryandotsmith/komrade-client
A client for the Komrade worker system.
https://github.com/ryandotsmith/komrade-client
Last synced: 3 months ago
JSON representation
A client for the Komrade worker system.
- Host: GitHub
- URL: https://github.com/ryandotsmith/komrade-client
- Owner: ryandotsmith
- Created: 2013-01-25T07:41:11.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2013-03-05T05:42:02.000Z (almost 12 years ago)
- Last Synced: 2024-04-24T22:20:20.003Z (9 months ago)
- Language: Ruby
- Size: 251 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Komrade Client
A small, Ruby superset of Komrade's [HTTP API](https://gist.github.com/4641301)
## Setup
Email [email protected] with your heroku email address for a beta pass.
```bash
$ heroku addons:add komrade:test
$ gem install komrade-client
```
## Usage
1. Install Gem
2. Minimalist Example
3. Rails Example
4. Komrade Dashboard
### Install Gem
Gemfile
```ruby
source :rubygems
gem 'komrade-client', '~> 1.0.15'
```
### Minimalist Example ###
This is the absolute bare minimum to see Komrade in action.
```bash
$ export KOMRADE_URL=https://{heroku_username}:{heroku_password}@service.komrade.io
$ ruby -r komrade-client -e 'Komrade::Queue.enqueue("puts", "hello world")'
$ ruby -r komrade-client -e 'puts Komrade::Queue.dequeue'
```
You should see "hello world" output in your terminal.
### Rails Example ###
To get started add `gem 'komrade-client', '~> 1.0.15'` to your Gemfile. Then run
`rails g komrade`. This will add a komrade-worker process to your Procfile (feel
free to edit your Procfile by hand if you prefer).
Your Procfile now should look something like this:
```
web: bundle exec rails s
komrade-worker: bundle exec rake komrade:work
```
This is an example of a Rails model that sends a welcome email upon user sign up.
The only code that is unique to Komrade here is the `Komrade::Queue.enqueue` method.
This method takes a method as a string and any parameters you want to pass to that method.
```ruby
class User < ActiveRecord::Base
after_create :enqueue_welcome_email
def self.send_welcome_email(id)
if u = find(id)
Mailer.welcome(u).deliver
end
end
def enqueue_welcome_email
Komrade::Queue.enqueue("User.send_welcome_email", self.id)
end
end
```
When you deploy your code, the will queue be ready to accept jobs, and the worker process
is waiting to do the work.
### Komrade Dashboard
```bash
$ heroku addons:open komrade:test
```
