iron_mq 2.1.3 → 3.0.0

data/Gemfile.lock

@@ -1,35 +1,33 @@
 PATH
   remote: .
   specs:
-    iron_mq (2.1.2)
-      iron_core (>= 0.4.2)
+    iron_mq (2.1.3)
+      iron_core (>= 0.4.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
     beanstalk-client (1.1.1)
-    concur (1.0.0)
-      faraday
-      faraday
-    faraday (0.8.4)
-      multipart-post (~> 1.1)
-    ffi (1.1.5)
-    iron_core (0.4.2)
-      rest (>= 2.0.2)
+    concur (1.0.2)
+    ethon (0.5.3)
+      ffi (~> 1.0.11)
+      mime-types (~> 1.18)
+    ffi (1.0.11)
+    iron_core (0.4.4)
+      rest (>= 2.1.1)
     mime-types (1.19)
-    multipart-post (1.1.5)
-    net-http-persistent (2.7)
-    rake (0.9.2.2)
-    rest (2.0.2)
+    minitest (4.2.0)
+    net-http-persistent (2.8)
+    rake (10.0.0)
+    rest (2.1.1)
       net-http-persistent
       rest-client (>= 0.3.0)
     rest-client (1.6.7)
       mime-types (>= 1.16)
-    test-unit (2.5.1)
-    typhoeus (0.4.2)
-      ffi (~> 1.0)
-      mime-types (~> 1.18)
-    uber_config (0.0.6)
+    test-unit (2.5.2)
+    typhoeus (0.5.1)
+      ethon (= 0.5.3)
+    uber_config (1.0.5)
 
 PLATFORMS
   ruby
@@ -38,6 +36,7 @@ DEPENDENCIES
   beanstalk-client
   concur
   iron_mq!
+  minitest
   net-http-persistent
   rake
   test-unit

data/README.md

@@ -1,6 +1,11 @@
 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
 ==============
 
@@ -26,29 +31,39 @@ You can have as many queues as you want, each with their own unique set of messa
 
 Now you can use it:
 
-**Push** a message on the queue:
+### Post a message on the queue:
 
     @queue.post("hello world!")
 
-**Pop** a message off the queue:
+Post a message with options:
+
+    @queue.post("hello world!", delay: 3600)
+
+### Get a message off the queue:
 
     msg = @queue.get()
     puts msg.body
 
-**Poll** for messages:
+Get a message with options:
 
-    @queue.poll do |msg|
-      puts msg.body
-    end
+    msg = @queue.get(timeout: 300)
 
 When you pop/get a message from the queue, it will NOT be deleted. It will eventually go back onto the queue after
-a timeout if you don't delete it (default timeout is 10 minutes).
+a timeout if you don't delete it (default timeout is 60 seconds).
 
-**Delete** a message from the queue:
+### Delete a message from the queue:
 
     msg.delete # or @queue.delete(msg.id)
 
-Delete a message from the queue when you're done with it.
+Be sure to delete a message from the queue when you're done with it.
+
+### Poll for messages:
+
+    @queue.poll do |msg|
+      puts msg.body
+    end
+
+Polling will automatically delete the message at the end of the block.
 
 Queue Information
 =================
@@ -56,3 +71,44 @@ Queue Information
     queue = @client.queue("my_queue")
     puts "size: #{queue.size}"
 
+
+Push Queues
+===========
+
+IronMQ push queues allow you to setup a queue that will push to an endpoint, rather than having to poll the endpoint.
+
+LINK TO BLOG POST
+
+### 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
+
+
+```ruby
+subscribers = []
+subscribers << {url: "http://rest-test.iron.io/code/200?store=key1"}
+subscribers << {url: "http://rest-test.iron.io/code/200?store=key2"}
+res = @queue.update_queue(:subscribers => subscribers,
+                               :push_type => t)
+```
+
+### Add/remove subscribers on a queue
+
+```ruby
+@queue.add_subscriber({url: "http://nowhere.com"})
+# Or to remove a subscriber:
+@queue.remove_subscriber({url: "http://nowhere.com"})
+```
+
+### Get message push status
+
+After pushing a message:
+
+```ruby
+queue.messages.get(m.id).subscribers
+```
+
+Returns an array of subscribers with status.

data/iron_mq.gemspec

@@ -2,7 +2,7 @@ require File.expand_path('../lib/iron_mq/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Travis Reeder"]
-  gem.email         = ["treeder@gmail.com"]
+  gem.email         = ["travis@iron.io"]
   gem.description   = "Ruby client for IronMQ by www.iron.io"
   gem.summary       = "Ruby client for IronMQ by www.iron.io"
   gem.homepage      = "https://github.com/iron-io/iron_mq_ruby"
@@ -16,9 +16,10 @@ Gem::Specification.new do |gem|
 
   gem.required_rubygems_version = ">= 1.3.6"
   gem.required_ruby_version = Gem::Requirement.new(">= 1.9")
-  gem.add_runtime_dependency "iron_core", ">= 0.4.2"
+  gem.add_runtime_dependency "iron_core", ">= 0.4.4"
 
   gem.add_development_dependency "test-unit"
+  gem.add_development_dependency "minitest"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "beanstalk-client"
   gem.add_development_dependency "uber_config"

data/lib/iron_mq/client.rb

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

data/lib/iron_mq/messages.rb

@@ -1,20 +1,42 @@
+require 'cgi'
+
 module IronMQ
   class Messages
 
-    attr_accessor :client
+    attr_reader :client, :queue
 
-    def initialize(client)
+    def initialize(client, queue=nil)
       @client = client
+      @queue = queue
     end
 
+
     def path(options={})
-      path = "projects/#{@client.project_id}/queues/#{options[:queue_name] || options['queue_name'] || @client.queue_name}/messages"
+      options[:queue_name] ||= ((@queue ? @queue.name : nil) || @client.queue_name)
+      options[:project_id] = @client.project_id
+      Messages.path(options)
+    end
+
+    def self.path(options)
+      path = "#{Queues.path(options)}/messages"
+      if options[:msg_id]
+        path << "/#{options[:msg_id]}"
+      end
+      path
     end
 
     # options:
     #  :queue_name => can specify an alternative queue name
     #  :timeout => amount of time before message goes back on the queue
     def get(options={})
+      if options.is_a?(String)
+        # assume it's an id
+        puts 'get_by_id'
+        return Message.new(self, {'id'=>options}, options)
+        #r = @client.get(path(:msg_id=>options))
+        #p r
+        #return r
+      end
       res = @client.parse_response(@client.get(path(options), options))
       ret = []
       res["messages"].each do |m|
@@ -70,31 +92,8 @@ module IronMQ
 
   end
 
-  class ResponseBase
-
-    def initialize(res)
-      @data = res
-    end
-
-    def raw
-      @data
-    end
-
-    def [](key)
-      raw[key]
-    end
-
-    def id
-      raw["id"]
-    end
-
-    def msg
-      raw["msg"]
-    end
-
-  end
-
   class Message < ResponseBase
+    attr_reader :messages
 
     def initialize(messages, res, options={})
       super(res)
@@ -102,7 +101,6 @@ module IronMQ
       @options = options
     end
 
-
     def body
       raw["body"]
     end
@@ -116,6 +114,15 @@ module IronMQ
       options2 = options.merge(@options) if @options
       @messages.release(self.id, options2)
     end
-  end
 
+    def subscribers(options={})
+      res = @messages.client.get(@messages.path(options.merge(msg_id: id)) + "/subscribers", options)
+      res = @messages.client.parse_response(res)
+      ret = []
+      res['subscribers'].each do |m|
+        ret << Subscriber.new(m, self, options)
+      end
+      ret
+    end
+  end
 end

data/lib/iron_mq/queues.rb

@@ -1,3 +1,6 @@
+require 'cgi'
+require_relative 'subscribers'
+
 module IronMQ
   class Queues
 
@@ -7,14 +10,20 @@ module IronMQ
       @client = client
     end
 
-    def path(options={})
-      path = "projects/#{@client.project_id}/queues"
-      if options[:name]
-        path << "/#{CGI::escape(options[:name])}"
+    def self.path(options)
+      path = "projects/#{options[:project_id]}/queues"
+      name = options[:name] || options[:queue_name] || options['queue_name']
+      if name
+        path << "/#{CGI::escape(name)}"
       end
       path
     end
 
+    def path(options={})
+      options[:project_id] = @client.project_id
+      Queues.path(options)
+    end
+
     def list(options={})
       ret = []
       r1 = @client.get("#{path(options)}", options)
@@ -46,20 +55,22 @@ module IronMQ
     #  :name => can specify an alternative queue name
     def get(options={})
       options[:name] ||= @client.queue_name
-      res = @client.parse_response(@client.get("#{path(options)}"))
+      r = @client.get("#{path(options)}")
+      puts "HEADERS"
+      p r.headers
+      res = @client.parse_response(r)
       return Queue.new(@client, res)
     end
 
     # Update a queue
     # options:
     #  :name => if not specified, will use global queue name
-    #  :subscriptions => url's to subscribe to
+    #  :subscribers => url's to subscribe to
     def post(options={})
       options[:name] ||= @client.queue_name
       res = @client.parse_response(@client.post(path(options), options))
-      res
       p res
-
+      res
     end
 
 
@@ -67,6 +78,8 @@ module IronMQ
 
   class Queue
 
+    attr_reader :client
+
     def initialize(client, res)
       @client = client
       @data = res
@@ -89,14 +102,20 @@ module IronMQ
     end
 
     def reload
-      load_queue
+      load_queue(:force => true)
+    end
+
+    def messages
+      raw["messages"]
     end
 
     # Used if lazy loading
-    def load_queue
+    def load_queue(options={})
+      return if @loaded && !options[:force]
       q = @client.queues.get(:name => name)
       @client.logger.debug "GOT Q: " + q.inspect
       @data = q.raw
+      @loaded = true
       q
     end
 
@@ -105,23 +124,43 @@ module IronMQ
     end
 
     def delete_queue()
-      @client.queues.delete(:name=>name)
+      @client.queues.delete(:name => name)
+    end
+
+    # updates the Queue object itself
+    def update_queue(options)
+      @client.queues.post(options.merge(:name => name))
     end
 
     def size
-      return raw["size"] if raw["size"]
-      return @size if @size
-      q = load_queue()
-      @size = q.size
-      @size
+      load_queue()
+      return raw["size"]
     end
 
     def total_messages
-      return raw["total_messages"] if raw["total_messages"]
-      return @total_messages if @total_messages
-      q = load_queue()
-      @total_messages = q.total_messages
-      @total_messages
+      load_queue()
+      return raw["total_messages"]
+    end
+
+    def subscribers
+      load_queue()
+      return raw["subscribers"]
+    end
+
+    def add_subscriber(subscriber_hash, options={})
+      puts 'add_subscriber'
+      res = @client.post("#{@client.queues.path(name: name)}/subscribers", subscribers: [subscriber_hash])
+      res = @client.parse_response(res)
+      p res
+      res
+    end
+
+    def remove_subscriber(subscriber_hash)
+      puts 'remove_subscriber'
+      res = @client.delete("#{@client.queues.path(name: name)}/subscribers", {subscribers: [subscriber_hash]}, {"Content-Type"=>@client.content_type})
+      res = @client.parse_response(res)
+      p res
+      res
     end
 
     def post(body, options={})
@@ -132,6 +171,11 @@ module IronMQ
       @client.messages.get(options.merge(:queue_name => name))
     end
 
+    def delete(id, options={})
+      @client.messages.delete(id, options.merge(:queue_name => name))
+    end
+
+
     # This will continuously poll for a message and pass it to the block. For example:
     #
     #     queue.poll { |msg| puts msg.body }
@@ -157,8 +201,8 @@ module IronMQ
       end
     end
 
-    def delete(id, options={})
-      @client.messages.delete(id, options.merge(:queue_name => name))
+    def messages
+      Messages.new(client, self)
     end
 
   end

data/lib/iron_mq/response.rb

@@ -0,0 +1,27 @@
+
+module IronMQ
+
+  class ResponseBase
+
+    attr_reader :raw
+
+    def initialize(raw)
+      @raw = raw
+    end
+
+    def [](key)
+      raw[key]
+    end
+
+    def id
+      raw["id"]
+    end
+
+    def msg
+      raw["msg"]
+    end
+
+  end
+
+
+end

data/lib/iron_mq/subscribers.rb

@@ -0,0 +1,34 @@
+module IronMQ
+  class Subscribers
+    def self.path(options)
+      path = "#{Messages.path(options)}/subscribers"
+      if options[:subscriber_id]
+        path << "/#{options[:subscriber_id]}"
+      end
+      path
+    end
+  end
+
+  class Subscriber < ResponseBase
+    attr_accessor :options
+
+    def initialize(raw, message, options={})
+      super(raw)
+      @message = message
+      @options = options
+    end
+
+    def delete(options={})
+      client = @message.messages.client
+
+      options[:subscriber_id] ||= @raw["id"]
+      options[:msg_id] ||= @message.id
+      options[:project_id] ||= client.project_id
+      options[:queue_name] ||= client.queue_name
+      path = Subscribers.path(options)
+      raw = client.delete(path)
+      res = client.parse_response(raw)
+      return ResponseBase.new(res)
+    end
+  end
+end

data/lib/iron_mq/version.rb

@@ -1,3 +1,4 @@
 module IronMQ
-  VERSION = "2.1.3"
+  VERSION = "3.0.0"
 end
+

data/lib/iron_mq.rb

@@ -1,4 +1,5 @@
 require 'rest'
+require_relative 'iron_mq/response'
 require_relative 'iron_mq/queues'
 require_relative 'iron_mq/messages'
 require_relative 'iron_mq/client'

data/test/quick_run.rb

@@ -1,5 +1,7 @@
 require_relative 'test_base'
 
+TIMES = 1
+
 class QuickRun < TestBase
 
   def setup
@@ -10,39 +12,43 @@ class QuickRun < TestBase
 
   def test_basics
 
-    res = @client.messages.post("hello world!")
-    p res
-    assert res.id
-    post_id = res.id
-    assert res.msg
-
-    res = @client.messages.get()
-    p res
-    puts "post_id=" + post_id.inspect
-    assert res.id
-    assert_equal res.id, post_id
-    assert res.body
-
-    res = @client.messages.delete(res["id"])
-    p res
-    assert res.msg
-
-    res = @client.messages.get()
-    p res
-    assert res.nil?
-
-    res = @client.messages.post("hello world!", :queue_name=>'test2')
-    p res
-    assert res.id
-    assert res.msg
-
-    res = @client.messages.get(:queue_name=>'test2')
-    p res
-    assert res.id
-    assert res.body
-
-    res = res.delete
-    p res
+    TIMES.times do |i|
+      puts "==== LOOP #{i} =================================="
+
+      res = @client.messages.post("hello world!")
+      p res
+      assert res.id
+      post_id = res.id
+      assert res.msg
+
+      res = @client.messages.get()
+      p res
+      puts "post_id=" + post_id.inspect
+      assert res.id
+      assert_equal res.id, post_id
+      assert res.body
+
+      res = @client.messages.delete(res["id"])
+      p res
+      assert res.msg
+
+      res = @client.messages.get()
+      p res
+      assert res.nil?
+
+      res = @client.messages.post("hello world!", :queue_name => 'test2')
+      p res
+      assert res.id
+      assert res.msg
+
+      res = @client.messages.get(:queue_name => 'test2')
+      p res
+      assert res.id
+      assert res.body
+
+      res = res.delete
+      p res
+    end
 
 
   end

data/test/test_base.rb

@@ -9,14 +9,21 @@ rescue Exception => ex
   raise ex
 end
 
+LOG = Logger.new(STDOUT)
+MAX_TRIES = 100
 
 class TestBase < Test::Unit::TestCase
+
   def setup
     puts 'setup'
     # check multiple config locations
     @config = UberConfig.load
     puts "config=" + @config.inspect
+
+    config = @config['iron']
+    @host = "#{config['host'] || "mq-aws-us-east-1.iron.io"}"
     @client = IronMQ::Client.new(@config['iron'])
+    Rest.logger.level = Logger::DEBUG # this doesn't work for some reason?
     IronCore::Logger.logger.level = Logger::DEBUG
     @client.queue_name = 'ironmq-ruby-tests'
 
@@ -26,11 +33,8 @@ class TestBase < Test::Unit::TestCase
   def clear_queue(queue_name=nil)
     queue_name ||= @client.queue_name
     puts "clearing queue #{queue_name}"
-    while res = @client.messages.get(:queue_name=>queue_name)
-      p res
-      puts res.body.to_s
-      res.delete
-    end
+    @client.queue(queue_name).post("test")
+    @client.queue(queue_name).clear
     puts 'cleared.'
   end
 

data/test/test_beanstalkd.rb

@@ -9,11 +9,11 @@ class BeanstalkTests < TestBase
     super
 
     config = @config['iron']
-    @host = "#{config['host'] || "mq-aws-us-east-1.iron.io"}:#{config['beanstalkd_port'] || 11300}"
-    puts "beanstalkd url: #{@host}"
+    beanstalkd_host = "#{@host}:#{config['beanstalkd_port'] || 11300}"
+    puts "beanstalkd url: #{beanstalkd_host}"
     @skip = @host.include? 'rackspace'
     return if @skip # bypass these tests if rackspace
-    @beanstalk = Beanstalk::Connection.new(@host)
+    @beanstalk = Beanstalk::Connection.new(beanstalkd_host)
     @beanstalk.put("oauth #{config['token']} #{config['project_id']}")
 
     clear_tube('default')