fnordmetric 0.6.6 → 0.7.0

data/README.md

@@ -5,7 +5,7 @@ FnordMetric is a highly configurable (and pretty fast) realtime app/event
 tracking thing based on ruby eventmachine and redis. You define your own 
 plotting and counting functions as ruby blocks!
 
-[ ![Build status - Travis-ci](https://secure.travis-ci.org/paulasmuth/fnordmetric.png) ](http://travis-ci.org/paulasmuth/fnordmetric) [ ![Dependency status - Gemnasium](https://gemnasium.com/paulasmuth/fnordmetric.png) ](https://gemnasium.com/paulasmuth/fnordmetric)
+[ ![Build status - Travis-ci](https://secure.travis-ci.org/paulasmuth/fnordmetric.png) ](http://travis-ci.org/paulasmuth/fnordmetric)
 
 [SCREENCAST][2]: the FnordMetric-instance we use to track our social dating app.
 
@@ -105,8 +105,8 @@ The fast way: Add your event directly to the redis-based queue.
 uuid = (8**32).to_s(36)
 event = { :_type => "unicorn_seen" }.to_json
 
-redis.set("fnordmetric-event-#{my_uuid}", event)
-redis.expire("fnordmetric-event-#{my_uuid}", 60)
+redis.set("fnordmetric-event-#{uuid}", event)
+redis.expire("fnordmetric-event-#{uuid}", 60)
 redis.lpush("fnordmetric-queue", uuid)
 ```
 
@@ -163,10 +163,6 @@ Call these methods from the event-handler block
 
 ----
 
-### Options: Gauges ###
-
-----
-
 ### Options: Widgets ###
 
 + `[autoupdate]` auto-refresh the timeline every n secs (0 turns autoupdate off)
@@ -185,7 +181,15 @@ BarsWidget
 
 ----
 
-### JSON API ###
+
+Resources
+----------
+
++ [PHP API for FnordMetric (github.com/leemachin/fnordmetric-php-api)](https://github.com/leemachin/fnordmetric-php-api)
++ [Python API for FnordMetric (github.com/sholiday/pyfnordmetric)](https://github.com/sholiday/pyfnordmetric)
++ [FnordMetric and C (Blog/Howto)](http://johnmurray.io/log/2012/01/19/FnordMetrics-and-C%23.md)
+
++ [The "fnordmetric" google group](http://groups.google.com/group/fnordmetric)
 
 
 Examples
@@ -343,6 +347,8 @@ Contributors
 + Kacper Bielecki (http://github.com/kazjote)
 + John Murray (http://github.com/JohnMurray)
 + Lars Gierth (http://github.com/lgierth)
++ Ross Kaffenberger (http://github.com/rossta)
++ Kunal Modi (http://github.com/kunalmodi)
 
 To contribute, please fork this repository, make your changes and run the 
 specs, commit them to your github repository and send me a pull request.

data/haml/app.haml

@@ -1,4 +1,4 @@
-!!!	
+!!!
 %html
 
   %head
@@ -18,7 +18,7 @@
       %ul
         -namespaces.each do |key,namespace|
           %li{:class => namespace.token == current_namespace.token ? 'active' : nil}
-            %a{:href=>"/#{namespace.token}"}=h namespace.title
+            %a{:href=> "#{path_prefix}/#{namespace.token}"}=h namespace.title
 
     #wrap
       #tabs
@@ -35,7 +35,7 @@
 
       #viewport
         .viewport_inner.clearfix
-            
+
 
 :javascript
   $(document).ready(function(){
@@ -56,9 +56,9 @@
       $(this).addClass('active').siblings().removeClass('active');
     });
 
-    function resizeViewport(){ 
+    function resizeViewport(){
       var viewport_width = window.innerWidth-220
-      $('#viewport').width(viewport_width); 
+      $('#viewport').width(viewport_width);
       FnordMetric.resizeView();
     }
 
@@ -68,7 +68,7 @@
     if(!#{current_namespace.active_users_available.to_s}) {
       $('#tabs li:first').trigger('click');
     }
-    
+
     if(window.location.hash){
       $('#tabs li.dashboard[rel="'+window.location.hash.slice(1)+'"]').trigger('click');
     }

data/lib/fnordmetric.rb

@@ -20,37 +20,33 @@ module FnordMetric
   def self.server_configuration=(configuration)
     @@server_configuration = configuration
   end
-  
-  def self.default_options(opts)
 
-    opts[:redis_url] ||= "redis://localhost:6379"
-    opts[:redis_prefix] ||= "fnordmetric"
-
-    opts[:inbound_stream] ||= ["0.0.0.0", "1337"]
-    opts[:web_interface] ||= ["0.0.0.0", "4242"]
-    opts[:web_interface_server] ||= "thin"
-
-    opts[:start_worker] ||= true
-    opts[:print_stats] ||= 3
-
-    # events that aren't processed after 2 min get dropped
-    opts[:event_queue_ttl] ||= 120
-
-    # event data is kept for one month
-    opts[:event_data_ttl] ||= 3600*24*30
-
-    # session data is kept for one month
-    opts[:session_data_ttl] ||= 3600*24*30
+  def self.default_options(opts = {})
+    {
+      :redis_url => "redis://localhost:6379",
+      :redis_prefix => "fnordmetric",
+      :inbound_stream => ["0.0.0.0", "1337"],
+      :web_interface => ["0.0.0.0", "4242"],
+      :web_interface_server => "thin",
+      :start_worker => true,
+      :print_stats => 3,
+      :event_queue_ttl => 120,
+      :event_data_ttl => 3600*24*30,
+      :session_data_ttl => 3600*24*30
+    }.merge(opts)
+  end
 
-    opts
+  def self.options(opts = {})
+    default_options(@@server_configuration || {}).merge(opts)
   end
 
-  def self.start_em(opts)
+  def self.start_em(opts = {})
     EM.run do
 
       trap("TERM", &method(:shutdown))
       trap("INT",  &method(:shutdown))
 
+      opts = options(opts)
       app = embedded(opts)
 
       if opts[:web_interface]
@@ -77,11 +73,10 @@ module FnordMetric
   end
 
   def self.run
-    opts = (defined?(@@server_configuration) && @@server_configuration) || {}
-    start_em(opts) 
+    start_em
   rescue Exception => e
     log "!!! eventmachine died, restarting... #{e.message}"
-    sleep(1); run 
+    sleep(1); run
   end
 
   def self.shutdown
@@ -113,7 +108,7 @@ module FnordMetric
   # `:inbound_stream` starts the TCP interface
   # `:print_stats`    periodicaly prints worker stats
   def self.embedded(opts={})
-    opts = default_options(opts)
+    opts = options(opts)
     app  = nil
 
     if opts[:rack_app] or opts[:web_interface]
@@ -157,6 +152,7 @@ require "fnordmetric/numbers_widget"
 require "fnordmetric/bars_widget"
 require "fnordmetric/toplist_widget"
 require "fnordmetric/pie_widget"
+require "fnordmetric/html_widget"
 require "fnordmetric/namespace"
 require "fnordmetric/gauge_modifiers"
 require "fnordmetric/gauge_calculations"

data/lib/fnordmetric/api.rb

@@ -1,19 +1,20 @@
 require 'securerandom'
 class FnordMetric::API
   @@opts = nil
+
   def initialize opts
     @@opts = FnordMetric.default_options(opts)
     connect
   end
-  
+
   def connect
     @redis = Redis.connect(:url => @@opts[:redis_url])
   end
-  
+
   def event(event_data)
     begin
       if event_data.is_a?(Hash)
-        event_data = event_data.to_json  
+        event_data = event_data.to_json
       else
         JSON.parse(event_data) # void ;)
       end
@@ -27,19 +28,19 @@ class FnordMetric::API
   def disconnect
     @redis.quit
   end
-  
-  private 
-  
-  def push_event(event_id, event_data)    
-    prefix = @@opts[:redis_prefix]    
+
+  private
+
+  def push_event(event_id, event_data)
+    prefix = @@opts[:redis_prefix]
     @redis.hincrby "#{prefix}-testdata",          "events_received", 1
     @redis.hincrby "#{prefix}-stats",             "events_received", 1
     @redis.set     "#{prefix}-event-#{event_id}", event_data
-    @redis.lpush   "#{prefix}-queue",             event_id       
+    @redis.lpush   "#{prefix}-queue",             event_id
     @redis.expire  "#{prefix}-event-#{event_id}", @@opts[:event_queue_ttl]
     event_id
   end
-  
+
   def get_next_uuid
     SecureRandom.uuid
   end

data/lib/fnordmetric/dashboard.rb

@@ -17,7 +17,9 @@ class FnordMetric::Dashboard
   end
 
   def token
-    title.to_s.gsub(/[\W]/, '')
+    token = title.to_s.gsub(/[\W]/, '')
+    token = Digest::SHA1.hexdigest(title.to_s) if token.empty?
+    token
   end
 
   def to_json

data/lib/fnordmetric/html_widget.rb

@@ -0,0 +1,28 @@
+class FnordMetric::HtmlWidget < FnordMetric::Widget
+  def data
+    super.merge(
+      :html => @opts[:html]
+    )
+  end
+
+	def add_gauges(gauges)
+		@gauges = []
+		@tick 	= 0
+		
+		if !gauges.blank?
+      error! "initializing a html widget with gauges is void"
+    end
+	end
+
+  def data_gauges
+		{}
+  end
+
+	def default_range(now=Time.now)
+		0..0
+	end
+
+  def has_tick?
+    false
+  end
+end

data/lib/fnordmetric/version.rb

@@ -1,3 +1,3 @@
 module FnordMetric
-  VERSION = "0.6.6"
+  VERSION = "0.7.0"
 end

data/lib/fnordmetric/widget.rb

@@ -17,7 +17,9 @@ class FnordMetric::Widget
   end
 
   def token
-    title.to_s.gsub(/[\W]/, '').downcase
+    token = title.to_s.gsub(/[\W]/, '').downcase
+    token = Digest::SHA1.hexdigest(title.to_s) if token.empty?
+    token
   end
 
   def add_gauges(gauges)

data/pub/fnordmetric.js

@@ -178,6 +178,31 @@ var FnordMetric = (function(){
 
   };
 
+	var htmlWidget = function(){
+		function render(opts){
+
+      opts.elem.append(
+        $('<div class="headbar small"></div>').html(opts.title)
+      ).css({
+        'marginBottom': 20,
+        'overflow': 'hidden'
+      });
+			
+			var container = $('<div></div>')
+        .addClass('html_container')
+				.html(opts.html);
+			
+			opts.elem.append(container);
+		}
+		
+		function updateValues(opts){}
+		function updatedisplay(opts, diff_factor){}
+	
+		return {
+			render: render
+		};
+	}
+
   var numbersWidget = function(){
 
 
@@ -604,7 +629,6 @@ var FnordMetric = (function(){
 
   };
 
-
   var pieWidget = function(){
 
     function render(opts){
@@ -1078,6 +1102,7 @@ var FnordMetric = (function(){
       if(widget.klass=='NumbersWidget'){ numbersWidget().render(widget); }
       if(widget.klass=='ToplistWidget'){ toplistWidget().render(widget); }
       if(widget.klass=='PieWidget'){ pieWidget().render(widget); }
+			if(widget.klass=="HtmlWidget") { htmlWidget().render(widget); }
     };
 
     function resizeWidget(wkey){

data/spec/dashboard_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require ::File.expand_path('../spec_helper.rb', __FILE__)
 
 describe FnordMetric::Dashboard do
@@ -20,6 +21,11 @@ describe FnordMetric::Dashboard do
     dashboard.token.should == 'MyF00barDash_board'
   end
 
+  it "should build the correct token if the dashboard name contains non-english characters" do
+    dashboard = FnordMetric::Dashboard.new(:title => 'Новая статистика!'){ |dash| }
+    dashboard.token.should_not be_empty
+  end
+
   it "should add a widget" do
     pending("fix this")
     #dashboard = FnordMetric::Dashboard.new(:title => 'My!F00bar-.Dash_board'){ |dash| }

data/spec/fnordmetric_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe FnordMetric do
+  after { FnordMetric.server_configuration = nil }
+
+  it "has default_options" do
+    opts = FnordMetric.default_options
+    opts[:redis_url].should eq("redis://localhost:6379")
+    opts[:redis_prefix].should eq("fnordmetric")
+    opts[:inbound_stream].should eq(["0.0.0.0", "1337"])
+    opts[:web_interface].should eq(["0.0.0.0", "4242"])
+    opts[:web_interface_server].should eq("thin")
+    opts[:start_worker].should be_true
+    opts[:print_stats].should == 3
+    opts[:event_queue_ttl].should == 120
+    opts[:event_data_ttl].should == 3600*24*30
+    opts[:session_data_ttl].should == 3600*24*30
+  end
+
+  it "default_options can be overriden" do
+    opts = FnordMetric.default_options({
+      :redis_url => "redis://example.com:6379",
+      :redis_prefix => "foobar",
+      :inbound_stream => ["0.0.0.0", "7331"],
+      :web_interface => ["0.0.0.0", "2424"],
+      :web_interface_server => "hatetepe",
+      :start_worker => false,
+      :print_stats => false,
+      :event_queue_ttl => 10,
+      :event_data_ttl => 20,
+      :session_data_ttl => 30,
+    })
+    opts[:redis_url].should eq("redis://example.com:6379")
+    opts[:redis_prefix].should eq("foobar")
+    opts[:inbound_stream].should eq(["0.0.0.0", "7331"])
+    opts[:web_interface].should eq(["0.0.0.0", "2424"])
+    opts[:web_interface_server].should eq("hatetepe")
+    opts[:start_worker].should be_false
+    opts[:print_stats].should be_false
+    opts[:event_queue_ttl].should == 10
+    opts[:event_data_ttl].should == 20
+    opts[:session_data_ttl].should == 30
+  end
+
+  it "merges default, server configuration, and given opts as options" do
+    FnordMetric.server_configuration = { :web_interface_server => "hatetepe", :print_stats => true }
+    opts = FnordMetric.options(:redis_url => "redis://example.com:6379", :print_stats => false)
+
+    opts[:redis_url].should eq("redis://example.com:6379")
+    opts[:redis_prefix].should eq("fnordmetric")
+    opts[:web_interface_server].should eq("hatetepe")
+    opts[:print_stats].should be_false
+  end
+
+
+end

metadata

@@ -2,7 +2,7 @@
 name: fnordmetric
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.6.6
+  version: 0.7.0
 platform: ruby
 authors: 
 - Paul Asmuth
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-21 00:00:00 +01:00
+date: 2012-04-21 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -224,6 +224,7 @@ files:
 - lib/fnordmetric/gauge.rb
 - lib/fnordmetric/gauge_calculations.rb
 - lib/fnordmetric/gauge_modifiers.rb
+- lib/fnordmetric/html_widget.rb
 - lib/fnordmetric/inbound_stream.rb
 - lib/fnordmetric/logger.rb
 - lib/fnordmetric/metric.rb
@@ -250,6 +251,7 @@ files:
 - spec/context_spec.rb
 - spec/dashboard_spec.rb
 - spec/event_spec.rb
+- spec/fnordmetric_spec.rb
 - spec/gauge_modifiers_spec.rb
 - spec/gauge_spec.rb
 - spec/inbound_stream_spec.rb
@@ -292,6 +294,7 @@ test_files:
 - spec/context_spec.rb
 - spec/dashboard_spec.rb
 - spec/event_spec.rb
+- spec/fnordmetric_spec.rb
 - spec/gauge_modifiers_spec.rb
 - spec/gauge_spec.rb
 - spec/inbound_stream_spec.rb