iron_mq 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce00af7c17301f12971aae72083ba984718c11be
-  data.tar.gz: 42965aeda2d296af77c3125a663132c7beb0a450
+  metadata.gz: ae70cddc4f116d5a8d516a5eed1cd722f221df59
+  data.tar.gz: ba911a0556103b6fa9c4b5407b59fd6966b92661
 SHA512:
-  metadata.gz: 0f40c8007eba47c0982c091e9857b79ff2be1c112416a0094196601e3744be3516680a9f67f9c2f8ebb543d09a84418e20f5e12d1960c424d612a5413fcb0028
-  data.tar.gz: 162e8e411c13837561c0c8bc1e3a5bd874ccd5df8110e1ae0b832994df27560217192d3d1c8c2fc03fb295f23ca2ba344646e73bd77ebb86ea4e6c014f55d8f9
+  metadata.gz: 8e07437588ae4af6e20c4816d23db5a88aed43e39311c329a3871751c96147628bf984044d333f270c5b55a8e67af17922fc7bf5694550198cae89fd5f3fea19
+  data.tar.gz: c4a9adda56a141bcad44756ae830310503410019725aa5590d1b36f9aa9449b21ed0ed03db725ad83e8842ba3360c5e6d1d9de3d96aa2b883f150a4335765c7a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    iron_mq (4.0.0)
+    iron_mq (4.0.1)
       iron_core (>= 0.5.1)
 
 GEM
@@ -13,7 +13,7 @@ GEM
       ffi (~> 1.2.0)
       mime-types (~> 1.18)
     ffi (1.2.1)
-    iron_core (0.5.1)
+    iron_core (0.5.2)
       rest (>= 2.2.0)
     mime-types (1.21)
     minitest (4.6.2)

data/README.md

@@ -4,9 +4,8 @@ IronMQ Ruby Client
 The [full API documentation is here](http://dev.iron.io/mq/reference/api/) 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.
 
-http://dev.iron.io/mq/reference/api/
 
-#Getting Started
+## Getting Started
 
 1\. Install the gem:
 
@@ -14,7 +13,7 @@ http://dev.iron.io/mq/reference/api/
 gem install iron_mq
 ```
 
-2\. Setup your Iron.io credentials: http://dev.iron.io/mq/reference/configuration/
+2\. [Setup your Iron.io credentials](http://dev.iron.io/mq/reference/configuration/)
 
 3\. Create an IronMQ client object:
 
@@ -28,9 +27,18 @@ Or pass in credentials:
 ironmq = IronMQ::Client.new(:token => "MY_TOKEN", :project_id => "MY_PROJECT_ID")
 ```
 
-#The Basics
 
-###Get a Queue Object
+## The Basics
+
+### Get Queues List
+
+```ruby
+list_queues = ironmq.queues # => [#<IronMQ::Queue:...>, ...]
+```
+
+--
+
+### Get a Queue Object
 
 You can have as many queues as you want, each with their own unique set of messages.
 
@@ -40,6 +48,8 @@ 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.
@@ -49,6 +59,8 @@ If a queue does not exist, it will be created upon the first posting of a messag
 queue.post("hello world!")
 ```
 
+--
+
 ### Retrieve Queue Information
 
 ```ruby
@@ -56,6 +68,8 @@ queue.info # => {"id"=>"5127bf043264140e863e2283", "name"=>"my_queue", ...}
 queue.id   # => "5127bf043264140e863e2283"
 ```
 
+--
+
 ### Get a Message off a Queue
 
 ```ruby
@@ -67,6 +81,8 @@ When you pop/get a message from the queue, it is no longer on the queue but it s
 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
 
 ```ruby
@@ -77,10 +93,12 @@ queue.delete(msg.id)
 
 Be sure to delete a message from the queue when you're done with it.
 
+--
+
 
-#Client
+## Client
 
-`IronMQ::Client` is based on `IronCore::Client` and provides easy access to the queues and messages.
+`IronMQ::Client` is based on `IronCore::Client` and provides easy access to the queues.
 
 ```ruby
 ironmq = IronMQ::Client.new(:token => "MY_TOKEN", :project_id => "MY_PROJECT_ID")
@@ -103,6 +121,8 @@ all_queues = ironmq.queues.all  # => [#<IronMQ::Queue:...>, ...]
 queues = ironmq.queues.all(:page => 1, :per_page => 10)
 ```
 
+--
+
 ### Get Queue by Name
 
 ```ruby
@@ -112,7 +132,9 @@ 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
+--
+
+## Queues
 
 ### Retrieve Queue Information
 
@@ -141,12 +163,16 @@ is_push_queue = queue.push_queue? # => true
 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
 
 ```ruby
 response = queue.delete_queue # => #<IronMQ::ResponseBase:...>
 ```
 
+--
+
 ### Post Messages to a Queue
 
 **Single message:**
@@ -183,6 +209,8 @@ Default is 0 seconds. Maximum is 604,800 seconds (7 days).
 * `expires_in`: How long in seconds to keep the item on the queue before it is deleted.
 Default is 604,800 seconds (7 days). Maximum is 2,592,000 seconds (30 days).
 
+--
+
 ### Get Messages from a Queue
 
 ```ruby
@@ -199,7 +227,7 @@ message = queue.get "5127bf043264140e863e2283" # => #<IronMQ::Message:...>
 
 * `n`: The maximum number of messages to get. Default is 1. Maximum is 100.
 
-* `timeout`: timeout: After timeout (in seconds), item will be placed back onto queue.
+* `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).
@@ -207,6 +235,8 @@ Maximum is 86,400 seconds (24 hours).
 When `n` parameter is specified and greater than 1 method returns `Array` of `Queue`s.
 Otherwise, `Queue` 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.
