File: README — Documentation for iron

IronMQ Ruby Client

The full API documentation is here and this client tries to stick to the API as much as possible so if you see an option in the API docs, you can use it in the methods below.

The versioning of this gem can be confusing when mapping it onto our API versions. For the v3 version of the MQ API you will want to use a version >= 6.x.x (this should be you). If you are still using version v2 of the MQ API (deprecated), you will need to stay at version <= 5.x.

Getting Started

1. Install the gem:

gem install iron_mq

2. Setup your Iron.io credentials

3. Create an IronMQ client object:

ironmq = IronMQ::Client.new

Or pass in credentials if you don't want to use an iron.json file or set ENV variables:

ironmq = IronMQ::Client.new(token: 'MY_TOKEN',
                            project_id: 'MY_PROJECT_ID')

You can also change the host if you want to use a different cloud or region, for example, to use Rackspace ORD:

ironmq = IronMQ::Client.new(host: 'mq-rackspace-ord.iron.io',
                            token:'MY_TOKEN',
                            project_id: 'MY_PROJECT_ID')

The default host is AWS us-east-1 zone (mq-aws-us-east-1.iron.io). See all available hosts/clouds/regions.

Keystone Authentication

Via Configuration File

Add keystone section to your iron.json file:

{
  "project_id": "57a7b7b35e8e331d45000001",
  "keystone": {
    "server": "http://your.keystone.host/v2.0/",
    "tenant": "some-group",
    "username": "name",
    "password": "password"
  }
}

In Code

keystone = {
  server: "http://your.keystone.host/v2.0/",
  tenant: "some-gorup",
  username: "name",
  password: "password"
}
client = IronMQ::Client.new(project_id: "57a7b7b35e8e331d45000001", keystone: keystone)

The Basics

Get Queues List

list_queues = ironmq.queues.list # => [#<IronMQ::Queue:...>, ...]

Get a Queue Object

You can have as many queues as you want, each with their own unique set of messages.

queue = ironmq.queue('my_queue')

Now you can use it.

Post a Message on a Queue

Messages are placed on the queue in a FIFO arrangement. If a queue does not exist, it will be created upon the first posting of a message.

queue.post('hello world!')

Retrieve Queue Information

queue.info
# => {"id"=>"5127bf043264140e863e2283", "name"=>"my_queue", ...}
queue.id
# => "5127bf043264140e863e2283"

Reserve/Get a Message from a Queue

msg = queue.reserve
msg.body
# => "hello world!"

When you reserve a message from the queue, it is no longer on the queue but it still exists within the system. You have to explicitly delete the message or else it will go back onto the queue after the timeout. The default timeout is 60 seconds. Minimal timeout is 30 seconds.

Delete a Message from a Queue

msg.delete
# or
queue.delete(message_id, reservation_id)

Be sure to delete a message from the queue when you're done with it.

messages = queue.reserve(n: 3)
queue.delete_reserved_messages(messages)

Delete reserved messages when you're done with it.

Client

IronMQ::Client is based on IronCore::Client and provides easy access to the queues.

ironmq = IronMQ::Client.new(token: 'MY_TOKEN',
                            project_id: 'MY_PROJECT_ID')

List Queues

all_queues = ironmq.queues.list
# => [#<IronMQ::Queue:...>, ...]
# or
all_queues = ironmq.queues.all
# => [#<IronMQ::Queue:...>, ...]

Optional parameters:

per_page: number of elements in response, default is 30.
previous: this is the last queue on the previous page, it will start from the next one. If queue with specified name doesn’t exist result will contain first per_page queues that lexicographically greater than previous
prefix: an optional queue prefix to search on. e.g., prefix=ca could return queues ["cars", "cats", etc.]
raw: Set it to true to obtain data in raw format. The default is false.

queues = ironmq.queues.all(per_page: 10, previous: 'test_queue')

Get Queue by Name

queue = ironmq.queue('my_queue')
# => #<IronMQ::Queue:...>

Note: if queue with desired name does not exist it returns fake queue. Queue will be created automatically on post of first message or queue configuration update.

