snappy_stats 0.0.1 → 0.0.2

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+script: bundle exec rspec spec

data/README.md

@@ -1,4 +1,72 @@
-snappy_stats
-============
+# snappy_stats [![Build Status](https://travis-ci.org/timrwilliams/snappy_stats.png?branch=master)](https://travis-ci.org/timrwilliams/snappy_stats)
+
+This is a simple Ruby time series statistics gem that uses Redis for storage. Retrieval is optimised for graphing engines by nil filling empty time periods. I graph it with [Rickshaw] (code.shutterstock.com/rickshaw/).
+
+## Installation
+Install the gem:
+
+    gem install snappy_stats
+
+Add it to your Gemfile:
+
+    gem "snappy_stats"
+
+## Background
+SnappyStats is a Ruby implementation of a simple time series statistics tool based on [ApiAxle's Javascript statistics lib] (http://blog.apiaxle.com/post/storing-near-realtime-stats-in-redis/) which in turn was heavily influenced by [RRDTool] (http://en.wikipedia.org/wiki/RRDtool).
+
+It allows you to store and retrieve simple metrics (think hit counters). The metrics are returned in a set optimised for graphing engines as each time period is represented in the results even if no hit was recorded in that period.
+
+## Usage
+    # Record a hit now
+    SnappyStats.recordHitNow("test:counter1")
+    # Get all results between given timestamp range
+    results = SnappyStats.get(:day,Time.now.midnight.to_i,(Time.now.midnight + 1.days).to_i,"test:counter1")
+
+## Detailed Example
+    require 'snappy_stats'
+
+    #Using Timecop to simulate changing time, not required in production implementation
+    Timecop.freeze
+    now = Time.now        
+
+    # Simulate 5 hits for today
+    5.times do 
+        SnappyStats.recordHitNow("test:counter1")
+    end
+
+    # Simulate 5 hits for 2 days from now
+    Timecop.freeze(now + 2.days) 
+    2.times do 
+        SnappyStats.recordHitNow("test:counter1")
+    end
+
+    # Decide what range we want to search for
+    from = Time.now.midnight.to_i
+    to = (Time.now.midnight + 2.days).to_i
+
+    # Get daily results between the from and to timestamps for given key, filling missing days with nil
+    daily_stats = SnappyStats.get(:day,from,to,"test:counter1")
+    p daily_stats  # {1382054400=>"5", 1382140800=>nil,1382227200=>"2"}
+
+## Configuration
+By default SnappyStats uses the current vesion of Redis defined in your project. To use a different Redis use a config initializer.
+
+    # config/initializers/snappy_stats.rb
+    SnappyStats.configure do |config|
+        # set the Redis connection to a new Redis connection
+        config.redis = Redis.new
+        # Change Redis key prefix away from default 'stats'
+        config.namnespace = "custom_stats"
+    end
+
+## Contributing to SnappyStats
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
 
-Simple Ruby time series statistics backed by Redis gem 

data/lib/snappy_stats/version.rb

@@ -1,3 +1,3 @@
 module SnappyStats
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/snappy_stats.rb

@@ -71,9 +71,7 @@ module SnappyStats
       tsround = SnappyStats.getRoundedTimestamp(time, size * factor)
       redis_key = "#{hash_key}:#{key}:#{gran}:#{tsround}"
       ts = getFactoredTimestamp time, factor      
-      val = SnappyStats.connection.hincrby redis_key, ts, 1     
-      puts val
-      puts "#{redis_key}, #{ts},#{SnappyStats.connection.hgetall(redis_key)}"
+      SnappyStats.connection.hincrby redis_key, ts, 1     
       SnappyStats.connection.expireat redis_key, tsround + ttl      
     end
   end

data/snappy_stats.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["tim@teachmatic.com"]
   spec.description   = %q{Metrics storage and retrieval library for time series data.}  
   spec.summary       = %q{Redis backed simple time series statistics gem}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/timrwilliams/snappy_stats"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "active_support"
+  spec.add_dependency "redis"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

data/spec/snappy_stats_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe SnappyStats do
+
+	before(:all) do
+		#Redis::Connection.drivers.delete_if {|x| Redis::Connection::Memory == x }
+		keys = SnappyStats.connection.keys("stats:*")
+		keys.each { | key | SnappyStats.connection.del(key) }
+	end
+
+  it "Calculates ts in seconds" do
+    Timecop.freeze(Time.local(2013, 01, 01, 01, 01))
+    time = SnappyStats.getSecondsTimestamp
+  	expect(time).to be 1357002060  	
+  	default_rounded = SnappyStats.getRoundedTimestamp(nil, 60)
+  	expect(default_rounded).to be 1357002060  	  	
+  	time = 1364833411 
+  	rounded = SnappyStats.getRoundedTimestamp(time, 60)
+  	expect(rounded).to be 1364833380 
+  end
+
+  it "Records a hit at all granularities" do
+      pending("Need updated version of fakeredis with correct hincrby implementation")  	
+    Timecop.freeze
+    now = Time.now        
+    5.times do 
+        SnappyStats.recordHitNow("test:counter1")
+    end
+    3.times do 
+        SnappyStats.recordHitNow("test:counter2")
+    end       
+    Timecop.freeze(now + 2.days) 
+    2.times do 
+        SnappyStats.recordHitNow("test:counter1")
+    end
+    from = now.midnight.to_i
+    to = (now.midnight + 2.day).to_i
+    daily_user1_stat = SnappyStats.get(:day,from,to,"test:counter1")
+    Timecop.freeze(now + 1.day)
+    puts daily_user1_stat
+    expect(daily_user1_stat[from]).to eq("5")
+    hourly_user1_stat = SnappyStats.get(:hour,from,to,"test:counter1")
+    expect(hourly_user1_stat[ Time.now.beginning_of_hour.to_i]).to eq("5")
+    daily_user2_stat = SnappyStats.get(:day,from,to,"test:counter2")
+    expect(daily_user2_stat[from]).to eq("3")    
+  end
+
+  after(:each) do
+    	Timecop.return
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'snappy_stats' # and any other gems you need
+require 'fakeredis'
+require 'timecop'
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snappy_stats
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,6 +11,38 @@ bindir: bin
 cert_chain: []
 date: 2013-10-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +131,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - LICENSE.txt
@@ -108,7 +142,9 @@ files:
 - lib/snappy_stats/config.rb
 - lib/snappy_stats/version.rb
 - snappy_stats.gemspec
-homepage: ''
+- spec/snappy_stats_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/timrwilliams/snappy_stats
 licenses:
 - MIT
 post_install_message: 
@@ -133,4 +169,6 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Redis backed simple time series statistics gem
-test_files: []
+test_files:
+- spec/snappy_stats_spec.rb
+- spec/spec_helper.rb