quredis 0.5.1

data/lib/quredis/public/js/jquery_ujs.js

@@ -0,0 +1,377 @@
+(function($, undefined) {
+
+/**
+ * Unobtrusive scripting adapter for jQuery
+ *
+ * Requires jQuery 1.6.0 or later.
+ * https://github.com/rails/jquery-ujs
+
+ * Uploading file using rails.js
+ * =============================
+ *
+ * By default, browsers do not allow files to be uploaded via AJAX. As a result, if there are any non-blank file fields
+ * in the remote form, this adapter aborts the AJAX submission and allows the form to submit through standard means.
+ *
+ * The `ajax:aborted:file` event allows you to bind your own handler to process the form submission however you wish.
+ *
+ * Ex:
+ *     $('form').live('ajax:aborted:file', function(event, elements){
+ *       // Implement own remote file-transfer handler here for non-blank file inputs passed in `elements`.
+ *       // Returning false in this handler tells rails.js to disallow standard form submission
+ *       return false;
+ *     });
+ *
+ * The `ajax:aborted:file` event is fired when a file-type input is detected with a non-blank value.
+ *
+ * Third-party tools can use this hook to detect when an AJAX file upload is attempted, and then use
+ * techniques like the iframe method to upload the file instead.
+ *
+ * Required fields in rails.js
+ * ===========================
+ *
+ * If any blank required inputs (required="required") are detected in the remote form, the whole form submission
+ * is canceled. Note that this is unlike file inputs, which still allow standard (non-AJAX) form submission.
+ *
+ * The `ajax:aborted:required` event allows you to bind your own handler to inform the user of blank required inputs.
+ *
+ * !! Note that Opera does not fire the form's submit event if there are blank required inputs, so this event may never
+ *    get fired in Opera. This event is what causes other browsers to exhibit the same submit-aborting behavior.
+ *
+ * Ex:
+ *     $('form').live('ajax:aborted:required', function(event, elements){
+ *       // Returning false in this handler tells rails.js to submit the form anyway.
+ *       // The blank required inputs are passed to this function in `elements`.
+ *       return ! confirm("Would you like to submit the form with missing info?");
+ *     });
+ */
+
+  // Shorthand to make it a little easier to call public rails functions from within rails.js
+  var rails;
+
+  $.rails = rails = {
+    // Link elements bound by jquery-ujs
+    linkClickSelector: 'a[data-confirm], a[data-method], a[data-remote], a[data-disable-with]',
+
+    // Select elements bound by jquery-ujs
+    inputChangeSelector: 'select[data-remote], input[data-remote], textarea[data-remote]',
+
+    // Form elements bound by jquery-ujs
+    formSubmitSelector: 'form',
+
+    // Form input elements bound by jquery-ujs
+    formInputClickSelector: 'form input[type=submit], form input[type=image], form button[type=submit], form button:not(button[type])',
+
+    // Form input elements disabled during form submission
+    disableSelector: 'input[data-disable-with], button[data-disable-with], textarea[data-disable-with]',
+
+    // Form input elements re-enabled after form submission
+    enableSelector: 'input[data-disable-with]:disabled, button[data-disable-with]:disabled, textarea[data-disable-with]:disabled',
+
+    // Form required input elements
+    requiredInputSelector: 'input[name][required]:not([disabled]),textarea[name][required]:not([disabled])',
+
+    // Form file input elements
+    fileInputSelector: 'input:file',
+
+    // Link onClick disable selector with possible reenable after remote submission
+    linkDisableSelector: 'a[data-disable-with]',
+
+    // Make sure that every Ajax request sends the CSRF token
+    CSRFProtection: function(xhr) {
+      var token = $('meta[name="csrf-token"]').attr('content');
+      if (token) xhr.setRequestHeader('X-CSRF-Token', token);
+    },
+
+    // Triggers an event on an element and returns false if the event result is false
+    fire: function(obj, name, data) {
+      var event = $.Event(name);
+      obj.trigger(event, data);
+      return event.result !== false;
+    },
+
+    // Default confirm dialog, may be overridden with custom confirm dialog in $.rails.confirm
+    confirm: function(message) {
+      return confirm(message);
+    },
+
+    // Default ajax function, may be overridden with custom function in $.rails.ajax
+    ajax: function(options) {
+      return $.ajax(options);
+    },
+
+    // Default way to get an element's href. May be overridden at $.rails.href.
+    href: function(element) {
+      return element.attr('href');
+    },
+
+    // Submits "remote" forms and links with ajax
+    handleRemote: function(element) {
+      var method, url, data, crossDomain, dataType, options;
+
+      if (rails.fire(element, 'ajax:before')) {
+        crossDomain = element.data('cross-domain') || null;
+        dataType = element.data('type') || ($.ajaxSettings && $.ajaxSettings.dataType);
+
+        if (element.is('form')) {
+          method = element.attr('method');
+          url = element.attr('action');
+          data = element.serializeArray();
+          // memoized value from clicked submit button
+          var button = element.data('ujs:submit-button');
+          if (button) {
+            data.push(button);
+            element.data('ujs:submit-button', null);
+          }
+        } else if (element.is(rails.inputChangeSelector)) {
+          method = element.data('method');
+          url = element.data('url');
+          data = element.serialize();
+          if (element.data('params')) data = data + "&" + element.data('params');
+        } else {
+          method = element.data('method');
+          url = rails.href(element);
+          data = element.data('params') || null;
+        }
+
+        options = {
+          type: method || 'GET', data: data, dataType: dataType, crossDomain: crossDomain,
+          // stopping the "ajax:beforeSend" event will cancel the ajax request
+          beforeSend: function(xhr, settings) {
+            if (settings.dataType === undefined) {
+              xhr.setRequestHeader('accept', '*/*;q=0.5, ' + settings.accepts.script);
+            }
+            return rails.fire(element, 'ajax:beforeSend', [xhr, settings]);
+          },
+          success: function(data, status, xhr) {
+            element.trigger('ajax:success', [data, status, xhr]);
+          },
+          complete: function(xhr, status) {
+            element.trigger('ajax:complete', [xhr, status]);
+          },
+          error: function(xhr, status, error) {
+            element.trigger('ajax:error', [xhr, status, error]);
+          }
+        };
+        // Only pass url to `ajax` options if not blank
+        if (url) { options.url = url; }
+
+        return rails.ajax(options);
+      } else {
+        return false;
+      }
+    },
+
+    // Handles "data-method" on links such as:
+    // <a href="/users/5" data-method="delete" rel="nofollow" data-confirm="Are you sure?">Delete</a>
+    handleMethod: function(link) {
+      var href = rails.href(link),
+        method = link.data('method'),
+        target = link.attr('target'),
+        csrf_token = $('meta[name=csrf-token]').attr('content'),
+        csrf_param = $('meta[name=csrf-param]').attr('content'),
+        form = $('<form method="post" action="' + href + '"></form>'),
+        metadata_input = '<input name="_method" value="' + method + '" type="hidden" />';
+
+      if (csrf_param !== undefined && csrf_token !== undefined) {
+        metadata_input += '<input name="' + csrf_param + '" value="' + csrf_token + '" type="hidden" />';
+      }
+
+      if (target) { form.attr('target', target); }
+
+      form.hide().append(metadata_input).appendTo('body');
+      form.submit();
+    },
+
+    /* Disables form elements:
+      - Caches element value in 'ujs:enable-with' data store
+      - Replaces element text with value of 'data-disable-with' attribute
+      - Sets disabled property to true
+    */
+    disableFormElements: function(form) {
+      form.find(rails.disableSelector).each(function() {
+        var element = $(this), method = element.is('button') ? 'html' : 'val';
+        element.data('ujs:enable-with', element[method]());
+        element[method](element.data('disable-with'));
+        element.prop('disabled', true);
+      });
+    },
+
+    /* Re-enables disabled form elements:
+      - Replaces element text with cached value from 'ujs:enable-with' data store (created in `disableFormElements`)
+      - Sets disabled property to false
+    */
+    enableFormElements: function(form) {
+      form.find(rails.enableSelector).each(function() {
+        var element = $(this), method = element.is('button') ? 'html' : 'val';
+        if (element.data('ujs:enable-with')) element[method](element.data('ujs:enable-with'));
+        element.prop('disabled', false);
+      });
+    },
+
+   /* For 'data-confirm' attribute:
+      - Fires `confirm` event
+      - Shows the confirmation dialog
+      - Fires the `confirm:complete` event
+
+      Returns `true` if no function stops the chain and user chose yes; `false` otherwise.
+      Attaching a handler to the element's `confirm` event that returns a `falsy` value cancels the confirmation dialog.
+      Attaching a handler to the element's `confirm:complete` event that returns a `falsy` value makes this function
+      return false. The `confirm:complete` event is fired whether or not the user answered true or false to the dialog.
+   */
+    allowAction: function(element) {
+      var message = element.data('confirm'),
+          answer = false, callback;
+      if (!message) { return true; }
+
+      if (rails.fire(element, 'confirm')) {
+        answer = rails.confirm(message);
+        callback = rails.fire(element, 'confirm:complete', [answer]);
+      }
+      return answer && callback;
+    },
+
+    // Helper function which checks for blank inputs in a form that match the specified CSS selector
+    blankInputs: function(form, specifiedSelector, nonBlank) {
+      var inputs = $(), input,
+        selector = specifiedSelector || 'input,textarea';
+      form.find(selector).each(function() {
+        input = $(this);
+        // Collect non-blank inputs if nonBlank option is true, otherwise, collect blank inputs
+        if (nonBlank ? input.val() : !input.val()) {
+          inputs = inputs.add(input);
+        }
+      });
+      return inputs.length ? inputs : false;
+    },
+
+    // Helper function which checks for non-blank inputs in a form that match the specified CSS selector
+    nonBlankInputs: function(form, specifiedSelector) {
+      return rails.blankInputs(form, specifiedSelector, true); // true specifies nonBlank
+    },
+
+    // Helper function, needed to provide consistent behavior in IE
+    stopEverything: function(e) {
+      $(e.target).trigger('ujs:everythingStopped');
+      e.stopImmediatePropagation();
+      return false;
+    },
+
+    // find all the submit events directly bound to the form and
+    // manually invoke them. If anyone returns false then stop the loop
+    callFormSubmitBindings: function(form, event) {
+      var events = form.data('events'), continuePropagation = true;
+      if (events !== undefined && events['submit'] !== undefined) {
+        $.each(events['submit'], function(i, obj){
+          if (typeof obj.handler === 'function') return continuePropagation = obj.handler(event);
+        });
+      }
+      return continuePropagation;
+    },
+
+    //  replace element's html with the 'data-disable-with' after storing original html
+    //  and prevent clicking on it
+    disableElement: function(element) {
+      element.data('ujs:enable-with', element.html()); // store enabled state
+      element.html(element.data('disable-with')); // set to disabled state
+      element.bind('click.railsDisable', function(e) { // prevent further clicking
+        return rails.stopEverything(e)
+      });
+    },
+
+    // restore element to its original state which was disabled by 'disableElement' above
+    enableElement: function(element) {
+      if (element.data('ujs:enable-with') !== undefined) {
+        element.html(element.data('ujs:enable-with')); // set to old enabled state
+        // this should be element.removeData('ujs:enable-with')
+        // but, there is currently a bug in jquery which makes hyphenated data attributes not get removed
+        element.data('ujs:enable-with', false); // clean up cache
+      }
+      element.unbind('click.railsDisable'); // enable element
+    }
+
+  };
+
+  $.ajaxPrefilter(function(options, originalOptions, xhr){ if ( !options.crossDomain ) { rails.CSRFProtection(xhr); }});
+
+  $(document).delegate(rails.linkDisableSelector, 'ajax:complete', function() {
+      rails.enableElement($(this));
+  });
+
+  $(document).delegate(rails.linkClickSelector, 'click.rails', function(e) {
+    var link = $(this), method = link.data('method'), data = link.data('params');
+    if (!rails.allowAction(link)) return rails.stopEverything(e);
+
+    if (link.is(rails.linkDisableSelector)) rails.disableElement(link);
+
+    if (link.data('remote') !== undefined) {
+      if ( (e.metaKey || e.ctrlKey) && (!method || method === 'GET') && !data ) { return true; }
+
+      if (rails.handleRemote(link) === false) { rails.enableElement(link); }
+      return false;
+
+    } else if (link.data('method')) {
+      rails.handleMethod(link);
+      return false;
+    }
+  });
+
+  $(document).delegate(rails.inputChangeSelector, 'change.rails', function(e) {
+    var link = $(this);
+    if (!rails.allowAction(link)) return rails.stopEverything(e);
+
+    rails.handleRemote(link);
+    return false;
+  });
+
+  $(document).delegate(rails.formSubmitSelector, 'submit.rails', function(e) {
+    var form = $(this),
+      remote = form.data('remote') !== undefined,
+      blankRequiredInputs = rails.blankInputs(form, rails.requiredInputSelector),
+      nonBlankFileInputs = rails.nonBlankInputs(form, rails.fileInputSelector);
+
+    if (!rails.allowAction(form)) return rails.stopEverything(e);
+
+    // skip other logic when required values are missing or file upload is present
+    if (blankRequiredInputs && form.attr("novalidate") == undefined && rails.fire(form, 'ajax:aborted:required', [blankRequiredInputs])) {
+      return rails.stopEverything(e);
+    }
+
+    if (remote) {
+      if (nonBlankFileInputs) {
+        return rails.fire(form, 'ajax:aborted:file', [nonBlankFileInputs]);
+      }
+
+      // If browser does not support submit bubbling, then this live-binding will be called before direct
+      // bindings. Therefore, we should directly call any direct bindings before remotely submitting form.
+      if (!$.support.submitBubbles && $().jquery < '1.7' && rails.callFormSubmitBindings(form, e) === false) return rails.stopEverything(e);
+
+      rails.handleRemote(form);
+      return false;
+
+    } else {
+      // slight timeout so that the submit button gets properly serialized
+      setTimeout(function(){ rails.disableFormElements(form); }, 13);
+    }
+  });
+
+  $(document).delegate(rails.formInputClickSelector, 'click.rails', function(event) {
+    var button = $(this);
+
+    if (!rails.allowAction(button)) return rails.stopEverything(event);
+
+    // register the pressed submit button
+    var name = button.attr('name'),
+      data = name ? {name:name, value:button.val()} : null;
+
+    button.closest('form').data('ujs:submit-button', data);
+  });
+
+  $(document).delegate(rails.formSubmitSelector, 'ajax:beforeSend.rails', function(event) {
+    if (this == event.target) rails.disableFormElements($(this));
+  });
+
+  $(document).delegate(rails.formSubmitSelector, 'ajax:complete.rails', function(event) {
+    if (this == event.target) rails.enableFormElements($(this));
+  });
+
+})( jQuery );

