rrdsimple 0.0.1

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'rake'
+
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'rrdsimple'
+
+GEM = 'rrdsimple'
+GEM_NAME = 'rrdsimple'
+GEM_VERSION = RRDSimple::VERSION
+AUTHORS = ['Edgar Gonzalez']
+EMAIL = "edgargonzalez@gmail.com"
+HOMEPAGE = "http://github.com/edgar/RRDSimple"
+SUMMARY = "A simple round robin database pattern via Redis"
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = GEM
+    gemspec.version = GEM_VERSION
+    gemspec.summary = SUMMARY
+    gemspec.platform = Gem::Platform::RUBY
+    gemspec.description = gemspec.summary
+    gemspec.email = EMAIL
+    gemspec.homepage = HOMEPAGE
+    gemspec.authors = AUTHORS
+    gemspec.required_ruby_version = ">= 1.8"
+    gemspec.add_dependency("redis", ">= 2.0.3")
+    gemspec.add_development_dependency "rspec", ">= 1.3.0"
+    gemspec.rubyforge_project = GEM
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "models #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/lib/rrdsimple.rb

@@ -0,0 +1,117 @@
+require 'rubygems'
+gem 'redis', '>= 2.0.3'
+require 'redis'
+
+class RRDSimple
+  VERSION = "0.0.1"
+
+  def initialize(opts)
+    @buckets = opts[:buckets]
+    @step = opts[:step]
+    @debug = opts[:debug] || false
+    @db = opts[:db] || Redis.new
+  end
+
+  def current_epoch
+    Time.now.utc.to_i / @step
+  end
+
+  def current_bucket
+    current_epoch % @buckets
+  end
+
+  def last_epoch_key(k)
+    "#{k}:epoch"
+  end
+
+  def last_epoch(k)
+    @db.get(last_epoch_key(k)).to_i
+  end
+
+  def set_last_epoch(k,v = Time.now.utc.to_i)
+    @db.set(last_epoch_key(k), v)
+  end
+
+  def last_bucket(set)
+    last_epoch(set) % @buckets
+  end
+
+  def bucket_key(k,i)
+    "#{k}:#{i}"
+  end
+
+  def bucket(k,i)
+    @db.get(bucket_key(k,i)).to_i
+  end
+
+  def relative_bucket(value, i)
+    b = value - i
+    b = (b < 0) ? @buckets + b : b
+  end
+
+  def epochs_ago(k, num)
+    bucket_key(k, relative_bucket(current_bucket,num))
+  end
+
+  def buckets(k)
+    a = []
+    i = 0
+    last_b = last_bucket(k)
+    while (i < @buckets) do
+      a.push bucket_key(k,relative_bucket(last_b,i))
+      i += 1
+    end
+    a
+  end
+
+  def values(k)
+    a = []
+    i = 0
+    last_e = last_epoch(k)
+    last_b = last_bucket(k)
+    while (i < @buckets) do
+      v = bucket(k,relative_bucket(last_b,i))
+      a.push({:value => v, :epoch => last_e - i}) if v != 0
+      i += 1
+    end
+    a
+  end
+
+  def epoch(k)
+    current_e = current_epoch
+    last_e = last_epoch(k)
+    if current_e != last_e
+      [(current_e - last_e).abs, @buckets].min.times do |n|
+        clear_bucket(epochs_ago(k, n))
+      end
+      set_last_epoch(k, current_e)
+    end
+    bucket_key(k, current_bucket)
+  end
+
+  def incr(k, val=1)
+    debug [:incr, epoch(k), val]
+    @db.incrby(epoch(k), val).to_i
+  end
+
+  def set(k, val)
+    debug [:set, epoch(k), val]
+    @db.set(epoch(k), val)
+  end
+
+  def clear(k)
+    @db.del(last_epoch_key(k))
+    buckets(k){|b| clear_bucket(b)}
+  end
+
+  protected
+
+    def clear_bucket(b)
+      debug [:clearing_epoch, b]
+      @db.del(b)
+    end
+
+    def debug(msg); puts msg if @debug; end
+
+end
+

