liprug 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c2a0efd0372fc1dcc5d21a8d65d5911fed62e53
+  data.tar.gz: da31cd1f5c7c1a649d5d5bc4e5ea3eeb09eb3844
+SHA512:
+  metadata.gz: d59576b841a9f2b596fd75428baae63413c03011c3a5f8b3281fcd2155394653e6f4771ef20c6c25feed6f9ca4716b7c7142e6a79923721b6f6b373b86020d87
+  data.tar.gz: 86cac38dc47ea2c6c38e148aed5a28cc7361817c22e255b37264e62f602dd7e841a4690b19f5e4c4830bb0e3e9c9ee57d2fe6c4c3c7f88705a969d45dd3bbc89

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    liprug (0.0.1)
+      rdiscount
+      redis
+      sinatra
+      slim
+      unicorn
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    kgio (2.8.0)
+    rack (1.5.2)
+    rack-protection (1.5.0)
+      rack
+    raindrops (0.12.0)
+    rake (10.1.0)
+    rdiscount (2.1.6)
+    redis (3.0.4)
+    sinatra (1.4.3)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    slim (2.0.1)
+      temple (~> 0.6.6)
+      tilt (>= 1.3.3, < 2.1)
+    temple (0.6.6)
+    tilt (1.4.1)
+    unicorn (4.6.3)
+      kgio (~> 2.6)
+      rack
+      raindrops (~> 0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  liprug!
+  rake

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Exoscale
+
+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,42 @@
+liprug: simple status board
+----------------------------
+
+![liprug](http://i.imgur.com/nI9l58i.png)
+
+The idea behind liprug is to give you a simple tool
+to communicate your operational status to clients.
+
+The main objectives behind liprug were:
+
+* Simple deployment compatible with heroku and AWS
+* All-in-one solution
+* Simple administration
+
+### Deployment
+
+You can deploy to heroku or any host provider. It is advised to set up liprug to operate
+behind SSL only.
+
+### Configuration
+
+Configuration is done through environment variables, here are the relevant ones:
+
+* `REDIS_URL` or `REDISTOGO_URL`: url of redis host for storage
+* `LIPRUG_BRAND_HEADER`: text you want shown on the header bar
+* `LIPRUG_BRAND_CONTACT`: if present, a "report issue" button will show up in the bar, with this value as href
+* `LIPRUG_BRAND_SCRIPT`: if present, a script to be inserted in the page, to track analytics for instance
+* `LIPRUG_CREDENTIALS`: colon separated user and password
+
+### Usage
+
+The main URL shows current service status, the `/admin` URL allows input and modifications
+
+### Roadmap
+
+* Additional authentication methods to admin interface
+* Per-service history
+* Typed service data to allow graphs
+
+### Authors
+
+liprug is a production of [exoscale](https://exoscale.ch)

data/Rakefile

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

data/config.ru

@@ -0,0 +1,6 @@
+$stdout.sync = true
+$:.unshift File.dirname(__FILE__) + '/lib'
+
+require 'liprug/service'
+
+run Rack::URLMap.new('/' => Liprug::Service)

data/lib/liprug/config.rb

@@ -0,0 +1,7 @@
+module Liprug
+  class Config
+    def self.[] index
+      ENV[index]
+    end
+  end
+end

data/lib/liprug/model.rb

@@ -0,0 +1,86 @@
+require 'redis'
+require 'json'
+require 'uri'
+require 'liprug/config'
+
+module Liprug
+  class Model
+    def self.connect!
+        url = Liprug::Config['REDISTOGO_URL']
+        url ||= Liprug::Config['REDIS_URL'] 
+        url ||= "redis://127.0.0.1"
+
+	uri = URI.parse(url)
+	options = {:host => uri.host}
+	options[:port] = uri.port if uri.port
+	options[:password] = uri.password if uri.password
+
+	Redis.new(options)
+    end	
+
+    def self.fetch
+      redis = connect!
+      services = redis.smembers 'services'
+      {
+	:brand => {
+          :script => Liprug::Config['LIPRUG_BRAND_SCRIPT'] || '',
+	  :name => Liprug::Config['LIPRUG_BRAND_HEADER'] || 'status board',
+	  :contact => Liprug::Config['LIPRUG_BRAND_CONTACT']
+	},
+        :services => services.map do |service|
+          {
+            service => JSON.parse(redis.get("service:#{service}"),
+                                    :symbolize_names => true)
+          }
+        end.reduce({}) do |e1,e2|
+          e1.merge e2
+        end,
+        :past => redis.lrange('events_past', 0, -1).map do |event|
+          JSON.parse event, :symbolize_names => true
+        end,
+        :upcoming => redis.lrange('events_upcoming', 0, -1).map do |event|
+          JSON.parse event, :symbolize_names => true
+        end
+      }
+    end
+
+    def self.add_status service, status
+      redis = connect!
+      redis.sadd "services", service
+      redis.set "service:#{service}", status.to_json
+    end
+
+    def self.delete_service service
+      redis = connect!
+      redis.srem "services", service
+      redis.del "service:#{service}"
+    end
+    
+    def self.add_upcoming_event event
+      redis = connect!
+      event[:date] = Time.new.asctime
+      event = event.to_json
+      redis.lpush "events_upcoming", event
+    end
+
+    def self.add_past_event event
+      redis = connect!
+      event[:date] = Time.new.asctime
+      event = event.to_json
+      redis.lpush "events_past", event
+    end
+
+    def self.delete_upcoming_event index
+      redis = connect!
+      redis.lset "events_upcoming", index, "XXXXX"
+      redis.lrem "events_upcoming", 1, "XXXXX"
+    end
+
+    def self.delete_past_event index
+      redis = connect!
+      redis.lset "events_past", index, "XXXXX"
+      redis.lrem "events_past", 1, "XXXXX"
+    end
+
+  end
+end

data/lib/liprug/public/js/app.js

@@ -0,0 +1,33 @@
+$(document).ready(function () {
+    $("td.delete-service").each(function(index, el) {
+	var b = $(el).find("button");
+	var id = b.attr("id");
+	b.click(function (ev) {
+	    ev.preventDefault();
+	    $.ajax({url: '/api/services/' + id,
+		    type: 'DELETE'});
+	});
+    });
+
+    $("td.delete-past-event").each(function(index, el) {
+
+	var b = $(el).find("button");
+	var id = b.attr("id");
+	b.click(function (ev) {
+	    ev.preventDefault();
+	    $.ajax({url: '/api/past/' + id,
+		    type: 'DELETE'});
+	});
+    });
+
+    $("td.delete-upcoming-event").each(function(index, el) {
+
+	var b = $(el).find("button");
+	var id = b.attr("id");
+	b.click(function (ev) {
+	    ev.preventDefault();
+	    $.ajax({url: '/api/upcoming/' + id,
+		    type: 'DELETE'});
+	});
+    });
+});

data/lib/liprug/service/helpers.rb

@@ -0,0 +1,21 @@
+require 'sinatra'
+require 'liprug/config'
+
+module Liprug
+  class Service < Sinatra::Base
+    helpers do
+
+      def authorized?
+        creds = (Liprug::Config['LIPRUG_CREDENTIALS'] || ":").split ":"
+        @auth ||=  Rack::Auth::Basic::Request.new(request.env)
+        @auth.provided? and @auth.basic? and @auth.credentials and @auth.credentials == creds
+      end
+
+      def protected!
+        return if authorized?
+        headers['WWW-Authenticate'] = 'Basic realm="Restricted Area"'
+        halt 401, "Not authorized"
+      end
+    end
+  end
+end

data/lib/liprug/service/routes.rb

@@ -0,0 +1,67 @@
+require 'sinatra'
+require 'rdiscount'
+require 'slim'
+require 'liprug/model'
+require 'liprug/service/helpers'
+
+module Liprug
+  class Service < Sinatra::Base
+    
+    get '/' do
+      slim :overview, :locals => Liprug::Model.fetch
+    end
+
+    get '/admin' do
+      protected!
+      slim :admin, :locals => Liprug::Model.fetch
+    end
+
+    post '/api/services' do
+      protected!
+      Liprug::Model.add_status(params[:name],
+                               {
+                                 :class => params[:class],
+                                 :message => params[:message]
+                               })
+      redirect "/admin"
+    end
+
+    delete '/api/services/:service' do
+      protected!
+      Liprug::Model.delete_service params[:service]
+      redirect "/admin"
+    end
+
+    post '/api/past' do
+      protected!
+      Liprug::Model.add_past_event({
+                                     :class => params[:class],
+                                     :message => params[:message]
+                                   })
+      redirect "/admin"
+    end
+
+    post '/api/upcoming' do
+      protected!
+      Liprug::Model.add_upcoming_event({
+                                         :class => params[:class],
+                                         :message => params[:message]
+                                       })
+      redirect "/admin"
+    end
+    
+    delete '/api/past/:event' do
+      protected!
+      Liprug::Model.delete_past_event params[:event].to_i
+
+      redirect "/admin"
+    end
+    
+    delete '/api/upcoming/:event' do
+      protected!
+      Liprug::Model.delete_upcoming_event params[:event].to_i
+
+      redirect "/admin"
+    end
+  end
+end

data/lib/liprug/service.rb

@@ -0,0 +1,9 @@
+require 'sinatra'
+module Liprug
+  class Service < Sinatra::Base
+
+    require 'liprug/model'
+    require 'liprug/service/helpers'
+    require 'liprug/service/routes'
+  end
+end

data/lib/liprug/version.rb

@@ -0,0 +1,3 @@
+module Liprug
+  VERSION = "0.0.2"
+end

data/lib/liprug/views/admin.slim

@@ -0,0 +1,118 @@
+doctype html
+html
+  head
+    title Status Board
+    meta name="viewport" content="width=device-width, initial-scale=1.0"
+    link rel="stylesheet" type="text/css" href="//netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap.min.css"
+  body
+
+    nav.navbar.navbar-default role="navigation"
+      div.navbar-header
+        a.navbar-brand href="/" status admin
+
+    div.container
+      div.row
+
+        div.col-md-8.col-md-offset-2
+
+          h2 Services
+
+          form.form-horizontal role="form" method="POST" action="/api/services"
+            div.form-group
+              label.col-lg-2.control-label for="name" Service Name
+              div.col-lg-6
+                input.form-control type="text" id="name" name="name"
+            div.form-group
+              label.col-lg-2.control-label for="class" Status class
+              div.col-lg-6
+                div
+                  input type="radio" id="class" name="class" value="success" success
+                div
+                  input type="radio" id="class" name="class" value="danger" danger
+                div
+                  input type="radio" id="class" name="class" value="warning" warning
+            div.form-group
+              label.col-lg-2.control-label for="message" Message
+              div.col-lg-6
+                input.form-control type="text" id="message" name="message"
+            div.form-group
+              div.col-lg-offset-2.col-lg-6
+                button.btn.btn-default type="submit" update
+
+          table.table.table-bordered.table-striped
+            tbody
+              - for name,status in services do
+                tr
+                  td #{name}
+                  td.delete-service
+                    button.btn.btn-primary.pull-right id="#{name}"
+                      span.glyphicon.glyphicon-trash
+                        |  delete
+
+          h2 Upcoming Events
+
+          form.form-horizontal role="form" method="POST" action="/api/upcoming"
+            div.form-group
+              label.col-lg-2.control-label for="class" Status class
+              div.col-lg-6
+                div
+                  input type="radio" id="event-class" name="class" value="info" info
+                div
+                  input type="radio" id="event-class" name="class" value="success" success
+                div
+                  input type="radio" id="event-class" name="class" value="danger" danger
+                div
+                  input type="radio" id="event-class" name="class" value="warning" warning
+            div.form-group
+              label.col-lg-2.control-label for="message" Message
+              div.col-lg-6
+                textarea.form-control id="event-message" name="message"
+            div.form-group
+              div.col-lg-offset-2.col-lg-6
+                button.btn.btn-default type="submit" update
+
+          table.table.table-bordered.table-striped
+            tbody
+              - for event, index in upcoming.each_with_index do
+                tr
+                  td #{event[:message]}
+                  td.delete-upcoming-event
+                    button.btn.btn-primary.pull-right id="#{index}"
+                      span.glyphicon.glyphicon-trash
+                        |  delete
+                          
+          h2 Past Events
+
+          form.form-horizontal role="form" method="POST" action="/api/past"
+            div.form-group
+              label.col-lg-2.control-label for="class" Status class
+              div.col-lg-6
+                div
+                  input type="radio" id="event-class" name="class" value="info" info
+                div
+                  input type="radio" id="event-class" name="class" value="success" success
+                div
+                  input type="radio" id="event-class" name="class" value="danger" danger
+                div
+                  input type="radio" id="event-class" name="class" value="warning" warning
+            div.form-group
+              label.col-lg-2.control-label for="message" Message
+              div.col-lg-6
+                textarea.form-control id="event-message" name="message"
+            div.form-group
+              div.col-lg-offset-2.col-lg-6
+                button.btn.btn-default type="submit" update
+
+          table.table.table-bordered.table-striped
+            tbody
+              - for event, index in past.each_with_index do
+                tr
+                  td #{event[:message]}
+                  td.delete-past-event
+                    button.btn.btn-primary.pull-right id="#{index}"
+                      span.glyphicon.glyphicon-trash
+                        |  delete
+
+
+          script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"
+          script type="text/javascript" src="/js/app.js"

data/lib/liprug/views/overview.slim

@@ -0,0 +1,73 @@
+doctype html
+html
+  head
+    title Status Board
+    meta name="viewport" content="width=device-width, initial-scale=1.0"
+    link rel="stylesheet" type="text/css" href="//netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap.min.css"
+  body
+
+    style type="text/css"
+      | .bs-callout {
+      |   margin: 20px 0;
+      |   padding: 15px 30px 15px 15px;
+      |   border-left: 5px solid #eee;
+      | }
+      | .bs-callout h4 { margin-top: 0; }
+      | .bs-callout p:last-child { margin-bottom: 0; }
+      | .bs-callout code, .bs-callout .highlight {background-color: #fff;}
+      | .bs-callout-danger {background-color: #fcf2f2; border-color: #dFb5b4;}
+      | .bs-callout-warning {background-color: #fefbed; border-color: #f1e7bc;}
+      | .bs-callout-info {background-color: #f0f7fd; border-color: #d0e3f0;}
+      | .bs-callout-success {background-color: #dff0d8; border-color: #d6e9c6;}
+
+    == brand[:script]
+
+    nav.navbar.navbar-default role="navigation"
+      div.navbar-header
+        button.navbar-toggle data-toggle="collapse" data-target=".navbar-main-collapse"
+          span.sr-only Toggle Navigation
+          span.icon-bar
+          span.icon-bar
+          span.icon-bar
+        a.navbar-brand href="/" #{brand[:name]}
+          
+      - if brand[:contact]
+        nav.collapse.navbar-collapse.navbar-main-collapse role="navigation"
+          a.navbar-btn.navbar-right.btn.btn-info.btn-sm href="#{brand[:contact]}" Report issue
+
+    div.container
+      div.row
+        div.col-md-8.col-md-offset-2
+          h2 Services
+
+          table.table.table-bordered.table-striped
+            thead
+              tr
+                th Service
+                th Status
+            tbody
+              - for name in services.keys.sort do
+                tr
+                  td #{name}
+                  td class="#{services[name][:class]}"
+                    | #{services[name][:message]}
+
+          h2 Upcoming Events
+          - for event in upcoming do
+            div class="bs-callout bs-callout-#{event[:class]}"
+              p
+                small
+                  i On #{event[:date]}
+                div
+                  == RDiscount.new(event[:message]).to_html
+          h2 Latest Events
+          - for event in past do
+            div class="bs-callout bs-callout-#{event[:class]}"
+              p
+                small
+                  i On #{event[:date]}
+                div
+                  == RDiscount.new(event[:message]).to_html
+    script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"
+    script type="text/javascript" src="//netdna.bootstrapcdn.com/bootstrap/3.0.0/js/bootstrap.min.js"
+      

data/lib/liprug.rb

@@ -0,0 +1,6 @@
+require "liprug/version"
+require "liprug/service"
+
+module Liprug
+  # Your code goes here...
+end

data/liprug.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'liprug/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "liprug"
+  spec.version       = Liprug::VERSION
+  spec.authors       = ["Pierre-Yves Ritschard"]
+  spec.email         = ["pyr@spootnik.org"]
+  spec.description   = %q{simple operational dashboard}
+  spec.summary       = %q{operational dashboard}
+  spec.homepage      = "https://github.com/exoscale/liprug"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "sinatra"
+  spec.add_dependency "slim"
+  spec.add_dependency "redis"
+  spec.add_dependency "rdiscount"
+  spec.add_dependency "unicorn"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: liprug
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Pierre-Yves Ritschard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: slim
+  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: redis
+  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: rdiscount
+  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: unicorn
+  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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: simple operational dashboard
+email:
+- pyr@spootnik.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- config.ru
+- lib/liprug.rb
+- lib/liprug/config.rb
+- lib/liprug/model.rb
+- lib/liprug/public/js/app.js
+- lib/liprug/service.rb
+- lib/liprug/service/helpers.rb
+- lib/liprug/service/routes.rb
+- lib/liprug/version.rb
+- lib/liprug/views/admin.slim
+- lib/liprug/views/overview.slim
+- liprug.gemspec
+homepage: https://github.com/exoscale/liprug
+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.0.0
+signing_key: 
+specification_version: 4
+summary: operational dashboard
+test_files: []