@@ -217,10 +247,12 @@ message = queue.get # => #<IronMQ::Message:...>
 message.touch # => #<IronMQ::ResponseBase:...>
 ```
 
+--
+
 ### Release Message
 
 ```ruby
-message = queue.get => #<IronMQ::Message:...>
+message = queue.get # => #<IronMQ::Message:...>
 
 response = message.release # => #<IronMQ::ResponseBase:...>
 # or
@@ -232,16 +264,18 @@ response = message.release(:delay => 42) # => #<IronMQ::ResponseBase:...>
 * `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
 
 ```ruby
 message = queue.get # => #<IronMQ::Queue:...>
 
 message.delete # => #<IronMQ::ResponseBase:...>
-# or
-queue.delete_message(message.id) # => #<IronMQ::ResponseBase:...>
 ```
 
+--
+
 ### Peek Messages from a Queue
 
 Peeking at a queue returns the next messages on the queue, but it does not reserve them.
@@ -256,6 +290,8 @@ messages = queue.peek(:n => 13) # => [#<IronMQ::Message:...>, ...]
 
 * `n`: The maximum number of messages to peek. Default is 1. Maximum is 100.
 
+--
+
 ### Poll for Messages
 
 ```ruby
@@ -264,13 +300,18 @@ queue.poll { |msg| puts msg.body }
 
 Polling will automatically delete the message at the end of the block.
 
+--
+
 ### Clear a Queue
 
 ```ruby
 queue.clear # => #<IronMQ::ResponseBase:...>
 ```
 
-#Push Queues
+--
+
+
+## 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](http://blog.iron.io/2013/01/ironmq-push-queues-reliable-message.html). 
@@ -291,6 +332,8 @@ See below for example json.
 * `retries`: How many times to retry on failure. Default is 3.
 * `retries_delay`: Delay between each retry in seconds. Default is 60.
 
+--
+
 ### Set Subscribers on a Queue
 
 Subscribers can be any HTTP endpoint. `push_type` is one of:
@@ -301,43 +344,90 @@ Subscribers can be any HTTP endpoint. `push_type` is one of:
 ```ruby
 ptype = :multicast
 subscribers = [
-  {url: "http://rest-test.iron.io/code/200?store=key1"}
-  {url: "http://rest-test.iron.io/code/200?store=key2"}
+  {:url => "http://rest-test.iron.io/code/200?store=key1"}
+  {:url => "http://rest-test.iron.io/code/200?store=key2"}
 ]
 
 queue.update(:subscribers => subscribers, :push_type => ptype)
 ```
 
+--
+
 ### Add/Remove Subscribers on a Queue
 
 ```ruby
-queue.add_subscriber({url: "http://nowhere.com"})
+queue.add_subscriber({:url => "http://nowhere.com"})
+
+queue.add_subscribers([
+  {:url => 'http://first.endpoint.xx/process'},
+  {:url => 'http://second.endpoint.xx/process'}
+])
+
 
 queue.remove_subscriber({url: "http://nowhere.com"})
+
+queue.remove_subscribers([
+  {:url => 'http://first.endpoint.xx/process'},
+  {:url => 'http://second.endpoint.xx/process'}
+])
 ```
 
