focuslight 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fbeba2724566d237bb40f671a73cdb4d65af7207
+  data.tar.gz: 6b27bc30fa0a0b60e604aa8dc5d306a1adb5e0c4
+SHA512:
+  metadata.gz: c9de2d208beecf0709727c1dd03c0d89455dd839fe2432288558367579d98fdb42950ead758e241725b39899e763ef0189271be3abefdecbc213db091cce7969
+  data.tar.gz: 4eeea83871b409b5788b89e24d71e2c8fb57ada42c7012779b032929efcebc958bd64d33544ce8542a5e3b4cca33fd827974bc0a44869f18386aabdc8b4566c7

data/.env

@@ -0,0 +1,13 @@
+DATADIR=./data
+PORT=5125
+HOST=0.0.0.0
+# FRONT_PROXY
+# ALLOW_FROM
+# 1MIN_METRICS=n
+FLOAT_SUPPORT=n # y
+DBURL=sqlite://data/gforecast.db
+# DBURL=mysql2://root:@localhost/focuslight
+# RRDCACHED=n
+# MOUNT=/
+LOG_PATH=log/application.log
+LOG_LEVEL=warn

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+data/
+.ruby-version
+log/
+*.log

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 2.0.0
+  - 2.1.0
+gemfile:
+  - Gemfile
+before_install:
+  - sudo apt-get install rrdtool librrd-dev
+before_script:
+  - bundle exec rake init

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# 0.1.1 (2014/02/27)
+
+Enhancements:
+
+* Use sequel database engine #17 and Support mysql #20 (thanks to koichiro)
+* Remove subtract feature and improve performance #19
+* Logger support #22
+* Gemify focuslight #25 (thanks to koichiro)
+
+Fixes:
+
+* Fix Procfile name #4
+* Fix color update #6 (thanks to eagletmt)
+* Prepare datadir by mkdir_p #7 (thanks to eagletmt)
+* Fix hash key #9 (thanks to u-ichi)
+* Fix graph_id typo #10 (thanks to u-ichi)
+* Fix JSON API #11 #12 #13 #14 #15 #16
+
+# 0.1.0
+
+Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TAGOMORI Satoshi
+
+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/Procfile

@@ -0,0 +1,3 @@
+web: bundle exec unicorn -E production -p $PORT -o $HOST
+worker1: bundle exec rake longer
+worker2: bundle exec rake shorter

data/Procfile-gem

@@ -0,0 +1,3 @@
+web: unicorn -E production -p $PORT -o $HOST
+worker1: rake longer
+worker2: rake shorter

data/README.md

