space-saver-redis 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem 'redis', '~> 3.0.1'
+
+group :development, :test do
+  gem 'jeweler', '~> 1.8.4'
+  gem 'rake', '~> 0.9.2.2'
+  gem 'rspec', '~> 2.11.0'
+  gem 'timecop', '~> 0.5.3'
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redis (3.0.2)
+    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)
+    timecop (0.5.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.8.4)
+  rake (~> 0.9.2.2)
+  redis (~> 3.0.1)
+  rspec (~> 2.11.0)
+  timecop (~> 0.5.3)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Art.sy
+
+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,40 @@
+space-saver-redis
+=================
+
+This gem is a pure Ruby implementation of Metwally, Agrawal, and Abbadi's 
+[SpaceSaver algorithm](http://www.cs.ucsb.edu/research/tech_reports/reports/2005-23.pdf) 
+for estimating the top K elements in a data stream. A [Redis](http://redis.io) 
+instance is used for storage.
+
+Here's an example:
+
+    require 'redis'
+    require 'space-saver-redis'
+
+    # Estimate the top 10 most frequent items seen in a data stream
+    space_saver = SpaceSaver.new(Redis.new, 10)
+
+    urls_visited.each { |url| space_saver.increment("urls", url) }
+
+After the above code executes, you can query `space_saver.leaders("urls")` to get
+an estimate of the top 10 most frequent URLs visited along with their estimated
+counts. The `SpaceSaver` instance uses only a Redis sorted set with at most K 
+elements (10, in this case) at any time to make this estimation. 
+
+Obviously, since the data structure uses only a small, fixed amount of space,
+there are some data distributions that can cause the top K elements returned to
+be completely incorrect, but for a lot of data distributions the results are
+worth the savings in space. In particular, for a `SpaceSaver` instance initialized
+with parameter K that observes a data stream of N items, any item that occurs more
+than N/K times is guaranteed to be in the list of estimated leaders.
+
+One way to cope with the error involved in this kind of estimation is to use a K
+bigger than you actually need and then truncate the number of leaders returned
+at query time. You can pass an additional parameter to the call to `leaders` to
+do this, for example `space_saver.leaders("urls", 3)` will return only the top
+3 of the 10 estimated most frequent items.
+
+Installation
+============
+
+    gem install space-saver-redis

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "space-saver-redis"
+  gem.homepage = "http://github.com/aaw/space-saver-redis"
+  gem.license = "MIT"
+  gem.summary = %Q{A pure Ruby implementation of the SpaceSaver algorithm for approximating the top K elements in a data stream, backed by Redis}
+  gem.description = %Q{A pure Ruby implementation of the SpaceSaver algorithm for approximating the top K elements in a data stream, backed by Redis}
+  gem.email = "aaron.windsor@gmail.com"
+  gem.authors = ["Aaron Windsor"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "space-saver-redis #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/space-saver-redis.rb

@@ -0,0 +1,22 @@
+class SpaceSaver
+  def initialize(redis, k)
+    @redis = redis
+    @k = k
+  end
+  
+  def increment(leaderboard, value)
+    score = @redis.zscore(leaderboard, value)
+    if score || @redis.zcard(leaderboard) < @k
+      @redis.zincrby(leaderboard, 1, value)
+    else
+      item, score = @redis.zrange(leaderboard, 0, 0, withscores: true).first
+      new_score = score.to_i + 1
+      @redis.zadd(leaderboard, new_score, value) if @redis.zrem(leaderboard, item)
+      new_score
+    end
+  end
+
+  def leaders(leaderboard, k=@k)
+    @redis.zrevrange(leaderboard, 0, k-1, withscores: true)
+  end
+end

data/spec/space-saver-redis_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe SpaceSaver do
+  it "returns an empty list when you ask about an empty leaderboard" do
+    s = SpaceSaver.new(Redis.new, 10)
+    s.leaders('unknown-leaderboard').should be_empty
+  end
+  it "can store different leaderboards in the same Redis database" do
+    s = SpaceSaver.new(Redis.new, 10)
+    s.increment('a','a_item')
+    s.increment('b','b_item')
+    s.leaders('a').should == [["a_item", 1.0]]
+    s.leaders('b').should == [["b_item", 1.0]]
+  end
+  it "uses a Redis sorted set of cardinality K if you pass K to the SpaceSaver constructor" do
+    r = Redis.new
+    [3,4,5].each do |k|
+      s = SpaceSaver.new(r, k)
+      30.times do |i| 
+        s.increment("leaderboard#{k}", "item#{i}")
+        r.zcard("leaderboard#{k}").should <= k
+      end
+      r.zcard("leaderboard#{k}").should == k
+    end
+  end
+  it "can return less than k leaders" do
+    s = SpaceSaver.new(Redis.new, 20)
+    100.times { |i| s.increment("leaderboard", "item#{i}") }
+    [5,6,7,8].each do |i|
+      s.leaders("leaderboard", i).length.should == i
+      s.leaders("leaderboard", i+1).should include(*s.leaders("leaderboard", i))
+    end
+  end
+  it "stores any element that occurs at least n/k times" do
+    s = SpaceSaver.new(Redis.new, 5)
+    200.times { s.increment("leaderboard", "foo") }
+    400.times do |i| 
+      s.increment("leaderboard", "bar") if i % 2 == 0
+      s.increment("leaderboard", "item#{i}")
+    end
+    200.times { s.increment("leaderboard", "baz") }
+    expected_leaders = ['foo','bar','baz']
+    s.leaders("leaderboard").map{ |x| x.first }.should include('foo','bar','baz')
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'redis'
+require 'space-saver-redis'
+
+db_number = ENV['REDIS_TEST_DATABASE'] || '15'
+ENV['REDIS_URL'] = "redis://localhost:6379/#{db_number}"
+redis = Redis.new
+if redis.keys('*').length > 0
+  puts "Warning! These specs use database #{db_number} on your local redis instance"
+  puts "running on port 6379. Your database #{db_number} seems to have keys in it."
+  puts "Please clear them before running the specs or set the environment"
+  puts "variable REDIS_TEST_DATABASE to use a different database number."
+  raise SystemExit
+end
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Redis.new.flushdb
+  end
+  config.after(:each) do
+    Redis.new.flushdb
+  end  
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: space-saver-redis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Windsor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &2169308260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2169308260
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2169307780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: *2169307780
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2169307300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *2169307300
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2169306820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: *2169306820
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &2169306340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: *2169306340
+description: A pure Ruby implementation of the SpaceSaver algorithm for approximating
+  the top K elements in a data stream, backed by Redis
+email: aaron.windsor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/space-saver-redis.rb
+- spec/space-saver-redis_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/aaw/space-saver-redis
+licenses:
+- MIT
+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: 300893669371900743
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A pure Ruby implementation of the SpaceSaver algorithm for approximating
+  the top K elements in a data stream, backed by Redis
+test_files: []