data/lib/quredis/public/js/quredis.js

@@ -0,0 +1 @@
+//

data/lib/quredis/version.rb

@@ -0,0 +1,3 @@
+module Quredis
+  Version = VERSION = '0.5.1'
+end

data/lib/quredis/views/index.erb

@@ -0,0 +1,28 @@
+<% unless items.empty? %>
+<table class="table table-striped">
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Ingress</th>
+      <th>Transit</th>
+      <th>Escape</th>
+      <th>Destroy</th>
+    </tr>
+  </thead>
+  <tbody>
+  <% for item in items %>
+    <tr>
+      <td><%=item['name']%></td>
+      <td><a href="/queue/<%=item['name']%>/ingress"><span class="badge badge-info"><%=item['ingress_count']%></span> <%=item['ingress']%></a></td>
+      <td><a href="/queue/<%=item['name']%>/transit"><span class="badge badge-info"><%=item['transit_count']%></span> <%=item['transit']%></a></td>
+      <td><a href="/queue/<%=item['name']%>/escape"><span class="badge badge-info"><%=item['escape_count']%></span> <%=item['escape']%></a></td>
+      <td><a class="btn btn-danger" href="/queue/<%=item['name']%>" data-confirm="About to remove this queue completely. Are you sure?" data-method="delete">Destroy</a></td>
+
+<!--       <td><a class="btn btn-danger" href="/destroy/<%=item['name']%>" data-confirm="About to remove this queue completely. Are you sure?" data-method="delete" data-disable-with="Deleting" data-remote>Destroy</a></td>
+ -->    </tr>
+  <% end %>
+  </tbody>
+</table>
+<% else %>
+ <p>No queues found</p>
+<% end %>

