fresh_redis 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/.rspec

@@ -0,0 +1,2 @@
+--format=nested
+--color

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    fresh_redis (0.0.1)
+      redis
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    mock_redis (0.5.2)
+    redis (3.0.1)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fresh_redis!
+  mock_redis (= 0.5.2)
+  rspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Julian Doherty
+
+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/README.md

@@ -0,0 +1,29 @@
+# FreshRedis
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fresh_redis'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fresh_redis
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+
+end

data/fresh_redis.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path("../lib/fresh_redis/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Julian Doherty (madlep)"]
+  gem.email         = ["madlep@madlep.com"]
+  gem.description   = %q{Aggregate, expiring, recent data in Redis}
+  gem.summary       = <<-TEXT.strip
+    Use redis for working with recent temporal based data that can expiry gradually. Useful for things like "get a count all failed login attempts for the last hour"
+  TEXT
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.name          = "fresh_redis"
+  gem.require_paths = ["lib"]
+  gem.version       = FreshRedis::VERSION
+
+  gem.add_runtime_dependency 'redis'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'mock_redis', '0.5.2'
+end

data/lib/fresh_redis/timestamp.rb

@@ -0,0 +1,17 @@
+class FreshRedis
+  module Timestamp
+    def normalize_key(key, t, granularity)
+      [key, normalize_time(t, granularity)].join(":")
+    end
+
+    def normalize_time(t, granularity)
+      t - (t % granularity)
+    end
+
+    def range_timestamps(t, freshness, granularity)
+      from = normalize_time(t - freshness, granularity)
+      to = normalize_time(t, granularity)
+      (from..to).step(granularity)
+    end
+  end
+end

data/lib/fresh_redis/version.rb

@@ -0,0 +1,3 @@
+class FreshRedis
+  VERSION = "0.0.1"
+end

data/lib/fresh_redis.rb

@@ -0,0 +1,61 @@
+require 'fresh_redis/timestamp'
+require 'fresh_redis/version'
+
+class FreshRedis
+  include Timestamp
+
+  VERSION = "0.0.1"
+
+  DEFAULT_OPTIONS = {
+    :freshness => 60 * 60, # 1 hour
+    :granularity => 1 * 60 # 1 minute
+  }
+
+  def initialize(redis)
+    @redis = redis
+  end
+
+  def fincr(key, options={})
+    options = default_options(options)
+    t           = options[:t]
+    freshness   = options[:freshness]
+    granularity = options[:granularity]
+
+    key = normalize_key(key, t, granularity)
+    @redis.multi do
+      @redis.incr key
+      @redis.expire key, freshness
+    end
+  end
+
+  def fsum(key, options={})
+    options = default_options(options)
+
+    reduce(key, options, 0){|acc, timestamp_total|
+      acc + timestamp_total.to_i
+    }
+  end
+
+  private
+  def reduce(key, options={}, initial=nil, &reduce_operation)
+    options = default_options(options)
+    t           = options[:t]
+    freshness   = options[:freshness]
+    granularity = options[:granularity]
+
+    raw_totals = @redis.pipelined {
+      range_timestamps(t, freshness, granularity).each do |timestamp|
+        timestamp_key = [key, timestamp].join(":")
+        @redis.get(timestamp_key)
+      end
+    }
+
+    raw_totals.reduce(initial, &reduce_operation)
+  end
+
+  def default_options(options)
+    options = DEFAULT_OPTIONS.merge(options)
+    options[:t] ||= Time.now.to_i
+    options
+  end
+end

data/spec/fresh_redis/timestamp_spec.rb

