clockwork_web 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d4554a13250d7249b7074982f164055299db2de
+  data.tar.gz: 079e42ce8ce88456cc44d5000a085a88e2c16ce7
+SHA512:
+  metadata.gz: 6ba42432d2220db8080cfc978a4c0a39a9f6e0ababe50d6218b976a061b518e8ff75fe1d5858497123262b24ef09922acd3e81e1dd19c0d80d67347ab3799858
+  data.tar.gz: 5dc43184b56bc5b15cf5716d4209cf91c05491b2cac070e55eaee6ab90a0d2049e2a4d6eb2efddb5e033161662825a3b5550d47684a01c724126b4443917b40c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Andrew Kane
+
+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,62 @@
+# Clockwork Web
+
+A web interface for [Clockwork](https://github.com/tomykaira/clockwork)
+
+- see list of jobs
+- see last run
+- disable jobs
+
+Screenshot, demo, and better UI coming soon
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'clockwork_web'
+```
+
+And add it to your `config/routes.rb`.
+
+```ruby
+mount ClockworkWeb::Engine, at: "clockwork"
+```
+
+Be sure to secure the dashboard in production.
+
+To see the last run and disable jobs, hook up Redis.
+
+```ruby
+ClockworkWeb.redis = Redis.new
+```
+
+#### Basic Authentication
+
+Set the following variables in your environment or an initializer.
+
+```ruby
+ENV["CLOCKWORK_USERNAME"] = "andrew"
+ENV["CLOCKWORK_PASSWORD"] = "secret"
+```
+
+#### Devise
+
+```ruby
+authenticate :user, lambda {|user| user.admin? } do
+  mount ClockworkWeb::Engine, at: "clockwork"
+end
+```
+
+## TODO
+
+- demo
+- better design
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/clockwork_web/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/clockwork_web/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/app/controllers/clockwork_web/home_controller.rb

@@ -0,0 +1,24 @@
+module ClockworkWeb
+  class HomeController < ActionController::Base
+    layout false
+    helper ClockworkWeb::HomeHelper
+
+    http_basic_authenticate_with name: ENV["CLOCKWORK_USERNAME"], password: ENV["CLOCKWORK_PASSWORD"] if ENV["CLOCKWORK_PASSWORD"]
+
+    def index
+      @events = Clockwork.manager.instance_variable_get(:@events).sort_by{|e| [e.instance_variable_get(:@period), e.job.to_s] }
+      # TODO fetch all disabled jobs and last runs in one call
+    end
+
+    def job
+      job = params[:job]
+      if params[:enable] == "true"
+        ClockworkWeb.enable(job)
+      else
+        ClockworkWeb.disable(job)
+      end
+      redirect_to root_path
+    end
+
+  end
+end

data/app/helpers/clockwork_web/home_helper.rb

@@ -0,0 +1,27 @@
+module ClockworkWeb
+  module HomeHelper
+
+    def friendly_period(period)
+      if period % 1.day == 0
+        "#{period / 1.day} day"
+      elsif period % 1.hour == 0
+        "#{period / 1.hour} hour"
+      elsif period % 1.minute == 0
+        "#{period / 1.minute} min"
+      else
+        "#{period} sec"
+      end
+    end
+
+    def last_run(event)
+      if ClockworkWeb.redis
+        # TODO get all events at once
+        timestamp = ClockworkWeb.redis.get("clockwork:last_run:#{event.job}")
+        if timestamp
+          time_ago_in_words(Time.at(timestamp.to_i))
+        end
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,88 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Clockwork</title>
+
+    <meta charset="utf-8" />
+
+    <style>
+      body {
+        font-family: "Helvetica Neue", Arial, Helvetica, sans-serif;
+        margin: 0;
+        padding: 20px;
+        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;
+      }
+
+      table td, table th {
+        padding: 8px;
+      }
+
+      td {
+        border-top: solid 1px #ddd;
+      }
+
+      .disabled {
+        background-color: pink;
+      }
+    </style>
+  </head>
+  <body>
+    <div class="container">
+      <table>
+        <thead>
+          <tr>
+            <th>Job</th>
+            <th style="width: 15%;">Period</th>
+            <th style="width: 15%;">Last Run</th>
+            <th style="width: 15%;">Action</th>
+          </tr>
+        </thead>
+        <tbody>
+          <% @events.each do |event| %>
+            <% enabled = ClockworkWeb.enabled?(event.job) %>
+            <tr class="<%= enabled ? "" : "disabled" %>">
+              <td><%= event.job %></td>
+              <td>
+                <%= friendly_period(event.instance_variable_get(:@period)) %>
+                <% at = event.instance_variable_get(:@at) %>
+                <% if at %>
+                  <div>
+                    <!-- TODO better format -->
+                    min: <%= at.instance_variable_get(:@min) %>
+                    hour: <%= at.instance_variable_get(:@hour) %>
+                    wday: <%= at.instance_variable_get(:@wday) %>
+                  </div>
+                <% end %>
+              </td>
+              <td><%= last_run(event) %></td>
+              <td><%= button_to enabled ? "Disable" : "Enable", home_job_path(job: event.job, enable: !enabled) %></td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+  </body>
+</html>

data/clockwork_web.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clockwork_web/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clockwork_web"
+  spec.version       = ClockworkWeb::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+  spec.summary       = %q{A web interface for Clockwork}
+  spec.description   = %q{A web interface for Clockwork}
+  spec.homepage      = "https://github.com/ankane/clockwork_web"
+  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 "clockwork"
+  spec.add_dependency "robustly"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+ClockworkWeb::Engine.routes.draw do
+  post "home/job"
+  root to: "home#index"
+end

data/lib/clockwork_web/engine.rb

@@ -0,0 +1,9 @@
+module ClockworkWeb
+  class Engine < ::Rails::Engine
+    isolate_namespace ClockworkWeb
+
+    initializer "clockwork_web" do |app|
+      require Rails.root.join("clock") # hacky
+    end
+  end
+end

data/lib/clockwork_web/version.rb

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

data/lib/clockwork_web.rb

@@ -0,0 +1,43 @@
+require "clockwork_web/version"
+
+# dependencies
+require "clockwork"
+require "robustly"
+
+# engine
+require "clockwork_web/engine"
+
+module ClockworkWeb
+  class << self
+    attr_accessor :redis
+  end
+
+  def self.enable(job)
+    ClockworkWeb.redis.del("clockwork:disabled:#{job}")
+    true
+  end
+
+  def self.disable(job)
+    ClockworkWeb.redis.set("clockwork:disabled:#{job}", 1)
+    true
+  end
+
+  def self.enabled?(job)
+    !ClockworkWeb.redis.exists("clockwork:disabled:#{job}")
+  end
+end
+
+module Clockwork
+  on(:before_run) do |t|
+    run = true
+    safely do
+      if ClockworkWeb.redis
+        run = ClockworkWeb.enabled?(t.job)
+        if run
+          ClockworkWeb.redis.set("clockwork:last_run:#{t.job}", Time.now.to_i)
+        end
+      end
+    end
+    run
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: clockwork_web
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: clockwork
+  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: robustly
+  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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A web interface for Clockwork
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/clockwork_web/home_controller.rb
+- app/helpers/clockwork_web/home_helper.rb
+- app/views/clockwork_web/home/index.html.erb
+- clockwork_web.gemspec
+- config/routes.rb
+- lib/clockwork_web.rb
+- lib/clockwork_web/engine.rb
+- lib/clockwork_web/version.rb
+homepage: https://github.com/ankane/clockwork_web
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A web interface for Clockwork
+test_files: []