+--
+
+### 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`.
+
+```ruby
+message = queue.post('push me!', :instantiate => true) # => #<IronMQ::Message:...>
+
+msgs = queue([{: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:
 
 ```ruby
 subscribers = queue.get(msg.id).subscribers # => [#<IronMQ::Subscriber:...>, ...]
-# old syntax, still supported
-subscribers = queue.messages.get(msg.id).subscribers # => [#<IronMQ::Subscriber:...>, ...]
 
 subscribers.each { |ss| puts "#{ss.id}: #{(ss.code == 200) ? 'Success' : 'Fail'}" }
 ```
 
 Returns an array of subscribers with status.
 
-### Delete Message Push 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
 
 ```ruby
 subscribers = queue.get(msg.id).subscribers # => [#<IronMQ::Subscriber:...>, ...]
 
-subscribers.each { |ss| ss.delete }
+subscribers.each do |ss|
+  ss.delete
+  # ss.acknowledge # This is `delete` alias
+end
 ```
 
+--
+
+
+## Further Links
+
+* [IronMQ Overview](http://dev.iron.io/mq/)
+* [IronMQ REST/HTTP API](http://dev.iron.io/mq/reference/api/)
+* [Push Queues](http://dev.iron.io/mq/reference/push_queues/)
+* [Other Client Libraries](http://dev.iron.io/mq/libraries/)
+* [Live Chat, Support & Fun](http://get.iron.io/chat)
 
 -------------
 © 2011 - 2013 Iron.io Inc. All Rights Reserved.

data/lib/iron_mq.rb

@@ -1,5 +1,5 @@
-require 'iron_mq/response'
-require 'iron_mq/queues'
-require 'iron_mq/messages'
-require 'iron_mq/client'
-require 'iron_mq/version'
+require File.expand_path('iron_mq/response', File.dirname(__FILE__))
+require File.expand_path('iron_mq/queues', File.dirname(__FILE__))
+require File.expand_path('iron_mq/messages', File.dirname(__FILE__))
+require File.expand_path('iron_mq/client', File.dirname(__FILE__))
+require File.expand_path('iron_mq/version', File.dirname(__FILE__))

data/lib/iron_mq/client.rb

@@ -1,7 +1,6 @@
 require 'yaml'
 
 require 'iron_core'
-require 'iron_mq/queues'
 
 module IronMQ
 

data/lib/iron_mq/messages.rb

@@ -28,7 +28,15 @@ module IronMQ
     end
 
     def delete
-      call_api_and_parse_response(:delete)
+      begin
+        call_api_and_parse_response(:delete)
+      rescue Rest::HttpError => ex
+        if ex.code == 404
+          Rest.logger.info("Delete got 404, safe to ignore.")
+        else
+          raise ex
+        end
+      end
     end
 
     def call_api_and_parse_response(meth, ext_path = "", options = {}, instantiate = true)

data/lib/iron_mq/queues.rb

@@ -1,5 +1,4 @@
 require 'cgi'
-require 'iron_mq/subscribers'
 
 module IronMQ
 
@@ -13,7 +12,7 @@ module IronMQ
     end
 
     def info
-      info  = raw
+      info = raw
       begin
         # Do not instantiate response
         info = call_api_and_parse_response(:get, '', {}, false)
@@ -90,6 +89,9 @@ module IronMQ
     def post_messages(payload, options = {})
       batch = false
 
+      instantiate = [options.delete(:instantiate),
+                     options.delete('instantiate')].compact.first
+
       msgs = if payload.is_a?(Array)
                batch = true
                # FIXME: This maybe better to process Array of Objects the same way as for single message.
@@ -109,15 +111,22 @@ module IronMQ
       # Do not instantiate response
       res = call_api_and_parse_response(:post, "/messages", {:messages => msgs}, false)
 
-      if batch
-        # FIXME: Return Array of ResponsBase instead, it seems more clear than raw response
-        #
-        #          res["ids"].each_with_object([]) do |id, responses|
-        #            responses << ResponseBase.new({"id" => id, "msg" => res["msg"]})
-        #          end
-        ResponseBase.new(res) # Backward capable
+      if instantiate
+        n = batch ? 2 : 1
+        msg_ids = res["ids"].map { |id| {'id' => id} }
+
+        process_messages(msg_ids, {:n => n})
       else
-        ResponseBase.new({"id" => res["ids"][0], "msg" => res["msg"]})
+        if batch
+          # FIXME: Return Array of ResponsBase instead, it seems more clear than raw response
+          #
+          #          res["ids"].each_with_object([]) do |id, responses|
+          #            responses << ResponseBase.new({"id" => id, "msg" => res["msg"]})
+          #          end
+          ResponseBase.new(res) # Backward capable
+        else
+          ResponseBase.new({"id" => res["ids"][0], "msg" => res["msg"]})
+        end
       end
     end
 

data/lib/iron_mq/subscribers.rb

@@ -15,6 +15,8 @@ module IronMQ
       @message.call_api_and_parse_response(:delete, path)
     end
 
+    alias_method :acknowledge, :delete
+
     private
 
     def path

data/lib/iron_mq/version.rb

@@ -1,4 +1,4 @@
 module IronMQ
-  VERSION = "4.0.0"
+  VERSION = "4.0.1"
 end
 

data/test/test_base.rb

@@ -11,7 +11,7 @@ unless Hash.instance_methods.include?(:default_proc=)
 end
 
 begin
-  require File.join(File.dirname(__FILE__), '../lib/iron_mq')
+  require File.expand_path('../lib/iron_mq', File.dirname(__FILE__))
 rescue Exception => ex
   puts "Could NOT load current iron_mq: " + ex.message
   raise ex

data/test/test_beanstalkd.rb

@@ -19,7 +19,7 @@ class BeanstalkTests < TestBase
   end
 
   def test_basics
-    omit_if @skip # bypass this test if rackspace
+    return if @skip # bypass this test if rackspace
     puts 'test_basics3'
 
     queue_name = "beanstalk_test"
@@ -60,7 +60,7 @@ class BeanstalkTests < TestBase
   end
 
   def clear_tube(tube)
-    omit_if @skip # bypass this test if rackspace
+    return if @skip # bypass this test if rackspace
     watched = @beanstalk.list_tubes_watched(true)
     puts 'watched: ' + watched.inspect
     @beanstalk.watch(tube)
@@ -75,7 +75,7 @@ class BeanstalkTests < TestBase
   end
 
   def test_basics2
-    omit_if @skip # bypass this test if rackspace
+    return if @skip # bypass this test if rackspace
     puts 'test_basics'
     msg = "hello #{Time.now}"
     @beanstalk.put(msg)
@@ -110,7 +110,7 @@ class BeanstalkTests < TestBase
   end
 
   def test_timeout
-    omit_if @skip # bypass this test if rackspace
+    return if @skip # bypass this test if rackspace
     puts 'test_timeout'
     msg = "timeout message #{Time.now}"
     # timeout of 10 seconds
@@ -137,7 +137,7 @@ class BeanstalkTests < TestBase
   end
 
   def test_delay
-    omit_if @skip # bypass this test if rackspace
+    return if @skip # bypass this test if rackspace
     puts 'test_delay'
     msg = "delayed message #{Time.now}"
     # delay of 2 seconds
@@ -160,12 +160,12 @@ class BeanstalkTests < TestBase
   end
 
   def tube_message(tube)
-    omit_if @skip # bypass this test if rackspace
+    return if @skip # bypass this test if rackspace
     "hello #{tube}! #{Time.now}"
   end
 
   def reserve(timeout=nil)
-    omit_if @skip # bypass this test if rackspace
+    return if @skip # bypass this test if rackspace
     begin
       job = @beanstalk.reserve(timeout)
       LOG.info 'got job: ' + job.inspect
@@ -177,7 +177,7 @@ class BeanstalkTests < TestBase
   end
 
   def test_tubes
-    omit_if @skip # bypass this test if rackspace
+    return if @skip # bypass this test if rackspace
     clear_tube('youtube')
     tube1 = 'default'
     msg1 = tube_message(tube1)

data/test/test_iron_mq.rb

@@ -5,7 +5,6 @@ require File.expand_path('test_base.rb', File.dirname(__FILE__))
 class IronMQTests < TestBase
   def setup
     super
-    @skip = @host.include? 'rackspace'
     LOG.info "@host: #{@host}"
 
     queues = @client.queues.list
@@ -125,10 +124,12 @@ class IronMQTests < TestBase
     # p res
 
     res = @client.queues.list
+    assert res.size > 0, "project must contain at least one queue"
+
     res.each do |q|
-      puts "#{q.name} and #{queue_name}";
+      # puts "#{q.name} and #{queue_name}"
       if q.name == queue_name
-        assert_equal q.size, 1 
+        assert_equal q.size, 1
       end
     end
 
@@ -613,8 +614,6 @@ class IronMQTests < TestBase
   end
 
   def test_webhooks
-    omit_if @skip
-    puts "skip webhooks: #{@skip}"
     qname ="webhook_queue"
     url = "#{@client.base_url}/#{qname}/messages/webhook?oauth=#{@client.token}"
     # p url

data/test/test_push_queues.rb

@@ -6,8 +6,6 @@ class TestPushQueues < TestBase
 
   def setup
     super
-    @skip = @host.include? 'rackspace'
-    return if @skip # bypass these tests if rackspace
   end
 
   def make_key(i, t, random=0)
@@ -16,7 +14,6 @@ class TestPushQueues < TestBase
 
 
   def test_queue_subscriptions
-    omit_if @skip
     types = ["multicast", "unicast"]
     # to delete queues later (clear project)
     queue_names = []
@@ -153,7 +150,6 @@ class TestPushQueues < TestBase
 
 
   def test_failure
-    omit_if @skip
     @rest = Rest::Client.new
     qname = "failure-queue"
 
@@ -214,11 +210,19 @@ class TestPushQueues < TestBase
       subscribers.each do |s|
         LOG.debug s
         if s["url"] == "http://rest-test.iron.io/code/503"
-          do_retry = true unless 503 == s["status_code"]
-          do_retry = true unless "error" == s["status"]
+          if "error" == s["status"]
+            assert_equal 0, s["retries_remaining"]
+          else
+            assert_equal 503, s["status_code"]
+            do_retry = true
+          end
         else
-          do_retry = true unless 200 == s["status_code"]
-          do_retry = true unless "deleted" == s["status"]
+          LOG.info "retries_remaining: #{s["retries_remaining"]}"
+          if ["deleted", "error"].include? s["status"] || 200 == s["status_code"]
+            assert_equal 0, s["retries_remaining"]
+          else
+            do_retry = true
+          end
         end
       end
       next if do_retry
@@ -233,7 +237,6 @@ class TestPushQueues < TestBase
 
 
   def test_202
-    omit_if @skip
     types = ["multicast"]
     types.each do |t|
 
@@ -340,8 +343,37 @@ class TestPushQueues < TestBase
   end
 
 
-  def test_202_failure
-    omit_if @skip
+  def test_post_and_instantiate
+    queue = @client.queue('push_and_instantiate')
+
+    subscribers = [{:url => "http://rest-test.iron.io/code/200"},
+                   {:url => "http://rest-test.iron.io/code/200"}]
+
+    res = queue.update_queue(:subscribers => subscribers,
+                             :push_type => 'multicast')
+
+    expected_size = subscribers.size
+    got_size = queue.subscribers.size
+    assert_equal expected_size, got_size, "queue's subscribers list must contain #{expected_size} elements, but got #{got_size}"
+
+    msgs = queue.post([{:body => 'push'},
+                       {:body => 'me'},
+                       {:body => 'now'}], :instantiate => true)
+    msgs.each { |msg| assert_instance_of(IronMQ::Message, msg, "post(:instantiate => true) must instantiate messages") }
+
+    sleep 5
+
+    msgs.each do |msg|
+      subscr_arr = msg.subscribers
+      subscr_arr.each do |s|
+        assert_instance_of(IronMQ::Subscriber, s, "message must return `Subscriber`, but got `#{s.class}`")
+        rsp = s.delete
+        assert_equal 200, rsp.code, "API must response with HTTP 200 status, but returned HTTP #{rsp.code}"
+      end
+    end
+
+    resp = queue.delete_queue
+    assert_equal 200, resp.code, "API must response with HTTP 200 status, but returned HTTP #{resp.code}"
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iron_mq
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Yury Yantsevich
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iron_core