iron_mq 4.0.3 → 4.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60ddd32d17b9bf5b091151e1e26915b75a60bb05
-  data.tar.gz: f21165a64e0001ecfff3e9c2144cec2b0cc9c9d2
+  metadata.gz: 59de953d559a2e493b72d7d9f5d588fb45b09522
+  data.tar.gz: ff331240b424418b610a83bb37f4091d5ac6f8af
 SHA512:
-  metadata.gz: d96d56ac39de492bc36e976b8467101bac942c34cf34af3896dc959d5f732b755d784060671e3ab25b7bd68dfd3a077c185e14fab7c4dd80e708fcff8f55611b
-  data.tar.gz: 0dbc4b37f6344681aec4d18b08fd2148738accd8f0abc0c6965ded1325f074e78d56d466d1035f3df8e7fe7189078cb5b076e79796438040a5c4daebc8466c93
+  metadata.gz: 24378f0dcf15c8f5c54759dfe6bac0e556ffa05905e9fb26597c28bfd63b23b3146a5a8dff5285cf9b0668e6b9036ac023b9df2ebd6caa795f2954fc9136aad6
+  data.tar.gz: 3ffaa342f10a49f5cd638b75e7440b4d2d36cc709f186866740cbd1013aa57e672f1e4db1302dcc38a05a5c116e82a633c4a72a055b5ee4e1f92d7dd2e506bd2

data/.gitignore

