rolling_counter 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41f8f745f17a45305e529f7b5d499341ab377173
+  data.tar.gz: e9ad474a5252520c99b7386019aab8d68240ff8d
+SHA512:
+  metadata.gz: 112598cd52ef05f509ad13cf3a842adf0e2200ee19c2ee59579335fe51e744435d240daff04090ca58da6079671c67722337d06b4c0cbd24b29da59fefe90719
+  data.tar.gz: 7d88fde704f54fa2cb1f141a7775d06e1beb379d470f10374bdefcfd65ffbfb332aacea7351d5b372c19b9f0521cce186e8f21cf6a73eaa272777d3e727927ba

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Global Personals
+
+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 @@
+# RollingCounter
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rolling_counter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rolling_counter
+
+## 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 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end

data/lib/rolling_counter.rb

@@ -0,0 +1,65 @@
+require "rolling_counter/version"
+require "securerandom"
+
+class RollingCounter
+
+  # :call-seq: RollingCounter.new(redis_client, max_window) -> counter
+  #
+  # Create a new counter instance, that will store/retrieve counts with
+  # +redis_client+ and return counts within the last +max_window+ seconds.
+  #
+  # Do not attempt to use counters with different +max_window+ to access the
+  # same keys, as results will not be consistent. Instead set +max_window+ to
+  # the max window needed, then pass the window required to #get.
+  #
+  def initialize(redis, max_window)
+    @redis      = redis
+    @max_window = max_window
+  end
+
+  # :call-seq: counter.incr(key) -> count
+  #            counter.incr(key, window) -> count
+  #
+  # Increment the counter for +key+ by 1. Returns the updated count within
+  # +window+, or the +max_window+ if +window+ is not supplied.
+  #
+  def incr(key, window=@max_window)
+    key = key.to_s
+    now = Time.now.to_f
+    @redis.multi do
+      @redis.zadd(key, now, SecureRandom.uuid)
+      @redis.expire(key, @max_window.ceil)
+      do_get(key, now, window)
+    end.last
+  end
+  alias increment incr
+  alias inc incr
+
+  # :call-seq: counter.get(key) -> count
+  #            counter.get(key, window) -> count
+  #
+  # Returns the count for +key+ within +window+ seconds.
+  #
+  def get(key, window=@max_window)
+    @redis.multi { do_get(key.to_s, Time.now.to_f, window) }.last
+  end
+
+  # :call-seq: counter.mget(key, [windows]) -> {window:count}
+  #
+  # Returns a hash of each +windows+ count for +key+.
+  #
+  def mget(key, windows)
+    now = Time.now.to_f
+    results = @redis.multi do
+      windows.each { |window| do_get(key.to_s, now, window) }
+    end.each_slice(2).map(&:last)
+    Hash[windows.zip(results)]
+  end
+
+  private
+
+  def do_get(key, now, window)
+    @redis.zremrangebyscore(key, 0, now - @max_window)
+    @redis.zcount(key, now - window, now)
+  end
+end

data/lib/rolling_counter/version.rb

@@ -0,0 +1,16 @@
+class RollingCounter
+  class Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 2
+    PRE = nil
+
+    class << self
+
+      def to_s
+        [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+      end
+
+    end
+  end
+end

data/rolling_counter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rolling_counter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rolling_counter"
+  spec.version       = RollingCounter::Version
+  spec.authors       = ["Mat Sadler", "Tim Blair"]
+  spec.email         = ["mat@sourcetagsandcodes.com", "tim@bla.ir"]
+  spec.description   = %q{A Redis-based multi-period rolling counter}
+  spec.summary       = %q{A Redis-based multi-period rolling counter}
+  spec.homepage      = "https://github.com/globaldev/rolling_counter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "mock_redis"
+  spec.add_development_dependency "timecop"
+end

data/spec/rolling_counter/rolling_counter_spec.rb

@@ -0,0 +1,62 @@
+require "timecop"
+require "mock_redis"
+
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+HOUR = 60*60
+DAY = 24*HOUR
+
+describe RollingCounter do
+  before do
+    @max_window = DAY
+    @key        = 1
+    @redis      = MockRedis.new
+    @counter    = RollingCounter.new(@redis, @max_window)
+  end
+
+  it "gets the correct count for a 1 hour window" do
+    [[2013,7,4,22], [2013,7,5,1], [2013,7,5,3]].each do |time|
+      Timecop.freeze(*time) { @counter.incr(@key) }
+    end
+
+    Timecop.freeze(2013,7,5,3) { @counter.get(@key, 1*HOUR).should == 1 }
+  end
+
+  it "gets the correct count for a 4 hour window" do
+    [[2013,7,4,22], [2013,7,5,1], [2013,7,5,3]].each do |time|
+      Timecop.freeze(*time) { @counter.incr(@key) }
+    end
+
+    Timecop.freeze(2013,7,5,3) { @counter.get(@key, 4*HOUR).should == 2 }
+  end
+
+  it "gets the correct count for a day window" do
+    [[2013,7,5,1], [2013,7,5,3], [2013,7,5,12], [2013,7,5,23]].each do |time|
+      Timecop.freeze(*time) { @counter.incr(@key) }
+    end
+
+    Timecop.freeze(2013,7,5,23) { @counter.get(@key, DAY).should == 4 }
+  end
+
+  it "gets the correct count for a day window" do
+    times = [
+      [2013,7,5,1], [2013,7,5,3], [2013,7,5,12], [2013,7,5,23], [2013,7,6,23]
+    ]
+    times.each do |time|
+      Timecop.freeze(*time) { @counter.incr(@key) }
+    end
+
+    Timecop.freeze(2013,7,6,23) { @counter.get(@key, DAY).should == 1 }
+  end
+
+  it "gets the correct count for a day window" do
+    [[2013,7,5,1], [2013,7,5,3], [2013,7,5,12], [2013,7,5,23]].each do |time|
+      Timecop.freeze(*time) { @counter.incr(@key) }
+    end
+
+    Timecop.freeze(2013,7,5,23) do
+      @counter.mget(@key, [4*HOUR, DAY]).should == { 14400 => 1, 86400 => 4 }
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "simplecov"
+SimpleCov.start do
+  add_filter "/spec/"
+  add_filter { |file| file.source.join !~ /def/ }
+end
+
+require "rspec"
+require "rspec/autorun"
+
+require "rolling_counter"

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: rolling_counter
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Mat Sadler
+- Tim Blair
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Redis-based multi-period rolling counter
+email:
+- mat@sourcetagsandcodes.com
+- tim@bla.ir
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rolling_counter.rb
+- lib/rolling_counter/version.rb
+- rolling_counter.gemspec
+- spec/rolling_counter/rolling_counter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/globaldev/rolling_counter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A Redis-based multi-period rolling counter
+test_files:
+- spec/rolling_counter/rolling_counter_spec.rb
+- spec/spec_helper.rb