bitmap-counter 0.0.0

data/.gitignore

@@ -0,0 +1 @@
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in em-apn.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    bitmap-counter (0.0.0)
+      bitset
+      redis
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bitset (0.1.0)
+    diff-lcs (1.1.3)
+    redis (2.2.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bitmap-counter!
+  rspec (~> 2.6.0)

data/README.md

@@ -0,0 +1,51 @@
+# Bitmap Counter
+
+An efficient id-based counter. Current implementation uses redis.
+
+# Usage
+
+    counter = Bitmap::Counter.new("name")
+    
+    counter.add(id = 1)   # a numeric user_id for example
+    counter.count         # 2
+    counter.includes?(1)  # true
+    counter.includes?(2)  # false
+    
+## DateCounter
+
+Count ids for a series of dates.
+
+    counter = Bitmap::DateCounter.new("name")
+    counter.add(1, Date.today)
+    counter.add(2, Date.today)
+    counter.add(1, Date.today - 1)
+
+You can inspect a specific date:
+    
+    counter.count(Date.today)     # 2
+    counter.count(Date.today - 1) # 1
+
+    counter.includes?(1, Date.today)      # true
+    counter.includes?(2, Date.today)      # true
+    counter.includes?(1, Date.today - 1)  # true
+    counter.includes?(2, Date.today - 1)  # false
+    
+Or a range of dates:
+
+    counter.count((Date.today - 1)..Date.today) # 2
+
+    counter.includes?(1, (Date.today - 1)..Date.today) # true
+    counter.includes?(2, (Date.today - 1)..Date.today) # true
+    counter.includes?(3, (Date.today - 1)..Date.today) # false
+    
+## Credits
+
+Inspired by the awesome [post](http://blog.getspool.com/2011/11/29/fast-easy-realtime-metrics-using-redis-bitmaps/) by Chandra Patni.
+        
+## Ruby Version
+
+This was developed on ruby 1.9.2p180 and not tested on other versions...yet :)
+
+## TODO
+
+* Add different backends (File, Postgres, etc)

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bitmap-counter.gemspec

@@ -0,0 +1,22 @@
+# -*- mode: ruby; encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "bitmap/counter"
+
+Gem::Specification.new do |s|
+  s.name        = "bitmap-counter"
+  s.version     = Bitmap::Counter::VERSION
+  s.authors     = ["Brandon Keene"]
+  s.email       = ["bkeene@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{A unique id counter implemented with redis bitmaps. Count the unique users across a date range.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "redis"
+  s.add_dependency "bitset"
+
+  s.add_development_dependency "rspec", "~> 2.6.0"
+end

data/lib/bitmap/counter.rb

@@ -0,0 +1,50 @@
+module Bitmap
+  class Counter
+    VERSION = "0.0.0"
+
+    class << self
+      def redis=(connection)
+        @redis = connection
+      end
+
+      def redis
+        @redis ||= Redis.new
+      end
+    end
+
+    def initialize(name)
+      @name = name
+    end
+
+    def count(id)
+      self.class.redis.setbit(key, id, 1)
+    end
+
+    def counted?(id)
+      self.class.redis.getbit(key, id) == 1
+    end
+
+    def unique
+      bitset.cardinality
+    end
+
+    def delete
+      self.class.redis.del(key)
+    end
+
+    def to_s
+      bitset.to_s
+    end
+
+    private
+
+    def bitset
+      string = self.class.redis.get(key).unpack("b*").first
+      Bitset.from_s(string)
+    end
+
+    def key
+      @key ||= "redis-bitmap-counter:#{@name}"
+    end
+  end
+end

data/lib/bitmap/date_counter.rb

@@ -0,0 +1,47 @@
+module Bitmap
+  class DateCounter < Bitmap::Counter
+    def count(id, date = Date.today)
+      self.class.redis.setbit(key(date), id, 1)
+    end
+
+    def counted?(id, date = Date.today)
+      self.class.redis.getbit(key(date), id) == 1
+    end
+
+    def unique(range = [Date.today])
+      range = [range] if range.is_a?(Date)
+      set = nil
+      range.each do |date|
+        next unless s = bitset(date)
+        set ||= s
+        set |= s
+      end
+      set.cardinality
+    end
+
+    def delete
+      keys = self.class.redis.keys("#{prefix}*")
+      self.class.redis.pipelined do
+        keys.each do |k|
+          self.class.redis.del(k)
+        end
+      end
+    end
+
+    private
+
+    def bitset(date)
+      if string = self.class.redis.get(key(date))
+        Bitset.from_s(string.unpack("b*").first)
+      end
+    end
+
+    def key(date)
+      "#{prefix}#{date}"
+    end
+
+    def prefix
+      "redis-bitmap-counter:#{@name}:"
+    end
+  end
+end

data/lib/bitmap_counter.rb

@@ -0,0 +1,4 @@
+require "redis"
+require "bitset"
+require "bitmap/counter"
+require "bitmap/date_counter"

data/spec/bitmap/counter_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Bitmap::Counter do
+  let(:counter) { Bitmap::Counter.new("test") }
+
+  before do
+    counter.delete
+    counter.count(1)
+    counter.count(3)
+    counter.count(7)
+  end
+
+  describe ".redis" do
+    it "uses a supplied redis instance" do
+      counter.counted?(1).should be_true
+
+      other_redis = Redis.new
+      other_redis.select(1)
+
+      Bitmap::Counter.redis = other_redis
+      Bitmap::Counter.redis.should == other_redis
+
+      other_counter = Bitmap::Counter.new("test")
+      other_counter.delete
+
+      other_counter.count(2)
+      other_counter.counted?(1).should be_false
+      other_counter.counted?(2).should be_true
+    end
+  end
+
+  describe "#unique" do
+    it "returns the sum of all unique ids" do
+      counter.unique.should == 3 # "10001010"
+    end
+  end
+
+  describe "#counted?" do
+    it "returns true/false if id has been counted" do
+      counter.counted?(1).should be_true
+      counter.counted?(2).should be_false
+      counter.counted?(3).should be_true
+      counter.counted?(7).should be_true
+      counter.counted?(99).should be_false
+    end
+  end
+end

data/spec/bitmap/date_counter_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Bitmap::DateCounter do
+  let(:counter) { Bitmap::DateCounter.new("test") }
+
+  before do
+    counter.delete
+  end
+
+  it "defaults to today" do
+    counter.count(1)
+    counter.counted?(1).should be_true
+    counter.unique.should == 1
+  end
+
+  it "reuses redis connections" do
+    lambda {
+      Bitmap::Counter.new("test")
+      Bitmap::Counter.new("test")
+      Bitmap::DateCounter.new("test")
+    }.should_not change { Bitmap::Counter.redis.info["connected_clients"] }
+  end
+
+  describe "with multiple days of data" do
+    before do
+      counter.count(1, Date.today)
+      counter.count(3, Date.today)
+      counter.count(7, Date.today)
+      counter.count(1, Date.today - 1)
+    end
+
+    it "returns counted? for an id on a date" do
+      counter.counted?(3, Date.today).should be_true
+      counter.counted?(3, Date.today - 1).should be_false
+
+      counter.counted?(1, Date.today).should be_true
+      counter.counted?(1, Date.today - 1).should be_true
+    end
+
+    it "returns number of unique ids for specific dates" do
+      counter.unique(Date.today).should == 3
+      counter.unique(Date.today - 1).should == 1
+    end
+
+    it "returns number of unique ids for a date range" do
+      counter.unique((Date.today - 1)..Date.today).should == 3
+    end
+
+    it "is not affected by out of range errors" do
+      counter.unique((Date.today - 2)..Date.today).should == 3
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "rubygems"
+require "bundler/setup"
+Bundler.require :default, :development
+
+require_relative "../lib/bitmap_counter"
+
+RSpec.configure do |config|
+  config.before(:each) do
+    # ???
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: bitmap-counter
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Brandon Keene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-30 00:00:00.000000000 -05:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &2152201380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152201380
+- !ruby/object:Gem::Dependency
+  name: bitset
+  requirement: &2152200960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152200960
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152200460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152200460
+description: 
+email:
+- bkeene@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bitmap-counter.gemspec
+- lib/bitmap/counter.rb
+- lib/bitmap/date_counter.rb
+- lib/bitmap_counter.rb
+- spec/bitmap/counter_spec.rb
+- spec/bitmap/date_counter_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A unique id counter implemented with redis bitmaps. Count the unique users
+  across a date range.
+test_files:
+- spec/bitmap/counter_spec.rb
+- spec/bitmap/date_counter_spec.rb
+- spec/spec_helper.rb