visitors 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--profile

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@visitors

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/(.*)_spec.rb})
+  watch(%r{^lib/(.*)\.rb})        { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^spec/spec_helper.rb}) { "spec" }
+end

data/README.md

@@ -0,0 +1,12 @@
+# Visitors
+
+    bundle install
+    bundle console
+
+    Visitors::Store.new
+    Visitors::Day.new
+
+    visitors store
+    visitors web
+
+### Come Back Later

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/visitors

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'visitors'
+  require 'visitors/cli'
+rescue LoadError
+  require File.expand_path('../../lib/visitors', __FILE__)
+  require File.expand_path('../../lib/visitors/cli', __FILE__)
+end
+
+Visitors::CLI.start

data/config.yml

@@ -0,0 +1,5 @@
+development:
+  database: postgres://localhost/visitors_development
+  redis_namespace: visitors_development
+  redis_config:
+    host: localhost

data/lib/visitors.rb

@@ -0,0 +1,26 @@
+$:.push File.expand_path('..', __FILE__)
+require 'visitors/helpers'
+
+module Visitors
+  extend self
+
+  autoload :Config,   'visitors/config'
+  autoload :Resource, 'visitors/resource'
+
+  autoload :Archiver, 'visitors/archiver'
+  autoload :Day,      'visitors/models'
+  autoload :Month,    'visitors/models'
+  autoload :Year,     'visitors/models'
+
+  def config
+    @config ||= Config.load
+  end
+
+  def find(id)
+    Resource.find(id)
+  end
+
+  def increment(id, field)
+    Resource.new(id).increment(field)
+  end
+end

data/lib/visitors/archiver.rb

@@ -0,0 +1,25 @@
+class Visitors::Archiver
+  Day   = Visitors::Day
+  Month = Visitors::Month
+  Year  = Visitors::Year
+
+  def archive_yesterday
+    Day.all.map do |day|
+      execute()
+    end
+  end
+
+  def save_today
+    Day.destroy
+
+    Visitors.store.slice.map do |id, stats|
+      Day.create(stats.merge(:resource_id => id))
+    end
+  end
+
+  private
+
+  def execute(*args)
+    Day.repository.adapter.select(*args)
+  end
+end

data/lib/visitors/cli.rb

@@ -0,0 +1,13 @@
+require 'thor'
+
+class Visitors::CLI < Thor
+  desc 'store', 'start the redis in-memory store'
+  def store
+    say "You're running in development, do it yourself!", :blue
+  end
+
+  desc 'web', 'start the web console (NOT IMPLEMENTED)'
+  def web
+    say 'Not implemented yet', :red
+  end
+end

data/lib/visitors/config.rb

@@ -0,0 +1,32 @@
+class Visitors::Config
+  class MissingEnvironmentError < StandardError; end
+
+  def self.load
+    new.tap { |instance| instance.send(:define_methods_from_yaml) }
+  end
+
+  def all
+    return yaml[env] if yaml[env]
+    raise MissingEnvironmentError, "#{env.inspect} environment not configured"
+  end
+
+  def inspect
+    all.inspect
+  end
+
+  private
+
+  def yaml
+    @yaml ||= YAML.load_file(File.expand_path('../../../config.yml', __FILE__))
+  end
+
+  def env
+    ENV['VISITORS_ENV'] || 'development'
+  end
+
+  def define_methods_from_yaml
+    all.each do |key, value|
+      self.class.send(:define_method, key) { value }
+    end
+  end
+end

data/lib/visitors/helpers.rb

@@ -0,0 +1,55 @@
+require 'redis'
+require 'redis-namespace'
+
+module Helpers
+  class UnsupportedField < StandardError; end
+
+  FIELDS = [:show, :search, :email, :website]
+  SET_NAME = 'resource_ids'
+
+  def redis
+    @redis ||= Redis::Namespace.new(Visitors.config.redis_namespace,
+                                    :redis => redis_connection)
+  end
+
+  def fields
+    FIELDS
+  end
+
+  def assert_valid_field!(name)
+    unless fields.include?(name)
+      error_message = "Invalid field #{name.inspect}. Valid fields are #{fields.inspect}"
+      raise UnsupportedField, error_message
+    end
+  end
+
+  def stats_for(key)
+    redis.hgetall(key)
+  end
+
+  def count
+    redis.scard(SET_NAME)
+  end
+
+  def known_ids
+    redis.smembers(SET_NAME)
+  end
+
+  def parse_date(date)
+    date = date.to_s
+    case date
+    when /\d{4}/
+      date
+    when /\d{1,2}/
+      Time.now.strftime("#{'%02d' % date}%y")
+    else
+      Time.now.strftime('%m%y')
+    end
+  end
+
+  private
+
+  def redis_connection
+    @redis_connection ||= Redis.new(Visitors.config.redis_config)
+  end
+end

data/lib/visitors/models.rb

@@ -0,0 +1,25 @@
+require 'dm-core'
+require 'dm-migrations'
+
+DataMapper.setup(:default, Visitors.config.database)
+
+MODEL_NAMES = %w[Day Month Year]
+
+MODEL_NAMES.each do |class_name|
+  Visitors.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+    class Visitors::#{class_name}
+      include DataMapper::Resource
+
+      property :id,          Serial
+      property :archived,    Time
+      property :resource_id, Integer, :required => true
+
+      Visitors::Resource.fields.each do |field|
+        property field, Integer, :default => 0, :required => true
+      end
+    end
+  RUBY
+end
+
+DataMapper.finalize
+DataMapper.auto_migrate!

data/lib/visitors/resource.rb