@@ -6,3 +6,5 @@ log
 test/config.yml
 *.sublime*
 /*.gem
+config.yml
+

data/Gemfile.lock

@@ -8,26 +8,33 @@ GEM
   remote: https://rubygems.org/
   specs:
     beanstalk-client (1.1.1)
-    concur (2.0.0)
-    ethon (0.5.9)
-      ffi (~> 1.2.0)
+    concur (2.1.1)
+    ethon (0.6.1)
+      ffi (>= 1.3.0)
       mime-types (~> 1.18)
-    ffi (1.2.1)
-    iron_core (0.5.2)
+    ffi (1.9.0)
+    go (1.1.0)
+      concur
+    iron_core (1.0.1)
       rest (>= 2.2.0)
-    mime-types (1.21)
-    minitest (4.6.2)
-    net-http-persistent (2.8)
+    iron_worker_ng (1.0.2)
+      bundler (>= 1.2.0)
+      iron_core (>= 1.0.0)
+      rubyzip (= 0.9.9)
+    mime-types (1.25)
+    minitest (5.0.8)
+    net-http-persistent (2.9)
     quicky (0.4.0)
-    rake (10.0.3)
-    rest (2.5.0)
+    rake (10.1.0)
+    rest (2.6.3)
+      net-http-persistent
       rest-client (>= 0.3.0)
-      typhoeus (>= 0.5.4)
     rest-client (1.6.7)
       mime-types (>= 1.16)
-    test-unit (2.5.4)
-    typhoeus (0.6.1)
-      ethon (~> 0.5.9)
+    rubyzip (0.9.9)
+    test-unit (2.5.5)
+    typhoeus (0.6.5)
+      ethon (~> 0.6.1)
     uber_config (1.0.5)
 
 PLATFORMS
@@ -35,8 +42,9 @@ PLATFORMS
 
 DEPENDENCIES
   beanstalk-client
-  concur
+  go
   iron_mq!
+  iron_worker_ng
   minitest
   net-http-persistent
   quicky

data/README.md

@@ -21,12 +21,17 @@ gem install iron_mq
 ironmq = IronMQ::Client.new
 ```
 
-Or pass in credentials:
+Or pass in credentials if you don't want to use an iron.json file or set ENV variables:
 
 ```ruby
 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:
 
+```ruby
+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](http://dev.iron.io/mq/reference/clouds/).
 
 ## The Basics
 
@@ -147,8 +152,6 @@ Shortcuts for `queue.info[key]`:
 
 ```ruby
 id = queue.id # => "5127bf043264140e863e2283"
-# Does queue exists on server? Alias for `queue.id.nil?`
-is_new = queue.new? # => false
 
 size = queue.size # => 7
 name = queue.name # => "my_queue"
@@ -233,8 +236,8 @@ You must delete the message from the queue to ensure it does not go back onto th
 If not set, value from POST is used. Default is 60 seconds. Minimum is 30 seconds.
 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.
+When `n` parameter is specified and greater than 1 method returns `Array` of `Message`s.
+Otherwise, `Message` object would be returned.
 
 --
 
@@ -330,7 +333,7 @@ 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_type`: Either `multicast` to push to all subscribers or `unicast` to push to one and only one subscriber. Default is `multicast`.
-* `retries`: How many times to retry on failure. Default is 3.
+* `retries`: How many times to retry on failure. Default is 3. Maximum is 100.
 * `retries_delay`: Delay between each retry in seconds. Default is 60.
 
 --
@@ -345,7 +348,7 @@ 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=key1"},
   {:url => "http://rest-test.iron.io/code/200?store=key2"}
 ]
 
@@ -421,6 +424,16 @@ end
 
 --
 
+### Revert Queue Back to Pull Queue
+
+If you want to revert you queue just update `push_type` to `'pull'`.
+
+```ruby
+queue.update(:push_type => 'pull');
+```
+
+--
+
 
 ## Further Links
 

data/iron_mq.gemspec

@@ -24,9 +24,9 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "beanstalk-client"
   gem.add_development_dependency "uber_config"
   gem.add_development_dependency "typhoeus", ">= 0.5.4"
-  gem.add_development_dependency "concur"
   gem.add_development_dependency "net-http-persistent"
   gem.add_development_dependency "quicky"
-
+  gem.add_development_dependency "iron_worker_ng"
+  gem.add_development_dependency "go"
 end
 

data/lib/iron_mq.rb

@@ -1,5 +1,6 @@
 require File.expand_path('iron_mq/response', File.dirname(__FILE__))
 require File.expand_path('iron_mq/subscribers', File.dirname(__FILE__))
+require File.expand_path('iron_mq/alert', 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__))

data/lib/iron_mq/alert.rb

@@ -0,0 +1,53 @@
+module IronMQ
+
+  class Alert
+    # `options` was kept for backward compatibility
+    attr_accessor :options
+
+    def initialize(queue, alert_hash, options = {})
+      @queue = queue
+      @raw = alert_hash
+      @options = options
+    end
+
+    def id
+      @raw["id"]
+    end
+
+    # alert type
+    def type
+      @raw["type"]
+    end
+
+    # target queue
+    def queue
+      @raw["queue"]
+    end
+
+    def trigger
+      @raw["trigger"]
+    end
+
+    # `options` was kept for backward compatibility
+    def delete(options = {})
+      @message.call_api_and_parse_response(:delete, path)
+    rescue Rest::HttpError => ex
+      if ex.code == 404
+        IronCore::Logger.info("IronMQ", "Delete got 404, safe to ignore.")
+        # return ResponseBase as normal
+        ResponseBase.new({"msg" => "Deleted"}, 404)
+      else
+        raise ex
+      end
+    end
+
+    alias_method :acknowledge, :delete
+
+    private
+
+    def path
+      "/alerts/#{id}"
+    end
+  end
+
+end

data/lib/iron_mq/client.rb

@@ -15,7 +15,7 @@ module IronMQ
           :host => IronMQ::Client::AWS_US_EAST_HOST,
           :port => 443,
           :api_version => 1,
-          :user_agent => 'iron_mq_ruby-' + 'very_new' + ' (iron_core_ruby-' + IronCore.version + ')'
+          :user_agent => 'iron_mq_ruby-' + IronMQ::VERSION + ' (iron_core_ruby-' + IronCore.version + ')'
       }
 
       super('iron', 'mq', options, default_options, [:project_id, :token, :api_version])
@@ -52,7 +52,7 @@ module IronMQ
     alias_method :all, :queues_list
 
     def queues_get(name)
-      Queue.new(self, name)
+      IronMQ::Queue.new(self, name)
     end
 
     alias_method :queue, :queues_get

data/lib/iron_mq/messages.rb

@@ -10,6 +10,26 @@ module IronMQ
       super(data, 200)
     end
 
+    def body
+      @raw['body']
+    end
+
+    def timeout
+      @raw['timeout']
+    end
+
+    def expires_in
+      @raw['expires_in']
+    end
+
+    def delay
+      @raw['delay']
+    end
+
+    def reserved_count
+      @raw['reserved_count']
+    end
+
     def touch
       call_api_and_parse_response(:post, "/touch")
     end
@@ -31,7 +51,7 @@ module IronMQ
       if ex.code == 404
         Rest.logger.info("Delete got 404, safe to ignore.")
         # return ResponseBase as normal
-        ResponseBase.new({"msg" => "Deleted"})
+        ResponseBase.new({"msg" => "Deleted"}, 404)
       else
         raise ex
       end

data/lib/iron_mq/queues.rb

@@ -3,36 +3,49 @@ require 'cgi'
 module IronMQ
 
   class Queue < ResponseBase
-    attr_reader :name
+    attr_reader :name, :raw
 
     def initialize(client, queue_name)
       @client = client
       @name = queue_name
-      super({"name" => queue_name})
+
     end
 
     def info
-      call_api_and_parse_response(:get)
-    rescue Rest::HttpError => ex
-      if ex.code == 404
-        Rest.logger.info("GET Queue#info return 404, treat as new queue, safe to ignore.")
-        # return ResponseBase as normal
-        ResponseBase.new(raw)
-      else
-        raise ex
+      load
+    end
+
+    # this is only run once if it hasn't been called before unless force is true, then it will force reload.
+    def load
+      if @raw.nil?
+        reload
       end
+      @raw
+    end
+
+    def reload
+      @raw = call_api_and_parse_response(:get, "", {}, false, true)
+      self
+    end
+
+    def id
+      load
+      @raw['id']
     end
 
     def size
-      info.size.to_i
+      load
+      @raw['size'].to_i
     end
 
     def total_messages
-      info.total_messages.to_i
+      load
+      @raw['total_messages'].to_i
     end
 
-    def new?
-      id.nil?
+    def push_type
+      load
+      @raw['push_type']
     end
 
     def push_queue?
@@ -49,19 +62,21 @@ module IronMQ
     alias_method :update_queue, :update
 
     def clear
-      call_api_and_parse_response(:post, "/clear")
+      call_api_and_parse_response(:post, "/clear", {}, false, true)
     end
 
     alias_method :clear_queue, :clear
 
     # Backward compatibility, better name is `delete`
     def delete_queue
-      call_api_and_parse_response(:delete)
+      r = call_api_and_parse_response(:delete)
+      @raw = nil
+      return r
     rescue Rest::HttpError => ex
       if ex.code == 404
         Rest.logger.info("Delete got 404, safe to ignore.")
         # return ResponseBase as normal
-        ResponseBase.new({"msg" => "Deleted"})
+        ResponseBase.new({"msg" => "Deleted"}, 404)
       else
         raise ex
       end
@@ -73,6 +88,11 @@ module IronMQ
       Message.new(self, {"id" => message_id}).delete
     end
 
+    # Accepts an array of message ids
+    def delete_messages(ids)
+      call_api_and_parse_response(:delete, "/messages", :ids => ids)
+    end
+
     def add_subscribers(subscribers)
       call_api_and_parse_response(:post, "/subscribers", :subscribers => subscribers)
     end
@@ -86,8 +106,8 @@ module IronMQ
       call_api_and_parse_response(:delete,
                                   "/subscribers",
                                   {
-                                    :subscribers => subscribers,
-                                    :headers => {"Content-Type" => @client.content_type}
+                                      :subscribers => subscribers,
+                                      :headers => {"Content-Type" => @client.content_type}
                                   })
     end
 
@@ -95,6 +115,29 @@ module IronMQ
       remove_subscribers([subscriber])
     end
 
+    # `options` was kept for backward compatibility
+    def subscribers(options = {})
+      load
+      if @raw['subscribers']
+        return @raw['subscribers'].map { |s| Subscriber.new(s, self, options) }
+      end
+      []
+    end
+
+    def add_alert(alert = {})
+      add_alerts([alert])
+    end
+
+    def add_alerts(alerts)
+      call_api_and_parse_response(:post, "/alerts", :alerts => alerts)
+    end
+
+    def alerts
+      load
+      return nil unless @raw["alerts"]
+      to_alerts(@raw["alerts"])
+    end
+
     def post_messages(payload, options = {})
       batch = false
 
@@ -110,7 +153,7 @@ module IronMQ
                #        For now user must pass objects like `[{:body => msg1}, {:body => msg2}]`
                payload.map { |msg| msg.merge(options) }
              else
-               [ options.merge(:body => payload) ]
+               [options.merge(:body => payload)]
              end
 
       # Do not instantiate response
@@ -123,7 +166,7 @@ module IronMQ
         process_messages(msg_ids, {:n => n})
       else
         if batch
-          # FIXME: Return Array of ResponsBase instead, it seems more clear than raw response
+          # FIXME: Return Array of ResponseBase instead, it seems more clear than raw response
           #
           #          res["ids"].map { |id| ResponseBase.new({"id" => id, "msg" => res["msg"]}) }
           #
@@ -142,7 +185,7 @@ module IronMQ
         return Message.new(self, {"id" => options})
       end
 
-      resp = call_api_and_parse_response(:get, "/messages", options)
+      resp = call_api_and_parse_response(:get, "/messages", options, false)
 
       process_messages(resp["messages"], options)
     end
@@ -150,7 +193,14 @@ module IronMQ
     alias_method :get, :get_messages
 
     # Backward compatibility
-    def messages ; self; end
+    def messages
+      self
+    end
+
+    def get_message(id)
+      resp = call_api_and_parse_response(:get, "/messages/#{id}", {}, false)
+      Message.new(self, resp)
+    end
 
     def peek_messages(options = {})
       resp = call_api_and_parse_response(:get, "/messages/peek", options)
@@ -162,7 +212,7 @@ module IronMQ
 
     def poll_messages(options = {}, &block)
       sleep_duration = options[:sleep_duration] || 1
-      
+
       while true
         msg = get_messages(options.merge(:n => 1))
         if msg.nil?
@@ -177,7 +227,8 @@ module IronMQ
 
     alias_method :poll, :poll_messages
 
-    def call_api_and_parse_response(meth, ext_path = "", options = {}, instantiate = true)
+    def call_api_and_parse_response(meth, ext_path = "", options = {}, instantiate = true, ignore404 = false)
+      r = nil
       response = if meth.to_s == "delete"
                    headers = options.delete(:headers) || options.delete("headers") || {}
 
@@ -185,23 +236,20 @@ module IronMQ
                  else
                    @client.parse_response(@client.send(meth, "#{path(ext_path)}", options))
                  end
-      instantiate ? ResponseBase.new(response) : response
+      r = instantiate ? ResponseBase.new(response) : response
+      r
     end
 
-    def method_missing(meth, *args)
-      # This is for reload queue info data when calling:
-      #   queue.id
-      #   queue.size
-      # etc.
-      if args.length == 0
-        self.info[meth.to_s]
-      else
-        super
+    private
+
+    def to_alerts(alert_array)
+      r = []
+      alert_array.each do |a|
+        r << Alert.new(self, a)
       end
+      r
     end
 
-    private
-
     def path(ext_path)
       "/#{CGI::escape(@name).gsub('+', '%20')}#{ext_path}"
     end