tally_counter 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.rvmrc
+.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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tally_counter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brendon Murphy
+
+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,99 @@
+# TallyCounter
+
+Tally web application hits with Rack & Redis sorted sets
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tally_counter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tally_counter
+
+## Usage
+
+In your `config.ru` or middleware configuration:
+
+```ruby
+use TallyCounter::Middleware
+
+# Options
+
+# Provide a Redis instance
+use TallyCounter::Middleware, :redis => $redis
+
+# Use a 15 minute interval window
+use TallyCounter::Middleware, :interval => 900
+
+# Use a namespace prefix for keys
+use TallyCounter::Middleware, :namespace => 'my_app_name'
+
+# Timeout to Redis in 0.001 seconds
+use TallyCounter::Middleware, :timeout => 0.001
+
+# Inject a logger
+use TallyCounter::Middleware, :logger => some_logger
+```
+
+It is adviseable you configure `TallyCounter::Middleware` before
+your main application (so Rails, Sinatra, etc) but after your
+static/cache layer.  You probably don't want to be tracking hits
+against CSS, js, etc.
+
+If you wish to avoid counting actions from further down the stack,
+you may inject a response header:
+
+```ruby
+headers['X-Tally-Counter-Skip'] = 'true'
+```
+
+Note the mere presence of the header and not its value is enough
+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
+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,
+and so on.
+
+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.
+
+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
+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
+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
+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,10 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/lib/tally_counter/version.rb

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

data/lib/tally_counter.rb

@@ -0,0 +1,79 @@
+require "tally_counter/version"
+require "logger"
+require "redis"
+require "timeout"
+
+module TallyCounter
+  class Window
+
+    attr_reader :interval
+
+    # @param [Integer] seconds of granularity for the window
+    def initialize(interval)
+      @interval = interval
+    end
+
+    # Returns the floor time for a given window.  For example,
+    # if the interval is 5 minutes and it is 12:38, the floow
+    # would be 12:35.  If offset is 1, the floor would be 12:30
+    #
+    # @param [Time] a time instance, commonly Time.now
+    # @param [offet] an integer of windows step back to
+    def floor(time, offset = 0)
+      epoch_time = time.to_i - interval * offset
+      Time.at((epoch_time / interval) * interval)
+    end
+
+  end
+
+  class Middleware
+
+    # @param app - a rack compliant app
+    # @param options
+    # @option options :interval time in seconds for window granularity
+    # @option options :logger a logger instance
+    # @option options :namespace optional redis key namespace, like 'app_name'
+    # @option options :redis a redis instance
+    # @option options :timeout seconds before timing out a redis command
+    def initialize(app, options = {})
+      @app       = app
+      @interval  = options[:interval] || 300
+      @logger    = options[:logger] || Logger.new($stdout)
+      @namespace = options[:namespace]
+      @redis     = options[:redis] || Redis.current
+      @timeout   = options[:timeout] || 0.007
+    end
+
+    def call(env)
+      tuple = @app.call(env)
+
+      unless tuple[1].delete('X-Tally-Counter-Skip')
+        req = Rack::Request.new(env)
+        track_ip(req.ip)
+      end
+
+      tuple
+    end
+
+    private
+
+    def track_ip(ip)
+      begin
+        Timeout::timeout(@timeout) do
+          @redis.zincrby current_key, 1, ip.to_s
+        end
+      rescue Timeout::Error, Redis::BaseError => e
+        @logger.error e.message
+      end
+    end
+
+    def current_key
+      [@namespace, "tally_counter", window_floor].compact.join(':')
+    end
+
+    def window_floor
+      TallyCounter::Window.new(@interval).floor(Time.now).to_i
+    end
+
+  end
+end

data/tally_counter.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/tally_counter/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Brendon Murphy"]
+  gem.email         = ["xternal1+github@gmail.com"]
+  gem.summary       = %q{Tally web application hits with Rack & Redis sorted sets}
+  gem.description   = gem.summary
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^test/})
+  gem.name          = "tally_counter"
+  gem.require_paths = ["lib"]
+  gem.version       = TallyCounter::VERSION
+
+  gem.add_dependency "redis"
+  gem.add_development_dependency "rack-test"
+end

data/test/tally_counter_test.rb

