nightfury 0.0.1 → 0.1.0

data/README.md

@@ -1,6 +1,34 @@
 # Nightfury
 
-TODO: Write a gem description
+**This gem is not yet production ready**
+
+## Concept
+
+Nightfury provides a reporting framework built on Redis for Ruby/Ruby on Rails applications. The framework is designed 
+to store differnt metrics in a time series or as a single value which can be easily queried. The following are the key terms:
+
+### Identity
+
+Like a company or a ticket or a user (anything that we want stats on very quickly)
+Has an id (can auto-generate but generally provided so you can map it to your db ids etc)
+Has metrics
+
+### Metrics
+
+A identity has many metrics.
+
+* Metric can be a single value or a time series. 
+* The value can be aggregate (average)
+* When you ask for the metric back, you can specify a time range for the values that you want back (if time series)
+
+### Tags
+
+Identities can be tagged and have multiple tags
+You can ask for stats for identities with certain tags over a particular time range (if asking for metrics that are series)
+
+## Usage
+
+**See example.rb for usage**
 
 ## Installation
 
@@ -16,10 +44,6 @@ Or install it yourself as:
 
     $ gem install nightfury
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Contributing
 
 1. Fork it

data/lib/nightfury.rb

@@ -39,5 +39,6 @@ require "nightfury/version"
 require "nightfury/metric"
 require "nightfury/metric/value"
 require "nightfury/metric/time_series"
+require "nightfury/metric/avg_time_series"
 require "nightfury/identity"
 

data/lib/nightfury/metric/avg_time_series.rb

@@ -0,0 +1,22 @@
+module Nightfury
+  module Metric
+    class AvgTimeSeries < TimeSeries
+
+      def default_meta
+        {'count' => 0}
+      end
+
+      protected
+
+      def before_set(value)
+        count = meta['count'] + 1
+        raw = get
+        current_value = raw.nil? ? 0 : raw.values.first.to_f
+        result = (current_value + value) / count.to_f
+        meta['count'] = count
+        save_meta
+        result
+      end
+    end
+  end
+end

data/lib/nightfury/metric/time_series.rb

@@ -21,10 +21,13 @@ module Nightfury
         data_point = ''
         if timestamp
           timestamp = timestamp.to_i
-          data_point = redis.zrangebyscore(redis_key, timestamp, timestamp).first
+          data_point = redis.zrangebyscore(redis_key, timestamp, timestamp, withscores: true).last
         else
-          data_point = redis.zrevrange(redis_key, 0, 0).first
+          data_point = redis.zrevrange(redis_key, 0, 0, withscores: true).last
         end
+      
+        return nil if data_point.nil?
+        return nil if data_point[1] == 0.0 
 
         time, data = decode_data_point(data_point)
         {time => data}
@@ -34,25 +37,34 @@ module Nightfury
         return nil unless redis.exists(redis_key)        
         start_time = start_time.to_i
         end_time = end_time.to_i
-        data_points = redis.zrangebyscore(redis_key, start_time, end_time)
+        data_points = redis.zrangebyscore(redis_key, start_time, end_time, withscores: true)
         decode_many_data_points(data_points)
       end
 
       def get_all
         return nil unless redis.exists(redis_key)        
-        data_points = redis.zrange(redis_key,1,-1)
+        data_points = redis.zrange(redis_key,1,-1, withscores: true)
         decode_many_data_points(data_points)         
       end
 
       def meta
-        json = redis.zrange(redis_key, 0, 0).first
-        JSON.parse(json)
+        unless @meta
+          json = redis.zrange(redis_key, 0, 0).first
+          @meta = JSON.parse(json)
+        end
+        @meta
       end
 
       def default_meta
         {}
       end
 
+      protected
+
+      def before_set(value)
+        value
+      end
+
       private
       
       def add_value_to_timeline(value, time)
@@ -71,6 +83,7 @@ module Nightfury
       end
 
       def decode_data_point(data_point)
+        data_point = data_point.first
         colon_index = data_point.index(':')
 
         [
@@ -79,8 +92,9 @@ module Nightfury
         ]
       end
 
-      def before_set(value)
-        value
+      def save_meta
+        redis.zremrangebyscore redis_key, 0, 0
+        redis.zadd redis_key, 0, meta.to_json 
       end
 
       def init_time_series

data/lib/nightfury/version.rb