Queues

Create a Queue

ironmq = IronMQ::Client.new
options = {
  message_timeout: 120,
  message_expiration: 24 * 3600,
  push: {
    subscribers: [
      {
        name: 'subscriber_name',
        url: 'http://rest-test.iron.io/code/200?store=key1',
        headers: {
          'Content-Type' => 'application/json'
        }
      }
    ],
    retries: 3,
    retries_delay: 30,
    error_queue: 'error_queue_name'
  }
}

ironmq.create_queue(options)

Options:

type: String or symbol. Queue type. :pull, :multicast, :unicast. Field required and static.
message_timeout: Integer. Number of seconds before message back to queue if it will not be deleted or touched.
message_expiration: Integer. Number of seconds between message post to queue and before message will be expired.

Push queues only:

push: subscribers: An array of subscriber hashes containing a name and a url required fields, and optional headers hash. headers's keys are names and values are means of HTTP headers. This set of subscribers will replace the existing subscribers. To add or remove subscribers, see the add subscribers endpoint or the remove subscribers endpoint. See below for example json.
push: retries: How many times to retry on failure. Default is 3. Maximum is 100.
push: retries_delay: Delay between each retry in seconds. Default is 60.
push: error_queue: String. Queue name to post push errors to.

Add subscribers to a push queue

subscribers = [
    {
        name: 'first',
        url: 'http://first.endpoint.xx/process',
        headers: {
            Content-Type: 'application/json'
        }
    },
    {
        name: 'second',
        url: 'http://second.endpoint.xx/process',
    }
]
queue.add_subscribers(subscribers)

Replace subscribers on a push queue

Sets list of subscribers to a queue. Older subscribers will be removed.

subscribers = [
    {
        name: 'the_only',
        url: 'http://my.over9k.host.com/push'
    }
]
queue.replace_subscribers(subscribers);

Remove subscribers by a name from a push queue

subscribers = [
    {
        name: 'the_only'
    }
]
queue.remove_subscribers(subscribers)

Retrieve Queue Information

info = queue.info
# => {"id"=>"5127bf043264140e863e2283", "name"=>"my_queue", ...}

Shortcuts for queue.info[key]:

id = queue.id # => "5127bf043264140e863e2283"

size = queue.size # => 7
name = queue.name # => "my_queue"
overall_messages = queue.total_messages # => 13
subscribers = queue.subscribers
# => [{"url" => "http://..."}, ...]

push_type = queue.push_type # => "multicast"
# Does queue Push Queue? Alias for `queue.push_type.nil?`
is_push_queue = queue.push_queue? # => true

Warning: to be sure configuration information is up-to-date client library call IronMQ API each time you request for any parameter except queue.name. In this case you may prefer to use queue.info to have Hash with all available info parameters.

Delete a Message Queue

response = queue.delete # => #<IronMQ::ResponseBase:...>

Post Messages to a Queue

Single message:

response = queue.post('something helpful') # => #<IronMQ::ResponseBase:...>
# or
response = queue.post('with parameteres', timeout: 300)
# => #<IronMQ::ResponseBase:...>

message_id = response.id # => "5847899158098068288"
status_message = response.msg # => "Messages put on queue."
http_code = response.code # => 200

Multiple messages:

# [{body: VALUE}, ...] format is required
messages = [{body: 'first'}, {body: 'second'}]

response = queue.post(messages)
# => {"ids" => ["5847899158098068288", ...], "msg" => "Messages put on queue."}
# or
response = queue.post(messages, timeout: 300)
# => {"ids" => ["5847899158098068288", ...], "msg" => "Messages put on queue."}

Optional parameters:

delay: The item will not be available on the queue until this many seconds have passed. Default is 0 seconds. Maximum is 604,800 seconds (7 days).

Get Messages from a Queue

message = queue.reserve # => #<IronMQ::Message:...>

# or N messages
messages = queue.reserve(n: 7) # => [#<IronMQ::Message:...>, ...]

# or message by ID
message = queue.get_message '5127bf043264140e863e2283'
# => #<IronMQ::Message:...>