@@ -0,0 +1,130 @@
+require "test/unit"
+require "rack/test"
+require File.expand_path('../../lib/tally_counter', __FILE__)
+
+module TestHelper
+  def 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
+
+  test "initializing with interval seconds" do
+    window = TallyCounter::Window.new(60)
+    assert_equal 60, window.interval
+  end
+
+  test "calculating the floor for a given time" do
+    window   = TallyCounter::Window.new(300)
+    expected = Time.parse('2013-06-15 00:25:00 -0700')
+    now      = Time.parse('2013-06-15 00:28:36 -0700')
+    assert_equal expected, window.floor(now)
+  end
+
+  test "calculating the floor for a given time with an offset" do
+    window   = TallyCounter::Window.new(300)
+
+    expected = Time.parse('2013-06-15 00:20:00 -0700')
+    now      = Time.parse('2013-06-15 00:28:36 -0700')
+    assert_equal expected, window.floor(now, 1)
+
+    expected = Time.parse('2013-06-15 00:15:00 -0700')
+    now      = Time.parse('2013-06-15 00:28:36 -0700')
+    assert_equal expected, window.floor(now, 2)
+  end
+end
+
+class TallyCounterMiddlewareTest < Test::Unit::TestCase
+  extend TestHelper
+  include Rack::Test::Methods
+
+  def redis
+    @redis ||= Redis.new :db => 14
+  end
+
+  def app_options
+    options = @app_options || {}
+    {:redis => redis}.merge(options)
+  end
+
+  def app_options=(options)
+    @app_options = options
+  end
+
+  def app
+    builder = Rack::Builder.new
+    builder.use TallyCounter::Middleware, app_options
+    builder.run lambda { |env|
+      req = Rack::Request.new(env)
+      headers = {}
+
+      if req.params['skip']
+        headers['X-Tally-Counter-Skip'] = 'true'
+      end
+
+      [200, headers, ['ok']]
+    }
+    builder.to_app
+  end
+
+  test "incrementing the count for the remote address" do
+    window = TallyCounter::Window.new(300)
+    key = "tally_counter:#{window.floor(Time.now).to_i}"
+    redis.del key, "127.0.0.1"
+    get "/"
+    assert_equal 1.0, redis.zscore(key, "127.0.0.1")
+    get "/"
+    assert_equal 2.0, redis.zscore(key, "127.0.0.1")
+  end
+
+  test "providing a namespace for the keys" do
+    window = TallyCounter::Window.new(300)
+    key = "foobar:tally_counter:#{window.floor(Time.now).to_i}"
+    redis.del key
+    self.app_options = {:namespace => 'foobar'}
+    get "/"
+    assert_equal 1.0, redis.zscore(key, "127.0.0.1")
+  end
+
+  test "skipping incrementing when X-Skip-Tally-Counter header is present" do
+    window = TallyCounter::Window.new(300)
+    key = "tally_counter:#{window.floor(Time.now).to_i}"
+    redis.del key, "127.0.0.1"
+    get "/?skip=true"
+    assert_nil redis.zscore(key, "127.0.0.1")
+  end
+
+  test "passing through to the next app in middleware chain" do
+    get "/"
+    assert_match "ok", last_response.body
+  end
+
+  test "tolerating a timeout error" do
+    fake_redis = Object.new.tap do |r|
+      def r.zincrby(*)
+        sleep 5
+      end
+    end
+    self.app_options = {:redis => fake_redis}
+
+    assert_nothing_raised { get "/" }
+    assert_match "ok", last_response.body
+  end
+
+  test "tolerating a redis error" do
+    fake_redis = Object.new.tap do |r|
+      def r.zincrby(*)
+        raise Redis::ConnectionError
+      end
+    end
+    self.app_options = {:redis => fake_redis}
+
+    assert_nothing_raised { get "/" }
+    assert_match "ok", last_response.body
+  end
+
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: tally_counter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brendon Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &2152445000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152445000
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &2152444560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152444560
+description: Tally web application hits with Rack & Redis sorted sets
+email:
+- xternal1+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tally_counter.rb
+- lib/tally_counter/version.rb
+- tally_counter.gemspec
+- test/tally_counter_test.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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Tally web application hits with Rack & Redis sorted sets
+test_files:
+- test/tally_counter_test.rb