@@ -1,3 +1,3 @@
 module Nightfury
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/nightfury/metric/avg_time_series_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Nightfury::Metric::AvgTimeSeries do
+  it "should have the right default meta" do
+    avg_metric = Nightfury::Metric::AvgTimeSeries.new(:avg)
+    avg_metric.default_meta.should == { 'count' => 0 }
+  end
+
+  it "should calculate avg before saving" do
+    avg_metric = Nightfury::Metric::AvgTimeSeries.new(:avg)
+    avg_metric.set(1)
+    avg_metric.set(2)
+    avg_metric.get.values.first.should == "1.5"
+  end
+
+  it "should update meta update count" do
+    avg_metric = Nightfury::Metric::AvgTimeSeries.new(:avg)
+    avg_metric.set(1)
+    avg_metric.set(2)
+    avg_metric.meta['count'].should == 2
+  end
+end

data/spec/nightfury/metric/time_series_spec.rb

@@ -27,6 +27,11 @@ describe Nightfury::Metric::TimeSeries do
           result = ts_metric.get
           result[time_later.to_i.to_s].should == '2'
         end
+
+        it "should return nil if there are no data points" do
+          ts_metric = Nightfury::Metric::TimeSeries.new(:time)
+          ts_metric.get.should be_nil
+        end
       end
 
       context "with timestamp" do
@@ -39,6 +44,11 @@ describe Nightfury::Metric::TimeSeries do
           result = ts_metric.get(time_now)
           result[time_now.to_i.to_s].should == '1'
         end
+
+        it "should return nil if there are no data points at the timestamp" do
+          ts_metric = Nightfury::Metric::TimeSeries.new(:time)
+          ts_metric.get(Time.now).should be_nil
+        end
       end
     end
 
@@ -50,6 +60,11 @@ describe Nightfury::Metric::TimeSeries do
         ts_metric.get_range(Time.now, Time.now).should be_nil
       end
 
+      it "should return an empty array if no data points are present in the specified ranges" do
+        ts_metric = Nightfury::Metric::TimeSeries.new(:time)
+        ts_metric.get_range(Time.now, Time.now).should be_empty
+      end
+
       it "should get all data points between the specified ranges" do
         ts_metric = Nightfury::Metric::TimeSeries.new(:time)
         time = Time.now
@@ -71,13 +86,18 @@ describe Nightfury::Metric::TimeSeries do
     end
 
     describe "#get_all" do
-      it "should retrun nil if metric key on redis is empty" do
+      it "should return nil if metric key on redis is empty" do
         ts_metric = Nightfury::Metric::TimeSeries.new(:time)
         # delete redis key
         ts_metric.redis.del ts_metric.redis_key
         ts_metric.get_all.should be_nil
       end
 
+      it "should return an empty array of there are no data points" do
+        ts_metric = Nightfury::Metric::TimeSeries.new(:time)
+        ts_metric.get_all.should be_empty
+      end
+
       it "should get all the data points in the series" do
         ts_metric = Nightfury::Metric::TimeSeries.new(:time)
         time = Time.now

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nightfury
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-17 00:00:00.000000000 Z
+date: 2012-12-21 00:00:00.000000000 Z
 dependencies: []
 description: Nightfury is a reporting/analytics backend written on Redis
 email:
@@ -29,11 +29,13 @@ files:
 - lib/nightfury.rb
 - lib/nightfury/identity.rb
 - lib/nightfury/metric.rb
+- lib/nightfury/metric/avg_time_series.rb
 - lib/nightfury/metric/time_series.rb
 - lib/nightfury/metric/value.rb
 - lib/nightfury/version.rb
 - nightfury.gemspec
 - spec/nightfury/identity_spec.rb
+- spec/nightfury/metric/avg_time_series_spec.rb
 - spec/nightfury/metric/time_series_spec.rb
 - spec/nightfury/metric/value_spec.rb
 - spec/nightfury/metric_spec.rb
@@ -66,6 +68,7 @@ specification_version: 3
 summary: Nightfury is a reporting/analytics backend written on Redis
 test_files:
 - spec/nightfury/identity_spec.rb
+- spec/nightfury/metric/avg_time_series_spec.rb
 - spec/nightfury/metric/time_series_spec.rb
 - spec/nightfury/metric/value_spec.rb
 - spec/nightfury/metric_spec.rb