@@ -0,0 +1,162 @@
+# Focuslight
+
+[![Build Status](https://travis-ci.org/focuslight/focuslight.png?branch=master)](https://travis-ci.org/focuslight/focuslight)
+
+Focuslight is a lightning Fast Graphing/Visualization tool, built on RRDTool. It is a Ruby clone of [GrowthForecast](http://kazeburo.github.io/GrowthForecast/).
+
+Focuslight is compatible with:
+ * stored data files
+   * database (sqlite) and graphs (rrdtool)
+ * almost all HTTP API requests, except for:
+   * `export` support
+ * almost all of features, except for:
+   * `subtract` support (`gmode`, `stype`, `sllimit`, `sulimit` parameters)
+
+## Prerequisites
+
+RRDTool and its dependencies must be installed before installing Focuslight.
+
+* RHEL/CentOS 6.x
+  * Add `epel` repository, then `sudo yum install rrdtool rrdtool-devel`
+* Ubuntu
+  * `sudo apt-get install rrdtool librrd-dev`
+* OSX
+  * `brew install rrdtool`
+
+## Installation
+
+Install focuslight with Ruby 2.0 or later. Execute after installation.
+
+### Using gem package
+
+Four easy steps installation with gem.
+
+1. `gem install focuslight`
+2. `focuslight new`  # creates focuslight resource in `pwd`/focuslight
+3. `focuslight init` # creates database scheme
+4. `focuslight start`
+
+Then see `http://localhost:5125/`
+
+### Using SQLite:
+
+1. clone this repository
+1. `cd focuslight`
+1. install dependencies: `bundle install`
+1. initialize database: `bundle exec rake init`
+1. execute: `bundle exec foreman start`
+
+Then see `http://localhost:5125/`
+
+### Using MySQL:
+
+You need to change DBURL parameter on .env file to `mysql2` version. 
+You may also configure the database name, the user name, and the password. See the Configuration section. 
+
+Then, create the database and assign permissions to the user as
+
+```
+mysql> CREATE DATABASE focuslight;
+mysql> GRANT  CREATE, ALTER, DELETE, INSERT, UPDATE, SELECT \\
+  ON focuslight.* TO 'user'\@'localhost' IDENTIFIED BY password;
+```
+
+Then, do the same thing with SQLite case. 
+
+## Configuration
+
+To configure Focuslight, edit the `.env` file in the project root directory.
+
+The default configuration is as follows:
+
+```
+DATADIR=./data
+PORT=5125
+HOST=0.0.0.0
+# FRONT_PROXY
+# ALLOW_FROM
+# 1MIN_METRICS=n
+FLOAT_SUPPORT=n # y
+DBURL=sqlite://data/gforecast.db
+# DBURL=mysql2://root:@localhost/focuslight
+# RRDCACHED=n
+# MOUNT=/
+LOG_PATH=log/application.log
+LOG_LEVEL=warn
+```
+
+## Switch from GrowthForecast
+
+1. Copy GrowthForecast's `datadir` directory (and its contents) to `./data` (or where you specified)
+1. Execute Focuslight
+
+## TODO
+
+* Merge GrowthForecast's commits after Jan 09, 2014
+  * api endpoint link label
+* RRDCached support
+* Front proxies and source address restrictions
+* HTTP API mount point support
+* Daemonize support
+* Add tests, and tests, and more tests
+
+## Imcompatible Features
+
+Focuslight has following incompatibilitie with GrowthForecast as specifications.
+
+### Subtract
+
+[GrowthForecast](http://kazeburo.github.io/GrowthForecast/index.html) has subtract graph support (gmode=subtract),
+but focuslight does not have it because subtract graphs can be created using mode=derive like:
+
+```
+curl -d "number=10&mode=derive" http://localhost:5125/api/service/section/graph
+```
+
+As a demo, you may run following shell codes.
+The number is incremental, but derive graph shows you the difference as a graph, which results in 1 in this demo.
+
+```
+number=1
+while true; do
+  curl -d "number=${number}&mode=derive" http://localhost:5125/api/service/section/graph
+  number=$((number+1))
+  sleep 60
+done
+```
+
+In addition, because focuslight does not support subtract graphs, `gmode`, `stype`, `sllimit`, and `sulimit`
+parameters on HTTP APIs are not available. In the case of POST (create, edit), they are ignored.
+In the case of GET, they are not returned.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2014- tagomoris
+
+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/Rakefile

@@ -0,0 +1,37 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ["-c", "-f progress"] # '--format specdoc'
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dotenv/tasks'
+require "focuslight/worker"
+
+task :init => :dotenv do
+  require "focuslight/init"
+  Focuslight::Init.run
+end
+
+task :console => :dotenv do
+  require "focuslight/init"
+  require 'irb'
+  # require 'irb/completion'
+  ARGV.clear
+  IRB.start
+end
+task :c => :console
+
+task :longer => :dotenv do
+  Focuslight::Worker.run(interval: 300, target: :normal)
+end
+
+task :shorter => :dotenv do
+  Focuslight::Worker.run(interval: 60, target: :short)
+end
+
+task :test => :spec
+task :default => :spec

data/bin/focuslight

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require "focuslight/cli"
+
+Focuslight::CLI.start

data/config.ru

@@ -0,0 +1,6 @@
+require "rubygems"
+require "sinatra"
+
+require File.expand_path '../lib/focuslight/web.rb', __FILE__
+
+run Focuslight::Web

data/focuslight.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'focuslight/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "focuslight"
+  spec.version       = Focuslight::VERSION
+  spec.authors       = ["TAGOMORI Satoshi", "Naotoshi Seo", "Shota Fukumori (sora_h)"]
+  spec.email         = ["tagomoris@gmail.com", "sonots@gmail.com", "her@sorah.jp"]
+  spec.description   = %q{Ruby port of GrowthForecast}
+  spec.summary       = %q{Lightning Fast Graphing/Visualization}
+  spec.homepage      = "https://github.com/tagomoris/focuslight"
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
+
+  spec.add_runtime_dependency "rake" #TODO: daemon execution without rake
+  spec.add_runtime_dependency "dotenv"
+  spec.add_runtime_dependency "foreman"
+  spec.add_runtime_dependency "thor"
+
+  spec.add_runtime_dependency "sinatra"
+  spec.add_runtime_dependency "sinatra-contrib"
+  spec.add_runtime_dependency "erubis"
+  spec.add_runtime_dependency "unicorn"
+
+  spec.add_runtime_dependency "sequel"
+  spec.add_runtime_dependency "sqlite3"
+  spec.add_runtime_dependency "mysql2"
+  spec.add_runtime_dependency "librrd"
+  spec.add_runtime_dependency "rrd-ffi"
+end

data/lib/focuslight.rb

@@ -0,0 +1,6 @@
+require 'dotenv'
+Dotenv.load
+require "focuslight/version"
+
+module Focuslight
+end

data/lib/focuslight/cli.rb

@@ -0,0 +1,56 @@
+require "fileutils"
+require "dotenv"
+require "thor"
+
+require "focuslight"
+
+class Focuslight::CLI < Thor
+  BASE_DIR = File.join(Dir.pwd, "focuslight")
+  DATA_DIR = File.join(BASE_DIR, "data")
+  DBURL = "sqlite://#{File.join(DATA_DIR, "gforecast.db")}"
+  LOG_DIR = File.join(BASE_DIR, "log")
+  LOG_FILE = File.join(LOG_DIR, "application.log")
+  ENV_FILE = File.join(BASE_DIR, ".env")
+
+  DEFAULT_DOTENV =<<-EOS
+DATADIR=#{DATA_DIR}
+PORT=5125
+HOST=0.0.0.0
+# FRONT_PROXY
+# ALLOW_FROM
+# 1MIN_METRICS=n
+FLOAT_SUPPORT=n # y
+DBURL=#{DBURL}
+# DBURL=mysql2://root:@localhost/focuslight
+# RRDCACHED=n
+# MOUNT=/
+LOG_PATH=#{LOG_FILE}
+LOG_LEVEL=warn
+EOS
+
+  default_command :start
+
+  desc "new", "Creating focuslight resource directory"
+  def new
+    FileUtils.mkdir_p(LOG_DIR)
+    File.write ENV_FILE, DEFAULT_DOTENV
+  end
+
+  desc "init", "Creating database schema"
+  def init
+    raise "Run `focuslight new` first" unless File.exist? ENV_FILE
+    Dotenv.load ENV_FILE
+    require "focuslight/init"
+    Focuslight::Init.run
+  end
+
+  desc "start", "Sartup focuslight server"
+  def start
+    raise "Run `focuslight new` first" unless File.exist? ENV_FILE
+
+    Dotenv.load ENV_FILE
+    require "foreman/cli"
+    procfile = File.expand_path("../../../Procfile-gem", __FILE__)
+    Foreman::CLI.new.invoke(:start, [], procfile: procfile)
+  end
+end