README.md in barbeque_client-0.9.1 vs README.md in barbeque_client-0.10.0
- old
+ new
@@ -26,10 +26,11 @@
```rb
execution = BarbequeClient.enqueue(
job: 'NotifyAuthor', # @param [String] job - Job name to enqueue.
message: { user_id: 7553989 }, # @param [Object] message - An object which is serializable as JSON.
queue: 'default', # @param optional [String] queue - A queue name to enqueue a job.
+ delay_seconds: 0, # @param optional [Integer] delay_seconds - Message timer of SQS.
)
execution.message_id #=> "a3c653c1-335e-4d4d-a6f9-eb91c0253d02"
execution.status #=> "pending"
```
@@ -37,9 +38,24 @@
```rb
message_id = "a3c653c1-335e-4d4d-a6f9-eb91c0253d02"
BarbequeClient.status(message_id: message_id) #=> "success"
```
+
+### With Rails
+
+Barbeque client has adapter for ActiveJob.
+
+```rb
+# config/environments/some_environment.rb
+Rails.application.config.active_job.queue_adapter = :barbeque
+```
+
+And everything will be ok. Don't forget to setup `config.application` and `config.endpoint` in somewhere.
+One more thing, `config.default_queue` option is meaningless with Rails.
+`default_queue` is the fallback option for enqueueing without specified queue name.
+However, ActiveJob always set default queue as 'default' internally,
+there is no place to work on. So please use [`queue_as`](http://api.rubyonrails.org/classes/ActiveJob/QueueName/ClassMethods.html#method-i-queue_as) when you want to use different queue name.
### Distributed tracing
Configure `tracing` option. Pick one of supported tracers.
See more detail in https://github.com/cookpad/garage_client#tracing.