data/lib/quredis/views/layout.erb

@@ -0,0 +1,62 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>Quredis Admin</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="description" content="">
+    <meta name="author" content="">
+
+    <!-- Le styles -->
+    <link href="/css/bootstrap.css" rel="stylesheet">
+    <style>
+      body {
+        padding-top: 60px; /* 60px to make the container go all the way to the bottom of the topbar */
+      }
+    </style>
+    <link href="/css/bootstrap-responsive.css" rel="stylesheet">
+    <link href="/css/quredis.css" rel="stylesheet">
+    <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+    <!--[if lt IE 9]>
+      <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+
+    <!-- Le fav and touch icons -->
+    <link rel="shortcut icon" href="ico/favicon.ico">
+    <link rel="apple-touch-icon-precomposed" sizes="144x144" href="ico/apple-touch-icon-144-precomposed.png">
+    <link rel="apple-touch-icon-precomposed" sizes="114x114" href="ico/apple-touch-icon-114-precomposed.png">
+    <link rel="apple-touch-icon-precomposed" sizes="72x72" href="ico/apple-touch-icon-72-precomposed.png">
+    <link rel="apple-touch-icon-precomposed" href="ico/apple-touch-icon-57-precomposed.png">
+  </head>
+
+  <body>
+
+    <div class="navbar navbar-fixed-top">
+      <div class="navbar-inner">
+        <div class="container">
+          <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+          </a>
+          <a class="brand" href="/">Quredis</a>
+        </div>
+      </div>
+    </div>
+
+    <div class="container">
+      <%= yield %>
+     <footer class="footer">
+        <p class="pull-right">Powered by <a href="http://github.com/cpatni/quredis" target="_blank">quredis</a></p>
+    </footer>
+   </div> <!-- /container -->
+
+    <!-- Le javascript
+    ================================================== -->
+    <!-- Placed at the end of the document so the pages load faster -->
+    <script src="/js/jquery.min.js"></script>
+    <script src="/js/bootstrap.min.js"></script>
+    <script src="/js/jquery_ujs.js"></script>
+    <script src="/js/quredis.js"></script>
+  </body>
+</html>