Optional parameters:

n: The maximum number of messages to get. Default is 1. Maximum is 100.
timeout: After timeout (in seconds), item will be placed back onto queue. You must delete the message from the queue to ensure it does not go back onto the queue. If not set, value from POST is used. Default is 60 seconds. Minimum is 30 seconds. Maximum is 86,400 seconds (24 hours).
wait: : Time in seconds to wait for a message to become available. This enables long polling. Default is 0 (does not wait), maximum is 30.
delete: true/false. This will delete the message on get. Be careful though, only use this if you are ok with losing a message if something goes wrong after you get it. Default is false.

When n parameter is specified and greater than 1 method returns Array of Messages. Otherwise, Message object would be returned.

Touch a Message on a Queue

Touching a reserved message extends its timeout by the duration specified when the message was created, which is 60 seconds by default.

message = queue.reserve # => #<IronMQ::Message:...>

message.touch # => #<IronMQ::ResponseBase:...>

Release Message

message = queue.reserve # => #<IronMQ::Message:...>

response = message.release # => #<IronMQ::ResponseBase:...>
# or
response = message.release(delay: 42) # => #<IronMQ::ResponseBase:...>

Optional parameters:

delay: The item will not be available on the queue until this many seconds have passed. Default is 0 seconds. Maximum is 604,800 seconds (7 days).

Delete a Message from a Queue

message = queue.reserve # => #<IronMQ::Queue:...>

message.delete # => #<IronMQ::ResponseBase:...>

Peek Messages from a Queue

Peeking at a queue returns the next messages on the queue, but it does not reserve them.

message = queue.peek # => #<IronMQ::Message:...>
# or multiple messages
messages = queue.peek(n: 13)
# => [#<IronMQ::Message:...>, ...]

Optional parameters:

n: The maximum number of messages to peek. Default is 1. Maximum is 100.

Poll for Messages

queue.poll { |msg| puts msg.body }

Polling will automatically delete the message at the end of the block.

Clear a Queue

queue.clear # => #<IronMQ::ResponseBase:...>

Add an Alert to a Queue

Check out our Blog Post on Queue Alerts.

Alerts have now been incorporated into IronMQ. This feature lets developers control actions based on the activity within a queue. With alerts, actions can be triggered when the number of messages in a queue reach a certain threshold. These actions can include things like auto-scaling, failure detection, load-monitoring, and system health.

You may add up to 5 alerts per queue.

Required parameters:

type: required - "fixed" or "progressive". In case of alert's type set to "fixed", alert will be triggered when queue size pass value set by trigger parameter. When type set to "progressive", alert will be triggered when queue size pass any of values, calculated by trigger * N where N >= 1. For example, if trigger set to 10, alert will be triggered at queue sizes 10, 20, 30, etc.
direction: required - "asc" or "desc". Set direction in which queue size must be changed when pass trigger value. If direction set to "asc" queue size must growing to trigger alert. When direction is "desc" queue size must decreasing to trigger alert.
trigger: required. It will be used to calculate actual values of queue size when alert must be triggered. See type field description. Trigger must be integer value greater than 0.
queue: required. Name of queue which will be used to post alert messages.

Optional parameters:

snooze: Number of seconds between alerts. If alert must be triggered but snooze is still active, alert will be omitted. Snooze must be integer value greater than or equal to 0.

queue.add_alert({
                  type: 'progressive',
                  trigger: 10,
                  queue: 'my_alert_queue',
                  direction: 'asc',
                  snooze: 0
                })
queue.clear
# => #<IronMQ::ResponseBase:0x007f95d3b25438 @raw={"msg"=>"Updated"}, @code=200>

Push Queues

IronMQ push queues allow you to setup a queue that will push to an endpoint, rather than having to poll the endpoint. Here's the announcement for an overview.

Update a Message Queue