@@ -0,0 +1,49 @@
+require 'fresh_redis'
+
+describe FreshRedis::Timestamp do
+  subject { Class.new.extend(FreshRedis::Timestamp) }
+  let(:now) { Time.new(2012, 9, 27, 15, 40, 56, "+10:00").to_i }
+  let(:normalized_now_minute) { Time.new(2012, 9, 27, 15, 40, 0, "+10:00").to_i }
+  let(:normalized_now_hour) { Time.new(2012, 9, 27, 15, 0, 0, "+10:00").to_i }
+
+  describe "#normalize_key" do
+    it "should append the normalized timestamp to the key" do
+      subject.normalize_key("foo", now, 60).should == "foo:#{normalized_now_minute}"
+    end
+  end
+  
+  describe "#normalize_time" do
+    it "should round down timestamp to nearest multiple of granularity" do
+      subject.normalize_time(now, 60).should == normalized_now_minute
+      subject.normalize_time(now, 3600).should == normalized_now_hour
+    end
+
+    it "shouldn't change the timestamp if the granularity is 1" do
+      subject.normalize_time(now, 1).should == now
+    end
+  end
+
+  describe "#range_timestamps" do
+    let(:range) { subject.range_timestamps(now, 600, 60) }
+    it "should generate an enumerable over the range" do
+      range.should be_kind_of(Enumerable)
+    end
+
+    it "should have one timestamp for each granularity step in the fresh range" do
+      range.count.should == 11 # fence-posting. we include the first and last elements in a timestamp range split by granularity
+    end
+
+    it "should have the first timestamp as the maximum freshness" do
+      range.first.should == normalized_now_minute - 600
+    end
+
+    it "should have now as the maximum freshness" do
+      range.to_a.last.should == normalized_now_minute
+    end
+
+    it "should step through the normalized timestamps split up by granularity" do
+      range.each_with_index{|t, i| t.should == normalized_now_minute - 600 + i * 60 }
+    end
+  end
+
+end

data/spec/fresh_redis_spec.rb

@@ -0,0 +1,40 @@
+require 'fresh_redis'
+require 'mock_redis'
+
+describe FreshRedis do
+  subject{ FreshRedis.new(mock_redis) }
+  let(:mock_redis) { MockRedis.new }
+  let(:now) { Time.new(2012, 9, 27, 15, 40, 56, "+10:00").to_i }
+  let(:normalized_now_minute) { Time.new(2012, 9, 27, 15, 40, 0, "+10:00").to_i }
+
+  describe "#fincr" do
+    it "should increment the key for the normalized timestamp" do
+      subject.fincr "foo", :granularity => 60, :t => now
+      subject.fincr "foo", :granularity => 60, :t => now + 3
+      subject.fincr "foo", :granularity => 60, :t => now + 60 # different normalized key
+      mock_redis.data["foo:#{normalized_now_minute}"].to_i.should == 2
+    end
+
+    it "should set the freshness as the expiry" do
+      # relying on mock_redis's time handling here - which converts to/from using Time.now Possible flakey temporal breakage potential
+      subject.fincr "foo", :freshness => 3600, :t => now
+      mock_redis.ttl("foo:#{normalized_now_minute}").should == 3600
+    end
+  end
+
+  describe "#fsum" do
+    it "should add the values of keys for specified freshness and granularity" do
+      subject.fincr "foo", :freshness => 60, :granularity => 10, :t => now - 60 + 1
+      subject.fincr "foo", :freshness => 60, :granularity => 10, :t => now - 60 + 2
+      subject.fincr "foo", :freshness => 60, :granularity => 10, :t => now - 60 + 3
+      subject.fincr "foo", :freshness => 60, :granularity => 10, :t => now - 60 + 5
+      subject.fincr "foo", :freshness => 60, :granularity => 10, :t => now - 60 + 8
+      subject.fincr "foo", :freshness => 60, :granularity => 10, :t => now - 60 + 13
+      subject.fincr "foo", :freshness => 60, :granularity => 10, :t => now - 60 + 21
+      subject.fincr "foo", :freshness => 60, :granularity => 10, :t => now - 60 + 34
+      subject.fincr "foo", :freshness => 60, :granularity => 10, :t => now - 60 + 55
+
+      subject.fsum("foo", :freshness => 60, :granularity => 10, :t => now).should ==  9
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: fresh_redis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Julian Doherty (madlep)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-27 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70193817243680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70193817243680
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70193817243180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70193817243180
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: &70193817242380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *70193817242380
+description: Aggregate, expiring, recent data in Redis
+email:
+- madlep@madlep.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- fresh_redis.gemspec
+- lib/fresh_redis.rb
+- lib/fresh_redis/timestamp.rb
+- lib/fresh_redis/version.rb
+- spec/fresh_redis/timestamp_spec.rb
+- spec/fresh_redis_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 107948125749487774
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 107948125749487774
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Use redis for working with recent temporal based data that can expiry gradually.
+  Useful for things like "get a count all failed login attempts for the last hour"
+test_files:
+- spec/fresh_redis/timestamp_spec.rb
+- spec/fresh_redis_spec.rb