data/lib/quredis/views/queue.erb

@@ -0,0 +1,23 @@
+<a class="btn btn-danger" href="/purge/<%=queue%>/<%=type%>" data-confirm="It will remove all the messages from this queue. Are you sure?" data-method="delete">Purge</a>
+<% unless type == 'ingress'%>
+<a class="btn btn-success" href="/retry/<%=queue%>/<%=type%>" data-confirm="It will re-enqueue all the messages to the ingress queue. Are you sure?" data-method="post">Retry</a>
+<% end %>
+
+<% unless items.empty? %>
+<table class="table table-striped">
+  <thead>
+    <tr>
+      <th>Item</th>
+    </tr>
+  </thead>
+  <tbody>
+  <% for item in items %>
+    <tr>
+      <td><%=item%></td>
+    </tr>
+  <% end %>
+  </tbody>
+</table>
+<% else %>
+ <p>No items found</p>
+<% end %>

data/lib/quredis/web.rb

@@ -0,0 +1,64 @@
+require 'sinatra'
+require 'json'
+require 'redis'
+require 'sinatra/base'
+require 'quredis/admin'
+
+module Quredis
+  class Web < Sinatra::Base
+
+    configure do
+      enable :method_override
+      enable :logging
+      #defer the evaluation so that redis_host and redis_port are set properly
+      set :admin, Proc.new {
+        redis_opts = {}
+        if settings.respond_to? :redis_host
+          redis_opts[:host] = settings.redis_host
+        end
+
+        if settings.respond_to? :redis_port
+          redis_opts[:port] = settings.redis_port
+        end
+        Quredis::Admin.new(redis_opts)
+      }
+    end
+
+
+    def admin
+      settings.admin
+    end
+
+    get '/' do
+      erb :index, :locals => admin.queues(params)
+    end
+
+    get '/queue/:name/:type' do |name, type|
+      erb :queue, :locals => admin.queue(name, type)
+    end
+
+    delete '/queue/:name' do |name|
+      admin.destroy_queue(name)
+      redirect '/'
+    end
+
+    delete '/purge/:name/:type' do |name, type|
+      admin.purge(name, type)
+      redirect '/'
+    end
+
+    post '/retry/:name/:type' do |name, type|
+      admin.retry(name, type)
+      redirect '/'
+    end
+
+    get '/api/queues' do
+      content_type :json
+      admin.queues(params).to_json
+    end
+
+    run! if app_file == $0
+
+  end
+end
+