options = {
  message_timeout: 120,
  message_expiration: 24 * 3600,
  push: {
    subscribers: [
      {
        name: 'subscriber_name',
        url: 'http://rest-test.iron.io/code/200?store=key1',
        headers: {
          'Content-Type' => 'application/json'
        }
      }
    ],
    retries: 3,
    retries_delay: 30,
    error_queue: 'error_queue_name'
  }
}

queue.update(options)

The following parameters are all related to Push Queues:

push: subscribers: An array of subscriber hashes containing a name and a url required fields, and optional headers hash. headers's keys are names and values are means of HTTP headers. This set of subscribers will replace the existing subscribers. To add or remove subscribers, see the add subscribers endpoint or the remove subscribers endpoint. See below for example json.
push: retries: How many times to retry on failure. Default is 3. Maximum is 100.
push: retries_delay: Delay between each retry in seconds. Default is 60.
push: error_queue: String. Queue name to post push errors to.

Note: queue type cannot be changed.

Set Subscribers on a Queue

Subscribers can be any HTTP endpoint. push type is one of:

multicast: will push to all endpoints/subscribers
unicast: will push to one and only one endpoint/subscriber

ironmq = IronMQ::Client.new
subscribers =
  [
   {
     name: 'key-one-sub',
     url: 'http://rest-test.iron.io/code/200?store=key1'
   },
   {
     name: 'key-two-sub',
     url: 'http://rest-test.iron.io/code/200?store=key2'
   }
  ]
ironmq.create_queue('queue_name', type: :multicast,
                    push: {subscribers: subscribers})

Add/Remove Subscribers on a Queue

queue.add_subscriber({
                       name: 'nowhere',
                       url: 'http://nowhere.com/push'
                     })

queue.add_subscribers([
                       {
                         name: 'first',
                         url: 'http://first.endpoint.xx/process',
                         headers: {
                           'Content-Type': 'application/json'
                         }
                       },
                       {
                         name: 'second',
                         url: 'http://second.endpoint.xx/process'
                       }
                      ])

queue.clear_subscribers

Post and instantiate

Sometimes you may want to post message to the Push Queue and instantiate Message instead getting it by ID returned in API response. To do this just set :instantiate to true.

message = queue.post('push me!', instantiate: true)
# => #<IronMQ::Message:...>

msgs = queue.post([{body: 'push'}, {body: 'me'}], instantiate: true)
# => [#<IronMQ::Message:...>, ...]

This creates fake Message objects. They contain only IDs.

Get Message Push Status

After pushing a message:

statuses = queue.get_message(msg.id).push_statuses
# => [#<IronMQ::Subscriber:...>, ...]

statuses.each do |s|
  puts "#{s.subscriber_name}: #{(s.code == 200) ? 'Success' : 'Fail'}"
end

Returns an array of subscribers with status.

Note: getting a message by ID is only for usable for Push Queues. This creates fake IronMQ::Message instance on which you call for subscribers' push statuses.

Acknowledge / Delete Message Push Status

subscribers = queue.get_message(msg.id).subscribers
# => [#<IronMQ::Subscriber:...>, ...]

subscribers.each do |ss|
  ss.delete
  # ss.acknowledge # This is `delete`'s alias
end

Queue Alerts

Queue Alerts allow you to set queue's size levels which are critical for your application. For example, you want to start processing worker when queue size grows from 0 to 1. Then add alert of type "fixed", direction "asc", and trigger 1. In this case, if queue size changed from 0 to 1 alert message will be put on queue, set by queue parameter of alert's hash. If you want to prevent alerts to be put onto alert queue in some time after previous alert message - use snooze parameter. For example, to make alert silent in one hour, set snooze to 3600 (seconds).

Note: alerts feature are only avalable for Pull (or regular) Queues.

See Queue Alerts to learn more.

Alerts Parameters

Alerts can be configured with the following parameters:

type: string, required. Type of alert. Available types are "fixed" and "progressive".
direction: string, optional. Direction of queue fluctuations. Available directions are "asc" (alert will be triggered if queue size grows) and "desc" (alert will be triggered if queue size decreases). Defaults to "asc".
trigger: integer, required. Value which is used to calculate actual queue size when alert will be triggered. In case of "fixed" type of alert trigger itself represents actual queue size. When type of alert is "progressive", actual queue sizes are calculated by trigger * N, where N is integer greater than 0. For example, type is "progressive" and trigger is 100. Alert messages will be put on queue at sizes 100, 200, 300, ...
queue: string, required. Name of a queue which receives alert messages.
snooze: integer, optional. Represents number of seconds alert will be silent after latter message, put onto alert queue.

Note: IronMQ backend checks for alerts duplications each time you add new alerts to a queue. It compares type, direction, and trigger parameters to find duplicates. If one or more of new alerts duplicates existing, backend return HTTP 400 error, message will be {"msg": "At least one new alert duplicates current queue alerts."}.

Add Alerts to a Queue

To add single alert to a queue.

queue.add_alert({
                  type: 'fixed',
                  direction: 'asc',
                  trigger: 1,
                  queue: 'alerts-queue',
                  snooze: 600
                })
# => #<IronMQ::ResponseBase:0x007f8d22980420 @raw={"msg"=>"Alerts were added."}, @code=200>

To add multiple alerts at a time.

queue.add_alerts([
                  {
                    type: 'fixed',
                    direction: 'desc',
                    trigger: 1,
                    queue: 'alerts-queue'
                  },
                  {
                    type: 'progressive',
                    trigger: 1000,
                    queue: 'critical-alerts-queue'
                  }
                 ])
# => #<IronMQ::ResponseBase:0x00abcdf1980420 @raw={"msg"=>"Alerts were added."}, @code=200>

Remove Alerts from a Queue

To remove single alert by its ID.

queue.remove_alert({ id: '5eee546df4a4140e8638a7e5' })
# => #<IronMQ::ResponseBase:0x007f8d229a1878 @raw={"msg"=>"Alerts were deleted."}, @code=200>

Remove multiple alerts by IDs.

queue.remove_alerts([
  { id: '53060b541185ab3eaf04c83f' },
  { id: '99a50b541185ab3eaf9bcfff' }
])
# => #<IronMQ::ResponseBase:0x093b8d229a18af @raw={"msg"=>"Alerts were deleted."}, @code=200>

Replace and Clear Alerts on a Queue

Following code sample shows how to replace alerts on a queue.

queue.replace_alerts([
                      {
                        type: 'fixed',
                        trigger: 100,
                        queue: 'alerts'
                      }
                     ])
# => #<IronMQ::ResponseBase:0x00008d229a16bf @raw={"msg"=>"Alerts were replaced."}, @code=200>

To clear alerts on a queue.

queue.clear_alerts
# => #<IronMQ::ResponseBase:0x87ad13ff3a18af @raw={"msg"=>"Alerts were replaced."}, @code=200>

Note: Queue#clear_alerts is a helper, which represents Queue#replace_alerts call with empty Array of alerts.

Important Notes

Ruby 1.8 is no more supported.
Queue type is static now. Once it is set, it cannot be changed.

IronMQ Ruby Client

Getting Started

Keystone Authentication

Via Configuration File

In Code

The Basics

Get Queues List

Get a Queue Object

Post a Message on a Queue

Retrieve Queue Information

Reserve/Get a Message from a Queue

Delete a Message from a Queue

Client

List Queues

Get Queue by Name

Queues

Create a Queue

Add subscribers to a push queue

Replace subscribers on a push queue

Remove subscribers by a name from a push queue

Retrieve Queue Information

Delete a Message Queue

Post Messages to a Queue

Get Messages from a Queue

Touch a Message on a Queue

Release Message

Delete a Message from a Queue

Peek Messages from a Queue

Poll for Messages

Clear a Queue

Add an Alert to a Queue

Push Queues

Update a Message Queue

Set Subscribers on a Queue

Add/Remove Subscribers on a Queue

Post and instantiate

Get Message Push Status

Acknowledge / Delete Message Push Status

Queue Alerts

Alerts Parameters

Add Alerts to a Queue

Remove Alerts from a Queue

Replace and Clear Alerts on a Queue

Important Notes

Further Links