tally_counter 0.0.1 → 0.1.0

data/README.md

@@ -59,14 +59,27 @@ to cause a count skip.
 ## Keys and Scoring
 
 The system uses Redis sorted sets for tracking application hits.
-For each request, a key will be counted, and the score for the
+For each request, a key will be generated, and the score for the
 remote request ip will be incremented by 1.
 
 Keys are generated like 'tally_counter:1371283200' where the time
 is the epoch seconds floor for the current window.  The floor for
-a 5 minute interval at 12:38 would be 12:35, at 12:33 its 12:30,
+a 5 minute interval at 12:38 would be 12:35, at 12:33 it's 12:30,
 and so on.
 
+Keys are generated using the `TallyCounter::KeyGenerate` class.
+This can be used in client applications for generating keys for
+Redis lookups.
+
+```ruby
+# Create a key generator for 5 minute windows with :foo namespace
+key_generate = TallyCounter::KeyGenerate.new(300, :foo)
+# Generate a key for the current time
+key_generate.for(Time.now)
+# Generate a key from 10 minutes ago
+key_generate.for(Time.now, 2)
+```
+
 It is recommended to use a scheduled process to inspect tally_counter
 sets past a certain age (say, 3 days) and prune them to keep your
 data set small and clean.
@@ -75,21 +88,16 @@ Finding totals for a range of time can be accomplished via a Redis
 zunionstore on a range of keys.  For example, if you have a a 5
 minute interval and want to see the last 15 minutes, simple grab
 the current window and the 2 previous and union them with equally
-weighted scoring.  See `TallyCounter::Window#floow` for generating
+weighted scoring.  See `TallyCounter::Window#floor` for generating
 window times and offsets.
 
 ## Reporting
 
 In the interest of giving this gem a single responsibility, reporting
 can be offloaded to other systems.  It should be easy to deploy
-a separate admin application conneted to the same server, and use
+a separate admin application connected to the same server, and use
 the `TallyCounter::Window` class for generating keys.
 
-## Todo
-
-Extract key generation to a utility for use by middleware and client
-apps.
-
 ## Contributing
 
 1. Fork it

data/lib/tally_counter/version.rb

@@ -1,3 +1,3 @@
 module TallyCounter
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/tally_counter.rb

@@ -14,7 +14,7 @@ module TallyCounter
     end
 
     # Returns the floor time for a given window.  For example,
-    # if the interval is 5 minutes and it is 12:38, the floow
+    # if the interval is 5 minutes and it is 12:38, the floor
     # would be 12:35.  If offset is 1, the floor would be 12:30
     #
     # @param [Time] a time instance, commonly Time.now
@@ -26,6 +26,22 @@ module TallyCounter
 
   end
 
+  class KeyGenerate
+    # @param [Integer] a seconds interval for Window use
+    # @param [String] optional app namespace
+    def initialize(interval, namespace = nil)
+      @window    = TallyCounter::Window.new(interval)
+      @namespace = namespace
+    end
+
+    # @param [Time] time for a key, often Time.now
+    # @param [Integer] offset for window to step back
+    def for(time, offset = 0)
+      timestamp = @window.floor(time, offset).to_i
+      [@namespace, "tally_counter", timestamp].compact.join(':')
+    end
+  end
+
   class Middleware
 
     # @param app - a rack compliant app
@@ -68,11 +84,11 @@ module TallyCounter
     end
 
     def current_key
-      [@namespace, "tally_counter", window_floor].compact.join(':')
+      key_generate.for(Time.now)
     end
 
-    def window_floor
-      TallyCounter::Window.new(@interval).floor(Time.now).to_i
+    def key_generate
+      @key_generate ||= TallyCounter::KeyGenerate.new(@interval, @namespace)
     end
 
   end

data/test/tally_counter_test.rb

@@ -2,17 +2,15 @@ require "test/unit"
 require "rack/test"
 require File.expand_path('../../lib/tally_counter', __FILE__)
 
-module TestHelper
-  def test(name, &block)
+class TallyCounterTestCase < Test::Unit::TestCase
+  def self.test(name, &block)
     name = name.gsub(/\W+/, ' ').strip
     test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
     define_method(test_name, &block)
   end
 end
 
-class TallyCounterWindowTest < Test::Unit::TestCase
-  extend TestHelper
-
+class TallyCounterWindowTest < TallyCounterTestCase
   test "initializing with interval seconds" do
     window = TallyCounter::Window.new(60)
     assert_equal 60, window.interval
@@ -38,8 +36,30 @@ class TallyCounterWindowTest < Test::Unit::TestCase
   end
 end
 
-class TallyCounterMiddlewareTest < Test::Unit::TestCase
-  extend TestHelper
+class TallyCounterKeyGenerateTest < TallyCounterTestCase
+  def time
+    Time.parse('2013-06-15 08:52:41 -0700')
+  end
+
+  test "generating a key without a namespace" do
+    key_generate = TallyCounter::KeyGenerate.new(300)
+    assert_equal 'tally_counter:1371311400', key_generate.for(time)
+  end
+
+  test "generating a key with a namespace" do
+    key_generate = TallyCounter::KeyGenerate.new(300, :some_app)
+    assert_equal 'some_app:tally_counter:1371311400', key_generate.for(time)
+  end
+
+  test "generating a key for a given window offset" do
+    key_generate = TallyCounter::KeyGenerate.new(300, :some_app)
+    assert_equal 'some_app:tally_counter:1371311400', key_generate.for(time, 0)
+    assert_equal 'some_app:tally_counter:1371311100', key_generate.for(time, 1)
+    assert_equal 'some_app:tally_counter:1371310800', key_generate.for(time, 2)
+  end
+end
+
+class TallyCounterMiddlewareTest < TallyCounterTestCase
   include Rack::Test::Methods
 
   def redis
@@ -104,10 +124,9 @@ class TallyCounterMiddlewareTest < Test::Unit::TestCase
   end
 
   test "tolerating a timeout error" do
-    fake_redis = Object.new.tap do |r|
-      def r.zincrby(*)
-        sleep 5
-      end
+    fake_redis = Object.new
+    def fake_redis.zincrby(*)
+      sleep 5
     end
     self.app_options = {:redis => fake_redis}
 
@@ -116,15 +135,13 @@ class TallyCounterMiddlewareTest < Test::Unit::TestCase
   end
 
   test "tolerating a redis error" do
-    fake_redis = Object.new.tap do |r|
-      def r.zincrby(*)
-        raise Redis::ConnectionError
-      end
+    fake_redis = Object.new
+    def fake_redis.zincrby(*)
+      raise Redis::ConnectionError
     end
     self.app_options = {:redis => fake_redis}
 
     assert_nothing_raised { get "/" }
     assert_match "ok", last_response.body
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tally_counter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &2152445000 !ruby/object:Gem::Requirement
+  requirement: &2160507200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152445000
+  version_requirements: *2160507200
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2152444560 !ruby/object:Gem::Requirement
+  requirement: &2160506760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152444560
+  version_requirements: *2160506760
 description: Tally web application hits with Rack & Redis sorted sets
 email:
 - xternal1+github@gmail.com