data/lib/quredis.rb

@@ -0,0 +1,121 @@
+require "logger"
+require 'redis'
+require 'json'
+
+module Quredis
+  attr_reader :name, :ingress, :transit, :escape
+
+  attr_reader :logger, :redis
+
+  def quredis(name, options = {}, &block)
+    @name = name
+    @ingress = options.fetch(:ingress, "ingress:#{name}")
+    @transit = options.fetch(:transit, "transit:#{name}")
+    @escape =  options.fetch(:escape, "escape:#{name}")
+    @block = block
+    @redis_timeout = options.fetch(:redis_timeout, 0)
+    @enable_worker_info = options.fetch(:enable_worker_info, false)
+  end
+
+  def logger
+    @logger ||= Logger.new(STDOUT)
+  end
+
+  def redis
+    @redis ||= Redis.new
+  end
+
+  def host
+    `hostname`.strip
+  end
+
+  def pid
+    Process.pid
+  end
+
+  def worker_id
+    @worker_id ||= "#{host}:#{pid}:#{@name}"
+  end
+
+  def register
+    redis.multi do |multi|
+      multi.set("quredis:queue:#{name}", {
+        :name => name,
+        :ingress => ingress,
+        :transit => transit,
+        :escape => escape
+      }.to_json)
+      multi.zadd('quredis:queues', Time.now.to_i, name)
+        if @enable_worker_info
+        multi.hmset("quredis:worker:#{worker_id}", *{
+          :worker_id => worker_id,
+          :host => host,
+          :pid => pid,
+          :messages => 0,
+          :errors => 0,
+          :start_time => Time.now.to_i
+        }.to_a.flatten)
+        multi.sadd("quredis:queue:#{@name}:workers", worker_id)
+        multi.zadd('quredis:workers', Time.now.to_i, worker_id)
+      end
+    end
+  end
+
+  def start
+    connect unless redis
+    register
+    recover
+    logger.info "Quredis starting..."
+    logger.info "#{name} Queues: ingress -> #{ingress} transit -> #{transit} escape -> #{escape}"
+    loop do
+      connect unless redis
+      pipe
+    end
+  end
+
+  #Not intended to run if we are running clustered service
+  def recover
+    loop do
+      element = redis.rpoplpush(transit, escape)
+      if element
+        begin
+          logger.debug("recovering #{element}")
+          @block.call element
+          redis.lrem(escape, -1, element)
+        rescue Exception => e
+          logger.error e
+        end
+      else
+        break
+      end
+    end
+  end
+
+  def pipe
+    element = nil
+    begin
+      element = redis.brpoplpush(ingress, transit, @redis_timeout || 0)
+      if element
+        begin
+          logger.debug("dequeued #{element}")
+          @block.call element
+        rescue StandardError, Timeout::Error => e
+          logger.error e
+          replies = redis.multi do |multi|
+            multi.lrem(transit, -1, element)
+            multi.lpush(escape, element)
+          end
+          element = nil if replies
+        ensure
+          redis.lrem(transit, -1, element) if element
+        end
+      else
+        on_timeout if respond_to? :on_timeout
+      end
+    rescue Errno::EINTR => e
+      raise e
+    rescue StandardError, Timeout::Error => e
+      logger.error e
+    end
+  end
+end