que_view 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b77d4ef6cb2aa616ac40ff47f98570756efd4873
+  data.tar.gz: 8ae982a7fd4d852b057b554a95b584bc441f4f75
+SHA512:
+  metadata.gz: bb0ee81f324a598019e9d8439f7bce18c138fc7e7c2e75938c84f74d95956f2e1c04a9ba262f09d211fb5a5b7557b68d2ff8e942e1415e8316370c38d279b3fa
+  data.tar.gz: 0eeb83804f71d29b39422efa8c2315b1a847ff2dc41d5fecc4673471bfc6a431e523624f0e21287247d61da972c3b0c12b187fbd761d145c44631efeef4b98a2

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+*.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1
+
+- initial release to provide visibility into scheduled Que tasks

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in que_view.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Kane, 2008-2014 Heroku (initial queries)
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# QueView
+
+Visibility into scheuled Que jobs.
+
+[Que](https://github.com/chanks/que)
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem "que_view"
+```
+
+And mount the dashboard in your router.
+
+```ruby
+mount QueView::Engine, at: "que_view"
+```
+Be sure to [secure the dashboard](#security) in production.
+
+## Security
+
+#### Basic Authentication
+
+Set the following variables in your environment or an initializer.
+
+```ruby
+ENV["QUEVIEW_USERNAME"] = "rock"
+ENV["QUEVIEW_PASSWORD"] = "aroundtheclock"
+```
+
+#### Devise
+
+```ruby
+authenticate :user, lambda {|user| user.admin? } do
+  mount QueView::Engine, at: "que_view"
+end
+```
+
+## TODO
+
+- add rspec tests
+- filter tasks by type
+
+Know a bit about Que? [Suggestions](https://github.com/tasboa/que_view/issues) are greatly appreciated.
+
+## History
+
+View the [changelog](https://github.com/tasboa/que_view/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/tasboa/que_view/issues)
+- Fix bugs and [submit pull requests](https://github.com/tasboa/que_view/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1 @@
+# TODO: add test calls

data/app/controllers/que_view/home_controller.rb

@@ -0,0 +1,12 @@
+module QueView
+  class HomeController < ActionController::Base
+    layout "que_view/application"
+    protect_from_forgery
+    http_basic_authenticate_with name: ENV["QUEVIEW_USERNAME"],
+                                 password: ENV["QUEVIEW_PASSWORD"] if ENV["QUEVIEW_PASSWORD"]
+
+    def index
+      @jobs = QueJob.all
+    end
+  end
+end

data/app/models/que_view/que_job.rb

@@ -0,0 +1,20 @@
+module QueView
+  # == Schema Information
+  #
+  # Table name: que_jobs
+  #
+  #  priority    :integer          default(100), not null
+  #  run_at      :datetime         not null
+  #  job_id      :integer          not null
+  #  job_class   :text             not null
+  #  args        :json             default([]), not null
+  #  error_count :integer          default(0), not null
+  #  last_error  :text
+  #  queue       :text             default(""), not null, primary key
+  #
+
+  # the database table that Que uses to store scheduled jobs
+  class QueJob < ActiveRecord::Base
+    self.table_name = "que_jobs"
+  end
+end

data/app/views/layouts/que_view/application.html.erb

@@ -0,0 +1,356 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= @title %> - QueView</title>
+
+    <meta charset="utf-8" />
+
+    <style>
+      body {
+        margin: 0;
+        padding: 20px;
+        background-color: #2b3e50;
+      }
+
+      body, textarea {
+        font-family: "Helvetica Neue", Arial, Helvetica, sans-serif;
+        font-size: 14px;
+        line-height: 1.4;
+        color: #333;
+      }
+
+      a, a:visited, a:active {
+        color: #428bca;
+        text-decoration: none;
+      }
+
+      a:hover {
+        text-decoration: underline;
+      }
+
+      table {
+        width: 100%;
+        border-collapse: collapse;
+        border-spacing: 0;
+        margin-bottom: 20px;
+      }
+
+      th {
+        text-align: left;
+        border-bottom: solid 2px #ddd;
+      }
+
+      h1 {
+        margin-top: 0;
+        font-size: 20px;
+        font-weight: bold;
+      }
+
+      h1, p {
+        margin-bottom: 20px;
+      }
+
+      ul {
+        list-style-type: none;
+        padding: 0;
+        margin: 0;
+      }
+
+      table td, table th {
+        padding: 8px;
+      }
+
+      td {
+        border-top: solid 1px #ddd;
+      }
+
+      pre {
+        background-color: #ddd;
+        padding: 10px;
+        white-space: pre-wrap;
+      }
+
+      textarea {
+        width: 100%;
+        height: 100px;
+        border: solid 1px #ccc;
+        padding: 10px;
+      }
+
+      .container {
+        max-width: 1000px;
+        margin-left: auto;
+        margin-right: auto;
+      }
+
+      .text-muted {
+        color: #999;
+      }
+
+      #status, .content, .alert {
+        margin-bottom: 20px;
+      }
+
+      .content {
+        padding: 20px 20px 1px 20px;
+        background-color: #eee;
+      }
+
+      .queries td {
+        vertical-align: middle;
+      }
+
+      #status div {
+        margin-bottom: 0;
+      }
+
+      /* nav */
+
+      .nav a {
+        color: #fff;
+        text-decoration: none;
+        display: block;
+        padding: 12px 20px;
+      }
+
+      .nav li.active a {
+        background-color: #df691a;
+      }
+
+      .nav a:hover {
+        background-color: #4e5d6c;
+      }
+
+      /* buttons */
+
+      .btn {
+        display: inline-block;
+        border: none;
+        color: #fff;
+        padding: 12px 20px;
+        font-size: inherit;
+        font-family: inherit;
+        line-height: 1;
+        cursor: pointer;
+        outline: none;
+        margin: 0;
+        -webkit-appearance: none;
+        -webkit-border-radius: 0;
+      }
+
+      .btn-danger {
+        background-color: #df691a;
+      }
+
+      .btn-info {
+        background-color: #5bc0de;
+      }
+
+      /* alerts */
+
+      .alert {
+        padding: 12px 20px;
+        color: #fff;
+      }
+
+      .alert-info {
+        background-color: #5bc0de;
+      }
+
+      .alert-success {
+        background-color: #5cb85c;
+      }
+
+      .alert-warning {
+        background-color: #f0ad4e;
+      }
+
+      .alert-danger {
+        background-color: #df691a;
+      }
+
+      .alert a {
+        color: #fff;
+        text-decoration: none;
+      }
+
+      /*
+        Simple Grid
+        Learn More - http://dallasbass.com/simple-grid-a-lightweight-responsive-css-grid/
+        Project Page - http://thisisdallas.github.com/Simple-Grid/
+        Author - Dallas Bass
+        Site - dallasbass.com
+      */
+
+      *, *:after, *:before {
+        -webkit-box-sizing: border-box;
+        -moz-box-sizing: border-box;
+        box-sizing: border-box;
+      }
+
+      body {
+        margin: 0px;
+      }
+
+      [class*='col-'] {
+        float: left;
+        padding-right: 20px;
+      }
+
+      [class*='col-']:last-of-type {
+        padding-right: 0px;
+      }
+
+      .grid {
+        width: 100%;
+
+        margin: 0 auto;
+        overflow: hidden;
+      }
+
+      .grid:after {
+        content: "";
+        display: table;
+        clear: both;
+      }
+
+      .grid-pad {
+        padding: 20px 0 0px 20px;
+      }
+
+      .grid-pad > [class*='col-']:last-of-type {
+        padding-right: 20px;
+      }
+
+      .push-right {
+        float: right;
+      }
+
+      /* Content Columns */
+
+      .col-1-1 {
+        width: 100%;
+      }
+      .col-2-3, .col-8-12 {
+        width: 66.66%;
+      }
+
+      .col-1-2, .col-6-12 {
+        width: 50%;
+      }
+
+      .col-1-3, .col-4-12 {
+        width: 33.33%;
+      }
+
+      .col-1-4, .col-3-12 {
+        width: 25%;
+      }
+
+      .col-1-5 {
+        width: 20%;
+      }
+
+      .col-1-6, .col-2-12 {
+        width: 16.667%;
+      }
+
+      .col-1-7 {
+        width: 14.28%;
+      }
+
+      .col-1-8 {
+        width: 12.5%;
+      }
+
+      .col-1-9 {
+        width: 11.1%;
+      }
+
+      .col-1-10 {
+        width: 10%;
+      }
+
+      .col-1-11 {
+        width: 9.09%;
+      }
+
+      .col-1-12 {
+        width: 8.33%
+      }
+
+      /* Layout Columns */
+
+      .col-11-12 {
+        width: 91.66%
+      }
+
+      .col-10-12 {
+        width: 83.333%;
+      }
+
+      .col-9-12 {
+        width: 75%;
+      }
+
+      .col-5-12 {
+        width: 41.66%;
+      }
+
+      .col-7-12 {
+        width: 58.33%
+      }
+
+      @media handheld, only screen and (max-width: 767px) {
+
+
+        .grid {
+          width: 100%;
+          min-width: 0;
+          margin-left: 0px;
+          margin-right: 0px;
+          padding-left: 0px;
+          padding-right: 0px;
+        }
+
+        [class*='col-'] {
+          width: auto;
+          float: none;
+          margin-left: 0px;
+          margin-right: 0px;
+          margin-top: 10px;
+          margin-bottom: 10px;
+          padding-right: 0px;
+          padding-left: 0px;
+        }
+      }
+    </style>
+  </head>
+  <body>
+    <div class="container">
+      <div class="alert alert-<%= alert ? "danger" : "info" %>">
+        <% if alert %>
+          <%= alert %>
+        <% elsif notice %>
+          <%= notice %>
+        <% elsif Rails.env.development? %>
+          Do not use development information to make decisions about your production environment
+        <% else %>
+          <%= link_to "QueView", root_path %>
+        <% end %>
+      </div>
+
+      <div class="grid">
+        <div class="col-3-12">
+          <ul class="nav">
+            <li class="<%= controller.action_name == "index" ? "active" : "" %>"><%= link_to "Jobs", root_path %></li>
+          </ul>
+        </div>
+
+        <div class="col-9-12">
+          <%= yield %>
+        </div>
+      </div>
+    </div>
+  </body>
+</html>

data/app/views/que_view/home/index.html.erb

@@ -0,0 +1,36 @@
+<% if @jobs.any? %>
+  <div class="content">
+    <h1>Jobs</h1>
+
+    <p>Scheduled jobs</p>
+
+    <table class="table">
+      <thead>
+        <tr>
+          <th>Priority</th>
+          <th>Run At</th>
+          <th>Job ID</th>
+          <th>Job Class</th>
+          <th>Args</th>
+          <th>Error Count</th>
+          <th>Last Error Message</th>
+          <th>Queue Name</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @jobs.each do |job| %>
+          <tr>
+            <td><%= job.priority %></td>
+            <td><%= job.run_at %></td>
+            <td><%= job.job_id %></td>
+            <td><%= job.job_class %></td>
+            <td><%= job.args %></td>
+            <td><%= job.error_count %></td>
+            <td><%= job.last_error %></td>
+            <td><%= job.queue %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+<% end %>

data/config/routes.rb

@@ -0,0 +1,3 @@
+QueView::Engine.routes.draw do
+  root to: "home#index"
+end

data/gemfiles/activerecord31.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in searchkick.gemspec
+gemspec path: "../"
+
+gem "activerecord", "~> 3.1.0"

data/gemfiles/activerecord32.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in searchkick.gemspec
+gemspec path: "../"
+
+gem "activerecord", "~> 3.2.0"

data/gemfiles/activerecord40.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in searchkick.gemspec
+gemspec path: "../"
+
+gem "activerecord", "~> 4.0.0"

data/lib/que_view/engine.rb

@@ -0,0 +1,5 @@
+module QueView
+  class Engine < ::Rails::Engine
+    isolate_namespace QueView
+  end
+end

data/lib/que_view/version.rb

@@ -0,0 +1,3 @@
+module QueView
+  VERSION = "0.0.1"
+end

data/lib/que_view.rb

@@ -0,0 +1,14 @@
+require "que_view/version"
+require "active_record"
+require "que_view/engine" if defined?(Rails)
+
+module QueView
+  # hack for connection
+  class Connection < ActiveRecord::Base
+    establish_connection ENV["QUEVIEW_DATABASE_URL"] if ENV["QUEVIEW_DATABASE_URL"]
+  end
+
+  class << self
+    # custom queries
+  end
+end

data/que_view.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "que_view/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "que_view"
+  spec.version       = QueView::VERSION
+  spec.authors       = ["Niko Roberts", "Bruno Coelho", "Guy Silva"]
+  spec.email         = ["niko@tasboa.com", "bruno@tasboa.com", "guy@tasboa.com"]
+  spec.summary       = %q{Visibility into scheduled Que tasks}
+  spec.description   = %q{Visibility into scheduled Que tasks}
+  spec.homepage      = "https://github.com/tasboa/que_view"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "que"
+  spec.add_dependency "activerecord"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/test/que_view_test.rb

@@ -0,0 +1,5 @@
+require_relative "spec_helper"
+
+describe QueView do
+  # add tests
+end

data/test/spec_helper.rb

@@ -0,0 +1,39 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= "test"
+
+require File.expand_path("../../config/environment", __FILE__)
+require 'rspec/rails'
+require 'ruby-debug'
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: que_view
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Niko Roberts
+- Bruno Coelho
+- Guy Silva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: que
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Visibility into scheduled Que tasks
+email:
+- niko@tasboa.com
+- bruno@tasboa.com
+- guy@tasboa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/que_view/home_controller.rb
+- app/models/que_view/que_job.rb
+- app/views/layouts/que_view/application.html.erb
+- app/views/que_view/home/index.html.erb
+- config/routes.rb
+- gemfiles/activerecord31.gemfile
+- gemfiles/activerecord32.gemfile
+- gemfiles/activerecord40.gemfile
+- lib/que_view.rb
+- lib/que_view/engine.rb
+- lib/que_view/version.rb
+- que_view.gemspec
+- test/que_view_test.rb
+- test/spec_helper.rb
+homepage: https://github.com/tasboa/que_view
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Visibility into scheduled Que tasks
+test_files:
+- test/que_view_test.rb
+- test/spec_helper.rb