@@ -0,0 +1,41 @@
+class Visitors::Resource
+  include Helpers
+  extend  Helpers
+
+  MONTHS = (1..12).to_a
+
+  class << self
+    def find(resource_id)
+      Hash[*MONTHS.map do |month|
+        [month, stats_for(new(resource_id, month).to_redis_key)]
+      end.flatten]
+    end
+
+    def increment(resource_id, field)
+      new(resource_id).increment(field)
+    end
+
+    alias :incr :increment
+  end
+
+  attr_reader :id, :date
+
+  def initialize(id, date = nil)
+    raise ArgumentError, 'Invalid id' unless id
+    @id   = id
+    @date = parse_date(date)
+  end
+
+  def to_redis_key
+    [id, date].join(':')
+  end
+
+  alias :key :to_redis_key
+
+  def increment(field)
+    assert_valid_field!(field.to_sym)
+
+    redis.sadd(SET_NAME, id)
+    redis.hincrby(key, field, 1)
+  end
+end

data/lib/visitors/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+$:.push File.expand_path('../../lib', __FILE__)
+require 'visitors'

data/spec/visitors/config_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Visitors::Config do
+  describe '#all' do
+    it 'uses the config.yml file to return a hash of configuration information' do
+      File.stub!(:expand_path => '/path/to/config.yml')
+      YAML.should_receive(:load_file).with('/path/to/config.yml').and_return('development' => {})
+      Visitors::Config.load.all
+    end
+
+    it 'raises when an environment is not defined' do
+      expect {
+	YAML.stub!(:load_file => {})
+	Visitors::Config.load.all
+      }.to raise_error(Visitors::Config::MissingEnvironmentError)
+    end
+  end
+end

data/spec/visitors/models_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Visitors::Day do
+end
+
+describe Visitors::Month do
+end
+
+describe Visitors::Year do
+end

data/spec/visitors/resource_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Visitors::Resource do
+  def resource(id = nil, date = nil)
+    @resource ||= Visitors::Resource.new(id, date)
+  end
+
+  describe '#key' do
+    context 'with an integer id' do
+      context 'with no date' do
+        it 'returns the resource id and the current date' do
+          Time.stub!(:now => double('time', :strftime => '0311'))
+          resource(1).key.should == '1:0311'
+        end
+      end
+
+      context 'with a timestamp of the form mmyy' do
+        it 'uses the id and the supplied timestamp' do
+          resource(1, '0311').key.should == '1:0311'
+        end
+      end
+
+      context 'with a nil date' do
+        it 'ignores the date and returns the id with the current date' do
+          Time.stub!(:now => double('time', :strftime => '0311'))
+          resource(1, nil).key.should == '1:0311'
+        end
+      end
+    end
+  end
+
+  context 'with no id' do
+    it 'returns an empty key' do
+      expect { resource(nil).key }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/visitors_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Visitors do
+  describe '.assert_valid_field!' do
+    it 'protects against using unknown fields' do
+      error_message = %{Invalid field "invalid_field". Valid fields are []}
+
+      expect {
+        Visitors.stub!(:fields => %w[])
+        Visitors.assert_valid_field!('invalid_field')
+      }.to raise_error(Visitors::UnsupportedField, error_message)
+    end
+  end
+end

data/visitors.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'visitors/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'visitors'
+  s.version     = Visitors::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['James Conroy-Finn']
+  s.email       = ['james@logi.cl']
+  s.homepage    = 'http://github.com/jcf/visitors'
+  s.summary     = %q{All-in-one fast logging system for your Rails application}
+  s.description = %q{Redis-backed activity storage to track visits to different parts of your Ruby web app in real-time.}
+
+  s.rubyforge_project = 'visitors'
+
+  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']
+
+  {
+    'redis'               => '2.1.1',
+    'redis-namespace'     => '0.10.0',
+    'dm-core'             => '1.0.2',
+    'dm-migrations'       => '1.0.2',
+    'dm-postgres-adapter' => '1.0.2',
+    'sinatra'             => '1.1.3',
+    'thor'                => '0.14.6'
+  }.each { |gem, version| s.add_dependency gem, "~> #{version}" }
+
+  {
+    'rspec'       => '2.5.0',
+    'guard-rspec' => '0.1.9',
+    'rb-fsevent'  => '0.3.10'
+  }.each { |gem, version| s.add_development_dependency gem, "~> #{version}" }
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification 
+name: visitors
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- James Conroy-Finn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-28 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.1.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: redis-namespace
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.10.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.2
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: dm-migrations
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.2
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: dm-postgres-adapter
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.2
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.14.6
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.1.9
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: rb-fsevent
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.3.10
+  type: :development
+  version_requirements: *id010
+description: Redis-backed activity storage to track visits to different parts of your Ruby web app in real-time.
+email: 
+- james@logi.cl
+executables: 
+- visitors
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/visitors
+- config.yml
+- lib/visitors.rb
+- lib/visitors/archiver.rb
+- lib/visitors/cli.rb
+- lib/visitors/config.rb
+- lib/visitors/helpers.rb
+- lib/visitors/models.rb
+- lib/visitors/resource.rb
+- lib/visitors/version.rb
+- spec/spec_helper.rb
+- spec/visitors/config_spec.rb
+- spec/visitors/models_spec.rb
+- spec/visitors/resource_spec.rb
+- spec/visitors_spec.rb
+- visitors.gemspec
+has_rdoc: true
+homepage: http://github.com/jcf/visitors
+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: visitors
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: All-in-one fast logging system for your Rails application
+test_files: 
+- spec/spec_helper.rb
+- spec/visitors/config_spec.rb
+- spec/visitors/models_spec.rb
+- spec/visitors/resource_spec.rb
+- spec/visitors_spec.rb