data/spec/rrdsimple_spec.rb

@@ -0,0 +1,186 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "RRDSimple" do
+
+  let(:rr) { RRDSimple.new(:step => 60, :buckets => 60, :db => redis) }
+  let(:jan01) {Time.utc(2010,1,1.0,0)}
+
+  before(:each) { time_travel_to(jan01) }
+  before(:each) { redis.flushdb }
+
+  it "should return the proper key for last_epoch" do
+    rr.last_epoch_key('k').should == 'k:epoch'
+  end
+
+  it "should return zero as last_epoch for an empty rrdsimple" do
+    rr.last_epoch('k').should == 0
+  end
+
+  it "should not exist in redis last epoch key related to an empty rrdsimple" do
+    redis.exists("k:epoch").should be_false
+  end
+
+  it "should not exist in redis any bucket key related to an empty rrdsimple" do
+    60.times do |i|
+      redis.exists("k:{i}").should be_false
+    end
+  end
+
+  it "should increment buckets within correct epoch" do
+    rr.epoch("k").should match(/k:0/)
+    rr.incr("k").should == 1
+    rr.incr("k", 2).should == 3
+    rr.incr("k").should == 4
+    # The bucket should have the counter
+    redis.get('k:0').to_i.should == 4
+    # The epoch should be consistent
+    rr.last_epoch('k').should == jan01.to_i / 60
+    v = rr.values('k')
+    v.size.should == 1
+    v[0][:value].should == 4
+    # The following to assertion are equivalent
+    v[0][:epoch].should == jan01.to_i / 60
+    Time.at(v[0][:epoch]*60).should == jan01
+
+    jump 60 # jump one minute
+    rr.incr("k").should == 1
+    rr.incr("k").should == 2
+
+    # The bucket should have the counter
+    redis.get('k:0').to_i.should == 4
+    redis.get('k:1').to_i.should == 2
+    # The epoch should be consistent
+    rr.last_epoch('k').should == (jan01 + 60).to_i / 60
+
+    # values
+    v = rr.values('k')
+    v.size.should == 2
+
+    v[0][:value].should == 2
+    # The following to assertion are equivalent
+    v[0][:epoch].should == (jan01 + 60).to_i / 60
+    Time.at(v[0][:epoch]*60).should == jan01 + 60
+
+    v[1][:value].should == 4
+    # The following to assertion are equivalent
+    v[1][:epoch].should == jan01.to_i / 60
+    Time.at(v[1][:epoch]*60).utc.should == jan01
+
+
+    jump 60*2 # jump two minute
+    rr.incr("k").should == 1
+    rr.incr("k").should == 2
+    rr.incr("k").should == 3
+
+    # The bucket should have the counter
+    redis.get('k:0').to_i.should == 4
+    redis.get('k:1').to_i.should == 2
+    redis.exists('k:2').should be_false
+    redis.get('k:3').to_i.should == 3
+    # The epoch should be consistent
+    rr.last_epoch('k').should == (jan01 + 60 + 120).to_i / 60
+
+    # values
+    v = rr.values('k')
+    v.size.should == 3
+
+    v[0][:value].should == 3
+    # The following to assertion are equivalent
+    v[0][:epoch].should == (jan01 + 60 + 60*2).to_i / 60
+    Time.at(v[0][:epoch]*60).should == jan01 + 60 + 60*2
+
+    v[1][:value].should == 2
+    # The following to assertion are equivalent
+    v[1][:epoch].should == (jan01 + 60).to_i / 60
+    Time.at(v[1][:epoch]*60).should == jan01 + 60
+
+    v[2][:value].should == 4
+    # The following to assertion are equivalent
+    v[2][:epoch].should == jan01.to_i / 60
+    Time.at(v[2][:epoch]*60).utc.should == jan01
+
+    jump 60*30 # jump 30 minutes
+
+    rr.incr('k').should == 1
+    # The bucket should have the counter
+    redis.get('k:0').to_i.should == 4
+    redis.get('k:1').to_i.should == 2
+    redis.exists('k:2').should be_false
+    redis.get('k:3').to_i.should == 3
+    (4..32).each do |i|
+      redis.exists("k:#{i}").should be_false
+    end
+    redis.get('k:33').to_i.should == 1
+
+    # The epoch should be consistent
+    rr.last_epoch('k').should == (jan01 + 60 + 60*2 + 60*30).to_i / 60
+
+    # values
+    v = rr.values('k')
+    v.size.should == 4
+
+    v[0][:value].should == 1
+    # The following to assertion are equivalent
+    v[0][:epoch].should == (jan01 + 60 + 60*2 + 60*30).to_i / 60
+    Time.at(v[0][:epoch]*60).should == jan01 + 60 + 60*2 + 60*30
+
+    v[1][:value].should == 3
+    # The following to assertion are equivalent
+    v[1][:epoch].should == (jan01 + 60 + 60*2).to_i / 60
+    Time.at(v[1][:epoch]*60).should == jan01 + 60 + 60*2
+
+    v[2][:value].should == 2
+    # The following to assertion are equivalent
+    v[2][:epoch].should == (jan01 + 60).to_i / 60
+    Time.at(v[2][:epoch]*60).should == jan01 + 60
+
+    v[3][:value].should == 4
+    # The following to assertion are equivalent
+    v[3][:epoch].should == jan01.to_i / 60
+    Time.at(v[3][:epoch]*60).utc.should == jan01
+
+    jump 60*45 # jump 45 minutes
+    rr.last_epoch('k').should == (jan01 + 60 + 60*2 + 60*30).to_i / 60
+
+    rr.incr('k').should == 1
+    rr.incr('k').should == 2
+    rr.incr('k').should == 3
+    rr.incr('k').should == 4
+    rr.incr('k').should == 5
+
+    # The bucket should have the counter
+    (0..17).each do |i|
+      redis.exists("k:#{i}").should be_false
+    end
+    redis.get('k:18').to_i.should == 5
+    (19..32).each do |i|
+      redis.exists("k:#{i}").should be_false
+    end
+    redis.get('k:33').to_i.should == 1
+    (34..59).each do |i|
+      redis.exists("k:#{i}").should be_false
+    end
+
+    # values
+    v = rr.values('k')
+    v.size.should == 2
+
+    v[0][:value].should == 5
+    # The following to assertion are equivalent
+    v[0][:epoch].should == (jan01 + 60 + 60*2 + 60*30 + 60*45).to_i / 60
+    Time.at(v[0][:epoch]*60).should == jan01 + 60 + 60*2 + 60*30 + 60*45
+
+    v[1][:value].should == 1
+    # The following to assertion are equivalent
+    v[1][:epoch].should == (jan01 + 60 + 60*2 + 60*30).to_i / 60
+    Time.at(v[1][:epoch]*60).should == jan01 + 60 + 60*2 + 60*30
+
+
+    rr.clear('k')
+    redis.exists("k:epoch").should be_false
+    (0..59).each do |i|
+      redis.exists("k:{i}").should be_false
+    end
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--color
+--format progress
+--loadby mtime
+--reverse
+--backtrace
+

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rrdsimple'
+require 'spec'
+require 'spec/autorun'
+require 'delorean'
+require 'ruby-debug'
+
+def redis
+  @redis ||= Redis.new(:host => 'localhost', :port => 6379, :db => 15 )
+end
+
+Spec::Runner.configure do |config|
+  config.include Delorean
+  config.after :suite do
+    redis.flushdb
+  end
+end
+

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: rrdsimple
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Edgar Gonzalez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-02 00:00:00 -04:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 3
+        version: 2.0.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id002
+description: A simple round robin database pattern via Redis
+email: edgargonzalez@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- lib/rrdsimple.rb
+- spec/rrdsimple_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/edgar/RRDSimple
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      version: "1.8"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rrdsimple
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A simple round robin database pattern via Redis
+test_files: 
+- spec/rrdsimple_spec.rb
+- spec/spec_helper.rb